DAI API در نسخه بتا است و ممکن است در شبکه شما در دسترس نباشد. برای اطلاعات بیشتر با مدیر حساب خود تماس بگیرید. IMA SDK برای پلتفرم هایی که در دسترس است توصیه می شود.

این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

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

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

سرویس: dai.google.com

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

روش: جریان

روش‌ها

روش‌ها
`stream`	`POST /ondemand/v1/hls/content/{content-source}/vid/{video-id}/stream` یک جریان HLS DAI برای منبع محتوای داده شده و شناسه ویدیو ایجاد می‌کند. `POST /ondemand/v1/dash/content/{content-source}/vid/{video-id}/stream` یک جریان DASH DAI برای منبع محتوای داده شده و شناسه ویدیو ایجاد می‌کند.

stream

POST /ondemand/v1/hls/content/{content-source}/vid/{video-id}/stream

یک جریان HLS DAI برای منبع محتوای داده شده و شناسه ویدیو ایجاد می‌کند.

POST /ondemand/v1/dash/content/{content-source}/vid/{video-id}/stream

یک جریان DASH DAI برای منبع محتوای داده شده و شناسه ویدیو ایجاد می‌کند.

درخواست 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

هدر درخواست

پارامترها

پارامترها
`api‑key`	`string` کلید API که هنگام ایجاد یک جریان ارائه می‌شود، باید برای شبکه ناشر معتبر باشد. به جای ارائه آن در بدنه درخواست، کلید API می‌تواند در هدر HTTP Authorization با فرمت زیر ارسال شود: Authorization: DCLKDAI key="<api-key>"

api‑key

string

کلید API که هنگام ایجاد یک جریان ارائه می‌شود، باید برای شبکه ناشر معتبر باشد.

به جای ارائه آن در بدنه درخواست، کلید API می‌تواند در هدر HTTP Authorization با فرمت زیر ارسال شود:

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

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

پارامترها
`content-source`	`string` شناسه CMS جریان.
`video-id`	`string` شناسه ویدیوی پخش زنده.

درخواست بدنه

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

پارامترها
`dai-ssb`	اختیاری	برای ایجاد یک جریان سیگنال‌دهی سمت سرور، روی `true` تنظیم کنید. مقدار پیش‌فرض `false` است. ردیابی جریان پیش‌فرض توسط کلاینت آغاز شده و در سمت سرور پینگ می‌شود.
پارامترهای هدف‌گیری DFP	اختیاری	پارامترهای هدف‌گذاری اضافی
پارامترهای جریان را نادیده بگیرید	اختیاری	مقادیر پیش‌فرض پارامتر ایجاد جریان را نادیده می‌گیرد.
احراز هویت HMAC	اختیاری	با استفاده از یک توکن مبتنی بر HMAC احراز هویت کنید.

بدنه پاسخ

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

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

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

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

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

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

روش‌ها
`media verification`	`GET {media_verification_url}/{ad_media_id}` API را از یک رویداد تأیید رسانه مطلع می‌کند.

درخواست HTTP

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

بدنه پاسخ

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

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

شناسه‌های رسانه‌های تبلیغاتی (HLS)

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

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

شناسه‌های رسانه‌های تبلیغاتی (DASH)

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

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

داده‌های پاسخ

جریان

از Stream برای رندر کردن لیستی از تمام منابع یک Stream تازه ایجاد شده در قالب JSON استفاده می‌شود.

نمایش JSON
{ "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)], }

نمایش JSON

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

فیلدها
`stream_id`	`string` شناسه جریان.
`total_duration`	`number` مدت زمان پخش جریانی (استریم) بر حسب ثانیه.
`content_duration`	`number` مدت زمان محتوا، بدون تبلیغات، بر حسب ثانیه.
`valid_for`	`string` مدت زمان پخش زنده با فرمت "00h00m00s" معتبر است.
`valid_until`	`string` تاریخ اعتبار جریان تا، با فرمت RFC 3339.
`subtitles`	`[object(Subtitle)]` فهرستی از زیرنویس‌ها. در صورت خالی بودن، حذف می‌شود. فقط HLS.
`hls_master_playlist`	`string` (منسوخ شده) آدرس لیست پخش اصلی HLS. از stream_manifest استفاده کنید. فقط HLS.
`stream_manifest`	`string` مانیفست استریم. مربوط به لیست پخش اصلی در HLS و MPD در DASH است. این تنها فیلدی است که علاوه بر "stream_id" هنگام ایجاد یک استریم beaconing سمت سرور، در پاسخ وجود دارد.
`media_verification_url`	`string` آدرس اینترنتی تأیید رسانه.
`apple_tv`	`object(AppleTV)` اطلاعات اختیاری مختص دستگاه‌های AppleTV. فقط HLS.
`ad_breaks`	`[object(AdBreak)]` فهرستی از AdBreakها. در صورت خالی بودن، حذف می‌شود.

اپل تی‌وی

AppleTV حاوی اطلاعات خاص دستگاه‌های Apple TV است.

نمایش JSON
{ "interstitials_url": string, }

فیلدها
`interstitials_url`	`string` آدرس اینترنتی تبلیغات بینابینی.

ادبریک

AdBreak یک تبلیغ واحد را در جریان نمایش توصیف می‌کند. این تبلیغ شامل موقعیت، مدت زمان، نوع (میانه/قبل/بعد) و لیستی از تبلیغات است.

نمایش JSON
{ "type": string, "start": number, "duration": number, "ads": [object(Ad)], }

فیلدها
`type`	`string` انواع معتبر استراحت عبارتند از: اواسط، قبل و بعد.
`start`	`number` موقعیتی در جریان که شکست از آن شروع می‌شود، بر حسب ثانیه.
`duration`	`number` مدت زمان پخش آگهی، بر حسب ثانیه.
`ads`	`[object(Ad)]` فهرستی از تبلیغات. در صورت خالی بودن، حذف می‌شود.

آگهی

Ad یک تبلیغ را در جریان توصیف می‌کند. این شامل موقعیت تبلیغ در وقفه، مدت زمان تبلیغ و برخی فراداده‌های اختیاری است.

نمایش JSON
{ "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": [], }

نمایش JSON

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

فیلدها
`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)]` فهرستی از Wrapperها. در صورت خالی بودن، حذف می‌شود.
`events`	`[object(Event)]` فهرستی از رویدادهای موجود در آگهی.
`verifications`	`[object(Verification)]` ورودی‌های تأیید اندازه‌گیری باز اختیاری که منابع و فراداده‌های مورد نیاز برای اجرای کد اندازه‌گیری شخص ثالث را برای تأیید پخش خلاقانه فهرست می‌کنند.
`universal_ad_id`	`object(UniversalAdID)` شناسه تبلیغ جهانی اختیاری.
`companions`	`[object(Companion)]` همراهان اختیاری که ممکن است همراه با این تبلیغ نمایش داده شوند.
`interactive_file`	`object(InteractiveFile)` خلاقیت تعاملی اختیاری (SIMID) که باید هنگام پخش تبلیغ نمایش داده شود.
`skip_metadata`	`object(SkipMetadata)` فراداده اختیاری برای تبلیغات قابل رد شدن. در صورت تنظیم، این نشان می‌دهد که تبلیغ قابل رد شدن است و شامل دستورالعمل‌هایی برای نحوه مدیریت رابط کاربری رد شدن و رویداد ردیابی است.
`extensions`	`string` لیست اختیاری تمام گره‌های <Extension> در VAST.

رویداد

رویداد شامل نوع رویداد و زمان ارائه آن است.

نمایش JSON
{ "time": number, "type": string, }

فیلدها
`time`	`number` زمان ارائه این رویداد.
`type`	`string` نوع این رویداد.

زیرنویس

Subtitle یک آهنگ زیرنویس sidecar را برای جریان ویدیو توصیف می‌کند. این دو فرمت زیرنویس را ذخیره می‌کند: TTML و WebVTT. ویژگی TTMLPath حاوی URL به فایل sidecar TTML است و ویژگی WebVTTPath به طور مشابه حاوی URL به فایل sidecar WebVTT است.

نمایش JSON
{ "language": string, "language_name": string, "ttml": string, "webvtt": string, }

فیلدها
`language`	`string` یک کد زبان، مانند «en» یا «de».
`language_name`	`string` نام توصیفی زبان. اگر چندین مجموعه زیرنویس برای یک زبان وجود داشته باشد، این نام، مجموعه خاص زیرنویس‌ها را متمایز می‌کند.
`ttml`	`string` آدرس اینترنتی (URL) اختیاری به فایل TTML sidecar.
`webvtt`	`string` آدرس اینترنتی (URL) اختیاری به فایل کناری WebVTT.

پرش از فراداده

SkipMetadata اطلاعات لازم برای مدیریت رویدادهای رد شدن برای تبلیغات قابل رد شدن را در اختیار کلاینت‌ها قرار می‌دهد.

نمایش JSON
{ "offset": number, "tracking_url": string, }

فیلدها
`offset`	`number` آفست (Offset) نشان دهنده مدت زمانی بر حسب ثانیه در تبلیغ است که بازیکن باید منتظر بماند تا دکمه رد شدن نمایش داده شود. اگر در VAST ارائه نشده باشد، حذف می‌شود.
`tracking_url`	`string` TrackingURL حاوی یک URL است که باید در رویداد skip پینگ شود.

آیکون

آیکون حاوی اطلاعاتی در مورد یک آیکون VAST است.

نمایش JSON
{ "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, }

نمایش JSON

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

فیلدها
`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 حاوی اطلاعاتی در مورد میزان کلیک روی یک آیکون است.

نمایش JSON
{ "url": string, }

فیلدها
`url`	`string`

تصویر جایگزین

FallbackImage حاوی اطلاعاتی در مورد یک تصویر پشتیبان VAST است.

نمایش JSON
{ "creative_type": string, "height": int32, "width": int32, "resource": string, "alt_text": string, }

فیلدها
`creative_type`	`string`
`height`	`int32`
`width`	`int32`
`resource`	`string`
`alt_text`	`string`

بسته بندی

Wrapper حاوی اطلاعاتی در مورد یک آگهی wrapper است. اگر شناسه معامله وجود نداشته باشد، شامل آن نمی‌شود.

نمایش JSON
{ "system": string, "ad_id": string, "creative_id": string, "creative_ad_id": string, "deal_id": string, }

فیلدها
`system`	`string` شناسه سیستم تبلیغاتی
`ad_id`	`string` شناسه تبلیغ برای تبلیغ بسته‌بندی استفاده می‌شود.
`creative_id`	`string` شناسه خلاقانه‌ای که برای تبلیغ بسته‌بندی استفاده شده است.
`creative_ad_id`	`string` شناسه تبلیغاتی خلاقانه که برای تبلیغ بسته‌بندی استفاده شده است.
`deal_id`	`string` شناسه معامله اختیاری برای آگهی بسته بندی.

تأیید

تأیید شامل اطلاعاتی برای اندازه‌گیری باز است که قابلیت مشاهده و اندازه‌گیری تأیید توسط اشخاص ثالث را تسهیل می‌کند. در حال حاضر، فقط منابع جاوا اسکریپت پشتیبانی می‌شوند. به https://iabtechlab.com/standards/open-measurement-sdk/ مراجعه کنید.

نمایش JSON
{ "vendor": string, "java_script_resources": [object(JavaScriptResource)], "tracking_events": [object(TrackingEvent)], "parameters": string, }

فیلدها
`vendor`	`string` فروشنده تأیید هویت.
`java_script_resources`	`[object(JavaScriptResource)]` فهرست منابع جاوا اسکریپت برای تأیید.
`tracking_events`	`[object(TrackingEvent)]` فهرست رویدادهای ردیابی برای تأیید.
`parameters`	`string` یک رشته‌ی مبهم که به کد تأیید بوت‌استرپ ارسال می‌شود.

جاوااسکریپت

JavaScriptResource شامل اطلاعاتی برای تأیید از طریق جاوا اسکریپت است.

نمایش JSON
{ "script_url": string, "api_framework": string, "browser_optional": boolean, }

فیلدها
`script_url`	`string` URI به محتوای جاوا اسکریپت.
`api_framework`	`string` APIFramework نام چارچوب ویدیویی است که کد تأیید را اعمال می‌کند.
`browser_optional`	`boolean` آیا این اسکریپت می‌تواند خارج از مرورگر اجرا شود؟

رویداد ردیابی

TrackingEvent شامل URLهایی است که باید در شرایط خاص توسط کلاینت پینگ شوند.

نمایش JSON
{ "event": string, "uri": string, }

فیلدها
`event`	`string` نوع رویداد ردیابی.
`uri`	`string` رویداد ردیابی که قرار است پینگ شود.

یونیورسال اد آی دی

UniversalAdID برای ارائه یک شناسه خلاقانه منحصر به فرد که در سراسر سیستم‌های تبلیغاتی حفظ می‌شود، استفاده می‌شود.

نمایش JSON
{ "id_value": string, "id_registry": string, }

فیلدها
`id_value`	`string` شناسه جهانی تبلیغ مربوط به طرح تبلیغاتی انتخاب شده برای تبلیغ.
`id_registry`	`string` رشته‌ای که برای شناسایی نشانی اینترنتی وب‌سایت ثبت آگهی استفاده می‌شود، جایی که شناسه جهانی آگهی خلاق انتخاب‌شده در آن فهرست‌بندی شده است.

همراه

«همراه» حاوی اطلاعاتی برای تبلیغات همراه است که ممکن است همراه با تبلیغ نمایش داده شوند.

نمایش JSON
{ "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)], }

نمایش JSON

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

فیلدها
`click_data`	`object(ClickData)` داده‌های کلیک برای این همراه.
`creative_type`	`string` ویژگی CreativeType در گره <StaticResource> در VAST، اگر این یک همراه از نوع استاتیک باشد.
`height`	`int32` ارتفاع این همراه بر حسب پیکسل.
`width`	`int32` عرض این همراه بر حسب پیکسل.
`resource`	`string` برای همراهان استاتیک و iframe، این URL ای خواهد بود که بارگذاری و نمایش داده می‌شود. برای همراهان HTML، این قطعه HTML خواهد بود که باید به عنوان همراه نشان داده شود.
`type`	`string` نوع این همراه. می‌تواند استاتیک، iframe یا HTML باشد.
`ad_slot_id`	`string` شناسه اسلات برای این همراه.
`api_framework`	`string` چارچوب API برای این همراه.
`tracking_events`	`[object(TrackingEvent)]` فهرست رویدادهای ردیابی برای این همراه.

فایل تعاملی

InteractiveFile حاوی اطلاعاتی برای خلاقیت تعاملی (یعنی SIMID) است که باید هنگام پخش تبلیغ نمایش داده شود.

نمایش JSON
{ "resource": string, "type": string, "variable_duration": boolean, "ad_parameters": string, }

فیلدها
`resource`	`string` آدرس اینترنتی (URL) مربوط به محتوای خلاقانه تعاملی.
`type`	`string` نوع MIME فایل ارائه شده به عنوان منبع.
`variable_duration`	`boolean` اینکه آیا این طرح خلاقانه می‌تواند درخواست تمدید مدت زمان را داشته باشد یا خیر.
`ad_parameters`	`string` مقدار گره <AdParameters> در VAST.

سرویس: dai.google.com

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

روش: جریان

روش‌ها

روش‌ها
`stream`	`POST /ondemand/v1/hls/content/{content-source}/vid/{video-id}/stream` یک جریان HLS DAI برای منبع محتوای داده شده و شناسه ویدیو ایجاد می‌کند. `POST /ondemand/v1/dash/content/{content-source}/vid/{video-id}/stream` یک جریان DASH DAI برای منبع محتوای داده شده و شناسه ویدیو ایجاد می‌کند.

stream

POST /ondemand/v1/hls/content/{content-source}/vid/{video-id}/stream

یک جریان HLS DAI برای منبع محتوای داده شده و شناسه ویدیو ایجاد می‌کند.

POST /ondemand/v1/dash/content/{content-source}/vid/{video-id}/stream

یک جریان DASH DAI برای منبع محتوای داده شده و شناسه ویدیو ایجاد می‌کند.

درخواست 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

هدر درخواست

پارامترها

پارامترها
`api‑key`	`string` کلید API که هنگام ایجاد یک جریان ارائه می‌شود، باید برای شبکه ناشر معتبر باشد. به جای ارائه آن در بدنه درخواست، کلید API می‌تواند در هدر HTTP Authorization با فرمت زیر ارسال شود: Authorization: DCLKDAI key="<api-key>"

api‑key

string

کلید API که هنگام ایجاد یک جریان ارائه می‌شود، باید برای شبکه ناشر معتبر باشد.

به جای ارائه آن در بدنه درخواست، کلید API می‌تواند در هدر HTTP Authorization با فرمت زیر ارسال شود:

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

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

پارامترها
`content-source`	`string` شناسه CMS جریان.
`video-id`	`string` شناسه ویدیوی پخش زنده.

درخواست بدنه

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

پارامترها
`dai-ssb`	اختیاری	برای ایجاد یک جریان سیگنال‌دهی سمت سرور، روی `true` تنظیم کنید. مقدار پیش‌فرض `false` است. ردیابی جریان پیش‌فرض توسط کلاینت آغاز شده و در سمت سرور پینگ می‌شود.
پارامترهای هدف‌گیری DFP	اختیاری	پارامترهای هدف‌گذاری اضافی
پارامترهای جریان را نادیده بگیرید	اختیاری	مقادیر پیش‌فرض پارامتر ایجاد جریان را نادیده می‌گیرد.
احراز هویت HMAC	اختیاری	با استفاده از یک توکن مبتنی بر HMAC احراز هویت کنید.

بدنه پاسخ

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

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

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

روش‌ها
`media verification`	`GET {media_verification_url}/{ad_media_id}` API را از یک رویداد تأیید رسانه مطلع می‌کند.

درخواست HTTP

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

بدنه پاسخ

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

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

شناسه‌های رسانه‌های تبلیغاتی (HLS)

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

شناسه‌های رسانه‌های تبلیغاتی (DASH)

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

داده‌های پاسخ

جریان

از Stream برای رندر کردن لیستی از تمام منابع یک Stream تازه ایجاد شده در قالب JSON استفاده می‌شود.

نمایش JSON
{ "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)], }

نمایش JSON

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

فیلدها
`stream_id`	`string` شناسه جریان.
`total_duration`	`number` مدت زمان پخش جریانی (استریم) بر حسب ثانیه.
`content_duration`	`number` مدت زمان محتوا، بدون تبلیغات، بر حسب ثانیه.
`valid_for`	`string` مدت زمان پخش زنده با فرمت "00h00m00s" معتبر است.
`valid_until`	`string` تاریخ اعتبار جریان تا، با فرمت RFC 3339.
`subtitles`	`[object(Subtitle)]` فهرستی از زیرنویس‌ها. در صورت خالی بودن، حذف می‌شود. فقط HLS.
`hls_master_playlist`	`string` (منسوخ شده) آدرس لیست پخش اصلی HLS. از stream_manifest استفاده کنید. فقط HLS.
`stream_manifest`	`string` مانیفست استریم. مربوط به لیست پخش اصلی در HLS و MPD در DASH است. این تنها فیلدی است که علاوه بر "stream_id" هنگام ایجاد یک استریم beaconing سمت سرور، در پاسخ وجود دارد.
`media_verification_url`	`string` آدرس اینترنتی تأیید رسانه.
`apple_tv`	`object(AppleTV)` اطلاعات اختیاری مختص دستگاه‌های AppleTV. فقط HLS.
`ad_breaks`	`[object(AdBreak)]` فهرستی از AdBreakها. در صورت خالی بودن، حذف می‌شود.

اپل تی‌وی

AppleTV حاوی اطلاعات خاص دستگاه‌های Apple TV است.

نمایش JSON
{ "interstitials_url": string, }

فیلدها
`interstitials_url`	`string` آدرس اینترنتی تبلیغات بینابینی.

ادبریک

نمایش JSON
{ "type": string, "start": number, "duration": number, "ads": [object(Ad)], }

فیلدها
`type`	`string` انواع معتبر استراحت عبارتند از: اواسط، قبل و بعد.
`start`	`number` موقعیتی در جریان که شکست از آن شروع می‌شود، بر حسب ثانیه.
`duration`	`number` مدت زمان پخش آگهی، بر حسب ثانیه.
`ads`	`[object(Ad)]` فهرستی از تبلیغات. در صورت خالی بودن، حذف می‌شود.

آگهی

نمایش JSON

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

فیلدها
`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)]` فهرستی از Wrapperها. در صورت خالی بودن، حذف می‌شود.
`events`	`[object(Event)]` فهرستی از رویدادهای موجود در آگهی.
`verifications`	`[object(Verification)]` ورودی‌های تأیید اندازه‌گیری باز اختیاری که منابع و فراداده‌های مورد نیاز برای اجرای کد اندازه‌گیری شخص ثالث را برای تأیید پخش خلاقانه فهرست می‌کنند.
`universal_ad_id`	`object(UniversalAdID)` شناسه تبلیغ جهانی اختیاری.
`companions`	`[object(Companion)]` همراهان اختیاری که ممکن است همراه با این تبلیغ نمایش داده شوند.
`interactive_file`	`object(InteractiveFile)` خلاقیت تعاملی اختیاری (SIMID) که باید هنگام پخش تبلیغ نمایش داده شود.
`skip_metadata`	`object(SkipMetadata)` فراداده اختیاری برای تبلیغات قابل رد شدن. در صورت تنظیم، این نشان می‌دهد که تبلیغ قابل رد شدن است و شامل دستورالعمل‌هایی برای نحوه مدیریت رابط کاربری رد شدن و رویداد ردیابی است.
`extensions`	`string` لیست اختیاری تمام گره‌های <Extension> در VAST.

رویداد

رویداد شامل نوع رویداد و زمان ارائه آن است.

نمایش JSON
{ "time": number, "type": string, }

فیلدها
`time`	`number` زمان ارائه این رویداد.
`type`	`string` نوع این رویداد.

زیرنویس

نمایش JSON
{ "language": string, "language_name": string, "ttml": string, "webvtt": string, }

فیلدها
`language`	`string` یک کد زبان، مانند «en» یا «de».
`language_name`	`string` نام توصیفی زبان. اگر چندین مجموعه زیرنویس برای یک زبان وجود داشته باشد، این نام، مجموعه خاص زیرنویس‌ها را متمایز می‌کند.
`ttml`	`string` آدرس اینترنتی (URL) اختیاری به فایل TTML sidecar.
`webvtt`	`string` آدرس اینترنتی (URL) اختیاری به فایل کناری WebVTT.

پرش از فراداده

نمایش JSON
{ "offset": number, "tracking_url": string, }

فیلدها
`offset`	`number` آفست (Offset) نشان دهنده مدت زمانی بر حسب ثانیه در تبلیغ است که بازیکن باید منتظر بماند تا دکمه رد شدن نمایش داده شود. اگر در VAST ارائه نشده باشد، حذف می‌شود.
`tracking_url`	`string` TrackingURL حاوی یک URL است که باید در رویداد skip پینگ شود.

آیکون

آیکون حاوی اطلاعاتی در مورد یک آیکون VAST است.

نمایش JSON

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

فیلدها
`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 حاوی اطلاعاتی در مورد میزان کلیک روی یک آیکون است.

نمایش JSON
{ "url": string, }

فیلدها
`url`	`string`

تصویر جایگزین

FallbackImage حاوی اطلاعاتی در مورد یک تصویر پشتیبان VAST است.

نمایش JSON
{ "creative_type": string, "height": int32, "width": int32, "resource": string, "alt_text": string, }

فیلدها
`creative_type`	`string`
`height`	`int32`
`width`	`int32`
`resource`	`string`
`alt_text`	`string`

بسته بندی

Wrapper حاوی اطلاعاتی در مورد یک آگهی wrapper است. اگر شناسه معامله وجود نداشته باشد، شامل آن نمی‌شود.

نمایش JSON
{ "system": string, "ad_id": string, "creative_id": string, "creative_ad_id": string, "deal_id": string, }

فیلدها
`system`	`string` شناسه سیستم تبلیغاتی
`ad_id`	`string` شناسه تبلیغ برای تبلیغ بسته‌بندی استفاده می‌شود.
`creative_id`	`string` شناسه خلاقانه‌ای که برای تبلیغ بسته‌بندی استفاده شده است.
`creative_ad_id`	`string` شناسه تبلیغاتی خلاقانه که برای تبلیغ بسته‌بندی استفاده شده است.
`deal_id`	`string` شناسه معامله اختیاری برای آگهی بسته بندی.

تأیید

نمایش JSON
{ "vendor": string, "java_script_resources": [object(JavaScriptResource)], "tracking_events": [object(TrackingEvent)], "parameters": string, }

فیلدها
`vendor`	`string` فروشنده تأیید هویت.
`java_script_resources`	`[object(JavaScriptResource)]` فهرست منابع جاوا اسکریپت برای تأیید.
`tracking_events`	`[object(TrackingEvent)]` فهرست رویدادهای ردیابی برای تأیید.
`parameters`	`string` یک رشته‌ی مبهم که به کد تأیید بوت‌استرپ ارسال می‌شود.

جاوااسکریپت

JavaScriptResource شامل اطلاعاتی برای تأیید از طریق جاوا اسکریپت است.

نمایش JSON
{ "script_url": string, "api_framework": string, "browser_optional": boolean, }

فیلدها
`script_url`	`string` URI به محتوای جاوا اسکریپت.
`api_framework`	`string` APIFramework نام چارچوب ویدیویی است که کد تأیید را اعمال می‌کند.
`browser_optional`	`boolean` آیا این اسکریپت می‌تواند خارج از مرورگر اجرا شود؟

رویداد ردیابی

TrackingEvent شامل URLهایی است که باید در شرایط خاص توسط کلاینت پینگ شوند.

نمایش JSON
{ "event": string, "uri": string, }

فیلدها
`event`	`string` نوع رویداد ردیابی.
`uri`	`string` رویداد ردیابی که قرار است پینگ شود.

یونیورسال اد آی دی

UniversalAdID برای ارائه یک شناسه خلاقانه منحصر به فرد که در سراسر سیستم‌های تبلیغاتی حفظ می‌شود، استفاده می‌شود.

نمایش JSON
{ "id_value": string, "id_registry": string, }

فیلدها
`id_value`	`string` شناسه جهانی تبلیغ مربوط به طرح تبلیغاتی انتخاب شده برای تبلیغ.
`id_registry`	`string` رشته‌ای که برای شناسایی نشانی اینترنتی وب‌سایت ثبت آگهی استفاده می‌شود، جایی که شناسه جهانی آگهی خلاق انتخاب‌شده در آن فهرست‌بندی شده است.

همراه

«همراه» حاوی اطلاعاتی برای تبلیغات همراه است که ممکن است همراه با تبلیغ نمایش داده شوند.

نمایش JSON

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

فیلدها
`click_data`	`object(ClickData)` داده‌های کلیک برای این همراه.
`creative_type`	`string` ویژگی CreativeType در گره <StaticResource> در VAST، اگر این یک همراه از نوع استاتیک باشد.
`height`	`int32` ارتفاع این همراه بر حسب پیکسل.
`width`	`int32` عرض این همراه بر حسب پیکسل.
`resource`	`string` برای همراهان استاتیک و iframe، این URL ای خواهد بود که بارگذاری و نمایش داده می‌شود. برای همراهان HTML، این قطعه HTML خواهد بود که باید به عنوان همراه نشان داده شود.
`type`	`string` نوع این همراه. می‌تواند استاتیک، iframe یا HTML باشد.
`ad_slot_id`	`string` شناسه اسلات برای این همراه.
`api_framework`	`string` چارچوب API برای این همراه.
`tracking_events`	`[object(TrackingEvent)]` فهرست رویدادهای ردیابی برای این همراه.

فایل تعاملی

InteractiveFile حاوی اطلاعاتی برای خلاقیت تعاملی (یعنی SIMID) است که باید هنگام پخش تبلیغ نمایش داده شود.

نمایش JSON
{ "resource": string, "type": string, "variable_duration": boolean, "ad_parameters": string, }

فیلدها
`resource`	`string` آدرس اینترنتی (URL) مربوط به محتوای خلاقانه تعاملی.
`type`	`string` نوع MIME فایل ارائه شده به عنوان منبع.
`variable_duration`	`boolean` اینکه آیا این طرح خلاقانه می‌تواند درخواست تمدید مدت زمان را داشته باشد یا خیر.
`ad_parameters`	`string` مقدار گره <AdParameters> در VAST.

API VOD درج آگهی پویا با مجموعه‌ها، منظم بمانید ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.

سرویس: dai.google.com

روش: جریان

درخواست HTTP

هدر درخواست

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

درخواست بدنه

بدنه پاسخ

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

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

درخواست HTTP

بدنه پاسخ

شناسه‌های رسانه‌های تبلیغاتی (HLS)

شناسه‌های رسانه‌های تبلیغاتی (DASH)

داده‌های پاسخ

جریان

اپل تی‌وی

ادبریک

آگهی

رویداد

زیرنویس

پرش از فراداده

آیکون

کلیک دیتا

تصویر جایگزین

بسته بندی

تأیید

جاوااسکریپت

رویداد ردیابی

یونیورسال اد آی دی

همراه

فایل تعاملی

سرویس: dai.google.com

روش: جریان

درخواست HTTP

هدر درخواست

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

درخواست بدنه

بدنه پاسخ

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

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

درخواست HTTP

بدنه پاسخ

شناسه‌های رسانه‌های تبلیغاتی (HLS)

شناسه‌های رسانه‌های تبلیغاتی (DASH)

داده‌های پاسخ

جریان

اپل تی‌وی

ادبریک

آگهی

رویداد

زیرنویس

پرش از فراداده

آیکون

کلیک دیتا

تصویر جایگزین

بسته بندی

تأیید

جاوااسکریپت

رویداد ردیابی

یونیورسال اد آی دی

همراه

فایل تعاملی

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