Как использовать API монитора действий в потоке

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

В этом руководстве рассказывается, как настроить аутентификацию, получить ресурс верхнего уровня DaiSession и запросить ресурсы, указанные в полях сеанса.

Требования

Чтобы использовать SAM API, вам потребуется:

Запросить ресурс DaiSession

Чтобы проверить сеанс динамической вставки объявлений, отправьте HTTP-запрос GET конечной точке networks.daiSessions.get с идентификатором сеанса динамической вставки объявлений или ключом отладки потока динамической вставки объявлений.

Получение ресурса DaiSession по идентификатору

Когда вы регистрируете сеанс потоковой передачи с помощью IMA DAI SDK, Full-service DAI API или Pod serving DAI API, Google DAI возвращает идентификатор сеанса DAI.

В примере ниже показано, как получить ресурс DaiSession с помощью идентификатора сеанса.

curl -X GET \
    "https://admanager.googleapis.com/v1/networks/NETWORK_CODE/daiSessions/SESSION_ID" \
    -H "Authorization: Bearer OAUTH_TOKEN"

Замените следующее:

  • NETWORK_CODE – код сети Google Менеджера рекламы.
  • SESSION_ID – идентификатор сеанса динамической вставки объявлений, возвращаемый при создании сеанса трансляции.
  • OAUTH_TOKEN – ваш токен доступа OAuth 2.0.

Как использовать ключ отладки для сеанса динамической вставки объявлений

При регистрации сеанса трансляции вы можете назначить специальный ключ отладки, используя параметр dai-sam-id или sam_id в запросах на показ пакетов видео по запросу. Этот ключ отладки можно передать непосредственно в пути к ресурсу DaiSession.

В примере ниже ресурс DaiSession извлекается с помощью ключа отладки.

curl -X GET \
    "https://admanager.googleapis.com/v1/networks/NETWORK_CODE/daiSessions/DEBUG_KEY" \
    -H "Authorization: Bearer OAUTH_TOKEN"

Замените DEBUG_KEY на собственный ключ отладки, указанный в запросе на создание потока.

Оба запроса возвращают ответ JSON DaiSession, содержащий контекст сеанса, выбранные объявления, пакеты объявлений, для которых принято решение, рекламные паузы и результаты диагностики. Выходные данные будут выглядеть примерно так:

{
  "name": "networks/21775744923/daiSessions/9587e2c1-d745-4bf1-9f6a-e9092127cb48:ATL",
  "creationContext": {
    "streamCreateRequest": {
      "requestTime": "2026-10-16T19:59:57.365124Z",
      "latency": "0.045s",
      "url": "/ssai/event/c-rArva4ShKVIAkNfy6HUQ/streams",
      "userAgent": "Mozilla/5.0",
      "responseCode": 201
    },
    "linearInfo": {
      "liveStream": "networks/21775744923/liveStreams/20000016294786",
      "assetKey": "c-rArva4ShKVIAkNfy6HUQ",
      "prefetchEnabled": false,
      "podTrimmingEnabled": true,
      "podTrimTolerance": "2s",
      "eventStartTime": "2020-06-09T20:00:00Z",
      "eventEndTime": "2037-01-01T08:00:00Z"
    },
    "debugKey": "my-custom-debug-key-001",
    "contentTitle": "IMA sample HLS live stream",
    "stitchingType": "STITCHED",
    "reportingType": "CLIENT",
    "interstitialEnabled": false
  },
  "slate": {
    "idType": "CREATIVE_ID",
    "idValue": "138544327419",
    "adSystem": "GDFP",
    "duration": "10s"
  },
  "adSelections": {
    "2021043961286562353": {
      "type": "VAST",
      "adRequest": {
        "adRequestKey": "2021043961286562353",
        "adTag": "https://pubads.g.doubleclick.net/gampad/live/ads?iu=/21775744923/external/vmap_ads_for_dai&cust_params=sample_ar%3Dstreammidonly&output=xml_vast4&pmxd=30000",
        "httpRequest": {
          "requestTime": "2026-10-16T19:59:57.177283526Z",
          "latency": "0.138s",
          "url": "https://pubads.g.doubleclick.net/gampad/live/ads?iu=/21775744923/external/vmap_ads_for_dai&cust_params=sample_ar%3Dstreammidonly&output=xml_vast4&pmxd=30000",
          "responseCode": 200,
          "responseBody": "<VAST version=\"4.0\"><Ad id=\"5937252921\" sequence=\"1\"><InLine><AdSystem>GDFP</AdSystem><AdTitle>External - Pod Midroll 1</AdTitle><Creatives><Creative id=\"138383221557\" sequence=\"1\"><Linear><Duration>00:00:10</Duration></Linear></Creative></Creatives></InLine></Ad></VAST>"
        },
        "childRequests": []
      }
    }
  },
  "adPods": {
    "9204525715521575580": {
      "requestedBreakType": "MIDROLL",
      "adRequestKey": "2021043961286562353",
      "prefetchStage": "DISABLED",
      "adBreakId": "-3821178632466845617",
      "label": "3196133",
      "creatives": {
        "6086226973783046639": {
          "idType": "GOOGLE_VIDEO_REGISTRY_ID",
          "idValue": "tVFdo4-fFVE",
          "adSystem": "GDFP",
          "duration": "10.010s",
          "podSequence": 1,
          "adBuffet": false,
          "vastInfos": [
            {
              "adSystem": "GDFP",
              "adTitle": "External - Pod Midroll 1",
              "creativeId": "138383221557"
            }
          ]
        }
      }
    }
  },
  "adBreaks": {
    "-3821178632466845617": {
      "podKeys": [
        "9204525715521575580"
      ],
      "adBreakId": "-3821178632466845617",
      "breakType": "MIDROLL",
      "breakSequence": "3196133",
      "servedAdsDuration": "30.999999999s",
      "executedBreakDuration": "30.999999999s",
      "linear": {
        "breakStartTime": "2026-10-16T20:22:28.130329Z",
        "expectedBreakDuration": "31s",
        "slateDuration": "0s",
        "underlyingDuration": "0s"
      },
      "trackingPings": {
        "3641994172850159057": {
          "originalTrackingEventId": "google_4445276280058090123",
          "request": {
            "requestTime": "2026-10-16T20:22:29.393993Z",
            "latency": "0.030s",
            "url": "https://dai.google.com/view/p/service/linear/impression/stream/1dccd632-5028-45be-a68a-6c90645cd237:ATL/network/21775744923/event/xDte1UxoSxmtRrB6lqHdmg/media/7083951761/stream_ad_id/EfzeSEQzFPU",
            "responseCode": 200
          }
        }
      }
    }
  },
  "findings": [
    {
      "severity": "INFO",
      "description": "Minimum slate inserted into underfilled ad break.",
      "slateFinding": {
        "type": "SLATE_STATUS_MINIMUM_INSERTED"
      }
    },
    {
      "severity": "INFO",
      "description": "Ad break was decisioned, but not served during playback.",
      "adBreakFinding": {
        "type": "UNSERVED_BREAK",
        "breakKey": "-3821178632466845617"
      }
    }
  ],
  "sessionDuration": "31.453022s"
}

Определив сеанс, вы можете запросить определенные поля сеанса в ресурсе DaiSession, перейти к ключам объектов из результатов сеанса или отправить последующие запросы к связанным ресурсам в Ad Manager API.

Как фильтровать поля сеанса с помощью масок полей

Полный ответ DaiSession включает необработанные тела XML VAST и VMAP, а также все события рекламных пауз. Чтобы уменьшить размер полезной нагрузки и получить только нужные поля сеанса, передайте маску чтения в параметре запроса fields или HTTP-заголовке X-Goog-FieldMask. Подробную информацию можно найти в статье Маски полей.

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

curl -X GET \
    "https://admanager.googleapis.com/v1/networks/NETWORK_CODE/daiSessions/SESSION_ID?fields=name,creationContext,findings" \
    -H "Authorization: Bearer OAUTH_TOKEN"

Чтобы получить только поля adBreaks и adPods, не скачивая необработанные XML-ответы объявлений в поле adSelections, используйте заголовок X-Goog-FieldMask:

curl -X GET \
    "https://admanager.googleapis.com/v1/networks/NETWORK_CODE/daiSessions/SESSION_ID" \
    -H "Authorization: Bearer OAUTH_TOKEN" \
    -H "X-Goog-FieldMask: name,adBreaks,adPods"

Просмотр результатов сеанса

Каждая запись в списке findings включает типизированный объект обнаружения с ключом, который указывает на определенный объект в ресурсе DaiSession. В таблице ниже показано, как сопоставить ключи поиска с полями сеанса.

Поиск пути к ключу Целевое местоположение в стране DaiSession
adBreakFinding.breakKey adBreaks[breakKey]
adRequestFinding.adSelectionKey, adRequestFinding.adRequestKey adSelections[adSelectionKey].adRequest и вложенный аккаунт childRequests[]
creativeFinding.creativeKey Сопоставить creativeKey с записями в adPods[podKey].creatives[creativeKey]
podFinding.podKey adPods[podKey]
slateFinding slate
trackingFinding.trackingPingKey Сопоставить trackingPingKey с записями в adBreaks[breakKey].trackingPings[trackingPingKey]

Чтобы отследить связи между коллекциями, выполните следующие действия:

  1. Начните с записи в массиве adBreaks.
  2. Прочитайте список podKeys, чтобы найти соответствующие записи в массиве adPods.
  3. Используйте поле adPod.adRequestKey в пакете, чтобы найти соответствующий объект AdRequest.adRequestKey в массиве adSelections.
  4. Проверьте исходный HTTP-запрос и ответ VAST в соответствующем объекте adRequest или вложенном массиве childRequests.

Запрос ресурсов трансляции и контента

Ресурс DaiSession содержит названия ресурсов, которые ссылаются на ресурсы livestream и content в Google Ad Manager API в конечной точке admanager.googleapis.com. Чтобы проверить конфигурацию потока и метаданные контента, вы можете отправлять HTTP-запросы GET к следующим ресурсам:

  • Ресурс LiveStream. Используйте значение поля creationContext.linearInfo.liveStream, чтобы вызвать метод networks.liveStreams.get.
  • Ресурс Content для видео по запросу. Используйте значение поля creationContext.vodInfo.content, чтобы вызвать метод networks.content.get.

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

curl -X GET \
    "https://admanager.googleapis.com/v1/networks/NETWORK_CODE/liveStreams/LIVE_STREAM_ID" \
    -H "Authorization: Bearer OAUTH_TOKEN"

Замените LIVE_STREAM_ID идентификатором трансляции из ресурса DaiSession.

Выходные данные будут выглядеть примерно так:

{
  "name": "networks/21775744923/liveStreams/20000016294786",
  "displayName": "IMA sample HLS live stream",
  "status": "ACTIVE",
  "createTime": "2020-06-09T20:00:07Z",
  "updateTime": "2026-08-18T15:37:05Z",
  "startTime": "2020-06-09T20:00:00Z",
  "endTime": "2037-01-01T08:00:00Z",
  "endTimeUnlimited": true,
  "contentUrls": [
    "https://contentsim.sandbox.google.com/content/590f95c5-c3ee-4a56-a10c-0cc660e91faa/linear/multivariant.m3u8"
  ],
  "adTags": [
    "https://pubads.g.doubleclick.net/gampad/live/ads?sz=640x480&output=xml_vast3&iu=/21775744923/external/vmap_ads_for_dai&env=vp&impl=s&gdfp_req=1&unviewed_position_start=1&ad_rule=0&cust_params=sample_ar%3Dstreammidonly&lseco=%%ASSET_KEY%%"
  ],
  "assetKey": "c-rArva4ShKVIAkNfy6HUQ",
  "slate": "networks/21775744923/slates/138544327419",
  "enableDaiAuthenticationKeys": false,
  "adBreakFillType": "SLATE",
  "underfillAdBreakFillType": "SLATE",
  "adHolidayDuration": "0s",
  "enableMaxFillerDuration": false,
  "enableDurationlessAdBreaks": false,
  "hlsSettings": {
    "playlistType": "LIVE",
    "masterPlaylistSettings": {
      "refreshType": "AUTOMATIC"
    }
  },
  "allowlistedIpsEnabled": false,
  "dynamicAdInsertionType": "LINEAR",
  "relativePlaylistDeliveryEnabled": false,
  "streamingFormat": "HLS",
  "prefetchEnabled": false,
  "forcedCueInEnabled": false,
  "shortSegmentDroppingEnabled": false,
  "adBreakMarkupTypesEnabled": false,
  "earlyBreakNotificationMultiBreakSchedulingEnabled": false,
  "dvrWindowDuration": "60s"
}