API VOD درج آگهی پویا

API درج آگهی پویا به شما امکان می‌دهد تا جریان‌های ویدیوی بر اساس تقاضا (VOD) DAI را درخواست و ردیابی کنید. جریان های HLS و DASH پشتیبانی می شوند.

خدمات: dai.google.com

مسیر روش stream نسبت به https://dai.google.com است

روش: جریان

درخواست HTTP

POST https://dai.google.com/ondemand/v1/hls/content/{content-source}/vid/{video-id}/stream

POST https://dai.google.com/ondemand/v1/dash/content/{content-source}/vid/{video-id}/stream

هدر درخواست

Authorization: DCLKDAI key="<api-key>"

پارامترهای مسیر

درخواست بدن

بدنه درخواست از نوع application/x-www-form-urlencoded است و شامل پارامترهای زیر است:

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی یک Stream جدید است. برای جریان‌های beaconing سمت سرور، این Stream فقط شامل فیلدهای stream_id و stream_manifest است.

باز کردن اندازه‌گیری

فیلد Verifications حاوی اطلاعاتی برای تأیید اندازه‌گیری باز برای جریان‌های چراغ‌گردان غیر از سمت سرور است. Verifications حاوی یک یا چند عنصر Verification است که منابع و ابرداده‌هایی را که برای تأیید پخش خلاقانه با کد اندازه‌گیری شخص ثالث نیاز دارید، فهرست می‌کنند. فقط JavaScriptResource پشتیبانی می شود. برای اطلاعات بیشتر، لطفاً به آزمایشگاه فناوری IAB و مشخصات VAST 4.1 مراجعه کنید.

روش: تایید رسانه ای

پس از اینکه در حین پخش با یک شناسه رسانه تبلیغاتی مواجه شدید، فوراً با استفاده از media_verification_url از نقطه پایانی stream درخواستی ارائه دهید. media_verification_url یک مسیر مطلق است. درخواست‌های تأیید رسانه برای جریان‌های نشان‌دهنده سمت سرور، جایی که سرور تأیید رسانه را آغاز می‌کند، ضروری نیست.

درخواست‌ها به نقطه پایانی media verification بی‌توان هستند.

درخواست HTTP

GET {media-verification-url}/{ad-media-id}

بدن پاسخگو

media verification پاسخ‌های زیر را برمی‌گرداند:

• HTTP/1.1 204 No Content .
• HTTP/1.1 404 Not Found اگر درخواست نمی تواند رسانه را به دلیل قالب بندی نادرست URL یا انقضا تأیید کند.
• اگر درخواست تأیید قبلی برای این شناسه موفقیت آمیز بود، HTTP/1.1 404 Not Found .
• HTTP/1.1 409 Conflict .

شناسه‌های رسانه آگهی (HLS)

شناسه‌های رسانه تبلیغاتی با استفاده از کلید TXXX که برای قاب‌های «اطلاعات متنی تعریف‌شده توسط کاربر» رزرو شده، در فراداده‌های زمان‌بندی شده HLS کدگذاری می‌شوند. محتویات قاب رمزگذاری نشده خواهد بود و همیشه با متن "google_" شروع می شود.

برای هر درخواست تأیید آگهی، کل محتوای متن قاب باید به media_verification_url اضافه شود.

شناسه‌های رسانه آگهی (DASH)

شناسه‌های رسانه تبلیغاتی با استفاده از عنصر EventStream در DASH در مانیفست درج می‌شوند.

هر EventStream دارای URI Scheme ID urn:google:dai:2018 خواهد بود. آنها حاوی رویدادهایی با ویژگی messageData هستند که حاوی شناسه رسانه تبلیغاتی است که با “google_” شروع می شود. کل محتوای ویژگی messageData باید برای هر درخواست تأیید آگهی به media_verification_url اضافه شود.

داده های پاسخ

جریان

{
  "stream_id": string,
  "total_duration": number,
  "content_duration": number,
  "valid_for": string,
  "valid_until": string,
  "subtitles": [object(Subtitle)],
  "hls_master_playlist": string,
  "stream_manifest": string,
  "media_verification_url": string,
  "apple_tv": object(AppleTV),
  "ad_breaks": [object(AdBreak)],
}

AppleTV

{
  "interstitials_url": string,
}

AdBreak

{
  "type": string,
  "start": number,
  "duration": number,
  "ads": [object(Ad)],
}

آگهی

{
  "seq": number,
  "start": number,
  "duration": number,
  "title": string,
  "description": string,
  "advertiser": string,
  "ad_system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
  "clickthrough_url": string,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "events": [object(Event)],
  "verifications": [object(Verification)],
  "universal_ad_id": object(UniversalAdID),
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
  "skip_metadata": object(SkipMetadata),
  "extensions": [],
}

رویداد

{
  "time": number,
  "type": string,
}

زیرنویس

{
  "language": string,
  "language_name": string,
  "ttml": string,
  "webvtt": string,
}

SkipMetadata

{
  "offset": number,
  "tracking_url": string,
}

نماد

{
  "click_data": object(ClickData),
  "creative_type": string,
  "click_fallback_images": [object(FallbackImage)],
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "x_position": string,
  "y_position": string,
  "program": string,
  "alt_text": string,
}

ClickData

{
  "url": string,
}

Fallback Image

{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}

لفاف

{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}

تأیید

{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}

JavaScriptResource

{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}

TrackingEvent

{
  "event": string,
  "uri": string,
}

UniversalAdID

{
  "id_value": string,
  "id_registry": string,
}

همراه

{
  "click_data": object(ClickData),
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "ad_slot_id": string,
  "api_framework": string,
  "tracking_events": [object(TrackingEvent)],
}

فایل تعاملی

{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}