Как получать уведомления о списках аудиторий с помощью веб-перехватчиков

В этом руководстве рассказывается, как использовать вебхуки для получения асинхронных уведомлений о статусе запросов на экспорт аудитории. Эта функция доступна только в версии v1alpha Data API.

Уведомления вебхука – это расширенная функция Google Analytics Data API. Общие сведения об экспорте аудиторий приведены в статье Как экспортировать аудиторию.

Без вебхуков вам придется периодически опрашивать API, чтобы определить, когда запрос будет выполнен.

Как создать пример приложения вебхука с помощью Cloud Run

Вы можете создать пример приложения вебхука с помощью Google Cloud, следуя инструкциям в руководстве Быстрый старт: развертывание примера сервиса в Cloud Run.

Чтобы пример сервиса мог прослушивать запросы уведомлений вебхука POST, замените файл index.js из руководства по быстрому началу работы следующим кодом:

  import express from 'express';

  const app = express();
  app.use(express.json());

  app.post('/', (req, res) => {
    const channelToken = req.get('X-Goog-Channel-Token');
    const bodyJson = JSON.stringify(req.body);

    console.log(`channel token: ${channelToken}`);
    console.log(`notification body: ${bodyJson}`);

    res.sendStatus(200);
  });

  const port = parseInt(process.env.PORT) || 8080;
  app.listen(port, () => {
    console.log(`helloworld: listening on port ${port}`);
  });

Для каждого входящего уведомления вебхука, отправленного в виде запроса POST, этот код выводит тело JSON уведомления вебхука и значение токена канала, а также возвращает код HTTP 200, указывающий на успешное выполнение операции.

Когда вы дойдете до конца руководства по быстрому началу работы с Cloud Run и развернете приложение вебхука с помощью команды gcloud run deploy, сохраните URL, по которому развернут ваш сервис.

URL сервиса будет показан в консоли, например:

  Service URL: https://webhooks-test-abcdef-uc.a.run.app

Это URI уведомлений сервера, по которому ваше приложение получает уведомления вебхука от Google Аналитики.

Создайте список аудитории и включите уведомления вебхука

Чтобы запросить уведомления вебхука, укажите следующие значения в объекте webhookNotification:

  • URI уведомлений сервера, содержащий веб-адрес, на который будут приходить уведомления вебхука.

  • Произвольная строка channelToken, которая защищает сообщение от подделки (необязательно). Укажите channelToken в HTTP-заголовке X-Goog-Channel-Token запроса POST вебхука.

Пример запроса с использованием вебхуков:

HTTP-запрос.

POST https://analyticsdata.googleapis.com/v1alpha/properties/1234567/audienceLists
{
  "webhookNotification": {
    "uri": "https://webhooks-test-abcdef-uc.a.run.app",
    "channelToken": "123456"
  },
  "audience": "properties/1234567/audiences/12345",
  "dimensions": [
    {
      "dimensionName": "deviceId"
    }
  ]
}

Ответ метода audienceLists.create содержит поле webhookNotification, которое подтверждает, что указанный веб-хук успешно ответил менее чем за 5 секунд.

Пример ответа:

Ответ HTTP

{
  "response": {
    "@type": "type.googleapis.com/google.analytics.data.v1alpha.AudienceList",
    "name": "properties/1234567/audienceLists/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName": "Purchasers",
    "dimensions": [
      {
        "dimensionName": "deviceId"
      }
    ],
    "state": "ACTIVE",
    "beginCreatingTime": "2024-06-10T04:50:09.119726379Z",
    "creationQuotaTokensCharged": 51,
    "rowCount": 13956,
    "percentageCompleted": 100,
    "webhookNotification": {
      "uri": "https://webhooks-test-abcdef-uc.a.run.app",
      "channelToken": "123456"
    }
  }
}

Если вебхук не отвечает или вы указали неверный URL сервиса, возвращается сообщение об ошибке.

Пример ошибки:

{
  "error": {
    "code": 400,
    "message": "Expected response code of 200 from webhook URI but instead
    '404' was received.",
    "status": "INVALID_ARGUMENT"
  }
}

Обработка уведомлений вебхука

Запрос POST к сервису вебхуков содержит в теле версию ресурса продолжительной операции в формате JSON и поле sentTimestamp. Временная метка отправки указывает время отправки запроса в микросекундах с начала эпохи Unix. По этой временной метке можно выявлять повторные уведомления.

При создании списка аудитории в вебхук отправляется один или два запроса POST:

  1. Первый запрос POST отправляется сразу. Он показывает только что созданный список аудитории в состоянии CREATING. Если первый запрос к вебхуку не удается выполнить, операция audienceLists.create возвращает ошибку и сведения о сбое вебхука.
  2. Второй запрос POST отправляется после того, как список аудитории будет создан. Создание списка аудитории завершается, когда он переходит в состояние ACTIVE или FAILED.

Вот пример первого уведомления для списка аудитории в состоянии CREATING:

  {
    "sentTimestamp":"1718261355692983",
    "name": "properties/1234567/audienceLists/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName":"Purchasers",
    "dimensions":[{"dimensionName":"deviceId"}],
    "state":"CREATING",
    "beginCreatingTime": "2024-06-10T04:50:09.119726379Z",
    "creationQuotaTokensCharged":0,
    "rowCount":0,
    "percentageCompleted":0,
    "webhookNotification":
      {
        "uri": "https://webhooks-test-abcdef-uc.a.run.app",
        "channelToken":"123456"
      }
  }

Ниже приведен пример второго уведомления для списка аудитории в состоянии ACTIVE.

  {
    "sentTimestamp":"1718261355692983",
    "name": "properties/1234567/audienceLists/123",
    "audience": "properties/1234567/audiences/12345",
    "audienceDisplayName":"Purchasers",
    "dimensions":[{"dimensionName":"deviceId"}],
    "state":"ACTIVE",
    "beginCreatingTime": "2024-06-10T04:50:09.119726379Z",
    "creationQuotaTokensCharged":68,
    "rowCount":13956,
    "percentageCompleted":100,
    "webhookNotification":
      {
        "uri": "https://webhooks-test-abcdef-uc.a.run.app",
        "channelToken":"123456"
      }
  }

Второе уведомление подтверждает, что список аудитории создан и готов к запросу с помощью метода audienceLists.query.

Чтобы протестировать вебхуки после вызова метода audienceLists.create, проверьте журналы примера приложения вебхука Cloud Run и посмотрите тело JSON каждого уведомления, отправленного Google Аналитикой.