REST Resource: adBreak.networks.assets.adBreaks

منبع: AdBreak

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

نمایش JSON 
{
  "name": string,
  "createTime": string,
  "expectedDuration": string,
  "customParams": string,
  "scte35CueOut": string,
  "podTemplateName": string,
  "breakState": enum (BreakState),
  "expectedStartTime": string,
  "expireDuration": string,
  "breakSequence": string,
  "breakParams": {
    object (BreakParams)
  },
  "matchParams": {
    object (MatchParams)
  },
  "servedBreak": {
    object (ServedBreak)
  }
}
فیلدها
name

string

فقط خروجی. نام منبع تبلیغ. این فیلد فرمتی به شکل "networks/" خواهد داشت. /دارایی‌ها/ /adBreaks/ «. (یا: "باورم نمی‌شود که آدم‌ها اشتباه می‌کنند.")

network_code کد شبکه‌ای در Google Ad Manager است که این محتوا به آن تعلق دارد.

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

adBreakId کلید Ad Break است. فقط خروجی.

createTime

string ( Timestamp format)

فقط خروجی. زمان ایجاد تبلیغ ناگهانی.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

expectedDuration

string ( Duration format)

الزامی. مدت زمان استراحت مورد انتظار.

مدت زمانی بر حسب ثانیه با حداکثر نه رقم کسری که به ' s ' ختم می‌شود. مثال: "3.5s" .

customParams
(deprecated)

string

اختیاری. جفت‌های کلید-مقدار که در درخواست‌های تبلیغ برای این وقفه برای هدف‌گیری معیارهای سفارشی در مدیریت تبلیغات گنجانده می‌شوند. مثال: 'key1=value&key2=value2,value22' منسوخ شده: لطفاً cust_params را در breakParams.ad_tag_params با استفاده از کلید "cust_params" تنظیم کنید.

scte35CueOut

string

اختیاری. داده‌های کدگذاری شده پایه ۶۴ از خروجی scte35. می‌تواند شامل دستور splice_insert() یا time_signal() باشد. مثال‌ها: - با time_signal(): "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==" - با splice_insert(): "/DAvAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="

podTemplateName
(deprecated)

string

اختیاری. نام قالب پاد مدیریت تبلیغات گوگل. منسوخ شده: لطفاً با استفاده از کلید "ptpln" مقدار cust_params را در breakParams.ad_tag_params تنظیم کنید.

breakState

enum ( BreakState )

فقط خروجی. وضعیت فعلی تبلیغ ناگهانی.

expectedStartTime

string ( Timestamp format)

اختیاری. زمان شروع مورد انتظار پخش تبلیغات.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

expireDuration

string ( Duration format)

اختیاری. زمان انقضای تبلیغ در expectsStartTime + expireDuration تنظیم می‌شود. اگر expectsStartTime تنظیم نشده باشد، تبلیغ پس از تصمیم‌گیری برای شروع، expireDuration خواهد شد. پیش‌فرض: ۳۰ دقیقه حداقل: ۵ دقیقه حداکثر: ۶ ساعت

مدت زمانی بر حسب ثانیه با حداکثر نه رقم کسری که به ' s ' ختم می‌شود. مثال: "3.5s" .

breakSequence

string ( int64 format)

فقط خروجی. شناسه توالی میان‌برنامه‌ایِ Ad Break. چندین Ad Break می‌توانند breakSequence یکسانی داشته باشند، اگر به صراحت از طریق breakParams.ad_tag_params با کلید mridx مشخص شده باشند. این به طور مؤثر دو Ad Break GAM را به هم مرتبط می‌کند.

breakParams

object ( BreakParams )

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

matchParams

object ( MatchParams )

اختیاری. برای Stitched DAI استفاده می‌شود تا مشخص کند که چگونه یک Ad Break ایجاد شده از طریق API با یک Ad Break درون مانیفست مطابقت دارد. هنگامی که یک Break جدید شناسایی می‌شود، یک تابع match برای تمام Ad Breakهای یک رویداد که breakState آنها SCHEDULED یا DECISIONED است، اجرا می‌شود تا بررسی شود که آیا تمام پارامترهای تنظیم شده در matchParams یک Ad Break با Break شناسایی شده مطابقت دارند یا خیر. اگر هر یک از این شرایط برآورده شود، تطابق رخ می‌دهد: ۱. Ad Break دارای یک فیلد matchParams است و تمام پارامترهای تنظیم شده در آن با Break جدید مطابقت دارند. ۲. Ad Break دارای DECISIONED است و فیلد matchParams ندارد.

برای جلوگیری از رفتار تصادفی "match-all" (که با یک matchParams خالی اما موجود رخ می‌دهد)، matchParams در صورت تنظیم نمی‌تواند خالی باشد. اگر فیلد در یک درخواست وجود داشته باشد، حداقل یکی از فیلدهای خودش باید تنظیم شود.

وقفه‌های تبلیغاتی (Ad Breaks) به این ترتیب بررسی می‌شوند: ۱. با matchParams، مرتب شده بر اساس expectedStartTime صعودی، createTime صعودی، که در آن وقفه‌های تبلیغاتی بدون expectedStartTime هنگام مرتب‌سازی در اولویت قرار می‌گیرند. ۲. بدون matchParams، مرتب شده بر اساس expectedStartTime صعودی، createTime صعودی، که در آن وقفه‌های تبلیغاتی بدون expectedStartTime هنگام مرتب‌سازی در اولویت قرار می‌گیرند.

اگر همه EABN های در حال انتظار مطابقت نداشته باشند، DAI با استفاده از شاخص میان‌دوره‌ای بعدی موجود، به رفتار تصمیم‌گیری JIT باز می‌گردد.

servedBreak

object ( ServedBreak )

فقط خروجی. این اطلاعات واقعی وقفه تبلیغاتی نمایش داده شده را نشان می‌دهد. فقط برای وقفه‌های تبلیغاتی با وضعیت COMPLETE وقفه تنظیم می‌شود.

حالت شکست

وضعیت یک تبلیغ ناگهانی (Ad Break).

انوم‌ها
BREAK_STATE_UNSPECIFIED وضعیت Ad Break مشخص نیست.
BREAK_STATE_DECISIONED تصمیم‌گیری در مورد Ad Break آغاز شده اما هنوز به کاربران ارائه نشده است.
BREAK_STATE_COMPLETE تبلیغ ناگهانی (Ad Break) به کاربران تحویل داده شد.
BREAK_STATE_SCHEDULED قرار است جلسه‌ی پخش تبلیغات (Ad Break) برگزار شود.
BREAK_STATE_EXPIRED آگهی تبلیغاتی منقضی شده و غیرقابل استفاده است. به طور پیش‌فرض، آگهی‌های تبلیغاتی 30 دقیقه پس از expectStartTime یا 30 دقیقه پس از شروع آگهی تبلیغاتی در صورت عدم تنظیم expectStartTime منقضی می‌شوند. می‌توان با استفاده از فیلد expireDuration، تاریخ انقضا را به طور صریح تعیین کرد.

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

پارامترهای مرتبط با یک تبلیغ کوتاه.

نمایش JSON 
{
  "macros": [
    {
      object (KeyValue)
    }
  ],
  "adTagParams": [
    {
      object (KeyValue)
    }
  ]
}
فیلدها
macros[]

object ( KeyValue )

اختیاری. مقادیر ماکروی سفارشی که جایگزین یک جای‌نگهدار دلخواه در تگ تبلیغ می‌شوند. در زمان درخواست تبلیغ، DAI ماکروهای تگ تبلیغ را به شکل %%DAI_PATTERN:[MACRO_KEY]%% بسط می‌دهد، که در آن MACRO_KEY کلید است.

در صورت تنظیم، این ماکروها نسبت به ماکروهای تنظیم شده در درخواست Pod Serving اولویت خواهند داشت.

adTagParams[]

object ( KeyValue )

اختیاری. پارامترهای برچسب تبلیغ را در درخواست تبلیغ اصلی لغو می‌کند.

اینها برای تصمیم‌گیری در مورد اینکه آیا قبل از درخواست‌های Pod Serving با تنظیم cust_params فعال می‌شود یا خیر، استفاده می‌شوند.

معمولاً پارامترها، پارامتر رشته پرس‌وجو را در درخواست تبلیغ اصلی برای break نادیده می‌گیرند. برای برخی از سرورهای تبلیغاتی با قالب‌های URL سفارشی، پارامترها ممکن است مکان‌های خاصی را در برچسب تبلیغ نادیده بگیرند تا با الزامات سرور تبلیغ مطابقت داشته باشند. تنظیم مقدار "mridx" در AdBreak، فیلد breakSequence را با مقدار ارائه شده، در صورتی که یک عدد صحیح مثبت معتبر باشد، نادیده می‌گیرد. این حتی برای سرورهای تبلیغاتی غیر GAM نیز صادق است.

در صورت تنظیم، این پارامترها نسبت به پارامترهای تنظیم شده در درخواست Pod Serving اولویت خواهند داشت.

مقدار کلیدی

نشان دهنده یک جفت کلید-مقدار است.

نمایش JSON 
{
  "key": string,
  "value": string
}
فیلدها
key

string

الزامی. کلید این جفت کلید-مقدار.

value

string

الزامی. مقدار این جفت کلید-مقدار.

پارامترهای تطبیق

پارامترهایی که باید با یک تبلیغ شناسایی‌شده‌ی Stitched DAI مطابقت داشته باشند.

نمایش JSON 
{
  "scte35Binary": string,
  "scte35Upid": string,
  "scte35EventId": integer,
  "breakDuration": boolean
}
فیلدها
scte35Binary

string

اختیاری. باینری SCTE-35. برای تطبیق با این فیلد، اعلان تبلیغاتی درون‌نمایشی باید همان رشته باینری SCTE-35 (با کدگذاری base64) را داشته باشد. اگر خالی باشد، از این مورد صرف نظر می‌شود.

scte35Upid

string

اختیاری. UPID SCTE-35 (شناسه منحصر به فرد برنامه). برای تطبیق با این فیلد، اعلان تبلیغاتی درون مانیفست باید همان UPID SCTE-35 را داشته باشد. UPID مقداری است که از فایل باینری SCTE-35 تجزیه می‌شود. اگر خالی باشد، از آن صرف نظر می‌شود.

scte35EventId

integer ( uint32 format)

اختیاری. شناسه رویداد SCTE-35. برای تطبیق با این فیلد، اعلان تبلیغ در مانیفست باید شناسه رویداد یکسانی داشته باشد (شناسه رویداد اتصال/شناسه رویداد قطعه‌بندی). شناسه رویداد مقداری است که از فایل باینری SCTE-35 تجزیه می‌شود. اگر خالی باشد، از آن صرف نظر می‌شود.

breakDuration

boolean

اختیاری. مدت زمان وقفه. برای تطبیق با این فیلد، وقفه تبلیغ در مانیفست باید مدت زمان وقفه مشابه با مدت زمان مورد انتظار وقفه تبلیغ، با تلرانس ۱ میلی‌ثانیه داشته باشد. اگر مقدار آن نادرست باشد، از این مرحله صرف نظر می‌شود.

سروِد بریک

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

نمایش JSON 
{
  "breakDetectTime": string,
  "detectedDuration": string,
  "scte35CueOut": string
}
فیلدها
breakDetectTime

string ( Timestamp format)

فقط خروجی. زمانی که تبلیغ متناظر شناسایی می‌شود. برای Pod Serving، این زمانی است که اولین بخش/مانیفست تبلیغ Pod درخواست می‌شود. برای Stitched DAI، این زمانی است که تبلیغ برای اولین بار در مانیفست شناسایی می‌شود.

از RFC 3339 استفاده می‌کند، که در آن خروجی تولید شده همیشه به صورت Z-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "Z" نیز پذیرفته می‌شوند. مثال‌ها: "2014-10-02T15:01:23Z" ، "2014-10-02T15:01:23.045123456Z" یا "2014-10-02T15:01:23+05:30" .

detectedDuration

string ( Duration format)

فقط خروجی. مدت زمان شناسایی شده در تبلیغ منطبق.

مدت زمانی بر حسب ثانیه با حداکثر نه رقم کسری که به ' s ' ختم می‌شود. مثال: "3.5s" .

scte35CueOut

string

فقط خروجی. پیام SCTE-35 کدگذاری شده با base64 که شناسایی شده است، به تبلیغ متناظر منتقل می‌شود.

روش‌ها

create

 API برای ایجاد یک تبلیغ کوتاه (Ad Break) در پخش زنده.

delete

 API برای حذف آگهی تبلیغاتی در پخش زنده.

get

 API برای دریافت تبلیغات لحظه‌ای در پخش زنده.

list

 API برای فهرست کردن وقفه‌های تبلیغاتی در پخش زنده.

patch

 API برای به‌روزرسانی یک تبلیغ ناگهانی در پخش زنده.