Сопоставления полей

Используйте сопоставления в таблицах, чтобы сопоставить запрос на сбор данных Measurement Protocol (/mp/collect) с его эквивалентом IngestEventsRequest в Data Manager API.

Аутентификация

Для Data Manager API требуются учетные данные OAuth, а не api_secret. Следуйте инструкциям в разделе Настройка доступа к API, чтобы создать новые учетные данные, включающие область действия Data Manager API.

Поля запроса

Запрос /mp/collect (Measurement Protocol) IngestEventsRequest (Data Manager API) Примечания
measurement_id (параметр запроса) destinations Сопоставление с product_destination_id для событий на сайте. Подробнее о полях целевой страницы…
firebase_app_id (параметр запроса) destinations Сопоставление с product_destination_id для событий в приложении. Подробнее о полях целевой страницы…
api_secret (параметр запроса) Ранее такого отчета не существовало Подробнее о том, как настроить доступ к API…
consent consent Установите объект Consent.
events events Установите список ресурсов Event. Подробнее о полях событий…
client_id events.client_id Обязательный атрибут для событий на сайте.
app_instance_id events.app_instance_id Обязательный атрибут для событий в приложении.
user_id events.user_id Необязательное поле. Уникальный идентификатор пользователя.
timestamp_micros events.event_timestamp В Measurement Protocol это можно указать на уровне запроса или отдельного события. В Data Manager API нет временной метки на уровне запроса. Установите для каждого события параметр event_timestamp, равный времени, когда произошло событие.
  • Если вы используете формат JSON, задайте значение в формате RFC 3339.
  • Если вы используете буферы протоколов, примените Timestamp и задайте поля seconds и (необязательно) nanoseconds.

Подробнее о формате временной метки…
user_properties events.user_properties

Установите объект UserProperties. Если вы отправляете тип или сегмент значений пользователя, используйте поля customer_type или customer_value_bucket объекта UserProperties соответственно. Для других свойств пользователя создайте отдельный объект UserProperty, задайте его поля property_name и value и добавьте его в список additional_user_properties.

API Менеджера данных не поддерживает установку временных меток для отдельных свойств пользователя. Временные метки, связанные с изменениями свойств пользователей, определяются по временной метке события (event_timestamp).

user_data events.user_data Установите объект UserData. Подробнее о полях с идентификатором пользователя…
non_personalized_ads events.consent.ad_personalization Если non_personalized_ads равно true, задайте для ad_personalization значение DENIED.
user_location events.event_location Подробнее о полях местоположения пользователя…
ip_override events.event_device_info.ip_address
device events.event_device_info Подробнее о полях устройств…
user_agent events.event_device_info.user_agent
validation_behavior Ранее такого отчета не существовало Используйте Диагностику, чтобы узнать статус загрузки, а также ошибки и предупреждения для отдельных событий во время последующей обработки. Если IngestEventsRequest не удается (например, из-за отсутствия обязательных полей), никакие события не обрабатываются. Вам нужно устранить ошибку и повторить запрос. Подробнее об ошибках API…
/debug/mp/collect validate_only Установите для параметра validate_only значение true, чтобы проверять события без сбора данных, как в сервере валидации Measurement Protocol.
Ранее такого отчета не существовало encoding Обязательно для загрузок UserData. Укажите Encoding, используемый для значений UserIdentifier.

Целевые поля

Measurement Protocol отправляет события непосредственно в определенный поток данных с помощью параметра запроса measurement_id или firebase_app_id.

В Data Manager API объект Destination используется для указания места, куда нужно отправлять данные. Подробнее о настройке целевых страниц…

Ниже описано, как сопоставить поля Measurement Protocol с эквивалентными полями в Destination.

Measurement Protocol Destination (Data Manager API) Примечания
measurement_id (параметр запроса) product_destination_id Идентификатор потока данных сайта Google Аналитики .
firebase_app_id (параметр запроса) product_destination_id Идентификатор приложения Firebase для потока данных приложения Google Аналитики.
Ранее такого отчета не существовало operating_account Установите для параметра account_id идентификатор ресурса Google Аналитики. Задайте для параметра account_type значение GOOGLE_ANALYTICS_PROPERTY.
Ранее такого отчета не существовало login_account Установите для параметра account_id идентификатор ресурса Google Аналитики. Задайте для параметра account_type значение GOOGLE_ANALYTICS_PROPERTY.

Поля типа обращения event

Measurement Protocol events[] Event (Data Manager API) Примечания
name event_name Если в event_name используется зарезервированное название, API отклоняет событие с ошибкой INVALID_EVENT_NAME.
Ранее такого отчета не существовало event_source Значение WEB, если событие было сгенерировано в веб-браузере, и APP, если событие было сгенерировано в приложении.
Ранее такого отчета не существовало destination_references Обязательно, если список destinations на уровне запроса содержит более одного Destination Google Аналитики. Добавьте запись, чтобы указать, в какой целевой сервис нужно передавать событие.
timestamp_micros event_timestamp
  • Если вы используете формат JSON, задайте значение в формате RFC 3339.
  • Если вы используете буферы протоколов, примените Timestamp и задайте поля seconds и (необязательно) nanoseconds.

Подробнее о формате временной метки…
params.currency currency
params.value conversion_value
params.customer_type user_properties.customer_type В Measurement Protocol параметр customer_type задается как параметр события. В Data Manager API задайте его в поле customer_type объекта UserProperties в событии.
params.transaction_id transaction_id Обязательный для некоторых событий и вариантов использования. Подробнее о том, как преобразовать данные в объекты Event…
params.items cart_data.items Подробнее о полях объектов для данных корзины…
params.coupon cart_data.coupon_codes Используйте поле coupon_codes, чтобы указать купоны, примененные к корзине. Предоставляйте только один купон для Google Аналитики. Это не зависит от купонов на уровне Item, которые можно задать с помощью cart_data.items.additional_item_parameters для отдельных товаров.
params.session_id additional_event_parameters Сопоставьте с записью, в которой для параметра parameter_name задано значение session_id.
params.engagement_time_msec additional_event_parameters Сопоставьте с записью, в которой для параметра parameter_name задано значение engagement_time_msec.
Другое в категории "params" additional_event_parameters

Сопоставьте другие параметры в виде списка объектов с parameter_name и value.

Примечание. Не добавляйте записи для transaction_id, currency или value; используйте поля верхнего уровня в Event.

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

Measurement Protocol user_data UserIdentifier (Data Manager API) Примечания
sha256_email_address[] email_address Установите форматированный и хешированный адрес электронной почты. Вы также можете зашифровать хешированный адрес электронной почты.
sha256_phone_number[] phone_number Отформатированный и хешированный номер телефона. Вы также можете зашифровать хешированный номер телефона.
address[] address Установите объект AddressInfo. Соблюдайте правила форматирования и хеширования.
address[].sha256_first_name address.given_name Форматированное и хешированное имя. Вы также можете зашифровать хешированное имя.
address[].sha256_last_name address.family_name Установите отформатированное и хешированное название семейной группы. Вы также можете зашифровать хешированное имя семейной группы.
address[].country address.region_code
address[].postal_code address.postal_code
address[].city address.city Указывается нормализованное название города. Не хешируйте это поле.
address[].region address.administrative_area Укажите нормализованный административный район (штат или провинцию). Не хешируйте это поле.
address[].sha256_street address.address_line Установите форматированный и хешированный адрес улицы. Вы также можете зашифровать хешированный адрес.

Поля товаров для данных корзины

Measurement Protocol items[] Item (Data Manager API) Примечания
item_id item_id Обязательно.
item_name additional_item_parameters Сопоставьте с записью, в которой для параметра parameter_name задано значение item_name.
quantity quantity Обязательно.
price unit_price Обязательно.
Другие поля объектов additional_item_parameters

Сопоставьте другие параметры товара (например, discount, affiliation, item_brand и т. д.) как список объектов с параметрами parameter_name и value.

Примечание. Не добавляйте записи для quantity, price или item_id; используйте поля верхнего уровня в Item.

Поля местоположения пользователя

Measurement Protocol user_location EventLocation (Data Manager API) Примечания
city city Название города, в котором произошло событие.
country_id region_code Укажите двухбуквенный код региона CLDR.
region_id subdivision_code Код административной единицы в соответствии со стандартом ISO 3166-2.
continent_id continent_code Код континента в формате UN M49.
subcontinent_id subcontinent_code Код субконтинента в формате UN M49.

Поля устройств

Measurement Protocol device DeviceInfo (Data Manager API) Примечания
category category
language language_code
screen_resolution screen_height и screen_width В Measurement Protocol значение screen_resolution передается в виде строки ("1280x720"). В Data Manager API значения screen_height и screen_width передаются как отдельные целые числа.
operating_system operating_system
operating_system_version operating_system_version
model model
brand brand
browser browser
browser_version browser_version