API خطی درج آگهی پویا

API درج آگهی پویا به شما امکان می‌دهد تا جریان‌های خطی (LIVE) DAI را درخواست و پیگیری کنید.

خدمات: dai.google.com

همه URI های زیر مربوط به https://dai.google.com هستند

روش: جریان

درخواست HTTP

POST https://dai.google.com/linear/v1/hls/event/{assetKey}/stream

هدر درخواست

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

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

درخواست بدن

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

بدن پاسخگو

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

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

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

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

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

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

درخواست HTTP

GET https://{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_" شروع می شود.

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

روش: فراداده

نقطه پایانی فراداده در metadata_url اطلاعاتی را که برای ساختن یک رابط کاربری تبلیغاتی استفاده شده است، برمی گرداند. نقطه پایانی فراداده برای جریان‌های نشان‌دهنده سمت سرور در دسترس نیست، جایی که سرور مسئول شروع تأیید رسانه آگهی است.

درخواست HTTP

GET https://{metadata_url}/{ad-media-id}

GET https://{metadata_url}

بدن پاسخگو

در صورت موفقیت آمیز بودن، پاسخ نمونه ای از PodMetadata را برمی گرداند.

کار با متادیتا

ابرداده دارای سه بخش مجزا است: tags ، ads و breaks تبلیغاتی. نقطه ورود به داده ها بخش tags است. از آنجا، تگ ها را تکرار کنید و اولین ورودی را پیدا کنید که نام آن پیشوندی برای شناسه رسانه تبلیغاتی موجود در جریان ویدئو است. برای مثال، ممکن است یک شناسه رسانه تبلیغاتی داشته باشید که به شکل زیر است:

google_1234567890

سپس یک شیء برچسب به نام google_12345 را پیدا می کنید. در این مورد، با شناسه رسانه تبلیغاتی شما مطابقت دارد. هنگامی که شی پیشوند رسانه تبلیغاتی درست را پیدا کردید، می‌توانید شناسه‌های تبلیغات، شناسه‌های استراحت آگهی و نوع رویداد را جستجو کنید. سپس از شناسه‌های تبلیغاتی برای نمایه‌سازی اشیاء ads و شناسه‌های وقفه تبلیغاتی برای نمایه‌سازی اشیاء breaks استفاده می‌شود.

داده های پاسخ

جریان

{
  "stream_id": string,
  "stream_manifest": string,
  "hls_master_playlist": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "polling_frequency": number,
}

PodMetadata

{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}

TagSegment

{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}

AdBreak

{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}

آگهی

{
  "ad_break_id": string,
  "position": 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,
  "click_tracking_urls": [],
  "verifications": [object(Verification)],
  "slate": boolean,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "universal_ad_id": object(UniversalAdID),
  "extensions": [],
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
}

نماد

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