Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / displayvideo_v1.firstAndThirdPartyAudiences.html
blob: 8a9bc9d31c7b672125a611cbd1d2b9033a8a8c56 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]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="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.firstAndThirdPartyAudiences.html">firstAndThirdPartyAudiences</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(firstAndThirdPartyAudienceId, advertiserId=None, partnerId=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets a first and third party audience.</p>
80<p class="toc_element">
81 <code><a href="#list">list(advertiserId=None, orderBy=None, partnerId=None, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Lists first and third party 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(firstAndThirdPartyAudienceId, advertiserId=None, partnerId=None, x__xgafv=None)</code>
89 <pre>Gets a first and third party audience.
90
91Args:
92 firstAndThirdPartyAudienceId: string, Required. The ID of the first and third party audience to fetch. (required)
93 advertiserId: string, The ID of the advertiser that has access to the fetched first and
94third party audience.
95 partnerId: string, The ID of the partner that has access to the fetched first and
96third party audience.
97 x__xgafv: string, V1 error format.
98 Allowed values
99 1 - v1 error format
100 2 - v2 error format
101
102Returns:
103 An object of the form:
104
105 { # Describes a first or third party audience list used for targeting.
106 # First party audiences are created via usage of client data.
107 # Third party audiences are provided by Third Party data providers and can only
108 # be licensed to customers.
109 &quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the first and third party audience. Assigned by the
110 # system.
111 &quot;firstAndThirdPartyAudienceType&quot;: &quot;A String&quot;, # Output only. Whether the audience is a first or third party audience.
112 # .
113 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the first and third party audience.
114 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the first and third party audience.
115 # .
116 }</pre>
117</div>
118
119<div class="method">
120 <code class="details" id="list">list(advertiserId=None, orderBy=None, partnerId=None, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
121 <pre>Lists first and third party audiences.
122
123The order is defined by the
124order_by parameter.
125
126Args:
127 advertiserId: string, The ID of the advertiser that has access to the fetched first and
128third party audiences.
129 orderBy: string, Field by which to sort the list.
130Acceptable values are:
131
132* `firstAndThirdPartyAudienceId` (default)
133* `displayName`
134
135The default sorting order is ascending. To specify descending order for
136a field, a suffix &quot;desc&quot; should be added to the field name. Example:
137`displayName desc`.
138 partnerId: string, The ID of the partner that has access to the fetched first and
139third party audiences.
140 filter: string, Allows filtering by first and third party audience fields.
141
142Supported syntax:
143
144* Filter expressions for first and third party audiences currently can
145only contain at most 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 first and third party audiences for which the display name contains
154&quot;Google&quot;: `displayName : &quot;Google&quot;`.
155
156The length of this field should be no more than 500 characters.
157 pageToken: string, A token identifying a page of results the server should return.
158Typically, this is the value of
159next_page_token
160returned from the previous call to `ListFirstAndThirdPartyAudiences`
161method. If not specified, the first page of results will be returned.
162 pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will
163default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
164is specified.
165 x__xgafv: string, V1 error format.
166 Allowed values
167 1 - v1 error format
168 2 - v2 error format
169
170Returns:
171 An object of the form:
172
173 {
174 &quot;firstAndThirdPartyAudiences&quot;: [ # The list of first and third party audiences. Audience size properties will
175 # not be included.
176 #
177 # This list will be absent if empty.
178 { # Describes a first or third party audience list used for targeting.
179 # First party audiences are created via usage of client data.
180 # Third party audiences are provided by Third Party data providers and can only
181 # be licensed to customers.
182 &quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the first and third party audience. Assigned by the
183 # system.
184 &quot;firstAndThirdPartyAudienceType&quot;: &quot;A String&quot;, # Output only. Whether the audience is a first or third party audience.
185 # .
186 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the first and third party audience.
187 &quot;displayName&quot;: &quot;A String&quot;, # Output only. The display name of the first and third party audience.
188 # .
189 },
190 ],
191 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results.
192 # Pass this value in the
193 # page_token
194 # field in the subsequent call to `ListFirstAndThirdPartyAudiences` method to
195 # retrieve the next page of results.
196 }</pre>
197</div>
198
199<div class="method">
200 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
201 <pre>Retrieves the next page of results.
202
203Args:
204 previous_request: The request for the previous page. (required)
205 previous_response: The response from the request for the previous page. (required)
206
207Returns:
208 A request object that you can call &#x27;execute()&#x27; on to request the next
209 page. Returns None if there are no more items in the collection.
210 </pre>
211</div>
212
213</body></html>