blob: a342752754ebc5c833f62a62a9f069d836279856 [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.firstAndThirdPartyAudiences.html">firstAndThirdPartyAudiences</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -080081 <code><a href="#get">get(firstAndThirdPartyAudienceId, partnerId=None, advertiserId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070082<p class="firstline">Gets a first and third party audience.</p>
83<p class="toc_element">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -080084 <code><a href="#list">list(partnerId=None, advertiserId=None, filter=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070085<p class="firstline">Lists first and third party audiences. The order is defined by the order_by parameter.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070086<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -080096 <code class="details" id="get">get(firstAndThirdPartyAudienceId, partnerId=None, advertiserId=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -070097 <pre>Gets a first and third party audience.
98
99Args:
100 firstAndThirdPartyAudienceId: string, Required. The ID of the first and third party audience to fetch. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700101 partnerId: string, The ID of the partner that has access to the fetched first and third party audience.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800102 advertiserId: string, The ID of the advertiser that has access to the fetched first and third party audience.
Bu Sun Kim65020912020-05-20 12:08:20 -0700103 x__xgafv: string, V1 error format.
104 Allowed values
105 1 - v1 error format
106 2 - v2 error format
107
108Returns:
109 An object of the form:
110
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700111 { # Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party audiences are provided by Third Party data providers and can only be licensed to customers.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800112 &quot;firstAndThirdPartyAudienceType&quot;: &quot;A String&quot;, # Output only. Whether the audience is a first or third party audience.
113 &quot;displayMobileAppAudienceSize&quot;: &quot;A String&quot;, # Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
114 &quot;description&quot;: &quot;A String&quot;, # The user-provided description of the audience. Only applicable to first party audiences.
115 &quot;activeDisplayAudienceSize&quot;: &quot;A String&quot;, # Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
116 &quot;gmailAudienceSize&quot;: &quot;A String&quot;, # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
117 &quot;audienceType&quot;: &quot;A String&quot;, # Output only. The type of the audience.
118 &quot;audienceSource&quot;: &quot;A String&quot;, # Output only. The source of the audience.
119 &quot;displayMobileWebAudienceSize&quot;: &quot;A String&quot;, # Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
120 &quot;displayDesktopAudienceSize&quot;: &quot;A String&quot;, # Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
121 &quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the first and third party audience. Assigned by the system.
122 &quot;membershipDurationDays&quot;: &quot;A String&quot;, # The duration in days that an entry remains in the audience after the qualifying event. Only applicable to first party audiences.
123 &quot;displayAudienceSize&quot;: &quot;A String&quot;, # Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700124 &quot;youtubeAudienceSize&quot;: &quot;A String&quot;, # Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
125 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the first and third party audience.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700126 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the first and third party audience.
Bu Sun Kim65020912020-05-20 12:08:20 -0700127 }</pre>
128</div>
129
130<div class="method">
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800131 <code class="details" id="list">list(partnerId=None, advertiserId=None, filter=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700132 <pre>Lists first and third party audiences. The order is defined by the order_by parameter.
Bu Sun Kim65020912020-05-20 12:08:20 -0700133
134Args:
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700135 partnerId: string, The ID of the partner that has access to the fetched first and third party audiences.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700136 advertiserId: string, The ID of the advertiser that has access to the fetched first and third party audiences.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700137 filter: string, Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences currently can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * The operator must be `CONTAINS (:)`. * Supported fields: - `displayName` Examples: * All first and third party audiences for which the display name contains &quot;Google&quot;: `displayName : &quot;Google&quot;`. The length of this field should be no more than 500 characters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700138 pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListFirstAndThirdPartyAudiences` method. If not specified, the first page of results will be returned.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800139 orderBy: string, Field by which to sort the list. Acceptable values are: * `firstAndThirdPartyAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix &quot;desc&quot; should be added to the field name. Example: `displayName desc`.
140 pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
Bu Sun Kim65020912020-05-20 12:08:20 -0700141 x__xgafv: string, V1 error format.
142 Allowed values
143 1 - v1 error format
144 2 - v2 error format
145
146Returns:
147 An object of the form:
148
149 {
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800150 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListFirstAndThirdPartyAudiences` method to retrieve the next page of results.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700151 &quot;firstAndThirdPartyAudiences&quot;: [ # The list of first and third party audiences. Audience size properties will not be included. This list will be absent if empty.
152 { # Describes a first or third party audience list used for targeting. First party audiences are created via usage of client data. Third party audiences are provided by Third Party data providers and can only be licensed to customers.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800153 &quot;firstAndThirdPartyAudienceType&quot;: &quot;A String&quot;, # Output only. Whether the audience is a first or third party audience.
154 &quot;displayMobileAppAudienceSize&quot;: &quot;A String&quot;, # Output only. The estimated mobile app audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
155 &quot;description&quot;: &quot;A String&quot;, # The user-provided description of the audience. Only applicable to first party audiences.
156 &quot;activeDisplayAudienceSize&quot;: &quot;A String&quot;, # Output only. The estimated audience size for the Display network in the past month. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
157 &quot;gmailAudienceSize&quot;: &quot;A String&quot;, # Output only. The estimated audience size for Gmail network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
158 &quot;audienceType&quot;: &quot;A String&quot;, # Output only. The type of the audience.
159 &quot;audienceSource&quot;: &quot;A String&quot;, # Output only. The source of the audience.
160 &quot;displayMobileWebAudienceSize&quot;: &quot;A String&quot;, # Output only. The estimated mobile web audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
161 &quot;displayDesktopAudienceSize&quot;: &quot;A String&quot;, # Output only. The estimated desktop audience size in Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
162 &quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the first and third party audience. Assigned by the system.
163 &quot;membershipDurationDays&quot;: &quot;A String&quot;, # The duration in days that an entry remains in the audience after the qualifying event. Only applicable to first party audiences.
164 &quot;displayAudienceSize&quot;: &quot;A String&quot;, # Output only. The estimated audience size for the Display network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only returned in GET request.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700165 &quot;youtubeAudienceSize&quot;: &quot;A String&quot;, # Output only. The estimated audience size for YouTube network. If the size is less than 1000, the number will be hidden and 0 will be returned due to privacy reasons. Otherwise, the number will be rounded off to two significant digits. Only applicable to first party audiences. Only returned in GET request.
166 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the first and third party audience.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700167 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the first and third party audience.
Bu Sun Kim65020912020-05-20 12:08:20 -0700168 },
169 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700170 }</pre>
171</div>
172
173<div class="method">
174 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
175 <pre>Retrieves the next page of results.
176
177Args:
178 previous_request: The request for the previous page. (required)
179 previous_response: The response from the request for the previous page. (required)
180
181Returns:
182 A request object that you can call &#x27;execute()&#x27; on to request the next
183 page. Returns None if there are no more items in the collection.
184 </pre>
185</div>
186
187</body></html>