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/{network_code}/assets/{asset_key}/adBreaks/{adBreakId}".

‫network_code هو معرِّف الشبكة في "إدارة إعلانات Google" الذي ينتمي إليه هذا المحتوى.

‫asset_key هو مفتاح "حدث البث المباشر" في "مدير إعلانات Google" الذي تم إنشاء "فواصل الإعلانات" ضمنه.

adBreakId هو مفتاح "الفاصل الإعلاني". النتائج فقط.
createTime

string (Timestamp format)

النتائج فقط. وقت إنشاء الفاصل الإعلاني

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف 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

اختياريّ. أزواج المفتاح/القيمة التي سيتم تضمينها في طلبات الإعلان لهذا الفاصل لاستهداف المعايير المخصّصة في "مدير إعلانات Google" مثال: ‎'key1=value&key2=value2,value22' تم إيقافها نهائيًا: يُرجى ضبط cust_params في breakParams.ad_tag_params باستخدام المفتاح "cust_params".
scte35CueOut

string

اختياريّ. بيانات مشفّرة باستخدام Base 64 من إشارة scte35 cue out قد يتضمّن الأمر splice_insert() أو time_signal(). أمثلة: - باستخدام time_signal(): ‎“/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” - باستخدام splice_insert(): ‎"/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo="
podTemplateName
(deprecated)

string

اختياريّ. اسم نموذج مجموعة الإعلانات المتسلسلة في "مدير إعلانات Google". تم إيقافها نهائيًا: يُرجى ضبط cust_params في breakParams.ad_tag_params باستخدام المفتاح "ptpln".
breakState

enum (BreakState)

النتائج فقط. الحالة الحالية لفاصل إعلاني
expectedStartTime

string (Timestamp format)

اختياريّ. تمثّل هذه السمة وقت البدء المتوقّع للفاصل الإعلاني.

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف Z. أمثلة: "2014-10-02T15:01:23Z" أو "2014-10-02T15:01:23.045123456Z" أو "2014-10-02T15:01:23+05:30".
expireDuration

string (Duration format)

اختياريّ. تنتهي صلاحية "الفاصل الإعلاني" في expectedStartTime + expireDuration. إذا لم يتم ضبط expectedStartTime، ستنتهي صلاحية "فواصل الإعلانات" بعد انتهاء مدة expireDuration من بدء عملية اتّخاذ القرار. القيمة التلقائية: 30 دقيقة الحد الأدنى: 5 دقائق الحد الأقصى: 6 ساعات

مدة بالثواني مع ما يصل إلى تسعة أرقام كسور، وتنتهي بـ "s". مثال: "3.5s".
breakSequence

string (int64 format)

النتائج فقط. رقم تعريف تسلسل الإعلانات أثناء التشغيل في منتصف الفيديو لفاصل الإعلانات قد تتضمّن فواصل إعلانية متعدّدة breakSequence نفسه إذا تمّ تحديده بشكلٍ صريح من خلال breakParams.ad_tag_params باستخدام المفتاح mridx. يؤدي ذلك إلى ربط فاصلَين إعلانيَين في "مدير إعلانات Google" بشكل فعّال.
breakParams

object (BreakParams)

اختياريّ. مَعلمات الفاصل التي سيتم تضمينها في طلبات الإعلانات لهذا الفاصل
matchParams

object (MatchParams)

اختياريّ. يُستخدم في "إعلانات DAI المدمجة" لتحديد كيفية مطابقة فاصل إعلاني تم إنشاؤه من خلال واجهة برمجة التطبيقات مع فاصل إعلاني في ملف البيان. عند رصد فاصل إعلاني جديد، سيتم تشغيل دالة مطابقة مع جميع الفواصل الإعلانية لحدث يتضمّن breakState بقيمة SCHEDULED أو DECISIONED للتحقّق مما إذا كانت جميع المَعلمات المضبوطة في matchParams الخاصة بـ "الفاصل الإعلاني" تتطابق مع الفاصل الإعلاني الذي تم رصده. تحدث المطابقة إذا تم استيفاء أحد الشرطين التاليين: 1. يتضمّن "فاصل الإعلانات" الحقل matchParams، وتتطابق جميع المَعلمات التي تم ضبطها فيه مع الفاصل الجديد. 2. فاصل الإعلانات هو DECISIONED ولا يحتوي على حقل matchParams.

لمنع حدوث سلوك "مطابقة الكل" غير المقصود (الذي سيحدث مع matchParams فارغ ولكنّه موجود)، لا يمكن أن يكون matchParams فارغًا إذا تم ضبطه. إذا كان الحقل متوفّرًا في الطلب، يجب ضبط حقل واحد على الأقل من حقوله.

يتم التحقّق من فواصل الإعلانات بهذا الترتيب: 1. مع matchParams، ويتم ترتيبها حسب expectedStartTime تصاعديًا، وcreateTime تصاعديًا، حيث يتم إعطاء الأولوية لفواصل الإعلانات بدون expectedStartTime عند ترتيبها 2. بدون matchParams، ويتم ترتيبها حسب expectedStartTime تصاعديًا، وcreateTime تصاعديًا، حيث يتم إعطاء الأولوية لفواصل الإعلانات بدون expectedStartTime عند ترتيبها

إذا لم تتطابق كل أرقام EABN المعلقة، ستعود ميزة "إدراج إعلان ديناميكي" إلى سلوك اتّخاذ القرار أثناء التنفيذ باستخدام فهرس الإعلانات أثناء التشغيل التالي المتاح.
servedBreak

object (ServedBreak)

النتائج فقط. تعكس هذه السمة المعلومات الفعلية لفاصل الإعلانات المعروض. يتم ضبطها فقط على فواصل إعلانية تتضمّن COMPLETE breakState.

BreakState

حالة "الفاصل الإعلاني".

عمليات التعداد
BREAK_STATE_UNSPECIFIED حالة "استراحة الإعلان" غير معروفة.
BREAK_STATE_DECISIONED بدأ اتّخاذ قرار بشأن "فواصل الإعلانات" ولكن لم يتم عرضه على المستخدمين بعد.
BREAK_STATE_COMPLETE تم عرض فاصل إعلاني للمستخدمين.
BREAK_STATE_SCHEDULED تم تحديد موعد لاتخاذ قرار بشأن الفاصل الإعلاني.
BREAK_STATE_EXPIRED انتهت صلاحية فاصل الإعلانات ولا يمكن استخدامه. بشكلٍ تلقائي، ستنتهي صلاحية "فواصل الإعلانات" بعد 30 دقيقة من expectedStartTime، أو بعد 30 دقيقة من بدء اتّخاذ قرار بشأن "فواصل الإعلانات" في حال عدم ضبط expectedStartTime. يمكن ضبط تاريخ انتهاء الصلاحية بشكل صريح باستخدام الحقل expireDuration.

BreakParams

المَعلمات المرتبطة بفاصل إعلاني

تمثيل JSON 
{
  "macros": [
    {
      object (KeyValue)
    }
  ],
  "adTagParams": [
    {
      object (KeyValue)
    }
  ]
}
الحقول
macros[]

object (KeyValue)

اختياريّ. قيم وحدات الماكرو المخصّصة التي تحلّ محلّ عنصر نائب عشوائي في علامة الإعلان عند طلب عرض الإعلان، ستوسّع ميزة "إدراج إعلان ديناميكي" وحدات ماكرو لعلامات الإعلانات بالشكل %%DAI_PATTERN:[MACRO_KEY]%%، حيث MACRO_KEY هو المفتاح.

في حال ضبطها، ستكون لهذه وحدات الماكرو الأولوية على وحدات الماكرو التي تم ضبطها في طلب عرض حزمة إعلانية.
adTagParams[]

object (KeyValue)

اختياريّ. تتجاوز مَعلمات علامة الإعلان في طلب عرض الإعلان الأساسي.

يتم استخدامها لاتّخاذ القرار بشأن ما إذا كان سيتم تشغيلها قبل طلبات "عرض الإعلانات المتسلسلة" مع ضبط cust_params.

بشكل عام، تتجاوز المَعلمات مَعلَمة سلسلة طلب البحث في طلب عرض الإعلان الأساسي للفاصل الإعلاني. بالنسبة إلى بعض خوادم الإعلانات التي تستخدم أشكال عناوين URL مخصّصة، قد تتجاوز المَعلمات أماكن معيّنة في علامة الإعلان من أجل الامتثال لمتطلبات خادم الإعلانات. سيؤدي ضبط قيمة "mridx" في AdBreak إلى تجاهل الحقل breakSequence واستخدام القيمة المقدَّمة بدلاً منه، إذا كانت عددًا صحيحًا موجبًا صالحًا. وينطبق ذلك حتى على خوادم الإعلانات غير التابعة لـ "مدير إعلانات Google".

في حال ضبط هذه المَعلمات، ستكون لها الأولوية على المَعلمات التي تم ضبطها في طلب عرض حزمة إعلانية.

KeyValue

تمثّل زوج المفتاح/القيمة.

تمثيل JSON 
{
  "key": string,
  "value": string
}
الحقول
key

string

الحقل مطلوب. مفتاح زوج المفتاح/القيمة هذا.
value

string

الحقل مطلوب. قيمة زوج المفتاح/القيمة هذا.

MatchParams

مَعلمات يجب مطابقتها مع فاصل إعلاني تم رصده في "إدراج إعلان ديناميكي مجمّع"

تمثيل 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

اختياريّ. مدة الاستراحة لمطابقة هذا الحقل، يجب أن يكون مدة فاصل الإعلان في ملف البيان هي مدة الفاصل نفسها المتوقّعة في expectedDuration، مع هامش سماح يبلغ 1 ملي ثانية. إذا كانت القيمة "خطأ"، يتم تخطّي هذا الإجراء.

ServedBreak

تمثّل هذه السمة المعلومات الفعلية عن فاصل الإعلانات المعروض.

تمثيل JSON 
{
  "breakDetectTime": string,
  "detectedDuration": string,
  "scte35CueOut": string
}
الحقول
breakDetectTime

string (Timestamp format)

النتائج فقط. الوقت الذي تم فيه رصد الفاصل الإعلاني المطابق بالنسبة إلى عرض الإعلانات المتسلسلة، هذا هو الوقت الذي يتم فيه طلب المقطع أو ملف البيان الأول من مجموعة الإعلانات المتسلسلة. بالنسبة إلى ميزة "دمج الإعلانات الديناميكية"، يكون هذا هو الوقت الذي يتم فيه رصد فاصل الإعلانات لأول مرة في ملف البيان.

يستخدم المعيار RFC 3339، حيث يكون الناتج الذي يتم إنشاؤه مُمثلاً بالتوقيت العالمي المنسَّق مع حرف Z في النهاية ويستخدم الأرقام الجزئية 0 أو 3 أو 6 أو 9. تُقبل أيضًا المعادلات الأخرى التي لا تستخدم حرف 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

 واجهة برمجة التطبيقات لإنشاء "فواصل إعلانية" ضمن البث المباشر

delete

 واجهة برمجة التطبيقات لحذف فاصل إعلاني ضمن البث المباشر

get

 واجهة برمجة التطبيقات للحصول على فاصل إعلاني ضمن البث المباشر

list

 واجهة برمجة التطبيقات لعرض "فواصل إعلانية" ضمن البث المباشر

patch

 واجهة برمجة التطبيقات لتعديل "فواصل إعلانية" ضمن البث المباشر