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