Package google.ads.datamanager.v1

string

Необязательно. Атрибуты сессии для атрибуции событий и моделирования.

string

Необязательно. Идентификатор клика Google (gclid), связанный с этим событием.

string

Необязательный параметр. Идентификатор клика для кликов, связанных с событиями приложения и исходящих с устройств iOS, начиная с iOS 14.

string

Необязательный параметр. Идентификатор клика для кликов, связанных с веб-событиями и происходящих на устройствах iOS, начиная с iOS 14.

DeviceInfo

Необязательно. Информация, собираемая об используемом устройстве (если таковое имелось) в момент перехода на сайт рекламодателя после взаимодействия с рекламой.

string

Обязательно. Укажите имя пользователя (в нижнем регистре), без знаков препинания, пробелов в начале и конце, хешированное как SHA-256.

string

Обязательно. Фамилия пользователя, все строчные буквы, без знаков препинания, без пробелов в начале и конце, хешированная как SHA-256.

string

Обязательно. Двухбуквенный региональный код адреса пользователя в формате ISO-3166-1 alpha-2.

string

Обязательно. Почтовый индекс адреса пользователя.

string

Необязательный параметр. Определяет, в какое Destination следует направить участника аудитории.

Consent

Необязательно. Настройки согласия пользователя.

UserData

Данные, предоставленные пользователем, позволяющие идентифицировать пользователя.

PairData

Идентификаторы PAIR (Publisher Advertiser Identity Reconciliation) .

Эта функция доступна только партнерам по передаче данных.

MobileData

Данные, идентифицирующие мобильные устройства пользователя.

UserIdData

Данные, относящиеся к уникальным идентификаторам пользователя, определенным рекламодателем.

PpidData

Данные, относящиеся к идентификаторам, предоставленным издателем.

Эта функция доступна только партнерам по передаче данных.

KeyType

Обязательно. Тип алгоритма, используемого для шифрования данных.

string

Обязательно. Имя ресурса Amazon для роли IAM, которая будет использоваться для доступа к расшифровке KMS. Должно быть в формате arn:{partition}:iam::{account_id}:role/{role_name}

string

Обязательно. URI ключа AWS KMS, используемого для расшифровки DEK. Должен быть в формате arn:{partition}:kms:{region}:{account_id}:key/{key_id} или aws-kms://arn:{partition}:kms:{region}:{account_id}:key/{key_id}

string

Обязательно. Ключ шифрования данных, закодированных в base64.

Location

Базовое местоположение запроса. Базовое местоположение представляет собой список запрашиваемых регионов, заданный оператором ИЛИ.

bool

Если установить значение true, сервис попытается автоматически определить базовое местоположение для получения аналитических данных.

string

Список кодов регионов ISO 3166-1 alpha-2.

string

Необязательно. Идентификатор торгового центра, связанный с товарами.

string

Необязательно. Метка фида Merchant Center, связанная с фидом товаров.

string

Необязательно. Код языка в ISO 639-1, связанный с фидом товаров в Merchant Center, куда загружаются ваши товары.

double

Необязательно. Сумма всех скидок, связанных с данной транзакцией.

Item

Необязательно. Список предметов, связанных с мероприятием.

ConsentStatus

Необязательный параметр. Указывает, согласен ли пользователь на предоставление данных о пользователе рекламной сети.

ConsentStatus

Необязательный параметр. Указывает, согласен ли пользователь на персонализацию рекламы.

int32

Только для вывода. Коэффициент совпадения для списков пользователей, соответствующих требованиям клиента.

DataSourceType

Необязательный. Неизменяемый. Источник данных для загрузки.

string

Обязательно. Родительский ресурс, которому принадлежит эта коллекция партнерских ссылок. Формат: accountTypes/{account_type}/accounts/{account}

PartnerLink

Обязательно. Партнерская ссылка для создания.

string

Обязательно. Учетная запись, которой принадлежит лицензируемый список пользователей. Формат должен быть accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}.

UserListDirectLicense

Обязательно. Для создания списка пользователей требуется прямая лицензия.

string

Обязательно. Учетная запись, которой принадлежит лицензируемый список пользователей. Формат должен быть accountTypes/{ACCOUNT_TYPE}/accounts/{ACCOUNT_ID}.

UserListGlobalLicense

Обязательно. Необходимо создать глобальную лицензию для списка пользователей.

string

Обязательно. Родительская учетная запись, в которой будет создан этот список пользователей. Формат: accountTypes/{account_type}/accounts/{account}

UserList

Обязательно. Список пользователей для создания.

bool

Необязательный параметр. Если значение равно true, запрос проверяется, но не выполняется.

string

Необязательно. Имя пользовательской переменной для установки. Если переменная не найдена для указанного места назначения, она будет проигнорирована.

string

Необязательный параметр. Значение, которое будет сохранено для пользовательской переменной.

string

Необязательный параметр. Строка-ссылка, используемая для определения того, в какой из объектов Event.destination_references следует отправить пользовательскую переменную. Если строка пустая, будет использован объект Event.destination_references .

string

Обязательно. Имя ресурса партнерской ссылки для удаления. Формат: accountTypes/{account_type}/accounts/{account}/partnerLinks/{partner_link}

string

Обязательно. Название списка пользователей для удаления. Формат: accountTypes/{account_type}/accounts/{account}/userLists/{user_list}

bool

Необязательный параметр. Если значение равно true, запрос проверяется, но не выполняется.

string

Необязательный параметр. Идентификатор для этого ресурса Destination , уникальный в рамках запроса. Используется для ссылки на этот Destination в запросах IngestEventsRequest и IngestAudienceMembersRequest .

ProductAccount

Необязательно. Учетная запись, используемая для выполнения этого вызова API. Для добавления или удаления данных из operating_account эта login_account должна иметь права на запись в operating_account . Например, учетная запись менеджера operating_account или учетная запись с установленной связью с operating_account .

ProductAccount

Необязательно. Учетная запись, к которой имеет доступ login_account пользователя, осуществляющего вход, через установленную связь учетных записей. Например, login_account партнера по данным может иметь доступ к linked_account клиента. Партнер может использовать это поле для отправки данных из linked_account в другую operating_account .

ProductAccount

Обязательно. Учетная запись, на которую следует отправить данные или с которой следует удалить данные.

string

Обязательно. Объект в аккаунте продукта, в который необходимо импортировать данные. Например, идентификатор аудитории Google Ads, идентификатор аудитории Display & Video 360 или идентификатор действия конверсии Google Ads.

string

Необязательный параметр. Строка user-gent устройства для данного контекста.

string

Необязательный параметр. IP-адрес устройства для данного контекста.

Примечание: Google Ads не поддерживает сопоставление IP-адресов конечных пользователей из Европейской экономической зоны (ЕЭЗ), Великобритании (UK) или Швейцарии (CH). Добавьте логику для условного исключения обмена IP-адресами пользователей из этих регионов и убедитесь, что вы предоставляете пользователям четкую и исчерпывающую информацию о данных, которые вы собираете на своих сайтах, в приложениях и других ресурсах, а также получаете согласие там, где это требуется по закону или в соответствии с применимыми политиками Google. Дополнительные сведения см. на странице «Об импорте данных о конверсиях в офлайн-режиме» .

GcpWrappedKeyInfo

Платформа Google Cloud Platform скрыла ключевую информацию.

AwsWrappedKeyInfo

Amazon Web Services скрыла ключевую информацию.

int64

Количество записей, которые не удалось загрузить по указанной причине.

ProcessingErrorReason

Причина ошибки, из-за которой не удалось записать данные.

ErrorCount

Список ошибок и количество ошибок по каждой причине. Может быть заполнено не во всех случаях.

string

Необязательный параметр. Строка-ссылка, используемая для определения пункта назначения. Если поле пустое, событие будет отправлено всем destinations в запросе.

string

Необязательный параметр. Уникальный идентификатор данного события. Обязателен для преобразований с использованием нескольких источников данных.

Timestamp

Обязательно. Время, когда произошло событие.

Timestamp

Необязательно. Последнее обновление информации о событии.

UserData

Необязательно. Фрагменты предоставленных пользователем данных, представляющие пользователя, с которым связано событие.

Consent

Необязательно. Информация о том, предоставил ли связанный пользователь различные типы согласия.

AdIdentifiers

Необязательно. Идентификаторы и другая информация, используемая для сопоставления события конверсии с другой онлайн-активностью (например, кликами по рекламе).

string

Необязательно. Код валюты, связанный со всеми денежными значениями в рамках этого события.

EventSource

Необязательно. Указывает место проведения события (веб, приложение, магазин и т. д.).

DeviceInfo

Необязательно. Собирается информация об используемом устройстве (если таковое имелось) в момент происшествия.

CartData

Необязательно. Информация о транзакции и товарах, связанных с мероприятием.

CustomVariable

Необязательно. Дополнительная информация в виде пар ключ/значение для отправки в контейнеры конверсии (действие конверсии или активность FL).

ExperimentalField

Необязательно. Список пар ключ/значение для экспериментальных полей, которые в будущем могут быть включены в API.

UserProperties

Необязательно. Информация о пользователе, оцененная рекламодателем на момент совершения события.

string

Необязательно. Название мероприятия. Обязательно для мероприятий GA4.

string

Необязательно. Уникальный идентификатор экземпляра веб-клиента пользователя для этого веб-потока GA4.

string

Необязательный параметр. Уникальный идентификатор пользователя, определяемый рекламодателем.

EventParameter

Необязательно. Список любых параметров события , которые должны быть включены в событие и которые не были указаны ранее с помощью других структурированных полей.

double

Необязательно. Значение конверсии, связанное с событием, для конверсий, основанных на значении.

string

Обязательно. Название используемого параметра.

string

Обязательно. Строковое представление значения параметра, который необходимо установить.

string

Необязательно. Название используемого поля.

string

Необязательный параметр. Значение поля, которое необходимо установить.

KeyType

Обязательно. Тип алгоритма, используемого для шифрования данных.

string

Обязательно. Поставщик пула учетных данных рабочей нагрузки должен использовать KEK.

string

Обязательно. Идентификатор ресурса службы управления ключами Google Cloud Platform. Должен быть в формате projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key} или gcp-kms://projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{key}

string

Обязательно. Ключ шифрования данных, закодированных в base64.

string

Обязательно. Имя ресурса прямой лицензии списка пользователей.

string

Обязательно. Имя ресурса глобальной лицензии списка пользователей.

string

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

Destination

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

AudienceMember

Required. The list of users to send to the specified destinations. At most 10000 AudienceMember resources can be sent in a single request.

Consent

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 .

bool

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

Encoding

Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non UserData uploads, this field is ignored.

EncryptionInfo

Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non UserData uploads, this field is ignored.

TermsOfService

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

string

The auto-generated ID of the request.

Destination

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

Event

Required. The list of events to send to the specified destinations. At most 2000 Event resources can be sent in a single request.

Consent

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 .

bool

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

Encoding

Optional. Required for UserData uploads. The encoding type of the user identifiers. For hashed user identifiers, this is the encoding type of the hashed string. For encrypted hashed user identifiers, this is the encoding type of the outer encrypted string, but not necessarily the inner hashed string, meaning the inner hashed string could be encoded in a different way than the outer encrypted string. For non UserData uploads, this field is ignored.

EncryptionInfo

Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non UserData uploads, this field is ignored.

string

The auto-generated ID of the request.

UploadKeyType

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

ContactIdInfo

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

MobileIdInfo

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

UserIdInfo

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

PairIdInfo

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

This feature is only available to data partners.

PseudonymousIdInfo

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

PartnerAudienceInfo

Optional. Additional information for partner audiences.

This feature is only available to data partners.

string

Optional. The product ID within the Merchant Center account.

int64

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

double

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

string

Optional. A unique identifier to reference the item.

ItemParameter

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

string

Required. The name of the parameter to use.

string

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

string

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

string

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

int32

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.

string

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.

UserListDirectLicense

The licenses for the given user list in the request.

string

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

string

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/- )

string

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

int32

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.

string

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.

UserListGlobalLicenseCustomerInfo

The customer information for the given license in the request.

string

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

string

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

string

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

int32

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.

string

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.

UserListGlobalLicense

The licenses for the given user list in the request.

string

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

string

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

int32

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.

string

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.

string

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.

Поддерживаемые операции:

• AND
• =
• !=
• >
• >=
• <
• <=
• : (имеет)

Supported fields:

• id
• display_name
• description
• membership_status
• integration_code
• access_reason
• ingested_user_list_info.upload_key_types

UserList

The user lists from the specified account.

string

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

string

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

DataSourceType

Optional. Immutable. Source of the upload data.

KeySpace

Required. Immutable. The key space of mobile IDs.

string

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

string

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

int64

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.

string

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

int32

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.

int64

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.

string

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

PartnerAudienceSource

Required. Immutable. The source of the partner audience.

string

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

string

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

string

Output only. The partner link ID.

ProductAccount

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

ProductAccount

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

string

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

Product

Deprecated. Use account_type instead.

string

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

AccountType

Optional. The type of the account. For example, GOOGLE_ADS . Either account_type or the deprecated product is required. If both are set, the values must match.

SyncStatus

Output only. Sync status of the user list.

int64

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

Destination

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

AudienceMember

Required. The list of users to remove.

bool

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

Encoding

Optional. Required for UserData uploads. The encoding type of the user identifiers. Applies to only the outer encoding for encrypted user identifiers. For non UserData uploads, this field is ignored.

EncryptionInfo

Optional. Encryption information for UserData uploads. If not set, it's assumed that uploaded identifying information is hashed but not encrypted. For non UserData uploads, this field is ignored.

string

The auto-generated ID of the request.

Destination

A destination within a DM API request.

RequestStatus

The request status of the destination.

ErrorInfo

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

WarningInfo

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

IngestAudienceMembersStatus

The status of the ingest audience members request.

IngestEventsStatus

The status of the ingest events request.

RemoveAudienceMembersStatus

The status of the remove audience members request.

IngestUserDataStatus

The status of the user data ingestion to the destination.

IngestMobileDataStatus

The status of the mobile data ingestion to the destination.

IngestPairDataStatus

The status of the pair data ingestion to the destination.

IngestUserIdDataStatus

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

IngestPpidDataStatus

The status of the ppid data ingestion to the destination.

int64

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

int64

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

int64

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

int64

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

int64

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

int64

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

int64

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.

int64

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

int64

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

MatchRateRange

The match rate range of the upload.

int64

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

int64

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.

RemoveUserDataStatus

The status of the user data removal from the destination.

RemoveMobileDataStatus

The status of the mobile data removal from the destination.

RemovePairDataStatus

The status of the pair data removal from the destination.

RemoveUserIdDataStatus

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

RemovePpidDataStatus

The status of the ppid data removal from the destination.

int64

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

int64

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

int64

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

int64

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

int64

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

int64

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.

int64

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

int64

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

int64

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

int64

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.

string

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

Baseline

Required. Baseline for the insights requested.

string

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

MarketingDataInsight

Contains the insights for the marketing data.

AudienceInsightsDimension

The dimension to which the insight belongs.

MarketingDataInsightsAttribute

Insights for values of a given dimension.

int64

The user interest ID.

float

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

AgeRange

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

Gender

Gender of the audience for which the lift is provided.

string

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

RequestStatusPerDestination

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

string

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}

int32

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.

string

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.

string

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.

Поддерживаемые операции:

• 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

PartnerLink

The partner links for the given account.

string

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

int64

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

int64

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.

bool

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

bool

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

TermsOfServiceStatus

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

UserListDirectLicense

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

FieldMask

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

UserListGlobalLicense

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

FieldMask

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

UserList

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}

FieldMask

Необязательный параметр. Список полей для обновления.

bool

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

UserIdentifier

Required. The identifiers for the user. It's possible to provide multiple instances of the same type of data (for example, multiple email addresses). To increase the likelihood of a match, provide as many identifiers as possible. At most 10 userIdentifiers can be provided in a single AudienceMember or Event .

string

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

DataSourceType

Optional. Immutable. Source of the upload data.

string

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

string

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

AddressInfo

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

string

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

int64

Output only. The unique ID of the user list.

bool

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

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.

AccessReason

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

SizeInfo

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

TargetNetworkInfo

Optional. Eligibility information for different target networks.

string

Required. The display name of the user list.

string

Optional. A description of the user list.

MembershipStatus

Optional. Membership status of this user list.

string

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

ClosingReason

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

AccessStatus

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 .

IngestedUserListInfo

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

string

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

string

Output only. Name of the user list being licensed.

Это поле доступно только для чтения.

string

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

Это поле доступно только для чтения.

UserListLicensePricing

Optional. UserListDirectLicense pricing.

UserListLicensePricing

Output only. Pricing history of this user list license.

Это поле доступно только для чтения.

UserListLicenseMetrics

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

int64

Immutable. ID of the user list being licensed.

UserListLicenseClientAccountType

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

int64

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

UserListLicenseStatus

Optional. Status of UserListDirectLicense - ENABLED or DISABLED.

string

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

string

Output only. Name of the user list being licensed.

Это поле доступно только для чтения.

UserListLicensePricing

Optional. UserListGlobalLicense pricing.

UserListLicensePricing

Output only. Pricing history of this user list license.

Это поле доступно только для чтения.

UserListLicenseMetrics

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

int64

Immutable. ID of the user list being licensed.

UserListGlobalLicenseType

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

UserListLicenseStatus

Optional. Status of UserListGlobalLicense - ENABLED or DISABLED.

string

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

int64

Output only. ID of the user list being licensed.

string

Output only. Name of the user list being licensed.

UserListGlobalLicenseType

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

UserListLicenseStatus

Output only. Status of UserListDirectLicense - ENABLED or DISABLED.

UserListLicensePricing

Output only. UserListDirectLicense pricing.

UserListLicenseClientAccountType

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

int64

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

string

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

UserListLicensePricing

Output only. Pricing history of this user list license.

UserListLicenseMetrics

Output only. Metrics related to this license

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

int64

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

int64

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

int64

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

int64

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.

int64

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.

int64

Output only. The ID of this pricing.

Timestamp

Output only. Start time of the pricing.

Timestamp

Optional. End time of the pricing.

bool

Output only. Whether this pricing is active.

UserListPricingBuyerApprovalState

Output only. The buyer approval state of this pricing.

Это поле доступно только для чтения.

int64

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 .

string

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

UserListPricingCostType

Immutable. The cost type of this pricing.

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

int64

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 to 0 , there is no cap.

CustomerType

Optional. Type of the customer associated with the event.

CustomerValueBucket

Optional. The advertiser-assessed value of the customer.

UserProperty

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

string

Required. The name of the user property to use.

string

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

int64

The count of records that have a warning.

ProcessingWarningReason

The warning reason.

WarningCount

A list of warnings and counts per warning reason.