Package google.ads.datamanager.v1
Stay organized with collections Save and categorize content based on your preferences.

Index

IngestionService (interface)
AddressInfo (message)
AudienceMember (message)
Consent (message)
ConsentStatus (enum)
Destination (message)
Encoding (enum)
EncryptionInfo (message)
GcpWrappedKeyInfo (message)
GcpWrappedKeyInfo.KeyType (enum)
IngestAudienceMembersRequest (message)
IngestAudienceMembersResponse (message)
MobileData (message)
PairData (message)
Product (enum)
ProductAccount (message)
RemoveAudienceMembersRequest (message)
RemoveAudienceMembersResponse (message)
TermsOfService (message)
TermsOfServiceStatus (enum)
UserData (message)
UserIdentifier (message)

IngestionService

Service for sending audience data to supported destinations.

IngestAudienceMembers

IngestAudienceMembers
`rpc IngestAudienceMembers(IngestAudienceMembersRequest) returns (IngestAudienceMembersResponse)` Uploads a list of `AudienceMember` resources to the provided `Destination`. Authorization scopes Requires the following OAuth scope: `https://www.googleapis.com/auth/datamanager`

rpc IngestAudienceMembers(IngestAudienceMembersRequest) returns (IngestAudienceMembersResponse)

Uploads a list of AudienceMember resources to the provided Destination.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/datamanager

RemoveAudienceMembers

RemoveAudienceMembers
`rpc RemoveAudienceMembers(RemoveAudienceMembersRequest) returns (RemoveAudienceMembersResponse)` Removes a list of `AudienceMember` resources from the provided `Destination`. Authorization scopes Requires the following OAuth scope: `https://www.googleapis.com/auth/datamanager`

rpc RemoveAudienceMembers(RemoveAudienceMembersRequest) returns (RemoveAudienceMembersResponse)

Removes a list of AudienceMember resources from the provided Destination.

Authorization scopes

Requires the following OAuth scope:

https://www.googleapis.com/auth/datamanager

AddressInfo

Address information for the user.

Fields
`given_name`	`string` Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.
`family_name`	`string` Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.
`region_code`	`string` Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user's address.
`postal_code`	`string` Required. The postal code of the user's address.

AudienceMember

The audience member to be operated on.

Fields
`consent`	`Consent` Optional. The consent setting for the user.
Union field `data`. The type of identifying data to be operated on. `data` can be only one of the following:
`user_data`	`UserData` User-provided data that identifies the user.
`pair_data`	`PairData` Publisher Advertiser Identity Reconciliation (PAIR) IDs.
`mobile_data`	`MobileData` Data identifying the user's mobile devices.

Fields
`ad_user_data`	`ConsentStatus` Optional. Represents if the user consents to ad user data.
`ad_personalization`	`ConsentStatus` Optional. Represents if the user consents to ad personalization.

ConsentStatus

Represents if the user granted, denied, or hasn't specified consent.

Enums
`CONSENT_STATUS_UNSPECIFIED`	Not specified.
`CONSENT_GRANTED`	Granted.
`CONSENT_DENIED`	Denied.

Destination

The Google product you're sending data to. For example, a Google Ads account.

Fields
`login_account`	`ProductAccount` 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`.
`linked_account`	`ProductAccount` 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`.
`operating_account`	`ProductAccount` Required. The account to send the data to or remove the data from.
`product_destination_id`	`string` Required. The object within the product account to ingest into. For example, a Google Ads audience ID or a Display & Video 360 audience ID.

Encoding

The encoding type of the hashed identifying information.

Enums
`ENCODING_UNSPECIFIED`	Unspecified Encoding type. Should never be used.
`HEX`	Hex encoding.
`BASE64`	Base 64 encoding.

EncryptionInfo

Encryption information for the data being ingested.

Fields

Fields
Union field `wrapped_key`. The wrapped key used to encrypt the data. `wrapped_key` can be only one of the following:
`gcp_wrapped_key_info`	`GcpWrappedKeyInfo` Google Cloud Platform wrapped key information.

Union field wrapped_key. The wrapped key used to encrypt the data. wrapped_key can be only one of the following:

gcp_wrapped_key_info

GcpWrappedKeyInfo

Google Cloud Platform wrapped key information.

GcpWrappedKeyInfo

Information about the Google Cloud Platform wrapped key.

Fields
`key_type`	`KeyType` Required. The type of algorithm used to encrypt the data.
`wip_provider`	`string` Required. The Workload Identity pool provider required to use KEK.
`kek_uri`	`string` Required. Google Cloud Platform Cloud Key Management Service resource ID.
`encrypted_dek`	`string` Required. The base64 encoded encrypted data encryption key.

KeyType

The type of algorithm used to encrypt the data.

Enums
`KEY_TYPE_UNSPECIFIED`	Unspecified key type. Should never be used.
`XCHACHA20_POLY1305`	Algorithm XChaCha20-Poly1305

IngestAudienceMembersRequest

Request to upload audience members to the provided destinations. Returns an IngestAudienceMembersResponse.

Fields
`destinations[]`	`Destination` Required. The list of destinations to send the audience members to.
`audience_members[]`	`AudienceMember` Required. The list of users to send to the specified destinations. At most 10000 `AudienceMember` resources can be sent in a single request.
`consent`	`Consent` 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`.
`validate_only`	`bool` Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results.
`encoding`	`Encoding` 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.
`encryption_info`	`EncryptionInfo` 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.
`terms_of_service`	`TermsOfService` Optional. The terms of service that the user has accepted/rejected.

IngestAudienceMembersResponse

Response from the IngestAudienceMembersRequest.

Fields

Fields
`request_id`	`string` The auto-generated ID of the request.

request_id

string

The auto-generated ID of the request.

MobileData

Mobile IDs for the audience. At least one mobile ID is required.

Fields

Fields
`mobile_ids[]`	`string` Required. The list of mobile device IDs (advertising ID/IDFA). At most 10 `mobileIds` can be provided in a single `AudienceMember`.

mobile_ids[]

string

Required. The list of mobile device IDs (advertising ID/IDFA). At most 10 mobileIds can be provided in a single AudienceMember.

PairData

PAIR IDs for the audience. At least one PAIR ID is required.

Fields

Fields
`pair_ids[]`	`string` Required. Cleanroom-provided PII data, hashed with SHA256, and encrypted with an EC commutative cipher using publisher key for the PAIR user list. At most 10 `pairIds` can be provided in a single `AudienceMember`.

pair_ids[]

string

Required. Cleanroom-provided PII data, hashed with SHA256, and encrypted with an EC commutative cipher using publisher key for the PAIR user list. At most 10 pairIds can be provided in a single AudienceMember.

Product

Represents a specific Google product. Used to locate accounts and destinations.

Enums
`PRODUCT_UNSPECIFIED`	Unspecified product. Should never be used.
`GOOGLE_ADS`	Google Ads.
`DISPLAY_VIDEO_PARTNER`	Display & Video 360 partner.
`DISPLAY_VIDEO_ADVERTISER`	Display & Video 360 advertiser.
`DATA_PARTNER`	Data Partner.

ProductAccount

Represents a specific account.

Fields

Fields
`product`	`Product` Required. The product the account belongs to. For example, `GOOGLE_ADS`.
`account_id`	`string` Required. The ID of the account. For example, your Google Ads account ID.

product

Product

Required. The product the account belongs to. For example, GOOGLE_ADS.

account_id

string

Required. The ID of the account. For example, your Google Ads account ID.

RemoveAudienceMembersRequest

Request to remove users from an audience in the provided destinations. Returns a RemoveAudienceMembersResponse.

Fields
`destinations[]`	`Destination` Required. The list of destinations to remove the users from.
`audience_members[]`	`AudienceMember` Required. The list of users to remove.
`validate_only`	`bool` Optional. For testing purposes. If `true`, the request is validated but not executed. Only errors are returned, not results.
`encoding`	`Encoding` 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.
`encryption_info`	`EncryptionInfo` 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.

RemoveAudienceMembersResponse

Response from the RemoveAudienceMembersRequest.

Fields

Fields
`request_id`	`string` The auto-generated ID of the request.

request_id

string

The auto-generated ID of the request.

TermsOfService

The terms of service that the user has accepted/rejected.

Fields

Fields
`customer_match_terms_of_service_status`	`TermsOfServiceStatus` Optional. The Customer Match terms of service: https://support.google.com/adspolicy/answer/6299717. This must be accepted for all uploads to Customer Match userlists.

customer_match_terms_of_service_status

TermsOfServiceStatus

Optional. The Customer Match terms of service: https://support.google.com/adspolicy/answer/6299717. This must be accepted for all uploads to Customer Match userlists.

TermsOfServiceStatus

Represents the caller's decision to accept or reject the terms of service.

Enums
`TERMS_OF_SERVICE_STATUS_UNSPECIFIED`	Not specified.
`ACCEPTED`	Status indicating the caller has chosen to accept the terms of service.
`REJECTED`	Status indicating the caller has chosen to reject the terms of service.

UserData

Data that identifies the user. At least one identifier is required.

Fields

Fields
`user_identifiers[]`	`UserIdentifier` 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`.

user_identifiers[]

UserIdentifier

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.

UserIdentifier

A single identifier for the user.

Fields
Union field `identifier`. Exactly one must be specified. `identifier` can be only one of the following:
`email_address`	`string` Hashed email address using SHA-256 hash function after normalization.
`phone_number`	`string` Hashed phone number using SHA-256 hash function after normalization (E164 standard).
`address`	`AddressInfo` The known components of a user's address. Holds a grouping of identifiers that are matched all at once.

Package google.ads.datamanager.v1Stay organized with collections Save and categorize content based on your preferences.

Index

IngestionService

AddressInfo

AudienceMember

Consent

ConsentStatus

Destination

Encoding

EncryptionInfo

GcpWrappedKeyInfo

KeyType

IngestAudienceMembersRequest

IngestAudienceMembersResponse

MobileData

PairData

Product

ProductAccount

RemoveAudienceMembersRequest

RemoveAudienceMembersResponse

TermsOfService

TermsOfServiceStatus

UserData

UserIdentifier

Package google.ads.datamanager.v1
Stay organized with collections Save and categorize content based on your preferences.