API زنده ارائه غلاف درج آگهی پویا

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

خدمات: dai.google.com

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

روش: جریان

روش ها
stream POST /ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

یک DAI DAI pod ارائه جلسه پخش زنده را ثبت می کند.

درخواست HTTP 

POST https://dai.google.com/ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

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

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است.

درخواست بدن

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

پارامترها
پارامترهای هدف DFP اختیاری پارامترهای هدف گیری اضافی
نادیده گرفتن پارامترهای جریان اختیاری مقادیر پیش‌فرض پارامتر ایجاد جریان را لغو کنید.
احراز هویت HMAC اختیاری با استفاده از توکن مبتنی بر HMAC احراز هویت.

بدن پاسخگو

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

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

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

روش: بخش غلاف

روش ها
pod segment GET /linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

یک جریان DAI برای شناسه رویداد داده شده ایجاد می کند.

درخواست HTTP 

GET https://dai.google.com/linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

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

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است.

pod_identifier

فرمت های زیر پشتیبانی می شوند:

pod/{integer}

شناسه عددی برای وقفه تبلیغاتی فعلی. شناسه‌های غلاف آگهی به‌صورت تدریجی برای هر رویداد وقفه تبلیغاتی، از 1 شروع می‌شود.

ad_break_id/{string}

شناسه رشته برای وقفه تبلیغاتی فعلی. ناشر ارائه‌شده Ad break ID محدودیت‌های مشابهی با Ad pod ID ندارد. هر شناسه Ad Break ناشناخته ای که به آن نقطه پایانی ارائه می شود، یک Ad Break جدید برای رویداد پخش زنده ایجاد می کند.

profile_name string

نام نمایه رمزگذاری Google Ad Manager DAI درخواستی . نمایه رمزگذاری باید یکی از نمایه های رمزگذاری پیکربندی شده برای رویداد انتخاب شده باشد.

segment_number integer

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

segment_format string

پسوند فایل مرتبط با قالب بخش درخواستی. پسوندهای پذیرفته شده عبارتند از: ts , mp4 , vtt , aac , ac3 یا eac3 .

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

پارامترها
stream_id مورد نیاز است string

شناسه جریان برای جلسه کاربر فعلی. این مقدار با یک درخواست موفقیت آمیز به نقطه پایانی stream برگردانده می شود.

sd required 1 integer

مدت زمان بخش درخواستی، بر حسب میلی ثانیه.

so اختیاری

افست بخش درخواستی در غلاف آگهی، در میلی ثانیه. اگر پارامتر so را حذف کنید، با ضرب مدت زمان بخش در شماره بخش محاسبه می شود.

pd مورد نیاز 2 integer

مدت زمان غلاف آگهی، بر حسب میلی ثانیه.

auth-token مورد نیاز است string

یک نشانه HMAC امضا شده و کدگذاری شده با URL برای غلاف تبلیغات فعلی.

last اختیاری boolean

آخرین بخش در وقفه تبلیغاتی را نشان می دهد. این پارامتر را برای تمام بخش های دیگر حذف کنید.

scte35 اختیاری string

سیگنال SCTE-35 با کد Base64 برای این استراحت تبلیغاتی.

cust_params اختیاری string

مجموعه‌ای از جفت‌های کلید-مقدار که برای هدف‌یابی کمپین Ad Manager استفاده می‌شود. این جفت ها باید به عنوان یک رشته پرس و جو کدگذاری شده با آدرس اینترنتی نمایش داده شوند.

مثال:
پارامترها
  • بخش = sports
  • صفحه = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

پاورقی ها

  1. sd برای بخش های اولیه مورد نیاز نیست. ↩
  2. pd برای رویدادهایی که وقفه‌های تبلیغاتی بدون مدت فعال هستند، لازم نیست. ↩

مثال

دریافت کنید https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/ad_break_id/adbreak -2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99a4a47-6T

دریافت کنید https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/pod/2/profi le/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a:

بدن پاسخگو

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

روش: مانیفست غلاف HLS

یک مانیفست غلاف تبلیغاتی HLS از یک جریان زنده را بازیابی می‌کند که برای بارگیری و پخش ویدیوی مشتری آماده است.

روش ها
GET GET /linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset}/{pod_identifier}.m3u8;

API برای بازیابی یک لیست پخش چند متغیره HLS برای یک آگهی.

درخواست HTTP 

GET https://dai.google.com/linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}.m3u8?stream_id={stream_id}&pd={pod_duration}

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

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است

pod_identifier

فرمت های زیر پشتیبانی می شوند:

pod/{integer}

شناسه عددی برای وقفه تبلیغاتی فعلی. شناسه‌های غلاف آگهی به‌صورت تدریجی برای هر رویداد وقفه تبلیغاتی، از 1 شروع می‌شود.

ad_break_id/{string}

شناسه رشته برای وقفه تبلیغاتی فعلی. ناشر ارائه‌شده Ad break ID محدودیت‌های مشابهی با Ad pod ID ندارد. هر شناسه Ad Break ناشناخته ای که به آن نقطه پایانی ارائه می شود، یک Ad Break جدید برای رویداد پخش زنده ایجاد می کند.

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

پارامترها
stream_id مورد نیاز string

شناسه جریان برای جلسه کاربر فعلی. این مقدار با یک درخواست موفقیت آمیز به نقطه پایانی stream برگردانده می شود.

pd مورد نیاز integer

مدت زمان غلاف آگهی، بر حسب میلی ثانیه.

scte35 اختیاری string

سیگنال SCTE-35 با کد Base64 برای این استراحت تبلیغاتی.

cust_params اختیاری string

مجموعه‌ای از جفت‌های کلید-مقدار که برای هدف‌یابی کمپین Ad Manager استفاده می‌شود. این جفت ها باید به عنوان یک رشته پرس و جو کدگذاری شده با آدرس اینترنتی نمایش داده شوند.

مثال:
پارامترها
  • بخش = sports
  • صفحه = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ یک لیست پخش چند متغیره HLS است.

روش: مانیفست غلاف DASH

یک مانیفست غلاف آگهی MPEG-DASH از جریان زنده را بازیابی می‌کند که برای بارگیری و پخش ویدیوی مشتری آماده است.

روش ها
GET GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/pod/{pod_id}/manifest.mpd

API برای بازیابی لیست پخش mpd MPEG-DASH برای یک آگهی.

درخواست HTTP 

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/stream/{stream_id}/pod/{pod_id}/manifest.mpd?pd={pod_duration}

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

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است

stream_id string

شناسه جریان برای جلسه کاربر فعلی. این مقدار با یک درخواست موفقیت آمیز به نقطه پایانی stream برگردانده می شود.

pod_id integer

شناسه عددی برای وقفه تبلیغاتی فعلی. شناسه‌های غلاف آگهی به‌صورت تدریجی برای هر رویداد وقفه تبلیغاتی، از 1 شروع می‌شود.

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

پارامترها
pd مورد نیاز integer

مدت زمان غلاف آگهی، بر حسب میلی ثانیه.

scte35 اختیاری string

سیگنال SCTE-35 با کد Base64 برای این استراحت تبلیغاتی.

cust_params اختیاری string

مجموعه‌ای از جفت‌های کلید-مقدار که برای هدف‌یابی کمپین Ad Manager استفاده می‌شود. این جفت ها باید به عنوان یک رشته پرس و جو کدگذاری شده با آدرس اینترنتی نمایش داده شوند.

مثال:
پارامترها
  • بخش = sports
  • صفحه = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ یک لیست پخش mpd MPEG-DASH است.

روش: الگوی دوره غلاف DASH

روش ها
pods GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

از Google Ad Manager یک الگوی دوره DASH درخواست می کند. این الگو حاوی ماکروهایی است که باید آنها را با پارامترهای جریان خود پر کنید. پس از پر شدن این ماکروها، الگو به دوره وقفه تبلیغاتی شما تبدیل می شود و می توان آن را در مانیفست DASH خود قرار داد.

درخواست HTTP 

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

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

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است.

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

پارامترها
stream_id مورد نیاز است string

شناسه جریان برای جلسه کاربر فعلی. این مقدار با یک درخواست موفقیت آمیز به نقطه پایانی stream برگردانده می شود.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی یک شی جدید PodTemplateResponse است.

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

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

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

روش ها
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 .
  • HTTP/1.1 404 Not Found اگر درخواست نمی تواند رسانه را به دلیل قالب بندی نادرست URL یا انقضا تأیید کند.
  • اگر درخواست تأیید قبلی برای این شناسه موفقیت آمیز بود، HTTP/1.1 404 Not Found .
  • HTTP/1.1 409 Conflict .

شناسه های رسانه تبلیغاتی

شناسه‌های رسانه تبلیغاتی در یک مسیر فراداده جداگانه کدگذاری می‌شوند - فراداده زمان‌بندی‌شده برای جریان انتقال HLS یا emsg برای فایل‌های mp4. شناسه های رسانه تبلیغاتی همیشه با رشته 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}

بدن پاسخگو

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

تجزیه فراداده

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

google_1234567890

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

داده های پاسخ

جریان

Stream برای ارائه فهرستی از منابع برای یک جریان تازه ایجاد شده در قالب JSON استفاده می شود.
نمایندگی JSON 
{
  "stream_id": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "heartbeat_url": string,
  "polling_frequency": number,
  "pod_manifest_url": string,
  "manifest_format": string,
}
فیلدها
stream_id string

شناسه جریان GAM.
media_verification_url string

نشانی وب تأیید رسانه که به عنوان نقطه پایانی پایه برای ردیابی رویدادهای پخش استفاده می‌شود.
metadata_url string

URL فراداده برای نظرسنجی اطلاعات دوره ای در مورد رویدادهای تبلیغات جریانی آتی استفاده می شود.
session_update_url string

نشانی وب به‌روزرسانی جلسه برای به‌روزرسانی پارامترهای هدف برای این جریان استفاده می‌شود. مقادیر اصلی برای پارامترهای هدف گیری در طول درخواست ایجاد جریان اولیه گرفته می شود.
heartbeat_url string

URL ضربان قلب، که برای زنده نگه داشتن جریان beaconing سمت سرور استفاده می‌شود، باید هر {PollingFrequency} ثانیه یک بار پینگ شود. پر شده برای جریان‌های نشان‌دهنده سمت سرور.
polling_frequency number

فرکانس نظرسنجی، در ثانیه، هنگام درخواست metadata_url یا heartbeat_url.
pod_manifest_url string

الگوی URL مانیفست غلاف برای تولید URL برای بازیابی مانیفست غلاف جریان، مطابق با URL فهرست پخش چند متغیره در HLS یا MPD در DASH استفاده می‌شود. پر شده برای رویدادهای پخش مستقیم از نوع درج آگهی پویا POD_SERVING_MANIFEST. https://developers.google.com/ad-manager/api/reference/v202305/LiveStreamEventService.DynamicAdInsertionType
manifest_format string

قالب مانیفست فرمت مانیفست بازیابی شده از pod_manifest_url، خط تیره یا hls است.

PodMetadata

PodMetadata حاوی اطلاعات فراداده در مورد تبلیغات، وقفه های تبلیغاتی و برچسب های شناسه رسانه است.
نمایندگی JSON
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}
فیلدها
tags map[string, object(TagSegment)]

نقشه بخش های برچسب نمایه شده با پیشوند برچسب.
ads map[string, object(Ad)]

نقشه تبلیغات نمایه شده با شناسه آگهی.
ad_breaks map[string, object(AdBreak)]

نقشه وقفه های تبلیغاتی نمایه شده با شناسه استراحت آگهی.

TagSegment

TagSegment حاوی یک مرجع به یک تبلیغ، وقفه تبلیغاتی آن و نوع رویداد است. TagSegment با type="progress" نباید به نقطه پایانی تأیید رسانه تبلیغات پینگ شود.
نمایندگی JSON
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
فیلدها
ad string

شناسه تبلیغ این تگ.
ad_break_id string

شناسه وقفه تبلیغاتی این تگ.
type string

نوع رویداد این برچسب

AdBreak

AdBreak یک وقفه تبلیغاتی را در جریان توصیف می کند. این شامل مدت زمان، نوع (اواسط/پیش/پست) و تعداد تبلیغات است.
نمایندگی JSON
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
فیلدها
type string

انواع وقفه های معتبر عبارتند از: pre، mid و post.
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

موقعیت این آگهی در وقفه آگهی، از 1 شروع می شود.
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

URL از طریق کلیک اختیاری.
click_tracking_urls string

URL های ردیابی کلیک اختیاری.
verifications [object(Verification)]

ورودی‌های تأیید اندازه‌گیری باز اختیاری که منابع و ابرداده‌های مورد نیاز برای اجرای کد اندازه‌گیری شخص ثالث را برای تأیید پخش خلاق فهرست می‌کنند.
slate boolean

bool اختیاری که نشان می دهد ورودی فعلی تخته سنگ است.
icons [object(Icon)]

فهرستی از نمادها که در صورت خالی بودن حذف می شوند.
wrappers [object(Wrapper)]

لیستی از Wrapper ها که در صورت خالی بودن حذف می شوند.
universal_ad_id object(UniversalAdID)

شناسه آگهی جهانی اختیاری.
extensions string

لیست اختیاری همه گره های <Extension> در VAST.
companions [object(Companion)]

همراهان اختیاری که ممکن است همراه با این آگهی نمایش داده شوند.
interactive_file object(InteractiveFile)

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

PodTemplateResponse

PodTemplateResponse نشان دهنده بار JSON است که برای دوخت غلاف به VTP بازگردانده شده است.
نمایندگی JSON
{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}
فیلدها
dash_period_template string

DashPeriodTemplate الگوی xml برای دوره ای است که باید قبل از دوخت با داده های مناسب پر شود.
segment_duration_ms int64

SegmentDurationMS مدت زمان بخش های دوره بر حسب میلی ثانیه است.

AdpodTimingMetadataResponse

AdpodTimingMetadataResponse حاوی اطلاعاتی در مورد Ad Pod و نحوه ساخت URL های بخش برای آن است.
نمایندگی JSON
{
  "status": string,
  "ads": [object(AdRendering)],
  "slate": object(SlateRendering),
  "dash_representations": map[string, object(DASHRepresentation)],
  "dash_adaptation_sets": map[string, object(DASHAdaptationSet)],
}
فیلدها
status string

وضعیت تصمیم گیری برای آگهی.
ads [object(AdRendering)]

آرایه ای از اشیاء تبلیغاتی که نحوه ارائه url های بخش تبلیغات را شرح می دهد که از 0 ایندکس شده است.
slate object(SlateRendering)

تخته سنگ توضیح می دهد که چگونه url های بخش تخته سنگ را ارائه کنید.
dash_representations map[string, object(DASHRepresentation)]

فهرست نمایش‌های DASH برای آن غلاف تبلیغاتی که باید در مانیفست‌های DASH ارائه شوند.
dash_adaptation_sets map[string, object(DASHAdaptationSet)]

فهرستی از مجموعه‌های انطباق DASH برای آن دسته تبلیغاتی که در مانیفست‌های DASH ارائه می‌شوند.

AdRendering

AdRendering نحوه ارائه یک تبلیغ تصمیم گیری را شرح می دهد.
نمایندگی JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
فیلدها
duration_ms number

مدت زمان تبلیغ، بر حسب میلی ثانیه (int).
variants map[string, object(VariantRendering)]

Dictionary of Variant Objects (به زیر مراجعه کنید)، نمایه شده توسط نوع/نمایه ID، همانطور که از UI پیکربندی شده است.

SlateRendering

SlateRendering نحوه رندر کردن محتوای اسلایت را توضیح می دهد.
نمایندگی JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
فیلدها
duration_ms number

مدت زمان تخته سنگ، بر حسب میلی ثانیه (int).
variants map[string, object(VariantRendering)]

فرهنگ لغت اشیاء Variant، نمایه‌سازی شده بر اساس شناسه نوع/نمایه. مدت زمان تخته سنگ باید تا رسیدن به طول تخته‌ای مورد نیاز، درج ناپیوستگی‌های HLS بین تکرارها یا حلقه‌گذاری دوره‌های جدید برای MPEG-DASH حلقه شود.

VariantRendering

VariantRendering یک نوع/نمایه را در آگهی/تبلیغ توصیف می کند.
نمایندگی JSON
{
  "segment_extension": string,
  "segment_durations": object(SegmentDurations),
}
فیلدها
segment_extension string

رشته، یکی از: ts، mp4، aac، ac3، ec3، m4a، m4v. بخشی از پسوند نام فایل از URL های بخش.
segment_durations object(SegmentDurations)

اشیاء SegmentDurations. مدت زمان هر بخش را می توان به یک URL بخش ترجمه کرد.

مدت زمان بخش

SegmentDurations مدت زمان دنباله ای از بخش ها را در یک واحد زمانی مشخص توصیف می کند.
نمایندگی JSON
{
  "timescale": number,
  "values": [],
}
فیلدها
timescale number

مقیاس زمانی تعداد واحدهای در ثانیه (int) مورد انتظار است: 1000 برای HLS (میلی ثانیه) 90000 برای DASH ویدئو (PTS) نرخ نمونه صوتی برای صدای DASH.
values number

آرایه ای از مدت زمان قطعه int، در واحدهای مقیاس زمانی.

نمایندگی DASH

DASHRepresentation گره های بازنمایی را که در مانیفست های DASH ارائه می شوند را توصیف می کند.
نمایندگی JSON
{
  "codecs": string,
  "bandwidth": number,
  "width": number,
  "height": number,
  "frame_rate": string,
  "audio_sampling_rate": number,
  "audio_channel_config": object(SchemeIDURIAndValue),
}
فیلدها
codecs string

کدک های نمایندگی
bandwidth number

پهنای باند نمایندگی
width number

عرض نمایندگی.
height number

ارتفاع نمایندگی.
frame_rate string

نرخ فریم نمایش.
audio_sampling_rate number

نرخ نمونه برداری صوتی از نمایندگی.
audio_channel_config object(SchemeIDURIAndValue)

پیکربندی کانال صوتی نمایندگی.

DASHAdaptationSet

DASHAdaptationSet گره های AdaptationSet را برای ارائه در مانیفست های DASH توصیف می کند.
نمایندگی JSON
{
  "content_type": string,
  "mime_type": string,
  "role": object(SchemeIDURIAndValue),
  "inband_event_stream": object(SchemeIDURIAndValue),
  "min_frame_rate": string,
  "max_frame_rate": string,
  "scan_type": string,
  "start_with_sap": string,
  "segment_alignment": boolean,
  "representations": [],
}
فیلدها
content_type string

نوع محتوای مجموعه انطباق.
mime_type string

نوع MIME مجموعه سازگاری.
role object(SchemeIDURIAndValue)

نقش مجموعه اقتباسی
inband_event_stream object(SchemeIDURIAndValue)

جریان رویداد درون باند مجموعه اقتباسی.
min_frame_rate string

حداقل نرخ فریم مجموعه انطباق.
max_frame_rate string

حداکثر نرخ فریم مجموعه انطباق.
scan_type string

نوع مجموعه سازگاری را اسکن کنید.
start_with_sap string

با SAP مجموعه سازگاری شروع کنید.
segment_alignment boolean

هم ترازی قطعه مجموعه انطباق.
representations string

بازنمایی از مجموعه اقتباسی.

SchemeIDURIandValue

SchemeIDURIAndValue یک جفت شناسه طرح و مقدار آن است.
نمایندگی JSON
{
  "scheme_id_uri": string,
  "value": string,
}
فیلدها
scheme_id_uri string

شناسه طرح URI مقدار.
value string

مقدار URI شناسه طرح.

نماد

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

ClickData حاوی اطلاعاتی در مورد یک نماد کلیک است.
نمایندگی JSON
{
  "url": string,
}
فیلدها
url string

Fallback Image

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

JavaScriptResource حاوی اطلاعاتی برای تأیید از طریق جاوا اسکریپت است.
نمایندگی JSON
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
فیلدها
script_url string

URI به بارگذاری جاوا اسکریپت.
api_framework string

APIFramework نام چارچوب ویدیویی است که کد تأیید را اعمال می کند.
browser_optional boolean

آیا این اسکریپت می تواند خارج از مرورگر اجرا شود یا خیر.

TrackingEvent

TrackingEvent حاوی URL هایی است که در شرایط خاص باید توسط مشتری پینگ شود.
نمایندگی JSON
{
  "event": string,
  "uri": string,
}
فیلدها
event string

نوع رویداد ردیابی
uri string

رویداد ردیابی که باید پینگ شود.

UniversalAdID

UniversalAdID برای ارائه یک شناسه خلاق منحصر به فرد استفاده می شود که در سراسر سیستم های تبلیغاتی نگهداری می شود.
نمایندگی JSON
{
  "id_value": string,
  "id_registry": string,
}
فیلدها
id_value string

شناسه آگهی جهانی خلاقیت انتخاب شده برای آگهی.
id_registry string

رشته ای که برای شناسایی نشانی وب سایت رجیستری استفاده می شود که شناسه آگهی جهانی خلاقیت انتخاب شده در آن فهرست شده است.

همراه

Companion حاوی اطلاعاتی برای تبلیغات همراه است که ممکن است همراه با آگهی نمایش داده شود.
نمایندگی 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 اگر همراهی از نوع static باشد.
height int32

ارتفاع بر حسب پیکسل این همراه.
width int32

عرض بر حسب پیکسل این همراه.
resource string

برای همراهان استاتیک و iframe این نشانی اینترنتی است که باید بارگیری و نمایش داده شود. برای همراهان 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 /ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

یک DAI DAI pod ارائه جلسه پخش زنده را ثبت می کند.

درخواست HTTP 

POST https://dai.google.com/ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

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

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است.

درخواست بدن

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

پارامترها
پارامترهای هدف DFP اختیاری پارامترهای هدف گیری اضافی
نادیده گرفتن پارامترهای جریان اختیاری مقادیر پیش‌فرض پارامتر ایجاد جریان را لغو کنید.
احراز هویت HMAC اختیاری با استفاده از توکن مبتنی بر HMAC احراز هویت.

بدن پاسخگو

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

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

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

روش: بخش غلاف

روش ها
pod segment GET /linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

یک جریان DAI برای شناسه رویداد داده شده ایجاد می کند.

درخواست HTTP 

GET https://dai.google.com/linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

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

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است.

pod_identifier

فرمت های زیر پشتیبانی می شوند:

pod/{integer}

شناسه عددی برای وقفه تبلیغاتی فعلی. شناسه‌های غلاف آگهی به‌صورت تدریجی برای هر رویداد وقفه تبلیغاتی، از 1 شروع می‌شود.

ad_break_id/{string}

شناسه رشته برای وقفه تبلیغاتی فعلی. ناشر ارائه‌شده Ad break ID محدودیت‌های مشابهی با Ad pod ID ندارد. هر شناسه Ad Break ناشناخته ای که به آن نقطه پایانی ارائه می شود، یک Ad Break جدید برای رویداد پخش زنده ایجاد می کند.

profile_name string

نام نمایه رمزگذاری Google Ad Manager DAI درخواستی . نمایه رمزگذاری باید یکی از نمایه های رمزگذاری پیکربندی شده برای رویداد انتخاب شده باشد.

segment_number integer

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

segment_format string

پسوند فایل مرتبط با قالب بخش درخواستی. پسوندهای پذیرفته شده عبارتند از: ts , mp4 , vtt , aac , ac3 یا eac3 .

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

پارامترها
stream_id مورد نیاز است string

شناسه جریان برای جلسه کاربر فعلی. این مقدار با یک درخواست موفقیت آمیز به نقطه پایانی stream برگردانده می شود.

sd required 1 integer

مدت زمان بخش درخواستی، بر حسب میلی ثانیه.

so اختیاری

افست بخش درخواستی در غلاف آگهی، در میلی ثانیه. اگر پارامتر so را حذف کنید، با ضرب مدت زمان بخش در شماره بخش محاسبه می شود.

pd مورد نیاز 2 integer

مدت زمان غلاف آگهی، بر حسب میلی ثانیه.

auth-token مورد نیاز است string

یک نشانه HMAC امضا شده و کدگذاری شده با URL برای غلاف تبلیغات فعلی.

last اختیاری boolean

آخرین بخش در وقفه تبلیغاتی را نشان می دهد. این پارامتر را برای تمام بخش های دیگر حذف کنید.

scte35 اختیاری string

سیگنال SCTE-35 با کد Base64 برای این استراحت تبلیغاتی.

cust_params اختیاری string

مجموعه‌ای از جفت‌های کلید-مقدار که برای هدف‌یابی کمپین Ad Manager استفاده می‌شود. این جفت ها باید به عنوان یک رشته پرس و جو کدگذاری شده با آدرس اینترنتی نمایش داده شوند.

مثال:
پارامترها
  • بخش = sports
  • صفحه = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

پاورقی ها

  1. sd برای بخش های اولیه مورد نیاز نیست. ↩
  2. pd برای رویدادهایی که وقفه‌های تبلیغاتی بدون مدت فعال هستند، لازم نیست. ↩

مثال

دریافت کنید https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/ad_break_id/adbreak -2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99a4a47-6T

دریافت کنید https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/pod/2/profi le/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a:

بدن پاسخگو

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

روش: مانیفست غلاف HLS

یک مانیفست غلاف تبلیغاتی HLS از یک جریان زنده را بازیابی می‌کند که برای بارگیری و پخش ویدیوی مشتری آماده است.

روش ها
GET GET /linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset}/{pod_identifier}.m3u8;

API برای بازیابی یک لیست پخش چند متغیره HLS برای یک آگهی.

درخواست HTTP 

GET https://dai.google.com/linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}.m3u8?stream_id={stream_id}&pd={pod_duration}

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

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است

pod_identifier

فرمت های زیر پشتیبانی می شوند:

pod/{integer}

شناسه عددی برای وقفه تبلیغاتی فعلی. شناسه‌های غلاف آگهی به‌صورت تدریجی برای هر رویداد وقفه تبلیغاتی، از 1 شروع می‌شود.

ad_break_id/{string}

شناسه رشته برای وقفه تبلیغاتی فعلی. ناشر ارائه‌شده Ad break ID محدودیت‌های مشابهی با Ad pod ID ندارد. هر شناسه Ad Break ناشناخته ای که به آن نقطه پایانی ارائه می شود، یک Ad Break جدید برای رویداد پخش زنده ایجاد می کند.

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

پارامترها
stream_id مورد نیاز string

شناسه جریان برای جلسه کاربر فعلی. این مقدار با یک درخواست موفقیت آمیز به نقطه پایانی stream برگردانده می شود.

pd مورد نیاز integer

مدت زمان غلاف آگهی، بر حسب میلی ثانیه.

scte35 اختیاری string

سیگنال SCTE-35 با کد Base64 برای این استراحت تبلیغاتی.

cust_params اختیاری string

مجموعه‌ای از جفت‌های کلید-مقدار که برای هدف‌یابی کمپین Ad Manager استفاده می‌شود. این جفت ها باید به عنوان یک رشته پرس و جو کدگذاری شده با آدرس اینترنتی نمایش داده شوند.

مثال:
پارامترها
  • بخش = sports
  • صفحه = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ یک لیست پخش چند متغیره HLS است.

روش: مانیفست غلاف DASH

یک مانیفست غلاف آگهی MPEG-DASH از جریان زنده را بازیابی می‌کند که برای بارگیری و پخش ویدیوی مشتری آماده است.

روش ها
GET GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/pod/{pod_id}/manifest.mpd

API برای بازیابی لیست پخش mpd MPEG-DASH برای یک آگهی.

درخواست HTTP 

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/stream/{stream_id}/pod/{pod_id}/manifest.mpd?pd={pod_duration}

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

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است

stream_id string

شناسه جریان برای جلسه کاربر فعلی. این مقدار با یک درخواست موفقیت آمیز به نقطه پایانی stream برگردانده می شود.

pod_id integer

شناسه عددی برای وقفه تبلیغاتی فعلی. شناسه‌های غلاف آگهی به‌صورت تدریجی برای هر رویداد وقفه تبلیغاتی، از 1 شروع می‌شود.

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

پارامترها
pd مورد نیاز integer

مدت زمان غلاف آگهی، بر حسب میلی ثانیه.

scte35 اختیاری string

سیگنال SCTE-35 با کد Base64 برای این استراحت تبلیغاتی.

cust_params اختیاری string

مجموعه‌ای از جفت‌های کلید-مقدار که برای هدف‌یابی کمپین Ad Manager استفاده می‌شود. این جفت ها باید به عنوان یک رشته پرس و جو کدگذاری شده با آدرس اینترنتی نمایش داده شوند.

مثال:
پارامترها
  • بخش = sports
  • صفحه = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ یک لیست پخش mpd MPEG-DASH است.

روش: الگوی دوره غلاف DASH

روش ها
pods GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

از Google Ad Manager یک الگوی دوره DASH درخواست می کند. این الگو حاوی ماکروهایی است که باید آنها را با پارامترهای جریان خود پر کنید. پس از پر شدن این ماکروها، الگو به دوره وقفه تبلیغاتی شما تبدیل می شود و می توان آن را در مانیفست DASH خود قرار داد.

درخواست HTTP 

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

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

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است.

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

پارامترها
stream_id مورد نیاز است string

شناسه جریان برای جلسه کاربر فعلی. این مقدار با یک درخواست موفقیت آمیز به نقطه پایانی stream برگردانده می شود.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی یک شی جدید PodTemplateResponse است.

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

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

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

روش ها
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 .
  • HTTP/1.1 404 Not Found اگر درخواست نمی تواند رسانه را به دلیل قالب بندی نادرست URL یا انقضا تأیید کند.
  • اگر درخواست تأیید قبلی برای این شناسه موفقیت آمیز بود، HTTP/1.1 404 Not Found .
  • HTTP/1.1 409 Conflict .

شناسه های رسانه تبلیغاتی

شناسه‌های رسانه تبلیغاتی در یک مسیر فراداده جداگانه کدگذاری می‌شوند - فراداده زمان‌بندی‌شده برای جریان انتقال HLS یا emsg برای فایل‌های mp4. شناسه های رسانه تبلیغاتی همیشه با رشته 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}

بدن پاسخگو

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

تجزیه فراداده

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

google_1234567890

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

داده های پاسخ

جریان

Stream برای ارائه فهرستی از منابع برای یک جریان تازه ایجاد شده در قالب JSON استفاده می شود.
نمایندگی JSON 
{
  "stream_id": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "heartbeat_url": string,
  "polling_frequency": number,
  "pod_manifest_url": string,
  "manifest_format": string,
}
فیلدها
stream_id string

شناسه جریان GAM.
media_verification_url string

نشانی وب تأیید رسانه که به عنوان نقطه پایانی پایه برای ردیابی رویدادهای پخش استفاده می‌شود.
metadata_url string

URL فراداده برای نظرسنجی اطلاعات دوره ای در مورد رویدادهای تبلیغات جریانی آتی استفاده می شود.
session_update_url string

نشانی وب به‌روزرسانی جلسه برای به‌روزرسانی پارامترهای هدف برای این جریان استفاده می‌شود. مقادیر اصلی برای پارامترهای هدف گیری در طول درخواست ایجاد جریان اولیه گرفته می شود.
heartbeat_url string

URL ضربان قلب، که برای زنده نگه داشتن جریان beaconing سمت سرور استفاده می‌شود، باید هر {PollingFrequency} ثانیه یک بار پینگ شود. پر شده برای جریان‌های نشان‌دهنده سمت سرور.
polling_frequency number

فرکانس نظرسنجی، در ثانیه، هنگام درخواست metadata_url یا heartbeat_url.
pod_manifest_url string

الگوی URL مانیفست غلاف برای تولید URL برای بازیابی مانیفست غلاف جریان، مطابق با URL فهرست پخش چند متغیره در HLS یا MPD در DASH استفاده می‌شود. پر شده برای رویدادهای پخش مستقیم از نوع درج آگهی پویا POD_SERVING_MANIFEST. https://developers.google.com/ad-manager/api/reference/v202305/LiveStreamEventService.DynamicAdInsertionType
manifest_format string

قالب مانیفست فرمت مانیفست بازیابی شده از pod_manifest_url، خط تیره یا hls است.

PodMetadata

PodMetadata حاوی اطلاعات فراداده در مورد تبلیغات، وقفه های تبلیغاتی و برچسب های شناسه رسانه است.
نمایندگی JSON
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}
فیلدها
tags map[string, object(TagSegment)]

نقشه بخش های برچسب نمایه شده با پیشوند برچسب.
ads map[string, object(Ad)]

نقشه تبلیغات نمایه شده با شناسه آگهی.
ad_breaks map[string, object(AdBreak)]

نقشه وقفه های تبلیغاتی نمایه شده با شناسه استراحت آگهی.

TagSegment

TagSegment حاوی یک مرجع به یک تبلیغ، وقفه تبلیغاتی آن و نوع رویداد است. TagSegment با type="progress" نباید به نقطه پایانی تأیید رسانه تبلیغات پینگ شود.
نمایندگی JSON
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
فیلدها
ad string

شناسه تبلیغ این تگ.
ad_break_id string

شناسه وقفه تبلیغاتی این تگ.
type string

نوع رویداد این برچسب

AdBreak

AdBreak یک وقفه تبلیغاتی را در جریان توصیف می کند. این شامل مدت زمان، نوع (اواسط/پیش/پست) و تعداد تبلیغات است.
نمایندگی JSON
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
فیلدها
type string

انواع وقفه های معتبر عبارتند از: pre، mid و post.
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

موقعیت این آگهی در وقفه آگهی، از 1 شروع می شود.
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

URL از طریق کلیک اختیاری.
click_tracking_urls string

URL های ردیابی کلیک اختیاری.
verifications [object(Verification)]

ورودی‌های تأیید اندازه‌گیری باز اختیاری که منابع و ابرداده‌های مورد نیاز برای اجرای کد اندازه‌گیری شخص ثالث را برای تأیید پخش خلاق فهرست می‌کنند.
slate boolean

bool اختیاری که نشان می دهد ورودی فعلی تخته سنگ است.
icons [object(Icon)]

فهرستی از نمادها که در صورت خالی بودن حذف می شوند.
wrappers [object(Wrapper)]

لیستی از Wrapper ها که در صورت خالی بودن حذف می شوند.
universal_ad_id object(UniversalAdID)

شناسه آگهی جهانی اختیاری.
extensions string

لیست اختیاری همه گره های <Extension> در VAST.
companions [object(Companion)]

همراهان اختیاری که ممکن است همراه با این آگهی نمایش داده شوند.
interactive_file object(InteractiveFile)

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

PodTemplateResponse

PodTemplateResponse نشان دهنده بار JSON است که برای دوخت غلاف به VTP بازگردانده شده است.
نمایندگی JSON
{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}
فیلدها
dash_period_template string

DashPeriodTemplate الگوی xml برای دوره ای است که باید قبل از دوخت با داده های مناسب پر شود.
segment_duration_ms int64

SegmentDurationMS مدت زمان بخش های دوره بر حسب میلی ثانیه است.

AdpodTimingMetadataResponse

AdpodTimingMetadataResponse حاوی اطلاعاتی در مورد Ad Pod و نحوه ساخت URL های بخش برای آن است.
نمایندگی JSON
{
  "status": string,
  "ads": [object(AdRendering)],
  "slate": object(SlateRendering),
  "dash_representations": map[string, object(DASHRepresentation)],
  "dash_adaptation_sets": map[string, object(DASHAdaptationSet)],
}
فیلدها
status string

وضعیت تصمیم گیری برای آگهی.
ads [object(AdRendering)]

آرایه ای از اشیاء تبلیغاتی که نحوه ارائه url های بخش تبلیغات را شرح می دهد که از 0 ایندکس شده است.
slate object(SlateRendering)

تخته سنگ توضیح می دهد که چگونه url های بخش تخته سنگ را ارائه کنید.
dash_representations map[string, object(DASHRepresentation)]

لیست بازنمودهای خط برای آن غلاف تبلیغاتی در مانیفست های داش ارائه می شود.
dash_adaptation_sets map[string, object(DASHAdaptationSet)]

لیست مجموعه های سازگاری DASH برای آن غلاف تبلیغاتی در مانیفست های داش ارائه می شود.

یک نشانگر

Adrendering نحوه ارائه یک تبلیغ تصمیم گیری را توصیف می کند.
نمایندگی JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
فیلدها
duration_ms number

مدت زمان تبلیغ ، در میلی ثانیه (int).
variants map[string, object(VariantRendering)]

فرهنگ لغت اشیاء مختلف (به تصویر زیر مراجعه کنید) ، که توسط شناسه Variant/Profile نمایه شده است ، همانطور که از UI پیکربندی شده است.

شستشو

Slaterendering نحوه ارائه محتوای صفحات را توصیف می کند.
نمایندگی JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
فیلدها
duration_ms number

مدت زمان تخته سنگ ، در میلی ثانیه (int).
variants map[string, object(VariantRendering)]

فرهنگ لغت اشیاء مختلف ، با شناسه متفاوت/مشخصات نمایه شده است. مدت زمان تخته سنگ باید حلقه شود تا طول تخته سنگ مورد نیاز به دست بیاید ، درج ناپیوستگی HLS بین تکرارها یا حلقه های جدید برای MPEG-DASH.

متغیر

Variantrendering یک نوع/پروفایل را در آگهی/تخته سنگ توصیف می کند.
نمایندگی JSON
{
  "segment_extension": string,
  "segment_durations": object(SegmentDurations),
}
فیلدها
segment_extension string

رشته ، یکی از: TS ، MP4 ، AAC ، AC3 ، EC3 ، M4A ، M4V. قسمت پسوند نام پرونده از URL های بخش.
segment_durations object(SegmentDurations)

اشیاء SegmentDurations. هر مدت زمان می تواند به یک URL بخش ترجمه شود.

بخشهای

بخش های بخش مدت زمان توالی بخش ها را در یک واحد زمانی مشخص توصیف می کند.
نمایندگی JSON
{
  "timescale": number,
  "values": [],
}
فیلدها
timescale number

Timescale تعداد واحدهای در ثانیه (int) است که انتظار می رود: 1000 برای HLS (میلی ثانیه) 90000 برای Dash Video (PTS) نرخ نمونه صوتی برای صدای Dash.
values number

آرایه ای از مدت زمان بخش int ، در واحدهای بازه زمانی.

نمایش

DashReventation گره های بازنمایی را که در مانیفست های داش ارائه می شود ، توصیف می کند.
نمایندگی JSON
{
  "codecs": string,
  "bandwidth": number,
  "width": number,
  "height": number,
  "frame_rate": string,
  "audio_sampling_rate": number,
  "audio_channel_config": object(SchemeIDURIAndValue),
}
فیلدها
codecs string

کدک های نمایندگی.
bandwidth number

پهنای باند نمایندگی.
width number

عرض نمایندگی.
height number

ارتفاع نمایندگی.
frame_rate string

نرخ فریم نمایندگی.
audio_sampling_rate number

میزان نمونه برداری صوتی نمایندگی.
audio_channel_config object(SchemeIDURIAndValue)

پیکربندی کانال صوتی نمایندگی.

DashAdaptationset

DashAdaptationset گره های Adaptiationset را که در مانیفست های داش ارائه می شود ، توصیف می کند.
نمایندگی JSON
{
  "content_type": string,
  "mime_type": string,
  "role": object(SchemeIDURIAndValue),
  "inband_event_stream": object(SchemeIDURIAndValue),
  "min_frame_rate": string,
  "max_frame_rate": string,
  "scan_type": string,
  "start_with_sap": string,
  "segment_alignment": boolean,
  "representations": [],
}
فیلدها
content_type string

نوع محتوای مجموعه سازگاری.
mime_type string

نوع MIME از مجموعه سازگاری.
role object(SchemeIDURIAndValue)

نقش مجموعه سازگاری.
inband_event_stream object(SchemeIDURIAndValue)

جریان رویداد با مجموعه سازگاری.
min_frame_rate string

حداقل نرخ فریم مجموعه سازگاری.
max_frame_rate string

حداکثر نرخ فریم مجموعه سازگاری.
scan_type string

نوع اسکن مجموعه سازگاری.
start_with_sap string

با SAP از مجموعه سازگاری شروع کنید.
segment_alignment boolean

تراز بخش مجموعه سازگاری.
representations string

بازنمایی مجموعه سازگاری.

مقادیر خاص

SchemeIduriandValue یک جفت شناسه طرح و ارزش آن است.
نمایندگی JSON
{
  "scheme_id_uri": string,
  "value": string,
}
فیلدها
scheme_id_uri string

طرح id uri از مقدار.
value string

ارزش طرح URI.

نماد

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

ClickData حاوی اطلاعاتی در مورد یک کلیک نماد است.
نمایندگی JSON
{
  "url": string,
}
فیلدها
url string

خط حمله

FallbackImage حاوی اطلاعاتی در مورد یک تصویر گسترده برگشتی است.
نمایندگی 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

لفاف

بسته بندی حاوی اطلاعاتی در مورد تبلیغ بسته بندی است. اگر وجود نداشته باشد ، شناسه معامله را شامل نمی شود.
نمایندگی 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

شناسه معاملات اختیاری برای تبلیغ بسته بندی.

تأیید

تأیید حاوی اطلاعاتی برای اندازه گیری باز است ، که قابلیت مشاهده شخص ثالث و اندازه گیری تأیید را تسهیل می کند. در حال حاضر ، فقط از منابع JavaScript پشتیبانی می شود. به https://iabtechlab.com/standards/open-mupearment-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

یک رشته مات به کد تأیید بوت استرپ منتقل شد.

javascripcriptresource

JavaScripTresource حاوی اطلاعاتی برای تأیید از طریق JavaScript است.
نمایندگی JSON
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
فیلدها
script_url string

URI به JavaScript Payload.
api_framework string

ApiframeWork نام چارچوب ویدیویی است که از کد تأیید استفاده می کند.
browser_optional boolean

آیا این اسکریپت را می توان در خارج از مرورگر اجرا کرد.

ردیابی کننده

TrackingEvent شامل URL هایی است که باید در شرایط خاص توسط مشتری پینگ شوند.
نمایندگی JSON
{
  "event": string,
  "uri": string,
}
فیلدها
event string

نوع رویداد ردیابی.
uri string

رویداد پیگیری برای پینگ شدن.

جهانی الدی

Universaladid برای تهیه یک شناسه خلاق منحصر به فرد که در سیستم های AD نگهداری می شود ، استفاده می شود.
نمایندگی JSON
{
  "id_value": string,
  "id_registry": string,
}
فیلدها
id_value string

شناسه تبلیغاتی جهانی خلاق انتخاب شده برای تبلیغ.
id_registry string

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

همراه

همراه حاوی اطلاعاتی برای تبلیغات همراه است که ممکن است همراه با AD نمایش داده شود.
نمایندگی 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> در وسیع اگر این یک همراه از نوع استاتیک باشد.
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

مقدار گره <dparameters> در وسیع.
،

API درج تبلیغاتی پویا به شما امکان می دهد تا Dai Livestreams را درخواست و ردیابی کنید.

سرویس: dai.google.com

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

روش: جریان

روش ها
stream POST /ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

یک جلسه Dai Dai Pod را که جلسه LIVESTREAM را ارائه می دهد ، ثبت می کند.

درخواست HTTP 

POST https://dai.google.com/ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

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

پارامترها
network_code string

کد شبکه شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی این رویداد را در Google Ad Manager مرتبط کرد.

درخواست بدن

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

پارامترها
پارامترهای هدفمند DFP اختیاری پارامترهای هدفمند اضافی.
پارامترهای جریان را نادیده بگیرید اختیاری مقادیر پیش فرض یک پارامتر ایجاد جریان را نادیده بگیرید.
احراز هویت HMAC اختیاری با استفاده از یک توکن مبتنی بر HMAC تأیید کنید.

بدن پاسخگو

در صورت موفقیت ، بدنه پاسخ حاوی یک شیء Stream جدید است.

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

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

روش: بخش POD

روش ها
pod segment GET /linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

یک جریان DAI برای شناسه رویداد داده شده ایجاد می کند.

درخواست HTTP 

GET https://dai.google.com/linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

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

پارامترها
network_code string

کد شبکه شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی این رویداد را در Google Ad Manager مرتبط کرد.

pod_identifier

قالب های زیر پشتیبانی می شوند:

pod/{integer}

شناسه عددی برای شکست آگهی فعلی. شناسه های غلاف تبلیغاتی برای هر رویداد شکست تبلیغاتی به صورت تدریجی اختصاص داده می شوند ، از 1 .

ad_break_id/{string}

شناسه رشته برای شکست تبلیغاتی فعلی. ناشر ارائه شده توسط شناسه AD Break محدودیت های مشابهی با AD POD ID ندارد. هر شناسه آگهی ناشناخته ارائه شده به آن نقطه پایانی ، یک آگهی جدید را برای رویداد Livestream ایجاد می کند.

profile_name string

نام نمایه رمزگذاری Google Ad Manager DAI . نمایه رمزگذاری باید یکی از پروفایل های رمزگذاری شده پیکربندی شده برای رویداد انتخاب شده باشد.

segment_number integer

شاخص بخش درخواست شده در غلاف تبلیغاتی فعلی ، از صفر شروع می شود.

segment_format string

پسوند پرونده مرتبط با قالب بخش درخواست شده. پسوندهای پذیرفته شده عبارتند از: ts ، mp4 ، vtt ، aac ، ac3 یا eac3 .

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

پارامترها
stream_id مورد نیاز است string

شناسه جریان برای جلسه کاربر فعلی. این مقدار با یک درخواست موفق به نقطه پایانی stream بازگردانده می شود.

sd required 1 integer

مدت زمان بخش درخواست شده ، در میلی ثانیه.

so اختیاری

جبران بخش درخواست شده در غلاف تبلیغاتی ، در میلی ثانیه. اگر پارامتر so را حذف کنید ، با ضرب مدت زمان قطعه توسط شماره قطعه محاسبه می شود.

pd مورد نیاز 2 integer

مدت زمان غلاف تبلیغاتی ، در میلی ثانیه.

auth-token مورد نیاز است string

نشانه HMAC امضا شده و رمزگذاری شده URL برای غلاف تبلیغاتی فعلی.

last اختیاری boolean

آخرین بخش در آگهی را نشان می دهد. این پارامتر را برای همه بخش های دیگر حذف کنید.

scte35 اختیاری string

SCTE-35Signal رمزگذاری شده Base64 برای این شکست تبلیغ.

cust_params اختیاری string

مجموعه ای از جفت های ارزش کلیدی ، که برای هدف قرار دادن تبلیغات تبلیغاتی استفاده می شود. این جفت ها باید به عنوان یک رشته پرس و جو رمزگذاری شده URL نشان داده شوند.

مثال:
پارامترها
  • بخش = sports
  • صفحه = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

پاورقی ها

  1. sd برای بخش های اولیه سازی لازم نیست. ↩
  2. pd برای رویدادهایی که دارای شکست های بدون آگهی بدون مدت هستند ، لازم نیست. ↩

مثال

دریافت کنید https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/ad_break_id/adbreak -2/پروفایل/8B8888CF79AD43F0800482FFC035A1AC_TS_A/1.TS؟ SO = 0 & SD = 10000 & PD = 30000 & stream_id = 8E19CBC6-850B-404C-99D7-860AA4A674CB: آزمون

دریافت کنید https://dai.google.com/linear/pods/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/pod/2/profi LE/8B888CF79AD43F0800482FFC035A1AC_TS_A/1.TS؟ SO = 0 & SD = 10000 & PD = 30000 & stream_id = 8E19CBC6-850B-404C-99D7-860AA4A674CB: آزمون

بدن پاسخگو

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

روش: HLS POD مانیفست

بازیابی یک مانیفست غلاف تبلیغاتی HLS از یک جریان مستقیم که برای بارگیری و بازی یک پخش کننده ویدیوی مشتری آماده است.

روش ها
GET GET /linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset}/{pod_identifier}.m3u8;

API برای بازیابی لیست پخش چند متغیره HLS برای یک غلاف تبلیغاتی.

درخواست HTTP 

GET https://dai.google.com/linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}.m3u8?stream_id={stream_id}&pd={pod_duration}

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

پارامترها
network_code string

کد شبکه شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی این رویداد را در Google Ad Manager مرتبط کرد

pod_identifier

قالب های زیر پشتیبانی می شوند:

pod/{integer}

شناسه عددی برای شکست آگهی فعلی. شناسه های غلاف تبلیغاتی برای هر رویداد شکست تبلیغاتی به صورت تدریجی اختصاص داده می شوند ، از 1 .

ad_break_id/{string}

شناسه رشته برای شکست تبلیغاتی فعلی. ناشر ارائه شده توسط شناسه AD Break محدودیت های مشابهی با AD POD ID ندارد. هر شناسه آگهی ناشناخته ارائه شده به آن نقطه پایانی ، یک آگهی جدید را برای رویداد Livestream ایجاد می کند.

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

پارامترها
stream_id مورد نیاز string

شناسه جریان برای جلسه کاربر فعلی. این مقدار با یک درخواست موفق به نقطه پایانی stream بازگردانده می شود.

pd مورد نیاز integer

مدت زمان غلاف تبلیغاتی ، در میلی ثانیه.

scte35 اختیاری string

SCTE-35Signal رمزگذاری شده Base64 برای این شکست تبلیغ.

cust_params اختیاری string

مجموعه ای از جفت های ارزش کلیدی ، که برای هدف قرار دادن تبلیغات تبلیغاتی استفاده می شود. این جفت ها باید به عنوان یک رشته پرس و جو رمزگذاری شده URL نشان داده شوند.

مثال:
پارامترها
  • بخش = sports
  • صفحه = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

بدن پاسخگو

در صورت موفقیت ، بدنه پاسخ یک لیست پخش چند منظوره HLS است.

روش: مانیفست غلاف

بازیابی یک غلاف تبلیغاتی MPEG-DASH از یک جریان مستقیم که برای بارگذاری و بازی یک پخش کننده ویدیوی مشتری آماده است.

روش ها
GET GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/pod/{pod_id}/manifest.mpd

API برای بازیابی لیست پخش MPEG-DASH MPD برای یک غلاف تبلیغاتی.

درخواست HTTP 

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/stream/{stream_id}/pod/{pod_id}/manifest.mpd?pd={pod_duration}

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

پارامترها
network_code string

کد شبکه شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی این رویداد را در Google Ad Manager مرتبط کرد

stream_id string

شناسه جریان برای جلسه کاربر فعلی. این مقدار با یک درخواست موفق به نقطه پایانی stream بازگردانده می شود.

pod_id integer

شناسه عددی برای شکست آگهی فعلی. شناسه های غلاف تبلیغاتی برای هر رویداد شکست تبلیغاتی به صورت تدریجی اختصاص داده می شوند ، از 1 .

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

پارامترها
pd مورد نیاز integer

مدت زمان غلاف تبلیغاتی ، در میلی ثانیه.

scte35 اختیاری string

SCTE-35Signal رمزگذاری شده Base64 برای این شکست تبلیغ.

cust_params اختیاری string

مجموعه ای از جفت های ارزش کلیدی ، که برای هدف قرار دادن تبلیغات تبلیغاتی استفاده می شود. این جفت ها باید به عنوان یک رشته پرس و جو رمزگذاری شده URL نشان داده شوند.

مثال:
پارامترها
  • بخش = sports
  • صفحه = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

بدن پاسخگو

در صورت موفقیت ، بدنه پاسخ یک لیست پخش MPEG-DASH MPD است.

روش: الگوی دوره غلاف

روش ها
pods GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

یک الگوی دوره DASH را از Google Ad Manager درخواست می کند. این الگوی حاوی ماکروهایی است که شما باید با پارامترهای جریان خود جمع شوید. پس از جمع شدن این ماکروها ، این الگوی به دوره شکست تبلیغ شما تبدیل می شود و می تواند در مانیفست داش شما بخیه شود.

درخواست HTTP 

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

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

پارامترها
network_code string

کد شبکه شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی این رویداد را در Google Ad Manager مرتبط کرد.

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

پارامترها
stream_id مورد نیاز است string

شناسه جریان برای جلسه کاربر فعلی. این مقدار با یک درخواست موفق به نقطه پایانی stream بازگردانده می شود.

بدن پاسخگو

در صورت موفقیت ، بدنه پاسخ حاوی یک شیء جدید PodTemplateResponse است.

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

پس از مواجهه با شناسه رسانه AD در هنگام پخش ، بلافاصله با استفاده از 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 .
  • HTTP/1.1 404 Not Found .
  • HTTP/1.1 404 Not Found .
  • HTTP/1.1 409 Conflict اگر درخواست دیگری در حال حاضر در حال ارسال پینگ است.

شناسه رسانه های تبلیغاتی

شناسه رسانه های تبلیغاتی در یک مسیر ابرداده جداگانه رمزگذاری می شود - ابرداده به موقع برای جریان حمل و نقل HLS یا EMSG برای پرونده های MP4. شناسه رسانه های تبلیغاتی همیشه با رشته 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}

بدن پاسخگو

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

ابرداده

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

google_1234567890

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

داده های پاسخ

جریان

جریان برای ارائه لیستی از منابع برای یک جریان تازه ایجاد شده با فرمت JSON استفاده می شود.
نمایندگی JSON 
{
  "stream_id": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "heartbeat_url": string,
  "polling_frequency": number,
  "pod_manifest_url": string,
  "manifest_format": string,
}
فیلدها
stream_id string

شناسه جریان GAM.
media_verification_url string

URL تأیید رسانه ای به عنوان نقطه پایانی برای ردیابی رویدادهای پخش استفاده می شود.
metadata_url string

URL ابرداده برای اطلاعات دوره ای در مورد رویدادهای تبلیغاتی جریان آینده استفاده می شود.
session_update_url string

URL به روزرسانی جلسه برای به روزرسانی پارامترهای هدفمند برای این جریان استفاده می شود. مقادیر اصلی برای پارامترهای هدفمند در طول درخواست ایجاد جریان اولیه ضبط می شوند.
heartbeat_url string

URL ضربان قلب ، که برای زنده نگه داشتن جریان چراغ سرور استفاده می شود ، باید در هر ثانیه {نظرسنجی فرکانس pinged شود. جمع شده برای جریان های چراغ جانبی سرور.
polling_frequency number

فرکانس نظرسنجی ، در چند ثانیه ، هنگام درخواست metadata_url یا heartbeat_url.
pod_manifest_url string

از الگوی URL مانیفست POD برای تولید URL برای بازیابی مانیفست غلاف یک جریان استفاده می شود ، مطابق با URL لیست پخش چند منظوره در HLS یا MPD در داش. برای رویدادهای زنده از نوع آگهی پویا از نوع POD_SERVING_MANIFEST جمع شده است. https://developers.google.com/ad-manager/api/reference/v202305/livestreameventservice.dynamicadinsertipe
manifest_format string

قالب مانیفست قالب مانیفست بازیابی شده از pod_manifest_url ، یا dash یا hls است.

غلاف

Podmetadata حاوی اطلاعات ابرداده در مورد تبلیغات ، آگهی های تبلیغاتی و برچسب های شناسه رسانه ای است.
نمایندگی JSON
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}
فیلدها
tags map[string, object(TagSegment)]

نقشه بخش های برچسب که توسط پیشوند برچسب نمایه می شوند.
ads map[string, object(Ad)]

نقشه تبلیغات با استفاده از آگهی شناسه.
ad_breaks map[string, object(AdBreak)]

نقشه آگهی های تبلیغاتی که توسط آگهی شناسه آگهی نمایه شده است.

نشان

TagSement شامل یک مرجع به یک آگهی ، شکستن آگهی آن و نوع رویداد است. برچسب با نوع = "پیشرفت" نباید به نقطه پایانی تأیید رسانه تبلیغ شود.
نمایندگی 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

تعداد تبلیغات در آگهی شکست.
AD یک تبلیغ در جریان را توصیف می کند.
نمایندگی 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

موقعیت این تبلیغ در آگهی آگهی ، از 1 شروع می شود.
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

URL Clickthrough اختیاری.
click_tracking_urls string

URL های Tracking URL های اختیاری.
verifications [object(Verification)]

ورودی های تأیید سنجی باز اختیاری که منابع و ابرداده های لازم برای اجرای کد اندازه گیری شخص ثالث را برای تأیید پخش خلاق ذکر می کند.
slate boolean

BOOL اختیاری که نشانگر ورودی فعلی است Slate است.
icons [object(Icon)]

لیستی از نمادها ، در صورت خالی بودن حذف شده است.
wrappers [object(Wrapper)]

لیستی از بسته بندی ها ، در صورت خالی حذف شده است.
universal_ad_id object(UniversalAdID)

شناسه تبلیغاتی جهانی اختیاری.
extensions string

لیست اختیاری از همه گره های <پسوند> در وسیع.
companions [object(Companion)]

همراهان اختیاری که ممکن است همراه با این تبلیغ نمایش داده شوند.
interactive_file object(InteractiveFile)

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

پاسخ

PodtemplaterEsponse نمایانگر بار JSON است که برای دوخت POD به VTP بازگردانده شده است.
نمایندگی JSON
{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}
فیلدها
dash_period_template string

Dashperiodtemplate الگوی XML است که دوره قبل از دوخت با داده های مناسب پر می شود.
segment_duration_ms int64

SegmentDurationms مدت زمان بخش های دوره در میلی ثانیه است.

adpodtimingmetadataresponse

AdpodtimingMetadataresponse حاوی اطلاعاتی در مورد غلاف تبلیغات و نحوه ساخت URL های بخش برای آن است.
نمایندگی JSON
{
  "status": string,
  "ads": [object(AdRendering)],
  "slate": object(SlateRendering),
  "dash_representations": map[string, object(DASHRepresentation)],
  "dash_adaptation_sets": map[string, object(DASHAdaptationSet)],
}
فیلدها
status string

وضعیت تصمیم گیری برای غلاف تبلیغاتی.
ads [object(AdRendering)]

آرایه ای از اشیاء تبلیغاتی که نحوه ارائه URL های بخش تبلیغاتی را توصیف می کنند ، از 0 استفاده می شود.
slate object(SlateRendering)

تخته سنگ در مورد نحوه ارائه URL های بخش صفحات.
dash_representations map[string, object(DASHRepresentation)]

لیست بازنمودهای خط برای آن غلاف تبلیغاتی در مانیفست های داش ارائه می شود.
dash_adaptation_sets map[string, object(DASHAdaptationSet)]

لیست مجموعه های سازگاری DASH برای آن غلاف تبلیغاتی در مانیفست های داش ارائه می شود.

یک نشانگر

Adrendering نحوه ارائه یک تبلیغ تصمیم گیری را توصیف می کند.
نمایندگی JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
فیلدها
duration_ms number

مدت زمان تبلیغ ، در میلی ثانیه (int).
variants map[string, object(VariantRendering)]

فرهنگ لغت اشیاء مختلف (به تصویر زیر مراجعه کنید) ، که توسط شناسه Variant/Profile نمایه شده است ، همانطور که از UI پیکربندی شده است.

شستشو

Slaterendering نحوه ارائه محتوای صفحات را توصیف می کند.
نمایندگی JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
فیلدها
duration_ms number

مدت زمان تخته سنگ ، در میلی ثانیه (int).
variants map[string, object(VariantRendering)]

فرهنگ لغت اشیاء مختلف ، با شناسه متفاوت/مشخصات نمایه شده است. مدت زمان تخته سنگ باید حلقه شود تا طول تخته سنگ مورد نیاز به دست بیاید ، درج ناپیوستگی HLS بین تکرارها یا حلقه های جدید برای MPEG-DASH.

متغیر

Variantrendering یک نوع/پروفایل را در آگهی/تخته سنگ توصیف می کند.
نمایندگی JSON
{
  "segment_extension": string,
  "segment_durations": object(SegmentDurations),
}
فیلدها
segment_extension string

رشته ، یکی از: TS ، MP4 ، AAC ، AC3 ، EC3 ، M4A ، M4V. قسمت پسوند نام پرونده از URL های بخش.
segment_durations object(SegmentDurations)

اشیاء SegmentDurations. هر مدت زمان می تواند به یک URL بخش ترجمه شود.

بخش های

بخش های بخش مدت زمان توالی بخش ها را در یک واحد زمانی مشخص توصیف می کند.
نمایندگی JSON
{
  "timescale": number,
  "values": [],
}
فیلدها
timescale number

Timescale تعداد واحدهای در ثانیه (int) است که انتظار می رود: 1000 برای HLS (میلی ثانیه) 90000 برای Dash Video (PTS) نرخ نمونه صوتی برای صدای Dash.
values number

آرایه ای از مدت زمان بخش int ، در واحدهای بازه زمانی.

نمایش

DashReventation گره های بازنمایی را که در مانیفست های داش ارائه می شود ، توصیف می کند.
نمایندگی JSON
{
  "codecs": string,
  "bandwidth": number,
  "width": number,
  "height": number,
  "frame_rate": string,
  "audio_sampling_rate": number,
  "audio_channel_config": object(SchemeIDURIAndValue),
}
فیلدها
codecs string

کدک های نمایندگی.
bandwidth number

پهنای باند نمایندگی.
width number

عرض نمایندگی.
height number

ارتفاع نمایندگی.
frame_rate string

نرخ فریم نمایندگی.
audio_sampling_rate number

میزان نمونه برداری صوتی نمایندگی.
audio_channel_config object(SchemeIDURIAndValue)

پیکربندی کانال صوتی نمایندگی.

DashAdaptationset

DashAdaptationset گره های Adaptiationset را که در مانیفست های داش ارائه می شود ، توصیف می کند.
نمایندگی JSON
{
  "content_type": string,
  "mime_type": string,
  "role": object(SchemeIDURIAndValue),
  "inband_event_stream": object(SchemeIDURIAndValue),
  "min_frame_rate": string,
  "max_frame_rate": string,
  "scan_type": string,
  "start_with_sap": string,
  "segment_alignment": boolean,
  "representations": [],
}
فیلدها
content_type string

نوع محتوای مجموعه سازگاری.
mime_type string

نوع MIME از مجموعه سازگاری.
role object(SchemeIDURIAndValue)

نقش مجموعه سازگاری.
inband_event_stream object(SchemeIDURIAndValue)

جریان رویداد با مجموعه سازگاری.
min_frame_rate string

حداقل نرخ فریم مجموعه سازگاری.
max_frame_rate string

حداکثر نرخ فریم مجموعه سازگاری.
scan_type string

نوع اسکن مجموعه سازگاری.
start_with_sap string

با SAP از مجموعه سازگاری شروع کنید.
segment_alignment boolean

تراز بخش مجموعه سازگاری.
representations string

بازنمایی مجموعه سازگاری.

مقادیر خاص

SchemeIduriandValue یک جفت شناسه طرح و ارزش آن است.
نمایندگی JSON
{
  "scheme_id_uri": string,
  "value": string,
}
فیلدها
scheme_id_uri string

طرح id uri از مقدار.
value string

ارزش طرح URI.

نماد

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

ClickData حاوی اطلاعاتی در مورد یک کلیک نماد است.
نمایندگی JSON
{
  "url": string,
}
فیلدها
url string

خط حمله

FallbackImage حاوی اطلاعاتی در مورد یک تصویر گسترده برگشتی است.
نمایندگی 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

لفاف

بسته بندی حاوی اطلاعاتی در مورد تبلیغ بسته بندی است. اگر وجود نداشته باشد ، شناسه معامله را شامل نمی شود.
نمایندگی 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

شناسه معاملات اختیاری برای تبلیغ بسته بندی.

تأیید

تأیید حاوی اطلاعاتی برای اندازه گیری باز است ، که قابلیت مشاهده شخص ثالث و اندازه گیری تأیید را تسهیل می کند. در حال حاضر ، فقط از منابع JavaScript پشتیبانی می شود. به https://iabtechlab.com/standards/open-mupearment-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

یک رشته مات به کد تأیید بوت استرپ منتقل شد.

javascripcriptresource

JavaScripTresource حاوی اطلاعاتی برای تأیید از طریق JavaScript است.
نمایندگی JSON
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
فیلدها
script_url string

URI به JavaScript Payload.
api_framework string

ApiframeWork نام چارچوب ویدیویی است که از کد تأیید استفاده می کند.
browser_optional boolean

آیا این اسکریپت را می توان در خارج از مرورگر اجرا کرد.

ردیابی کننده

TrackingEvent شامل URL هایی است که باید در شرایط خاص توسط مشتری پینگ شوند.
نمایندگی JSON
{
  "event": string,
  "uri": string,
}
فیلدها
event string

نوع رویداد ردیابی.
uri string

رویداد پیگیری برای پینگ شدن.

جهانی الدی

Universaladid برای تهیه یک شناسه خلاق منحصر به فرد که در سیستم های AD نگهداری می شود ، استفاده می شود.
نمایندگی JSON
{
  "id_value": string,
  "id_registry": string,
}
فیلدها
id_value string

شناسه تبلیغاتی جهانی خلاق انتخاب شده برای تبلیغ.
id_registry string

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

همراه

همراه حاوی اطلاعاتی برای تبلیغات همراه است که ممکن است همراه با AD نمایش داده شود.
نمایندگی 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> در وسیع اگر این یک همراه از نوع استاتیک باشد.
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

مقدار گره <dparameters> در وسیع.
،

API درج تبلیغاتی پویا به شما امکان می دهد تا Dai Livestreams را درخواست و ردیابی کنید.

سرویس: dai.google.com

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

روش: جریان

روش ها
stream POST /ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

یک جلسه Dai Dai Pod را که جلسه LIVESTREAM را ارائه می دهد ، ثبت می کند.

درخواست HTTP 

POST https://dai.google.com/ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

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

پارامترها
network_code string

کد شبکه شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی این رویداد را در Google Ad Manager مرتبط کرد.

درخواست بدن

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

پارامترها
پارامترهای هدفمند DFP اختیاری پارامترهای هدفمند اضافی.
پارامترهای جریان را نادیده بگیرید اختیاری مقادیر پیش فرض یک پارامتر ایجاد جریان را نادیده بگیرید.
احراز هویت HMAC اختیاری با استفاده از یک توکن مبتنی بر HMAC تأیید کنید.

بدن پاسخگو

در صورت موفقیت ، بدنه پاسخ حاوی یک شیء Stream جدید است.

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

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

روش: بخش POD

روش ها
pod segment GET /linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

یک جریان DAI برای شناسه رویداد داده شده ایجاد می کند.

درخواست HTTP 

GET https://dai.google.com/linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

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

پارامترها
network_code string

کد شبکه شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی این رویداد را در Google Ad Manager مرتبط کرد.

pod_identifier

قالب های زیر پشتیبانی می شوند:

pod/{integer}

شناسه عددی برای شکست آگهی فعلی. شناسه های غلاف تبلیغاتی برای هر رویداد شکست تبلیغاتی به صورت تدریجی اختصاص داده می شوند ، از 1 .

ad_break_id/{string}

شناسه رشته برای شکست تبلیغاتی فعلی. ناشر ارائه شده توسط شناسه AD Break محدودیت های مشابهی با AD POD ID ندارد. هر شناسه آگهی ناشناخته ارائه شده به آن نقطه پایانی ، یک آگهی جدید را برای رویداد Livestream ایجاد می کند.

profile_name string

نام نمایه رمزگذاری Google Ad Manager DAI . نمایه رمزگذاری باید یکی از پروفایل های رمزگذاری شده پیکربندی شده برای رویداد انتخاب شده باشد.

segment_number integer

شاخص بخش درخواست شده در غلاف تبلیغاتی فعلی ، از صفر شروع می شود.

segment_format string

پسوند پرونده مرتبط با قالب بخش درخواست شده. پسوندهای پذیرفته شده عبارتند از: ts ، mp4 ، vtt ، aac ، ac3 یا eac3 .

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

پارامترها
stream_id مورد نیاز است string

شناسه جریان برای جلسه کاربر فعلی. این مقدار با یک درخواست موفق به نقطه پایانی stream بازگردانده می شود.

sd required 1 integer

مدت زمان بخش درخواست شده ، در میلی ثانیه.

so اختیاری

جبران بخش درخواست شده در غلاف تبلیغاتی ، در میلی ثانیه. اگر پارامتر so را حذف کنید ، با ضرب مدت زمان قطعه توسط شماره قطعه محاسبه می شود.

pd مورد نیاز 2 integer

مدت زمان غلاف تبلیغاتی ، در میلی ثانیه.

auth-token مورد نیاز است string

نشانه HMAC امضا شده و رمزگذاری شده URL برای غلاف تبلیغاتی فعلی.

last اختیاری boolean

آخرین بخش در آگهی را نشان می دهد. این پارامتر را برای همه بخش های دیگر حذف کنید.

scte35 اختیاری string

SCTE-35Signal رمزگذاری شده Base64 برای این شکست تبلیغ.

cust_params اختیاری string

مجموعه ای از جفت های ارزش کلیدی ، که برای هدف قرار دادن تبلیغات تبلیغاتی استفاده می شود. این جفت ها باید به عنوان یک رشته پرس و جو رمزگذاری شده URL نشان داده شوند.

مثال:
پارامترها
  • بخش = sports
  • صفحه = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

پاورقی ها

  1. sd برای بخش های اولیه سازی لازم نیست. ↩
  2. pd برای رویدادهایی که دارای شکست های بدون آگهی بدون مدت هستند ، لازم نیست. ↩

مثال

دریافت کنید https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/ad_break_id/adbreak -2/پروفایل/8B8888CF79AD43F0800482FFC035A1AC_TS_A/1.TS؟ SO = 0 & SD = 10000 & PD = 30000 & stream_id = 8E19CBC6-850B-404C-99D7-860AA4A674CB: آزمون

دریافت کنید https://dai.google.com/linear/pods/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/pod/2/profi LE/8B888CF79AD43F0800482FFC035A1AC_TS_A/1.TS؟ SO = 0 & SD = 10000 & PD = 30000 & stream_id = 8E19CBC6-850B-404C-99D7-860AA4A674CB: آزمون

بدن پاسخگو

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

روش: HLS POD مانیفست

بازیابی یک مانیفست غلاف تبلیغاتی HLS از یک جریان مستقیم که برای بارگیری و بازی یک پخش کننده ویدیوی مشتری آماده است.

روش ها
GET GET /linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset}/{pod_identifier}.m3u8;

API برای بازیابی لیست پخش چند متغیره HLS برای یک غلاف تبلیغاتی.

درخواست HTTP 

GET https://dai.google.com/linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}.m3u8?stream_id={stream_id}&pd={pod_duration}

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

پارامترها
network_code string

کد شبکه شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی این رویداد را در Google Ad Manager مرتبط کرد

pod_identifier

قالب های زیر پشتیبانی می شوند:

pod/{integer}

شناسه عددی برای شکست آگهی فعلی. شناسه های غلاف تبلیغاتی برای هر رویداد شکست تبلیغاتی به صورت تدریجی اختصاص داده می شوند ، از 1 .

ad_break_id/{string}

شناسه رشته برای شکست تبلیغاتی فعلی. ناشر ارائه شده توسط شناسه AD Break محدودیت های مشابهی با AD POD ID ندارد. هر شناسه آگهی ناشناخته ارائه شده به آن نقطه پایانی ، یک آگهی جدید را برای رویداد Livestream ایجاد می کند.

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

پارامترها
stream_id مورد نیاز string

شناسه جریان برای جلسه کاربر فعلی. این مقدار با یک درخواست موفق به نقطه پایانی stream بازگردانده می شود.

pd مورد نیاز integer

مدت زمان غلاف تبلیغاتی ، در میلی ثانیه.

scte35 اختیاری string

SCTE-35Signal رمزگذاری شده Base64 برای این شکست تبلیغ.

cust_params اختیاری string

مجموعه ای از جفت های ارزش کلیدی ، که برای هدف قرار دادن تبلیغات تبلیغاتی استفاده می شود. این جفت ها باید به عنوان یک رشته پرس و جو رمزگذاری شده URL نشان داده شوند.

مثال:
پارامترها
  • بخش = sports
  • صفحه = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

بدن پاسخگو

در صورت موفقیت ، بدنه پاسخ یک لیست پخش چند منظوره HLS است.

روش: مانیفست غلاف

بازیابی یک غلاف تبلیغاتی MPEG-DASH از یک جریان مستقیم که برای بارگذاری و بازی یک پخش کننده ویدیوی مشتری آماده است.

روش ها
GET GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/pod/{pod_id}/manifest.mpd

API برای بازیابی لیست پخش MPEG-DASH MPD برای یک غلاف تبلیغاتی.

درخواست HTTP 

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/stream/{stream_id}/pod/{pod_id}/manifest.mpd?pd={pod_duration}

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

پارامترها
network_code string

کد شبکه شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی این رویداد را در Google Ad Manager مرتبط کرد

stream_id string

شناسه جریان برای جلسه کاربر فعلی. این مقدار با یک درخواست موفق به نقطه پایانی stream بازگردانده می شود.

pod_id integer

شناسه عددی برای شکست آگهی فعلی. شناسه های غلاف تبلیغاتی برای هر رویداد شکست تبلیغاتی به صورت تدریجی اختصاص داده می شوند ، از 1 .

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

پارامترها
pd مورد نیاز integer

مدت زمان غلاف تبلیغاتی ، در میلی ثانیه.

scte35 اختیاری string

SCTE-35Signal رمزگذاری شده Base64 برای این شکست تبلیغ.

cust_params اختیاری string

مجموعه ای از جفت های ارزش کلیدی ، که برای هدف قرار دادن تبلیغات تبلیغاتی استفاده می شود. این جفت ها باید به عنوان یک رشته پرس و جو رمزگذاری شده URL نشان داده شوند.

مثال:
پارامترها
  • بخش = sports
  • صفحه = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

بدن پاسخگو

در صورت موفقیت ، بدنه پاسخ یک لیست پخش MPEG-DASH MPD است.

روش: الگوی دوره غلاف

روش ها
pods GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

یک الگوی دوره DASH را از Google Ad Manager درخواست می کند. این الگوی حاوی ماکروهایی است که شما باید با پارامترهای جریان خود جمع شوید. پس از جمع شدن این ماکروها ، این الگوی به دوره شکست تبلیغ شما تبدیل می شود و می تواند در مانیفست داش شما بخیه شود.

درخواست HTTP 

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

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

پارامترها
network_code string

کد شبکه شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی این رویداد را در Google Ad Manager مرتبط کرد.

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

پارامترها
stream_id مورد نیاز است string

شناسه جریان برای جلسه کاربر فعلی. این مقدار با یک درخواست موفق به نقطه پایانی stream بازگردانده می شود.

بدن پاسخگو

در صورت موفقیت ، بدنه پاسخ حاوی یک شیء جدید PodTemplateResponse است.

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

پس از مواجهه با شناسه رسانه AD در هنگام پخش ، بلافاصله با استفاده از 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 .
  • HTTP/1.1 404 Not Found .
  • HTTP/1.1 404 Not Found .
  • HTTP/1.1 409 Conflict اگر درخواست دیگری در حال حاضر در حال ارسال پینگ است.

شناسه رسانه های تبلیغاتی

شناسه رسانه های تبلیغاتی در یک مسیر ابرداده جداگانه رمزگذاری می شود - ابرداده به موقع برای جریان حمل و نقل HLS یا EMSG برای پرونده های MP4. Ad media identifiers will always begin with the string google_ .

The entire text contents of the metadata entry should be appended to the ad verification URL prior to making each ad verification request.

Method: metadata

The metadata endpoint at metadata_url returns information used to build an ad UI. The metadata endpoint isn't available for server-side-beaconing streams, where the server is responsible for initiating ad media verification.

روش ها
metadata GET /{metadata_url}/{ad-media-id}

GET /{metadata_url}

Retrieves ad metadata information.

درخواست HTTP 

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

GET https://{metadata_url}

بدن پاسخگو

If successful, the response returns an instance of PodMetadata .

Parsing Metadata

Metadata has three discrete sections: tags , ads , and ad breaks . The entry point into the data is the tags section. From there, iterate through the tags and find the first entry whose name is a prefix for the ad media ID found in the video stream. For example, you might have an ad media ID that looks like:

google_1234567890

Then you find a tag object named google_12345 . In this case, it matches your ad media id. Once you find the correct ad media prefix object, you can look up ad ids, ad break ids, and the event type. Ad ids are then used to index the ads objects and ad break ids are used to index the breaks objects.

داده های پاسخ

جریان

Stream is used to render a list of resources for a newly created stream in JSON format.
نمایندگی JSON 
{
  "stream_id": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "heartbeat_url": string,
  "polling_frequency": number,
  "pod_manifest_url": string,
  "manifest_format": string,
}
فیلدها
stream_id string

The GAM stream identifier.
media_verification_url string

The media verification URL used as base endpoint for tracking playback events.
metadata_url string

Metadata URL used to poll for periodic information about upcoming stream ad events.
session_update_url string

The session's update URL used to update the targeting parameters for this stream. The original values for the targeting parameters are captured during the initial stream create request.
heartbeat_url string

The heartbeat URL, used to keep the server side beaconing stream alive, it must be pinged every {PollingFrequency} seconds. Populated for server side beaconing streams.
polling_frequency number

The polling frequency, in seconds, when requesting metadata_url or heartbeat_url.
pod_manifest_url string

The pod manifest URL template is used to generate the URL to retrieve a stream's pod manifest, corresponding to the URL of the multivariant playlist in HLS or the MPD in DASH. Populated for Livestream events of Dynamic Ad Insertion type POD_SERVING_MANIFEST. https://developers.google.com/ad-manager/api/reference/v202305/LiveStreamEventService.DynamicAdInsertionType
manifest_format string

Manifest format is the format of the manifest retrieved from pod_manifest_url, either dash or hls.

PodMetadata

PodMetadata contains metadata information on ads, ad breaks, and media ID tags.
نمایندگی JSON
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}
فیلدها
tags map[string, object(TagSegment)]

Map of tag segments indexed by tag prefix.
ads map[string, object(Ad)]

Map of ads indexed by ad ID.
ad_breaks map[string, object(AdBreak)]

Map of ad breaks indexed by ad break ID.

TagSegment

TagSegment contains a reference to an ad, its ad break, and event type. TagSegment with type="progress" should not be pinged to the ad media verification endpoint.
نمایندگی JSON
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
فیلدها
ad string

The ID of this tag's ad.
ad_break_id string

The ID of this tag's ad break.
type string

This tag's event type.

AdBreak

AdBreak describes a single ad break in the stream. It contains a duration, a type (mid/pre/post) and the number of ads.
نمایندگی JSON
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
فیلدها
type string

Valid break types are: pre, mid, and post.
duration number

Total ad duration for this ad break, in seconds.
expected_duration number

Expected duration of the ad break (in seconds), including all ads and any slate.
ads number

Number of ads in the ad break.
Ad describes an ad in the stream.
نمایندگی 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

The ID of this ad's ad break.
position number

Position of this ad in the ad break, starting at 1.
duration number

Duration of the ad, in seconds.
title string

Optional title of the ad.
description string

Optional description of the ad.
advertiser string

Optional advertiser identifier.
ad_system string

Optional ad system.
ad_id string

Optional ad ID.
creative_id string

Optional creative ID.
creative_ad_id string

Optional creative ad ID.
deal_id string

Optional deal ID.
clickthrough_url string

Optional clickthrough URL.
click_tracking_urls string

Optional click tracking URLs.
verifications [object(Verification)]

Optional Open Measurement verification entries which list the resources and metadata required to execute third-party measurement code to verify creative playback.
slate boolean

Optional bool indicating the current entry is slate.
icons [object(Icon)]

A list of icons, omitted if empty.
wrappers [object(Wrapper)]

A list of Wrappers, omitted if empty.
universal_ad_id object(UniversalAdID)

Optional universal ad ID.
extensions string

Optional list of all <Extension> nodes in the VAST.
companions [object(Companion)]

Optional companions that may be displayed along with this ad.
interactive_file object(InteractiveFile)

Optional interactive creative (SIMID) that should be displayed during ad playback.

PodTemplateResponse

PodTemplateResponse represents the JSON payload returned to a VTP for pod stitching.
نمایندگی JSON
{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}
فیلدها
dash_period_template string

DashPeriodTemplate is the xml template for the period to be filled with appropriate data before stitching.
segment_duration_ms int64

SegmentDurationMS is the duration of the period segments in milliseconds.

AdpodTimingMetadataResponse

AdpodTimingMetadataResponse contains information about the Ad Pod and how to build segment URLs for it.
نمایندگی JSON
{
  "status": string,
  "ads": [object(AdRendering)],
  "slate": object(SlateRendering),
  "dash_representations": map[string, object(DASHRepresentation)],
  "dash_adaptation_sets": map[string, object(DASHAdaptationSet)],
}
فیلدها
status string

Decision status for the ad pod.
ads [object(AdRendering)]

Array of Ad objects describing how to render the ad segment urls, indexed starting at 0.
slate object(SlateRendering)

Slate describing how to render the slate segment urls.
dash_representations map[string, object(DASHRepresentation)]

List of DASH Representations for that ad pod to be rendered in DASH manifests.
dash_adaptation_sets map[string, object(DASHAdaptationSet)]

List of DASH Adaptation Sets for that ad pod to be rendered in DASH manifests.

AdRendering

AdRendering describes how to render a decisioned ad.
نمایندگی JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
فیلدها
duration_ms number

Duration of the ad, in milliseconds (int).
variants map[string, object(VariantRendering)]

Dictionary of Variant objects (see below), indexed by the variant/profile ID, as configured from the UI.

SlateRendering

SlateRendering describes how to render slate content.
نمایندگی JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
فیلدها
duration_ms number

Duration of the slate, in milliseconds (int).
variants map[string, object(VariantRendering)]

Dictionary of Variant objects, indexed by variant/profile ID. Slate durations must be looped until the required slate length is reached, inserting HLS discontinuities between iterations, or looping new periods for MPEG-DASH.

VariantRendering

VariantRendering describes one variant/profile within the ad/slate.
نمایندگی JSON
{
  "segment_extension": string,
  "segment_durations": object(SegmentDurations),
}
فیلدها
segment_extension string

String, one of: ts, mp4, aac, ac3, ec3, m4a, m4v. Filename extension part of the segment URLs.
segment_durations object(SegmentDurations)

SegmentDurations objects. Each segment duration can be translated into a segment URL.

SegmentDurations

SegmentDurations describes the duration of a sequence of segments, in a specified time unit.
نمایندگی JSON
{
  "timescale": number,
  "values": [],
}
فیلدها
timescale number

Timescale is the number of units per second (int) Expected to be: 1000 for HLS (milliseconds) 90000 for DASH video (PTS) Audio sample rate for DASH audio.
values number

Array of int segment durations, in timescale units.

DASHRepresentation

DASHRepresentation describes Representation nodes to be rendered in DASH manifests.
نمایندگی JSON
{
  "codecs": string,
  "bandwidth": number,
  "width": number,
  "height": number,
  "frame_rate": string,
  "audio_sampling_rate": number,
  "audio_channel_config": object(SchemeIDURIAndValue),
}
فیلدها
codecs string

Codecs of the representation.
bandwidth number

Bandwidth of the representation.
width number

Width of the representation.
height number

Height of the representation.
frame_rate string

Frame rate of the representation.
audio_sampling_rate number

Audio sampling rate of the representation.
audio_channel_config object(SchemeIDURIAndValue)

Audio channel configuration of the representation.

DASHAdaptationSet

DASHAdaptationSet describes AdaptationSet nodes to be rendered in DASH manifests.
نمایندگی JSON
{
  "content_type": string,
  "mime_type": string,
  "role": object(SchemeIDURIAndValue),
  "inband_event_stream": object(SchemeIDURIAndValue),
  "min_frame_rate": string,
  "max_frame_rate": string,
  "scan_type": string,
  "start_with_sap": string,
  "segment_alignment": boolean,
  "representations": [],
}
فیلدها
content_type string

Content type of the adaptation set.
mime_type string

MIME type of the adaptation set.
role object(SchemeIDURIAndValue)

Role of the adaptation set.
inband_event_stream object(SchemeIDURIAndValue)

Inband event stream of the adaptation set.
min_frame_rate string

Minimum frame rate of the adaptation set.
max_frame_rate string

Maximum frame rate of the adaptation set.
scan_type string

Scan type of the adaptation set.
start_with_sap string

Start with SAP of the adaptation set.
segment_alignment boolean

Segment alignment of the adaptation set.
representations string

Representations of the adaptation set.

SchemeIDURIAndValue

SchemeIDURIAndValue is a pair of a scheme ID and its value.
نمایندگی JSON
{
  "scheme_id_uri": string,
  "value": string,
}
فیلدها
scheme_id_uri string

Scheme ID URI of the value.
value string

Value of the scheme ID URI.

نماد

Icon contains information about a VAST Icon.
نمایندگی 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

ClickData contains information about an icon clickthrough.
نمایندگی JSON
{
  "url": string,
}
فیلدها
url string

FallbackImage

FallbackImage contains information about a VAST fallback image.
نمایندگی 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 contains information about a wrapper ad. It does not include a Deal ID if it does not exist.
نمایندگی JSON
{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}
فیلدها
system string

Ad system identifier.
ad_id string

Ad ID used for the wrapper ad.
creative_id string

Creative ID used for the wrapper ad.
creative_ad_id string

Creative Ad ID used for the wrapper ad.
deal_id string

Optional deal ID for the wrapper ad.

تأیید

Verification contains information for Open Measurement, which facilitates third-party viewability and verification measurement. Currently, only JavaScript resources are supported. See https://iabtechlab.com/standards/open-measurement-sdk/
نمایندگی JSON
{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}
فیلدها
vendor string

The verification vendor.
java_script_resources [object(JavaScriptResource)]

List of JavaScript resources for the verification.
tracking_events [object(TrackingEvent)]

List of tracking events for the verification.
parameters string

An opaque string passed to bootstrap verification code.

JavaScriptResource

JavaScriptResource contains information for verification via JavaScript.
نمایندگی JSON
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
فیلدها
script_url string

URI to javascript payload.
api_framework string

APIFramework is the name of the video framework exercising the verification code.
browser_optional boolean

Whether this script can be run outside of a browser.

TrackingEvent

TrackingEvent contains URLs that should be pinged by the client in certain situations.
نمایندگی JSON
{
  "event": string,
  "uri": string,
}
فیلدها
event string

The type of the tracking event.
uri string

The tracking event to be pinged.

UniversalAdID

UniversalAdID is used to provide a unique creative identifier that is maintained across ad systems.
نمایندگی JSON
{
  "id_value": string,
  "id_registry": string,
}
فیلدها
id_value string

The Universal Ad ID of the selected creative for the ad.
id_registry string

A string used to identify the URL for the registry website where the selected creative's Universal Ad ID is cataloged.

همراه

Companion contains information for companion ads that may be displayed along with ad.
نمایندگی 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)

The click data for this companion.
creative_type string

The CreativeType attribute on the <StaticResource> node in the VAST if this is a companion of type static.
height int32

The height in pixels of this companion.
width int32

The width in pixels of this companion.
resource string

For static and iframe companions this will be the URL to be loaded and displayed. For HTML companions, this will be the HTML snippet that should be shown as the companion.
type string

Type of this companion. It can be either static, iframe or HTML.
ad_slot_id string

The slot ID for this companion.
api_framework string

The API framework for this companion.
tracking_events [object(TrackingEvent)]

List of tracking events for this companion.

InteractiveFile

InteractiveFile contains information for interactive creative (ie SIMID) that should be displayed during ad playback.
نمایندگی JSON
{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}
فیلدها
resource string

The URL to the interactive creative.
type string

The MIME type of the file provided as the resource.
variable_duration boolean

Whether this creative may ask for the duration to be extended.
ad_parameters string

The value of the <AdParameters> node in the VAST.