Package google.ads.drx.video.v1

الفهرس

AdBreakNotificationService

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

إنشاء AdBreak

rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)

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

نطاقات الأذونات

يتطلب ذلك أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على OAuth 2.0.
قوائم AdBreaks

rpc ListAdBreaks(ListAdBreaksRequest) returns (ListAdBreaksResponse)

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

نطاقات الأذونات

يتطلب ذلك أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على OAuth 2.0.

خدمة ContentContentIngestionService

خدمة واجهة برمجة تطبيقات لعرض المحتوى تتيح إنشاء أو تعديل محتوى الفيديو والبيانات الوصفية المرتبطة به في "مدير إعلانات Google"

تعديل فيديو

rpc UpdateVideoContent(UpdateVideoContentRequest) returns (VideoContent)

واجهة برمجة التطبيقات لإنشاء محتوى جديد أو تعديل بياناته الوصفية إذا كان المحتوى متوفّرًا في "مدير إعلانات Google" عرض المحتوى بنجاح أو خطأ google.rpc.Code عند تعذّر تنفيذه

مثال على طلب يبدو:

{
   "status": "ACTIVE",
   "title": "Best video ever",
   "updateTime": "2019-01-24T01:30:15.01Z",
   "duration": "230s",
   "cuePoints": ["55.532s", "192s"],
   "publishTime": "2019-01-24T01:30:15.01Z",
   "thumbnailUrl": "http://www.domain.com/tn.jpg",
   "metadata": {
       "keyValues": {
           "category": "sports",
           "tag": ["soccer", "messi"],
       }
   }
}
نطاقات الأذونات

يتطلب ذلك أحد نطاقات OAuth التالية:

  • https://www.googleapis.com/auth/contentingestion
  • https://www.googleapis.com/auth/video-ads

لمزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على OAuth 2.0.

AdBreak

البيانات الوصفية للفاصل الإعلاني المستخدَمة لاتخاذ قرار بشأن فاصل إعلاني في حدث فيديو مباشر

الحقول
name

string

الإخراج فقط. اسم مورد فاصل الإعلانات يجب أن يكون هذا الحقل على النحو التالي: "networks//assets//adBreaks/".

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

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

ad_BREAK_id هو مفتاح فاصل الإعلانات. الإخراج فقط
expected_duration

Duration

مطلوبة. مدة الاستراحة المتوقّعة.
custom_params

string

أزواج المفتاح/القيمة المراد تضمينها في طلبات الإعلان لهذا الفاصل في ما يتعلق باستهداف المعايير المخصصة في "مدير الإعلانات". مثال: 'key1=value&key2=value2,value22'
scte_35_cue_out

string

البيانات المشفّرة للقاعدة 64 من إشارة scte35. قد تشتمل على الأمر splice_insert() أو time_signal(). أمثلة: - مع time_signal(): "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAJSON/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” - مع splice_insert(): "/DAvAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
pod_template_name

string

اسم نموذج المجموعة الإعلانية في "مدير إعلانات Google"
break_state

BreakState

الحالة الراهنة لفاصل الإعلانات

بريك

حالة فاصل الإعلانات.

عمليات التعداد
BREAK_STATE_UNSPECIFIED حالة فاصل الإعلان غير معروفة.
BREAK_STATE_DECISIONED بدأ اتخاذ قرار فاصل الإعلان ولكن لم يتم تسليمه للمستخدمين بعد.
BREAK_STATE_COMPLETE تم عرض "فاصل الإعلان" للمستخدمين.

تنسيق الترجمة والشرح

التنسيقات التي قد تكون بها ملفات الترجمة والشرح

عمليات التعداد
CLOSED_CAPTION_FORMAT_UNSPECIFIED لم يتم تحديد تنسيق الترجمة والشرح.
TTML التطبيق/ttaf+xml
WEB_VTT نص/vtt

معلومات الترجمة والشرح

البيانات الوصفية لملف ترجمة وشرح واحد

الحقول
language_code

string

رمز لغة مجموعة مهندسي شبكة الإنترنت (IETF) BCP-47 الذي يمثل اللغة المستخدَمة في ملف الترجمة والشرح.
closed_caption_format

ClosedCaptionFormat

تنسيق ملف الترجمة والشرح.
url

string

عنوان URL لملف الترجمة والشرح

إنشاء طلب AdBreak

طلب الحصول على مبلغ AdBreakNotificationService.CreateAdBreak

الحقول
parent

string

يحدّد هذا الحقل حدث LiveStreamEvent الذي يجب ربط هذا الفاصل الإعلاني به باستخدام مفتاح مادة عرض البث المباشر. يجب أن يكون تنسيق الملف "networks/{network_code}/assets/{asset_code}".
custom_parent

string

يحدّد هذا الحقل حدث LiveStreamEvent الذي يجب ربط هذا الفاصل الإعلاني به باستخدام مفتاح مادة العرض المخصّصة. يجب أن يكون تنسيق الملف "networks/{network_code}/customassets/{asset_code}".
content

string

وهذه طريقة بديلة لتحديد الحدث المباشر للبث، إذا كان مرتبطًا بجزء من المحتوى ضمن أداة GAM. يجب أن يكون بالتنسيق "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}".
ad_break

AdBreak

مطلوبة. الفاصل الإعلاني الفعلي.
ad_break_id

string

هذا هو ad_BREAK_id الذي يمكن للمستخدمين تقديمه من خلال الطلب.

معلومات AdAdInsertion

معلومات ذات صلة بإدراج الإعلانات الديناميكية

الحقول
video_ingest_url_info

VideoIngestUrlInfo

رابط للملف الرئيسي m3u8 الذي يتم استخدامه لأغراض التكيُّف وإنشاء قوائم التشغيل.
media_update_time

Timestamp

الوقت الذي تم فيه إجراء آخر تعديل على ملف الفيديو المُشار إليه في video_ingest_url_info.
closed_caption_url_info[]

ClosedCaptionUrlInfo

عنوان URL الذي يؤدي إلى ملف الترجمة والشرح.
fw_caid

string

رقم تعريف مادة العرض المخصّصة الحرة والذي يُستخدم لاستهداف الإعلانات.

البيانات الوصفية لـ Gracenote

البيانات الوصفية للمحتوى من Gracenote

الحقول
gracenote_id

string

مطلوبة. يشير معرّف Gracenote إلى المحتوى. يجب أن تحتوي على إحدى البادئات الصالحة: 1. "EP" - حلقة من سلسلة 2 "MV" - الفيلم 3. "SP" - حدث رياضي
gracenote_series_id

string

اختياريّ. ويشير هذا الحقل إلى رقم تعريف سلسلة Gracenote. ويجب أن يحمل بادئة "SH".

طلب قائمة الإعلانات

طلب الحصول على مبلغ AdBreakNotificationService.ListAdBreaks

الحقول
parent

string

اختياريّ. يحدّد هذا الحقل حدث LiveStreamEvent الذي يجب ربط هذا الفاصل الإعلاني به باستخدام مفتاح مادة عرض البث المباشر. يجب أن يكون تنسيق الملف "networks/{network_code}/assets/{asset_code}".
custom_parent

string

اختياريّ. يحدّد هذا الحقل حدث LiveStreamEvent الذي يجب ربط هذا الفاصل الإعلاني به باستخدام مفتاح مادة العرض المخصّصة. يجب أن يكون تنسيق الملف "networks/{network_code}/customassets/{asset_code}".
content

string

اختياريّ. وهذه طريقة بديلة لتحديد الحدث المباشر للبث، إذا كان مرتبطًا بجزء من المحتوى ضمن أداة GAM. يجب أن يكون بالتنسيق "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}".
page_size

int32

اختياريّ. الحد الأقصى لعدد الفواصل الإعلانية التي يمكن إرجاعها. قد تعرض الخدمة عددًا أقل من هذه القيمة. وفي حال عدم تحديدها، سيتم عرض 10 فواصل إعلانية على الأكثر. الحدّ الأقصى للقيمة هو 100، وسيتم فرض القيم التي تزيد على 100 على 100.
page_token

string

اختياريّ. تم تلقّي رمز مميَّز للصفحة من مكالمة سابقة على ListAdBreaks. قدِّم هذا المستند لاسترداد الصفحة التالية.

عند التقسيم على صفحات، يجب أن تتطابق جميع المعلّمات الأخرى المقدَّمة إلى ListAdBreaks مع المكالمة التي وفّرت الرمز المميز للصفحة.

قائمة AdBreaksResponse

ردّ على AdBreakNotificationService.ListAdBreaks

الحقول
ad_breaks[]

AdBreak

الإخراج فقط. قائمة بفواصل الإعلانات التي تتطابق مع حدث LiveStreamEvent المطلوب.
next_page_token

string

رمز مميز يمكن إرساله باسم page_token لاسترداد الصفحة التالية. إذا تم حذف هذا الحقل، لن تتوفّر أي صفحات لاحقة.

البيانات الوصفية

البيانات الوصفية المخصّصة للمحتوى

الحقول
key_values

map<string, Value>

يحدد البيانات الوصفية المخصصة للمحتوى كزوج من المفتاح والقيمة. يتم قبول السلاسل أو قائمة السلاسل فقط للقيم.

VideoVideoContentNames

قائمة أسماء كل المحتوى الذي تتم مشاركته.

الحقول
syndicated_video_content[]

string

حقل متكرّر لاسم المحتوى الذي تتم مشاركته ويجب أن يكون تنسيقها هو "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}"، كما يجب أن تنتمي إلى الشبكة نفسها التي يتضمّن المحتوى الذي يحتوي على هذا الحقل.

طلب تعديل المحتوى

طلب [VideoContentIngestionService.UpdateVideoContentRequest][].

الحقول
video_content

VideoContent

مطلوبة. البيانات الوصفية للمحتوى

VideoContent

البيانات الوصفية للمحتوى

الحقول
name

string

الإخراج فقط. اسم المورد لمحتوى الفيديو تنسيق هذا الحقل: "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}"

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

content_source_id هو معرّف مصدر المحتوى في "مدير إعلانات Google" الذي يجب أن ينتمي إليه هذا المحتوى.

cms_content_id هو رقم تعريف محتوى نظام إدارة المحتوى في "مدير إعلانات Google"، ويتم تشكيله كجزء من طلب الإعلان لتحديد الإعلانات التي يمكن أن يعرضها "مدير إعلانات Google" مقارنةً بالفيديو المقابل. يمكن أن تكون هذه القيمة رقمية أو أبجدية رقمية.
status

VideoContentStatus

حالة المحتوى. وإذا تم حذفها، سيتم تفعيل القيمة التلقائية.
title

string

مطلوبة. تمثّل هذه السمة عنوان المحتوى.
update_time

Timestamp

مطلوبة. تاريخ آخر تعديل للمحتوى
publish_time

Timestamp

وقت نشر المحتوى يجب ملء هذا الحقل إذا كان الفيديو مصمّمًا لتضمينه في قواعد الإعلانات التي تحدّد وقتَي البدء والانتهاء.
duration

Duration

مدة المحتوى. تتوفر المدة حتى تصل إلى المستوى المللي ثانية.
cue_points[]

Duration

يحدد نقاط العمولة. تشير نقاط عرض الإعلان إلى الأماكن التي يمكن إدراج إعلان فيها في الفيديو. تتم إضافة نقاط العمولة إلى مستوى المللي ثانية. يجب ملء هذا الحقل إذا كان الفيديو يحتوي على فواصل إعلانية أثناء التشغيل.
thumbnail_url

string

عنوان URL للصورة المصغّرة للمحتوى
metadata

Metadata

تحدد البيانات الوصفية المخصصة للمحتوى.
gracenote_metadata

GracenoteMetadata

البيانات الوصفية المرتبطة بالمحتوى هي Gracenote.
syndication_metadata

VideoContentSyndicationInfo

البيانات الوصفية المرتبطة بمشاركة المحتوى
dynamic_ad_insertion_metadata

DynamicAdInsertionInfo

البيانات الوصفية المتعلقة بميزة "إدراج الإعلان الديناميكي" بالمحتوى

حالة الفيديو

خيارات الحالة لعرض الإعلانات المستهدفة للمحتوى أو عدم عرضها.

عمليات التعداد
ACTIVE وسيتم عرض الإعلانات التي تستهدف المحتوى.
BLOCKED ولن يتم عرض أي إعلانات على هذا المحتوى إذا كانت الحالة "محظور".
DELETED وستتم أرشفة المحتوى في "مدير إعلانات Google". وإذا تلقّى "مدير إعلانات Google" طلب إعلان عن محتوى تم وضع علامة "محذوف" عليه، يمكن أن يستمر عرض الإعلانات للشركة نفسها أو الإعلانات التي تستهدف وحدات المستودع أو معايير الاستهداف الأخرى. لحظر الإعلانات، اضبط الحالة على "محظور".

معلومات محتوى الفيديو

البيانات الوصفية لتحديد العلاقات بين المحتوى الأساسي والمحتوى المقتبس.

الحقول
حقل الاتحاد syndication. لا يمكن أن يحتوي VideoContentSyndiationMetadata إلا على واحد مما يلي. لا يمكن أن يكون syndication سوى واحد مما يلي:
canonical_video_content

string

اسم المحتوى الأساسي. ويجب أن يكون تنسيقه مثل "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}"، كما يجب أن ينتمي إلى الشبكة نفسها التي يتضمّن المحتوى الذي يحتوي على هذا الحقل.
syndicated_video_content_names

SyndicatedVideoContentNames

مجموعة من المحتوى المقتبس

تنسيق الفيديو

التنسيقات التي يمكن أن يتم ترميز محتوى الفيديو من خلالها.

عمليات التعداد
VIDEO_FORMAT_UNSPECIFIED لم يتم تحديد تنسيق الفيديو.
HLS التطبيق/x-mpegURL
DASH application/dash+xml

VideoIngestUrlInfo

البيانات الوصفية التي تحدّد الرابط الذي يؤدي إلى ملف m3u8 المستخدَم لوضع شروط وإنشاء قوائم تشغيل

الحقول
video_format

VideoFormat

تمثّل هذه السمة تنسيق الفيديو.
video_preconditioned

VideoPreconditioned

للإشارة إلى ما إذا كان المحتوى مشروطًا بعرض الإعلانات أثناء التشغيل أم لا، ما يعني أنّ شرائحك مقسّمة حاليًا في وقت الفواصل الإعلانية.
url

string

الرابط الذي يؤدي إلى ملف m3u8

فيديوهات مُعدَّة مسبقًا

الحالة المشروطة لمحتوى الفيديو

عمليات التعداد
NO غير مشروط بعد.
YES تم إجراء تعديلات على الفيديو/شرطه.