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

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

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 Неуказанный источник событий. Не следует использовать.
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.

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

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

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.