این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Early ad break notification

استفاده از Early Ad Break Notification API

توجه: این API هنوز در نسخه بتا است. اگر می خواهید درخواست دسترسی به برنامه EABN را داشته باشید، با مدیر حساب خود صحبت کنید.

Early Ad Break Notification (EABN) API به شما این امکان را می دهد که قبل از شروع وقفه تبلیغاتی، Google Ad Manager را از وقفه تبلیغاتی آتی با فراداده آن مطلع کنید. حداکثر یک ساعت قبل از وقفه آگهی می توانید درخواست اعلان ارسال کنید. این راهنما نحوه فعال کردن و استفاده از EABN API و نمونه‌های درخواست و پاسخ را توضیح می‌دهد.

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

تماس های برقرار شده با EABN API باید شامل اطلاعات زیر باشد:

شناسه جریان مستقیم مربوطه که وقفه آگهی برای آن ایجاد می شود. این شناسه می تواند یکی از موارد زیر باشد:
«کلید دارایی» جریان زنده.
"کلید دارایی سفارشی" جریان زنده، که به شما امکان می دهد فضای کلید خود را با تعیین رشته شناسه خود مدیریت کنید.
«شناسه منبع محتوا» و «شناسه محتوا» پخش زنده.

توجه: برای استفاده از این نوع شناسه باید فعال باشید. برای اطلاعات بیشتر، با مدیر حساب خود تماس بگیرید.

مدت زمان مورد انتظار وقفه تبلیغاتی بعدی. مدت زمان باید تا حد امکان به مدت زمان استراحت واقعی تبلیغات نزدیک باشد.

علاوه بر این فیلدهای الزامی، می‌توانید پارامترهای هدف‌گیری سفارشی، نام قالب آگهی برای اعمال، یا داده‌های SCTE35 Cue Out را در صورت وجود ارسال کنید.

پیش نیازها

برای استفاده از EABN API، باید یک حساب سرویس ایجاد کنید و حساب را به شبکه Google Ad Manager خود اضافه کنید.

ایجاد یک حساب کاربری خدمات

برای ایجاد یک حساب سرویس برای تماس با EABN API، مراحل زیر را انجام دهید: - اگر یک حساب Google Cloud دارید، از ماژول IAM برای ایجاد یک حساب سرویس استفاده کنید. برای اطلاعات بیشتر، به ایجاد و مدیریت حساب‌های سرویس مراجعه کنید. - اگر حساب Google Cloud ندارید، مراحل زیر را برای ایجاد آن از Google API Console انجام دهید:

یک پروژه جدید ایجاد کنید یا یک پروژه موجود را انتخاب کنید.
در صفحه اعتبارنامه‌ها ، روی مدیریت حساب‌های سرویس کلیک کنید.
در صفحه حساب‌های سرویس ، روی ایجاد حساب سرویس کلیک کنید.
در صفحه ایجاد حساب کاربری ، جزئیات حساب را وارد کنید. سپس، روی CREATE کلیک کنید.

هنگامی که یک حساب سرویس ایجاد کردید، کلید JSON حساب را کپی کنید، که برای احراز هویت استفاده می شود.

افزودن حساب سرویس خود به شبکه Google Ad Manager

برای افزودن حساب سرویس خود به شبکه خود، مراحل را در افزودن کاربر حساب سرویس برای دسترسی به API تکمیل کنید.

فعال کردن API

پس از ایجاد حساب سرویس، اطلاعات زیر را در اختیار مدیر حساب خود قرار دهید تا API برای حساب شما فعال شود:

آدرس ایمیل حساب Google Cloud شما
حساب خدمات شما
کد شبکه شبکه Google Ad Manager شما.

پس از اینکه API توسط مدیر حساب شما فعال شد، مراحل زیر را برای فعال کردن API انجام دهید:

در کتابخانه Google API ، «Google Ad Manager Video API» را جستجو کنید.
روی ENABLE کلیک کنید.

توجه: اگر API در نتایج جستجو ظاهر نشد، با مدیر حساب خود تماس بگیرید تا تأیید کنید که حساب شما برای DAI API فعال شده است.

با استفاده از API

می توانید با استفاده از درخواست های JSON/REST با EABN API تماس بگیرید.

مجوز

برای برقراری تماس‌های مجاز با EABN API، باید اعتبار حساب سرویس OAuth2 را با استفاده از کلید JSON از حساب سرویس خود و محدوده https://www.googleapis.com/auth/video-ads ایجاد کنید. برای اطلاعات بیشتر، استفاده از OAuth 2.0 برای برنامه های کاربردی سرور به سرور را ببینید.

برای هر تماس با EABN API باید کد مجوز حاصل را به عنوان سرصفحه Auth اضافه کنید.

ارسال اعلان وقفه تبلیغاتی زودهنگام

برای ارسال زودهنگام اعلان وقفه تبلیغاتی، بسته به نحوه تعیین جریان زنده، یک درخواست POST به یکی از سه نشانی اینترنتی معتبر EABN ارسال کنید. بخش های زیر تفاوت بین URL ها را توضیح می دهند و نمونه های درخواست و پاسخ را ارائه می دهند.

URL ها

سه URL معتبر برای اطلاع رسانی زودهنگام وقفه تبلیغاتی وجود دارد. شما می توانید از هر سه نوع برای ایجاد یک وقفه تبلیغاتی ( POST ) یا دریافت لیست وقفه های تبلیغاتی اختصاص داده شده ( GET ) استفاده کنید.

برای استفاده از کلید دارایی یک جریان زنده، از:

POST admanagervideo.googleapis.com/v1/networks/{network_code}/assets/{asset_key}/adBreaks

GET admanagervideo.googleapis.com/v1/networks/{network_code}/assets/{asset_key}/adBreaks

برای استفاده از کلید دارایی سفارشی یک جریان زنده، از:

POST admanagervideo.googleapis.com/v1/networks/{network_code}/customAssets/{custom_asset_key}/adBreaks

GET admanagervideo.googleapis.com/v1/networks/{network_code}/customAssets/{custom_asset_key}/adBreaks

برای استفاده از Content Source ID و Content ID، از موارد زیر استفاده کنید:

POST admanagervideo.googleapis.com/v1/networks/{network_code}/sources/{content_source_id}/content/{content_id}/adBreaks

GET admanagervideo.googleapis.com/v1/networks/{network_code}/sources/{content_source_id}/content/{content_id}/adBreaks

برای تمام پارامترها:

network_code نشان دهنده کد شبکه شبکه Google Ad Manager شما است.
asset_key نشان دهنده کلید دارایی است که در صفحه جزئیات پخش زنده شما نشان داده شده است.
custom_asset_key کلید دارایی سفارشی پخش زنده شما را نشان می دهد.
content_source_id نشان دهنده شناسه منبع محتوا در Google Ad Manager است.
content_id نشان دهنده شناسه یک قطعه محتوا در Google Ad Manager است.

توجه: جفت content_source_id / content_id مشخص شده باید با یک جریان زنده در Google Ad Manager مرتبط باشد.

بدنه درخواست - فقط برای ایجاد یک Ad Break (POST) استفاده می شود

شیء
`expectedDuration`	مورد نیاز	مدت زمان این وقفه تبلیغاتی، با استفاده از قالب مدت زمان استاندارد Google (xx.xxxs که xx.xxx تعداد ثانیه‌ها است)
`customParams`	اختیاری	جفت‌های کلید-مقدار در درخواست‌های آگهی برای این وقفه برای هدف‌یابی معیارهای سفارشی در AM360، با تفکیک `=` و ملحق شدند `&` . مثال: `key=value&key2=value2,value3` برای اطلاعات بیشتر در مورد هدف‌یابی، به تامین پارامترهای هدف‌گیری در جریان خود مراجعه کنید.
`podTemplateName`	اختیاری	نام قالب آگهی
`scte35CueOut`	اختیاری	داده های کدگذاری شده با پایه 64 از نشانه scte35. می تواند شامل شود `splice_insert()` یا `time_signal()` فرمان مثال ها: time_signal(): `/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==` splice_insert(): `/DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo=`

درخواست های نمونه

یک Ad Break ایجاد کنید

POST admanagervideo.googleapis.com/v1/networks/.../sources/.../content/.../adBreaks
Content-Type: application/json
Authorization: Bearer …
{
    "expectedDuration": "30s",
    "scte35CueOut": "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==",
    "customParams": "param1=value1&param2=value2",
    "podTemplateName": "podtemplate"
}

بدن پاسخگو

بدنه پاسخ شامل تمام پارامترهای ارسال شده در شی adBreak ، و همچنین یک فیلد name اضافی است که شامل شناسه استاندارد در سراسر Google مربوط به وقفه تبلیغاتی ایجاد شده است. این فیلد در قالب زیر برگردانده می شود:

networks/{network_code}/assets/{asset_key}/adBreaks/{ad_break_id}

پاسخ نمونه

HTTP/1.1 200 OK
{
  "name": "networks/.../assets/.../adBreaks/1",
  "expectedDuration": "30s",
  "scte35CueOut": "/DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==",
  "customParams": "param1=value1&param2=value2",
  "podTemplateName": "podtemplate"
}

لیست وقفه های تبلیغاتی اختصاص داده شده

GET admanagervideo.googleapis.com/v1/networks/.../sources/.../content/.../adBreaks
Content-Type: application/json
Authorization: Bearer …

بدن پاسخگو

بدنه پاسخ شامل وقفه‌های تبلیغاتی با یک قسمت breakState اضافی برای هر وقفه آگهی اختصاص داده شده به جریان است. فیلد breakState از مقادیر زیر پشتیبانی می کند:

 // Ad break decisioning has started.
BREAK_STATE_DECISIONED

// Break has started to be delivered to end users.
BREAK_STATE_COMPLETE

پاسخ نمونه

HTTP/1.1 200 OK
{
  "name": "networks/.../assets/.../adBreaks/1",
  "expectedDuration": "30s",
  "breakState": "BREAK_STATE_COMPLETE"
}