1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="datamanager_v1.html">Data Manager API</a> . <a href="datamanager_v1.audienceMembers.html">audienceMembers</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#ingest">ingest(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Uploads a list of AudienceMember resources to the provided Destination.</p>
<p class="toc_element">
<code><a href="#remove">remove(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Removes a list of AudienceMember resources from the provided Destination.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="ingest">ingest(body=None, x__xgafv=None)</code>
<pre>Uploads a list of AudienceMember resources to the provided Destination.
Args:
body: object, The request body.
The object takes the form of:
{ # Request to upload audience members to the provided destinations. Returns an IngestAudienceMembersResponse.
"audienceMembers": [ # Required. The list of users to send to the specified destinations. At most 10000 AudienceMember resources can be sent in a single request.
{ # The audience member to be operated on.
"consent": { # [Digital Markets Act (DMA)](//digital-markets-act.ec.europa.eu/index_en) consent settings for the user. # Optional. The consent setting for the user.
"adPersonalization": "A String", # Optional. Represents if the user consents to ad personalization.
"adUserData": "A String", # Optional. Represents if the user consents to ad user data.
},
"destinationReferences": [ # Optional. Defines which Destination to send the audience member to.
"A String",
],
"mobileData": { # Mobile IDs for the audience. At least one mobile ID is required. # Data identifying the user's mobile devices.
"mobileIds": [ # Required. The list of mobile device IDs (advertising ID/IDFA). At most 10 `mobileIds` can be provided in a single AudienceMember.
"A String",
],
},
"pairData": { # [PAIR](//support.google.com/admanager/answer/15067908) IDs for the audience. At least one PAIR ID is required. # [Publisher Advertiser Identity Reconciliation (PAIR) IDs](//support.google.com/admanager/answer/15067908).
"pairIds": [ # Required. Cleanroom-provided PII data, hashed with SHA256, and encrypted with an EC commutative cipher using publisher key for the [PAIR]((//support.google.com/admanager/answer/15067908)) user list. At most 10 `pairIds` can be provided in a single AudienceMember.
"A String",
],
},
"userData": { # Data that identifies the user. At least one identifier is required. # User-provided data that identifies the user.
"userIdentifiers": [ # Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 `userIdentifiers` can be provided in a single AudienceMember or Event.
{ # A single identifier for the user.
"address": { # Address information for the user. # The known components of a user's address. Holds a grouping of identifiers that are matched all at once.
"familyName": "A String", # Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.
"givenName": "A String", # Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.
"postalCode": "A String", # Required. The postal code of the user's address.
"regionCode": "A String", # Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.
},
"emailAddress": "A String", # Hashed email address using SHA-256 hash function after normalization.
"phoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard).
},
],
},
},
],
"consent": { # [Digital Markets Act (DMA)](//digital-markets-act.ec.europa.eu/index_en) consent settings for the user. # Optional. Request-level consent to apply to all users in the request. User-level consent overrides request-level consent, and can be specified in each AudienceMember.
"adPersonalization": "A String", # Optional. Represents if the user consents to ad personalization.
"adUserData": "A String", # Optional. Represents if the user consents to ad user data.
},
"destinations": [ # Required. The list of destinations to send the audience members to.
{ # The Google product you're sending data to. For example, a Google Ads account.
"linkedAccount": { # Represents a specific account. # Optional. An account that the calling user's `login_account` has access to, through an established account link. For example, a data partner's `login_account` might have access to a client's `linked_account`. The partner might use this field to send data from the `linked_account` to another `operating_account`.
"accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID.
"accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match.
"product": "A String", # Deprecated. Use `account_type` instead.
},
"loginAccount": { # Represents a specific account. # Optional. The account used to make this API call. To add or remove data from the `operating_account`, this `login_account` must have write access to the `operating_account`. For example, a manager account of the `operating_account`, or an account with an established link to the `operating_account`.
"accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID.
"accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match.
"product": "A String", # Deprecated. Use `account_type` instead.
},
"operatingAccount": { # Represents a specific account. # Required. The account to send the data to or remove the data from.
"accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID.
"accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match.
"product": "A String", # Deprecated. Use `account_type` instead.
},
"productDestinationId": "A String", # Required. The object within the product account to ingest into. For example, a Google Ads audience ID, a Display & Video 360 audience ID or a Google Ads conversion action ID.
"reference": "A String", # Optional. ID for this `Destination` resource, unique within the request. Use to reference this `Destination` in the IngestEventsRequest and IngestAudienceMembersRequest.
},
],
"encoding": "A String", # Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non `UserData` uploads, this field is ignored.
"encryptionInfo": { # Encryption information for the data being ingested. # Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non `UserData` uploads, this field is ignored.
"gcpWrappedKeyInfo": { # Information about the Google Cloud Platform wrapped key. # Google Cloud Platform wrapped key information.
"encryptedDek": "A String", # Required. The base64 encoded encrypted data encryption key.
"kekUri": "A String", # Required. Google Cloud Platform [Cloud Key Management Service resource ID](//cloud.google.com/kms/docs/getting-resource-ids). Should be in the format of "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}".
"keyType": "A String", # Required. The type of algorithm used to encrypt the data.
"wipProvider": "A String", # Required. The [Workload Identity](//cloud.google.com/iam/docs/workload-identity-federation) pool provider required to use KEK.
},
},
"termsOfService": { # The terms of service that the user has accepted/rejected. # Optional. The terms of service that the user has accepted/rejected.
"customerMatchTermsOfServiceStatus": "A String", # Optional. The Customer Match terms of service: https://support.google.com/adspolicy/answer/6299717. This must be accepted when ingesting UserData or MobileData. This field is not required for Partner Match User list.
},
"validateOnly": True or False, # Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response from the IngestAudienceMembersRequest.
"requestId": "A String", # The auto-generated ID of the request.
}</pre>
</div>
<div class="method">
<code class="details" id="remove">remove(body=None, x__xgafv=None)</code>
<pre>Removes a list of AudienceMember resources from the provided Destination.
Args:
body: object, The request body.
The object takes the form of:
{ # Request to remove users from an audience in the provided destinations. Returns a RemoveAudienceMembersResponse.
"audienceMembers": [ # Required. The list of users to remove.
{ # The audience member to be operated on.
"consent": { # [Digital Markets Act (DMA)](//digital-markets-act.ec.europa.eu/index_en) consent settings for the user. # Optional. The consent setting for the user.
"adPersonalization": "A String", # Optional. Represents if the user consents to ad personalization.
"adUserData": "A String", # Optional. Represents if the user consents to ad user data.
},
"destinationReferences": [ # Optional. Defines which Destination to send the audience member to.
"A String",
],
"mobileData": { # Mobile IDs for the audience. At least one mobile ID is required. # Data identifying the user's mobile devices.
"mobileIds": [ # Required. The list of mobile device IDs (advertising ID/IDFA). At most 10 `mobileIds` can be provided in a single AudienceMember.
"A String",
],
},
"pairData": { # [PAIR](//support.google.com/admanager/answer/15067908) IDs for the audience. At least one PAIR ID is required. # [Publisher Advertiser Identity Reconciliation (PAIR) IDs](//support.google.com/admanager/answer/15067908).
"pairIds": [ # Required. Cleanroom-provided PII data, hashed with SHA256, and encrypted with an EC commutative cipher using publisher key for the [PAIR]((//support.google.com/admanager/answer/15067908)) user list. At most 10 `pairIds` can be provided in a single AudienceMember.
"A String",
],
},
"userData": { # Data that identifies the user. At least one identifier is required. # User-provided data that identifies the user.
"userIdentifiers": [ # Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 `userIdentifiers` can be provided in a single AudienceMember or Event.
{ # A single identifier for the user.
"address": { # Address information for the user. # The known components of a user's address. Holds a grouping of identifiers that are matched all at once.
"familyName": "A String", # Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.
"givenName": "A String", # Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.
"postalCode": "A String", # Required. The postal code of the user's address.
"regionCode": "A String", # Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.
},
"emailAddress": "A String", # Hashed email address using SHA-256 hash function after normalization.
"phoneNumber": "A String", # Hashed phone number using SHA-256 hash function after normalization (E164 standard).
},
],
},
},
],
"destinations": [ # Required. The list of destinations to remove the users from.
{ # The Google product you're sending data to. For example, a Google Ads account.
"linkedAccount": { # Represents a specific account. # Optional. An account that the calling user's `login_account` has access to, through an established account link. For example, a data partner's `login_account` might have access to a client's `linked_account`. The partner might use this field to send data from the `linked_account` to another `operating_account`.
"accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID.
"accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match.
"product": "A String", # Deprecated. Use `account_type` instead.
},
"loginAccount": { # Represents a specific account. # Optional. The account used to make this API call. To add or remove data from the `operating_account`, this `login_account` must have write access to the `operating_account`. For example, a manager account of the `operating_account`, or an account with an established link to the `operating_account`.
"accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID.
"accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match.
"product": "A String", # Deprecated. Use `account_type` instead.
},
"operatingAccount": { # Represents a specific account. # Required. The account to send the data to or remove the data from.
"accountId": "A String", # Required. The ID of the account. For example, your Google Ads account ID.
"accountType": "A String", # Optional. The type of the account. For example, `GOOGLE_ADS`. Either `account_type` or the deprecated `product` is required. If both are set, the values must match.
"product": "A String", # Deprecated. Use `account_type` instead.
},
"productDestinationId": "A String", # Required. The object within the product account to ingest into. For example, a Google Ads audience ID, a Display & Video 360 audience ID or a Google Ads conversion action ID.
"reference": "A String", # Optional. ID for this `Destination` resource, unique within the request. Use to reference this `Destination` in the IngestEventsRequest and IngestAudienceMembersRequest.
},
],
"encoding": "A String", # Optional. Required for UserData uploads. The encoding type of the user identifiers. Applies to only the outer encoding for encrypted user identifiers. For non `UserData` uploads, this field is ignored.
"encryptionInfo": { # Encryption information for the data being ingested. # Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non `UserData` uploads, this field is ignored.
"gcpWrappedKeyInfo": { # Information about the Google Cloud Platform wrapped key. # Google Cloud Platform wrapped key information.
"encryptedDek": "A String", # Required. The base64 encoded encrypted data encryption key.
"kekUri": "A String", # Required. Google Cloud Platform [Cloud Key Management Service resource ID](//cloud.google.com/kms/docs/getting-resource-ids). Should be in the format of "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}".
"keyType": "A String", # Required. The type of algorithm used to encrypt the data.
"wipProvider": "A String", # Required. The [Workload Identity](//cloud.google.com/iam/docs/workload-identity-federation) pool provider required to use KEK.
},
},
"validateOnly": True or False, # Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response from the RemoveAudienceMembersRequest.
"requestId": "A String", # The auto-generated ID of the request.
}</pre>
</div>
</body></html>
|
