Debian Codegraph @

docs/dyn/dfareporting_v3_4.dimensionValues.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="dfareporting_v3_4.html">Campaign Manager 360 API</a> . <a href="dfareporting_v3_4.dimensionValues.html">dimensionValues</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#query">query(profileId, body=None, maxResults=None, pageToken=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves list of report dimension values for a list of filters.</p>
83 <p class="toc_element">
84 <code><a href="#query_next">query_next(previous_request, previous_response)</a></code></p>
85 <p class="firstline">Retrieves the next page of results.</p>
86 <h3>Method Details</h3>
87 <div class="method">
88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90 </div>
91
92 <div class="method">
93 <code class="details" id="query">query(profileId, body=None, maxResults=None, pageToken=None, x__xgafv=None)</code>
94 <pre>Retrieves list of report dimension values for a list of filters.
95
96 Args:
97 profileId: string, The Campaign Manager 360 user profile ID. (required)
98 body: object, The request body.
99 The object takes the form of:
100
101 { # Represents a DimensionValuesRequest.
102 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension for which values should be requested.
103 &quot;endDate&quot;: &quot;A String&quot;,
104 &quot;filters&quot;: [ # The list of filters by which to filter values. The filters are ANDed.
105 { # Represents a dimension filter.
106 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension to filter.
107 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionFilter.
108 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension to filter.
109 },
110 ],
111 &quot;kind&quot;: &quot;A String&quot;, # The kind of request this is, in this case dfareporting#dimensionValueRequest .
112 &quot;startDate&quot;: &quot;A String&quot;,
113 }
114
115 maxResults: integer, Maximum number of results to return.
116 pageToken: string, The value of the nextToken from the previous result page.
117 x__xgafv: string, V1 error format.
118 Allowed values
119 1 - v1 error format
120 2 - v2 error format
121
122 Returns:
123 An object of the form:
124
125 { # Represents the list of DimensionValue resources.
126 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
127 &quot;items&quot;: [ # The dimension values returned in this response.
128 { # Represents a DimensionValue resource.
129 &quot;dimensionName&quot;: &quot;A String&quot;, # The name of the dimension.
130 &quot;etag&quot;: &quot;A String&quot;, # The eTag of this response for caching purposes.
131 &quot;id&quot;: &quot;A String&quot;, # The ID associated with the value if available.
132 &quot;kind&quot;: &quot;A String&quot;, # The kind of resource this is, in this case dfareporting#dimensionValue.
133 &quot;matchType&quot;: &quot;A String&quot;, # Determines how the &#x27;value&#x27; field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, &#x27;*&#x27; is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions (&#x27;dfa:paidSearch*&#x27;) allow a matchType other than EXACT.
134 &quot;value&quot;: &quot;A String&quot;, # The value of the dimension.
135 },
136 ],
137 &quot;kind&quot;: &quot;A String&quot;, # The kind of list this is, in this case dfareporting#dimensionValueList.
138 &quot;nextPageToken&quot;: &quot;A String&quot;, # Continuation token used to page through dimension values. To retrieve the next page of results, set the next request&#x27;s &quot;pageToken&quot; to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
139 }</pre>
140 </div>
141
142 <div class="method">
143 <code class="details" id="query_next">query_next(previous_request, previous_response)</code>
144 <pre>Retrieves the next page of results.
145
146 Args:
147 previous_request: The request for the previous page. (required)
148 previous_response: The response from the request for the previous page. (required)
149
150 Returns:
151 A request object that you can call &#x27;execute()&#x27; on to request the next
152 page. Returns None if there are no more items in the collection.
153 </pre>
154 </div>
155
156 </body></html>