• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, 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
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, 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_v2_7.html">DCM/DFA Reporting And Trafficking API</a> . <a href="dfareporting_v2_7.dimensionValues.html">dimensionValues</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#query">query(profileId, body, pageToken=None, maxResults=None)</a></code></p>
79<p class="firstline">Retrieves list of report dimension values for a list of filters.</p>
80<p class="toc_element">
81  <code><a href="#query_next">query_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
85    <code class="details" id="query">query(profileId, body, pageToken=None, maxResults=None)</code>
86  <pre>Retrieves list of report dimension values for a list of filters.
87
88Args:
89  profileId: string, The DFA user profile ID. (required)
90  body: object, The request body. (required)
91    The object takes the form of:
92
93{ # Represents a DimensionValuesRequest.
94    "dimensionName": "A String", # The name of the dimension for which values should be requested.
95    "startDate": "A String", # The start date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd".
96    "kind": "dfareporting#dimensionValueRequest", # The kind of request this is, in this case dfareporting#dimensionValueRequest.
97    "endDate": "A String", # The end date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd".
98    "filters": [ # The list of filters by which to filter values. The filters are ANDed.
99      { # Represents a dimension filter.
100        "dimensionName": "A String", # The name of the dimension to filter.
101        "kind": "dfareporting#dimensionFilter", # The kind of resource this is, in this case dfareporting#dimensionFilter.
102        "value": "A String", # The value of the dimension to filter.
103      },
104    ],
105  }
106
107  pageToken: string, The value of the nextToken from the previous result page.
108  maxResults: integer, Maximum number of results to return.
109
110Returns:
111  An object of the form:
112
113    { # Represents the list of DimensionValue resources.
114    "nextPageToken": "A String", # Continuation token used to page through dimension values. To retrieve the next page of results, set the next request's "pageToken" to the value of this field. The page token is only valid for a limited amount of time and should not be persisted.
115    "items": [ # The dimension values returned in this response.
116      { # Represents a DimensionValue resource.
117        "kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
118        "value": "A String", # The value of the dimension.
119        "dimensionName": "A String", # The name of the dimension.
120        "etag": "A String", # The eTag of this response for caching purposes.
121        "matchType": "A String", # Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '*' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch*') allow a matchType other than EXACT.
122        "id": "A String", # The ID associated with the value if available.
123      },
124    ],
125    "kind": "dfareporting#dimensionValueList", # The kind of list this is, in this case dfareporting#dimensionValueList.
126    "etag": "A String", # The eTag of this response for caching purposes.
127  }</pre>
128</div>
129
130<div class="method">
131    <code class="details" id="query_next">query_next(previous_request, previous_response)</code>
132  <pre>Retrieves the next page of results.
133
134Args:
135  previous_request: The request for the previous page. (required)
136  previous_response: The response from the request for the previous page. (required)
137
138Returns:
139  A request object that you can call 'execute()' on to request the next
140  page. Returns None if there are no more items in the collection.
141    </pre>
142</div>
143
144</body></html>