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

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

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

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

سرویس: dai.google.com

همه URI ها نسبت به https://dai.google.com هستند

روش: جریان

روش‌ها
`stream`	`POST /linear/v1/hls/event/{assetKey}/stream` یک جریان DAI برای شناسه رویداد داده شده ایجاد می‌کند.

درخواست HTTP

POST https://dai.google.com/linear/v1/hls/event/{assetKey}/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>"

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

پارامترها
`assetKey`	`string` شناسه رویداد جریان. توجه: کلید دارایی جریان، شناسه‌ای است که می‌توان آن را در رابط کاربری مدیر تبلیغات نیز یافت.

درخواست بدنه

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

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

بدنه پاسخ

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

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

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

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

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

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

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

درخواست HTTP

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

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

روش: فراداده

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

روش‌ها
`metadata`	`GET /{metadata_url}/{ad-media-id}` `GET /{metadata_url}` اطلاعات فراداده تبلیغ را بازیابی می‌کند.

درخواست HTTP

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

GET https://{metadata_url}

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

پارامترها
`delta_token`	اختیاری	`string` یک توکن مبهم که وضعیت همگام‌سازی فعلی کلاینت را نشان می‌دهد. در صورت ارائه، سرور فقط فراداده‌هایی را که از زمان تولید توکن تغییر کرده‌اند، همراه با یک `next_delta_token` جدید در پاسخ، برمی‌گرداند. در صورت حذف، سرور کل فراداده‌ها را برای کل پنجره DVR برمی‌گرداند.

بدنه پاسخ

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

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

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

google_1234567890

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

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

جریان

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

نمایش JSON
{ "stream_id": string, "stream_manifest": string, "hls_master_playlist": string, "media_verification_url": string, "metadata_url": string, "session_update_url": string, "polling_frequency": number, }

فیلدها
`stream_id`	`string` شناسه جریان GAM.
`stream_manifest`	`string` آدرس اینترنتی مانیفست جریان، که برای بازیابی لیست پخش چند متغیره در HLS یا MPD در DASH استفاده می‌شود.
`hls_master_playlist`	`string` (منسوخ شده) آدرس لیست پخش چند متغیره HLS. به جای آن از "stream_manifest" استفاده کنید.
`media_verification_url`	`string` URL تأیید رسانه که به عنوان نقطه پایانی پایه برای ردیابی رویدادهای پخش استفاده می‌شود.
`metadata_url`	`string` نشانی اینترنتی فراداده که برای نظرسنجی جهت کسب اطلاعات دوره‌ای در مورد رویدادهای آتی تبلیغات استریم استفاده می‌شود.
`session_update_url`	`string` URL به‌روزرسانی جلسه که برای به‌روزرسانی پارامترهای هدف‌گیری برای این جریان استفاده می‌شود. مقادیر اصلی پارامترهای هدف‌گیری در طول درخواست اولیه ایجاد جریان دریافت می‌شوند.
`polling_frequency`	`number` فرکانس رای‌گیری، بر حسب ثانیه، هنگام درخواست metadata_url یا heartbeat_url.

پادفراداده

PodMetadata حاوی اطلاعات فراداده در مورد تبلیغات، وقفه‌های تبلیغاتی و برچسب‌های شناسه رسانه است.

نمایش JSON
{ "tags": map[string, object(TagSegment)], "ads": map[string, object(Ad)], "ad_breaks": map[string, object(AdBreak)], "next_delta_token": string, "obsolete_ad_break_ids": [], }

فیلدها
`tags`	`map[string, object(TagSegment)]` نقشه بخش‌های برچسب که بر اساس پیشوند برچسب فهرست‌بندی شده‌اند.
`ads`	`map[string, object(Ad)]` نقشه آگهی‌های فهرست‌بندی‌شده بر اساس شناسه آگهی.
`ad_breaks`	`map[string, object(AdBreak)]` نقشه‌ی وقفه‌های تبلیغاتی فهرست‌بندی‌شده بر اساس شناسه‌ی وقفه‌ی تبلیغاتی.
`next_delta_token`	`string` یک توکن غیرشفاف برای استفاده کلاینت در نظرسنجی بعدی.
`obsolete_ad_break_ids`	`string` فهرستی از شناسه‌های تبلیغات مزاحم که منسوخ شده‌اند و باید از حافظه پنهان کلاینت حذف شوند.

تگ سگمنت

TagSegment حاوی ارجاعی به یک تبلیغ، بخش تبلیغ آن و نوع رویداد است. TagSegment با نوع "progress" نباید به نقطه پایانی تأیید رسانه تبلیغ پینگ شود.

نمایش JSON
{ "ad": string, "ad_break_id": string, "type": string, }

فیلدها
`ad`	`string` شناسه‌ی تبلیغ این تگ.
`ad_break_id`	`string` شناسه‌ی تبلیغ این تگ.
`type`	`string` نوع رویداد این تگ.

ادبریک

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

نمایش JSON
{ "type": string, "duration": number, "expected_duration": number, "ads": number, }

فیلدها
`type`	`string` انواع معتبر استراحت عبارتند از: قبل، وسط و بعد.
`duration`	`number` مدت زمان کل تبلیغ برای این بخش تبلیغاتی، بر حسب ثانیه.
`expected_duration`	`number` مدت زمان مورد انتظار برای پخش آگهی (به ثانیه)، شامل تمام آگهی‌ها و هرگونه برنامه‌ی زمانی.
`ads`	`number` تعداد تبلیغات در متن آگهی.

آگهی

تبلیغ، تبلیغی را در جریان توصیف می‌کند.

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

نمایش JSON

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

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

آیکون

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

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

سرویس: dai.google.com

همه URI ها نسبت به https://dai.google.com هستند

روش: جریان

روش‌ها
`stream`	`POST /linear/v1/hls/event/{assetKey}/stream` یک جریان DAI برای شناسه رویداد داده شده ایجاد می‌کند.

درخواست HTTP

POST https://dai.google.com/linear/v1/hls/event/{assetKey}/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>"

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

پارامترها
`assetKey`	`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 https://{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)

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

روش: فراداده

روش‌ها
`metadata`	`GET /{metadata_url}/{ad-media-id}` `GET /{metadata_url}` اطلاعات فراداده تبلیغ را بازیابی می‌کند.

درخواست HTTP

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

GET https://{metadata_url}

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

پارامترها
`delta_token`	اختیاری	`string` یک توکن مبهم که وضعیت همگام‌سازی فعلی کلاینت را نشان می‌دهد. در صورت ارائه، سرور فقط فراداده‌هایی را که از زمان تولید توکن تغییر کرده‌اند، همراه با یک `next_delta_token` جدید در پاسخ، برمی‌گرداند. در صورت حذف، سرور کل فراداده‌ها را برای کل پنجره DVR برمی‌گرداند.

بدنه پاسخ

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

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

google_1234567890

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

جریان

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

نمایش JSON
{ "stream_id": string, "stream_manifest": string, "hls_master_playlist": string, "media_verification_url": string, "metadata_url": string, "session_update_url": string, "polling_frequency": number, }

فیلدها
`stream_id`	`string` شناسه جریان GAM.
`stream_manifest`	`string` آدرس اینترنتی مانیفست جریان، که برای بازیابی لیست پخش چند متغیره در HLS یا MPD در DASH استفاده می‌شود.
`hls_master_playlist`	`string` (منسوخ شده) آدرس لیست پخش چند متغیره HLS. به جای آن از "stream_manifest" استفاده کنید.
`media_verification_url`	`string` URL تأیید رسانه که به عنوان نقطه پایانی پایه برای ردیابی رویدادهای پخش استفاده می‌شود.
`metadata_url`	`string` نشانی اینترنتی فراداده که برای نظرسنجی جهت کسب اطلاعات دوره‌ای در مورد رویدادهای آتی تبلیغات استریم استفاده می‌شود.
`session_update_url`	`string` URL به‌روزرسانی جلسه که برای به‌روزرسانی پارامترهای هدف‌گیری برای این جریان استفاده می‌شود. مقادیر اصلی پارامترهای هدف‌گیری در طول درخواست اولیه ایجاد جریان دریافت می‌شوند.
`polling_frequency`	`number` فرکانس رای‌گیری، بر حسب ثانیه، هنگام درخواست metadata_url یا heartbeat_url.

پادفراداده

PodMetadata حاوی اطلاعات فراداده در مورد تبلیغات، وقفه‌های تبلیغاتی و برچسب‌های شناسه رسانه است.

نمایش JSON
{ "tags": map[string, object(TagSegment)], "ads": map[string, object(Ad)], "ad_breaks": map[string, object(AdBreak)], "next_delta_token": string, "obsolete_ad_break_ids": [], }

فیلدها
`tags`	`map[string, object(TagSegment)]` نقشه بخش‌های برچسب که بر اساس پیشوند برچسب فهرست‌بندی شده‌اند.
`ads`	`map[string, object(Ad)]` نقشه آگهی‌های فهرست‌بندی‌شده بر اساس شناسه آگهی.
`ad_breaks`	`map[string, object(AdBreak)]` نقشه‌ی وقفه‌های تبلیغاتی فهرست‌بندی‌شده بر اساس شناسه‌ی وقفه‌ی تبلیغاتی.
`next_delta_token`	`string` یک توکن غیرشفاف برای استفاده کلاینت در نظرسنجی بعدی.
`obsolete_ad_break_ids`	`string` فهرستی از شناسه‌های تبلیغات مزاحم که منسوخ شده‌اند و باید از حافظه پنهان کلاینت حذف شوند.

تگ سگمنت

نمایش JSON
{ "ad": string, "ad_break_id": string, "type": string, }

فیلدها
`ad`	`string` شناسه‌ی تبلیغ این تگ.
`ad_break_id`	`string` شناسه‌ی تبلیغ این تگ.
`type`	`string` نوع رویداد این تگ.

ادبریک

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

نمایش JSON
{ "type": string, "duration": number, "expected_duration": number, "ads": number, }

فیلدها
`type`	`string` انواع معتبر استراحت عبارتند از: قبل، وسط و بعد.
`duration`	`number` مدت زمان کل تبلیغ برای این بخش تبلیغاتی، بر حسب ثانیه.
`expected_duration`	`number` مدت زمان مورد انتظار برای پخش آگهی (به ثانیه)، شامل تمام آگهی‌ها و هرگونه برنامه‌ی زمانی.
`ads`	`number` تعداد تبلیغات در متن آگهی.

آگهی

تبلیغ، تبلیغی را در جریان توصیف می‌کند.

نمایش JSON

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

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

آیکون

آیکون حاوی اطلاعاتی در مورد یک آیکون 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 خطی درج آگهی پویا با مجموعه‌ها، منظم بمانید ذخیره و طبقه‌بندی محتوا براساس اولویت‌های شما.

سرویس: dai.google.com

روش: جریان

درخواست HTTP

هدر درخواست

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

درخواست بدنه

بدنه پاسخ

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

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

درخواست HTTP

بدنه پاسخ

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

روش: فراداده

درخواست HTTP

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

بدنه پاسخ

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

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

جریان

پادفراداده

تگ سگمنت

ادبریک

آگهی

آیکون

کلیک دیتا

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

بسته بندی

تأیید

جاوااسکریپت

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

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

همراه

فایل تعاملی

سرویس: dai.google.com

روش: جریان

درخواست HTTP

هدر درخواست

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

درخواست بدنه

بدنه پاسخ

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

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

درخواست HTTP

بدنه پاسخ

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

روش: فراداده

درخواست HTTP

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

بدنه پاسخ

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

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

جریان

پادفراداده

تگ سگمنت

ادبریک

آگهی

آیکون

کلیک دیتا

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

بسته بندی

تأیید

جاوااسکریپت

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

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

همراه

فایل تعاملی

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