Method: events.ingest

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

HTTP-запрос

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

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

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

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

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)
    }
  ]
}
Поля
destinationReferences[]

string

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

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.

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-адрес устройства для данного контекста.

EventSource

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

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

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

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

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

string

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

value

string

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

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

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

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

string

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

value

string

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

,

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

HTTP-запрос

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

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

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

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

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)
    }
  ]
}
Поля
destinationReferences[]

string

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

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.

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-адрес устройства для данного контекста.

EventSource

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

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

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

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

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

string

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

value

string

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

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

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

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

string

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

value

string

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