As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Ads Datamanager v1 API

class google.ads.datamanager_v1.types.AdIdentifiers(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

session_attributes

Optional. Session attributes for event attribution and modeling.

Type

str

gclid

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

Type

str

gbraid

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

Type

str

wbraid

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

Type

str

landing_page_device_info

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.

Type

google.ads.datamanager_v1.types.DeviceInfo

class google.ads.datamanager_v1.types.AddressInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Address information for the user.

given_name

Required. Given (first) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.

Type

str

family_name

Required. Family (last) name of the user, all lowercase, with no punctuation, no leading or trailing whitespace, and hashed as SHA-256.

Type

str

region_code

Required. The 2-letter region code in ISO-3166-1 alpha-2 of the user’s address.

Type

str

postal_code

Required. The postal code of the user’s address.

Type

str

class google.ads.datamanager_v1.types.AgeRange(value)

Bases: proto.enums.Enum

The demographic age ranges

Values:

AGE_RANGE_UNSPECIFIED (0):

Not specified.

AGE_RANGE_UNKNOWN (1):

Unknown.

AGE_RANGE_18_24 (2):

Between 18 and 24 years old.

AGE_RANGE_25_34 (3):

Between 25 and 34 years old.

AGE_RANGE_35_44 (4):

Between 35 and 44 years old.

AGE_RANGE_45_54 (5):

Between 45 and 54 years old.

AGE_RANGE_55_64 (6):

Between 55 and 64 years old.

AGE_RANGE_65_UP (7):

65 years old and beyond.

class google.ads.datamanager_v1.types.AudienceMember(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The audience member to be operated on.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

destination_references

Optional. Defines which [Destination][google.ads.datamanager.v1.Destination] to send the audience member to.

Type

MutableSequence[str]

user_data

User-provided data that identifies the user.

This field is a member of oneof data.

Type

google.ads.datamanager_v1.types.UserData

pair_data

Publisher Advertiser Identity Reconciliation (PAIR) IDs.

This feature is only available to data partners.

This field is a member of oneof data.

Type

google.ads.datamanager_v1.types.PairData

mobile_data

Data identifying the user’s mobile devices.

This field is a member of oneof data.

Type

google.ads.datamanager_v1.types.MobileData

user_id_data

Data related to unique identifiers for a user, as defined by the advertiser.

This field is a member of oneof data.

Type

google.ads.datamanager_v1.types.UserIdData

ppid_data

Data related to publisher provided identifiers. This feature is only available to data partners.

This field is a member of oneof data.

Type

google.ads.datamanager_v1.types.PpidData

consent

Optional. The consent setting for the user.

Type

google.ads.datamanager_v1.types.Consent

class google.ads.datamanager_v1.types.AwsWrappedKeyInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A data encryption key wrapped by an AWS KMS key.

key_type

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

Type

google.ads.datamanager_v1.types.AwsWrappedKeyInfo.KeyType

role_arn

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}

Type

str

kek_uri

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} or aws-kms://arn:{partition}:kms:{region}:{account_id}:key/{key_id}

Type

str

encrypted_dek

Required. The base64 encoded encrypted data encryption key.

Type

str

class KeyType(value)

Bases: proto.enums.Enum

The type of algorithm used to encrypt the data.

Values:

KEY_TYPE_UNSPECIFIED (0):

Unspecified key type. Should never be used.

XCHACHA20_POLY1305 (1):

Algorithm XChaCha20-Poly1305

class google.ads.datamanager_v1.types.Baseline(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Baseline criteria against which insights are compared.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

baseline_location

The baseline location of the request. Baseline location is an OR-list of the requested regions.

This field is a member of oneof baseline.

Type

google.ads.datamanager_v1.types.Baseline.Location

location_auto_detection_enabled

If set to true, the service will try to automatically detect the baseline location for insights.

This field is a member of oneof baseline.

Type

bool

class Location(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The baseline location of the request. Baseline location is on OR-list of ISO 3166-1 alpha-2 region codes of the requested regions.

region_codes

List of ISO 3166-1 alpha-2 region codes.

Type

MutableSequence[str]

class google.ads.datamanager_v1.types.CartData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The cart data associated with the event.

merchant_id

Optional. The Merchant Center ID associated with the items.

Type

str

merchant_feed_label

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

Type

str

merchant_feed_language_code

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

Type

str

transaction_discount

Optional. The sum of all discounts associated with the transaction.

Type

float

items

Optional. The list of items associated with the event.

Type

MutableSequence[google.ads.datamanager_v1.types.Item]

class google.ads.datamanager_v1.types.Consent(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

ad_user_data

Optional. Represents if the user consents to ad user data.

Type

google.ads.datamanager_v1.types.ConsentStatus

ad_personalization

Optional. Represents if the user consents to ad personalization.

Type

google.ads.datamanager_v1.types.ConsentStatus

class google.ads.datamanager_v1.types.ConsentStatus(value)

Bases: proto.enums.Enum

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

Values:

CONSENT_STATUS_UNSPECIFIED (0):

Not specified.

CONSENT_GRANTED (1):

Granted.

CONSENT_DENIED (2):

Denied.

class google.ads.datamanager_v1.types.ContactIdInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Additional information when CONTACT_ID is one of the upload_key_types.

data_source_type

Optional. Immutable. Source of the upload data

This field is a member of oneof _data_source_type.

Type

google.ads.datamanager_v1.types.DataSourceType

match_rate_percentage

Output only. Match rate for customer match user lists.

Type

int

class google.ads.datamanager_v1.types.CreatePartnerLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to create a [PartnerLink][google.ads.datamanager.v1.PartnerLink] resource. Returns a [PartnerLink][google.ads.datamanager.v1.PartnerLink].

parent

Required. The parent, which owns this collection of partner links. Format: accountTypes/{account_type}/accounts/{account}

Type

str

partner_link

Required. The partner link to create.

Type

google.ads.datamanager_v1.types.PartnerLink

class google.ads.datamanager_v1.types.CreateUserListDirectLicenseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to create a [UserListDirectLicense][google.ads.datamanager.v1.UserListDirectLicense] resource.

parent

Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

Type

str

user_list_direct_license

Required. The user list direct license to create.

Type

google.ads.datamanager_v1.types.UserListDirectLicense

class google.ads.datamanager_v1.types.CreateUserListGlobalLicenseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to create a [UserListGlobalLicense][google.ads.datamanager.v1.UserListGlobalLicense] resource.

parent

Required. The account that owns the user list being licensed. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

Type

str

user_list_global_license

Required. The user list global license to create.

Type

google.ads.datamanager_v1.types.UserListGlobalLicense

class google.ads.datamanager_v1.types.CreateUserListRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for CreateUserList.

parent

Required. The parent account where this user list will be created. Format: accountTypes/{account_type}/accounts/{account}

Type

str

user_list

Required. The user list to create.

Type

google.ads.datamanager_v1.types.UserList

validate_only

Optional. If true, the request is validated but not executed.

Type

bool

class google.ads.datamanager_v1.types.CustomVariable(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Custom variable for ads conversions.

variable

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

Type

str

value

Optional. The value to store for the custom variable.

Type

str

destination_references

Optional. Reference string used to determine which of the [Event.destination_references][google.ads.datamanager.v1.Event.destination_references] the custom variable should be sent to. If empty, the [Event.destination_references][google.ads.datamanager.v1.Event.destination_references] will be used.

Type

MutableSequence[str]

class google.ads.datamanager_v1.types.CustomerType(value)

Bases: proto.enums.Enum

Type of the customer associated with the event.

Values:

CUSTOMER_TYPE_UNSPECIFIED (0):

Unspecified CustomerType. Should never be used.

NEW (1):

The customer is new to the advertiser.

RETURNING (2):

The customer is returning to the advertiser.

REENGAGED (3):

The customer has re-engaged with the advertiser.

class google.ads.datamanager_v1.types.CustomerValueBucket(value)

Bases: proto.enums.Enum

The advertiser-assessed value of the customer.

Values:

CUSTOMER_VALUE_BUCKET_UNSPECIFIED (0):

Unspecified CustomerValueBucket. Should never be used.

LOW (1):

The customer is low value.

MEDIUM (2):

The customer is medium value.

HIGH (3):

The customer is high value.

class google.ads.datamanager_v1.types.DataSourceType(value)

Bases: proto.enums.Enum

Indicates source of upload data.

Values:

DATA_SOURCE_TYPE_UNSPECIFIED (0):

Not specified.

DATA_SOURCE_TYPE_FIRST_PARTY (1):

The uploaded data is first-party data.

DATA_SOURCE_TYPE_THIRD_PARTY_CREDIT_BUREAU (2):

The uploaded data is from a third-party credit bureau.

DATA_SOURCE_TYPE_THIRD_PARTY_VOTER_FILE (3):

The uploaded data is from a third-party voter file.

DATA_SOURCE_TYPE_THIRD_PARTY_PARTNER_DATA (4):

The uploaded data is third party partner data.

class google.ads.datamanager_v1.types.DeletePartnerLinkRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to delete a [PartnerLink][google.ads.datamanager.v1.PartnerLink] resource. Returns a [google.protobuf.Empty][google.protobuf.Empty].

name

Required. The resource name of the partner link to delete. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}

Type

str

class google.ads.datamanager_v1.types.DeleteUserListRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for DeleteUserList.

name

Required. The name of the user list to delete. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

Type

str

validate_only

Optional. If true, the request is validated but not executed.

Type

bool

class google.ads.datamanager_v1.types.Destination(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

reference

Optional. ID for this Destination resource, unique within the request. Use to reference this Destination in the [IngestEventsRequest][google.ads.datamanager.v1.IngestEventsRequest] and [IngestAudienceMembersRequest][google.ads.datamanager.v1.IngestAudienceMembersRequest].

Type

str

login_account

Optional. The account used to make this API call. To add or remove data from the [operating_account][google.ads.datamanager.v1.Destination.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.

Type

google.ads.datamanager_v1.types.ProductAccount

linked_account

Optional. An account that the calling user’s [login_account][google.ads.datamanager.v1.Destination.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][google.ads.datamanager.v1.Destination.operating_account].

Type

google.ads.datamanager_v1.types.ProductAccount

operating_account

Required. The account to send the data to or remove the data from.

Type

google.ads.datamanager_v1.types.ProductAccount

product_destination_id

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.

Type

str

class google.ads.datamanager_v1.types.DeviceInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

user_agent

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

Type

str

ip_address

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.

Type

str

class google.ads.datamanager_v1.types.Encoding(value)

Bases: proto.enums.Enum

The encoding type of the hashed identifying information.

Values:

ENCODING_UNSPECIFIED (0):

Unspecified Encoding type. Should never be used.

HEX (1):

Hex encoding.

BASE64 (2):

Base 64 encoding.

class google.ads.datamanager_v1.types.EncryptionInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Encryption information for the data being ingested.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

gcp_wrapped_key_info

Google Cloud Platform wrapped key information.

This field is a member of oneof wrapped_key.

Type

google.ads.datamanager_v1.types.GcpWrappedKeyInfo

aws_wrapped_key_info

Amazon Web Services wrapped key information.

This field is a member of oneof wrapped_key.

Type

google.ads.datamanager_v1.types.AwsWrappedKeyInfo

class google.ads.datamanager_v1.types.ErrorCount(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The error count for a given error reason.

record_count

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

Type

int

reason

The error reason of the failed records.

Type

google.ads.datamanager_v1.types.ProcessingErrorReason

class google.ads.datamanager_v1.types.ErrorInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Error counts for each type of error.

error_counts

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

Type

MutableSequence[google.ads.datamanager_v1.types.ErrorCount]

class google.ads.datamanager_v1.types.ErrorReason(value)

Bases: proto.enums.Enum

Error reasons for Data Manager API. NOTE: This enum is not frozen and new values may be added in the future.

Values:

ERROR_REASON_UNSPECIFIED (0):

Do not use this default value.

INTERNAL_ERROR (1):

An internal error has occurred.

DEADLINE_EXCEEDED (2):

The request took too long to respond.

RESOURCE_EXHAUSTED (3):

Too many requests.

NOT_FOUND (4):

Resource not found.

PERMISSION_DENIED (5):

The user does not have permission or the resource is not found.

INVALID_ARGUMENT (6):

There was a problem with the request.

REQUIRED_FIELD_MISSING (7):

Required field is missing.

INVALID_FORMAT (8):

Format is invalid.

INVALID_HEX_ENCODING (9):

The HEX encoded value is malformed.

INVALID_BASE64_ENCODING (10):

The base64 encoded value is malformed.

INVALID_SHA256_FORMAT (11):

The SHA256 encoded value is malformed.

INVALID_POSTAL_CODE (12):

Postal code is not valid.

INVALID_COUNTRY_CODE (13):

Deprecated: Enum is unused in the Data Manager API.

INVALID_ENUM_VALUE (14):

Enum value cannot be used.

INVALID_USER_LIST_TYPE (15):

Type of the user list is not applicable for this request.

INVALID_AUDIENCE_MEMBER (16):

This audience member is not valid.

TOO_MANY_AUDIENCE_MEMBERS (17):

Maximum number of audience members allowed per request is 10,000.

TOO_MANY_USER_IDENTIFIERS (18):

Maximum number of user identifiers allowed per audience member is 10.

TOO_MANY_DESTINATIONS (19):

Maximum number of destinations allowed per request is 10.

INVALID_DESTINATION (20):

This Destination is not valid.

DATA_PARTNER_USER_LIST_MUTATE_NOT_ALLOWED (21):

Data Partner does not have access to the operating account owned userlist.

INVALID_MOBILE_ID_FORMAT (22):

Mobile ID format is not valid.

INVALID_USER_LIST_ID (23):

User list is not valid.

MULTIPLE_DATA_TYPES_NOT_ALLOWED (24):

Multiple data types are not allowed to be ingested in a single request.

DIFFERENT_LOGIN_ACCOUNTS_NOT_ALLOWED_FOR_DATA_PARTNER (25):

Destination configs containing a DataPartner login account must have the same login account across all destination configs.

TERMS_AND_CONDITIONS_NOT_SIGNED (26):

Required terms and conditions are not accepted.

INVALID_NUMBER_FORMAT (27):

Invalid number format.

INVALID_CONVERSION_ACTION_ID (28):

Conversion action ID is not valid.

INVALID_CONVERSION_ACTION_TYPE (29):

The conversion action type is not valid.

INVALID_CURRENCY_CODE (30):

The currency code is not supported.

INVALID_EVENT (31):

This event is not valid.

TOO_MANY_EVENTS (32):

Maximum number of events allowed per request is 10,000.

DESTINATION_ACCOUNT_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS (33):

The destination account is not enabled for enhanced conversions for leads.

DESTINATION_ACCOUNT_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS (34):

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 (35):

The destination account hasn’t agreed to the terms for enhanced conversions.

DUPLICATE_DESTINATION_REFERENCE (36):

Two or more destinations in the request have the same reference.

UNSUPPORTED_OPERATING_ACCOUNT_FOR_DATA_PARTNER (37):

Unsupported operating account for data partner authorization.

UNSUPPORTED_LINKED_ACCOUNT_FOR_DATA_PARTNER (38):

Unsupported linked account for data partner authorization.

NO_IDENTIFIERS_PROVIDED (39):

Events data contains no user identifiers or ad identifiers.

INVALID_PROPERTY_TYPE (40):

The property type is not supported.

INVALID_STREAM_TYPE (41):

The stream type is not supported.

LINKED_ACCOUNT_ONLY_ALLOWED_WITH_DATA_PARTNER_LOGIN_ACCOUNT (42):

Linked account is only supported when the login account is a DATA_PARTNER account.

OPERATING_ACCOUNT_LOGIN_ACCOUNT_MISMATCH (43):

The login account must be the same as the operating account for the given use case.

EVENT_TIME_INVALID (44):

Event did not occur within the acceptable time window.

RESERVED_NAME_USED (45):

Parameter uses a reserved name.

INVALID_EVENT_NAME (46):

The event name is not supported.

NOT_ALLOWLISTED (47):

The account is not allowlisted for the given feature.

INVALID_REQUEST_ID (48):

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 (49):

An event had 2 or more Google Analytics destinations.

FIELD_VALUE_TOO_LONG (50):

The field value is too long.

TOO_MANY_ELEMENTS (51):

Too many elements in a list in the request.

ALREADY_EXISTS (52):

The resource already exists.

IMMUTABLE_FIELD_FOR_UPDATE (53):

Attempted to set an immutable field for an update request.

INVALID_RESOURCE_NAME (54):

The resource name is invalid.

INVALID_FILTER (55):

The query filter is invalid.

INVALID_UPDATE_MASK (56):

The update mask is invalid.

INVALID_PAGE_TOKEN (57):

The page token is invalid.

CANNOT_UPDATE_DISABLED_LICENSE (58):

Cannot update a license that has been disabled.

CANNOT_CREATE_LICENSE_FOR_SENSITIVE_USERLIST (59):

Sensitive user lists cannot be licensed to this client.

INSUFFICIENT_COST (60):

Cost too low for this license.

CANNOT_DISABLE_LICENSE (61):

Reseller license cannot be disabled since it is in use.

INVALID_CLIENT_ACCOUNT_ID (62):

Invalid client account id.

PRICING_ONLY_ZERO_COST_ALLOWED (63):

Non-zero cost not allowed for this client account.

PRICE_TOO_HIGH (64):

Cost too high for this license.

CUSTOMER_NOT_ALLOWED_TO_CREATE_LICENSE (65):

Customer not allowed to create license.

INVALID_PRICING_END_DATE (66):

Pricing end date is invalid for this license.

CANNOT_LICENSE_LOGICAL_LIST_WITH_LICENSED_OR_SHARED_SEGMENT (67):

Logical user list with shared or licensed segment cannot be licensed.

MISMATCHED_ACCOUNT_TYPE (68):

Client customer’s account type in the request does not match the customer’s actual account type.

MEDIA_SHARE_COST_NOT_ALLOWED_FOR_LICENSE_TYPE (69):

License type does not support media share cost.

MEDIA_SHARE_COST_NOT_ALLOWED_FOR_CLIENT_CUSTOMER (70):

Client customer type does not support media share cost.

INVALID_MEDIA_SHARE_COST (71):

Invalid media share cost.

INVALID_COST_TYPE (72):

Invalid cost type.

MEDIA_SHARE_COST_NOT_ALLOWED_FOR_NON_COMMERCE_USER_LIST (73):

UserList type does not support media share cost.

MAX_COST_NOT_ALLOWED (74):

Max cost is only allowed for cost_type MEDIA_SHARE.

COMMERCE_AUDIENCE_CAN_ONLY_BE_DIRECTLY_LICENSED (75):

Commerce audience can only be directly licensed.

INVALID_DESCRIPTION (76):

The description is not valid.

INVALID_DISPLAY_NAME (77):

The display name is not valid.

DISPLAY_NAME_ALREADY_USED (78):

The display name is already being used for another user list for the account.

OWNERSHIP_REQUIRED_FOR_UPDATE (79):

Ownership is required to modify the user list.

USER_LIST_MUTATION_NOT_SUPPORTED (80):

The user list type is read-only and does not support mutation.

SENSITIVE_USER_LIST_IMMUTABLE (81):

A user list which is privacy sensitive or legal rejected cannot be mutated by external users.

BILLABLE_RECORD_COUNT_IMMUTABLE (82):

The remarketing user list’s billable record field cannot be modified once it is set.

USER_LIST_NAME_RESERVED (83):

The user list name is reserved for system lists.

ADVERTISER_NOT_ALLOWLISTED_FOR_UPLOADED_DATA (84):

The advertiser needs to be allowlisted to use remarketing lists created from advertiser uploaded data.

UNSUPPORTED_PARTNER_AUDIENCE_SOURCE (85):

The partner audience source is not supported for the user list type.

COMMERCE_PARTNER_NOT_ALLOWED (86):

Setting the commerce_partner field is only supported if the partner_audience_source is COMMERCE_AUDIENCE.

UNSUPPORTED_PARTNER_AUDIENCE_INFO (87):

The partner_audience_info field is not supported for the user list type.

PARTNER_MATCH_FOR_MANAGER_ACCOUNT_DISALLOWED (88):

Partner Match user lists cannot be created by manager accounts.

DATA_PARTNER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA (89):

The data partner is not allowlisted for THIRD_PARTY_PARTNER_DATA.

ADVERTISER_TOS_NOT_ACCEPTED (90):

The advertiser has not accepted the partner’s terms of service.

ADVERTISER_NOT_ALLOWLISTED_FOR_THIRD_PARTY_PARTNER_DATA (91):

The advertiser is not allowlisted for THIRD_PARTY_PARTNER_DATA.

USER_LIST_TYPE_NOT_SUPPORTED_FOR_ACCOUNT (92):

This user list type is not supported for this account.

INVALID_COMMERCE_PARTNER (93):

The commerce_partner field is invalid.

CUSTOMER_NOT_ALLOWLISTED_FOR_COMMERCE_AUDIENCE (94):

The data provider is not allowlisted to create commerce audiences.

UNSUPPORTED_USER_LIST_UPLOAD_KEY_TYPES (95):

The user list upload key types are not supported.

UNSUPPORTED_INGESTED_USER_LIST_INFO_CONFIG (96):

The ingested user list info config is not supported.

UNSUPPORTED_ACCOUNT_TYPES_FOR_USER_LIST_TYPE (97):

The account types are not supported for the user list type.

UNSUPPORTED_ACCOUNT_TYPE_FOR_PARTNER_LINK (98):

The account types are not supported for the partner link.

MEMBERSHIP_DURATION_TOO_LONG (99):

The user list membership duration is too long.

INVALID_MERCHANT_ID (100):

The merchant_id field is not valid.

EU_POLITICAL_ADVERTISING_DECLARATION_REQUIRED (101):

The customer contains non-exempt campaigns without the EU political advertising declaration.

class google.ads.datamanager_v1.types.Event(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

destination_references

Optional. Reference string used to determine the destination. If empty, the event will be sent to all [destinations][google.ads.datamanager.v1.IngestEventsRequest.destinations] in the request.

Type

MutableSequence[str]

transaction_id

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

Type

str

event_timestamp

Required. The time the event occurred.

Type

google.protobuf.timestamp_pb2.Timestamp

last_updated_timestamp

Optional. The last time the event was updated.

Type

google.protobuf.timestamp_pb2.Timestamp

user_data

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

Type

google.ads.datamanager_v1.types.UserData

consent

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

Type

google.ads.datamanager_v1.types.Consent

ad_identifiers

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

Type

google.ads.datamanager_v1.types.AdIdentifiers

currency

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

Type

str

conversion_value

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

This field is a member of oneof _conversion_value.

Type

float

event_source

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

Type

google.ads.datamanager_v1.types.EventSource

event_device_info

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

Type

google.ads.datamanager_v1.types.DeviceInfo

cart_data

Optional. Information about the transaction and items associated with the event.

Type

google.ads.datamanager_v1.types.CartData

custom_variables

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

Type

MutableSequence[google.ads.datamanager_v1.types.CustomVariable]

experimental_fields

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

Type

MutableSequence[google.ads.datamanager_v1.types.ExperimentalField]

user_properties

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

Type

google.ads.datamanager_v1.types.UserProperties

event_name

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

Type

str

client_id

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

Type

str

user_id

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

Type

str

additional_event_parameters

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

Type

MutableSequence[google.ads.datamanager_v1.types.EventParameter]

class google.ads.datamanager_v1.types.EventParameter(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Event parameter for GA4 events.

parameter_name

Required. The name of the parameter to use.

Type

str

value

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

Type

str

class google.ads.datamanager_v1.types.EventSource(value)

Bases: proto.enums.Enum

The source of the event.

Values:

EVENT_SOURCE_UNSPECIFIED (0):

Unspecified EventSource. Should never be used.

WEB (1):

The event was generated from a web browser.

APP (2):

The event was generated from an app.

IN_STORE (3):

The event was generated from an in-store transaction.

PHONE (4):

The event was generated from a phone call.

OTHER (5):

The event was generated from other sources.

class google.ads.datamanager_v1.types.ExperimentalField(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Experimental field representing unofficial fields.

field

Optional. The name of the field to use.

Type

str

value

Optional. The value the field to set.

Type

str

class google.ads.datamanager_v1.types.GcpWrappedKeyInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Information about the Google Cloud Platform wrapped key.

key_type

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

Type

google.ads.datamanager_v1.types.GcpWrappedKeyInfo.KeyType

wip_provider

Required. The Workload Identity pool provider required to use KEK.

Type

str

kek_uri

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} or gcp-kms://projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}

Type

str

encrypted_dek

Required. The base64 encoded encrypted data encryption key.

Type

str

class KeyType(value)

Bases: proto.enums.Enum

The type of algorithm used to encrypt the data.

Values:

KEY_TYPE_UNSPECIFIED (0):

Unspecified key type. Should never be used.

XCHACHA20_POLY1305 (1):

Algorithm XChaCha20-Poly1305

class google.ads.datamanager_v1.types.Gender(value)

Bases: proto.enums.Enum

The type of demographic genders (for example, female).

Values:

GENDER_UNSPECIFIED (0):

Not specified.

GENDER_UNKNOWN (1):

Unknown.

GENDER_MALE (2):

Male.

GENDER_FEMALE (3):

Female.

class google.ads.datamanager_v1.types.GetUserListDirectLicenseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to get a [UserListDirectLicense][google.ads.datamanager.v1.UserListDirectLicense] resource.

name

Required. The resource name of the user list direct license.

Type

str

class google.ads.datamanager_v1.types.GetUserListGlobalLicenseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to get a [UserListGlobalLicense][google.ads.datamanager.v1.UserListGlobalLicense] resource.

name

Required. The resource name of the user list global license.

Type

str

class google.ads.datamanager_v1.types.GetUserListRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for GetUserList.

name

Required. The resource name of the UserList to retrieve. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

Type

str

class google.ads.datamanager_v1.types.IngestAudienceMembersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to upload audience members to the provided destinations. Returns an [IngestAudienceMembersResponse][google.ads.datamanager.v1.IngestAudienceMembersResponse].

destinations

Required. The list of destinations to send the audience members to.

Type

MutableSequence[google.ads.datamanager_v1.types.Destination]

audience_members

Required. The list of users to send to the specified destinations. At most 10000 [AudienceMember][google.ads.datamanager.v1.AudienceMember] resources can be sent in a single request.

Type

MutableSequence[google.ads.datamanager_v1.types.AudienceMember]

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][google.ads.datamanager.v1.AudienceMember].

Type

google.ads.datamanager_v1.types.Consent

validate_only

Optional. For testing purposes. If true, the request is validated but not executed. Only errors are returned, not results.

Type

bool

encoding

Optional. Required for [UserData][google.ads.datamanager.v1.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.

Type

google.ads.datamanager_v1.types.Encoding

encryption_info

Optional. Encryption information for [UserData][google.ads.datamanager.v1.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.

Type

google.ads.datamanager_v1.types.EncryptionInfo

terms_of_service

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

Type

google.ads.datamanager_v1.types.TermsOfService

class google.ads.datamanager_v1.types.IngestAudienceMembersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response from the [IngestAudienceMembersRequest][google.ads.datamanager.v1.IngestAudienceMembersRequest].

request_id

The auto-generated ID of the request.

Type

str

class google.ads.datamanager_v1.types.IngestEventsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to upload audience members to the provided destinations. Returns an [IngestEventsResponse][google.ads.datamanager.v1.IngestEventsResponse].

destinations

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

Type

MutableSequence[google.ads.datamanager_v1.types.Destination]

events

Required. The list of events to send to the specified destinations. At most 2000 [Event][google.ads.datamanager.v1.Event] resources can be sent in a single request.

Type

MutableSequence[google.ads.datamanager_v1.types.Event]

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][google.ads.datamanager.v1.Event].

Type

google.ads.datamanager_v1.types.Consent

validate_only

Optional. For testing purposes. If true, the request is validated but not executed. Only errors are returned, not results.

Type

bool

encoding

Optional. Required for [UserData][google.ads.datamanager.v1.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.

Type

google.ads.datamanager_v1.types.Encoding

encryption_info

Optional. Encryption information for [UserData][google.ads.datamanager.v1.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.

Type

google.ads.datamanager_v1.types.EncryptionInfo

class google.ads.datamanager_v1.types.IngestEventsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response from the [IngestEventsRequest][google.ads.datamanager.v1.IngestEventsRequest].

request_id

The auto-generated ID of the request.

Type

str

class google.ads.datamanager_v1.types.IngestedUserListInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a user list that is populated by user provided data.

upload_key_types

Required. Immutable. Upload key types of this user list.

Type

MutableSequence[google.ads.datamanager_v1.types.IngestedUserListInfo.UploadKeyType]

contact_id_info

Optional. Additional information when CONTACT_ID is one of the upload_key_types.

Type

google.ads.datamanager_v1.types.ContactIdInfo

mobile_id_info

Optional. Additional information when MOBILE_ID is one of the upload_key_types.

Type

google.ads.datamanager_v1.types.MobileIdInfo

user_id_info

Optional. Additional information when USER_ID is one of the upload_key_types.

Type

google.ads.datamanager_v1.types.UserIdInfo

pair_id_info

Optional. Additional information when PAIR_ID is one of the upload_key_types.

This feature is only available to data partners.

Type

google.ads.datamanager_v1.types.PairIdInfo

pseudonymous_id_info

Optional. Additional information for PSEUDONYMOUS_ID is one of the upload_key_types.

Type

google.ads.datamanager_v1.types.PseudonymousIdInfo

partner_audience_info

Optional. Additional information for partner audiences. This feature is only available to data partners.

Type

google.ads.datamanager_v1.types.PartnerAudienceInfo

class UploadKeyType(value)

Bases: proto.enums.Enum

Enum containing the possible upload key types of a user list.

Values:

UPLOAD_KEY_TYPE_UNSPECIFIED (0):

Not specified.

CONTACT_ID (1):

Customer info such as email address, phone number or physical address.

MOBILE_ID (2):

Mobile advertising ids.

USER_ID (3):

Third party provided user ids.

PAIR_ID (4):

Publisher advertiser identity reconciliation ids.

PSEUDONYMOUS_ID (5):

Data Management Platform IDs:

• Google User ID

• Partner Provided ID

• Publisher Provided ID

• iOS IDFA

• Android advertising ID

• Roku ID

• Amazon Fire TV ID

• Xbox or Microsoft ID

class google.ads.datamanager_v1.types.Item(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents an item in the cart associated with the event.

merchant_product_id

Optional. The product ID within the Merchant Center account.

Type

str

quantity

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

Type

int

unit_price

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

Type

float

item_id

Optional. A unique identifier to reference the item.

Type

str

additional_item_parameters

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.

Type

MutableSequence[google.ads.datamanager_v1.types.ItemParameter]

class google.ads.datamanager_v1.types.ItemParameter(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

parameter_name

Required. The name of the parameter to use.

Type

str

value

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

Type

str

class google.ads.datamanager_v1.types.ListUserListDirectLicensesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to list all [UserListDirectLicense][google.ads.datamanager.v1.UserListDirectLicense] resources for a given account.

parent

Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

Type

str

filter

Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). Fields must be specified using either all camel case or all snake case. Don’t use a combination of camel case and snake case.

Supported Operations:

• AND

• =

• !=

• >

• >=

• <

• <=

Unsupported Fields:

• name (use get method instead)

• historical_pricings and all its subfields

• pricing.start_time

• pricing.end_time

Type

str

page_size

Optional. The maximum number of licenses to return per page. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Type

int

page_token

Optional. A page token, received from a previous ListUserListDirectLicense call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUserListDirectLicense must match the call that provided the page token.

Type

str

class google.ads.datamanager_v1.types.ListUserListDirectLicensesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response from the [ListUserListDirectLicensesRequest][google.ads.datamanager.v1.ListUserListDirectLicensesRequest].

user_list_direct_licenses

The licenses for the given user list in the request.

Type

MutableSequence[google.ads.datamanager_v1.types.UserListDirectLicense]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

class google.ads.datamanager_v1.types.ListUserListGlobalLicenseCustomerInfosRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to list all [UserListGlobalLicenseCustomerInfo][google.ads.datamanager.v1.UserListGlobalLicenseCustomerInfo] resources for a given user list global license.

parent

Required. The global license whose customer info are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}/userListGlobalLicenses/{USER_LIST_GLOBAL_LICENSE_ID}. To list all global license customer info under an account, replace the user list global license id with a ‘-’ (for example, accountTypes/DATA_PARTNER/accounts/123/userListGlobalLicenses/-)

Type

str

filter

Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). Fields must be specified using either all camel case or all snake case. Don’t use a combination of camel case and snake case.

Supported Operations:

• AND

• =

• !=

• >

• >=

• <

• <=

Unsupported Fields:

• name (use get method instead)

• historical_pricings and all its subfields

• pricing.start_time

• pricing.end_time

Type

str

page_size

Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Type

int

page_token

Optional. A page token, received from a previous ListUserListDirectLicense call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUserListDirectLicense must match the call that provided the page token.

Type

str

class google.ads.datamanager_v1.types.ListUserListGlobalLicenseCustomerInfosResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response from the [ListUserListGlobalLicensesCustomerInfoRequest][google.ads.datamanager.v1.ListUserListGlobalLicensesCustomerInfoRequest].

user_list_global_license_customer_infos

The customer information for the given license in the request.

Type

MutableSequence[google.ads.datamanager_v1.types.UserListGlobalLicenseCustomerInfo]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

class google.ads.datamanager_v1.types.ListUserListGlobalLicensesRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to list all [UserListGlobalLicense][google.ads.datamanager.v1.UserListGlobalLicense] resources for a given account.

parent

Required. The account whose licenses are being queried. Should be in the format accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}

Type

str

filter

Optional. A filter string to apply to the list request. All fields need to be on the left hand side of each condition (for example: user_list_id = 123). Fields must be specified using either all camel case or all snake case. Don’t use a combination of camel case and snake case.

Supported Operations:

• AND

• =

• !=

• >

• >=

• <

• <=

Unsupported Fields:

• name (use get method instead)

• historical_pricings and all its subfields

• pricing.start_time

• pricing.end_time

Type

str

page_size

Optional. The maximum number of licenses to return. The service may return fewer than this value. If unspecified, at most 50 licenses will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Type

int

page_token

Optional. A page token, received from a previous ListUserListGlobalLicense call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUserListDirectLicense must match the call that provided the page token.

Type

str

class google.ads.datamanager_v1.types.ListUserListGlobalLicensesResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response from the [ListUserListGlobalLicensesRequest][google.ads.datamanager.v1.ListUserListGlobalLicensesRequest].

user_list_global_licenses

The licenses for the given user list in the request.

Type

MutableSequence[google.ads.datamanager_v1.types.UserListGlobalLicense]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

class google.ads.datamanager_v1.types.ListUserListsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for ListUserLists.

parent

Required. The parent account which owns this collection of user lists. Format: accountTypes/{account_type}/accounts/{account}

Type

str

page_size

Optional. The maximum number of user lists to return. The service may return fewer than this value. If unspecified, at most 50 user lists will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Type

int

page_token

Optional. A page token, received from a previous ListUserLists call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListUserLists must match the call that provided the page token.

Type

str

filter

Optional. A filter string. All fields need to be on the left hand side of each condition (for example: display_name = "list 1"). Fields must be specified using either all camel case or all snake case. Don’t use a combination of camel case and snake case.

Supported operations:

• AND

• =

• !=

• >

• >=

• <

• <=

• : (has)

Supported fields:

• id

• display_name

• description

• membership_status

• integration_code

• access_reason

• ingested_user_list_info.upload_key_types

Type

str

class google.ads.datamanager_v1.types.ListUserListsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for ListUserLists.

user_lists

The user lists from the specified account.

Type

MutableSequence[google.ads.datamanager_v1.types.UserList]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

class google.ads.datamanager_v1.types.MatchRateRange(value)

Bases: proto.enums.Enum

The match rate range of the upload or userlist.

Values:

MATCH_RATE_RANGE_UNKNOWN (0):

The match rate range is unknown.

MATCH_RATE_RANGE_NOT_ELIGIBLE (1):

The match rate range is not eligible.

MATCH_RATE_RANGE_LESS_THAN_20 (2):

The match rate range is less than 20% (in the interval [0, 20)).

MATCH_RATE_RANGE_20_TO_30 (3):

The match rate range is between 20% and 30% (in the interval [20, 31)).

MATCH_RATE_RANGE_31_TO_40 (4):

The match rate range is between 31% and 40% (in the interval [31, 41)).

MATCH_RATE_RANGE_41_TO_50 (5):

The match rate range is between 41% and 50% (in the interval [41, 51)).

MATCH_RATE_RANGE_51_TO_60 (6):

The match rate range is between 51% and 60% (in the interval [51, 61).

MATCH_RATE_RANGE_61_TO_70 (7):

The match rate range is between 61% and 70% (in the interval [61, 71)).

MATCH_RATE_RANGE_71_TO_80 (8):

The match rate range is between 71% and 80% (in the interval [71, 81)).

MATCH_RATE_RANGE_81_TO_90 (9):

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

MATCH_RATE_RANGE_91_TO_100 (10):

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

class google.ads.datamanager_v1.types.MobileData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

mobile_ids

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

Type

MutableSequence[str]

class google.ads.datamanager_v1.types.MobileIdInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Additional information when MOBILE_ID is one of the upload_key_types.

data_source_type

Optional. Immutable. Source of the upload data.

This field is a member of oneof _data_source_type.

Type

google.ads.datamanager_v1.types.DataSourceType

key_space

Required. Immutable. The key space of mobile IDs.

This field is a member of oneof _key_space.

Type

google.ads.datamanager_v1.types.MobileIdInfo.KeySpace

app_id

Required. Immutable. A string that uniquely identifies a mobile application from which the data was collected.

This field is a member of oneof _app_id.

Type

str

class KeySpace(value)

Bases: proto.enums.Enum

Key space for mobile ID.

Values:

KEY_SPACE_UNSPECIFIED (0):

Not specified.

IOS (1):

The iOS keyspace.

ANDROID (2):

The Android keyspace.

class google.ads.datamanager_v1.types.PairData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

This feature is only available to data partners.

pair_ids

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][google.ads.datamanager.v1.AudienceMember].

Type

MutableSequence[str]

class google.ads.datamanager_v1.types.PairIdInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Additional information when PAIR_ID is one of the upload_key_types.

This feature is only available to data partners.

publisher_id

Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms.

This field is a member of oneof _publisher_id.

Type

int

publisher_name

Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.

This field is a member of oneof _publisher_name.

Type

str

match_rate_percentage

Required. This field denotes the percentage of membership match of this user list with the corresponding publisher’s first party data. Must be between 0 and 100 inclusive.

This field is a member of oneof _match_rate_percentage.

Type

int

advertiser_identifier_count

Optional. The count of the advertiser’s first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.

This field is a member of oneof _advertiser_identifier_count.

Type

int

clean_room_identifier

Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.

This field is a member of oneof _clean_room_identifier.

Type

str

class google.ads.datamanager_v1.types.PartnerAudienceInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Additional information for partner audiences.

This feature is only available to data partners.

partner_audience_source

Required. Immutable. The source of the partner audience.

This field is a member of oneof _partner_audience_source.

Type

google.ads.datamanager_v1.types.PartnerAudienceInfo.PartnerAudienceSource

commerce_partner

Optional. The commerce partner name. Only allowed if partner_audience_source is COMMERCE_AUDIENCE.

This field is a member of oneof _commerce_partner.

Type

str

class PartnerAudienceSource(value)

Bases: proto.enums.Enum

Partner audience source.

Values:

PARTNER_AUDIENCE_SOURCE_UNSPECIFIED (0):

Not specified.

COMMERCE_AUDIENCE (1):

Partner Audience source is commerce audience.

LINEAR_TV_AUDIENCE (2):

Partner Audience source is linear TV audience.

AGENCY_PROVIDER_AUDIENCE (3):

Partner Audience source is agency/provider audience.

class google.ads.datamanager_v1.types.PartnerLink(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A partner link between an owning account and a partner account.

name

Identifier. The name of the partner link. Format: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}

Type

str

partner_link_id

Output only. The partner link ID.

Type

str

owning_account

Required. The owning account granting access to the partner account.

Type

google.ads.datamanager_v1.types.ProductAccount

partner_account

Required. The partner account granted access by the owning account.

Type

google.ads.datamanager_v1.types.ProductAccount

class google.ads.datamanager_v1.types.PpidData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Publisher provided identifiers data holding the ppids. At least one ppid is required.

This feature is only available to data partners.

ppids

Required. The list of publisher provided identifiers for a user.

Type

MutableSequence[str]

class google.ads.datamanager_v1.types.ProcessingErrorReason(value)

Bases: proto.enums.Enum

The processing error reason.

Values:

PROCESSING_ERROR_REASON_UNSPECIFIED (0):

The processing error reason is unknown.

PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE (1):

The custom variable is invalid.

PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED (2):

The status of the custom variable is not enabled.

PROCESSING_ERROR_REASON_EVENT_TOO_OLD (3):

The conversion is older than max supported age.

PROCESSING_ERROR_REASON_DENIED_CONSENT (4):

The ad user data is denied, either by the user or in the advertiser default settings.

PROCESSING_ERROR_REASON_NO_CONSENT (5):

Advertiser did not give 3P consent for the Ads core platform services.

PROCESSING_ERROR_REASON_UNKNOWN_CONSENT (6):

The overall consent (determined from row level consent, request level consent, and account settings) could not be determined for this user

PROCESSING_ERROR_REASON_DUPLICATE_GCLID (7):

A conversion with the same GCLID and conversion time already exists in the system.

PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID (8):

A conversion with the same order id and conversion action combination was already uploaded.

PROCESSING_ERROR_REASON_INVALID_GBRAID (9):

The gbraid could not be decoded.

PROCESSING_ERROR_REASON_INVALID_GCLID (10):

The google click ID could not be decoded.

PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID (11):

Merchant id contains non-digit characters.

PROCESSING_ERROR_REASON_INVALID_WBRAID (12):

The wbraid could not be decoded.

PROCESSING_ERROR_REASON_INTERNAL_ERROR (13):

Internal error.

PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED (14):

Enhanced conversions terms are not signed in the destination account.

PROCESSING_ERROR_REASON_INVALID_EVENT (15):

The event is invalid.

PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS (16):

The matched transactions are less than the minimum threshold.

PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS (17):

The transactions are less than the minimum threshold.

PROCESSING_ERROR_REASON_INVALID_FORMAT (18):

The event has format error.

PROCESSING_ERROR_REASON_DECRYPTION_ERROR (19):

The event has a decryption error.

PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR (20):

The DEK failed to be decrypted.

PROCESSING_ERROR_REASON_INVALID_WIP (21):

The WIP is formatted incorrectly or the WIP does not exist.

PROCESSING_ERROR_REASON_INVALID_KEK (22):

The KEK cannot decrypt data because it is the wrong KEK, or it does not exist.

PROCESSING_ERROR_REASON_WIP_AUTH_FAILED (23):

The WIP could not be used because it was rejected by its attestation condition.

PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED (24):

The system did not have the permissions needed to access the KEK.

PROCESSING_ERROR_REASON_AWS_AUTH_FAILED (27):

The system failed to authenticate with AWS.

PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR (25):

Failed to decrypt the [UserIdentifier][google.ads.datamanager.v1.UserIdentifier] data using the DEK.

PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER (26):

The user attempted to ingest events with an ad identifier that isn’t from the operating account’s ads.

class google.ads.datamanager_v1.types.ProcessingWarningReason(value)

Bases: proto.enums.Enum

The processing warning reason.

Values:

PROCESSING_WARNING_REASON_UNSPECIFIED (0):

The processing warning reason is unknown.

PROCESSING_WARNING_REASON_KEK_PERMISSION_DENIED (1):

The system did not have the permissions needed to access the KEK.

PROCESSING_WARNING_REASON_DEK_DECRYPTION_ERROR (2):

The DEK failed to be decrypted.

PROCESSING_WARNING_REASON_DECRYPTION_ERROR (3):

The event has a decryption error.

PROCESSING_WARNING_REASON_WIP_AUTH_FAILED (4):

The WIP could not be used because it was rejected by its attestation condition.

PROCESSING_WARNING_REASON_INVALID_WIP (5):

The WIP is formatted incorrectly or the WIP does not exist.

PROCESSING_WARNING_REASON_INVALID_KEK (6):

The KEK cannot decrypt data because it is the wrong KEK, or it does not exist.

PROCESSING_WARNING_REASON_USER_IDENTIFIER_DECRYPTION_ERROR (7):

Failed to decrypt th [UserIdentifier][google.ads.datamanager.v1.UserIdentifier] data using the DEK.

PROCESSING_WARNING_REASON_INTERNAL_ERROR (8):

Internal error.

PROCESSING_WARNING_REASON_AWS_AUTH_FAILED (9):

The system failed to authenticate with AWS.

class google.ads.datamanager_v1.types.Product(value)

Bases: proto.enums.Enum

Deprecated. Use [AccountType][google.ads.datamanager.v1.ProductAccount.AccountType] instead. Represents a specific Google product.

Values:

PRODUCT_UNSPECIFIED (0):

Unspecified product. Should never be used.

GOOGLE_ADS (1):

Google Ads.

DISPLAY_VIDEO_PARTNER (2):

Display & Video 360 partner.

DISPLAY_VIDEO_ADVERTISER (3):

Display & Video 360 advertiser.

DATA_PARTNER (4):

Data Partner.

class google.ads.datamanager_v1.types.ProductAccount(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Represents a specific account.

product

Deprecated. Use [account_type][google.ads.datamanager.v1.ProductAccount.account_type] instead.

Type

google.ads.datamanager_v1.types.Product

account_id

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

Type

str

account_type

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.

Type

google.ads.datamanager_v1.types.ProductAccount.AccountType

class AccountType(value)

Bases: proto.enums.Enum

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

Values:

ACCOUNT_TYPE_UNSPECIFIED (0):

Unspecified product. Should never be used.

GOOGLE_ADS (1):

Google Ads.

DISPLAY_VIDEO_PARTNER (2):

Display & Video 360 partner.

DISPLAY_VIDEO_ADVERTISER (3):

Display & Video 360 advertiser.

DATA_PARTNER (4):

Data Partner.

GOOGLE_ANALYTICS_PROPERTY (5):

Google Analytics.

GOOGLE_AD_MANAGER_AUDIENCE_LINK (6):

Google Ad Manager audience link.

class google.ads.datamanager_v1.types.PseudonymousIdInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Additional information when PSEUDONYMOUS_ID is one of the upload_key_types.

sync_status

Output only. Sync status of the user list.

This field is a member of oneof _sync_status.

Type

google.ads.datamanager_v1.types.PseudonymousIdInfo.SyncStatus

billable_record_count

Optional. Immutable. The number of billable records (e.g. uploaded or matched).

This field is a member of oneof _billable_record_count.

Type

int

class SyncStatus(value)

Bases: proto.enums.Enum

Sync status of the user list.

Values:

SYNC_STATUS_UNSPECIFIED (0):

Not specified.

CREATED (1):

The user list has been created as a placeholder. List contents and/or metadata are still being synced. The user list is not ready for use.

READY_FOR_USE (2):

The user list is ready for use. Contents and cookies have been synced correctly.

FAILED (3):

An error has occurred syncing user list contents and/or metadata. The user list cannot be used.

class google.ads.datamanager_v1.types.RemoveAudienceMembersRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to remove users from an audience in the provided destinations. Returns a [RemoveAudienceMembersResponse][google.ads.datamanager.v1.RemoveAudienceMembersResponse].

destinations

Required. The list of destinations to remove the users from.

Type

MutableSequence[google.ads.datamanager_v1.types.Destination]

audience_members

Required. The list of users to remove.

Type

MutableSequence[google.ads.datamanager_v1.types.AudienceMember]

validate_only

Optional. For testing purposes. If true, the request is validated but not executed. Only errors are returned, not results.

Type

bool

encoding

Optional. Required for [UserData][google.ads.datamanager.v1.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.

Type

google.ads.datamanager_v1.types.Encoding

encryption_info

Optional. Encryption information for [UserData][google.ads.datamanager.v1.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.

Type

google.ads.datamanager_v1.types.EncryptionInfo

class google.ads.datamanager_v1.types.RemoveAudienceMembersResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response from the [RemoveAudienceMembersRequest][google.ads.datamanager.v1.RemoveAudienceMembersRequest].

request_id

The auto-generated ID of the request.

Type

str

class google.ads.datamanager_v1.types.RequestStatusPerDestination(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A request status per destination.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

destination

A destination within a DM API request.

Type

google.ads.datamanager_v1.types.Destination

request_status

The request status of the destination.

Type

google.ads.datamanager_v1.types.RequestStatusPerDestination.RequestStatus

error_info

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

Type

google.ads.datamanager_v1.types.ErrorInfo

warning_info

A warning info containing the warning reason and warning counts related to the upload.

Type

google.ads.datamanager_v1.types.WarningInfo

audience_members_ingestion_status

The status of the ingest audience members request.

This field is a member of oneof status.

Type

google.ads.datamanager_v1.types.RequestStatusPerDestination.IngestAudienceMembersStatus

events_ingestion_status

The status of the ingest events request.

This field is a member of oneof status.

Type

google.ads.datamanager_v1.types.RequestStatusPerDestination.IngestEventsStatus

audience_members_removal_status

The status of the remove audience members request.

This field is a member of oneof status.

Type

google.ads.datamanager_v1.types.RequestStatusPerDestination.RemoveAudienceMembersStatus

class IngestAudienceMembersStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The status of the ingest audience members request.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

user_data_ingestion_status

The status of the user data ingestion to the destination.

This field is a member of oneof status.

Type

google.ads.datamanager_v1.types.RequestStatusPerDestination.IngestUserDataStatus

mobile_data_ingestion_status

The status of the mobile data ingestion to the destination.

This field is a member of oneof status.

Type

google.ads.datamanager_v1.types.RequestStatusPerDestination.IngestMobileDataStatus

pair_data_ingestion_status

The status of the pair data ingestion to the destination.

This field is a member of oneof status.

Type

google.ads.datamanager_v1.types.RequestStatusPerDestination.IngestPairDataStatus

user_id_data_ingestion_status

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

This field is a member of oneof status.

Type

google.ads.datamanager_v1.types.RequestStatusPerDestination.IngestUserIdDataStatus

ppid_data_ingestion_status

The status of the ppid data ingestion to the destination.

This field is a member of oneof status.

Type

google.ads.datamanager_v1.types.RequestStatusPerDestination.IngestPpidDataStatus

class IngestEventsStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The status of the events ingestion to the destination.

record_count

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.

Type

int

class IngestMobileDataStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

record_count

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.

Type

int

mobile_id_count

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.

Type

int

class IngestPairDataStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

record_count

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.

Type

int

pair_id_count

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.

Type

int

class IngestPpidDataStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

record_count

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.

Type

int

ppid_count

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

Type

int

class IngestUserDataStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

record_count

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.

Type

int

user_identifier_count

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.

Type

int

upload_match_rate_range

The match rate range of the upload.

Type

google.ads.datamanager_v1.types.MatchRateRange

class IngestUserIdDataStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

record_count

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.

Type

int

user_id_count

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

Type

int

class RemoveAudienceMembersStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The status of the remove audience members request.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

user_data_removal_status

The status of the user data removal from the destination.

This field is a member of oneof status.

Type

google.ads.datamanager_v1.types.RequestStatusPerDestination.RemoveUserDataStatus

mobile_data_removal_status

The status of the mobile data removal from the destination.

This field is a member of oneof status.

Type

google.ads.datamanager_v1.types.RequestStatusPerDestination.RemoveMobileDataStatus

pair_data_removal_status

The status of the pair data removal from the destination.

This field is a member of oneof status.

Type

google.ads.datamanager_v1.types.RequestStatusPerDestination.RemovePairDataStatus

user_id_data_removal_status

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

This field is a member of oneof status.

Type

google.ads.datamanager_v1.types.RequestStatusPerDestination.RemoveUserIdDataStatus

ppid_data_removal_status

The status of the ppid data removal from the destination.

This field is a member of oneof status.

Type

google.ads.datamanager_v1.types.RequestStatusPerDestination.RemovePpidDataStatus

class RemoveMobileDataStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The status of the mobile data removal from the destination.

record_count

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.

Type

int

mobile_id_count

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.

Type

int

class RemovePairDataStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The status of the pair data removal from the destination.

record_count

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.

Type

int

pair_id_count

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.

Type

int

class RemovePpidDataStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The status of the ppid data removal from the destination.

record_count

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.

Type

int

ppid_count

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

Type

int

class RemoveUserDataStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The status of the user data removal from the destination.

record_count

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.

Type

int

user_identifier_count

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.

Type

int

class RemoveUserIdDataStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

record_count

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.

Type

int

user_id_count

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

Type

int

class RequestStatus(value)

Bases: proto.enums.Enum

The request status.

Values:

REQUEST_STATUS_UNKNOWN (0):

The request status is unknown.

SUCCESS (1):

The request succeeded.

PROCESSING (2):

The request is processing.

FAILED (3):

The request failed.

PARTIAL_SUCCESS (4):

The request partially succeeded.

class google.ads.datamanager_v1.types.RetrieveInsightsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for DM API MarketingDataInsightsService.RetrieveInsights

parent

Required. The parent account that owns the user list. Format: accountTypes/{account_type}/accounts/{account}

Type

str

baseline

Required. Baseline for the insights requested.

Type

google.ads.datamanager_v1.types.Baseline

user_list_id

Required. The user list ID for which insights are requested.

Type

str

class google.ads.datamanager_v1.types.RetrieveInsightsResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response message for DM API MarketingDataInsightsService.RetrieveInsights

marketing_data_insights

Contains the insights for the marketing data.

Type

MutableSequence[google.ads.datamanager_v1.types.RetrieveInsightsResponse.MarketingDataInsight]

class MarketingDataInsight(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Insights for marketing data.

This feature is only available to data partners.

dimension

The dimension to which the insight belongs.

Type

google.ads.datamanager_v1.types.RetrieveInsightsResponse.MarketingDataInsight.AudienceInsightsDimension

attributes

Insights for values of a given dimension.

Type

MutableSequence[google.ads.datamanager_v1.types.RetrieveInsightsResponse.MarketingDataInsight.MarketingDataInsightsAttribute]

class AudienceInsightsDimension(value)

Bases: proto.enums.Enum

Possible dimensions for use in generating insights.

Values:

AUDIENCE_INSIGHTS_DIMENSION_UNSPECIFIED (0):

Not specified.

AUDIENCE_INSIGHTS_DIMENSION_UNKNOWN (1):

The value is unknown in this version.

AFFINITY_USER_INTEREST (2):

An Affinity UserInterest.

IN_MARKET_USER_INTEREST (3):

An In-Market UserInterest.

AGE_RANGE (4):

An age range.

GENDER (5):

A gender.

class MarketingDataInsightsAttribute(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Insights for a collection of related attributes of the same dimension.

user_interest_id

The user interest ID.

This field is a member of oneof _user_interest_id.

Type

int

lift

Measure of lift that the audience has for the attribute value as compared to the baseline. Range [0-1].

This field is a member of oneof _lift.

Type

float

age_range

Age range of the audience for which the lift is provided.

This field is a member of oneof _age_range.

Type

google.ads.datamanager_v1.types.AgeRange

gender

Gender of the audience for which the lift is provided.

This field is a member of oneof _gender.

Type

google.ads.datamanager_v1.types.Gender

class google.ads.datamanager_v1.types.RetrieveRequestStatusRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to get the status of request made to the DM API for a given request ID. Returns a [RetrieveRequestStatusResponse][google.ads.datamanager.v1.RetrieveRequestStatusResponse].

request_id

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

Type

str

class google.ads.datamanager_v1.types.RetrieveRequestStatusResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response from the [RetrieveRequestStatusRequest][google.ads.datamanager.v1.RetrieveRequestStatusRequest].

request_status_per_destination

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

Type

MutableSequence[google.ads.datamanager_v1.types.RequestStatusPerDestination]

class google.ads.datamanager_v1.types.SearchPartnerLinksRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to search for [PartnerLink][google.ads.datamanager.v1.PartnerLink] resources. Returns a [SearchPartnerLinksResponse][google.ads.datamanager.v1.SearchPartnerLinksResponse].

parent

Required. Account to search for partner links. If no filter is specified, all partner links where this account is either the owning_account or partner_account are returned.

Format: accountTypes/{account_type}/accounts/{account}

Type

str

page_size

The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 10 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.

Type

int

page_token

A page token, received from a previous SearchPartnerLinks call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SearchPartnerLinks must match the call that provided the page token.

Type

str

filter

Optional. A filter string. All fields need to be on the left hand side of each condition (for example: partner_link_id = 123456789). Fields must be specified using either all camel case or all snake case. Don’t use a combination of camel case and snake case.

Supported operations:

• AND

• =

• !=

Supported fields:

• partner_link_id

• owning_account.account_type

• owning_account.account_id

• partner_account.account_type

• partner_account.account_id

Example: owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321

Type

str

class google.ads.datamanager_v1.types.SearchPartnerLinksResponse(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Response from the [SearchPartnerLinksRequest][google.ads.datamanager.v1.SearchPartnerLinksRequest].

partner_links

The partner links for the given account.

Type

MutableSequence[google.ads.datamanager_v1.types.PartnerLink]

next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

Type

str

class google.ads.datamanager_v1.types.SizeInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Estimated number of members in this user list in different target networks.

display_network_members_count

Output only. Estimated number of members in this user list, on the Google Display Network.

Type

int

search_network_members_count

Output only. Estimated number of members in this user list in the google.com domain. These are the members available for targeting in Search campaigns.

Type

int

class google.ads.datamanager_v1.types.TargetNetworkInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Eligibility information for different target networks.

eligible_for_display

Output only. Indicates this user list is eligible for Google Display Network.

Type

bool

eligible_for_search

Optional. Indicates if this user list is eligible for Google Search Network.

This field is a member of oneof _eligible_for_search.

Type

bool

class google.ads.datamanager_v1.types.TermsOfService(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

customer_match_terms_of_service_status

Optional. The Customer Match terms of service: https://support.google.com/adspolicy/answer/6299717. This must be accepted when ingesting [UserData][google.ads.datamanager.v1.UserData] or [MobileData][google.ads.datamanager.v1.MobileData]. This field is not required for Partner Match User list.

Type

google.ads.datamanager_v1.types.TermsOfServiceStatus

class google.ads.datamanager_v1.types.TermsOfServiceStatus(value)

Bases: proto.enums.Enum

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

Values:

TERMS_OF_SERVICE_STATUS_UNSPECIFIED (0):

Not specified.

ACCEPTED (1):

Status indicating the caller has chosen to accept the terms of service.

REJECTED (2):

Status indicating the caller has chosen to reject the terms of service.

class google.ads.datamanager_v1.types.UpdateUserListDirectLicenseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to update a [UserListDirectLicense][google.ads.datamanager.v1.UserListDirectLicense] resource.

user_list_direct_license

Required. The licenses’ name field is used to identify the license to update.

Type

google.ads.datamanager_v1.types.UserListDirectLicense

update_mask

Optional. The list of fields to update. The special character * is not supported and an INVALID_UPDATE_MASK error will be thrown if used.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.datamanager_v1.types.UpdateUserListGlobalLicenseRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request to update a [UserListGlobalLicense][google.ads.datamanager.v1.UserListGlobalLicense] resource.

user_list_global_license

Required. The licenses’ name field is used to identify the license to update.

Type

google.ads.datamanager_v1.types.UserListGlobalLicense

update_mask

Optional. The list of fields to update. The special character * is not supported and an INVALID_UPDATE_MASK error will be thrown if used.

Type

google.protobuf.field_mask_pb2.FieldMask

class google.ads.datamanager_v1.types.UpdateUserListRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Request message for UpdateUserList.

user_list

Required. The user list to update.

The user list’s name field is used to identify the user list to update. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

Type

google.ads.datamanager_v1.types.UserList

update_mask

Optional. The list of fields to update.

Type

google.protobuf.field_mask_pb2.FieldMask

validate_only

Optional. If true, the request is validated but not executed.

Type

bool

class google.ads.datamanager_v1.types.UserData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

user_identifiers

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][google.ads.datamanager.v1.AudienceMember] or [Event][google.ads.datamanager.v1.Event].

Type

MutableSequence[google.ads.datamanager_v1.types.UserIdentifier]

class google.ads.datamanager_v1.types.UserIdData(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

User id data holding the user id.

user_id

Required. A unique identifier for a user, as defined by the advertiser.

Type

str

class google.ads.datamanager_v1.types.UserIdInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Additional information when USER_ID is one of the upload_key_types.

data_source_type

Optional. Immutable. Source of the upload data.

This field is a member of oneof _data_source_type.

Type

google.ads.datamanager_v1.types.DataSourceType

class google.ads.datamanager_v1.types.UserIdentifier(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A single identifier for the user.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

email_address

Hashed email address using SHA-256 hash function after normalization.

This field is a member of oneof identifier.

Type

str

phone_number

Hashed phone number using SHA-256 hash function after normalization (E164 standard).

This field is a member of oneof identifier.

Type

str

address

The known components of a user’s address. Holds a grouping of identifiers that are matched all at once.

This field is a member of oneof identifier.

Type

google.ads.datamanager_v1.types.AddressInfo

class google.ads.datamanager_v1.types.UserList(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A user list resource.

name

Identifier. The resource name of the user list. Format: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

Type

str

id

Output only. The unique ID of the user list.

Type

int

read_only

Output only. An option that indicates if a user may edit a list.

Type

bool

display_name

Required. The display name of the user list.

This field is a member of oneof _display_name.

Type

str

description

Optional. A description of the user list.

This field is a member of oneof _description.

Type

str

membership_status

Optional. Membership status of this user list.

This field is a member of oneof _membership_status.

Type

google.ads.datamanager_v1.types.UserList.MembershipStatus

integration_code

Optional. An ID from external system. It is used by user list sellers to correlate IDs on their systems.

This field is a member of oneof _integration_code.

Type

str

membership_duration

Optional. The duration a user remains in the user list. Valid durations are exact multiples of 24 hours (86400 seconds). Providing a value that is not an exact multiple of 24 hours will result in an INVALID_ARGUMENT error.

Type

google.protobuf.duration_pb2.Duration

closing_reason

Output only. The reason why this user list membership status is closed.

This field is a member of oneof _closing_reason.

Type

google.ads.datamanager_v1.types.UserList.ClosingReason

access_reason

Output only. The reason this account has been granted access to the list.

Type

google.ads.datamanager_v1.types.UserList.AccessReason

account_access_status

Optional. Indicates if this share is still enabled. When a user list is shared with the account this field is set to ENABLED. Later the user list owner can decide to revoke the share and make it DISABLED.

This field is a member of oneof _account_access_status.

Type

google.ads.datamanager_v1.types.UserList.AccessStatus

size_info

Output only. Estimated number of members in this user list in different target networks.

Type

google.ads.datamanager_v1.types.SizeInfo

target_network_info

Optional. Eligibility information for different target networks.

Type

google.ads.datamanager_v1.types.TargetNetworkInfo

ingested_user_list_info

Optional. Represents a user list that is populated by user ingested data.

This field is a member of oneof user_list_info.

Type

google.ads.datamanager_v1.types.IngestedUserListInfo

class AccessReason(value)

Bases: proto.enums.Enum

Enum describing possible access reasons.

Values:

ACCESS_REASON_UNSPECIFIED (0):

Not specified.

OWNED (1):

The resource is owned by the user.

SHARED (2):

The resource is shared to the user.

LICENSED (3):

The resource is licensed to the user.

SUBSCRIBED (4):

The user subscribed to the resource.

AFFILIATED (5):

The resource is accessible to the user.

class AccessStatus(value)

Bases: proto.enums.Enum

Indicates if this client still has access to the list.

Values:

ACCESS_STATUS_UNSPECIFIED (0):

Not specified.

ENABLED (1):

The access is enabled.

DISABLED (2):

The access is disabled.

class ClosingReason(value)

Bases: proto.enums.Enum

Indicates the reason why the user list was closed. This enum is only used when a list is auto-closed by the system.

Values:

CLOSING_REASON_UNSPECIFIED (0):

Not specified.

UNUSED (1):

The user list was closed because it has not been used in targeting recently. See https://support.google.com/google-ads/answer/2472738 for details.

class MembershipStatus(value)

Bases: proto.enums.Enum

Status of the user list.

Values:

MEMBERSHIP_STATUS_UNSPECIFIED (0):

Not specified.

OPEN (1):

Open status - User list is accruing members and can be targeted to.

CLOSED (2):

Closed status - No new members being added.

class google.ads.datamanager_v1.types.UserListDirectLicense(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A user list direct license.

This feature is only available to data partners.

name

Identifier. The resource name of the user list direct license.

Type

str

user_list_id

Immutable. ID of the user list being licensed.

This field is a member of oneof _user_list_id.

Type

int

user_list_display_name

Output only. Name of the user list being licensed. This field is read-only.

Type

str

client_account_type

Immutable. Account type of client customer which the user list is being licensed to.

This field is a member of oneof _client_account_type.

Type

google.ads.datamanager_v1.types.UserListLicenseClientAccountType

client_account_id

Immutable. ID of client customer which the user list is being licensed to.

This field is a member of oneof _client_account_id.

Type

int

client_account_display_name

Output only. Name of client customer which the user list is being licensed to.

This field is read-only.

Type

str

status

Optional. Status of UserListDirectLicense - ENABLED or DISABLED.

This field is a member of oneof _status.

Type

google.ads.datamanager_v1.types.UserListLicenseStatus

pricing

Optional. UserListDirectLicense pricing.

Type

google.ads.datamanager_v1.types.UserListLicensePricing

historical_pricings

Output only. Pricing history of this user list license. This field is read-only.

Type

MutableSequence[google.ads.datamanager_v1.types.UserListLicensePricing]

metrics

Output only. Metrics related to this license

This field is read-only and only populated if the start and end dates are set in the ListUserListDirectLicenses call

Type

google.ads.datamanager_v1.types.UserListLicenseMetrics

class google.ads.datamanager_v1.types.UserListGlobalLicense(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A user list global license.

This feature is only available to data partners.

name

Identifier. The resource name of the user list global license.

Type

str

user_list_id

Immutable. ID of the user list being licensed.

This field is a member of oneof _user_list_id.

Type

int

user_list_display_name

Output only. Name of the user list being licensed. This field is read-only.

Type

str

license_type

Immutable. Product type of client customer which the user list is being licensed to.

This field is a member of oneof _license_type.

Type

google.ads.datamanager_v1.types.UserListGlobalLicenseType

status

Optional. Status of UserListGlobalLicense - ENABLED or DISABLED.

This field is a member of oneof _status.

Type

google.ads.datamanager_v1.types.UserListLicenseStatus

pricing

Optional. UserListGlobalLicense pricing.

Type

google.ads.datamanager_v1.types.UserListLicensePricing

historical_pricings

Output only. Pricing history of this user list license. This field is read-only.

Type

MutableSequence[google.ads.datamanager_v1.types.UserListLicensePricing]

metrics

Output only. Metrics related to this license

This field is read-only and only populated if the start and end dates are set in the ListUserListGlobalLicenses call

Type

google.ads.datamanager_v1.types.UserListLicenseMetrics

class google.ads.datamanager_v1.types.UserListGlobalLicenseCustomerInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Information about a customer of a user list global license. This will automatically be created by the system when a customer purchases a global license.

name

Identifier. The resource name of the user list global license customer.

Type

str

user_list_id

Output only. ID of the user list being licensed.

Type

int

user_list_display_name

Output only. Name of the user list being licensed.

Type

str

license_type

Output only. Product type of client customer which the user list is being licensed to.

Type

google.ads.datamanager_v1.types.UserListGlobalLicenseType

status

Output only. Status of UserListDirectLicense - ENABLED or DISABLED.

Type

google.ads.datamanager_v1.types.UserListLicenseStatus

pricing

Output only. UserListDirectLicense pricing.

Type

google.ads.datamanager_v1.types.UserListLicensePricing

client_account_type

Output only. Product type of client customer which the user list is being licensed to.

Type

google.ads.datamanager_v1.types.UserListLicenseClientAccountType

client_account_id

Output only. ID of client customer which the user list is being licensed to.

Type

int

client_account_display_name

Output only. Name of client customer which the user list is being licensed to.

Type

str

historical_pricings

Output only. Pricing history of this user list license.

Type

MutableSequence[google.ads.datamanager_v1.types.UserListLicensePricing]

metrics

Output only. Metrics related to this license

This field is only populated if the start and end dates are set in the ListUserListGlobalLicenseCustomerInfos call.

Type

google.ads.datamanager_v1.types.UserListLicenseMetrics

class google.ads.datamanager_v1.types.UserListGlobalLicenseType(value)

Bases: proto.enums.Enum

User list global license types.

Values:

USER_LIST_GLOBAL_LICENSE_TYPE_UNSPECIFIED (0):

UNSPECIFIED.

USER_LIST_GLOBAL_LICENSE_TYPE_RESELLER (1):

Reseller license.

USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_SELL_SIDE (2):

DataMart Sell Side license.

USER_LIST_GLOBAL_LICENSE_TYPE_DATA_MART_BUY_SIDE (3):

DataMart Buy Side license.

class google.ads.datamanager_v1.types.UserListLicenseClientAccountType(value)

Bases: proto.enums.Enum

Possible product of a client account for a user list license.

Values:

USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_UNKNOWN (0):

Unknown.

USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_ADS (1):

Google Ads customer.

USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_PARTNER (2):

Display & Video 360 partner.

USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_DISPLAY_VIDEO_ADVERTISER (3):

Display & Video 360 advertiser.

USER_LIST_LICENSE_CLIENT_ACCOUNT_TYPE_GOOGLE_AD_MANAGER_AUDIENCE_LINK (4):

Google Ad Manager audience link.

class google.ads.datamanager_v1.types.UserListLicenseMetrics(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Metrics related to a user list license.

click_count

Output only. The number of clicks for the user list license.

Type

int

impression_count

Output only. The number of impressions for the user list license.

Type

int

revenue_usd_micros

Output only. The revenue for the user list license in USD micros.

Type

int

start_date

Output only. The start date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If end_date is used in the filter, start_date is also required. If neither start_date nor end_date are included in the filter, the UserListLicenseMetrics fields will not be populated in the response.

Type

int

end_date

Output only. The end date (inclusive) of the metrics in the format YYYYMMDD. For example, 20260102 represents January 2, 2026. If start_date is used in the filter, end_date is also required. If neither start_date nor end_date are included in the filter, the UserListLicenseMetrics fields will not be populated in the response.

Type

int

class google.ads.datamanager_v1.types.UserListLicensePricing(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

A user list license pricing.

pricing_id

Output only. The ID of this pricing.

Type

int

cost_micros

Optional. The cost associated with the model, in micro units (10^-6), in the currency specified by the currency_code field. For example, 2000000 means $2 if currency_code is USD.

This field is a member of oneof _cost_micros.

Type

int

currency_code

Optional. The currency in which cost and max_cost is specified. Must be a three-letter currency code defined in ISO 4217.

This field is a member of oneof _currency_code.

Type

str

start_time

Output only. Start time of the pricing.

Type

google.protobuf.timestamp_pb2.Timestamp

end_time

Optional. End time of the pricing.

Type

google.protobuf.timestamp_pb2.Timestamp

pricing_active

Output only. Whether this pricing is active.

Type

bool

buyer_approval_state

Output only. The buyer approval state of this pricing. This field is read-only.

Type

google.ads.datamanager_v1.types.UserListLicensePricing.UserListPricingBuyerApprovalState

cost_type

Immutable. The cost type of this pricing.

Can be set only in the create operation. Can’t be updated for an existing license.

This field is a member of oneof _cost_type.

Type

google.ads.datamanager_v1.types.UserListLicensePricing.UserListPricingCostType

max_cost_micros

Optional. The maximum CPM a commerce audience can be charged when the MEDIA_SHARE cost type is used. The value is in micro units (10^-6) and in the currency specified by the currency_code field. For example, 2000000 means $2 if currency_code is USD.

This is only relevant when cost_type is MEDIA_SHARE. When cost_type is not MEDIA_SHARE, and this field is set, a MAX_COST_NOT_ALLOWED error will be returned. If not set or set to0, there is no cap.

This field is a member of oneof _max_cost_micros.

Type

int

class UserListPricingBuyerApprovalState(value)

Bases: proto.enums.Enum

User list pricing buyer approval state.

Values:

USER_LIST_PRICING_BUYER_APPROVAL_STATE_UNSPECIFIED (0):

UNSPECIFIED.

PENDING (1):

User list client has not yet accepted the pricing terms set by the user list owner.

APPROVED (2):

User list client has accepted the pricing terms set by the user list owner.

REJECTED (3):

User list client has rejected the pricing terms set by the user list owner.

class UserListPricingCostType(value)

Bases: proto.enums.Enum

User list pricing cost type.

Values:

USER_LIST_PRICING_COST_TYPE_UNSPECIFIED (0):

Unspecified.

CPC (1):

Cost per click.

CPM (2):

Cost per mille (thousand impressions).

MEDIA_SHARE (3):

Media share.

class google.ads.datamanager_v1.types.UserListLicenseStatus(value)

Bases: proto.enums.Enum

User list license status.

Values:

USER_LIST_LICENSE_STATUS_UNSPECIFIED (0):

Unknown.

USER_LIST_LICENSE_STATUS_ENABLED (1):

Active status - user list is still being licensed.

USER_LIST_LICENSE_STATUS_DISABLED (2):

Inactive status - user list is no longer being licensed.

class google.ads.datamanager_v1.types.UserProperties(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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.

customer_type

Optional. Type of the customer associated with the event.

Type

google.ads.datamanager_v1.types.CustomerType

customer_value_bucket

Optional. The advertiser-assessed value of the customer.

Type

google.ads.datamanager_v1.types.CustomerValueBucket

additional_user_properties

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

Type

MutableSequence[google.ads.datamanager_v1.types.UserProperty]

class google.ads.datamanager_v1.types.UserProperty(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

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

property_name

Required. The name of the user property to use.

Type

str

value

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

Type

str

class google.ads.datamanager_v1.types.WarningCount(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

The warning count for a given warning reason.

record_count

The count of records that have a warning.

Type

int

reason

The warning reason.

Type

google.ads.datamanager_v1.types.ProcessingWarningReason

class google.ads.datamanager_v1.types.WarningInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Bases: proto.message.Message

Warning counts for each type of warning.

warning_counts

A list of warnings and counts per warning reason.

Type

MutableSequence[google.ads.datamanager_v1.types.WarningCount]