Debian Codegraph @

docs/dyn/displayvideo_v3.firstAndThirdPartyAudiences.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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_v3.html">Display & Video 360 API</a> . <a href="displayvideo_v3.firstAndThirdPartyAudiences.html">firstAndThirdPartyAudiences</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#create">create(advertiserId=None, body=None, x__xgafv=None)</a></code></p>
82 <p class="firstline">Creates a FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`</p>
83 <p class="toc_element">
84 <code><a href="#editCustomerMatchMembers">editCustomerMatchMembers(firstAndThirdPartyAudienceId, body=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`</p>
86 <p class="toc_element">
87 <code><a href="#get">get(firstAndThirdPartyAudienceId, advertiserId=None, partnerId=None, x__xgafv=None)</a></code></p>
88 <p class="firstline">Gets a first and third party audience.</p>
89 <p class="toc_element">
90 <code><a href="#list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Lists first and third party audiences. The order is defined by the order_by parameter.</p>
92 <p class="toc_element">
93 <code><a href="#list_next">list_next()</a></code></p>
94 <p class="firstline">Retrieves the next page of results.</p>
95 <p class="toc_element">
96 <code><a href="#patch">patch(firstAndThirdPartyAudienceId, advertiserId=None, body=None, updateMask=None, x__xgafv=None)</a></code></p>
97 <p class="firstline">Updates an existing FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`</p>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="close">close()</code>
101 <pre>Close httplib2 connections.</pre>
102 </div>
103
104 <div class="method">
105 <code class="details" id="create">create(advertiserId=None, body=None, x__xgafv=None)</code>
106 <pre>Creates a FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
107
108 Args:
109 body: object, The request body.
110 The object takes the form of:
111
112 { # 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.
113 &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.
114 &quot;appId&quot;: &quot;A String&quot;, # The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
115 &quot;audienceSource&quot;: &quot;A String&quot;, # Output only. The source of the audience.
116 &quot;audienceType&quot;: &quot;A String&quot;, # The type of the audience.
117 &quot;contactInfoList&quot;: { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`
118 &quot;consent&quot;: { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
119 &quot;adPersonalization&quot;: &quot;A String&quot;, # Represents consent for ad personalization.
120 &quot;adUserData&quot;: &quot;A String&quot;, # Represents consent for ad user data.
121 },
122 &quot;contactInfos&quot;: [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn&#x27;t be greater than 500,000.
123 { # Contact information defining a Customer Match audience member.
124 &quot;countryCode&quot;: &quot;A String&quot;, # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
125 &quot;hashedEmails&quot;: [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
126 &quot;A String&quot;,
127 ],
128 &quot;hashedFirstName&quot;: &quot;A String&quot;, # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
129 &quot;hashedLastName&quot;: &quot;A String&quot;, # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
130 &quot;hashedPhoneNumbers&quot;: [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
131 &quot;A String&quot;,
132 ],
133 &quot;zipCodes&quot;: [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
134 &quot;A String&quot;,
135 ],
136 },
137 ],
138 },
139 &quot;description&quot;: &quot;A String&quot;, # The user-provided description of the audience. Only applicable to first party audiences.
140 &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.
141 &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.
142 &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.
143 &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.
144 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the first and third party audience.
145 &quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the first and third party audience. Assigned by the system.
146 &quot;firstAndThirdPartyAudienceType&quot;: &quot;A String&quot;, # Whether the audience is a first or third party audience.
147 &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.
148 &quot;membershipDurationDays&quot;: &quot;A String&quot;, # The duration in days that an entry remains in the audience after the qualifying event. The set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
149 &quot;mobileDeviceIdList&quot;: { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
150 &quot;consent&quot;: { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
151 &quot;adPersonalization&quot;: &quot;A String&quot;, # Represents consent for ad personalization.
152 &quot;adUserData&quot;: &quot;A String&quot;, # Represents consent for ad user data.
153 },
154 &quot;mobileDeviceIds&quot;: [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn&#x27;t be greater than 500,000.
155 &quot;A String&quot;,
156 ],
157 },
158 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the first and third party audience.
159 &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.
160 }
161
162 advertiserId: string, Required. The ID of the advertiser under whom the FirstAndThirdPartyAudience will be created.
163 x__xgafv: string, V1 error format.
164 Allowed values
165 1 - v1 error format
166 2 - v2 error format
167
168 Returns:
169 An object of the form:
170
171 { # 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.
172 &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.
173 &quot;appId&quot;: &quot;A String&quot;, # The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
174 &quot;audienceSource&quot;: &quot;A String&quot;, # Output only. The source of the audience.
175 &quot;audienceType&quot;: &quot;A String&quot;, # The type of the audience.
176 &quot;contactInfoList&quot;: { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`
177 &quot;consent&quot;: { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
178 &quot;adPersonalization&quot;: &quot;A String&quot;, # Represents consent for ad personalization.
179 &quot;adUserData&quot;: &quot;A String&quot;, # Represents consent for ad user data.
180 },
181 &quot;contactInfos&quot;: [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn&#x27;t be greater than 500,000.
182 { # Contact information defining a Customer Match audience member.
183 &quot;countryCode&quot;: &quot;A String&quot;, # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
184 &quot;hashedEmails&quot;: [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
185 &quot;A String&quot;,
186 ],
187 &quot;hashedFirstName&quot;: &quot;A String&quot;, # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
188 &quot;hashedLastName&quot;: &quot;A String&quot;, # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
189 &quot;hashedPhoneNumbers&quot;: [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
190 &quot;A String&quot;,
191 ],
192 &quot;zipCodes&quot;: [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
193 &quot;A String&quot;,
194 ],
195 },
196 ],
197 },
198 &quot;description&quot;: &quot;A String&quot;, # The user-provided description of the audience. Only applicable to first party audiences.
199 &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.
200 &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.
201 &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.
202 &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.
203 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the first and third party audience.
204 &quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the first and third party audience. Assigned by the system.
205 &quot;firstAndThirdPartyAudienceType&quot;: &quot;A String&quot;, # Whether the audience is a first or third party audience.
206 &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.
207 &quot;membershipDurationDays&quot;: &quot;A String&quot;, # The duration in days that an entry remains in the audience after the qualifying event. The set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
208 &quot;mobileDeviceIdList&quot;: { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
209 &quot;consent&quot;: { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
210 &quot;adPersonalization&quot;: &quot;A String&quot;, # Represents consent for ad personalization.
211 &quot;adUserData&quot;: &quot;A String&quot;, # Represents consent for ad user data.
212 },
213 &quot;mobileDeviceIds&quot;: [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn&#x27;t be greater than 500,000.
214 &quot;A String&quot;,
215 ],
216 },
217 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the first and third party audience.
218 &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.
219 }</pre>
220 </div>
221
222 <div class="method">
223 <code class="details" id="editCustomerMatchMembers">editCustomerMatchMembers(firstAndThirdPartyAudienceId, body=None, x__xgafv=None)</code>
224 <pre>Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
225
226 Args:
227 firstAndThirdPartyAudienceId: string, Required. The ID of the Customer Match FirstAndThirdPartyAudience whose members will be edited. (required)
228 body: object, The request body.
229 The object takes the form of:
230
231 { # Request message for FirstAndThirdPartyAudienceService.EditCustomerMatchMembers.
232 &quot;addedContactInfoList&quot;: { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the members to be added.
233 &quot;consent&quot;: { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
234 &quot;adPersonalization&quot;: &quot;A String&quot;, # Represents consent for ad personalization.
235 &quot;adUserData&quot;: &quot;A String&quot;, # Represents consent for ad user data.
236 },
237 &quot;contactInfos&quot;: [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn&#x27;t be greater than 500,000.
238 { # Contact information defining a Customer Match audience member.
239 &quot;countryCode&quot;: &quot;A String&quot;, # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
240 &quot;hashedEmails&quot;: [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
241 &quot;A String&quot;,
242 ],
243 &quot;hashedFirstName&quot;: &quot;A String&quot;, # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
244 &quot;hashedLastName&quot;: &quot;A String&quot;, # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
245 &quot;hashedPhoneNumbers&quot;: [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
246 &quot;A String&quot;,
247 ],
248 &quot;zipCodes&quot;: [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
249 &quot;A String&quot;,
250 ],
251 },
252 ],
253 },
254 &quot;addedMobileDeviceIdList&quot;: { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the members to be added.
255 &quot;consent&quot;: { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
256 &quot;adPersonalization&quot;: &quot;A String&quot;, # Represents consent for ad personalization.
257 &quot;adUserData&quot;: &quot;A String&quot;, # Represents consent for ad user data.
258 },
259 &quot;mobileDeviceIds&quot;: [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn&#x27;t be greater than 500,000.
260 &quot;A String&quot;,
261 ],
262 },
263 &quot;advertiserId&quot;: &quot;A String&quot;, # Required. The ID of the owner advertiser of the updated Customer Match FirstAndThirdPartyAudience.
264 &quot;removedContactInfoList&quot;: { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the members to be removed.
265 &quot;consent&quot;: { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
266 &quot;adPersonalization&quot;: &quot;A String&quot;, # Represents consent for ad personalization.
267 &quot;adUserData&quot;: &quot;A String&quot;, # Represents consent for ad user data.
268 },
269 &quot;contactInfos&quot;: [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn&#x27;t be greater than 500,000.
270 { # Contact information defining a Customer Match audience member.
271 &quot;countryCode&quot;: &quot;A String&quot;, # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
272 &quot;hashedEmails&quot;: [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
273 &quot;A String&quot;,
274 ],
275 &quot;hashedFirstName&quot;: &quot;A String&quot;, # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
276 &quot;hashedLastName&quot;: &quot;A String&quot;, # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
277 &quot;hashedPhoneNumbers&quot;: [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
278 &quot;A String&quot;,
279 ],
280 &quot;zipCodes&quot;: [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
281 &quot;A String&quot;,
282 ],
283 },
284 ],
285 },
286 &quot;removedMobileDeviceIdList&quot;: { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the members to be removed.
287 &quot;consent&quot;: { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
288 &quot;adPersonalization&quot;: &quot;A String&quot;, # Represents consent for ad personalization.
289 &quot;adUserData&quot;: &quot;A String&quot;, # Represents consent for ad user data.
290 },
291 &quot;mobileDeviceIds&quot;: [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn&#x27;t be greater than 500,000.
292 &quot;A String&quot;,
293 ],
294 },
295 }
296
297 x__xgafv: string, V1 error format.
298 Allowed values
299 1 - v1 error format
300 2 - v2 error format
301
302 Returns:
303 An object of the form:
304
305 { # The response of FirstAndThirdPartyAudienceService.EditCustomerMatchMembers.
306 &quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Required. The ID of the updated Customer Match FirstAndThirdPartyAudience.
307 }</pre>
308 </div>
309
310 <div class="method">
311 <code class="details" id="get">get(firstAndThirdPartyAudienceId, advertiserId=None, partnerId=None, x__xgafv=None)</code>
312 <pre>Gets a first and third party audience.
313
314 Args:
315 firstAndThirdPartyAudienceId: string, Required. The ID of the first and third party audience to fetch. (required)
316 advertiserId: string, The ID of the advertiser that has access to the fetched first and third party audience.
317 partnerId: string, The ID of the partner that has access to the fetched first and third party audience.
318 x__xgafv: string, V1 error format.
319 Allowed values
320 1 - v1 error format
321 2 - v2 error format
322
323 Returns:
324 An object of the form:
325
326 { # 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.
327 &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.
328 &quot;appId&quot;: &quot;A String&quot;, # The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
329 &quot;audienceSource&quot;: &quot;A String&quot;, # Output only. The source of the audience.
330 &quot;audienceType&quot;: &quot;A String&quot;, # The type of the audience.
331 &quot;contactInfoList&quot;: { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`
332 &quot;consent&quot;: { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
333 &quot;adPersonalization&quot;: &quot;A String&quot;, # Represents consent for ad personalization.
334 &quot;adUserData&quot;: &quot;A String&quot;, # Represents consent for ad user data.
335 },
336 &quot;contactInfos&quot;: [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn&#x27;t be greater than 500,000.
337 { # Contact information defining a Customer Match audience member.
338 &quot;countryCode&quot;: &quot;A String&quot;, # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
339 &quot;hashedEmails&quot;: [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
340 &quot;A String&quot;,
341 ],
342 &quot;hashedFirstName&quot;: &quot;A String&quot;, # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
343 &quot;hashedLastName&quot;: &quot;A String&quot;, # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
344 &quot;hashedPhoneNumbers&quot;: [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
345 &quot;A String&quot;,
346 ],
347 &quot;zipCodes&quot;: [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
348 &quot;A String&quot;,
349 ],
350 },
351 ],
352 },
353 &quot;description&quot;: &quot;A String&quot;, # The user-provided description of the audience. Only applicable to first party audiences.
354 &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.
355 &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.
356 &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.
357 &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.
358 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the first and third party audience.
359 &quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the first and third party audience. Assigned by the system.
360 &quot;firstAndThirdPartyAudienceType&quot;: &quot;A String&quot;, # Whether the audience is a first or third party audience.
361 &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.
362 &quot;membershipDurationDays&quot;: &quot;A String&quot;, # The duration in days that an entry remains in the audience after the qualifying event. The set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
363 &quot;mobileDeviceIdList&quot;: { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
364 &quot;consent&quot;: { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
365 &quot;adPersonalization&quot;: &quot;A String&quot;, # Represents consent for ad personalization.
366 &quot;adUserData&quot;: &quot;A String&quot;, # Represents consent for ad user data.
367 },
368 &quot;mobileDeviceIds&quot;: [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn&#x27;t be greater than 500,000.
369 &quot;A String&quot;,
370 ],
371 },
372 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the first and third party audience.
373 &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.
374 }</pre>
375 </div>
376
377 <div class="method">
378 <code class="details" id="list">list(advertiserId=None, filter=None, orderBy=None, pageSize=None, pageToken=None, partnerId=None, x__xgafv=None)</code>
379 <pre>Lists first and third party audiences. The order is defined by the order_by parameter.
380
381 Args:
382 advertiserId: string, The ID of the advertiser that has access to the fetched first and third party audiences.
383 filter: string, Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. 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. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
384 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`.
385 pageSize: integer, Requested page size. Must be between `1` and `5000`. If unspecified, this value defaults to `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
386 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.
387 partnerId: string, The ID of the partner that has access to the fetched first and third party audiences.
388 x__xgafv: string, V1 error format.
389 Allowed values
390 1 - v1 error format
391 2 - v2 error format
392
393 Returns:
394 An object of the form:
395
396 {
397 &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.
398 { # 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.
399 &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.
400 &quot;appId&quot;: &quot;A String&quot;, # The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
401 &quot;audienceSource&quot;: &quot;A String&quot;, # Output only. The source of the audience.
402 &quot;audienceType&quot;: &quot;A String&quot;, # The type of the audience.
403 &quot;contactInfoList&quot;: { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`
404 &quot;consent&quot;: { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
405 &quot;adPersonalization&quot;: &quot;A String&quot;, # Represents consent for ad personalization.
406 &quot;adUserData&quot;: &quot;A String&quot;, # Represents consent for ad user data.
407 },
408 &quot;contactInfos&quot;: [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn&#x27;t be greater than 500,000.
409 { # Contact information defining a Customer Match audience member.
410 &quot;countryCode&quot;: &quot;A String&quot;, # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
411 &quot;hashedEmails&quot;: [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
412 &quot;A String&quot;,
413 ],
414 &quot;hashedFirstName&quot;: &quot;A String&quot;, # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
415 &quot;hashedLastName&quot;: &quot;A String&quot;, # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
416 &quot;hashedPhoneNumbers&quot;: [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
417 &quot;A String&quot;,
418 ],
419 &quot;zipCodes&quot;: [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
420 &quot;A String&quot;,
421 ],
422 },
423 ],
424 },
425 &quot;description&quot;: &quot;A String&quot;, # The user-provided description of the audience. Only applicable to first party audiences.
426 &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.
427 &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.
428 &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.
429 &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.
430 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the first and third party audience.
431 &quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the first and third party audience. Assigned by the system.
432 &quot;firstAndThirdPartyAudienceType&quot;: &quot;A String&quot;, # Whether the audience is a first or third party audience.
433 &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.
434 &quot;membershipDurationDays&quot;: &quot;A String&quot;, # The duration in days that an entry remains in the audience after the qualifying event. The set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
435 &quot;mobileDeviceIdList&quot;: { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
436 &quot;consent&quot;: { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
437 &quot;adPersonalization&quot;: &quot;A String&quot;, # Represents consent for ad personalization.
438 &quot;adUserData&quot;: &quot;A String&quot;, # Represents consent for ad user data.
439 },
440 &quot;mobileDeviceIds&quot;: [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn&#x27;t be greater than 500,000.
441 &quot;A String&quot;,
442 ],
443 },
444 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the first and third party audience.
445 &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.
446 },
447 ],
448 &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.
449 }</pre>
450 </div>
451
452 <div class="method">
453 <code class="details" id="list_next">list_next()</code>
454 <pre>Retrieves the next page of results.
455
456 Args:
457 previous_request: The request for the previous page. (required)
458 previous_response: The response from the request for the previous page. (required)
459
460 Returns:
461 A request object that you can call &#x27;execute()&#x27; on to request the next
462 page. Returns None if there are no more items in the collection.
463 </pre>
464 </div>
465
466 <div class="method">
467 <code class="details" id="patch">patch(firstAndThirdPartyAudienceId, advertiserId=None, body=None, updateMask=None, x__xgafv=None)</code>
468 <pre>Updates an existing FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
469
470 Args:
471 firstAndThirdPartyAudienceId: string, Output only. The unique ID of the first and third party audience. Assigned by the system. (required)
472 body: object, The request body.
473 The object takes the form of:
474
475 { # 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.
476 &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.
477 &quot;appId&quot;: &quot;A String&quot;, # The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
478 &quot;audienceSource&quot;: &quot;A String&quot;, # Output only. The source of the audience.
479 &quot;audienceType&quot;: &quot;A String&quot;, # The type of the audience.
480 &quot;contactInfoList&quot;: { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`
481 &quot;consent&quot;: { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
482 &quot;adPersonalization&quot;: &quot;A String&quot;, # Represents consent for ad personalization.
483 &quot;adUserData&quot;: &quot;A String&quot;, # Represents consent for ad user data.
484 },
485 &quot;contactInfos&quot;: [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn&#x27;t be greater than 500,000.
486 { # Contact information defining a Customer Match audience member.
487 &quot;countryCode&quot;: &quot;A String&quot;, # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
488 &quot;hashedEmails&quot;: [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
489 &quot;A String&quot;,
490 ],
491 &quot;hashedFirstName&quot;: &quot;A String&quot;, # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
492 &quot;hashedLastName&quot;: &quot;A String&quot;, # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
493 &quot;hashedPhoneNumbers&quot;: [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
494 &quot;A String&quot;,
495 ],
496 &quot;zipCodes&quot;: [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
497 &quot;A String&quot;,
498 ],
499 },
500 ],
501 },
502 &quot;description&quot;: &quot;A String&quot;, # The user-provided description of the audience. Only applicable to first party audiences.
503 &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.
504 &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.
505 &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.
506 &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.
507 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the first and third party audience.
508 &quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the first and third party audience. Assigned by the system.
509 &quot;firstAndThirdPartyAudienceType&quot;: &quot;A String&quot;, # Whether the audience is a first or third party audience.
510 &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.
511 &quot;membershipDurationDays&quot;: &quot;A String&quot;, # The duration in days that an entry remains in the audience after the qualifying event. The set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
512 &quot;mobileDeviceIdList&quot;: { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
513 &quot;consent&quot;: { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
514 &quot;adPersonalization&quot;: &quot;A String&quot;, # Represents consent for ad personalization.
515 &quot;adUserData&quot;: &quot;A String&quot;, # Represents consent for ad user data.
516 },
517 &quot;mobileDeviceIds&quot;: [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn&#x27;t be greater than 500,000.
518 &quot;A String&quot;,
519 ],
520 },
521 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the first and third party audience.
522 &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.
523 }
524
525 advertiserId: string, Required. The ID of the owner advertiser of the updated FirstAndThirdPartyAudience.
526 updateMask: string, Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays`
527 x__xgafv: string, V1 error format.
528 Allowed values
529 1 - v1 error format
530 2 - v2 error format
531
532 Returns:
533 An object of the form:
534
535 { # 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.
536 &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.
537 &quot;appId&quot;: &quot;A String&quot;, # The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
538 &quot;audienceSource&quot;: &quot;A String&quot;, # Output only. The source of the audience.
539 &quot;audienceType&quot;: &quot;A String&quot;, # The type of the audience.
540 &quot;contactInfoList&quot;: { # Wrapper message for a list of contact information defining Customer Match audience members. # Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO`
541 &quot;consent&quot;: { # User consent status. # Input only. The consent setting for the users in contact_infos. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
542 &quot;adPersonalization&quot;: &quot;A String&quot;, # Represents consent for ad personalization.
543 &quot;adUserData&quot;: &quot;A String&quot;, # Represents consent for ad user data.
544 },
545 &quot;contactInfos&quot;: [ # A list of ContactInfo objects defining Customer Match audience members. The size of members after splitting the contact_infos mustn&#x27;t be greater than 500,000.
546 { # Contact information defining a Customer Match audience member.
547 &quot;countryCode&quot;: &quot;A String&quot;, # Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes
548 &quot;hashedEmails&quot;: [ # A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase.
549 &quot;A String&quot;,
550 ],
551 &quot;hashedFirstName&quot;: &quot;A String&quot;, # SHA256 hashed first name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_last_name * zip_codes
552 &quot;hashedLastName&quot;: &quot;A String&quot;, # SHA256 hashed last name of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. Must also be set with the following fields: * country_code * hashed_first_name * zip_codes
553 &quot;hashedPhoneNumbers&quot;: [ # A list of SHA256 hashed phone numbers of the member. Before hashing, all phone numbers must be formatted using the [E.164 format](//en.wikipedia.org/wiki/E.164) and include the country calling code.
554 &quot;A String&quot;,
555 ],
556 &quot;zipCodes&quot;: [ # A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name
557 &quot;A String&quot;,
558 ],
559 },
560 ],
561 },
562 &quot;description&quot;: &quot;A String&quot;, # The user-provided description of the audience. Only applicable to first party audiences.
563 &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.
564 &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.
565 &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.
566 &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.
567 &quot;displayName&quot;: &quot;A String&quot;, # The display name of the first and third party audience.
568 &quot;firstAndThirdPartyAudienceId&quot;: &quot;A String&quot;, # Output only. The unique ID of the first and third party audience. Assigned by the system.
569 &quot;firstAndThirdPartyAudienceType&quot;: &quot;A String&quot;, # Whether the audience is a first or third party audience.
570 &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.
571 &quot;membershipDurationDays&quot;: &quot;A String&quot;, # The duration in days that an entry remains in the audience after the qualifying event. The set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID`
572 &quot;mobileDeviceIdList&quot;: { # Wrapper message for a list of mobile device IDs defining Customer Match audience members. # Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID`
573 &quot;consent&quot;: { # User consent status. # Input only. The consent setting for the users in mobile_device_ids. Leaving this field unset indicates that consent is not specified. If ad_user_data or ad_personalization fields are set to `CONSENT_STATUS_DENIED`, the request will return an error.
574 &quot;adPersonalization&quot;: &quot;A String&quot;, # Represents consent for ad personalization.
575 &quot;adUserData&quot;: &quot;A String&quot;, # Represents consent for ad user data.
576 },
577 &quot;mobileDeviceIds&quot;: [ # A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn&#x27;t be greater than 500,000.
578 &quot;A String&quot;,
579 ],
580 },
581 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the first and third party audience.
582 &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.
583 }</pre>
584 </div>
585
586 </body></html>