Package google.ads.datamanager.v1

Индекс

Служба приема данных

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

IngestAudienceMembers

rpc IngestAudienceMembers( IngestAudienceMembersRequest ) returns ( IngestAudienceMembersResponse )

Загружает список ресурсов AudienceMember в указанное Destination .

Области полномочий

Требуется следующая область действия OAuth:

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

rpc IngestEvents( IngestEventsRequest ) returns ( IngestEventsResponse )

Загружает список ресурсов Event из указанного Destination .

Области полномочий

Требуется следующая область действия OAuth:

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

rpc RemoveAudienceMembers( RemoveAudienceMembersRequest ) returns ( RemoveAudienceMembersResponse )

Удаляет список ресурсов AudienceMember из указанного Destination .

Области полномочий

Требуется следующая область действия OAuth:

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

rpc RetrieveRequestStatus( RetrieveRequestStatusRequest ) returns ( RetrieveRequestStatusResponse )

Получает статус запроса по заданному идентификатору запроса.

Области полномочий

Требуется следующая область действия OAuth:

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

AdIdentifiers

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

Поля
session_attributes

string

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

gclid

string

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

gbraid

string

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

wbraid

string

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

landing_page_device_info

DeviceInfo

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

Информация об адресе

Адресная информация для пользователя.

Поля
given_name

string

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

family_name

string

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

region_code

string

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

postal_code

string

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

Участник аудитории

Участника аудитории, которому будет проведена операция.

Поля
destination_references[]

string

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

consent

Consent

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

data поля объединения. Тип идентификационных данных, с которыми необходимо выполнить операцию. data могут быть только одним из следующих типов:
user_data

UserData

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

pair_data

PairData

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

mobile_data

MobileData

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

AwsWrappedKeyInfo

Ключ шифрования данных, упакованный в ключ AWS KMS.

Поля
key_type

KeyType

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

role_arn

string

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

kek_uri

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}

encrypted_dek

string

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

KeyType

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

Перечисления
KEY_TYPE_UNSPECIFIED Тип ключа не указан. Использовать его не следует.
XCHACHA20_POLY1305 Алгоритм XChaCha20-Poly1305

CartData

Данные корзины, связанные с событием.

Поля
merchant_id

string

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

merchant_feed_label

string

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

merchant_feed_language_code

string

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

transaction_discount

double

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

items[]

Item

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

Настройки согласия пользователя в соответствии с Законом о цифровых рынках (DMA) .

Поля
ad_user_data

ConsentStatus

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

ad_personalization

ConsentStatus

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

Статус согласия

Указывает, дал ли пользователь согласие, отклонил его или не указал явно.

Перечисления
CONSENT_STATUS_UNSPECIFIED Не указан.
CONSENT_GRANTED Предоставленный.
CONSENT_DENIED Отклонен.

Пользовательская переменная

Пользовательская переменная для конверсий в рекламе.

Поля
variable

string

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

value

string

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

destination_references[]

string

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

Тип клиента

Тип клиента, участвующего в мероприятии.

Перечисления
CUSTOMER_TYPE_UNSPECIFIED Тип клиента не указан. Использовать его не следует.
NEW Клиент впервые обращается к рекламодателю.
RETURNING Клиент возвращается к рекламодателю.
REENGAGED Клиент возобновил взаимодействие с рекламодателем.

CustomerValueBucket

Оценочная стоимость клиента, определяемая рекламодателем.

Перечисления
CUSTOMER_VALUE_BUCKET_UNSPECIFIED Неуказанный CustomerValueBucket. Использовать его не следует.
LOW Клиент имеет низкую ценность.
MEDIUM Клиент относится к категории средней ценности.
HIGH Клиент имеет высокую ценность.

Место назначения

Продукт Google, в который вы отправляете данные. Например, аккаунт Google Ads.

Поля
reference

string

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

login_account

ProductAccount

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

linked_account

ProductAccount

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

operating_account

ProductAccount

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

product_destination_id

string

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

Информация об устройстве

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

Поля
user_agent

string

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

ip_address

string

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

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

Кодирование

Тип кодирования хешированной идентификационной информации.

Перечисления
ENCODING_UNSPECIFIED Тип кодировки не указан. Использовать его не следует.
HEX Шестнадцатеричное кодирование.
BASE64 Кодирование Base64.

EncryptionInfo

Информация для шифрования обрабатываемых данных.

Поля
Поле объединения wrapped_key . Зашифрованный ключ, используемый для шифрования данных. wrapped_key может принимать только одно из следующих значений:
gcp_wrapped_key_info

GcpWrappedKeyInfo

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

aws_wrapped_key_info

AwsWrappedKeyInfo

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

ErrorCount

Количество ошибок по указанной причине.

Поля
record_count

int64

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

reason

ProcessingErrorReason

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

ErrorInfo

Для каждого типа ошибок подсчитывается количество ошибок.

Поля
error_counts[]

ErrorCount

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

Причина ошибки

Причины ошибок при использовании API менеджера данных.

Перечисления
ERROR_REASON_UNSPECIFIED Не используйте это значение по умолчанию.
INTERNAL_ERROR Произошла внутренняя ошибка.
DEADLINE_EXCEEDED На обработку запроса потребовалось слишком много времени.
RESOURCE_EXHAUSTED Слишком много запросов.
NOT_FOUND Ресурс не найден.
PERMISSION_DENIED У пользователя нет необходимых прав или ресурс не найден.
INVALID_ARGUMENT Возникла проблема с запросом.
REQUIRED_FIELD_MISSING Отсутствует обязательное поле.
INVALID_FORMAT Неверный формат.
INVALID_HEX_ENCODING Значение в шестнадцатеричном формате некорректно.
INVALID_BASE64_ENCODING Закодированное в base64 значение имеет некорректный формат.
INVALID_SHA256_FORMAT Закодированное значение SHA256 имеет некорректный формат.
INVALID_POSTAL_CODE Почтовый индекс недействителен.
INVALID_COUNTRY_CODE Код страны недействителен.
INVALID_ENUM_VALUE Значение перечисления использовать нельзя.
INVALID_USER_LIST_TYPE Тип списка пользователей не имеет значения для данного запроса.
INVALID_AUDIENCE_MEMBER Данный зритель недействителен.
TOO_MANY_AUDIENCE_MEMBERS Максимальное количество зрителей, допускаемых по одному запросу, составляет 10 000 человек.
TOO_MANY_USER_IDENTIFIERS Максимальное количество идентификаторов пользователей, разрешенных для одного участника аудитории, составляет 10.
TOO_MANY_DESTINATIONS Максимальное количество пунктов назначения, разрешенных для одного запроса, составляет 10.
INVALID_DESTINATION Этот пункт назначения недействителен.
DATA_PARTNER_USER_LIST_MUTATE_NOT_ALLOWED У партнера по данным нет доступа к списку пользователей, принадлежащих операционной учетной записи.
INVALID_MOBILE_ID_FORMAT Формат мобильного идентификатора недействителен.
INVALID_USER_LIST_ID Список пользователей недействителен.
MULTIPLE_DATA_TYPES_NOT_ALLOWED В одном запросе не допускается обработка данных нескольких типов.
DIFFERENT_LOGIN_ACCOUNTS_NOT_ALLOWED_FOR_DATA_PARTNER В конфигурациях назначения, содержащих учетную запись для входа в DataPartner, эта учетная запись должна быть одинаковой во всех конфигурациях назначения.
TERMS_AND_CONDITIONS_NOT_SIGNED Обязательные условия не принимаются.
INVALID_NUMBER_FORMAT Неверный формат числа.
INVALID_CONVERSION_ACTION_ID Идентификатор действия конверсии недействителен.
INVALID_CONVERSION_ACTION_TYPE Тип действия преобразования недопустим.
INVALID_CURRENCY_CODE Код валюты не поддерживается.
INVALID_EVENT Данное мероприятие недействительно.
TOO_MANY_EVENTS Максимальное количество событий, разрешенных для одного запроса, составляет 10 000.
DESTINATION_ACCOUNT_NOT_ENABLED_ENHANCED_CONVERSIONS_FOR_LEADS Для целевого аккаунта не активирована функция повышения конверсии лидов.
DESTINATION_ACCOUNT_DATA_POLICY_PROHIBITS_ENHANCED_CONVERSIONS Использование расширенных показателей конверсии для целевого аккаунта невозможно из-за политики Google в отношении данных клиентов. Обратитесь к представителю Google.
DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED Целевой аккаунт не согласился с условиями повышения конверсии.
DUPLICATE_DESTINATION_REFERENCE В запросе два или более пункта назначения имеют одинаковую ссылку.
UNSUPPORTED_OPERATING_ACCOUNT_FOR_DATA_PARTNER Неподдерживаемый операционный аккаунт для авторизации партнеров по передаче данных.
UNSUPPORTED_LINKED_ACCOUNT_FOR_DATA_PARTNER Неподдерживаемая связанная учетная запись для авторизации партнеров по данным.
NO_IDENTIFIERS_PROVIDED Данные о событиях не содержат идентификаторов пользователей или рекламных идентификаторов.
INVALID_PROPERTY_TYPE Данный тип свойства не поддерживается.
INVALID_STREAM_TYPE Тип потока не поддерживается.
LINKED_ACCOUNT_ONLY_ALLOWED_WITH_DATA_PARTNER_LOGIN_ACCOUNT Связанная учетная запись поддерживается только в том случае, если учетная запись для входа является учетной записью DATA_PARTNER .
OPERATING_ACCOUNT_LOGIN_ACCOUNT_MISMATCH Для данного сценария использования учетная запись для входа в систему должна совпадать с операционной учетной записью.
EVENT_TIME_INVALID Событие не произошло в допустимые сроки.
RESERVED_NAME_USED Параметр использует зарезервированное имя.
INVALID_EVENT_NAME Название события не поддерживается.
NOT_ALLOWLISTED Данная учетная запись не включена в список разрешенных для использования указанной функции.
INVALID_REQUEST_ID Идентификатор запроса, используемый для получения статуса запроса, недействителен. Статус можно получить только для запросов, которые успешно выполнены и не имеют validate_only=true .
MULTIPLE_DESTINATIONS_FOR_GOOGLE_ANALYTICS_EVENT В рамках мероприятия использовалось 2 или более точек доступа Google Analytics.
FIELD_VALUE_TOO_LONG Значение поля слишком длинное.
TOO_MANY_ELEMENTS В запросе слишком много элементов в списке.

Событие

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

Поля
destination_references[]

string

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

transaction_id

string

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

event_timestamp

Timestamp

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

last_updated_timestamp

Timestamp

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

user_data

UserData

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

consent

Consent

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

ad_identifiers

AdIdentifiers

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

currency

string

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

conversion_value

double

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

event_source

EventSource

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

event_device_info

DeviceInfo

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

cart_data

CartData

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

custom_variables[]

CustomVariable

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

experimental_fields[]

ExperimentalField

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

user_properties

UserProperties

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

event_name

string

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

client_id

string

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

user_id

string

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

additional_event_parameters[]

EventParameter

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

EventParameter

Параметр события для событий GA4.

Поля
parameter_name

string

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

value

string

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

EventSource

Источник события.

Перечисления
EVENT_SOURCE_UNSPECIFIED Неуказанный EventSource. Использовать его не следует.
WEB Событие было сгенерировано из веб-браузера.
APP Событие было сгенерировано с помощью приложения.
IN_STORE Событие было инициировано транзакцией в магазине.
PHONE Идея мероприятия возникла после телефонного звонка.
OTHER Информация о мероприятии была получена из других источников.

Экспериментальная область

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

Поля
field

string

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

value

string

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

GcpWrappedKeyInfo

Информация о зашифрованном ключе Google Cloud Platform.

Поля
key_type

KeyType

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

wip_provider

string

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

kek_uri

string

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

encrypted_dek

string

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

KeyType

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

Перечисления
KEY_TYPE_UNSPECIFIED Тип ключа не указан. Использовать его не следует.
XCHACHA20_POLY1305 Алгоритм XChaCha20-Poly1305

IngestAudienceMembersRequest

Запрос на загрузку данных об участниках аудитории в указанные места назначения. Возвращает объект IngestAudienceMembersResponse .

Вы можете попробовать этот метод в обозревателе REST API:
Попробуйте с REST.
Поля
destinations[]

Destination

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

audience_members[]

AudienceMember

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

consent

Consent

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

validate_only

bool

Необязательно. Используется в целях тестирования. Если true , запрос проверяется, но не выполняется. Возвращаются только ошибки, а не результаты.

encoding

Encoding

Необязательно. Обязательно для загрузки UserData . Тип кодирования идентификаторов пользователей. Для хешированных идентификаторов пользователей это тип кодирования хешированной строки. Для зашифрованных хешированных идентификаторов пользователей это тип кодирования внешней зашифрованной строки, но не обязательно внутренней хешированной строки, то есть внутренняя хешированная строка может быть закодирована иначе, чем внешняя зашифрованная строка. Для загрузки данных, не относящихся UserData , это поле игнорируется.

encryption_info

EncryptionInfo

Необязательно. Информация о шифровании для загружаемых UserData . Если не указано, предполагается, что загружаемая идентификационная информация хешируется, но не шифруется. Для загружаемых данных, не относящихся UserData , это поле игнорируется.

terms_of_service

TermsOfService

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

IngestAudienceMembersResponse

Ответ на запрос IngestAudienceMembersRequest .

Поля
request_id

string

Автоматически сгенерированный идентификатор запроса.

IngestEventsRequest

Запрос на загрузку данных об участниках аудитории в указанные места назначения. Возвращает объект IngestEventsResponse .

Вы можете попробовать этот метод в обозревателе REST API:
Попробуйте с REST.
Поля
destinations[]

Destination

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

events[]

Event

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

consent

Consent

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

validate_only

bool

Необязательно. Используется в целях тестирования. Если true , запрос проверяется, но не выполняется. Возвращаются только ошибки, а не результаты.

encoding

Encoding

Необязательно. Обязательно для загрузки UserData . Тип кодирования идентификаторов пользователей. Для хешированных идентификаторов пользователей это тип кодирования хешированной строки. Для зашифрованных хешированных идентификаторов пользователей это тип кодирования внешней зашифрованной строки, но не обязательно внутренней хешированной строки, то есть внутренняя хешированная строка может быть закодирована иначе, чем внешняя зашифрованная строка. Для загрузки данных, не относящихся UserData , это поле игнорируется.

encryption_info

EncryptionInfo

Необязательно. Информация о шифровании для загружаемых UserData . Если не указано, предполагается, что загружаемая идентификационная информация хешируется, но не шифруется. Для загружаемых данных, не относящихся UserData , это поле игнорируется.

IngestEventsResponse

Ответ от IngestEventsRequest .

Поля
request_id

string

Автоматически сгенерированный идентификатор запроса.

Элемент

Представляет собой товар в корзине, связанный с событием.

Поля
merchant_product_id

string

Необязательно. Идентификатор продукта в учетной записи Merchant Center.

quantity

int64

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

unit_price

double

Дополнительно. Цена за единицу товара указана без учета налогов, доставки и любых скидок за транзакцию.

item_id

string

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

additional_item_parameters[]

ItemParameter

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

ItemParameter

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

Поля
parameter_name

string

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

value

string

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

Диапазон коэффициентов соответствия

Диапазон вероятности совпадения для загружаемых файлов или списка пользователей.

Перечисления
MATCH_RATE_RANGE_UNKNOWN Диапазон вероятности совпадения неизвестен.
MATCH_RATE_RANGE_NOT_ELIGIBLE Диапазон коэффициентов соответствия не подходит.
MATCH_RATE_RANGE_LESS_THAN_20 Диапазон вероятности совпадения составляет менее 20% (в интервале [0, 20) ).
MATCH_RATE_RANGE_20_TO_30 Диапазон вероятности совпадения составляет от 20% до 30% (в интервале [20, 31) ).
MATCH_RATE_RANGE_31_TO_40 Диапазон процента совпадений составляет от 31% до 40% (в интервале [31, 41) ).
MATCH_RATE_RANGE_41_TO_50 Диапазон процента совпадений составляет от 41% до 50% (в интервале [41, 51) ).
MATCH_RATE_RANGE_51_TO_60 Диапазон процента совпадений составляет от 51% до 60% (в интервале [51, 61) .
MATCH_RATE_RANGE_61_TO_70 Диапазон процента совпадений составляет от 61% до 70% (в интервале [61, 71) ).
MATCH_RATE_RANGE_71_TO_80 Диапазон процента совпадений составляет от 71% до 80% (в интервале [71, 81) ).
MATCH_RATE_RANGE_81_TO_90 Диапазон процента совпадений составляет от 81% до 90% (в интервале [81, 91) ).
MATCH_RATE_RANGE_91_TO_100

Диапазон вероятности совпадения составляет от 91% до 100% (в интервале [91, 100] ).

Мобильные данные

Идентификаторы мобильных телефонов для аудитории. Требуется как минимум один идентификатор мобильного телефона.

Поля
mobile_ids[]

string

Обязательно. Список идентификаторов мобильных устройств (идентификатор рекламы/IDFA). В одном объекте AudienceMember можно указать не более 10 mobileIds .

Парные данные

Идентификаторы пар (PAIR ID) для аудитории. Требуется как минимум один идентификатор пары.

Поля
pair_ids[]

string

Обязательно. Персональные данные, предоставленные в чистой комнате, хешированные с помощью SHA256 и зашифрованные коммутативным шифром EC с использованием ключа издателя для списка пользователей PAIR . В одном объекте AudienceMember может быть указано не более 10 pairIds .

ProcessingErrorReason

Причина ошибки обработки.

Перечисления
PROCESSING_ERROR_REASON_UNSPECIFIED Причина ошибки обработки неизвестна.
PROCESSING_ERROR_REASON_INVALID_CUSTOM_VARIABLE Пользовательская переменная недействительна.
PROCESSING_ERROR_REASON_CUSTOM_VARIABLE_NOT_ENABLED Статус пользовательской переменной — неактивен.
PROCESSING_ERROR_REASON_EVENT_TOO_OLD Возраст преобразованного файла превышает максимально допустимый возраст.
PROCESSING_ERROR_REASON_DUPLICATE_GCLID В системе уже существует преобразование с тем же GCLID и временем преобразования.
PROCESSING_ERROR_REASON_DUPLICATE_TRANSACTION_ID Конверсия с тем же идентификатором заказа и комбинацией действия конверсии уже была загружена.
PROCESSING_ERROR_REASON_INVALID_GBRAID Расшифровать gbraid не удалось.
PROCESSING_ERROR_REASON_INVALID_GCLID Не удалось расшифровать идентификатор клика Google.
PROCESSING_ERROR_REASON_INVALID_MERCHANT_ID Идентификатор продавца содержит символы, не являющиеся цифрами.
PROCESSING_ERROR_REASON_INVALID_WBRAID Расшифровать wbraid не удалось.
PROCESSING_ERROR_REASON_INTERNAL_ERROR Внутренняя ошибка.
PROCESSING_ERROR_REASON_DESTINATION_ACCOUNT_ENHANCED_CONVERSIONS_TERMS_NOT_SIGNED Условия расширенных конверсий не подписываются в целевом аккаунте.
PROCESSING_ERROR_REASON_INVALID_EVENT Событие недействительно.
PROCESSING_ERROR_REASON_INSUFFICIENT_MATCHED_TRANSACTIONS Количество совпадающих транзакций меньше минимального порогового значения.
PROCESSING_ERROR_REASON_INSUFFICIENT_TRANSACTIONS Количество транзакций ниже минимального порога.
PROCESSING_ERROR_REASON_INVALID_FORMAT В событии обнаружена ошибка форматирования.
PROCESSING_ERROR_REASON_DECRYPTION_ERROR В событии обнаружена ошибка расшифровки.
PROCESSING_ERROR_REASON_DEK_DECRYPTION_ERROR Расшифровка DEK не удалась.
PROCESSING_ERROR_REASON_INVALID_WIP Документ в процессе работы отформатирован неправильно или отсутствует.
PROCESSING_ERROR_REASON_INVALID_KEK KEK не может расшифровать данные, потому что это неправильный KEK или он не существует.
PROCESSING_ERROR_REASON_WIP_AUTH_FAILED Документ WIP не мог быть использован, поскольку он был отклонен из-за условия подтверждения.
PROCESSING_ERROR_REASON_KEK_PERMISSION_DENIED Система не обладала необходимыми правами доступа для доступа к KEK.
PROCESSING_ERROR_REASON_AWS_AUTH_FAILED Система не прошла аутентификацию в AWS.
PROCESSING_ERROR_REASON_USER_IDENTIFIER_DECRYPTION_ERROR Не удалось расшифровать данные UserIdentifier с помощью DEK.
PROCESSING_ERROR_OPERATING_ACCOUNT_MISMATCH_FOR_AD_IDENTIFIER Пользователь попытался получить события с идентификатором объявления, который не относится к объявлениям в учетной записи пользователя.

ProcessingWarningReason

Причина предупреждения, связанного с обработкой.

Перечисления
PROCESSING_WARNING_REASON_UNSPECIFIED Причина предупреждения об обработке неизвестна.
PROCESSING_WARNING_REASON_KEK_PERMISSION_DENIED Система не обладала необходимыми правами доступа для доступа к KEK.
PROCESSING_WARNING_REASON_DEK_DECRYPTION_ERROR Расшифровка DEK не удалась.
PROCESSING_WARNING_REASON_DECRYPTION_ERROR В событии обнаружена ошибка расшифровки.
PROCESSING_WARNING_REASON_WIP_AUTH_FAILED Документ WIP не мог быть использован, поскольку он был отклонен из-за условия подтверждения.
PROCESSING_WARNING_REASON_INVALID_WIP Документ в процессе работы отформатирован неправильно или отсутствует.
PROCESSING_WARNING_REASON_INVALID_KEK KEK не может расшифровать данные, потому что это неправильный KEK или он не существует.
PROCESSING_WARNING_REASON_USER_IDENTIFIER_DECRYPTION_ERROR Не удалось расшифровать данные UserIdentifier с помощью DEK.
PROCESSING_WARNING_REASON_INTERNAL_ERROR Внутренняя ошибка.
PROCESSING_WARNING_REASON_AWS_AUTH_FAILED Система не прошла аутентификацию в AWS.

Продукт

Устарело. Используйте AccountType вместо него. Представляет конкретный продукт Google.

Перечисления
PRODUCT_UNSPECIFIED Неуказанный продукт. Использовать ни в коем случае.
GOOGLE_ADS Реклама Google.
DISPLAY_VIDEO_PARTNER Партнер Display & Video 360.
DISPLAY_VIDEO_ADVERTISER Рекламодатель, использующий 360-градусную рекламу в формате Display & Video.
DATA_PARTNER Партнер по данным.

ProductAccount

Представляет собой конкретный счет.

Поля
product
(deprecated)

Product

Устарело. Используйте account_type вместо него.

account_id

string

Обязательно. Идентификатор аккаунта. Например, идентификатор вашего аккаунта Google Ads.

account_type

AccountType

Необязательный параметр. Тип учетной записи. Например, GOOGLE_ADS . Обязательным является либо account_type , либо устаревший product . Если указаны оба параметра, значения должны совпадать.

Тип учетной записи

Обозначает типы учетных записей Google. Используется для определения учетных записей и мест назначения.

Перечисления
ACCOUNT_TYPE_UNSPECIFIED Неуказанный продукт. Использовать ни в коем случае.
GOOGLE_ADS Реклама Google.
DISPLAY_VIDEO_PARTNER Партнер Display & Video 360.
DISPLAY_VIDEO_ADVERTISER Рекламодатель, использующий 360-градусную рекламу в формате Display & Video.
DATA_PARTNER Партнер по данным.
GOOGLE_ANALYTICS_PROPERTY Google Analytics.

RemoveAudienceMembersRequest

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

Вы можете попробовать этот метод в обозревателе REST API:
Попробуйте с REST.
Поля
destinations[]

Destination

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

audience_members[]

AudienceMember

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

validate_only

bool

Необязательно. Используется в целях тестирования. Если true , запрос проверяется, но не выполняется. Возвращаются только ошибки, а не результаты.

encoding

Encoding

Необязательно. Обязательно для загрузки UserData . Тип кодировки идентификаторов пользователей. Применяется только к внешней кодировке для зашифрованных идентификаторов пользователей. Для загрузок, не относящихся UserData , это поле игнорируется.

encryption_info

EncryptionInfo

Необязательно. Информация о шифровании для загружаемых UserData . Если не указано, предполагается, что загружаемая идентификационная информация хешируется, но не шифруется. Для загружаемых данных, не относящихся UserData , это поле игнорируется.

RemoveAudienceMembersResponse

Ответ на запрос RemoveAudienceMembersRequest .

Поля
request_id

string

Автоматически сгенерированный идентификатор запроса.

RequestStatusPerDestination

Статус запроса для каждого пункта назначения.

Поля
destination

Destination

Пункт назначения в запросе к API DM.

request_status

RequestStatus

Статус запроса к месту назначения.

error_info

ErrorInfo

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

warning_info

WarningInfo

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

status поля объединения. Статус пункта назначения. status может принимать только одно из следующих значений:
audience_members_ingestion_status

IngestAudienceMembersStatus

Статус запроса на обработку данных от участников аудитории.

events_ingestion_status

IngestEventsStatus

Статус запроса на прием событий.

audience_members_removal_status

RemoveAudienceMembersStatus

Статус запроса на удаление участников аудитории.

IngestAudienceMembersStatus

Статус запроса на обработку данных от участников аудитории.

Поля
status поля объединения. Статус приема данных от участников аудитории в пункт назначения. status может принимать только одно из следующих значений:
user_data_ingestion_status

IngestUserDataStatus

Состояние загрузки пользовательских данных в пункт назначения.

mobile_data_ingestion_status

IngestMobileDataStatus

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

pair_data_ingestion_status

IngestPairDataStatus

Статус передачи данных пары в пункт назначения.

IngestEventsStatus

Статус событий, поступающих в пункт назначения.

Поля
record_count

int64

Общее количество событий, отправленных в запросе на загрузку. Включает все события в запросе, независимо от того, были ли они успешно обработаны или нет.

IngestMobileDataStatus

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

Поля
record_count

int64

Общее количество участников аудитории, указанных в запросе на загрузку для целевого объекта. Включает всех участников аудитории в запросе, независимо от того, были ли они успешно загружены или нет.

mobile_id_count

int64

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

IngestPairDataStatus

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

Поля
record_count

int64

Общее количество участников аудитории, указанных в запросе на загрузку для целевого объекта. Включает всех участников аудитории в запросе, независимо от того, были ли они успешно загружены или нет.

pair_id_count

int64

Общее количество идентификаторов пар, отправленных в запросе на загрузку для целевого объекта. Включает все идентификаторы пар в запросе, независимо от того, были ли они успешно загружены или нет.

IngestUserDataStatus

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

Поля
record_count

int64

Общее количество участников аудитории, указанных в запросе на загрузку для целевого объекта. Включает всех участников аудитории в запросе, независимо от того, были ли они успешно загружены или нет.

user_identifier_count

int64

Общее количество идентификаторов пользователей, отправленных в запросе на загрузку для целевого объекта. Включает все идентификаторы пользователей в запросе, независимо от того, были ли они успешно обработаны или нет.

upload_match_rate_range

MatchRateRange

Диапазон вероятности совпадения загружаемых файлов.

RemoveAudienceMembersStatus

Статус запроса на удаление участников аудитории.

Поля
status поля объединения. Статус удаления участников аудитории из места назначения. status может принимать только одно из следующих значений:
user_data_removal_status

RemoveUserDataStatus

Статус удаления пользовательских данных из целевого хранилища.

mobile_data_removal_status

RemoveMobileDataStatus

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

pair_data_removal_status

RemovePairDataStatus

Статус удаления данных пары из места назначения.

RemoveMobileDataStatus

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

Поля
record_count

int64

Общее количество участников аудитории, указанных в запросе на удаление. Включает всех участников аудитории, независимо от того, было ли их удаление успешным или нет.

mobile_id_count

int64

Общее количество идентификаторов мобильных устройств, отправленных в запросе на удаление. Включает все идентификаторы мобильных устройств в запросе, независимо от того, были ли они успешно удалены или нет.

RemovePairDataStatus

Статус удаления данных пары из места назначения.

Поля
record_count

int64

Общее количество участников аудитории, указанных в запросе на удаление. Включает всех участников аудитории, независимо от того, было ли их удаление успешным или нет.

pair_id_count

int64

Общее количество идентификаторов пар, отправленных в запросе на удаление. Включает все идентификаторы пар в запросе, независимо от того, были ли они успешно удалены или нет.

RemoveUserDataStatus

Статус удаления пользовательских данных из целевого хранилища.

Поля
record_count

int64

Общее количество участников аудитории, указанных в запросе на удаление. Включает всех участников аудитории, независимо от того, было ли их удаление успешным или нет.

user_identifier_count

int64

Общее количество идентификаторов пользователей, отправленных в запросе на удаление. Включает все идентификаторы пользователей в запросе, независимо от того, были ли они успешно удалены или нет.

RequestStatus

Статус запроса.

Перечисления
REQUEST_STATUS_UNKNOWN Статус запроса неизвестен.
SUCCESS Запрос был успешно выполнен.
PROCESSING Запрос обрабатывается.
FAILED Запрос не выполнен.
PARTIAL_SUCCESS Запрос был частично удовлетворен.

RetrieveRequestStatusRequest

Запрос на получение статуса запроса к API DM для заданного идентификатора запроса. Возвращает объект RetrieveRequestStatusResponse .

Вы можете попробовать этот метод в обозревателе REST API:
Попробуйте с REST.
Поля
request_id

string

Обязательно. Обязательно. Идентификатор запроса API менеджера данных.

RetrieveRequestStatusResponse

Ответ от RetrieveRequestStatusRequest .

Поля
request_status_per_destination[]

RequestStatusPerDestination

Список статусов запросов по каждому пункту назначения. Порядок статусов соответствует порядку пунктов назначения в исходном запросе.

Условия предоставления услуг

Условия предоставления услуг, которые пользователь принял/отклонил.

Поля
customer_match_terms_of_service_status

TermsOfServiceStatus

Необязательно. Условия предоставления услуг Customer Match: https://support.google.com/adspolicy/answer/6299717 . Их необходимо принять при загрузке UserData или MobileData . Это поле не обязательно для списка пользователей Partner Match.

Условия предоставления услуг

Отражает решение звонящего принять или отклонить условия предоставления услуг.

Перечисления
TERMS_OF_SERVICE_STATUS_UNSPECIFIED Не указан.
ACCEPTED Статус, указывающий на то, что звонящий принял условия предоставления услуг.
REJECTED Статус указывает на то, что звонящий отклонил условия предоставления услуг.

Пользовательские данные

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

Поля
user_identifiers[]

UserIdentifier

Обязательно. Идентификаторы пользователя. Можно указать несколько экземпляров данных одного типа (например, несколько адресов электронной почты). Чтобы повысить вероятность совпадения, укажите как можно больше идентификаторов. В одном объекте AudienceMember или Event можно указать не более 10 userIdentifiers .

Идентификатор пользователя

Единый идентификатор пользователя.

Поля
identifier поля объединения. Необходимо указать ровно один такой идентификатор. identifier может принимать только одно из следующих значений:
email_address

string

Хэшированный адрес электронной почты, полученный с помощью хэш-функции SHA-256 после нормализации.

phone_number

string

Хэшированный номер телефона, полученный с помощью хэш-функции SHA-256 после нормализации (стандарт E164).

address

AddressInfo

Известные компоненты адреса пользователя. Содержит группу идентификаторов, которые совпадают все одновременно.

Пользовательские свойства

Информация о пользователе, полученная рекламодателем на момент события. Дополнительные сведения см. на странице https://support.google.com/google-ads/answer/14007601 .

Поля
customer_type

CustomerType

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

customer_value_bucket

CustomerValueBucket

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

additional_user_properties[]

UserProperty

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

Пользовательское свойство

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

Поля
property_name

string

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

value

string

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

WarningCount

Количество предупреждений по данной причине.

Поля
record_count

int64

Количество записей, содержащих предупреждение.

reason

ProcessingWarningReason

Причина предупреждения.

WarningInfo

Предупреждение учитывается для каждого типа предупреждения.

Поля
warning_counts[]

WarningCount

Список предупреждений и количество предупреждений по каждой причине.