blob: 5d213742cbd07c4e5e2bac509b4d519f9d680d4e [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<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="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.combinedAudiences.html">combinedAudiences</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(combinedAudienceId, partnerId=None, advertiserId=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets a combined audience.</p>
80<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070081 <code><a href="#list">list(pageToken=None, pageSize=None, advertiserId=None, orderBy=None, partnerId=None, filter=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070082<p class="firstline">Lists combined audiences.</p>
83<p class="toc_element">
84 <code><a href="#list_next">list_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="get">get(combinedAudienceId, partnerId=None, advertiserId=None, x__xgafv=None)</code>
89 <pre>Gets a combined audience.
90
91Args:
92 combinedAudienceId: string, Required. The ID of the combined audience to fetch. (required)
93 partnerId: string, The ID of the partner that has access to the fetched combined audience.
94 advertiserId: string, The ID of the advertiser that has access to the fetched combined
95audience.
96 x__xgafv: string, V1 error format.
97 Allowed values
98 1 - v1 error format
99 2 - v2 error format
100
101Returns:
102 An object of the form:
103
104 { # Describes a combined audience resource.
105 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the combined audience.
106 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the combined audience.
107 # .
108 &quot;combinedAudienceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the combined audience. Assigned by the system.
109 }</pre>
110</div>
111
112<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700113 <code class="details" id="list">list(pageToken=None, pageSize=None, advertiserId=None, orderBy=None, partnerId=None, filter=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700114 <pre>Lists combined audiences.
115
116The order is defined by the
117order_by parameter.
118
119Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700120 pageToken: string, A token identifying a page of results the server should return.
121Typically, this is the value of
122next_page_token
123returned from the previous call to `ListCombinedAudiences` method.
124If not specified, the first page of results will be returned.
125 pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will
126default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
127is specified.
128 advertiserId: string, The ID of the advertiser that has access to the fetched combined
129audiences.
130 orderBy: string, Field by which to sort the list.
131Acceptable values are:
132
133* `combinedAudienceId` (default)
134* `displayName`
135
136The default sorting order is ascending. To specify descending order for
137a field, a suffix &quot;desc&quot; should be added to the field name. Example:
138`displayName desc`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700139 partnerId: string, The ID of the partner that has access to the fetched combined audiences.
140 filter: string, Allows filtering by combined audience fields.
141
142Supported syntax:
143
144* Filter expressions for combined audiences currently can only contain at
145most one restriction.
146* A restriction has the form of `{field} {operator} {value}`.
147* The operator must be `CONTAINS (:)`.
148* Supported fields:
149 - `displayName`
150
151Examples:
152
153* All combined audiences for which the display name contains &quot;Google&quot;:
154`displayName : &quot;Google&quot;`.
155
156The length of this field should be no more than 500 characters.
Bu Sun Kim65020912020-05-20 12:08:20 -0700157 x__xgafv: string, V1 error format.
158 Allowed values
159 1 - v1 error format
160 2 - v2 error format
161
162Returns:
163 An object of the form:
164
165 {
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700166 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results.
167 # Pass this value in the
168 # page_token
169 # field in the subsequent call to `ListCombinedAudiences` method to retrieve
170 # the next page of results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700171 &quot;combinedAudiences&quot;: [ # The list of combined audiences.
172 #
173 # This list will be absent if empty.
174 { # Describes a combined audience resource.
175 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the combined audience.
176 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the combined audience.
177 # .
178 &quot;combinedAudienceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the combined audience. Assigned by the system.
179 },
180 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700181 }</pre>
182</div>
183
184<div class="method">
185 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
186 <pre>Retrieves the next page of results.
187
188Args:
189 previous_request: The request for the previous page. (required)
190 previous_response: The response from the request for the previous page. (required)
191
192Returns:
193 A request object that you can call &#x27;execute()&#x27; on to request the next
194 page. Returns None if there are no more items in the collection.
195 </pre>
196</div>
197
198</body></html>