Package google.ads.datamanager.v1

Index

• IngestionService (interface)
• AdIdentifiers (message)
• AddressInfo (message)
• AudienceMember (message)
• CartData (message)
• Consent (message)
• ConsentStatus (enum)
• CustomVariable (message)
• Destination (message)
• DeviceInfo (message)
• Encoding (enum)
• EncryptionInfo (message)
• Event (message)
• EventSource (enum)
• ExperimentalField (message)
• GcpWrappedKeyInfo (message)
• GcpWrappedKeyInfo.KeyType (enum)
• IngestAudienceMembersRequest (message)
• IngestAudienceMembersResponse (message)
• IngestEventsRequest (message)
• IngestEventsResponse (message)
• Item (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
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

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

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.

Consent

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

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

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.

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.

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.
transaction_id	string Required. The unique identifier for this event.
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.

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.

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.
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
request_id	string The auto-generated ID of the request.

IngestEventsRequest

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

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.

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.

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
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
request_id	string The auto-generated ID of the 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 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
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.