Как отправлять события Measurement Protocol в Google Аналитику

В этом руководстве объясняется, как отправлять веб-события и события потоков приложений протокола измерений Google Analytics на сервер Google Analytics, чтобы можно было просматривать события протокола измерений в отчетах Google Analytics .

Выберите платформу, которую вы хотите видеть в этом руководстве:

Firebase gtag.js

Форматировать запрос

Протокол измерений Google Analytics поддерживает только запросы HTTP POST .

Для отправки события используйте следующий формат:

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

Совет: если вы хотите, чтобы ваши данные обрабатывались в ЕС, измените HOST в примере на region1.google-analytics.com .

В URL-адресе запроса необходимо указать следующее:

• api_secret : API SECRET , сгенерированный в пользовательском интерфейсе Google Analytics.

  Чтобы создать новый секрет, перейдите в раздел «Администрирование» > «Потоки данных» > выберите свой поток > «Протокол измерений» > «Создать» .

• firebase_app_id : идентификатор приложения Firebase, который можно найти в консоли Firebase в разделе «Настройки проекта» > «Основные» > «Ваши приложения» > «Идентификатор приложения» .

  firebase_app_id не то же самое, что app_instance_id . firebase_app_id идентифицирует ваше приложение, тогда как app_instance_id идентифицирует отдельную установку приложения.

Полную информацию см. в параметрах запроса .

В тексте запроса необходимо указать следующее:

• app_instance_id : Уникальный идентификатор для экземпляра приложения Firebase. Это отличается от web client_id :

  • Android - получитьAppInstanceId()
  • Котлин - getAppInstanceId()
  • Swift - appInstanceID()
  • Objective-C - appInstanceID
  • C++ - GetAnalyticsInstanceId()
  • Unity - GetAnalyticsInstanceIdAsync()

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

• consent : Необязательно. Узнайте, как задать настройки согласия .

• user_location : Необязательно. Географическая информация для событий в запросе.

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

  Google Analytics игнорирует это поле, если запрос также включает user_location .

• device : Необязательно. Информация об устройстве для событий в запросе.

• timestamp_micros : Необязательно. Время эпохи Unix в микросекундах для событий и свойств пользователя в запросе. Если не указано, по умолчанию используется время запроса .

• events : Массив элементов событий. Вы можете включить несколько событий в один запрос.

  Для отображения активности пользователя в отчетах типа Realtime , engagement_time_msec и session_id должны быть предоставлены как часть params для event . Параметр engagement_time_msec должен отражать время взаимодействия события в миллисекундах.

  Вот пример:

  {
   "app_instance_id": "12345678901234567890123456789012",
   "events": [
     {
        "name": "campaign_details",
        "params": {
          "campaign_id": "google_1234",
          "campaign": "Summer_fun",
          "source": "google",
          "medium": "cpc",
          "term": "summer+travel",
          "content": "logolink",
          "session_id": "123",
          "engagement_time_msec": 100
        }
     }
   ]
  }

Хотя session_start — это зарезервированное имя события , создание нового session_id создает новый сеанс без необходимости отправлять session_start . Поймите, как подсчитываются сеансы .

Попробуй это

Вот пример, который вы можете использовать для отправки нескольких событий одновременно. Этот пример отправляет событие tutorial_begin и событие join_group на ваш сервер Google Analytics, включает географическую информацию с помощью поля user_location и включает информацию об устройстве с помощью поля device .

const firebase_app_id = `1:1234567890:android:321abc456def7890`;
const api_secret = `<secret_value>`;

fetch(`https://www.google-analytics.com/mp/collect?firebase_app_id=${firebase_app_id}&api_secret=${api_secret}`, {
  method: "POST",
  body: JSON.stringify({
    app_instance_id: 'app_instance_id',
    events: [
      {
        name: "tutorial_begin",
        params: {
          "session_id": "123",
          "engagement_time_msec": 100
        }
      },
      {
        name: "join_group",
        params: {
          "group_id": "G_12345",
          "session_id": "123",
          "engagement_time_msec": 150
        }
      }
    ],
    user_location: {
      city: "Mountain View",
      region_id: "US-CA",
      country_id: "US",
      subcontinent_id: "021",
      continent_id: "019"
    },
    device: {
      category: "mobile",
      language: "en",
      screen_resolution: "1280x2856",
      operating_system: "Android",
      operating_system_version: "14",
      model: "Pixel 9 Pro",
      brand: "Google",
      browser: "Chrome",
      browser_version: "136.0.7103.60"
    }
  })
});

Формат firebase_app_id зависит от платформы. См. Application ID в разделе Файлы и объекты конфигурации Firebase .

Переопределить временную метку

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

1. timestamp_micros события.
2. Временная метка запроса timestamp_micros .
3. Время, когда протокол измерений получает запрос.

Следующий пример отправляет временную метку уровня запроса, которая применяется ко всем событиям в запросе. В результате протокол измерений назначает событиям tutorial_begin и join_group временную метку requestUnixEpochTimeInMicros .

{
  "timestamp_micros": requestUnixEpochTimeInMicros,
  "events": [
    {
      "name": "tutorial_begin"
    },
    {
      "name": "join_group",
      "params": {
        "group_id": "G_12345",
      }
    }
  ]
}

Следующий пример отправляет как временную метку уровня запроса, так и временную метку уровня события. В результате протокол измерений назначает событию tutorial_begin временную метку tutorialBeginUnixEpochTimeInMicros , а событию join_group — временную метку requestUnixEpochTimeInMicros .

{
  "timestamp_micros": requestUnixEpochTimeInMicros,
  "events": [
    {
      "name": "tutorial_begin",
      "timestamp_micros": tutorialBeginUnixEpochTimeInMicros
    },
    {
      "name": "join_group",
      "params": {
        "group_id": "G_12345",
      }
    }
  ]
}

Ограничения

При отправке событий Measurement Protocol в Google Analytics действуют следующие ограничения:

Примечание: Информацию об ограничениях функций 360 см. в разделе Google Analytics 360 .

• Запросы могут содержать максимум 25 событий.
• События могут иметь максимум 25 параметров.
• События могут иметь максимум 25 пользовательских свойств.
• Имена пользовательских свойств должны содержать не более 24 символов.
• Значения свойств пользователя должны содержать не более 36 символов.
• Названия событий должны содержать не более 40 символов, могут содержать только буквенно-цифровые символы и символы подчеркивания и должны начинаться с буквенного символа.
• Имена параметров, включая параметры элементов, должны содержать не более 40 символов, могут содержать только буквенно-цифровые символы и символы подчеркивания и должны начинаться с буквенного символа.
• Значения параметров, включая значения параметров элементов, должны содержать не более 100 символов для стандартного свойства Google Analytics и не более 500 символов для свойства Google Analytics 360.
• Параметры элемента могут иметь максимум 10 пользовательских параметров.
• Тело сообщения должно быть меньше 130 КБ.
• События App Measurement Protocol, отправляемые в Google Analytics, не заполняют поисковые аудитории в Google Ads для пользователей приложений.

Дополнительные требования для каждого варианта использования см. в разделе «Распространенные варианты использования» .