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

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

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

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 .

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 Рекламы или идентификатор аудитории Display & Video 360.

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

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

Поля
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 обернула ключевую информацию.

Событие

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

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

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

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.

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

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

MobileData

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

Поля
mobile_ids[]

string

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

PairData

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

Поля
pair_ids[]

string

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

Продукт

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

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

ProductAccount

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

Поля
product

Product

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

account_id

string

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

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

Запрос на удаление пользователей из аудитории в указанных местах назначения. Возвращает 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

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

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

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

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

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

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

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

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