Method: events.ingest

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

HTTP-запрос

POST https://datamanager.googleapis.com/v1/events:ingest

URL использует синтаксис перекодировки gRPC .

Текст запроса

Тело запроса содержит данные со следующей структурой:

JSON-представление 
{
  "destinations": [
    {
      object (Destination)
    }
  ],
  "events": [
    {
      object (Event)
    }
  ],
  "consent": {
    object (Consent)
  },
  "validateOnly": boolean,
  "encoding": enum (Encoding),
  "encryptionInfo": {
    object (EncryptionInfo)
  }
}
Поля
destinations[]

object ( Destination )

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

events[]

object ( Event )

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

consent

object ( Consent )

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

validateOnly

boolean

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

encoding

enum ( Encoding )

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

encryptionInfo

object ( EncryptionInfo )

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

Тело ответа

Ответ от IngestEventsRequest .

В случае успеха тело ответа содержит данные со следующей структурой:

JSON-представление 
{
  "requestId": string
}
Поля
requestId

string

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

Области авторизации

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

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

Событие

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

JSON-представление 
{
  "destinationReferences": [
    string
  ],
  "transactionId": string,
  "eventTimestamp": string,
  "lastUpdatedTimestamp": string,
  "userData": {
    object (UserData)
  },
  "consent": {
    object (Consent)
  },
  "adIdentifiers": {
    object (AdIdentifiers)
  },
  "currency": string,
  "conversionValue": number,
  "eventSource": enum (EventSource),
  "eventDeviceInfo": {
    object (DeviceInfo)
  },
  "cartData": {
    object (CartData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "experimentalFields": [
    {
      object (ExperimentalField)
    }
  ],
  "userProperties": {
    object (UserProperties)
  }
}
Поля
destinationReferences[]

string

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

transactionId

string

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

eventTimestamp

string ( Timestamp format)

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

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

lastUpdatedTimestamp

string ( Timestamp format)

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

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

userData

object ( UserData )

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

consent

object ( Consent )

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

adIdentifiers

object ( AdIdentifiers )

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

currency

string

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

conversionValue

number

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

eventSource

enum ( EventSource )

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

eventDeviceInfo

object ( DeviceInfo )

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

cartData

object ( CartData )

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

customVariables[]

object ( CustomVariable )

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

experimentalFields[]

object ( ExperimentalField )

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

userProperties

object ( UserProperties )

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

AdIdentifiers

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

JSON-представление 
{
  "sessionAttributes": string,
  "gclid": string,
  "gbraid": string,
  "wbraid": string,
  "landingPageDeviceInfo": {
    object (DeviceInfo)
  }
}
Поля
sessionAttributes

string

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

gclid

string

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

gbraid

string

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

wbraid

string

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

landingPageDeviceInfo

object ( DeviceInfo )

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

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

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

JSON-представление 
{
  "userAgent": string,
  "ipAddress": string
}
Поля
userAgent

string

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

ipAddress

string

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

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

EventSource

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

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

CartData

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

JSON-представление 
{
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "transactionDiscount": number,
  "items": [
    {
      object (Item)
    }
  ]
}
Поля
merchantId

string

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

merchantFeedLabel

string

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

merchantFeedLanguageCode

string

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

transactionDiscount

number

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

items[]

object ( Item )

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

Элемент

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

JSON-представление 
{
  "merchantProductId": string,
  "quantity": string,
  "unitPrice": number
}
Поля
merchantProductId

string

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

quantity

string ( int64 format)

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

unitPrice

number

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

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

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

JSON-представление 
{
  "variable": string,
  "value": string,
  "destinationReferences": [
    string
  ]
}
Поля
variable

string

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

value

string

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

destinationReferences[]

string

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

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

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

JSON-представление 
{
  "field": string,
  "value": string
}
Поля
field

string

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

value

string

Необязательно. Значение поля, которое нужно задать.

Свойства пользователя

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

JSON-представление 
{
  "customerType": enum (CustomerType),
  "customerValueBucket": enum (CustomerValueBucket)
}
Поля
customerType

enum ( CustomerType )

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

customerValueBucket

enum ( CustomerValueBucket )

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

Тип клиента

Тип клиента, связанного с событием.

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

CustomerValueBucket

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

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