Package google.ads.drx.video.v1

شاخص

AdBreakNotificationService

یک سرویس API که به ناشران اجازه می‌دهد تا Ad Break‌ها را در یک جریان زنده ایجاد کنند.

CreateAdBreak

rpc CreateAdBreak( CreateAdBreakRequest ) returns ( AdBreak )

API برای ایجاد یک Ad Break در جریان زنده.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

ListAdBreaks

rpc ListAdBreaks( ListAdBreaksRequest ) returns ( ListAdBreaksResponse )

API برای فهرست کردن Ad Break ها در جریان مستقیم.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

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

برای اطلاعات بیشتر، به نمای کلی OAuth 2.0 مراجعه کنید.

VideoContentIngestionService

یک سرویس API برای جذب محتوا که امکان ایجاد یا به‌روزرسانی محتوای ویدیویی و ابرداده‌های مرتبط با آن را در Google Ad Manager می‌دهد.

به روز رسانی محتوای ویدیویی

rpc UpdateVideoContent( UpdateVideoContentRequest ) returns ( VideoContent )

API برای ایجاد محتوای جدید یا به‌روزرسانی ابرداده آن در صورتی که محتوا از قبل در Ad Manager وجود داشته باشد. محتوا را در صورت موفقیت یا یک 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

فقط خروجی نام منبع Ad Break. این فیلد دارای قالب "شبکه/ /دارایی/ /adBreaks/ ".

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

asset_key کلید رویداد پخش زنده در Google Ad Manage است که تحت آن Ad Break ایجاد شده است.

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

expected_duration

Duration

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

custom_params

string

جفت‌های کلید-مقدار در درخواست‌های آگهی برای این وقفه برای هدف‌یابی معیارهای سفارشی در Ad Manager لحاظ شوند. مثال: 'key1=value&key2=value2,value22'

scte_35_cue_out

string

پایگاه 64 داده های رمزگذاری شده را از نشانه scte35. ممکن است شامل دستور splice_insert() یا time_signal() باشد. مثال‌ها: - با time_signal(): "/DA0AAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAsoKGKNAIAmsnRfg==" - با splice_insert(): "/DAvAAAAAAA//vFAVAAA2Ah NWLbowo="

pod_template_name

string

نام قالب Google Ad Manager pod.

break_state

BreakState

وضعیت فعلی وقفه تبلیغاتی.

BreakState

وضعیت یک Ad Break.

Enums
BREAK_STATE_UNSPECIFIED وضعیت Ad Break ناشناخته است.
BREAK_STATE_DECISIONED تصمیم گیری برای وقفه تبلیغاتی شروع شد اما هنوز به کاربران تحویل داده نشده است.
BREAK_STATE_COMPLETE Ad Break به کاربران تحویل داده شد.

ClosedCaptionFormat

فرمت هایی که فایل های زیرنویس بسته ممکن است در آنها باشند.

Enums
CLOSED_CAPTION_FORMAT_UNSPECIFIED قالب زیرنویس بسته مشخص نشده است.
TTML application/ttaf+xml
WEB_VTT متن / vtt

ClosedCaptionUrlInfo

فراداده برای یک فایل زیرنویس بسته.

فیلدها
language_code

string

کد زبان IETF BCP-47 نشان دهنده زبانی است که فایل زیرنویس بسته در آن قرار دارد.

closed_caption_format

ClosedCaptionFormat

فرمت فایل زیرنویس بسته.

url

string

آدرس فایل زیرنویس بسته.

CreateAdBreakRequest

درخواست AdBreakNotificationService.CreateAdBreak .

فیلدها
parent

string

این فیلد LiveStreamEvent را مشخص می کند که این وقفه تبلیغاتی باید با استفاده از کلید دارایی پخش جریانی زنده به آن مرتبط شود. باید فرمت "networks/{network_code}/assets/{asset_code}" را داشته باشد.

custom_parent

string

این فیلد LiveStreamEvent را مشخص می‌کند که این وقفه تبلیغاتی باید با استفاده از کلید دارایی سفارشی مرتبط شود. باید فرمت "networks/{network_code}/customAssets/{asset_code}" را داشته باشد.

content

string

این یک راه جایگزین برای شناسایی LiveStreamEvent است، اگر با محتوایی در GAM مرتبط باشد. باید فرمت "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

پیوندی به فایل master m3u8 که برای شرطی سازی و تولید لیست پخش استفاده می شود.

media_update_time

Timestamp

زمانی که فایل ویدیویی به آن اشاره شده در video_ingest_url_info آخرین بار اصلاح شد.

closed_caption_url_info[]

ClosedCaptionUrlInfo

نشانی اینترنتی فایل زیرنویس/زیرنویس بسته.

fw_caid

string

شناسه دارایی سفارشی چرخ آزاد مورد استفاده برای هدف‌یابی تبلیغات.

GracenoteMetadata

فراداده Gracenote برای محتوا.

فیلدها
gracenote_id

string

مورد نیاز. برای محتوا به شناسه Gracenote مراجعه می کند. باید یکی از این پیشوندهای معتبر داشته باشد: 1. "EP" - قسمت یک سری 2. "MV" - فیلم 3. "SP" - رویداد ورزشی

gracenote_series_id

string

اختیاری. این قسمت به شناسه سری Gracenote اشاره دارد. باید با پیشوند 'SH' باشد.

ListAdBreaksRequest

درخواست AdBreakNotificationService.ListAdBreaks .

فیلدها
parent

string

اختیاری. این فیلد LiveStreamEvent را مشخص می کند که این وقفه تبلیغاتی باید با استفاده از کلید دارایی پخش جریانی زنده به آن مرتبط شود. باید فرمت "networks/{network_code}/assets/{asset_code}" را داشته باشد.

custom_parent

string

اختیاری. این فیلد LiveStreamEvent را مشخص می‌کند که این وقفه تبلیغاتی باید با استفاده از کلید دارایی سفارشی مرتبط شود. باید فرمت "networks/{network_code}/customAssets/{asset_code}" را داشته باشد.

content

string

اختیاری. این یک راه جایگزین برای شناسایی LiveStreamEvent است، اگر با محتوایی در GAM مرتبط باشد. باید فرمت "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

مورد نیاز. فراداده محتوا.

محتوای ویدیویی

فراداده محتوا.

فیلدها
name

string

فقط خروجی نام منبع محتوای ویدیویی. فرمت این فیلد به شرح زیر است: 'networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}'

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

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

cms_content_id شناسه محتوای CMS در Google Ad Manager است که به‌عنوان بخشی از درخواست آگهی برای شناسایی تبلیغاتی که Ad Manager می‌تواند در مقابل ویدیوی مربوطه ارائه کند، تشکیل شده است. این مقدار می تواند عددی یا الفبایی باشد.

status

VideoContentStatus

وضعیت محتوا. اگر این مورد حذف شود مقدار پیش فرض فعال خواهد بود.

title

string

مورد نیاز. عنوان مطلب.

update_time

Timestamp

مورد نیاز. آخرین زمان اصلاح محتوا.

publish_time

Timestamp

زمان انتشار مطالب اگر ویدیو به گونه‌ای طراحی شده باشد که در قوانین آگهی که زمان شروع و پایان را مشخص می‌کند، درج شود، این یک قسمت الزامی است.

duration

Duration

مدت زمان محتوا. مدت زمان تا سطح میلی ثانیه پشتیبانی می شود.

cue_points[]

Duration

نقاط نشانه را شناسایی می کند. نقاط نشانه مکان هایی در زمان هستند که می توان یک تبلیغ را در ویدیو درج کرد. نقاط نشانه تا سطح میلی ثانیه پشتیبانی می شوند. اگر ویدیو حاوی وقفه‌های تبلیغاتی میان‌پولی باشد، این یک قسمت الزامی است.

thumbnail_url

string

نشانی اینترنتی تصویر کوچک محتوا.

metadata

Metadata

متادیتای سفارشی محتوا را شناسایی می کند.

gracenote_metadata

GracenoteMetadata

فراداده مربوط به محتوا را Gracenote کنید.

syndication_metadata

VideoContentSyndicationInfo

ابرداده مربوط به سندیکا از محتوا.

dynamic_ad_insertion_metadata

DynamicAdInsertionInfo

فراداده مربوط به درج آگهی پویا از محتوا.

VideoContentStatus

گزینه های وضعیت برای ارائه یا عدم ارائه تبلیغات هدفمند برای یک محتوا.

Enums
ACTIVE تبلیغات هدفمند محتوا ارائه خواهد شد.
BLOCKED در صورت مسدود بودن وضعیت، هیچ تبلیغی علیه این محتوا ارائه نخواهد شد.
DELETED محتوا در Ad Manager بایگانی خواهد شد. اگر مدیر تبلیغات برای محتوایی که به‌عنوان «حذف شده» علامت‌گذاری شده است، درخواست آگهی دریافت کند، تبلیغات خانگی یا آگهی‌های هدفمند برای واحدهای موجودی یا سایر معیارهای هدف‌یابی همچنان می‌توانند در مقابل آن قرار بگیرند. برای مسدود کردن تبلیغات، وضعیت را روی BLOCKED تنظیم کنید.

VideoContentSyndicationInfo

ابرداده برای مشخص کردن روابط بین محتوای متعارف و محتوای سندیکایی.

فیلدها
syndication میدانی اتحادیه VideoContentSyndiationMetadata فقط می تواند حاوی یکی از موارد زیر باشد. syndication می تواند تنها یکی از موارد زیر باشد:
canonical_video_content

string

نام محتوای متعارف. باید قالب "networks/{network_code}/sources/{content_source_id}/content/{cms_content_id}" را داشته باشد و باید به همان شبکه محتوای حاوی این فیلد تعلق داشته باشد.

syndicated_video_content_names

SyndicatedVideoContentNames

مجموعه ای از محتوای سندیکایی

فرمت ویدئو

فرمت هایی که محتوای ویدیویی ممکن است در آنها رمزگذاری شود.

Enums
VIDEO_FORMAT_UNSPECIFIED فرمت ویدئو مشخص نشده است.
HLS application/x-mpegURL
DASH application/dash+xml

VideoIngestUrlInfo

فراداده پیوند به فایل m3u8 را مشخص می کند که برای شرطی سازی و تولید لیست پخش استفاده می شود.

فیلدها
video_format

VideoFormat

فرمت ویدیو.

video_preconditioned

VideoPreconditioned

برای نشان دادن اینکه آیا محتوا از قبل برای تبلیغات میان فیلم شرطی شده است یا نه، به این معنی که بخش‌های شما در زمان وقفه‌های تبلیغاتی از قبل تقسیم شده‌اند.

url

string

لینک فایل m3u8.

ویدئو پیش شرط شده

وضعیت شرطی محتوای ویدیویی.

Enums
NO هنوز مشروط نشده است.
YES ویدیو شرطی/تقسیم شده است.