Package google.ads.drx.video.v1

الفهرس

AdBreakNotificationService

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

CreateAdBreak

rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak)

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

نطاقات التفويض

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

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

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

rpc ListAdBreaks(ListAdBreaksRequest) returns (ListAdBreaksResponse)

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

نطاقات التفويض

يتطلب هذا الإعداد أحد نطاقات OAuth التالية:

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

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

VideoContentIngestionService

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

UpdateVideoContent

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.

الفاصل الإعلاني

يتم استخدام البيانات الوصفية للفاصل الإعلاني لتحديد الإعلانات التي تظهر بعد فاصل إعلاني ضمن حدث فيديو مباشر.

الحقول
name

string

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

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

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

ad_break_id هو مفتاح الفاصل الإعلاني. النتائج فقط.
expected_duration

Duration

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

string

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

string

بيانات بترميز Base 64 من إشارة scte35. قد يتضمّن الأمر splice_insert()‎ أو time_signal()‎. أمثلة: - with time_signal(): “/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==” - with splice_insert(): "/DAvAAAAAAz2///wFAAACPALv+/+AUc2s
pod_template_name

string

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

BreakState

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

BreakState

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

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

ClosedCaptionFormat

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

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

ClosedCaptionUrlInfo

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

الحقول
language_code

string

رمز اللغة IETF BCP-47 الذي يمثّل اللغة التي كتب بها ملف الترجمة والشرح
closed_caption_format

ClosedCaptionFormat

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

string

تمثّل هذه السمة عنوان URL لملف الترجمة والشرح.

CreateAdBreakRequest

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

الحقول
parent

string

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

string

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

string

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

AdBreak

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

string

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

DynamicAdInsertionInfo

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

الحقول
video_ingest_url_info

VideoIngestUrlInfo

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

Timestamp

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

ClosedCaptionUrlInfo

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

string

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

GracenoteMetadata

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

الحقول
gracenote_id

string

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

string

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

ListAdBreaksRequest

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

الحقول
parent

string

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

string

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

string

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

int32

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

string

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

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

ListAdBreaksResponse

ردّ على AdBreakNotificationService.ListAdBreaks

الحقول
ad_breaks[]

AdBreak

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

string

رمز مميّز يمكن إرساله على شكل page_token لاسترداد الصفحة التالية. في حال إسقاط هذا الحقل، لن تظهر أي صفحات لاحقة.

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

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

الحقول
key_values

map<string, Value>

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

SyndicatedVideoContentNames

قائمة بأسماء كل المحتوى المقتبَس.

الحقول
syndicated_video_content[]

string

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

UpdateVideoContentRequest

طلب للحصول على [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 هو Content ID لنظام إدارة المحتوى (CMS) في "مدير إعلانات 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

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

VideoContentStatus

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

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

VideoContentSyndicationInfo

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

الحقول
حقل الربط syndication يمكن أن تحتوي VideoContentSyndiationMetadata على أحد العناصر التالية فقط. يمكن أن يكون syndication واحدًا فقط مما يلي:
canonical_video_content

string

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

SyndicatedVideoContentNames

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

VideoFormat

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

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

VideoIngestUrlInfo

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

الحقول
video_format

VideoFormat

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

VideoPreconditioned

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

string

رابط إلى ملف m3u8

VideoPreconditioned

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

عمليات التعداد
NO لم يتم فرض شروط على المنتج بعد.
YES تم تكييف أو تكييف الفيديو.