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

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

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

Отформатируйте запрос

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

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

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

PAYLOAD_DATA

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

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

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

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

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

Для протокола Measurement Protocol необходимо предоставить тело запроса в формате JSON POST . Вот пример:

  {
   "app_instance_id": "APP_INSTANCE_ID",
   "events": [
      {
        "name": "login",
        "params": {
          "method": "Google",
          "session_id": "SESSION_ID",
          "engagement_time_msec": 100
        }
      }
   ]
  }

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

Попробуйте!

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

const firebaseAppId = "FIREBASE_APP_ID";
const apiSecret = "API_SECRET";

fetch(`https://www.google-analytics.com/mp/collect?firebase_app_id=${firebaseAppId}&api_secret=${apiSecret}`, {
  method: "POST",
  body: JSON.stringify({
    app_instance_id: "APP_INSTANCE_ID",
    events: [
      {
        name: "tutorial_begin",
        params: {
          "session_id": "SESSION_ID",
          "engagement_time_msec": 100
        }
      },
      {
        name: "join_group",
        params: {
          "group_id": "G_12345",
          "session_id": "SESSION_ID",
          "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 зависит от платформы. См. раздел «Идентификатор приложения» в конфигурационных файлах и объектах Firebase .

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

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

  1. timestamp_micros значение параметра event или user.
  2. timestamp_micros запроса.
  3. Время получения запроса протоколом измерения.

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

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

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

  • tutorialBeginUnixEpochTimeInMicros для события tutorial_begin
  • customerTierUnixEpochTimeInMicros для свойства пользователя customer_tier
  • requestUnixEpochTimeInMicros для события join_group и свойства пользователя newsletter_reader .
{
  "timestamp_micros": requestUnixEpochTimeInMicros,
  "events": [
    {
      "name": "tutorial_begin",
      "timestamp_micros": tutorialBeginUnixEpochTimeInMicros
    },
    {
      "name": "join_group",
      "params": {
        "group_id": "G_12345",
      }
    }
  ],
  "user_properties": {
    "customer_tier": {
      "value": "PREMIUM",
      "timestamp_micros": customerTierUnixEpochTimeInMicros
    },
    "newsletter_reader": {
      "value": "true"
    }
  }
}

Проверка поведения при обработке прошлых событий и свойств пользователя.

События и свойства пользователей могут быть датированы задним числом до 72 часов. Если значение timestamp_micros относится к периоду более 72 часов назад, протокол измерения принимает или отклоняет событие или свойство пользователя следующим образом:

  • Если параметр validation_behavior не задан или задан в значение RELAXED , протокол измерения принимает событие или свойство пользователя, но переопределяет его метку времени на 72 часа назад.
  • Если для параметра validation_behavior установлено значение ENFORCE_RECOMMENDATIONS , протокол измерения отклоняет событие или свойство пользователя.

Ограничения

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

  • В запросе может быть максимум 25 событий.
  • События могут содержать максимум 25 параметров.
  • В рамках мероприятия может быть указано максимум 25 пользовательских свойств.
  • Названия свойств пользователя должны содержать не более 24 символов.
  • Значения свойств пользователя должны содержать не более 36 символов.
  • Названия мероприятий не должны содержать более 40 символов, могут включать только буквенно-цифровые символы и символы подчеркивания, а также должны начинаться с буквы.
  • Названия параметров, включая параметры элементов, должны содержать не более 40 символов, могут содержать только буквенно-цифровые символы и символы подчеркивания, а также должны начинаться с буквы.
  • Значения параметров, включая значения параметров элементов, должны быть не более 100 символов для стандартного ресурса Google Analytics и не более 500 символов для ресурса Google Analytics 360.

    Это ограничение не распространяется на параметры session_id и session_number , если их значения предоставляются соответствующими встроенными переменными Analytics Session ID и Analytics Session Number в Google Tag Manager.

  • Параметры элемента могут содержать максимум 10 пользовательских параметров.

  • Размер тела сообщения должен быть менее 130 кБ.

  • Временная метка должна быть в пределах последних 72 часов. Подробности см. в разделе «Поведение проверки для прошлых событий» .

  • События протокола App Measurement Protocol, отправляемые в Google Analytics, не отображаются в поисковых аудиториях Google Ads для пользователей приложения.

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