Ссылка на протокол измерений

На этой странице описывается механизм передачи и параметры данных для протокола измерений.

Транспорт

Все данные должны отправляться безопасно с использованием HTTPS POST запросов.

Отправляйте запросы на следующую конечную точку:

https://www.google-analytics.com/mp/collect

Если вы хотите, чтобы ваши данные обрабатывались в ЕС, используйте следующую конечную точку:

https://region1.google-analytics.com/mp/collect

Вот пример POST запроса:

POST /mp/collect HTTP/1.1
HOST: www.google-analytics.com
Content-Type: application/json
PAYLOAD_DATA

Замените PAYLOAD_DATA на полезную нагрузку запроса.

Протокол измерений возвращает код статуса 2xx , если получен HTTP запрос. Протокол измерений не возвращает код ошибки, если полезная нагрузка неправильно сформирована или если данные неверны или не обработаны Google Analytics.

Полезная нагрузка

Полезная нагрузка состоит из двух частей:

  1. Параметры запроса.
  2. Тело JSON POST .

Параметры запроса

Имя параметра Описание

api_secret

 Обязательно . Секрет API из пользовательского интерфейса Google Analytics.

Находится в разделе Администрирование > Потоки данных > Выберите свой поток > Протокол измерения > Создать .

Только для вашей организации. Необходимо регулярно обновлять, чтобы избежать чрезмерного СПАМА.

Тело JSON POST

Ключ Тип Описание

user_id

 string

Необязательно . Уникальный идентификатор пользователя. См. User-ID для кросс-платформенного анализа для получения дополнительной информации об этом идентификаторе. Может включать только символы utf-8.

timestamp_micros

 number

Необязательно . Временная метка Unix, микросекунды , а не миллисекунды . Представляет время события. Следует устанавливать только для записи событий, произошедших в прошлом. Может быть переопределено user_property или временными метками событий. События могут быть датированы задним числом до 3 календарных дней в зависимости от часового пояса свойства.

user_properties

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

user_data

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

non_personalized_ads

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

user_location

 object Необязательно . Устанавливает географическую информацию для запроса в структурированном формате.

ip_override

 string Необязательно . IP-адрес, который Google Analytics использует для получения географической информации для запроса.

events[]

 array Обязательно . Массив элементов event . До 25 событий можно отправить на один запрос. См. справочник событий для всех допустимых событий.

events[].name

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

events[].params

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

Атрибут consent настраивает типы и состояния согласия . Если вы не укажете consent , Google Analytics использует настройки согласия из соответствующих онлайн-взаимодействий для клиента или экземпляра приложения.

Ключ Тип Описание

ad_user_data

 string

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

Либо GRANTED , либо DENIED .

ad_personalization

 string

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

Либо GRANTED , либо DENIED .

Географическая информация

Атрибуты user_location и ip_override предоставляют географическую информацию. user_location имеет приоритет над ip_override .

Вот структура поля user_location . Укажите как можно больше атрибутов. Мы рекомендуем country_id и region_id как минимум.

Ключ Тип Описание

city

 string Необязательно . Название города .

region_id

 string Необязательно . Страна и подразделение по ISO 3166. Например, US-CA , US-AR , CA-BC , GB-LND , CN-HK .

country_id

 string Необязательно . Страна в формате ISO 3166-1 alpha-2 . Например, US , AU , ES , FR .

subcontinent_id

 string Необязательно . Субконтинент в формате ООН M49 . Например, 011 , 021 , 030 , 039 .

continent_id

 string Необязательно . Континент в формате ООН M49 . Например, 002 , 019 , 142 , 150 .

Вот пример user_location :

"user_location:" {
  "city:" "Mountain View",
  "region_id:" "US-CA",
  "country_id:" "US",
  "subcontinent_id:" "021",
  "continent_id:" "019"
}

ip_override — это альтернатива user_location . Если вместо этого вы отправляете ip_override , Google Analytics извлекает географическую информацию из IP-адреса. Если вы отправляете user_location , Google Analytics игнорирует ip_override .

Если вы не отправляете user_location или ip_override , Google Analytics извлекает географическую информацию из событий тегирования с помощьюclient_id .

Google Analytics применяет к запросу подробные настройки данных о местоположении объекта недвижимости независимо от отправленной географической информации.

Пользовательские параметры

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

  • Пользовательские параметры, определяемые пользователем, могут быть включены в user_properties .
  • Пользовательские параметры области событий могут быть включены в events[].params .
  • В items могут быть включены пользовательские параметры, относящиеся к области действия элемента .

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

Зарезервированные имена

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

Зарезервированные названия событий

Следующие названия событий зарезервированы и не могут быть использованы:

  • ad_activeview
  • ad_click
  • ad_exposure
  • ad_query
  • ad_reward
  • adunit_exposure
  • app_clear_data
  • app_exception
  • app_install
  • app_remove
  • app_store_refund
  • app_update
  • app_upgrade
  • dynamic_link_app_open
  • dynamic_link_app_update
  • dynamic_link_first_open
  • error
  • firebase_campaign
  • firebase_in_app_message_action
  • firebase_in_app_message_dismiss
  • firebase_in_app_message_impression
  • first_open
  • first_visit
  • in_app_purchase
  • notification_dismiss
  • notification_foreground
  • notification_open
  • notification_receive
  • notification_send
  • os_update
  • session_start
  • user_engagement

Зарезервированные имена параметров

Следующие имена параметров зарезервированы и не могут быть использованы:

  • firebase_conversion

Имена параметров не могут начинаться со следующих символов:

  • _ (underscore)
  • firebase_
  • ga_
  • google_
  • gtag.

Зарезервированные имена свойств пользователя

Следующие имена свойств пользователя зарезервированы и не могут быть использованы:

  • first_open_time
  • first_visit_time
  • last_deep_link_referrer
  • user_id
  • first_open_after_install

Кроме того, имена свойств пользователя не могут начинаться с:

  • _ (underscore)
  • firebase_
  • ga_
  • google_