تتيح لك واجهة برمجة التطبيقات "إدراج إعلان ديناميكي" طلب عمليات بث عند الطلب وتتبُّعها باستخدام ميزة "إدراج إعلان ديناميكي".
الخدمة: dai.google.com
ترتبط كل معرّفات الموارد المنتظمة (URI) بالموقع الإلكتروني https://dai.google.com
.
الطريقة: إنشاء بث
ينشئ هذا الإجراء بثًا مباشرةً من الجهاز، ويعرض جميع الموارد اللازمة لتطبيق العميل من أجل تشغيل الإعلانات وتتبُّعها وعرض عناصر واجهة المستخدم.
الطُرق | |
---|---|
create stream |
POST: /ondemand/pods/api/v1/network/{network_code}/stream
إنشاء جلسة عرض محتوى عند الطلب باستخدام "إعلانات DAI" |
طلب HTTP
POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream
مَعلمات المسار
المعلمات | |
---|---|
network_code |
string
رمز شبكة "مدير إعلانات Google" الخاص بالناشر |
نص الطلب
يكون نص الطلب من النوع application/json
ويجب أن يحتوي على كائن CreateStreamRequest
.
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نصها على عنصر جديد
CreateStreamResponse
.
الطريقة: تسجيل بث
تسجّل هذه الطريقة بثًا على الخلفية لنظام "إعلانات الفيديو الديناميكية" من Google على الجهاز، وتعرض جميع الموارد اللازمة لتتبُّع الإعلانات في تطبيق العميل وعرض عناصر واجهة المستخدم. على عكس طريقة create stream
،
لا تعرض هذه الطريقة بيانًا للإعلانات القابلة للتشغيل. بدلاً من ذلك، يتم تنفيذ هذا الإجراء من خلال طلب خادم منفصل: decision ad pods
.
الطُرق | |
---|---|
register stream |
POST: /ondemand/pods/api/v1/network/{network_code}/stream_registration
تسجيل حزمة DAI تعرض جلسة فيديو عند الطلب |
طلب HTTP
POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/stream_registration
مَعلمات المسار
المعلمات | |
---|---|
network_code |
string
رمز شبكة "مدير إعلانات Google" الخاص بالناشر |
نص الطلب
يكون نص الطلب من النوع application/json
ويجب أن يحتوي على كائن StreamRegistrationRequest
.
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نصها على عنصر جديد
StreamRegistrationResponse
.
الطريقة: استرداد حِزم الإعلانات
تتّبع هذه الطريقة طلب register stream
من جهاز، وهي ضرورية لاسترداد بيانات وصف إعلانات قابلة للتشغيل من أجل دمجها في بيانات وصف المحتوى.
الطُرق | |
---|---|
decision ad pods |
POST: /ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods
مجموعات إعلانات اتّخاذ القرار لجلسة فيديو عند الطلب تعرض مجموعة إعلانات DAI. |
طلب HTTP
POST https://dai.google.com/ondemand/pods/api/v1/network/{network_code}/streams/{stream_id}/adpods
مَعلمات المسار
المعلمات | |
---|---|
network_code |
string
رمز شبكة "مدير إعلانات Google" الخاص بالناشر |
stream_id |
string
تم استلام stream_id من مكالمة stream_registration. |
نص الطلب
يكون نص الطلب من النوع application/json
ويجب أن يحتوي على كائن AdPodDecisionRequest
.
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نصها على عنصر جديد
AdPodDecisionResponse
.
الطريقة: بيانات وصفية لمجموعات الإعلانات المتسلسلة
تعرض هذه الطريقة جميع المعلومات اللازمة لتتبُّع الإعلانات وعرض عناصر واجهة المستخدِم المناسبة بدقة في تطبيق العميل.
الطُرق | |
---|---|
ad pods metadata |
GET: /ondemand/pods/api/v1/network/.../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 للبيانات الوصفية المقترَح، بالثواني. يتم ملء هذا الحقل لفيديوهات البث عند الطلب باستخدام ميزة "اتّخاذ القرار عند الطلب". |
TagSegment
يحتوي TagSegment على مرجع إلى إعلان وفاصل إعلاني ونوع حدث. يجب عدم إرسال طلبات ping إلى نقطة النهاية الخاصة بالتحقّق من صحة وسائط الإعلان في 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)] إدخالات التحقّق الاختيارية في Open Measurement التي تسرد الموارد والبيانات الوصفية المطلوبة لتنفيذ رمز القياس التابع لجهة خارجية من أجل التحقّق من تشغيل تصميم الإعلان. |
slate |
boolean قيمة منطقية اختيارية تشير إلى أنّ الإدخال الحالي هو لوحة إعلانية. |
icons |
[object(Icon)] قائمة بالرموز، يتم حذفها إذا كانت فارغة. |
wrappers |
[object(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 إلى واجهة برمجة التطبيقات الخاصة بعرض إعلانات ضمن حزمة الفيديو عند الطلب. يبدأ شريك تكنولوجي للفيديو (VTP) عملية إنشاء البث نيابةً عن حزمة SDK والناشر لكل مستخدم. يؤدي إنشاء البث إلى عرض مجموعات إعلانات متسلسلة تم اتخاذ قرار بشأنها لكي يتم دمجها في "تجربة البث المباشر". يختلف ذلك عن مسار 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 مفعّلة. عند تفعيل ميزة "الإعلانات الديناميكية أثناء البث"، ستعرض عناوين URL لقوائم مواد العرض لكل فاصل إعلاني، ويمكن استخدامها مع الإعلانات البينية في HLS. |
targeting_parameters |
string معلمات استهداف إضافية في "مدير إعلانات Google". اختياري. |
content_duration_seconds |
number ContentDurationSeconds هي مدة المحتوى بالثواني. مطلوبة عندما تستخدم استجابة علامة الإعلان إزاحات الوقت بالنسبة المئوية. |
decision_timing_options |
object(DecisionTimingOptions) يشير إلى وقت اتّخاذ قرار بشأن حزم الإعلانات. |
enable_inline_manifests |
boolean تشير إلى ما إذا كان يجب تضمين بيانات ملفات بيان الفواصل الإعلانية في استجابة JSON. |
dai_options |
object(CreateStreamOptions) خيارات DAIOptions لإنشاء ساحة مشاركات |
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 بثًا من الجهاز لاتّخاذ قرارات بشأن حزم الإعلانات في المستقبل. يختلف ذلك عن CreateStreamRequest الذي ينشئ مصدر فيديو ويعرض حزم إعلانية تتضمّن قرارات في طلب واحد.تمثيل JSON |
---|
{ "targeting_parameters": map[string, string], "dai_options": object(StreamRegistrationOptions), } |
الحقول | |
---|---|
targeting_parameters |
string معلمات استهداف إضافية في "مدير إعلانات Google". اختياري. |
dai_options |
object(StreamRegistrationOptions) خيارات DAIOptions لتسجيل البث |
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 التي سيحتاج إليها الجهاز. يمكن الإشارة إلى رقم تعريف مصدر البيانات في طلب لاحق لاتّخاذ قرار بشأن حزمة الإعلانات. ويختلف ذلك عن CreateStreamResponse الذي يمثّل ردًا لإنشاء مصدر بث واتّخاذ قرارات بشأن حزم إعلانية في الوقت نفسه.تمثيل 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 للبيانات الوصفية سيتم استخدامه لطلب البيانات الوصفية لحزمة الإعلانات. |
DecisionTimingOptions
تصف DecisionTimingOptions خيارات التوقيت لاتّخاذ قرارات بشأن فواصل الإعلانات في البث.تمثيل JSON |
---|
{ "type": string, "on_create_breaks": [], } |
الحقول | |
---|---|
type |
string يصف الحقل "النوع" الوقت الذي يتم فيه اتّخاذ قرار بشأن حزم الإعلانات في البث. الأنواع الصالحة هي: on_create (تلقائي)، وon_demand. عندما يكون النوع on_demand، يتم اتخاذ قرار عرض الإعلانات بشكل غير مباشر عند طلب بيان لفرصة إعلانية معيّنة. عندما يكون النوع on_create، يتم اتّخاذ جميع قرارات الإعلانات عند إنشاء حدث البث. |
on_create_breaks |
string OnCreateBreaks هي قائمة بمعرّفات فواصل VMAP حساسة لحالة الأحرف يجب اتخاذ قرار بشأنها عند إنشاء البث. لا يُسمح بهذا الحقل إلا إذا كان النوع on_demand. يمكن استخدام معرّفَي فاصل الإعلانات الخاصَّين "preroll" و "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
تصف 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) تمثّل هذه السمة درجة دقة الفيديو من حيث العرض والارتفاع. |
AudioSettings
تصف AudioSettings الصوت في ملف تعريف الترميز. إذا كان أحد إعدادات الصوت متوفّرًا، يجب أن تكون جميعها متوفّرة.تمثيل JSON |
---|
{ "codec": string, "bitrate": int32, "channels": int32, "sample_rate": int64, } |
الحقول | |
---|---|
codec |
string سلسلة برنامج ترميز RFC6381 للصوت. |
bitrate |
int32 الحد الأقصى لمعدل نقل بيانات الصوت في ملف الترميز. |
channels |
int32 يشير إلى عدد القنوات الصوتية (بما في ذلك قنوات التردد المنخفض). |
sample_rate |
int64 معدّل البيانات في الملف الصوتي، بالهرتز. |
SubtitleSettings
تصف SubtitleSettings الترجمة المصاحبة لملفات تعريف الترميز.تمثيل JSON |
---|
{ "format": string, "language": string, } |
الحقول | |
---|---|
format |
string تنسيق الترجمة والشرح: webvtt لبروتوكول HLS، وwebvtt أو ttml لبروتوكول DASH. |
language |
string اللغة التي سيتم إدراجها في البيان |
الدقة
تشير درجة الدقة إلى عرض الفيديو وارتفاعه.تمثيل JSON |
---|
{ "width": int32, "height": int32, } |
الحقول | |
---|---|
width |
int32 تمثّل هذه السمة عرض الفيديو بالبكسل. مطلوب. |
height |
int32 تمثّل هذه السمة ارتفاع الفيديو بالبكسل. مطلوب. |
AdPodDecisionRequest
يمثّل 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(AdPodDecisionOptions), } |
الحقول | |
---|---|
encoding_profiles |
[object(EncodingProfile)] قائمة بملفات الترميز الشخصية مطلوب. |
ad_tag |
string علامة الإعلان الأساسية لاتّخاذ القرارات. مطلوب. |
cuepoints |
number قائمة بنقاط الإشارات بالثواني هذه السمة مطلوبة عندما تستخدم استجابة علامة الإعلان إزاحات زمنية موضعية. |
manifest_type |
string أنواع البيانات الصالحة هي: hls وdash. القيمة التلقائية: hls. اختياري. |
enable_hls_asset_list |
boolean يشير هذا الحقل إلى ما إذا كانت الإعلانات البينية في قائمة مواد عرض HLS مفعّلة. عند تفعيل ميزة "الإعلانات الديناميكية أثناء البث"، ستعرض عناوين URL لقوائم مواد العرض لكل فاصل إعلاني، ويمكن استخدامها مع الإعلانات البينية في HLS. |
targeting_parameters |
string معلمات استهداف إضافية في "مدير إعلانات Google". اختياري. |
content_duration_seconds |
number ContentDurationSeconds هي مدة المحتوى بالثواني. مطلوبة عندما تستخدم استجابة علامة الإعلان إزاحات الوقت بالنسبة المئوية. |
decision_timing_options |
object(DecisionTimingOptions) يشير إلى وقت اتّخاذ قرار بشأن حزم الإعلانات. |
enable_inline_manifests |
boolean تشير إلى ما إذا كان يجب تضمين بيانات ملفات بيان الفواصل الإعلانية في استجابة JSON. |
dai_options |
object(AdPodDecisionOptions) خيارات DAI لاتّخاذ قرار بشأن مجموعة الإعلانات المتسلسلة |
AdPodDecisionResponse
يمثّل AdPodDecisionResponse ردًا على حزم إعلانات اتخاذ القرار في بث تم تسجيله سابقًا. تحتوي على قائمة بقرارات حِزم الإعلانات التي تم اتّخاذها بشأن هذا البث.تمثيل 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 على المعلومات الإضافية المطلوبة لعرض الحزمة على الجهاز وبدء عملية التحقّق. كما هو موضّح في مستندات Dynamic Ad Insertion Linear API. يتم تضمينها فقط في عمليات البث التي تستخدم إشارات التتبُّع من جهة العميل. |
metadata_url |
string MetadataURL هو عنوان URL للبيانات الوصفية سيتم استخدامه لطلب البيانات الوصفية لحزمة الإعلانات. |
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 هي خريطة لاسم ملف تعريف الترميز إلى manifest_uris لمتغيرات HLS لبروتوكول HLS. |
multivariant_uri |
string MultivariantURI هو معرّف الموارد المنتظم (URI) لبيان المحتوى المتعدّد المتغيرات بتنسيق HLS. |
mpd_uri |
string MPDURI هو معرّف الموارد المنتظم (URI) لملف MPD الخاص بمحتوى DASH. |
manifests |
string البيانات الوصفية هي خريطة لاسم ملف تعريف الترميز إلى ملف البيانات الوصفية المتغير لبروتوكول HLS. يتم ملء هذا الحقل فقط إذا تم ضبط enable_inline_manifests على "صحيح" في البث. |
multivariant_manifest |
string MultivariantManifest هو بيان متعدد الصيغ لمحتوى HLS. يتم ملء هذا الحقل فقط إذا تم ضبط enable_inline_manifests على "صحيح" في البث. |
mpd_manifest |
string MPDManifest هو بيان MPD لمحتوى DASH. يتم ملء هذا الحقل فقط إذا تم ضبط enable_inline_manifests على "صحيح" في البث. |
asset_list_uri |
string AssetListURI هو معرّف الموارد المنتظم لقائمة مواد عرض الإعلانات البينية المستندة إلى بروتوكول HLS. يتم ملء هذا الحقل فقط إذا كانت الإعلانات البينية المستندة إلى قائمة مواد العرض في بث HLS مفعّلة. |
start |
number وقت بدء مجموعة الإعلانات المتسلسلة في المخطط الزمني الخاص بمادة العرض (بدون تضمين مجموعات الإعلانات المتسلسلة السابقة) بالثواني العشرية |
duration |
number مدة سلسلة الإعلانات بالثواني العشرية |
type |
string نوع الفاصل الإعلاني |
midroll_index |
number فهرس قائم على الرقم 1 للإعلانات أثناء التشغيل في بث مباشر، استنادًا إلى رقم تعريف فاصل VMAP. تم استبعاده من الإعلانات قبل التشغيل وبعده. |
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 إذا تم ضبط القيمة على "صحيح"، يشير ذلك إلى أنّ الخادم سيستخدم أي ملف إعلان متاح مرة واحدة على الأكثر عند مطابقة ملفات الترميز المطلوبة. |
بث
يُستخدَم البث لعرض قائمة بجميع الموارد الخاصة ببث تم إنشاؤه حديثًا بتنسيق 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 |
FallbackImage
يحتوي 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
يحتوي العنصر الحاوي على معلومات حول إعلان حاوٍ. ولا يتضمّن معرّف صفقة إذا لم يكن متوفّرًا.تمثيل 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 معرّف الصفقة الاختياري للإعلان المغلّف |
التحقّق
يتضمّن التحقّق معلومات عن Open Measurement، ما يسهّل قياس إمكانية العرض والتحقّق من جهات خارجية. في الوقت الحالي، لا تتوفّر سوى موارد JavaScript. يُرجى الاطّلاع على 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)] قائمة بمراجع JavaScript للتحقّق |
tracking_events |
[object(TrackingEvent)] قائمة بأحداث التتبُّع الخاصة بعملية إثبات الملكية |
parameters |
string سلسلة غير شفافة يتم تمريرها إلى رمز التحقّق الأوّلي. |
JavaScriptResource
يحتوي JavaScriptResource على معلومات للتحقّق من خلال JavaScript.تمثيل JSON |
---|
{ "script_url": string, "api_framework": string, "browser_optional": boolean, } |
الحقول | |
---|---|
script_url |
string عنوان URI لحِزمة JavaScript. |
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 سلسلة تُستخدَم لتحديد عنوان URL الخاص بالموقع الإلكتروني للسجلّ الذي تم فيه إدراج المعرّف العالمي للإعلان الخاص بتصميم الإعلان المحدّد. |
الإعلان المصاحب
يحتوي العنصر 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 إذا كان هذا إعلانًا مصاحبًا من النوع الثابت |
height |
int32 تمثّل هذه السمة ارتفاع العنصر المصاحب بالبكسل. |
width |
int32 تمثّل هذه السمة عرض العنصر المصاحب بالبكسل. |
resource |
string بالنسبة إلى الإعلانات المصاحبة الثابتة وإطارات iframe، سيكون هذا هو عنوان URL الذي سيتم تحميله وعرضه. بالنسبة إلى العناصر المصاحبة بتنسيق HTML، سيكون هذا هو مقتطف HTML الذي يجب عرضه كعنصر مصاحب. |
type |
string نوع هذا الإعلان المصاحب. يمكن أن يكون ثابتًا أو إطار iframe أو HTML. |
ad_slot_id |
string معرّف موضع الإعلان المرافق هذا |
api_framework |
string إطار عمل واجهة برمجة التطبيقات لهذا التطبيق المرافق |
tracking_events |
[object(TrackingEvent)] قائمة بأحداث التتبُّع لهذا الإعلان المرافق: |
InteractiveFile
يحتوي 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. |