Package google.ads.datamanager.v1

  • The IngestionService allows uploading and removing audience data to supported destinations through methods like IngestAudienceMembers and RemoveAudienceMembers.

  • The API supports different types of identifiers for audience members and events, including user-provided data, PAIR IDs, and mobile device data.

  • Detailed status information for requests can be retrieved using the RetrieveRequestStatus method, including success, processing, failed, or partial success statuses per destination.

  • Data can be encrypted using Google Cloud Platform wrapped keys, and the API provides specific reasons for processing errors and warnings.

  • User data and events can include consent information for DMA compliance and advertiser-assessed user properties.

Index

IngestionService

Service for sending audience data to supported destinations.

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
IngestEvents

rpc IngestEvents(IngestEventsRequest) returns (IngestEventsResponse)

Uploads a list of Event resources from the provided Destination.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/datamanager
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
RetrieveRequestStatus

rpc RetrieveRequestStatus(RetrieveRequestStatusRequest) returns (RetrieveRequestStatusResponse)

Gets the status of a request given request id.

Authorization scopes

Requires the following OAuth scope:

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

AdIdentifiers

Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).

Fields
session_attributes

string

Optional. Session attributes for event attribution and modeling.
gclid

string

Optional. The Google click ID (gclid) associated with this event.
gbraid

string

Optional. The click identifier for clicks associated with app events and originating from iOS devices starting with iOS14.
wbraid

string

Optional. The click identifier for clicks associated with web events and originating from iOS devices starting with iOS14.
landing_page_device_info

DeviceInfo

Optional. Information gathered about the device being used (if any) at the time of landing onto the advertiser’s site after interacting with the ad.

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
destination_references[]

string

Optional. Defines which Destination to send the audience member to.
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.

AwsWrappedKeyInfo

A data encryption key wrapped by an AWS KMS key.

Fields
key_type

KeyType

Required. The type of algorithm used to encrypt the data.
role_arn

string

Required. The Amazon Resource Name of the IAM Role to assume for KMS decryption access. Should be in the format of "arn:{partition}:iam::{account_id}:role/{role_name}"
kek_uri

string

Required. The URI of the AWS KMS key used to decrypt the DEK. Should be in the format of "arn:{partition}:kms:{region}:{account_id}:key/{key_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

CartData

The cart data associated with the event.

Fields
merchant_id

string

Optional. The Merchant Center ID associated with the items.
merchant_feed_label

string

Optional. The Merchant Center feed label associated with the feed of the items.
merchant_feed_language_code

string

Optional. The language code in ISO 639-1 associated with the Merchant Center feed of the items.where your items are uploaded.
transaction_discount

double

Optional. The sum of all discounts associated with the transaction.
items[]

Item

Optional. The list of items associated with the event.

Digital Markets Act (DMA) consent settings for the user.

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.

CustomVariable

Custom variable for ads conversions.

Fields
variable

string

Optional. The name of the custom variable to set. If the variable is not found for the given destination, it will be ignored.
value

string

Optional. The value to store for the custom variable.
destination_references[]

string

Optional. Reference string used to determine which of the Event.destination_references the custom variable should be sent to. If empty, the Event.destination_references will be used.

CustomerType

Type of the customer associated with the event.

Enums
CUSTOMER_TYPE_UNSPECIFIED Unspecified CustomerType. Should never be used.
NEW The customer is new to the advertiser.
RETURNING The customer is returning to the advertiser.
REENGAGED The customer has re-engaged with the advertiser.

CustomerValueBucket

The advertiser-assessed value of the customer.

Enums
CUSTOMER_VALUE_BUCKET_UNSPECIFIED Unspecified CustomerValueBucket. Should never be used.
LOW The customer is low value.
MEDIUM The customer is medium value.
HIGH The customer is high value.

Destination

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

Fields
reference

string

Optional. ID for this Destination resource, unique within the request. Use to reference this Destination in the IngestEventsRequest and IngestAudienceMembersRequest.
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, a Display & Video 360 audience ID or a Google Ads conversion action ID.

DeviceInfo

Information about the device being used (if any) when the event happened.

Fields
user_agent

string

Optional. The user-agent string of the device for the given context.
ip_address

string

Optional. The IP address of the device for the given context.

Note: Google Ads does not support IP address matching for end users in the European Economic Area (EEA), United Kingdom (UK), or Switzerland (CH). Add logic to conditionally exclude sharing IP addresses from users from these regions and ensure that you provide users with clear and comprehensive information about the data you collect on your sites, apps, and other properties and get consent where required by law or any applicable Google policies. See the About offline conversion imports page for more details.

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
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.
aws_wrapped_key_info

AwsWrappedKeyInfo

Amazon Web Services wrapped key information.

ErrorCount

The error count for a given error reason.

Fields
record_count

int64

The count of records that failed to upload for a given reason.
reason

ProcessingErrorReason

The error reason of the failed records.

ErrorInfo

Error counts for each type of error.

Fields
error_counts[]

ErrorCount

A list of errors and counts per error reason. May not be populated in all cases.

ErrorReason

Error reasons for Data Manager API.

Enums
ERROR_REASON_UNSPECIFIED Do not use this default value.
INTERNAL_ERROR An internal error has occurred.
DEADLINE_EXCEEDED The request took too long to respond.
RESOURCE_EXHAUSTED Too many requests.
NOT_FOUND Resource not found.
PERMISSION_DENIED The user does not have permission or the resource is not found.
INVALID_ARGUMENT There was a problem with the request.
REQUIRED_FIELD_MISSING Required field is missing.
INVALID_FORMAT Format is invalid.
INVALID_HEX_ENCODING The HEX encoded value is malformed.
INVALID_BASE64_ENCODING The base64 encoded value is malformed.
INVALID_SHA256_FORMAT The SHA256 encoded value is malformed.
INVALID_POSTAL_CODE Postal code is not valid.
INVALID_COUNTRY_CODE Country code is not valid.
INVALID_ENUM_VALUE Enum value cannot be used.
INVALID_USER_LIST_TYPE Type of the user list is not applicable for this request.
INVALID_AUDIENCE_MEMBER This audience member is not valid.
TOO_MANY_AUDIENCE_MEMBERS Maximum number of audience members allowed per request is 10,000.
TOO_MANY_USER_IDENTIFIERS Maximum number of user identifiers allowed per audience member is 10.
TOO_MANY_DESTINATIONS Maximum number of destinations allowed per request is 10.
INVALID_DESTINATION This Destination is not valid.
DATA_PARTNER_USER_LIST_MUTATE_NOT_ALLOWED Data Partner does not have access to the operating account owned userlist.
INVALID_MOBILE_ID_FORMAT Mobile ID format is not valid.
INVALID_USER_LIST_ID User list is not valid.
MULTIPLE_DATA_TYPES_NOT_ALLOWED Multiple data types are not allowed to be ingested in a single request.
DIFFERENT_LOGIN_ACCOUNTS_NOT_ALLOWED_FOR_DATA_PARTNER Destination configs containing a DataPartner login account must have the same login account across all destination configs.
TERMS_AND_CONDITIONS_NOT_SIGNED Required terms and conditions are not accepted.
INVALID_NUMBER_FORMAT Invalid number format.
INVALID_CONVERSION_ACTION_ID Conversion action ID is not valid.
INVALID_CONVERSION_ACTION_TYPE The conversion action type is not valid.
INVALID_CURRENCY_CODE The currency code is not supported.
INVALID_EVENT This event is not valid.
TOO_MANY_EVENTS Maximum number of events allowed per request is 10,000.
DESTINATION_ACCOUNT_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS The destination account is not enabled for enhanced conversions for leads.
DESTINATION_ACCOUNT_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS Enhanced conversions can't be used for the destination account because of Google customer data policies. Contact your Google representative..
DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED The destination account hasn't agreed to the terms for enhanced conversions.
DUPLICATE_DESTINATION_REFERENCE Two or more destinations in the request have the same reference.
UNSUPPORTED_OPERATING_ACCOUNT_FOR_DATA_PARTNER Unsupported operating account for data partner authorization.
UNSUPPORTED_LINKED_ACCOUNT_FOR_DATA_PARTNER Unsupported linked account for data partner authorization.
NO_IDENTIFIERS_PROVIDED Events data contains no user identifiers or ad identifiers.
INVALID_PROPERTY_TYPE The property type is not supported.
INVALID_STREAM_TYPE The stream type is not supported.
LINKED_ACCOUNT_ONLY_ALLOWED_WITH_DATA_PARTNER_LOGIN_ACCOUNT Linked account is only supported when the login account is a DATA_PARTNER account.
OPERATING_ACCOUNT_LOGIN_ACCOUNT_MISMATCH The login account must be the same as the operating account for the given use case.
EVENT_TIME_INVALID Event did not occur within the acceptable time window.
RESERVED_NAME_USED Parameter uses a reserved name.
INVALID_EVENT_NAME The event name is not supported.
NOT_ALLOWLISTED The account is not allowlisted for the given feature.
INVALID_REQUEST_ID The request ID used to retrieve the status of a request is not valid. Status can only be retrieved for requests that succeed and don't have validate_only=true.
MULTIPLE_DESTINATIONS_FOR_GOOGLE_ANALYTICS_EVENT An event had 2 or more Google Analytics destinations.
FIELD_VALUE_TOO_LONG The field value is too long.
TOO_MANY_ELEMENTS Too many elements in a list in the request.

Event

An event representing a user interaction with an advertiser's website or app.

Fields
destination_references[]

string

Optional. Reference string used to determine the destination. If empty, the event will be sent to all destinations in the request.
transaction_id

string

Optional. The unique identifier for this event. Required for conversions using multiple data sources.
event_timestamp

Timestamp

Required. The time the event occurred.
last_updated_timestamp

Timestamp

Optional. The last time the event was updated.
user_data

UserData

Optional. Pieces of user provided data, representing the user the event is associated with.
consent

Consent

Optional. Information about whether the associated user has provided different types of consent.
ad_identifiers

AdIdentifiers

Optional. Identifiers and other information used to match the conversion event with other online activity (such as ad clicks).
currency

string

Optional. The currency code associated with all monetary values within this event.
conversion_value

double

Optional. The conversion value associated with the event, for value-based conversions.
event_source

EventSource

Optional. Signal for where the event happened (web, app, in-store, etc.).
event_device_info

DeviceInfo

Optional. Information gathered about the device being used (if any) when the event happened.
cart_data

CartData

Optional. Information about the transaction and items associated with the event.
custom_variables[]

CustomVariable

Optional. Additional key/value pair information to send to the conversion containers (conversion action or FL activity).
experimental_fields[]

ExperimentalField

Optional. A list of key/value pairs for experimental fields that may eventually be promoted to be part of the API.
user_properties

UserProperties

Optional. Advertiser-assessed information about the user at the time that the event happened.
event_name

string

Optional. The name of the event. Required for GA4 events.
client_id

string

Optional. A unique identifier for the user instance of a web client for this GA4 web stream.
user_id

string

Optional. A unique identifier for a user, as defined by the advertiser.
additional_event_parameters[]

EventParameter

Optional. A bucket of any event parameters to be included within the event that were not already specified using other structured fields.

EventParameter

Event parameter for GA4 events.

Fields
parameter_name

string

Required. The name of the parameter to use.
value

string

Required. The string representation of the value of the parameter to set.

EventSource

The source of the event.

Enums
EVENT_SOURCE_UNSPECIFIED Unspecified EventSource. Should never be used.
WEB The event was generated from a web browser.
APP The event was generated from an app.
IN_STORE The event was generated from an in-store transaction.
PHONE The event was generated from a phone call.
OTHER The event was generated from other sources.

ExperimentalField

Experimental field representing unofficial fields.

Fields
field

string

Optional. The name of the field to use.
value

string

Optional. The value the field to set.

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. Should be in the format of "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}".
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.

You can try this method in the REST APIs explorer:
Try it with REST
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
request_id

string

The auto-generated ID of the request.

IngestEventsRequest

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

You can try this method in the REST APIs explorer:
Try it with REST
Fields
destinations[]

Destination

Required. The list of destinations to send the events to.
events[]

Event

Required. The list of events to send to the specified destinations. At most 2000 Event 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 Event.
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.

IngestEventsResponse

Response from the IngestEventsRequest.

Fields
request_id

string

The auto-generated ID of the request.

Item

Represents an item in the cart associated with the event.

Fields
merchant_product_id

string

Optional. The product ID within the Merchant Center account.
quantity

int64

Optional. The number of this item associated with the event.
unit_price

double

Optional. The unit price excluding tax, shipping, and any transaction level discounts.
item_id

string

Optional. A unique identifier to reference the item.
additional_item_parameters[]

ItemParameter

Optional. A bucket of any event parameters related to an item to be included within the event that were not already specified using other structured fields.

ItemParameter

A bucket of any event parameters related to an item to be included within the event that were not already specified using other structured fields.

Fields
parameter_name

string

Required. The name of the parameter to use.
value

string

Required. The string representation of the value of the parameter to set.

MatchRateRange

The match rate range of the upload or userlist.

Enums
MATCH_RATE_RANGE_UNKNOWN The match rate range is unknown.
MATCH_RATE_RANGE_NOT_ELIGIBLE The match rate range is not eligible.
MATCH_RATE_RANGE_LESS_THAN_20 The match rate range is less than 20% (in the interval [0, 20)).
MATCH_RATE_RANGE_20_TO_30 The match rate range is between 20% and 30% (in the interval [20, 31)).
MATCH_RATE_RANGE_31_TO_40 The match rate range is between 31% and 40% (in the interval [31, 41)).
MATCH_RATE_RANGE_41_TO_50 The match rate range is between 41% and 50% (in the interval [41, 51)).
MATCH_RATE_RANGE_51_TO_60 The match rate range is between 51% and 60% (in the interval [51, 61).
MATCH_RATE_RANGE_61_TO_70 The match rate range is between 61% and 70% (in the interval [61, 71)).
MATCH_RATE_RANGE_71_TO_80 The match rate range is between 71% and 80% (in the interval [71, 81)).
MATCH_RATE_RANGE_81_TO_90 The match rate range is between 81% and 90% (in the interval [81, 91)).
MATCH_RATE_RANGE_91_TO_100

The match rate range is between 91% and 100% (in the interval [91, 100]).

MobileData

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

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.

PairData

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

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.

ProcessingErrorReason

The processing error reason.

Enums
PROCESSING_ERROR_REASON_UNSPECIFIED The processing error reason is unknown.
PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE The custom variable is invalid.
PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED The status of the custom variable is not enabled.
PROCESSING_ERROR_REASON_EVENT_TOO_OLD The conversion is older than max supported age.
PROCESSING_ERROR_REASON_DUPLICATE_GCLID A conversion with the same GCLID and conversion time already exists in the system.
PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID A conversion with the same order id and conversion action combination was already uploaded.
PROCESSING_ERROR_REASON_INVALID_GBRAID The gbraid could not be decoded.
PROCESSING_ERROR_REASON_INVALID_GCLID The google click ID could not be decoded.
PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID Merchant id contains non-digit characters.
PROCESSING_ERROR_REASON_INVALID_WBRAID The wbraid could not be decoded.
PROCESSING_ERROR_REASON_INTERNAL_ERROR Internal error.
PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED Enhanced conversions terms are not signed in the destination account.
PROCESSING_ERROR_REASON_INVALID_EVENT The event is invalid.
PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS The matched transactions are less than the minimum threshold.
PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS The transactions are less than the minimum threshold.
PROCESSING_ERROR_REASON_INVALID_FORMAT The event has format error.
PROCESSING_ERROR_REASON_DECRYPTION_ERROR The event has a decryption error.
PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR The DEK failed to be decrypted.
PROCESSING_ERROR_REASON_INVALID_WIP The WIP is formatted incorrectly or the WIP does not exist.
PROCESSING_ERROR_REASON_INVALID_KEK The KEK cannot decrypt data because it is the wrong KEK, or it does not exist.
PROCESSING_ERROR_REASON_WIP_AUTH_FAILED The WIP could not be used because it was rejected by its attestation condition.
PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED The system did not have the permissions needed to access the KEK.
PROCESSING_ERROR_REASON_AWS_AUTH_FAILED The system failed to authenticate with AWS.
PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR Failed to decrypt the UserIdentifier data using the DEK.
PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER The user attempted to ingest events with an ad identifier that isn't from the operating account's ads.

ProcessingWarningReason

The processing warning reason.

Enums
PROCESSING_WARNING_REASON_UNSPECIFIED The processing warning reason is unknown.
PROCESSING_WARNING_REASON_KEK_PERMISSION_DENIED The system did not have the permissions needed to access the KEK.
PROCESSING_WARNING_REASON_DEK_DECRYPTION_ERROR The DEK failed to be decrypted.
PROCESSING_WARNING_REASON_DECRYPTION_ERROR The event has a decryption error.
PROCESSING_WARNING_REASON_WIP_AUTH_FAILED The WIP could not be used because it was rejected by its attestation condition.
PROCESSING_WARNING_REASON_INVALID_WIP The WIP is formatted incorrectly or the WIP does not exist.
PROCESSING_WARNING_REASON_INVALID_KEK The KEK cannot decrypt data because it is the wrong KEK, or it does not exist.
PROCESSING_WARNING_REASON_USER_IDENTIFIER_DECRYPTION_ERROR Failed to decrypt th UserIdentifier data using the DEK.
PROCESSING_WARNING_REASON_INTERNAL_ERROR Internal error.
PROCESSING_WARNING_REASON_AWS_AUTH_FAILED The system failed to authenticate with AWS.

Product

Deprecated. Use AccountType instead. Represents a specific Google product.

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
product
(deprecated)

Product

Deprecated. Use account_type instead.
account_id

string

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

AccountType

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.

AccountType

Represents Google account types. Used to locate accounts and destinations.

Enums
ACCOUNT_TYPE_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.
GOOGLE_ANALYTICS_PROPERTY Google Analytics.

RemoveAudienceMembersRequest

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

You can try this method in the REST APIs explorer:
Try it with REST
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
request_id

string

The auto-generated ID of the request.

RequestStatusPerDestination

A request status per destination.

Fields
destination

Destination

A destination within a DM API request.
request_status

RequestStatus

The request status of the destination.
error_info

ErrorInfo

An error info error containing the error reason and error counts related to the upload.
warning_info

WarningInfo

A warning info containing the warning reason and warning counts related to the upload.
Union field status. The status of the destination. status can be only one of the following:
audience_members_ingestion_status

IngestAudienceMembersStatus

The status of the ingest audience members request.
events_ingestion_status

IngestEventsStatus

The status of the ingest events request.
audience_members_removal_status

RemoveAudienceMembersStatus

The status of the remove audience members request.

IngestAudienceMembersStatus

The status of the ingest audience members request.

Fields
Union field status. The status of the audience members ingestion to the destination. status can be only one of the following:
user_data_ingestion_status

IngestUserDataStatus

The status of the user data ingestion to the destination.
mobile_data_ingestion_status

IngestMobileDataStatus

The status of the mobile data ingestion to the destination.
pair_data_ingestion_status

IngestPairDataStatus

The status of the pair data ingestion to the destination.

IngestEventsStatus

The status of the events ingestion to the destination.

Fields
record_count

int64

The total count of events sent in the upload request. Includes all events in the request, regardless of whether they were successfully ingested or not.

IngestMobileDataStatus

The status of the mobile data ingestion to the destination containing stats related to the ingestion.

Fields
record_count

int64

The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.
mobile_id_count

int64

The total count of mobile ids sent in the upload request for the destination. Includes all mobile ids in the request, regardless of whether they were successfully ingested or not.

IngestPairDataStatus

The status of the pair data ingestion to the destination containing stats related to the ingestion.

Fields
record_count

int64

The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.
pair_id_count

int64

The total count of pair ids sent in the upload request for the destination. Includes all pair ids in the request, regardless of whether they were successfully ingested or not.

IngestUserDataStatus

The status of the user data ingestion to the destination containing stats related to the ingestion.

Fields
record_count

int64

The total count of audience members sent in the upload request for the destination. Includes all audience members in the request, regardless of whether they were successfully ingested or not.
user_identifier_count

int64

The total count of user identifiers sent in the upload request for the destination. Includes all user identifiers in the request, regardless of whether they were successfully ingested or not.
upload_match_rate_range

MatchRateRange

The match rate range of the upload.

RemoveAudienceMembersStatus

The status of the remove audience members request.

Fields
Union field status. The status of the audience members removal from the destination. status can be only one of the following:
user_data_removal_status

RemoveUserDataStatus

The status of the user data removal from the destination.
mobile_data_removal_status

RemoveMobileDataStatus

The status of the mobile data removal from the destination.
pair_data_removal_status

RemovePairDataStatus

The status of the pair data removal from the destination.

RemoveMobileDataStatus

The status of the mobile data removal from the destination.

Fields
record_count

int64

The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.
mobile_id_count

int64

The total count of mobile Ids sent in the removal request. Includes all mobile ids in the request, regardless of whether they were successfully removed or not.

RemovePairDataStatus

The status of the pair data removal from the destination.

Fields
record_count

int64

The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.
pair_id_count

int64

The total count of pair ids sent in the removal request. Includes all pair ids in the request, regardless of whether they were successfully removed or not.

RemoveUserDataStatus

The status of the user data removal from the destination.

Fields
record_count

int64

The total count of audience members sent in the removal request. Includes all audience members in the request, regardless of whether they were successfully removed or not.
user_identifier_count

int64

The total count of user identifiers sent in the removal request. Includes all user identifiers in the request, regardless of whether they were successfully removed or not.

RequestStatus

The request status.

Enums
REQUEST_STATUS_UNKNOWN The request status is unknown.
SUCCESS The request succeeded.
PROCESSING The request is processing.
FAILED The request failed.
PARTIAL_SUCCESS The request partially succeeded.

RetrieveRequestStatusRequest

Request to get the status of request made to the DM API for a given request ID. Returns a RetrieveRequestStatusResponse.

You can try this method in the REST APIs explorer:
Try it with REST
Fields
request_id

string

Required. Required. The request ID of the Data Manager API request.

RetrieveRequestStatusResponse

Response from the RetrieveRequestStatusRequest.

Fields
request_status_per_destination[]

RequestStatusPerDestination

A list of request statuses per destination. The order of the statuses matches the order of the destinations in the original request.

TermsOfService

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

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 when ingesting UserData or MobileData. This field is not required for Partner Match User list.

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
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 or Event.

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.

UserProperties

Advertiser-assessed information about the user at the time that the event happened. See https://support.google.com/google-ads/answer/14007601 for more details.

Fields
customer_type

CustomerType

Optional. Type of the customer associated with the event.
customer_value_bucket

CustomerValueBucket

Optional. The advertiser-assessed value of the customer.
additional_user_properties[]

UserProperty

Optional. A bucket of any additional user properties for the user associated with this event.

UserProperty

A bucket of any additional user properties for the user associated with this event.

Fields
property_name

string

Required. The name of the user property to use.
value

string

Required. The string representation of the value of the user property to use.

WarningCount

The warning count for a given warning reason.

Fields
record_count

int64

The count of records that have a warning.
reason

ProcessingWarningReason

The warning reason.

WarningInfo

Warning counts for each type of warning.

Fields
warning_counts[]

WarningCount

A list of warnings and counts per warning reason.