Pod Insertion Ad Dynamic Serving VOD API, Dynamic Ad Insertion pod Serving VOD API

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

خدمات: dai.google.com

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

روش: ایجاد جریان

این روش یک جریان مستقیماً از دستگاه ایجاد می‌کند و تمام منابع مورد نیاز برای برنامه مشتری برای پخش و ردیابی تبلیغات و نمایش عناصر رابط کاربری را برمی‌گرداند.

روش ها
create stream	POST: /ondemand/pods/api/v1/network/{network_code}/stream یک غلاف DAI ارائه جلسه VOD ایجاد کنید.

درخواست HTTP

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

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

پارامترها
network_code	string کد شبکه Google Ad Manager ناشر.

درخواست بدن

بدنه درخواست از نوع application/json است و باید حاوی یک شی CreateStreamRequest باشد.

بدن پاسخگو

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

روش: ثبت جریان

این روش یک جریان را در پشتیبان Google DAI از دستگاه ثبت می‌کند و تمام منابع مورد نیاز برای برنامه مشتری برای ردیابی تبلیغات و نمایش عناصر رابط کاربری را برمی‌گرداند. برخلاف روش create stream ، این روش مانیفست تبلیغات قابل پخش را برنمی‌گرداند. درعوض، این عمل در یک فراخوانی سرور جداگانه انجام می‌شود: decision ad pods .

روش ها
register stream	POST: /ondemand/pods/api/v1/network/{network_code}/stream_registration یک غلاف DAI در حال ارائه جلسه VOD را ثبت می کند.

درخواست HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream_registration

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

پارامترها
network_code	string کد شبکه Google Ad Manager ناشر.

درخواست بدن

بدنه درخواست از نوع application/json است و باید حاوی یک شی StreamRegistrationRequest باشد.

بدن پاسخگو

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

روش: بازیابی غلاف های تبلیغاتی

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

روش ها
decision ad pods	POST: /ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods پادهای تبلیغات تصمیم برای یک پاد DAI در حال ارائه جلسه VOD.

درخواست HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

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

پارامترها
network_code	string کد شبکه Google Ad Manager ناشر.
stream_id	string stream_id از یک تماس stream_registration دریافت شد.

درخواست بدن

بدنه درخواست از نوع application/json است و باید حاوی یک شی AdPodDecisionRequest باشد.

بدن پاسخگو

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

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

این روش تمام اطلاعات مورد نیاز برای برنامه مشتری برای ردیابی تبلیغات و ارائه دقیق عناصر رابط کاربری مناسب را برمی گرداند.

روش ها
ad pods metadata	GET: /ondemand/pods/api/v1/network/.../metadata فراداده های غلاف تبلیغات را برای یک جلسه خاص بازیابی کنید. این URL در ویژگی StreamRegistrationResponse metadata_url برگردانده شده است.

درخواست HTTP

GET: /ondemand/pods/api/v1/network/.../metadata

بدن پاسخگو

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

داده ها

PodMetadata

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

نمایندگی JSON
{ "tags": map[string, object(TagSegment)], "ads": map[string, object(Ad)], "ad_breaks": map[string, object(AdBreak)], "polling_frequency": number, }

فیلدها
tags	map[string, object(TagSegment)] نقشه بخش های برچسب نمایه شده با پیشوند برچسب.
ads	map[string, object(Ad)] نقشه تبلیغات نمایه شده با شناسه آگهی.
ad_breaks	map[string, object(AdBreak)] نقشه وقفه های تبلیغاتی نمایه شده با شناسه استراحت آگهی.
polling_frequency	number فرکانس نظرسنجی URL فراداده توصیه شده، در چند ثانیه. پر شده برای جریان های VOD با استفاده از تصمیم گیری بر اساس تقاضا.

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) که باید در حین پخش آگهی نمایش داده شود.

MatchOpts

MatchOpts الزامات تطبیق رسانه را برای یک جریان مشخص می کند.

نمایندگی JSON
{ "audio_channels": boolean, "audio_sample_rate": boolean, }

فیلدها
audio_channels	boolean کانال های صوتی را بین محتوا و تبلیغات مطابقت دهید.
audio_sample_rate	boolean نرخ نمونه صوتی را بین محتوا و تبلیغات مطابقت دهید.

CreateStreamRequest

CreateStreamRequest اطلاعاتی را که در درخواست‌های HTTP به API سرویس‌دهنده VOD یافت می‌شود، توصیف می‌کند. ایجاد جریان توسط VTP (شریک فناوری ویدیو)، از طرف SDK و ناشر، برای هر کاربر آغاز می شود. استریم نتایج را در غلاف‌های تبلیغاتی تصمیم‌گیری برای دوخت VTP ایجاد کرد. این برخلاف جریان StreamRegistrationRequest+AdPodDecisionRequest است که یک جریان را ثبت می کند و ادپادهای تصمیم را در چندین درخواست تصمیم می گیرد.

نمایندگی JSON
{ "encoding_profiles": [object(EncodingProfile)], "ad_tag": string, "cuepoints": [], "manifest_type": string, "enable_hls_asset_list": boolean, "targeting_parameters": map[string, string], "content_duration_seconds": number, "decision_timing_options": object(DecisionTimingOptions), "enable_inline_manifests": boolean, "dai_options": object(CreateStreamOptions), }

فیلدها
encoding_profiles	[object(EncodingProfile)] لیستی از پروفایل های رمزگذاری مورد نیاز.
ad_tag	string تگ تبلیغات پایه برای تصمیم گیری مورد نیاز.
cuepoints	number لیستی از نقاط نشانه، در چند ثانیه. زمانی که پاسخ تگ آگهی از جابجایی های زمانی موقعیتی استفاده می کند، الزامی است.
manifest_type	string انواع مانیفست معتبر عبارتند از: hls و dash. پیش فرض: hls. اختیاری.
enable_hls_asset_list	boolean نشان می دهد که آیا فهرست دارایی های HLS بینابینی فعال است یا خیر. هنگامی که فعال باشد، DAI URL های لیست دارایی را برای هر adbreak برمی گرداند، که می تواند برای موارد بینابینی HLS استفاده شود.
targeting_parameters	string پارامترهای هدفمند Ad Manager اضافی. اختیاری.
content_duration_seconds	number ContentDurationSeconds مدت زمان محتوا بر حسب ثانیه است. زمانی که پاسخ تگ تبلیغات از درصد جبران زمان استفاده می کند، الزامی است.
decision_timing_options	object(DecisionTimingOptions) نشان می دهد که چه زمانی باید adpod ها تصمیم گیری شوند.
enable_inline_manifests	boolean نشان می دهد که آیا مانیفست های شکست باید در پاسخ JSON درج شوند یا خیر.
dai_options	object(CreateStreamOptions) گزینه های DAI برای ایجاد جریان.

CreateStreamOptions

CreateStreamOptions گزینه های موجود در جریان یک مرحله ای ایجاد گردش کار را نشان می دهد.

نمایندگی JSON
{ "dash_profile": string, "match_options": object(MatchOpts), "data_sharing_policy_code": string, "sam_id": string, "session_title": string, "dash_inband_event_stream": boolean, "distinct_ad_profiles": boolean, "tracking_mode": string, "emsg_version": uint32, }

فیلدها
dash_profile	string نمایه MPEG-DASH برای استفاده، "زنده" یا "بر اساس تقاضا".
match_options	object(MatchOpts)
data_sharing_policy_code	string به ناشران اجازه می دهد تا خط مشی اشتراک گذاری داده پیش فرض شبکه را نادیده بگیرند.
sam_id	string sam_id کلید اشکال زدایی SAM برای جلسه است، اختیاری است.
session_title	string session_title عنوان جلسه SAM برای جریان است، اختیاری است.
dash_inband_event_stream	boolean dash_inband_event_stream نشان می‌دهد که DAI پیام‌های ID3 را به‌عنوان رویدادهای درون باند (در رسانه) با استفاده از عنصر InbandEventStream به جای عناصر EventStream (در مانیفست) درج می‌کند.
distinct_ad_profiles	boolean اگر روی درست تنظیم شود، نشان می‌دهد که سرور هنگام مطابقت با نمایه‌های رمزگذاری درخواستی، از هر نمایه تبلیغاتی موجود حداکثر یک بار استفاده می‌کند.
tracking_mode	string tracking_mode نوع ردیابی آگهی برای استفاده در جریان است، اختیاری است. مقادیر معتبر عبارتند از: 'ad_media'، 'server'، 'client'.
emsg_version	uint32 emsg_version یک نسخه emsg خاص را مجبور می کند که برای ID3های درون رسانه ای استفاده شود. فقط زمانی پشتیبانی می شود که dash_inband_event_stream درست باشد.

StreamRegistrationRequest

StreamRegistrationRequest جریانی را از دستگاه برای تصمیم گیری در مورد adpod در آینده ثبت می کند. این برخلاف CreateStreamRequest است که یک جریان ایجاد می کند و در یک درخواست واحد تصمیم گیری می کند.

نمایندگی JSON
{ "targeting_parameters": map[string, string], "dai_options": object(StreamRegistrationOptions), }

فیلدها
targeting_parameters	string پارامترهای هدفمند Ad Manager اضافی. اختیاری.
dai_options	object(StreamRegistrationOptions) گزینه های DAI برای ثبت جریان.

StreamRegistrationOptions

StreamRegistrationOptions گزینه های موجود برای ایجاد جریان را فهرست می کند

نمایندگی JSON
{ "sam_id": string, "tracking_mode": string, "emsg_version": uint32, "skippable_ads_supported": boolean, }

فیلدها
sam_id	string sam_id کلید اشکال زدایی SAM برای جلسه است، اختیاری است.
tracking_mode	string tracking_mode نوع ردیابی آگهی برای استفاده در جریان است، اختیاری است. مقادیر معتبر عبارتند از: 'ad_media'، 'server'، 'client'.
emsg_version	uint32 emsg_version یک نسخه emsg خاص را مجبور می کند که برای ID3های درون رسانه ای استفاده شود. فقط زمانی پشتیبانی می شود که dash_inband_event_stream درست باشد.
skippable_ads_supported	boolean نشان می دهد که آیا تبلیغات قابل رد شدن پشتیبانی می شوند یا خیر.

StreamRegistrationResponse

StreamRegistrationResponse نشان دهنده پاسخ json است که در پاسخ به StreamRegistrationRequest به مشتری ارسال می شود. این شامل شناسه جریان و تمام URL هایی است که دستگاه به آن نیاز دارد. شناسه جریان را می توان در درخواست تصمیم بعدی adpod ارجاع داد. این برخلاف CreateStreamResponse است که پاسخی برای ایجاد جریان و تصمیم‌گیری همزمان Adpods را نشان می‌دهد.

نمایندگی JSON
{ "stream_id": string, "media_verification_url": string, "valid_for": string, "valid_until": string, "metadata_url": string, }

فیلدها
stream_id	string StreamID شناسه منحصربه‌فرد برای جریان فعلی این بیننده است.
media_verification_url	string MediaVerificationURL پیشوند URL است که در درخواست های تأیید رسانه تبلیغاتی که در زیر توضیح داده شده است استفاده می شود. برای جریان های چراغ گردان سمت مشتری وجود ندارد.
valid_for	string ValidFor مدت زمانی است که این جریان در قالب "00h00m00s" معتبر است.
valid_until	string ValidUntil تاریخ و زمانی است که تا آن زمان این جریان معتبر است.
metadata_url	string MetadataURL URL فراداده ای است که برای درخواست ابرداده adpod استفاده می شود.

DecisionTimingOptions

DecisionTimingOptions گزینه‌های زمان‌بندی برای تصمیم‌گیری adbreak‌ها را برای جریان توصیف می‌کند.

نمایندگی JSON
{ "type": string, "on_create_breaks": [], }

فیلدها
type	string نوع توضیح می دهد که چه زمانی adpod برای جریان تصمیم گیری می شود. انواع معتبر عبارتند از: on_create (پیش فرض)، on_demand. هنگامی که نوع بر روی تقاضا است، زمانی که مانیفست برای یک استراحت خاص درخواست می شود، تبلیغات با تنبلی تصمیم گیری می شوند. وقتی نوع on_create است، همه تبلیغات هنگام ایجاد جریان تصمیم گیری می شوند.
on_create_breaks	string OnCreateBreaks لیستی از breakID های VMAP حساس به حروف بزرگ و کوچک است که باید در هنگام ایجاد جریان تصمیم گیری شود. این فیلد فقط در صورتی مجاز است که نوع آن on_demand باشد. شناسه‌های وقفه تبلیغاتی ویژه «preroll» و «postroll» را می‌توان برای نشان دادن اینکه در زمان ایجاد جریان تصمیم‌گیری در مورد وقفه قبل از پخش یا postroll انجام شود.

EncodingProfile

EncodingProfile رمزگذاری یک نوع محتوای واحد را توصیف می کند. ممکن است فقط تنظیمات ویدیو، فقط تنظیمات صدا (در مورد نوع رسانه)، هر دو تنظیمات ویدیو و صدا، یا هیچ کدام در مورد زیرنویس باشد.

نمایندگی JSON
{ "profile_name": string, "type": string, "container_type": string, "video_settings": object(VideoSettings), "audio_settings": object(AudioSettings), "subtitle_settings": object(SubtitleSettings), }

فیلدها
profile_name	string ناشر نامی را برای نمایه ارائه کرده است. منحصر به فرد در هر جریان. مورد نیاز.
type	string انواع معتبر عبارتند از: رسانه، iframe، زیرنویس. مورد نیاز.
container_type	string انواع معتبر عبارتند از: mpeg2ts، fmp4cmaf و hls_packed_audio. برای نوع رسانه و iframe مورد نیاز است.
video_settings	object(VideoSettings) اگر نوع کانتینر iframe باشد، تنظیمات ویدیو مورد نیاز است. در غیر این صورت، فقط در صورتی حضور دارند که نمایه حاوی ویدیو باشد.
audio_settings	object(AudioSettings) اگر نمایه حاوی صدا باشد، تنظیمات صدا وجود دارد. تنظیمات صدا فقط در صورتی مجاز است که نوع ظرف رسانه ای باشد.
subtitle_settings	object(SubtitleSettings) تنظیمات زیرنویس برای نوع زیرنویس مورد نیاز است.

تنظیمات ویدیو

VideoSettings ویدیوی یک نمایه رمزگذاری را توصیف می کند. اگر یک تنظیم ویدیو وجود دارد، همه باید وجود داشته باشند.

نمایندگی JSON
{ "codec": string, "bitrate": int32, "frames_per_second": number, "resolution": object(Resolution), }

فیلدها
codec	string رشته کدک RFC6381 ویدیو.
bitrate	int32 حداکثر نرخ بیت ویدیوی نمایه رمزگذاری.
frames_per_second	number فریم در ثانیه ویدیو
resolution	object(Resolution) وضوح عرض x ارتفاع ویدیو.

تنظیمات صوتی

AudioSettings صدای یک نمایه رمزگذاری را توصیف می کند. اگر یک تنظیم صوتی وجود دارد، همه باید وجود داشته باشند.

نمایندگی JSON
{ "codec": string, "bitrate": int32, "channels": int32, "sample_rate": int64, }

فیلدها
codec	string رشته کدک RFC6381 صدا.
bitrate	int32 حداکثر نرخ بیت صوتی نمایه رمزگذاری.
channels	int32 تعداد کانال های صوتی (از جمله کانال های فرکانس پایین).
sample_rate	int64 نرخ نمونه صدا، بر حسب هرتز.

تنظیمات زیرنویس

SubtitleSettings زیرنویس نمایه های رمزگذاری را توصیف می کند.

نمایندگی JSON
{ "format": string, "language": string, }

فیلدها
format	string فرمت زیرنویس ها: webvtt برای hls، webvtt یا ttml برای خط تیره.
language	string زبانی که باید در مانیفست درج شود.

قطعنامه

رزولوشن عرض x ارتفاع یک ویدیو را توصیف می کند.

نمایندگی JSON
{ "width": int32, "height": int32, }

فیلدها
width	int32 عرض ویدیو، بر حسب پیکسل. مورد نیاز.
height	int32 ارتفاع ویدیو، بر حسب پیکسل. مورد نیاز.

AdPodDecisionRequest

AdPodDecisionRequest یک درخواست برای adpods تصمیم برای جریانی که قبلاً ثبت شده است را نشان می دهد.

نمایندگی JSON
{ "encoding_profiles": [object(EncodingProfile)], "ad_tag": string, "cuepoints": [], "manifest_type": string, "enable_hls_asset_list": boolean, "targeting_parameters": map[string, string], "content_duration_seconds": number, "decision_timing_options": object(DecisionTimingOptions), "enable_inline_manifests": boolean, "dai_options": object(AdPodDecisionOptions), }

فیلدها
encoding_profiles	[object(EncodingProfile)] لیستی از پروفایل های رمزگذاری مورد نیاز.
ad_tag	string تگ تبلیغات پایه برای تصمیم گیری مورد نیاز.
cuepoints	number لیستی از نقاط نشانه، در چند ثانیه. زمانی که پاسخ تگ آگهی از جابجایی های زمانی موقعیتی استفاده می کند، الزامی است.
manifest_type	string انواع مانیفست معتبر عبارتند از: hls و dash. پیش فرض: hls. اختیاری.
enable_hls_asset_list	boolean نشان می دهد که آیا فهرست دارایی های HLS بینابینی فعال است یا خیر. هنگامی که فعال باشد، DAI URL های لیست دارایی را برای هر adbreak برمی گرداند، که می تواند برای موارد بینابینی HLS استفاده شود.
targeting_parameters	string پارامترهای هدفمند Ad Manager اضافی. اختیاری.
content_duration_seconds	number ContentDurationSeconds مدت زمان محتوا بر حسب ثانیه است. زمانی که پاسخ تگ تبلیغات از درصد جبران زمان استفاده می کند، الزامی است.
decision_timing_options	object(DecisionTimingOptions) نشان می دهد که چه زمانی باید adpod ها تصمیم گیری شوند.
enable_inline_manifests	boolean نشان می دهد که آیا مانیفست های شکست باید در پاسخ JSON درج شوند یا خیر.
dai_options	object(AdPodDecisionOptions) گزینه های DAI برای تصمیم گیری غلاف آگهی.

AdPodDecisionResponse

AdPodDecisionResponse پاسخی به adpods تصمیم برای جریانی که قبلاً ثبت شده است را نشان می دهد. این شامل فهرستی از غلاف های تبلیغاتی است که برای آن جریان تصمیم گرفته شده است.

نمایندگی JSON
{ "valid_for": string, "valid_until": string, "ad_pods": [object(AdPod)], }

فیلدها
valid_for	string ValidFor مدت زمانی است که این جریان در قالب "00h00m00s" معتبر است.
valid_until	string ValidUntil تاریخ و زمانی است که تا آن زمان این جریان معتبر است.
ad_pods	[object(AdPod)] فهرستی از غلاف آگهی که بر اساس ترتیب درج مرتب شده اند.

CreateStreamResponse

CreateStreamResponse نشان دهنده پاسخ json است که در پاسخ به CreateStreamRequest به مشتری ارسال می شود.

نمایندگی JSON
{ "valid_for": string, "valid_until": string, "ad_pods": [object(AdPod)], "stream_id": string, "media_verification_url": string, "pod_metadata": object(PodMetadata), "metadata_url": string, }

فیلدها
valid_for	string ValidFor مدت زمانی است که این جریان در قالب "00h00m00s" معتبر است.
valid_until	string ValidUntil تاریخ و زمانی است که تا آن زمان این جریان معتبر است.
ad_pods	[object(AdPod)] فهرستی از غلاف آگهی که بر اساس ترتیب درج مرتب شده اند.
stream_id	string StreamID شناسه منحصربه‌فرد برای جریان فعلی این بیننده است.
media_verification_url	string MediaVerificationURL پیشوند URL است که در درخواست های تأیید رسانه تبلیغاتی که در زیر توضیح داده شده است استفاده می شود. برای جریان های چراغ گردان سمت مشتری وجود ندارد.
pod_metadata	object(PodMetadata) PodMetadata حاوی اطلاعات اضافی مورد نیاز برای رندر کردن غلاف در دستگاه و تأیید صحت است. همانطور که در اسناد API خطی درج تبلیغات پویا توضیح داده شده است. فقط برای جریان های چراغ گردان سمت مشتری گنجانده شده است.
metadata_url	string MetadataURL URL فراداده ای است که برای درخواست ابرداده adpod استفاده می شود.

AdPod

AdPod نشان دهنده یک استراحت تبلیغاتی تصمیم گیری شده برای پخش است.

نمایندگی JSON
{ "manifest_uris": map[string, string], "multivariant_uri": string, "mpd_uri": string, "manifests": map[string, string], "multivariant_manifest": string, "mpd_manifest": string, "asset_list_uri": string, "start": number, "duration": number, "type": string, "midroll_index": number, }

فیلدها
manifest_uris	string ManifestURIs نقشه ای از رمزگذاری نام نمایه به نوع HLS manifest_uris برای محتوای HLS است.
multivariant_uri	string MultivariantURI URI برای مانیفست چند متغیره برای محتوای HLS است.
mpd_uri	string MPDURI URI برای MPD برای محتوای DASH است.
manifests	string Manifests نقشه ای از رمزگذاری نام نمایه در مانیفست نوع HLS است. فقط در صورتی پر می شود که جریان دارای enable_inline_manifests روی true باشد.
multivariant_manifest	string MultivariantManifest مانیفست چند متغیره برای محتوای HLS است. فقط در صورتی پر می شود که جریان دارای enable_inline_manifests روی true باشد.
mpd_manifest	string MPDManifest مانیفست MPD برای محتوای DASH است. فقط در صورتی پر می شود که جریان دارای enable_inline_manifests روی true باشد.
asset_list_uri	string AssetListURI URI فهرست دارایی های بینابینی HLS برای محتوای HLS است. تنها در صورتی پر می‌شود که جریان دارای فهرست دارایی‌های میان‌اثر HLS فعال باشد.
start	number زمان شروع غلاف آگهی در جدول زمانی دارایی (بدون احتساب پادهای تبلیغاتی قبلی) در ثانیه ممیز شناور.
duration	number مدت زمان غلاف آگهی در ثانیه ممیز شناور.
type	string نوع استراحت آگهی
midroll_index	number فهرست مبتنی بر 1 میان‌افزار در جریان، بر اساس شناسه شکست VMAP. برای pre-roll و postroll حذف شده است.

AdPodDecisionOptions

AdPodDecisionOptions گزینه های اضافی برای جریان را نشان می دهد.

نمایندگی JSON
{ "dash_profile": string, "match_options": object(MatchOpts), "data_sharing_policy_code": string, "sam_id": string, "session_title": string, "dash_inband_event_stream": boolean, "distinct_ad_profiles": boolean, }

فیلدها
dash_profile	string نمایه MPEG-DASH برای استفاده، "زنده" یا "بر اساس تقاضا".
match_options	object(MatchOpts)
data_sharing_policy_code	string به ناشران اجازه می دهد تا خط مشی اشتراک گذاری داده پیش فرض شبکه را نادیده بگیرند.
sam_id	string sam_id کلید اشکال زدایی SAM برای جلسه است، اختیاری است.
session_title	string session_title عنوان جلسه SAM برای جریان است، اختیاری است.
dash_inband_event_stream	boolean dash_inband_event_stream نشان می‌دهد که DAI پیام‌های ID3 را به‌عنوان رویدادهای درون باند (در رسانه) با استفاده از عنصر InbandEventStream به جای عناصر EventStream (در مانیفست) درج می‌کند.
distinct_ad_profiles	boolean اگر روی درست تنظیم شود، نشان می‌دهد که سرور هنگام مطابقت با نمایه‌های رمزگذاری درخواستی، از هر نمایه تبلیغاتی موجود حداکثر یک بار استفاده می‌کند.

جریان

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

نمایندگی JSON
{ "stream_id": string, "valid_for": string, "valid_until": string, "media_verification_url": string, }

فیلدها
stream_id	string شناسه جریان.
valid_for	string مدت زمان پخش در قالب «00h00m00s» معتبر است.
valid_until	string تاریخی که پخش جریانی تا زمانی که در قالب RFC 3339 معتبر است.
media_verification_url	string URL تأیید رسانه.

نماد

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

روش: ایجاد جریان

این روش یک جریان مستقیماً از دستگاه ایجاد می‌کند و تمام منابع مورد نیاز برای برنامه مشتری برای پخش و ردیابی تبلیغات و نمایش عناصر رابط کاربری را برمی‌گرداند.

روش ها
create stream	POST: /ondemand/pods/api/v1/network/{network_code}/stream یک غلاف DAI ارائه جلسه VOD ایجاد کنید.

درخواست HTTP

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

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

پارامترها
network_code	string کد شبکه Google Ad Manager ناشر.

درخواست بدن

بدنه درخواست از نوع application/json است و باید حاوی یک شی CreateStreamRequest باشد.

بدن پاسخگو

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

روش: ثبت جریان

این روش یک جریان را در پشتیبان Google DAI از دستگاه ثبت می‌کند و تمام منابع مورد نیاز برای برنامه مشتری برای ردیابی تبلیغات و نمایش عناصر رابط کاربری را برمی‌گرداند. برخلاف روش create stream ، این روش مانیفست تبلیغات قابل پخش را برنمی‌گرداند. درعوض، این عمل در یک فراخوانی سرور جداگانه انجام می‌شود: decision ad pods .

روش ها
register stream	POST: /ondemand/pods/api/v1/network/{network_code}/stream_registration یک غلاف DAI در حال ارائه جلسه VOD را ثبت می کند.

درخواست HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream_registration

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

پارامترها
network_code	string کد شبکه Google Ad Manager ناشر.

درخواست بدن

بدنه درخواست از نوع application/json است و باید حاوی یک شی StreamRegistrationRequest باشد.

بدن پاسخگو

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

روش: بازیابی غلاف های تبلیغاتی

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

روش ها
decision ad pods	POST: /ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods پادهای تبلیغات تصمیم برای یک پاد DAI در حال ارائه جلسه VOD.

درخواست HTTP

POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods

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

پارامترها
network_code	string کد شبکه Google Ad Manager ناشر.
stream_id	string stream_id از یک تماس stream_registration دریافت شد.

درخواست بدن

بدنه درخواست از نوع application/json است و باید حاوی یک شی AdPodDecisionRequest باشد.

بدن پاسخگو

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

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

این روش تمام اطلاعات مورد نیاز برای برنامه مشتری برای ردیابی تبلیغات و ارائه دقیق عناصر رابط کاربری مناسب را برمی گرداند.

روش ها
ad pods metadata	GET: /ondemand/pods/api/v1/network/.../metadata فراداده های غلاف تبلیغات را برای یک جلسه خاص بازیابی کنید. این URL در ویژگی StreamRegistrationResponse metadata_url برگردانده شده است.

درخواست HTTP

GET: /ondemand/pods/api/v1/network/.../metadata

بدن پاسخگو

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

داده ها

PodMetadata

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

نمایندگی JSON
{ "tags": map[string, object(TagSegment)], "ads": map[string, object(Ad)], "ad_breaks": map[string, object(AdBreak)], "polling_frequency": number, }

فیلدها
tags	map[string, object(TagSegment)] نقشه بخش های برچسب نمایه شده با پیشوند برچسب.
ads	map[string, object(Ad)] نقشه تبلیغات نمایه شده با شناسه آگهی.
ad_breaks	map[string, object(AdBreak)] نقشه وقفه های تبلیغاتی نمایه شده با شناسه استراحت آگهی.
polling_frequency	number فرکانس نظرسنجی URL فراداده توصیه شده، در چند ثانیه. پر شده برای جریان های VOD با استفاده از تصمیم گیری بر اساس تقاضا.

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) که باید در حین پخش آگهی نمایش داده شود.

MatchOpts

MatchOpts الزامات تطبیق رسانه را برای یک جریان مشخص می کند.

نمایندگی JSON
{ "audio_channels": boolean, "audio_sample_rate": boolean, }

فیلدها
audio_channels	boolean کانال های صوتی را بین محتوا و تبلیغات مطابقت دهید.
audio_sample_rate	boolean نرخ نمونه صوتی را بین محتوا و تبلیغات مطابقت دهید.

CreateStreamRequest

CreateStreamRequest اطلاعاتی را که در درخواست‌های HTTP به API سرویس‌دهنده VOD یافت می‌شود، توصیف می‌کند. ایجاد جریان توسط VTP (شریک فناوری ویدیو)، از طرف SDK و ناشر، برای هر کاربر آغاز می شود. استریم نتایج را در غلاف‌های تبلیغاتی تصمیم‌گیری برای دوخت VTP ایجاد کرد. این برخلاف جریان StreamRegistrationRequest+AdPodDecisionRequest است که یک جریان را ثبت می کند و ادپادهای تصمیم را در چندین درخواست تصمیم می گیرد.

نمایندگی JSON
{ "encoding_profiles": [object(EncodingProfile)], "ad_tag": string, "cuepoints": [], "manifest_type": string, "enable_hls_asset_list": boolean, "targeting_parameters": map[string, string], "content_duration_seconds": number, "decision_timing_options": object(DecisionTimingOptions), "enable_inline_manifests": boolean, "dai_options": object(CreateStreamOptions), }

فیلدها
encoding_profiles	[object(EncodingProfile)] لیستی از پروفایل های رمزگذاری مورد نیاز.
ad_tag	string تگ تبلیغات پایه برای تصمیم گیری مورد نیاز.
cuepoints	number لیستی از نقاط نشانه، در چند ثانیه. زمانی که پاسخ تگ آگهی از جابجایی های زمانی موقعیتی استفاده می کند، الزامی است.
manifest_type	string انواع مانیفست معتبر عبارتند از: hls و dash. پیش فرض: hls. اختیاری.
enable_hls_asset_list	boolean نشان می دهد که آیا فهرست دارایی های HLS بینابینی فعال است یا خیر. هنگامی که فعال باشد، DAI URL های لیست دارایی را برای هر adbreak برمی گرداند، که می تواند برای موارد بینابینی HLS استفاده شود.
targeting_parameters	string پارامترهای هدفمند Ad Manager اضافی. اختیاری.
content_duration_seconds	number ContentDurationSeconds مدت زمان محتوا بر حسب ثانیه است. زمانی که پاسخ تگ تبلیغات از درصد جبران زمان استفاده می کند، الزامی است.
decision_timing_options	object(DecisionTimingOptions) نشان می دهد که چه زمانی باید adpod ها تصمیم گیری شوند.
enable_inline_manifests	boolean نشان می دهد که آیا مانیفست های شکست باید در پاسخ JSON درج شوند یا خیر.
dai_options	object(CreateStreamOptions) گزینه های DAI برای ایجاد جریان.

CreateStreamOptions

CreateStreamOptions گزینه های موجود در جریان یک مرحله ای ایجاد گردش کار را نشان می دهد.

نمایندگی JSON
{ "dash_profile": string, "match_options": object(MatchOpts), "data_sharing_policy_code": string, "sam_id": string, "session_title": string, "dash_inband_event_stream": boolean, "distinct_ad_profiles": boolean, "tracking_mode": string, "emsg_version": uint32, }

فیلدها
dash_profile	string نمایه MPEG-DASH برای استفاده، "زنده" یا "بر اساس تقاضا".
match_options	object(MatchOpts)
data_sharing_policy_code	string به ناشران اجازه می دهد تا خط مشی اشتراک گذاری داده پیش فرض شبکه را نادیده بگیرند.
sam_id	string sam_id کلید اشکال زدایی SAM برای جلسه است، اختیاری است.
session_title	string session_title عنوان جلسه SAM برای جریان است، اختیاری است.
dash_inband_event_stream	boolean dash_inband_event_stream نشان می‌دهد که DAI پیام‌های ID3 را به‌عنوان رویدادهای درون باند (در رسانه) با استفاده از عنصر InbandEventStream به جای عناصر EventStream (در مانیفست) درج می‌کند.
distinct_ad_profiles	boolean اگر روی درست تنظیم شود، نشان می‌دهد که سرور هنگام مطابقت با نمایه‌های رمزگذاری درخواستی، از هر نمایه تبلیغاتی موجود حداکثر یک بار استفاده می‌کند.
tracking_mode	string tracking_mode نوع ردیابی آگهی برای استفاده در جریان است، اختیاری است. مقادیر معتبر عبارتند از: 'ad_media'، 'server'، 'client'.
emsg_version	uint32 emsg_version یک نسخه emsg خاص را مجبور می کند که برای ID3های درون رسانه ای استفاده شود. فقط زمانی پشتیبانی می شود که dash_inband_event_stream درست باشد.

StreamRegistrationRequest

StreamRegistrationRequest جریانی را از دستگاه برای تصمیم گیری در مورد adpod در آینده ثبت می کند. این برخلاف CreateStreamRequest است که یک جریان ایجاد می کند و در یک درخواست واحد تصمیم گیری می کند.

نمایندگی JSON
{ "targeting_parameters": map[string, string], "dai_options": object(StreamRegistrationOptions), }

فیلدها
targeting_parameters	string پارامترهای هدفمند Ad Manager اضافی. اختیاری.
dai_options	object(StreamRegistrationOptions) گزینه های DAI برای ثبت جریان.

StreamRegistrationOptions

StreamRegistrationOptions گزینه های موجود برای ایجاد جریان را فهرست می کند

نمایندگی JSON
{ "sam_id": string, "tracking_mode": string, "emsg_version": uint32, "skippable_ads_supported": boolean, }

فیلدها
sam_id	string sam_id کلید اشکال زدایی SAM برای جلسه است، اختیاری است.
tracking_mode	string tracking_mode نوع ردیابی آگهی برای استفاده در جریان است، اختیاری است. مقادیر معتبر عبارتند از: 'ad_media'، 'server'، 'client'.
emsg_version	uint32 emsg_version یک نسخه emsg خاص را مجبور می کند که برای ID3های درون رسانه ای استفاده شود. فقط زمانی پشتیبانی می شود که dash_inband_event_stream درست باشد.
skippable_ads_supported	boolean نشان می دهد که آیا تبلیغات قابل رد شدن پشتیبانی می شوند یا خیر.

StreamRegistrationResponse

StreamRegistrationResponse نشان دهنده پاسخ json است که در پاسخ به StreamRegistrationRequest به مشتری ارسال می شود. این شامل شناسه جریان و تمام URL هایی است که دستگاه به آن نیاز دارد. شناسه جریان را می توان در درخواست تصمیم بعدی adpod ارجاع داد. این برخلاف CreateStreamResponse است که پاسخی برای ایجاد جریان و تصمیم‌گیری همزمان Adpods را نشان می‌دهد.

نمایندگی JSON
{ "stream_id": string, "media_verification_url": string, "valid_for": string, "valid_until": string, "metadata_url": string, }

فیلدها
stream_id	string StreamID شناسه منحصربه‌فرد برای جریان فعلی این بیننده است.
media_verification_url	string MediaVerificationURL پیشوند URL است که در درخواست های تأیید رسانه تبلیغاتی که در زیر توضیح داده شده است استفاده می شود. برای جریان های چراغ گردان سمت مشتری وجود ندارد.
valid_for	string ValidFor مدت زمانی است که این جریان در قالب "00h00m00s" معتبر است.
valid_until	string ValidUntil تاریخ و زمانی است که تا آن زمان این جریان معتبر است.
metadata_url	string MetadataURL URL فراداده ای است که برای درخواست ابرداده adpod استفاده می شود.

DecisionTimingOptions

DecisionTimingOptions گزینه‌های زمان‌بندی برای تصمیم‌گیری adbreak‌ها را برای جریان توصیف می‌کند.

نمایندگی JSON
{ "type": string, "on_create_breaks": [], }

فیلدها
type	string نوع توضیح می دهد که چه زمانی adpod برای جریان تصمیم گیری می شود. انواع معتبر عبارتند از: on_create (پیش فرض)، on_demand. هنگامی که نوع بر روی تقاضا است، زمانی که مانیفست برای یک استراحت خاص درخواست می شود، تبلیغات با تنبلی تصمیم گیری می شوند. وقتی نوع on_create است، همه تبلیغات هنگام ایجاد جریان تصمیم گیری می شوند.
on_create_breaks	string OnCreateBreaks لیستی از breakID های VMAP حساس به حروف بزرگ و کوچک است که باید در هنگام ایجاد جریان تصمیم گیری شود. این فیلد فقط در صورتی مجاز است که نوع آن on_demand باشد. شناسه‌های وقفه تبلیغاتی ویژه «preroll» و «postroll» را می‌توان برای نشان دادن اینکه در زمان ایجاد جریان تصمیم‌گیری در مورد وقفه قبل از پخش یا postroll انجام شود.

EncodingProfile

EncodingProfile رمزگذاری یک نوع محتوای واحد را توصیف می کند. ممکن است فقط تنظیمات ویدیو، فقط تنظیمات صدا (در مورد نوع رسانه)، هر دو تنظیمات ویدیو و صدا، یا هیچ کدام در مورد زیرنویس باشد.

نمایندگی JSON
{ "profile_name": string, "type": string, "container_type": string, "video_settings": object(VideoSettings), "audio_settings": object(AudioSettings), "subtitle_settings": object(SubtitleSettings), }

فیلدها
profile_name	string ناشر نامی را برای نمایه ارائه کرده است. منحصر به فرد در هر جریان. مورد نیاز.
type	string انواع معتبر عبارتند از: رسانه، iframe، زیرنویس. مورد نیاز.
container_type	string انواع معتبر عبارتند از: mpeg2ts، fmp4cmaf و hls_packed_audio. برای نوع رسانه و iframe مورد نیاز است.
video_settings	object(VideoSettings) اگر نوع کانتینر iframe باشد، تنظیمات ویدیو مورد نیاز است. در غیر این صورت، فقط در صورتی حضور دارند که نمایه حاوی ویدیو باشد.
audio_settings	object(AudioSettings) اگر نمایه حاوی صدا باشد، تنظیمات صدا وجود دارد. تنظیمات صدا فقط در صورتی مجاز است که نوع ظرف رسانه ای باشد.
subtitle_settings	object(SubtitleSettings) تنظیمات زیرنویس برای نوع زیرنویس مورد نیاز است.

تنظیمات ویدیو

VideoSettings ویدیوی یک نمایه رمزگذاری را توصیف می کند. اگر یک تنظیم ویدیو وجود دارد، همه باید وجود داشته باشند.

نمایندگی JSON
{ "codec": string, "bitrate": int32, "frames_per_second": number, "resolution": object(Resolution), }

فیلدها
codec	string رشته کدک RFC6381 ویدیو.
bitrate	int32 حداکثر نرخ بیت ویدیوی نمایه رمزگذاری.
frames_per_second	number فریم در ثانیه ویدیو
resolution	object(Resolution) وضوح عرض x ارتفاع ویدیو.

تنظیمات صوتی

AudioSettings صدای یک نمایه رمزگذاری را توصیف می کند. اگر یک تنظیم صوتی وجود دارد، همه باید وجود داشته باشند.

نمایندگی JSON
{ "codec": string, "bitrate": int32, "channels": int32, "sample_rate": int64, }

فیلدها
codec	string رشته کدک RFC6381 صدا.
bitrate	int32 حداکثر نرخ بیت صوتی نمایه رمزگذاری.
channels	int32 تعداد کانال های صوتی (از جمله کانال های فرکانس پایین).
sample_rate	int64 نرخ نمونه صدا، بر حسب هرتز.

تنظیمات زیرنویس

SubtitleSettings زیرنویس نمایه های رمزگذاری را توصیف می کند.

نمایندگی JSON
{ "format": string, "language": string, }

فیلدها
format	string فرمت زیرنویس ها: webvtt برای hls، webvtt یا ttml برای خط تیره.
language	string زبانی که باید در مانیفست درج شود.

قطعنامه

رزولوشن عرض x ارتفاع یک ویدیو را توصیف می کند.

نمایندگی JSON
{ "width": int32, "height": int32, }

فیلدها
width	int32 عرض ویدیو، بر حسب پیکسل. مورد نیاز.
height	int32 ارتفاع ویدیو، بر حسب پیکسل. مورد نیاز.

AdPodDecisionRequest

AdPodDecisionRequest یک درخواست برای adpods تصمیم برای جریانی که قبلاً ثبت شده است را نشان می دهد.

نمایندگی JSON
{ "encoding_profiles": [object(EncodingProfile)], "ad_tag": string, "cuepoints": [], "manifest_type": string, "enable_hls_asset_list": boolean, "targeting_parameters": map[string, string], "content_duration_seconds": number, "decision_timing_options": object(DecisionTimingOptions), "enable_inline_manifests": boolean, "dai_options": object(AdPodDecisionOptions), }

فیلدها
encoding_profiles	[object(EncodingProfile)] لیستی از پروفایل های رمزگذاری مورد نیاز.
ad_tag	string تگ تبلیغات پایه برای تصمیم گیری مورد نیاز.
cuepoints	number لیستی از نقاط نشانه، در چند ثانیه. زمانی که پاسخ تگ آگهی از جابجایی های زمانی موقعیتی استفاده می کند، الزامی است.
manifest_type	string انواع مانیفست معتبر عبارتند از: hls و dash. پیش فرض: hls. اختیاری.
enable_hls_asset_list	boolean نشان می دهد که آیا فهرست دارایی های HLS بینابینی فعال است یا خیر. هنگامی که فعال باشد، DAI URL های لیست دارایی را برای هر adbreak برمی گرداند، که می تواند برای موارد بینابینی HLS استفاده شود.
targeting_parameters	string پارامترهای هدفمند Ad Manager اضافی. اختیاری.
content_duration_seconds	number ContentDurationSeconds مدت زمان محتوا بر حسب ثانیه است. زمانی که پاسخ تگ تبلیغات از درصد جبران زمان استفاده می کند، الزامی است.
decision_timing_options	object(DecisionTimingOptions) نشان می دهد که چه زمانی باید adpod ها تصمیم گیری شوند.
enable_inline_manifests	boolean نشان می دهد که آیا مانیفست های شکست باید در پاسخ JSON درج شوند یا خیر.
dai_options	object(AdPodDecisionOptions) گزینه های DAI برای تصمیم گیری غلاف آگهی.

AdPodDecisionResponse

AdPodDecisionResponse پاسخی به adpods تصمیم برای جریانی که قبلاً ثبت شده است را نشان می دهد. این شامل فهرستی از غلاف های تبلیغاتی است که برای آن جریان تصمیم گرفته شده است.

نمایندگی JSON
{ "valid_for": string, "valid_until": string, "ad_pods": [object(AdPod)], }

فیلدها
valid_for	string ValidFor مدت زمانی است که این جریان در قالب "00h00m00s" معتبر است.
valid_until	string ValidUntil تاریخ و زمانی است که تا آن زمان این جریان معتبر است.
ad_pods	[object(AdPod)] فهرستی از غلاف آگهی که بر اساس ترتیب درج مرتب شده اند.

CreateStreamResponse

CreateStreamResponse نشان دهنده پاسخ json است که در پاسخ به CreateStreamRequest به مشتری ارسال می شود.

نمایندگی JSON
{ "valid_for": string, "valid_until": string, "ad_pods": [object(AdPod)], "stream_id": string, "media_verification_url": string, "pod_metadata": object(PodMetadata), "metadata_url": string, }

فیلدها
valid_for	string ValidFor مدت زمانی است که این جریان در قالب "00h00m00s" معتبر است.
valid_until	string ValidUntil تاریخ و زمانی است که تا آن زمان این جریان معتبر است.
ad_pods	[object(AdPod)] فهرستی از غلاف آگهی که بر اساس ترتیب درج مرتب شده اند.
stream_id	string StreamID شناسه منحصربه‌فرد برای جریان فعلی این بیننده است.
media_verification_url	string MediaVerificationURL پیشوند URL است که در درخواست های تأیید رسانه تبلیغاتی که در زیر توضیح داده شده است استفاده می شود. برای جریان های چراغ گردان سمت مشتری وجود ندارد.
pod_metadata	object(PodMetadata) PodMetadata حاوی اطلاعات اضافی مورد نیاز برای رندر کردن غلاف در دستگاه و تأیید صحت است. همانطور که در اسناد API خطی درج تبلیغات پویا توضیح داده شده است. فقط برای جریان های چراغ گردان سمت مشتری گنجانده شده است.
metadata_url	string MetadataURL URL فراداده ای است که برای درخواست ابرداده adpod استفاده می شود.

AdPod

AdPod نشان دهنده یک استراحت تبلیغاتی تصمیم گیری شده برای پخش است.

نمایندگی JSON
{ "manifest_uris": map[string, string], "multivariant_uri": string, "mpd_uri": string, "manifests": map[string, string], "multivariant_manifest": string, "mpd_manifest": string, "asset_list_uri": string, "start": number, "duration": number, "type": string, "midroll_index": number, }

فیلدها
manifest_uris	string ManifestURIs نقشه ای از رمزگذاری نام نمایه به نوع HLS manifest_uris برای محتوای HLS است.
multivariant_uri	string MultivariantURI URI برای مانیفست چند متغیره برای محتوای HLS است.
mpd_uri	string MPDURI URI برای MPD برای محتوای DASH است.
manifests	string Manifests نقشه ای از رمزگذاری نام نمایه در مانیفست نوع HLS است. فقط در صورتی پر می شود که جریان دارای enable_inline_manifests روی true باشد.
multivariant_manifest	string MultivariantManifest مانیفست چند متغیره برای محتوای HLS است. فقط در صورتی پر می شود که جریان دارای enable_inline_manifests روی true باشد.
mpd_manifest	string MPDManifest مانیفست MPD برای محتوای DASH است. فقط در صورتی پر می شود که جریان دارای enable_inline_manifests روی true باشد.
asset_list_uri	string AssetListURI URI فهرست دارایی های بینابینی HLS برای محتوای HLS است. تنها در صورتی پر می‌شود که جریان دارای فهرست دارایی‌های میان‌اثر HLS فعال باشد.
start	number زمان شروع غلاف آگهی در جدول زمانی دارایی (بدون احتساب پادهای تبلیغاتی قبلی) در ثانیه ممیز شناور.
duration	number مدت زمان غلاف آگهی در ثانیه ممیز شناور.
type	string نوع استراحت آگهی
midroll_index	number فهرست مبتنی بر 1 میان‌افزار در جریان، بر اساس شناسه شکست VMAP. برای pre-roll و postroll حذف شده است.

AdPodDecisionOptions

AdPodDecisionOptions گزینه های اضافی برای جریان را نشان می دهد.

نمایندگی JSON
{ "dash_profile": string, "match_options": object(MatchOpts), "data_sharing_policy_code": string, "sam_id": string, "session_title": string, "dash_inband_event_stream": boolean, "distinct_ad_profiles": boolean, }

فیلدها
dash_profile	string نمایه MPEG-DASH برای استفاده، "زنده" یا "بر اساس تقاضا".
match_options	object(MatchOpts)
data_sharing_policy_code	string به ناشران اجازه می دهد تا خط مشی اشتراک گذاری داده پیش فرض شبکه را نادیده بگیرند.
sam_id	string sam_id کلید اشکال زدایی SAM برای جلسه است، اختیاری است.
session_title	string session_title عنوان جلسه SAM برای جریان است، اختیاری است.
dash_inband_event_stream	boolean dash_inband_event_stream نشان می‌دهد که DAI پیام‌های ID3 را به‌عنوان رویدادهای درون باند (در رسانه) با استفاده از عنصر InbandEventStream به جای عناصر EventStream (در مانیفست) درج می‌کند.
distinct_ad_profiles	boolean اگر روی درست تنظیم شود، نشان می‌دهد که سرور هنگام مطابقت با نمایه‌های رمزگذاری درخواستی، از هر نمایه تبلیغاتی موجود حداکثر یک بار استفاده می‌کند.

جریان

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

نمایندگی JSON
{ "stream_id": string, "valid_for": string, "valid_until": string, "media_verification_url": string, }

فیلدها
stream_id	string شناسه جریان.
valid_for	string مدت زمان پخش در قالب «00h00m00s» معتبر است.
valid_until	string تاریخی که پخش جریانی تا زمانی که در قالب RFC 3339 معتبر است.
media_verification_url	string URL تأیید رسانه.

نماد

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

تأیید

تأیید حاوی اطلاعاتی برای اندازه گیری باز است ، که قابلیت مشاهده شخص ثالث و اندازه گیری تأیید را تسهیل می کند. در حال حاضر ، فقط از منابع 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> در وسیع.