Package google.ads.datamanager.v1

Индекс

IngestionService (интерфейс)
AdIdentifiers (сообщение)
AddressInfo (сообщение)
AudienceMember (сообщение)
CartData (сообщение)
Consent (сообщение)
ConsentStatus (перечисление)
CustomVariable (сообщение)
Destination (сообщение)
DeviceInfo (сообщение)
Encoding (перечисление)
EncryptionInfo (сообщение)
Event (сообщение)
EventSource (перечисление)
ExperimentalField (сообщение)
GcpWrappedKeyInfo (сообщение)
GcpWrappedKeyInfo.KeyType (перечисление)
IngestAudienceMembersRequest (сообщение)
IngestAudienceMembersResponse (сообщение)
IngestEventsRequest (сообщение)
IngestEventsResponse (сообщение)
Item (сообщение)
MobileData (сообщение)
PairData (сообщение)
Product (перечисление)
ProductAccount (сообщение)
RemoveAudienceMembersRequest (сообщение)
RemoveAudienceMembersResponse (сообщение)
TermsOfService (сообщение)
TermsOfServiceStatus (перечисление)
UserData (сообщение)
UserIdentifier (сообщение)

IngestionService

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

IngestAudienceMembers

IngestAudienceMembers
`rpc IngestAudienceMembers( IngestAudienceMembersRequest ) returns ( IngestAudienceMembersResponse )` Загружает список ресурсов `AudienceMember` в указанное `Destination` . Области действия авторизации Требуется следующая область действия OAuth: `https://www.googleapis.com/auth/datamanager`

rpc IngestAudienceMembers( IngestAudienceMembersRequest ) returns ( IngestAudienceMembersResponse )

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

Области действия авторизации

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

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

IngestEvents

IngestEvents
`rpc IngestEvents( IngestEventsRequest ) returns ( IngestEventsResponse )` Загружает список ресурсов `Event` из указанного `Destination` . Области действия авторизации Требуется следующая область действия OAuth: `https://www.googleapis.com/auth/datamanager`

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`

rpc RemoveAudienceMembers( RemoveAudienceMembersRequest ) returns ( RemoveAudienceMembersResponse )

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

Области действия авторизации

Требуется следующая область действия 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` Обязательно. Почтовый индекс адреса пользователя.

АудиторияЧлен

Зритель, которому предстоит операция.

Поля
`consent`	`Consent` Необязательно. Настройка согласия для пользователя.
`data` поля объединения. Тип идентифицирующих данных, над которыми необходимо работать. `data` могут быть только одним из следующих:
`user_data`	`UserData` Предоставленные пользователем данные, идентифицирующие пользователя.
`pair_data`	`PairData` Идентификаторы сверки личности издателя и рекламодателя (PAIR) .
`mobile_data`	`MobileData` Данные, идентифицирующие мобильные устройства пользователя.

Данные о корзине

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

Поля
`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` Необязательно. Список элементов, связанных с событием.

Поля

Поля
`ad_user_data`	`ConsentStatus` Необязательно. Показывает, дает ли пользователь согласие на рекламу данных пользователя.
`ad_personalization`	`ConsentStatus` Необязательно. Показывает, соглашается ли пользователь на персонализацию рекламы.

ad_user_data

ConsentStatus

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

ad_personalization

ConsentStatus

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

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

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

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

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

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

Поля

Поля
`variable`	`string` Необязательно. Имя пользовательской переменной для установки. Если переменная не найдена для указанного назначения, она будет проигнорирована.
`value`	`string` Необязательно. Значение для сохранения пользовательской переменной.

variable

string

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

value

string

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

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

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

Поля
`reference`	`string` Необязательно. Идентификатор для этого ресурса `Destination` , уникальный в пределах запроса. Используйте для ссылки на это `Destination` в `IngestEventsRequest` .
`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.

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

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

Поля

Поля
`user_agent`	`string` Необязательно. Строка пользовательского агента устройства для данного контекста.
`ip_address`	`string` Необязательно. IP-адрес устройства для данного контекста.

user_agent

string

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

ip_address

string

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

Кодирование

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

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

ШифрованиеИнформация

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

Поля

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

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

gcp_wrapped_key_info

GcpWrappedKeyInfo

Google Cloud Platform обернула ключевую информацию.

Событие

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

Поля
`destination_references[]`	`string` Необязательно. Справочная строка, используемая для определения пункта назначения.
`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.

EventSource

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

Перечисления
`EVENT_SOURCE_UNSPECIFIED`	Неуказанный EventSource. Никогда не следует использовать.
`WEB`	Событие было сгенерировано из веб-браузера.

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

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

Поля

Поля
`field`	`string` Необязательно. Имя поля для использования.
`value`	`string` Необязательно. Значение поля для установки.

field

string

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

value

string

Необязательно. Значение поля для установки.

GcpWrappedKeyInfo

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

Поля
`key_type`	`KeyType` Обязательно. Тип алгоритма, используемого для шифрования данных.
`wip_provider`	`string` Обязательно. Для использования KEK требуется поставщик пула удостоверений рабочей нагрузки .
`kek_uri`	`string` Обязательно. Идентификатор ресурса службы управления облачными ключами Google Cloud Platform.
`encrypted_dek`	`string` Обязательно. Ключ шифрования зашифрованных данных в кодировке base64.

Тип ключа

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

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

IngestAudienceMembersRequest

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

Поля
`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` Необязательно. Условия обслуживания, которые пользователь принял/отклонил.

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

Ответ от IngestAudienceMembersRequest .

Поля

Поля
`request_id`	`string` Автоматически сгенерированный идентификатор запроса.

request_id

string

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

IngestEventsRequest

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

Поля
`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` Автоматически сгенерированный идентификатор запроса.

request_id

string

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

Элемент

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

Поля

Поля
`merchant_product_id`	`string` Необязательно. Идентификатор продукта в учетной записи Merchant Center.
`quantity`	`int64` Необязательно. Номер этого элемента, связанного с событием.
`unit_price`	`double` Необязательно. Цена за единицу товара без учета налогов, доставки и любых скидок на уровне транзакции.

merchant_product_id

string

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

quantity

int64

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

unit_price

double

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

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

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

Поля

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

mobile_ids[]

string

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

ПараДанные

PAIR ID для аудитории. Требуется как минимум один PAIR ID.

Поля

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

pair_ids[]

string

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

Продукт

Представляет определенный продукт Google. Используется для поиска учетных записей и пунктов назначения.

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

ProductAccount

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

Поля

Поля
`product`	`Product` Обязательно. Продукт, к которому принадлежит аккаунт. Например, `GOOGLE_ADS` .
`account_id`	`string` Обязательно. Идентификатор аккаунта. Например, идентификатор вашего аккаунта Google Ads.

product

Product

Обязательно. Продукт, к которому принадлежит аккаунт. Например, GOOGLE_ADS .

account_id

string

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

УдалитьАудиториюУчастникиЗапрос

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

Поля
`destinations[]`	`Destination` Обязательно. Список мест назначения, из которых необходимо удалить пользователей.
`audience_members[]`	`AudienceMember` Обязательно. Список пользователей для удаления.
`validate_only`	`bool` Необязательно. Для целей тестирования. Если `true` , запрос проверяется, но не выполняется. Возвращаются только ошибки, а не результаты.
`encoding`	`Encoding` Необязательно. Требуется для загрузок `UserData` . Тип кодировки идентификаторов пользователей. Применяется только к внешней кодировке для зашифрованных идентификаторов пользователей. Для загрузок, отличных от `UserData` , это поле игнорируется.
`encryption_info`	`EncryptionInfo` Необязательно. Информация о шифровании для загрузок `UserData` . Если не установлено, предполагается, что загруженная идентификационная информация хешируется, но не шифруется. Для загрузок, не относящихся `UserData` , это поле игнорируется.

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

Ответ на RemoveAudienceMembersRequest .

Поля

Поля
`request_id`	`string` Автоматически сгенерированный идентификатор запроса.

request_id

string

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

Условия обслуживания

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

Поля

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

customer_match_terms_of_service_status

TermsOfServiceStatus

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

Условия обслуживанияСтатус

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

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

Данные пользователя

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

Поля

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

user_identifiers[]

UserIdentifier

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

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

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

Поля
`identifier` поля объединения. Необходимо указать только один. `identifier` может быть только одним из следующих:
`email_address`	`string` Хэшированный адрес электронной почты с использованием хэш-функции SHA-256 после нормализации.
`phone_number`	`string` Хэшированный номер телефона с использованием хэш-функции SHA-256 после нормализации (стандарт E164).
`address`	`AddressInfo` Известные компоненты адреса пользователя. Содержит группу идентификаторов, которые сопоставляются все одновременно.

Package google.ads.datamanager.v1Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

Индекс

IngestionService

AdIdentifiers

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

АудиторияЧлен

Данные о корзине

Согласие

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

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

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

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

Кодирование

ШифрованиеИнформация

Событие

EventSource

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

GcpWrappedKeyInfo

Тип ключа

IngestAudienceMembersRequest

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

IngestEventsRequest

IngestEventsResponse

Элемент

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

ПараДанные

Продукт

ProductAccount

УдалитьАудиториюУчастникиЗапрос

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

Условия обслуживания

Условия обслуживанияСтатус

Данные пользователя

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

Package google.ads.datamanager.v1