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,
  "eventSource": enum (EventSource),
  "eventDeviceInfo": {
    object (DeviceInfo)
  },
  "cartData": {
    object (CartData)
  },
  "customVariables": [
    {
      object (CustomVariable)
    }
  ],
  "experimentalFields": [
    {
      object (ExperimentalField)
    }
  ],
  "userProperties": {
    object (UserProperties)
  },
  "eventName": string,
  "clientId": string,
  "userId": string,
  "additionalEventParameters": [
    {
      object (EventParameter)
    }
  ],
  "thirdPartyUserData": {
    object (UserData)
  },
  "eventLocation": {
    object (EventLocation)
  },
  "appInstanceId": string,
  "conversionValue": number
}
Поля
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

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

eventSource

enum ( EventSource )

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

eventDeviceInfo

object ( DeviceInfo )

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

cartData

object ( CartData )

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

customVariables[]

object ( CustomVariable )

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

experimentalFields[]

object ( ExperimentalField )

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

userProperties

object ( UserProperties )

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

eventName

string

Необязательно. Название мероприятия. Обязательно для мероприятий GA4.

clientId

string

Необязательно. Уникальный идентификатор экземпляра веб-клиента пользователя для этого веб-потока GA4.

userId

string

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

additionalEventParameters[]

object ( EventParameter )

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

thirdPartyUserData

object ( UserData )

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

eventLocation

object ( EventLocation )

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

appInstanceId

string

Необязательно. Уникальный идентификатор экземпляра приложения пользователя для данного потока приложений GA4.

conversionValue

number

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

AdIdentifiers

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

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

string

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

gclid

string

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

gbraid

string

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

wbraid

string

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

landingPageDeviceInfo

object ( DeviceInfo )

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

mobileDeviceId

string

Необязательно. Мобильный идентификатор для рекламодателей. В iOS это может быть IDFA, в Android — AdID, или идентификаторы рекламодателей других платформ.

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

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

JSON-представление 
{
  "userAgent": string,
  "ipAddress": string,
  "category": string,
  "languageCode": string,
  "screenHeight": integer,
  "screenWidth": integer,
  "operatingSystem": string,
  "operatingSystemVersion": string,
  "model": string,
  "brand": string,
  "browser": string,
  "browserVersion": string
}
Поля
userAgent

string

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

ipAddress

string

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

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

category

string

Необязательно. Категория устройства. Например, «настольный компьютер», «планшет», «мобильный телефон», «смарт-телевизор».

languageCode

string

Необязательно. Язык, используемый устройством, в формате ISO 639-1.

screenHeight

integer

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

screenWidth

integer

Необязательно. Ширина экрана в пикселях.

operatingSystem

string

Необязательно. Операционная система или платформа устройства.

operatingSystemVersion

string

Необязательно. Версия операционной системы или платформы.

model

string

Необязательно. Модель устройства.

brand

string

Необязательно. Марка устройства.

browser

string

Необязательно. Марка или тип браузера.

browserVersion

string

Необязательно. Версия браузера.

EventSource

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

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

CartData

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

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

string

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

merchantFeedLabel

string

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

merchantFeedLanguageCode

string

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

transactionDiscount

number

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

items[]

object ( Item )

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

couponCodes[]

string

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

Если мероприятие предназначено для использования в Google Analytics, укажите только один промокод. Google Analytics игнорирует дополнительные промокоды.

Элемент

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

JSON-представление 
{
  "merchantProductId": string,
  "quantity": string,
  "unitPrice": number,
  "itemId": string,
  "additionalItemParameters": [
    {
      object (ItemParameter)
    }
  ],
  "merchantId": string,
  "merchantFeedLabel": string,
  "merchantFeedLanguageCode": string,
  "customVariables": [
    {
      object (ItemCustomVariable)
    }
  ],
  "conversionValue": number
}
Поля
merchantProductId

string

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

quantity

string ( int64 format)

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

unitPrice

number

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

itemId

string

Необязательно. Уникальный идентификатор для ссылки на элемент.

additionalItemParameters[]

object ( ItemParameter )

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

merchantId

string

Необязательно. Идентификатор торгового центра, связанный с товаром. Для событий «Продажи в магазине» это значение будет переопределять значение, установленное на уровне корзины. Для других событий это поле игнорируется.

merchantFeedLabel

string

Необязательно. Метка фида Merchant Center. Если страны по-прежнему используются, вместо них можно использовать двухбуквенный код страны в формате ISO-3166-1 alpha-2. Для событий «Продажи в магазине» это значение будет переопределять значение, установленное на уровне корзины. Для других событий это поле игнорируется.

merchantFeedLanguageCode

string

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

customVariables[]

object ( ItemCustomVariable )

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

conversionValue

number

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

ItemParameter

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

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

string

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

value

string

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

ItemCustomVariable

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

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

string

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

value

string

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

destinationReferences[]

string

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

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

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

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),
  "additionalUserProperties": [
    {
      object (UserProperty)
    }
  ]
}
Поля
customerType

enum ( CustomerType )

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

customerValueBucket

enum ( CustomerValueBucket )

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

additionalUserProperties[]

object ( UserProperty )

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

Тип клиента

Тип клиента, участвующего в мероприятии.

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

CustomerValueBucket

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

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

Пользовательское свойство

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

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

string

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

value

string

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

EventParameter

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

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

string

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

value

string

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

Место проведения мероприятия

Место, где произошло событие.

JSON-представление 
{
  "storeId": string,
  "city": string,
  "subdivisionCode": string,
  "regionCode": string,
  "subcontinentCode": string,
  "continentCode": string
}
Поля
storeId

string

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

city

string

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

subdivisionCode

string

Необязательно. Код подразделения ISO 3166-2, где произошло событие.

regionCode

string

Необязательно. Двухбуквенный региональный код CLDR адреса пользователя.

subcontinentCode

string

Необязательно. Код субконтинента в формате ООН M49, где произошло событие.

continentCode

string

Необязательно. Код континента в формате ООН M49, где произошло событие.