Korzystanie z narzędzia do monitorowania (aktywności w) transmisji na żywo API

Interfejs API monitora aktywności strumienia (SAM) dynamicznego wstawiania reklam (DAI) umożliwia pobieranie dzienników diagnostycznych i wyników wyświetlania sesji transmisji na żywo i wideo na żądanie (VOD).

Z tego przewodnika dowiesz się, jak skonfigurować uwierzytelnianie, pobrać zasób najwyższego poziomu DaiSession i poprosić o zasoby określone w polach sesji.

Wymagania wstępne

Aby korzystać z interfejsu SAM API, musisz mieć:

Poproś o zasób DaiSession

Aby sprawdzić sesję DAI, wyślij żądanie HTTP GET do punktu końcowego networks.daiSessions.get z identyfikatorem sesji DAI lub kluczem debugowania strumienia DAI.

Pobieranie zasobu DaiSession według identyfikatora

Gdy rejestrujesz sesję strumienia za pomocą pakietu IMA DAI SDK, interfejsu Full-service DAI API lub interfejsu Pod serving DAI API, Google DAI zwraca identyfikator sesji DAI.

W tym przykładzie pobieramy zasób DaiSession za pomocą identyfikatora sesji:

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

Zastąp te elementy:

  • NETWORK_CODE: kod sieci Google Ad Managera,
  • SESSION_ID: identyfikator sesji z dynamicznym wstawianiem reklam zwracany podczas tworzenia sesji strumienia.
  • OAUTH_TOKEN: Twój token dostępu OAuth 2.0.

Używanie klucza debugowania w sesji z dynamicznym wstawianiem reklam

Podczas rejestrowania sesji strumienia możesz przypisać niestandardowy klucz debugowania, używając parametru dai-sam-id lub sam_id w żądaniach VOD dotyczących wyświetlania bloków reklamowych. Ten klucz debugowania możesz przekazać bezpośrednio w ścieżce zasobu DaiSession.

W tym przykładzie pobierany jest zasób DaiSession za pomocą klucza debugowania:

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

Zastąp DEBUG_KEY niestandardowym kluczem debugowania określonym w żądaniu utworzenia strumienia.

Oba żądania zwracają odpowiedź JSON DaiSession zawierającą kontekst sesji, wybrane reklamy, bloki reklamowe, przerwy na reklamę i wyniki diagnostyki. Dane wyjściowe są podobne do tych:

{
  "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"
}

Po zidentyfikowaniu sesji możesz wysłać zapytanie o konkretne pola sesji w zasobie DaiSession, przejść do kluczy encji z wyników sesji lub wysłać kolejne żądania do przydatnych materiałów w interfejsie API Ad Managera.

Filtrowanie pól sesji za pomocą masek pól

Pełna odpowiedź DaiSession zawiera nieprzetworzone treści VAST i VMAP XML oraz wszystkie historyczne zdarzenia przerw. Aby zmniejszyć rozmiar ładunku i pobrać tylko potrzebne pola sesji, przekaż maskę odczytu w parametrze zapytania fields lub nagłówku HTTP X-Goog-FieldMask. Więcej informacji znajdziesz w artykule Maski pól.

Aby sprawdzić, czy podczas sesji wystąpiły błędy, poproś tylko o kontekst utworzenia sesji i wyniki diagnostyki:

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

Aby pobrać tylko pola adBreaks i adPods bez pobierania nieprzetworzonych odpowiedzi na reklamy XML w polu adSelections, użyj nagłówka 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"

Sprawdzanie wyników sesji

Każdy wpis na liście findings zawiera obiekt wyniku z typem i kluczem, który wskazuje konkretną encję w zasobie DaiSession. W tabeli poniżej pokazujemy, jak rozwiązać problem z kluczami ustaleń w polach sesji:

Znajdowanie ścieżki klucza Lokalizacja docelowa: DaiSession
adBreakFinding.breakKey adBreaks[breakKey]
adRequestFinding.adSelectionKey, adRequestFinding.adRequestKey adSelections[adSelectionKey].adRequest i zagnieżdżone childRequests[]
creativeFinding.creativeKey Dopasuj creativeKey do wpisów w: adPods[podKey].creatives[creativeKey]
podFinding.podKey adPods[podKey]
slateFinding slate
trackingFinding.trackingPingKey Dopasuj trackingPingKey do wpisów w: adBreaks[breakKey].trackingPings[trackingPingKey]

Aby prześledzić relacje między kolekcjami, wykonaj te czynności:

  1. Zacznij od wpisu w tablicy adBreaks.
  2. Przeczytaj listę podKeys, aby znaleźć odpowiednie wpisy w tablicy adPods.
  3. Użyj pola adPod.adRequestKey w podzie, aby znaleźć pasujący element AdRequest.adRequestKey w tablicy adSelections.
  4. Sprawdź początkowe żądanie HTTP i odpowiedź VAST w pasującym obiekcie adRequest lub jego zagnieżdżonej tablicy childRequests.

Żądanie zasobów transmisji na żywo i treści

Zasób DaiSession zawiera nazwy zasobów, które prowadzą do zasobów livestream i content w interfejsie Google Ad Manager API w punkcie końcowym admanager.googleapis.com. Aby sprawdzić konfigurację strumienia i metadane treści, możesz wysyłać żądania HTTP GET do tych zasobów:

  • Zasób LiveStream: użyj wartości pola creationContext.linearInfo.liveStream, aby wywołać metodę networks.liveStreams.get.
  • Zasób VOD Content: użyj wartości pola creationContext.vodInfo.content, aby wywołać metodę networks.content.get.

Ten przykład pobiera połączony zasób LiveStream, do którego odwołuje się pole creationContext.linearInfo.liveStream:

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

Zastąp LIVE_STREAM_ID identyfikatorem transmisji na żywo w zasobie DaiSession.

Dane wyjściowe są podobne do tych:

{
  "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"
}