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,
  "fieldWarnings": [
    {
      object (FieldWarning)
    }
  ]
}
Поля
requestId

string

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

object (FieldWarning)

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

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

Требуется следующая область действия 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,
  "callInfo": {
    object (CallInfo)
  },
  "conversionValue": number,
  "conversionCount": number
}
Поля
destinationReferences[]

string

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

string

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

string (Timestamp format)

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

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "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. Допустимы и другие типы нормализации. Примеры: "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)

Необязательное поле. Дополнительная информация о парах "ключ-значение", которая будет отправляться в контейнеры конверсий (действие-конверсия или действие Floodlight).
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.
callInfo

object (CallInfo)

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

number

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

number

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

AdIdentifiers

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

JSON-представление 
{
  "sessionAttributes": string,
  "gclid": string,
  "gbraid": string,
  "wbraid": string,
  "landingPageDeviceInfo": {
    object (DeviceInfo)
  },
  "mobileDeviceId": string,
  "dclid": string,
  "impressionId": string,
  "matchId": string,
  "encryptedUserIds": [
    {
      object (EncryptedUserId)
    }
  ],
  "ppid": string,
  "visitorPpid": string,
  "leadId": string
}
Поля
sessionAttributes

string

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

string

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

string

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

string

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

object (DeviceInfo)

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

string

Необязательное поле. Идентификатор мобильного устройства для рекламодателей. Это может быть IDFA на iOS, AdID на Android или идентификаторы для рекламодателей на других платформах.
dclid

string

Необязательное поле. Идентификатор клика по медийному объявлению, связанный с этим событием.
impressionId

string

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

string

Необязательное поле. Поле идентификатора сопоставления, используемое для объединения этого события с предыдущим.
encryptedUserIds[]

object (EncryptedUserId)

Необязательное поле. Любое количество зашифрованных идентификаторов пользователей.
ppid

string

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

string

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

string

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

EncryptedUserId

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

JSON-представление 
{
  "encryptedId": string,
  "entityType": enum (EncryptionEntityType),
  "entityId": string,
  "source": enum (EncryptionSource)
}
Поля
encryptedId

string

Обязательно. Зашифрованный буквенно-цифровой идентификатор.
entityType

enum (EncryptionEntityType)

Обязательно. Тип объекта шифрования. Она должна соответствовать конфигурации шифрования для показа объявлений или передачи данных.
entityId

string (int64 format)

Обязательно. Идентификатор объекта шифрования. Она должна соответствовать конфигурации шифрования для показа объявлений или передачи данных.
source

enum (EncryptionSource)

Обязательно. Указывает, был ли зашифрованный файл cookie получен при показе объявления (макрос %m) или при передаче данных.

EncryptionEntityType

Тип объекта шифрования.

Перечисления
ENCRYPTION_ENTITY_TYPE_UNSPECIFIED Не указан тип объекта шифрования.
CAMPAIGN_MANAGER_ACCOUNT Аккаунт Менеджера кампаний 360.
CAMPAIGN_MANAGER_ADVERTISER рекламодателем в Менеджере кампаний 360.
DISPLAY_VIDEO_PARTNER Партнер в Дисплее и Видео 360.
DISPLAY_VIDEO_ADVERTISER Рекламодатель в Дисплее и Видео 360.
GOOGLE_ADS_CUSTOMER Клиент Google Рекламы.
GOOGLE_AD_MANAGER_NETWORK_CODE Код сети Google Менеджера рекламы.

EncryptionSource

Источник шифрования.

Перечисления
ENCRYPTION_SOURCE_UNSPECIFIED Источник шифрования не указан.
AD_SERVING Источник шифрования при показе объявлений.
DATA_TRANSFER Источник шифрования при передаче данных.

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

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

string

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

string

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

number

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

object (Item)

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

string

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

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

Показатель

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

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

Необязательное поле. Идентификатор Merchant Center, связанный с товаром. Для распродаж в магазинах это значение переопределит значение, заданное на уровне корзины. Для других событий это поле игнорируется.
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.

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

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

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

string

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

string

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

string

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

ExperimentalField

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

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

string

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

string

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

UserProperties

Информация о пользователе, полученная рекламодателем в момент события. Подробнее: 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)

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

CustomerType

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

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

CustomerValueBucket

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

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

UserProperty

Группа дополнительных свойств пользователя, связанных с этим событием.

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

string

Обязательно. Название свойства пользователя.
value

string

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

EventParameter

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

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

string

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

string

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

EventLocation

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

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

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

string

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

CallInfo

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

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

string (Timestamp format)

Обязательно. Время начала телефонного звонка, который привел к этому событию.

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".