Package google.ads.datamanager.v1

Индекс

IngestionService

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

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
Удалить участников аудитории

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, начиная с iOS14.

wbraid

string

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

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

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

encrypted_dek

string

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

KeyType

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

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

CartData

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

Поля
merchant_id

string

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

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

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

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 Рекламы, идентификатор аудитории Дисплея и Видео 360 или идентификатор действия-конверсии Google Рекламы.

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

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

Поля
user_agent

string

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

ip_address

string

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

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

Кодирование

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

Перечисления
ENCODING_UNSPECIFIED Неуказанный тип кодировки. Никогда не следует использовать.
HEX Шестнадцатеричное кодирование.
BASE64 Кодировка Base 64.

Информация о шифровании

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

Поля
Поле объединения 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 У Data Partner нет доступа к списку пользователей, принадлежащих операционному счету.
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

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

ПараметрСобытия

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

Поля
parameter_name

string

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

value

string

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

EventSource

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

Перечисления
EVENT_SOURCE_UNSPECIFIED Не указан источник события. Никогда не следует использовать.
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}».

encrypted_dek

string

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

KeyType

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

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

IngestAudienceMembersRequest

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

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

Destination

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

audience_members[]

AudienceMember

Обязательно. Список пользователей для отправки по указанным адресам. В одном запросе можно отправить не более 10 000 ресурсов 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

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

Параметр элемента

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

Поля
parameter_name

string

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

value

string

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

MatchRateRange

Диапазон коэффициентов соответствия загрузки или списка пользователей.

Перечисления
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] ).

MobileData

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

Поля
mobile_ids[]

string

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

PairData

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

Поля
pair_ids[]

string

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

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

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

Перечисления
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 Неправильно отформатирован WIP или не существует.
PROCESSING_ERROR_REASON_INVALID_KEK KEK не может расшифровать данные, потому что это неправильный KEK или он не существует.
PROCESSING_ERROR_REASON_WIP_AUTH_FAILED Незавершенный проект не мог быть использован, поскольку он был отклонен по условию аттестации.
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 Пользователь попытался загрузить события с идентификатором рекламы, который не относится к рекламе действующего аккаунта.

ОбработкаПредупрежденияПричина

Причина предупреждения об обработке.

Перечисления
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 Незавершенный проект не мог быть использован, поскольку он был отклонен по условию аттестации.
PROCESSING_WARNING_REASON_INVALID_WIP Неправильно отформатирован 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 Рекламодатель Display & Video 360.
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 Рекламодатель Display & Video 360.
DATA_PARTNER Партнер по данным.
GOOGLE_ANALYTICS_PROPERTY Google Аналитика.

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

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

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

Destination

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

audience_members[]

AudienceMember

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

validate_only

bool

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

encoding

Encoding

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

encryption_info

EncryptionInfo

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

УдалитьОтветАудиторииУчастников

Ответ на 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

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

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

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

Поля
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

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

UserProperty

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

Поля
property_name

string

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

value

string

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

WarningCount

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

Поля
record_count

int64

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

reason

ProcessingWarningReason

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

ПредупреждениеИнформация

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

Поля
warning_counts[]

WarningCount

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