API زنده ارائه غلاف درج آگهی پویا

API درج آگهی پویا به شما امکان می‌دهد پخش‌های زنده DAI را درخواست و پیگیری کنید.

خدمات: dai.google.com

همه URI ها مربوط به https://dai.google.com هستند.

روش: جریان

روش ها
stream POST /ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

یک پاد DAI را برای ارائه جلسه پخش زنده ثبت می کند.

درخواست HTTP

POST https://dai.google.com/ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

پارامترهای مسیر

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است.

درخواست بدن

بدنه درخواست از نوع application/x-www-form-urlencoded است و شامل پارامترهای زیر است:

پارامترها
پارامترهای هدف DFP اختیاری پارامترهای هدف گیری اضافی
نادیده گرفتن پارامترهای جریان اختیاری مقادیر پیش‌فرض پارامتر ایجاد جریان را لغو کنید.
احراز هویت HMAC اختیاری با استفاده از توکن مبتنی بر HMAC احراز هویت.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی یک شی Stream جدید است.

باز کردن اندازه‌گیری

API DAI حاوی اطلاعاتی برای تأیید اندازه‌گیری باز در قسمت Verifications است. این فیلد حاوی یک یا چند عنصر Verification که منابع و ابرداده های مورد نیاز برای اجرای کد اندازه گیری شخص ثالث را به منظور تأیید پخش خلاق فهرست می کند. فقط JavaScriptResource پشتیبانی می شود. برای اطلاعات بیشتر، به آزمایشگاه فناوری IAB و مشخصات VAST 4.1 مراجعه کنید.

روش: بخش غلاف

روش ها
pod segment GET /linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

یک جریان DAI برای شناسه رویداد داده شده ایجاد می کند.

درخواست HTTP

GET https://dai.google.com/linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

پارامترهای مسیر

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است.

pod_identifier

فرمت های زیر پشتیبانی می شوند:

pod/{integer}

شناسه عددی برای وقفه تبلیغاتی فعلی. شناسه‌های غلاف آگهی به‌صورت تدریجی برای هر رویداد وقفه تبلیغاتی، از 1 شروع می‌شود.

ad_break_id/{string}

شناسه رشته برای وقفه تبلیغاتی فعلی. ناشر ارائه‌شده Ad break ID محدودیت‌های مشابهی با Ad pod ID ندارد. هر شناسه Ad Break ناشناخته ای که به آن نقطه پایانی ارائه می شود، یک Ad Break جدید برای رویداد پخش زنده ایجاد می کند.

profile_name string

نام نمایه رمزگذاری Google Ad Manager DAI درخواستی . نمایه رمزگذاری باید یکی از نمایه های رمزگذاری پیکربندی شده برای رویداد انتخاب شده باشد.

segment_number integer

نمایه بخش درخواستی در غلاف تبلیغات فعلی که از صفر شروع می شود.

segment_format string

پسوند فایل مرتبط با قالب بخش درخواستی. پسوندهای پذیرفته شده عبارتند از: ts , mp4 , vtt , aac , ac3 یا eac3 .

پارامترهای پرس و جو

پارامترها
stream_id مورد نیاز است string

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

sd required 1 integer

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

so اختیاری

افست بخش درخواستی در غلاف آگهی، در میلی ثانیه. اگر پارامتر so را حذف کنید، با ضرب مدت زمان بخش در شماره بخش محاسبه می شود.

pd مورد نیاز 2 integer

مدت زمان غلاف آگهی، بر حسب میلی ثانیه.

auth-token مورد نیاز است string

یک نشانه HMAC امضا شده و کدگذاری شده با URL برای غلاف تبلیغات فعلی.

last اختیاری boolean

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

scte35 اختیاری string

سیگنال SCTE-35 با کد Base64 برای این استراحت تبلیغاتی.

cust_params اختیاری string

مجموعه‌ای از جفت‌های کلید-مقدار که برای هدف‌یابی کمپین Ad Manager استفاده می‌شود. این جفت ها باید به عنوان یک رشته پرس و جو کدگذاری شده با آدرس اینترنتی نمایش داده شوند.

مثال:
پارامترها
  • بخش = sports
  • صفحه = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

پاورقی ها

  1. sd برای بخش های اولیه مورد نیاز نیست.
  2. pd برای رویدادهایی که وقفه‌های تبلیغاتی بدون مدت فعال هستند، لازم نیست.

مثال

دریافت کنید https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/ad_break_id/adbreak -2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99a4a47-6T

دریافت کنید https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/pod/2/profi le/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a:

بدن پاسخگو

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

روش: مانیفست غلاف HLS

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

روش ها
GET GET /linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset}/{pod_identifier}.m3u8;

API برای بازیابی یک لیست پخش چند متغیره HLS برای یک آگهی.

درخواست HTTP

GET https://dai.google.com/linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}.m3u8?stream_id={stream_id}&pd={pod_duration}

پارامترهای مسیر

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است

pod_identifier

فرمت های زیر پشتیبانی می شوند:

pod/{integer}

شناسه عددی برای وقفه تبلیغاتی فعلی. شناسه‌های غلاف آگهی به‌صورت تدریجی برای هر رویداد وقفه تبلیغاتی، از 1 شروع می‌شود.

ad_break_id/{string}

شناسه رشته برای وقفه تبلیغاتی فعلی. ناشر ارائه‌شده Ad break ID محدودیت‌های مشابهی با Ad pod ID ندارد. هر شناسه Ad Break ناشناخته ای که به آن نقطه پایانی ارائه می شود، یک Ad Break جدید برای رویداد پخش زنده ایجاد می کند.

پارامترهای پرس و جو

پارامترها
stream_id مورد نیاز string

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

pd مورد نیاز integer

مدت زمان غلاف آگهی، بر حسب میلی ثانیه.

scte35 اختیاری string

سیگنال SCTE-35 با کد Base64 برای این استراحت تبلیغاتی.

cust_params اختیاری string

مجموعه‌ای از جفت‌های کلید-مقدار که برای هدف‌یابی کمپین Ad Manager استفاده می‌شود. این جفت ها باید به عنوان یک رشته پرس و جو کدگذاری شده با آدرس اینترنتی نمایش داده شوند.

مثال:
پارامترها
  • بخش = sports
  • صفحه = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ یک لیست پخش چند متغیره HLS است.

روش: مانیفست غلاف DASH

یک مانیفست غلاف آگهی MPEG-DASH از جریان زنده را بازیابی می‌کند که برای بارگیری و پخش ویدیوی مشتری آماده است.

روش ها
GET GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/pod/{pod_id}/manifest.mpd

API برای بازیابی لیست پخش mpd MPEG-DASH برای یک آگهی.

درخواست HTTP

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/stream/{stream_id}/pod/{pod_id}/manifest.mpd?pd={pod_duration}

پارامترهای مسیر

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است

stream_id string

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

pod_id integer

شناسه عددی برای وقفه تبلیغاتی فعلی. شناسه‌های غلاف آگهی به‌صورت تدریجی برای هر رویداد وقفه تبلیغاتی، از 1 شروع می‌شود.

پارامترهای پرس و جو

پارامترها
pd مورد نیاز integer

مدت زمان غلاف آگهی، بر حسب میلی ثانیه.

scte35 اختیاری string

سیگنال SCTE-35 با کد Base64 برای این استراحت تبلیغاتی.

cust_params اختیاری string

مجموعه‌ای از جفت‌های کلید-مقدار که برای هدف‌یابی کمپین Ad Manager استفاده می‌شود. این جفت ها باید به عنوان یک رشته پرس و جو کدگذاری شده با آدرس اینترنتی نمایش داده شوند.

مثال:
پارامترها
  • بخش = sports
  • صفحه = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ یک لیست پخش mpd MPEG-DASH است.

روش: الگوی دوره غلاف DASH

روش ها
pods GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

از Google Ad Manager یک الگوی دوره DASH درخواست می کند. این الگو حاوی ماکروهایی است که باید آنها را با پارامترهای جریان خود پر کنید. پس از پر شدن این ماکروها، الگو به دوره وقفه تبلیغاتی شما تبدیل می شود و می توان آن را در مانیفست DASH خود قرار داد.

درخواست HTTP

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

پارامترهای مسیر

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است.

پارامترهای پرس و جو

پارامترها
stream_id مورد نیاز است string

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

tv اختیاری integer

نسخه قالب. پیش‌فرض 0 است. نسخه قالب پاد را برای بازگشت مشخص می کند.

  • 0 : الگویی را درخواست می کند که از شناسه توالی غلاف استفاده می کند.
  • 1 : الگویی را درخواست می‌کند که هم از شناسه‌های توالی پاد و هم از شناسه‌های شکست آگهی پشتیبانی کند.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی یک شی جدید PodTemplateResponse است.

روش: فراداده زمان بندی آگهی

روش ها
ad pod timing metadata GET /linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

فراداده زمان بندی غلاف آگهی را بازیابی می کند.

درخواست HTTP

GET https://dai.google.com/linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

پارامترهای مسیر

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مرتبط با این پخش زنده در Google Ad Manager.

پارامترهای پرس و جو

پارامترها
stream_id مورد نیاز string

شناسه جریان Ad Manager از برنامه پخش کننده ویدیوی مشتری.

ad_break_id مورد نیاز است string

شناسه بعدی استراحت آگهی آینده.

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

محدودیت های زیر برای شناسه های adbreak سفارشی اعمال می شود:

  • باید بین 1 تا 63 کاراکتر باشد
  • باید فقط شامل حروف کوچک، اعداد و خط فاصله باشد.
  • preroll شناسه استراحت آگهی برای بازیابی غلاف آگهی قبل از پخش رزرو شده است. نمی توان از آن برای شناسایی هر پاد تبلیغاتی دیگری استفاده کرد.
auth-token مورد نیاز است string

auth-token از یک نشانه HMAC با پارامترهای زیر تشکیل شده است:

  • ad_break_id
  • custom_asset_key
  • exp
  • network_code
  • custom_params
  • pd
  • scte35
timeout اختیاری integer

تعداد میلی‌ثانیه‌هایی که DAI می‌تواند این درخواست را برای منتظر ماندن برای تصمیم‌گیری آگهی مسدود کند. از این پارامتر در درخواست‌هایی استفاده کنید که در اولین درخواست باید تبلیغات پر شده را برگردانند، مانند وقفه‌های تبلیغاتی قبل از پخش.

اگر از مهلت زمانی فراتر رود، درخواست وضعیت معلق را برمی‌گرداند.

اگر گنجانده شود، مقدار وقفه باید بین 1000 تا 15000 میلی ثانیه باشد. در صورت حذف، پاسخ ها به تأخیر نمی افتند و منتظر تصمیم گیری آگهی هستند.

final اختیاری boolean

روی true تنظیم کنید تا به DAI نشان دهید که این آخرین درخواستی است که VTP مایل است برای این غلاف تبلیغاتی انجام دهد. اگر تصمیمی برای آگهی هنوز در دسترس نباشد (تا زمان پایان اختیاری)، DAI برای این درخواست صفحه را به طور دائم برمی گرداند.

پیش فرض ها به false .

پارامترهای تصمیم گیری تبلیغات

pd اختیاری integer

مدت زمان وقفه تبلیغاتی (بر حسب میلی ثانیه). همچنین به عنوان مدت زمان غلاف آگهی نیز نامیده می شود.

اگر از EABN استفاده می شود، مقدار pd باید با مدت زمان ارائه شده در اعلان وقفه تبلیغاتی شما مطابقت داشته باشد. اگر مدت زمان ها مطابقت نداشته باشند، مقدار EABN در اولویت قرار می گیرد.

cust_params اختیاری string

پارامترهای سفارشی برای هدف قرار دادن وقفه تبلیغاتی، همانطور که در مرکز راهنمای Ad Manager توضیح داده شده است.

scte35 اختیاری string

یک سیگنال SCTE-35 با کد base64.

اگر سیگنال نامعتبر باشد، پیامی در هدر HTTP X-Ad-Manager-Dai-Warning ارسال می شود و درخواست بدون مقدار scte35 نامعتبر ارسال می شود.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی یک شی جدید AdPodTimingMetadataResponse است.

روش: تایید رسانه ای

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

درخواست‌ها به نقطه پایانی media verification بی‌توان هستند.

روش ها
media verification GET /{media_verification_url}/{ad_media_id}

API را از یک رویداد تأیید رسانه مطلع می کند.

درخواست HTTP

GET https://{media-verification-url}/{ad-media-id}

بدن پاسخگو

media verification پاسخ‌های زیر را برمی‌گرداند:

  • HTTP/1.1 204 No Content .
  • HTTP/1.1 404 Not Found اگر درخواست نمی تواند رسانه را به دلیل قالب بندی نادرست URL یا انقضا تأیید کند.
  • اگر درخواست تأیید قبلی برای این شناسه موفقیت آمیز بود، HTTP/1.1 404 Not Found .
  • HTTP/1.1 409 Conflict .

شناسه های رسانه تبلیغاتی

شناسه‌های رسانه تبلیغاتی در یک مسیر فراداده جداگانه کدگذاری می‌شوند - فراداده زمان‌بندی‌شده برای جریان انتقال HLS یا emsg برای فایل‌های mp4. شناسه های رسانه تبلیغاتی همیشه با رشته google_ شروع می شوند.

قبل از انجام هر درخواست تأیید آگهی، کل محتوای متنی ورودی فراداده باید به URL تأیید آگهی اضافه شود.

روش: فراداده

نقطه پایانی فراداده در metadata_url اطلاعاتی را که برای ساختن یک رابط کاربری تبلیغاتی استفاده شده است، برمی گرداند. نقطه پایانی فراداده برای جریان‌های نشان‌دهنده سمت سرور در دسترس نیست، جایی که سرور مسئول شروع تأیید رسانه آگهی است.

روش ها
metadata GET /{metadata_url}/{ad-media-id}

GET /{metadata_url}

اطلاعات فراداده تبلیغات را بازیابی می کند.

درخواست HTTP

GET https://{metadata_url}/{ad-media-id}

GET https://{metadata_url}

بدن پاسخگو

در صورت موفقیت آمیز بودن، پاسخ نمونه ای از PodMetadata را برمی گرداند.

تجزیه فراداده

ابرداده دارای سه بخش مجزا است: tags ، ads و breaks تبلیغاتی. نقطه ورود به داده ها بخش tags است. از آنجا، تگ ها را تکرار کنید و اولین ورودی را پیدا کنید که نام آن پیشوندی برای شناسه رسانه تبلیغاتی موجود در جریان ویدئو است. برای مثال، ممکن است یک شناسه رسانه تبلیغاتی داشته باشید که به شکل زیر است:

google_1234567890

سپس یک شیء برچسب به نام google_12345 را پیدا می کنید. در این مورد، با شناسه رسانه تبلیغاتی شما مطابقت دارد. هنگامی که شی پیشوند رسانه تبلیغاتی درست را پیدا کردید، می‌توانید شناسه‌های تبلیغات، شناسه‌های استراحت آگهی و نوع رویداد را جستجو کنید. سپس از شناسه‌های تبلیغاتی برای نمایه‌سازی اشیاء ads و شناسه‌های وقفه تبلیغاتی برای نمایه‌سازی اشیاء breaks استفاده می‌شود.

داده های پاسخ

جریان

Stream برای ارائه فهرستی از منابع برای یک جریان تازه ایجاد شده در قالب JSON استفاده می شود.
نمایندگی JSON
{
  "stream_id": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "heartbeat_url": string,
  "polling_frequency": number,
  "pod_manifest_url": string,
  "manifest_format": string,
}
فیلدها
stream_id string

شناسه جریان GAM.
media_verification_url string

نشانی وب تأیید رسانه که به عنوان نقطه پایانی پایه برای ردیابی رویدادهای پخش استفاده می‌شود.
metadata_url string

URL فراداده برای نظرسنجی اطلاعات دوره ای در مورد رویدادهای تبلیغات جریانی آتی استفاده می شود.
session_update_url string

نشانی وب به‌روزرسانی جلسه برای به‌روزرسانی پارامترهای هدف برای این جریان استفاده می‌شود. مقادیر اصلی برای پارامترهای هدف گیری در طول درخواست ایجاد جریان اولیه گرفته می شود.
heartbeat_url string

URL ضربان قلب، که برای زنده نگه داشتن جریان beaconing سمت سرور استفاده می‌شود، باید هر {PollingFrequency} ثانیه یک بار پینگ شود. پر شده برای جریان‌های نشان‌دهنده سمت سرور.
polling_frequency number

فرکانس نظرسنجی، در ثانیه، هنگام درخواست metadata_url یا heartbeat_url.
pod_manifest_url string

الگوی URL مانیفست غلاف برای تولید URL برای بازیابی مانیفست غلاف جریان، مطابق با URL فهرست پخش چند متغیره در HLS یا MPD در DASH استفاده می‌شود. پر شده برای رویدادهای پخش مستقیم از نوع درج آگهی پویا POD_SERVING_MANIFEST. https://developers.google.com/ad-manager/api/reference/v202305/LiveStreamEventService.DynamicAdInsertionType
manifest_format string

قالب مانیفست فرمت مانیفست بازیابی شده از pod_manifest_url، خط تیره یا hls است.

PodMetadata

PodMetadata حاوی اطلاعات فراداده در مورد تبلیغات، وقفه های تبلیغاتی و برچسب های شناسه رسانه است.
نمایندگی JSON
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}
فیلدها
tags map[string, object(TagSegment)]

نقشه بخش های برچسب نمایه شده با پیشوند برچسب.
ads map[string, object(Ad)]

نقشه تبلیغات نمایه شده با شناسه آگهی.
ad_breaks map[string, object(AdBreak)]

نقشه وقفه های تبلیغاتی نمایه شده با شناسه استراحت آگهی.

TagSegment

TagSegment حاوی یک مرجع به یک تبلیغ، وقفه تبلیغاتی آن و نوع رویداد است. 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)]

ورودی‌های تأیید اندازه‌گیری باز اختیاری که منابع و ابرداده‌های مورد نیاز برای اجرای کد اندازه‌گیری شخص ثالث را برای تأیید پخش خلاق فهرست می‌کنند.
slate boolean

bool اختیاری که نشان می دهد ورودی فعلی تخته سنگ است.
icons [object(Icon)]

فهرستی از نمادها که در صورت خالی بودن حذف می شوند.
wrappers [object(Wrapper)]

لیستی از Wrapper ها که در صورت خالی بودن حذف می شوند.
universal_ad_id object(UniversalAdID)

شناسه آگهی جهانی اختیاری.
extensions string

لیست اختیاری همه گره های <Extension> در VAST.
companions [object(Companion)]

همراهان اختیاری که ممکن است همراه با این آگهی نمایش داده شوند.
interactive_file object(InteractiveFile)

خلاقیت تعاملی اختیاری (SIMID) که باید در حین پخش آگهی نمایش داده شود.

PodTemplateResponse

PodTemplateResponse نشان دهنده بار JSON است که برای دوخت غلاف به VTP بازگردانده شده است.
نمایندگی JSON
{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}
فیلدها
dash_period_template string

DashPeriodTemplate الگوی xml برای دوره ای است که باید قبل از دوخت با داده های مناسب پر شود.
segment_duration_ms int64

SegmentDurationMS مدت زمان بخش های دوره بر حسب میلی ثانیه است.

AdpodTimingMetadataResponse

AdpodTimingMetadataResponse حاوی اطلاعاتی در مورد Ad Pod و نحوه ساخت URL های بخش برای آن است.
نمایندگی JSON
{
  "status": string,
  "ads": [object(AdRendering)],
  "slate": object(SlateRendering),
  "dash_representations": map[string, object(DASHRepresentation)],
  "dash_adaptation_sets": map[string, object(DASHAdaptationSet)],
}
فیلدها
status string

وضعیت تصمیم گیری برای آگهی.
ads [object(AdRendering)]

آرایه ای از اشیاء تبلیغاتی که نحوه ارائه url های بخش تبلیغات را شرح می دهد که از 0 ایندکس شده است.
slate object(SlateRendering)

تخته سنگ توضیح می دهد که چگونه url های بخش تخته سنگ را ارائه کنید.
dash_representations map[string, object(DASHRepresentation)]

فهرست نمایش‌های DASH برای آن غلاف تبلیغاتی که باید در مانیفست‌های DASH ارائه شوند.
dash_adaptation_sets map[string, object(DASHAdaptationSet)]

فهرستی از مجموعه‌های انطباق DASH برای آن دسته تبلیغاتی که در مانیفست‌های DASH ارائه می‌شوند.

AdRendering

AdRendering نحوه ارائه یک تبلیغ تصمیم گیری را شرح می دهد.
نمایندگی JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
فیلدها
duration_ms number

مدت زمان تبلیغ، بر حسب میلی ثانیه (int).
variants map[string, object(VariantRendering)]

Dictionary of Variant Objects (به زیر مراجعه کنید)، نمایه شده توسط نوع/نمایه ID، همانطور که از UI پیکربندی شده است.

SlateRendering

SlateRendering نحوه رندر کردن محتوای اسلایت را توضیح می دهد.
نمایندگی JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
فیلدها
duration_ms number

مدت زمان تخته سنگ، بر حسب میلی ثانیه (int).
variants map[string, object(VariantRendering)]

فرهنگ لغت اشیاء Variant، نمایه‌سازی شده بر اساس شناسه نوع/نمایه. مدت زمان تخته سنگ باید تا رسیدن به طول تخته‌ای مورد نیاز، درج ناپیوستگی‌های HLS بین تکرارها یا حلقه‌گذاری دوره‌های جدید برای MPEG-DASH حلقه شود.

VariantRendering

VariantRendering یک نوع/نمایه را در آگهی/تبلیغ توصیف می کند.
نمایندگی JSON
{
  "segment_extension": string,
  "segment_durations": object(SegmentDurations),
}
فیلدها
segment_extension string

رشته، یکی از: ts، mp4، aac، ac3، ec3، m4a، m4v. بخشی از پسوند نام فایل از URL های بخش.
segment_durations object(SegmentDurations)

اشیاء SegmentDurations. مدت زمان هر بخش را می توان به یک URL بخش ترجمه کرد.

مدت زمان بخش

SegmentDurations مدت زمان دنباله ای از بخش ها را در یک واحد زمانی مشخص توصیف می کند.
نمایندگی JSON
{
  "timescale": number,
  "values": [],
}
فیلدها
timescale number

مقیاس زمانی تعداد واحدهای در ثانیه (int) مورد انتظار است: 1000 برای HLS (میلی ثانیه) 90000 برای DASH ویدئو (PTS) نرخ نمونه صوتی برای صدای DASH.
values number

آرایه ای از مدت زمان قطعه int، در واحدهای مقیاس زمانی.

نمایندگی DASH

DASHRepresentation گره های بازنمایی را که در مانیفست های DASH ارائه می شوند را توصیف می کند.
نمایندگی JSON
{
  "codecs": string,
  "bandwidth": number,
  "width": number,
  "height": number,
  "frame_rate": string,
  "audio_sampling_rate": number,
  "audio_channel_config": object(SchemeIDURIAndValue),
}
فیلدها
codecs string

کدک های نمایندگی
bandwidth number

پهنای باند نمایندگی
width number

عرض نمایندگی
height number

ارتفاع نمایندگی.
frame_rate string

نرخ فریم نمایش.
audio_sampling_rate number

نرخ نمونه برداری صوتی از نمایندگی.
audio_channel_config object(SchemeIDURIAndValue)

پیکربندی کانال صوتی نمایندگی.

DASHAdaptationSet

DASHAdaptationSet گره های AdaptationSet را برای ارائه در مانیفست های DASH توصیف می کند.
نمایندگی JSON
{
  "content_type": string,
  "mime_type": string,
  "role": object(SchemeIDURIAndValue),
  "inband_event_stream": object(SchemeIDURIAndValue),
  "min_frame_rate": string,
  "max_frame_rate": string,
  "scan_type": string,
  "start_with_sap": string,
  "segment_alignment": boolean,
  "representations": [],
}
فیلدها
content_type string

نوع محتوای مجموعه انطباق.
mime_type string

نوع MIME مجموعه سازگاری.
role object(SchemeIDURIAndValue)

نقش مجموعه اقتباسی
inband_event_stream object(SchemeIDURIAndValue)

جریان رویداد درون باند مجموعه اقتباسی.
min_frame_rate string

حداقل نرخ فریم مجموعه انطباق.
max_frame_rate string

حداکثر نرخ فریم مجموعه انطباق.
scan_type string

نوع مجموعه سازگاری را اسکن کنید.
start_with_sap string

با SAP مجموعه سازگاری شروع کنید.
segment_alignment boolean

هم ترازی قطعه مجموعه انطباق.
representations string

بازنمایی از مجموعه اقتباسی.

SchemeIDURIandValue

SchemeIDURIAndValue یک جفت شناسه طرح و مقدار آن است.
نمایندگی JSON
{
  "scheme_id_uri": string,
  "value": string,
}
فیلدها
scheme_id_uri string

شناسه طرح URI مقدار.
value string

مقدار URI شناسه طرح.

نماد

نماد حاوی اطلاعاتی درباره نماد 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

Fallback Image

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 حاوی اطلاعاتی در مورد آگهی 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

شناسه معامله اختیاری برای آگهی بسته بندی.

تأیید

راستی‌آزمایی حاوی اطلاعاتی برای «اندازه‌گیری باز» است که قابلیت مشاهده و اندازه‌گیری راستی‌آزمایی شخص ثالث را تسهیل می‌کند. در حال حاضر، فقط منابع جاوا اسکریپت پشتیبانی می شود. به 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)]

فهرست منابع جاوا اسکریپت برای تأیید.
tracking_events [object(TrackingEvent)]

لیست رویدادهای ردیابی برای تأیید.
parameters string

یک رشته مات به کد تأیید بوت استرپ ارسال شد.

JavaScriptResource

JavaScriptResource حاوی اطلاعاتی برای تأیید از طریق جاوا اسکریپت است.
نمایندگی JSON
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
فیلدها
script_url string

URI به بارگذاری جاوا اسکریپت.
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

رشته ای که برای شناسایی نشانی وب سایت رجیستری استفاده می شود که شناسه آگهی جهانی خلاقیت انتخاب شده در آن فهرست شده است.

همراه

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 اگر همراهی از نوع static باشد.
height int32

ارتفاع بر حسب پیکسل این همراه.
width int32

عرض بر حسب پیکسل این همراه.
resource string

برای همراهان استاتیک و iframe این نشانی اینترنتی است که باید بارگیری و نمایش داده شود. برای همراهان HTML، این قطعه HTML است که باید به عنوان همراه نشان داده شود.
type string

نوع این همراه. می تواند ثابت، iframe یا HTML باشد.
ad_slot_id string

شناسه اسلات برای این همراه.
api_framework string

چارچوب API برای این همراه.
tracking_events [object(TrackingEvent)]

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

فایل تعاملی

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.
،

API درج آگهی پویا به شما امکان می‌دهد پخش‌های زنده DAI را درخواست و پیگیری کنید.

خدمات: dai.google.com

همه URI ها مربوط به https://dai.google.com هستند.

روش: جریان

روش ها
stream POST /ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

یک پاد DAI را برای ارائه جلسه پخش زنده ثبت می کند.

درخواست HTTP

POST https://dai.google.com/ssai/pods/api/v1/network/{network_code}/custom_asset/{custom_asset_key}/stream

پارامترهای مسیر

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است.

درخواست بدن

بدنه درخواست از نوع application/x-www-form-urlencoded است و شامل پارامترهای زیر است:

پارامترها
پارامترهای هدف DFP اختیاری پارامترهای هدف گیری اضافی
نادیده گرفتن پارامترهای جریان اختیاری مقادیر پیش‌فرض پارامتر ایجاد جریان را لغو کنید.
احراز هویت HMAC اختیاری با استفاده از توکن مبتنی بر HMAC احراز هویت.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی یک شی Stream جدید است.

باز کردن اندازه‌گیری

API DAI حاوی اطلاعاتی برای تأیید اندازه‌گیری باز در قسمت Verifications است. این فیلد حاوی یک یا چند عنصر Verification که منابع و ابرداده های مورد نیاز برای اجرای کد اندازه گیری شخص ثالث را به منظور تأیید پخش خلاق فهرست می کند. فقط JavaScriptResource پشتیبانی می شود. برای اطلاعات بیشتر، به آزمایشگاه فناوری IAB و مشخصات VAST 4.1 مراجعه کنید.

روش: بخش غلاف

روش ها
pod segment GET /linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

یک جریان DAI برای شناسه رویداد داده شده ایجاد می کند.

درخواست HTTP

GET https://dai.google.com/linear/pods/v1/seg/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}/profile/{profile_name}/{segment_number}.{segment_format}

پارامترهای مسیر

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است.

pod_identifier

فرمت های زیر پشتیبانی می شوند:

pod/{integer}

شناسه عددی برای وقفه تبلیغاتی فعلی. شناسه‌های غلاف آگهی به‌صورت تدریجی برای هر رویداد وقفه تبلیغاتی، از 1 شروع می‌شود.

ad_break_id/{string}

شناسه رشته برای وقفه تبلیغاتی فعلی. ناشر ارائه‌شده Ad break ID محدودیت‌های مشابهی با Ad pod ID ندارد. هر شناسه Ad Break ناشناخته ای که به آن نقطه پایانی ارائه می شود، یک Ad Break جدید برای رویداد پخش زنده ایجاد می کند.

profile_name string

نام نمایه رمزگذاری Google Ad Manager DAI درخواستی . نمایه رمزگذاری باید یکی از نمایه های رمزگذاری پیکربندی شده برای رویداد انتخاب شده باشد.

segment_number integer

نمایه بخش درخواستی در غلاف تبلیغات فعلی که از صفر شروع می شود.

segment_format string

پسوند فایل مرتبط با قالب بخش درخواستی. پسوندهای پذیرفته شده عبارتند از: ts , mp4 , vtt , aac , ac3 یا eac3 .

پارامترهای پرس و جو

پارامترها
stream_id مورد نیاز است string

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

sd required 1 integer

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

so اختیاری

افست بخش درخواستی در غلاف آگهی، در میلی ثانیه. اگر پارامتر so را حذف کنید، با ضرب مدت زمان بخش در شماره بخش محاسبه می شود.

pd مورد نیاز 2 integer

مدت زمان غلاف آگهی، بر حسب میلی ثانیه.

auth-token مورد نیاز است string

یک نشانه HMAC امضا شده و کدگذاری شده با URL برای غلاف تبلیغات فعلی.

last اختیاری boolean

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

scte35 اختیاری string

سیگنال SCTE-35 با کد Base64 برای این استراحت تبلیغاتی.

cust_params اختیاری string

مجموعه‌ای از جفت‌های کلید-مقدار که برای هدف‌یابی کمپین Ad Manager استفاده می‌شود. این جفت ها باید به عنوان یک رشته پرس و جو کدگذاری شده با آدرس اینترنتی نمایش داده شوند.

مثال:
پارامترها
  • بخش = sports
  • صفحه = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

پاورقی ها

  1. sd برای بخش های اولیه مورد نیاز نیست.
  2. pd برای رویدادهایی که وقفه‌های تبلیغاتی بدون مدت فعال هستند، لازم نیست.

مثال

دریافت کنید https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/ad_break_id/adbreak -2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99a4a47-6T

دریافت کنید https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/pod/2/profi le/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a:

بدن پاسخگو

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

روش: مانیفست غلاف HLS

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

روش ها
GET GET /linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset}/{pod_identifier}.m3u8;

API برای بازیابی یک لیست پخش چند متغیره HLS برای یک آگهی.

درخواست HTTP

GET https://dai.google.com/linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset_key}/{pod_identifier}.m3u8?stream_id={stream_id}&pd={pod_duration}

پارامترهای مسیر

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است

pod_identifier

فرمت های زیر پشتیبانی می شوند:

pod/{integer}

شناسه عددی برای وقفه تبلیغاتی فعلی. شناسه‌های غلاف آگهی به‌صورت تدریجی برای هر رویداد وقفه تبلیغاتی، از 1 شروع می‌شود.

ad_break_id/{string}

شناسه رشته برای وقفه تبلیغاتی فعلی. ناشر ارائه‌شده Ad break ID محدودیت‌های مشابهی با Ad pod ID ندارد. هر شناسه Ad Break ناشناخته ای که به آن نقطه پایانی ارائه می شود، یک Ad Break جدید برای رویداد پخش زنده ایجاد می کند.

پارامترهای پرس و جو

پارامترها
stream_id مورد نیاز string

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

pd مورد نیاز integer

مدت زمان غلاف آگهی، بر حسب میلی ثانیه.

scte35 اختیاری string

سیگنال SCTE-35 با کد Base64 برای این استراحت تبلیغاتی.

cust_params اختیاری string

مجموعه‌ای از جفت‌های کلید-مقدار که برای هدف‌یابی کمپین Ad Manager استفاده می‌شود. این جفت ها باید به عنوان یک رشته پرس و جو کدگذاری شده با آدرس اینترنتی نمایش داده شوند.

مثال:
پارامترها
  • بخش = sports
  • صفحه = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ یک لیست پخش چند متغیره HLS است.

روش: مانیفست غلاف DASH

یک مانیفست غلاف آگهی MPEG-DASH از جریان زنده را بازیابی می‌کند که برای بارگیری و پخش ویدیوی مشتری آماده است.

روش ها
GET GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/pod/{pod_id}/manifest.mpd

API برای بازیابی لیست پخش mpd MPEG-DASH برای یک آگهی.

درخواست HTTP

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/stream/{stream_id}/pod/{pod_id}/manifest.mpd?pd={pod_duration}

پارامترهای مسیر

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است

stream_id string

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

pod_id integer

شناسه عددی برای وقفه تبلیغاتی فعلی. شناسه‌های غلاف آگهی به‌صورت تدریجی برای هر رویداد وقفه تبلیغاتی، از 1 شروع می‌شود.

پارامترهای پرس و جو

پارامترها
pd مورد نیاز integer

مدت زمان غلاف آگهی، بر حسب میلی ثانیه.

scte35 اختیاری string

سیگنال SCTE-35 با کد Base64 برای این استراحت تبلیغاتی.

cust_params اختیاری string

مجموعه‌ای از جفت‌های کلید-مقدار که برای هدف‌یابی کمپین Ad Manager استفاده می‌شود. این جفت ها باید به عنوان یک رشته پرس و جو کدگذاری شده با آدرس اینترنتی نمایش داده شوند.

مثال:
پارامترها
  • بخش = sports
  • صفحه = golf,tennis
Request URL ...&cust_params=section%3Dsports%26page%3Dgolf%2Ctennis...

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ یک لیست پخش mpd MPEG-DASH است.

روش: الگوی دوره غلاف DASH

روش ها
pods GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

از Google Ad Manager یک الگوی دوره DASH درخواست می کند. این الگو حاوی ماکروهایی است که باید آنها را با پارامترهای جریان خود پر کنید. پس از پر شدن این ماکروها، الگو به دوره وقفه تبلیغاتی شما تبدیل می شود و می توان آن را در مانیفست DASH خود قرار داد.

درخواست HTTP

GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json

پارامترهای مسیر

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مربوط به این رویداد در Google Ad Manager است.

پارامترهای پرس و جو

پارامترها
stream_id مورد نیاز است string

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

tv اختیاری integer

نسخه قالب. پیش‌فرض 0 است. نسخه قالب پاد را برای بازگشت مشخص می کند.

  • 0 : الگویی را درخواست می کند که از شناسه توالی غلاف استفاده می کند.
  • 1 : الگویی را درخواست می‌کند که هم از شناسه‌های توالی پاد و هم از شناسه‌های شکست آگهی پشتیبانی کند.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی یک شی جدید PodTemplateResponse است.

روش: فراداده زمان بندی آگهی

روش ها
ad pod timing metadata GET /linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

فراداده زمان بندی غلاف آگهی را بازیابی می کند.

درخواست HTTP

GET https://dai.google.com/linear/pods/v1/adv/network/{network_code}/custom_asset/{custom_asset_key}/pod.json

پارامترهای مسیر

پارامترها
network_code string

کد شبکه Google Ad Manager ناشر.

custom_asset_key string

شناسه سفارشی مرتبط با این پخش زنده در Google Ad Manager.

پارامترهای پرس و جو

پارامترها
stream_id مورد نیاز string

شناسه جریان Ad Manager از برنامه پخش کننده ویدیوی مشتری.

ad_break_id مورد نیاز است string

شناسه بعدی استراحت آگهی آینده.

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

محدودیت های زیر برای شناسه های adbreak سفارشی اعمال می شود:

  • باید بین 1 تا 63 کاراکتر باشد
  • باید فقط شامل حروف کوچک، اعداد و خط فاصله باشد.
  • preroll شناسه استراحت آگهی برای بازیابی غلاف آگهی قبل از پخش رزرو شده است. نمی توان از آن برای شناسایی هر پاد تبلیغاتی دیگری استفاده کرد.
auth-token مورد نیاز است string

auth-token از یک نشانه HMAC با پارامترهای زیر تشکیل شده است:

  • ad_break_id
  • custom_asset_key
  • exp
  • network_code
  • custom_params
  • pd
  • scte35
timeout اختیاری integer

تعداد میلی‌ثانیه‌هایی که DAI می‌تواند این درخواست را برای منتظر ماندن برای تصمیم‌گیری آگهی مسدود کند. از این پارامتر در درخواست‌هایی استفاده کنید که در اولین درخواست باید تبلیغات پر شده را برگردانند، مانند وقفه‌های تبلیغاتی قبل از پخش.

اگر از مهلت زمانی فراتر رود، درخواست وضعیت معلق را برمی‌گرداند.

اگر گنجانده شود، مقدار وقفه باید بین 1000 تا 15000 میلی ثانیه باشد. در صورت حذف، پاسخ ها به تأخیر نمی افتند و منتظر تصمیم گیری آگهی هستند.

final اختیاری boolean

روی true تنظیم کنید تا به DAI نشان دهید که این آخرین درخواستی است که VTP مایل است برای این غلاف تبلیغاتی انجام دهد. اگر تصمیمی برای آگهی هنوز در دسترس نباشد (تا زمان پایان اختیاری)، DAI برای این درخواست صفحه را به طور دائم برمی گرداند.

پیش فرض ها به false .

پارامترهای تصمیم گیری تبلیغات

pd اختیاری integer

مدت زمان وقفه تبلیغاتی (بر حسب میلی ثانیه). همچنین به عنوان مدت زمان غلاف آگهی نیز نامیده می شود.

اگر از EABN استفاده می شود، مقدار pd باید با مدت زمان ارائه شده در اعلان وقفه تبلیغاتی شما مطابقت داشته باشد. اگر مدت زمان ها مطابقت نداشته باشند، مقدار EABN در اولویت قرار می گیرد.

cust_params اختیاری string

پارامترهای سفارشی برای هدف قرار دادن وقفه تبلیغاتی، همانطور که در مرکز راهنمای Ad Manager توضیح داده شده است.

scte35 اختیاری string

یک سیگنال SCTE-35 با کد base64.

اگر سیگنال نامعتبر باشد، پیامی در هدر HTTP X-Ad-Manager-Dai-Warning ارسال می شود و درخواست بدون مقدار scte35 نامعتبر ارسال می شود.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی یک شی جدید AdPodTimingMetadataResponse است.

روش: تایید رسانه ای

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

درخواست‌ها به نقطه پایانی media verification بی‌توان هستند.

روش ها
media verification GET /{media_verification_url}/{ad_media_id}

API را از یک رویداد تأیید رسانه مطلع می کند.

درخواست HTTP

GET https://{media-verification-url}/{ad-media-id}

بدن پاسخگو

media verification پاسخهای زیر را برمی گرداند:

  • اگر تأیید رسانه موفق شود و تمام پینگ ها ارسال شود HTTP/1.1 204 No Content .
  • HTTP/1.1 404 Not Found .
  • HTTP/1.1 404 Not Found .
  • HTTP/1.1 409 Conflict اگر درخواست دیگری در حال حاضر در حال ارسال پینگ است.

شناسه رسانه های تبلیغاتی

شناسه رسانه های تبلیغاتی در یک مسیر ابرداده جداگانه رمزگذاری می شود - ابرداده به موقع برای جریان حمل و نقل HLS یا EMSG برای پرونده های MP4. شناسه رسانه های تبلیغاتی همیشه با رشته google_ شروع می شود.

کل محتوای متن ورودی ابرداده باید قبل از ارسال هر درخواست تأیید آگهی ، به URL تأیید آگهی اضافه شود.

روش: ابرداده

نقطه پایانی ابرداده در metadata_url اطلاعات مورد استفاده برای ساخت یک آگهی تبلیغاتی را برمی گرداند. نقطه پایانی ابرداده برای جریان های کنار سرور در دسترس نیست ، جایی که سرور مسئول شروع تأیید رسانه های تبلیغاتی است.

روش ها
metadata GET /{metadata_url}/{ad-media-id}

GET /{metadata_url}

اطلاعات ابرداده تبلیغاتی را بازیابی می کند.

درخواست HTTP

GET https://{metadata_url}/{ad-media-id}

GET https://{metadata_url}

بدن پاسخگو

در صورت موفقیت ، پاسخ نمونه ای از PodMetadata را برمی گرداند.

ابرداده

ابرداده دارای سه بخش گسسته است: tags ، ads و breaks تبلیغاتی. نقطه ورود به داده ها بخش tags است. از آنجا ، از طریق برچسب ها تکرار کنید و اولین ورودی را پیدا کنید که نام آن پیشوند شناسه رسانه تبلیغاتی است که در جریان ویدیو یافت می شود. به عنوان مثال ، شما ممکن است یک شناسه رسانه ای تبلیغاتی داشته باشید که به نظر می رسد:

google_1234567890

سپس یک شی برچسب به نام google_12345 پیدا می کنید. در این حالت ، با شناسه رسانه تبلیغاتی شما مطابقت دارد. پس از پیدا کردن صحیح پیشوند رسانه تبلیغاتی ، می توانید شناسه های تبلیغاتی ، شناسه های تبلیغات و نوع رویداد را جستجو کنید. سپس از شناسه های ads برای فهرست بندی اشیاء ADS استفاده می شود و از شناسه های AD Break برای نمایه اشیاء breaks استفاده می شود.

داده های پاسخ

جریان

جریان برای ارائه لیستی از منابع برای یک جریان تازه ایجاد شده با فرمت JSON استفاده می شود.
نمایندگی JSON
{
  "stream_id": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "heartbeat_url": string,
  "polling_frequency": number,
  "pod_manifest_url": string,
  "manifest_format": string,
}
فیلدها
stream_id string

شناسه جریان GAM.
media_verification_url string

URL تأیید رسانه ای به عنوان نقطه پایانی برای ردیابی رویدادهای پخش استفاده می شود.
metadata_url string

URL ابرداده برای اطلاعات دوره ای در مورد رویدادهای تبلیغاتی جریان آینده استفاده می شود.
session_update_url string

URL به روزرسانی جلسه برای به روزرسانی پارامترهای هدفمند برای این جریان استفاده می شود. مقادیر اصلی برای پارامترهای هدفمند در طول درخواست ایجاد جریان اولیه ضبط می شوند.
heartbeat_url string

URL ضربان قلب ، که برای زنده نگه داشتن جریان چراغ سرور استفاده می شود ، باید در هر ثانیه {نظرسنجی فرکانس pinged شود. جمع شده برای جریان های چراغ جانبی سرور.
polling_frequency number

فرکانس نظرسنجی ، در چند ثانیه ، هنگام درخواست metadata_url یا heartbeat_url.
pod_manifest_url string

از الگوی URL مانیفست POD برای تولید URL برای بازیابی مانیفست غلاف یک جریان استفاده می شود ، مطابق با URL لیست پخش چند منظوره در HLS یا MPD در داش. برای رویدادهای زنده از نوع آگهی پویا از نوع POD_SERVING_MANIFEST جمع شده است. https://developers.google.com/ad-manager/api/reference/v202305/livestreameventservice.dynamicadinsertipe
manifest_format string

قالب مانیفست قالب مانیفست بازیابی شده از pod_manifest_url ، یا dash یا hls است.

غلاف

Podmetadata حاوی اطلاعات ابرداده در مورد تبلیغات ، آگهی های تبلیغاتی و برچسب های شناسه رسانه ای است.
نمایندگی JSON
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
}
فیلدها
tags map[string, object(TagSegment)]

نقشه بخش های برچسب که توسط پیشوند برچسب نمایه می شوند.
ads map[string, object(Ad)]

نقشه تبلیغات با استفاده از آگهی شناسه.
ad_breaks map[string, object(AdBreak)]

نقشه آگهی های تبلیغاتی که توسط آگهی شناسه آگهی نمایه شده است.

نشان

TagSement شامل یک مرجع به یک آگهی ، شکستن آگهی آن و نوع رویداد است. برچسب با نوع = "پیشرفت" نباید به نقطه پایانی تأیید رسانه تبلیغ شود.
نمایندگی JSON
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
فیلدها
ad string

شناسه تبلیغ این برچسب.
ad_break_id string

شناسه آگهی این برچسب.
type string

نوع رویداد این برچسب.

با ضرب و شتم

Adbreak یک شکست تبلیغاتی در جریان را توصیف می کند. این شامل مدت زمان ، یک نوع (اواسط/قبل/پست) و تعداد تبلیغات است.
نمایندگی JSON
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
فیلدها
type string

انواع معتبر استراحت عبارتند از: قبل ، میانه و پست.
duration number

مدت زمان تبلیغ برای این شکست تبلیغات ، در ثانیه.
expected_duration number

مدت زمان پیش بینی استراحت تبلیغ (در ثانیه) ، از جمله همه تبلیغات و هر تخته سنگ.
ads number

تعداد تبلیغات در آگهی شکست.
AD یک تبلیغ در جریان را توصیف می کند.
نمایندگی 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 Clickthrough اختیاری.
click_tracking_urls string

URL های Tracking URL های اختیاری.
verifications [object(Verification)]

ورودی های تأیید سنجی باز اختیاری که منابع و ابرداده های لازم برای اجرای کد اندازه گیری شخص ثالث را برای تأیید پخش خلاق ذکر می کند.
slate boolean

BOOL اختیاری که نشانگر ورودی فعلی است Slate است.
icons [object(Icon)]

لیستی از نمادها ، در صورت خالی بودن حذف شده است.
wrappers [object(Wrapper)]

لیستی از بسته بندی ها ، در صورت خالی حذف شده است.
universal_ad_id object(UniversalAdID)

شناسه تبلیغاتی جهانی اختیاری.
extensions string

لیست اختیاری از همه گره های <پسوند> در وسیع.
companions [object(Companion)]

همراهان اختیاری که ممکن است همراه با این تبلیغ نمایش داده شوند.
interactive_file object(InteractiveFile)

اختیاری تعاملی خلاق (SIMID) که باید در طول پخش تبلیغ نمایش داده شود.

پاسخ

PodtemplaterEsponse نمایانگر بار JSON است که برای دوخت POD به VTP بازگردانده شده است.
نمایندگی JSON
{
  "dash_period_template": string,
  "segment_duration_ms": int64,
}
فیلدها
dash_period_template string

Dashperiodtemplate الگوی XML است که دوره قبل از دوخت با داده های مناسب پر می شود.
segment_duration_ms int64

SegmentDurationms مدت زمان بخش های دوره در میلی ثانیه است.

adpodtimingmetadataresponse

AdpodtimingMetadataresponse حاوی اطلاعاتی در مورد غلاف تبلیغات و نحوه ساخت URL های بخش برای آن است.
نمایندگی JSON
{
  "status": string,
  "ads": [object(AdRendering)],
  "slate": object(SlateRendering),
  "dash_representations": map[string, object(DASHRepresentation)],
  "dash_adaptation_sets": map[string, object(DASHAdaptationSet)],
}
فیلدها
status string

وضعیت تصمیم گیری برای غلاف تبلیغاتی.
ads [object(AdRendering)]

آرایه ای از اشیاء تبلیغاتی که نحوه ارائه URL های بخش تبلیغاتی را توصیف می کنند ، از 0 استفاده می شود.
slate object(SlateRendering)

تخته سنگ در مورد نحوه ارائه URL های بخش صفحات.
dash_representations map[string, object(DASHRepresentation)]

لیست بازنمودهای خط برای آن غلاف تبلیغاتی در مانیفست های داش ارائه می شود.
dash_adaptation_sets map[string, object(DASHAdaptationSet)]

لیست مجموعه های سازگاری DASH برای آن غلاف تبلیغاتی در مانیفست های داش ارائه می شود.

یک نشانگر

Adrendering نحوه ارائه یک تبلیغ تصمیم گیری را توصیف می کند.
نمایندگی JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
فیلدها
duration_ms number

مدت زمان تبلیغ ، در میلی ثانیه (int).
variants map[string, object(VariantRendering)]

فرهنگ لغت اشیاء مختلف (به تصویر زیر مراجعه کنید) ، که توسط شناسه Variant/Profile نمایه شده است ، همانطور که از UI پیکربندی شده است.

شستشو

Slaterendering نحوه ارائه محتوای صفحات را توصیف می کند.
نمایندگی JSON
{
  "duration_ms": number,
  "variants": map[string, object(VariantRendering)],
}
فیلدها
duration_ms number

مدت زمان تخته سنگ ، در میلی ثانیه (int).
variants map[string, object(VariantRendering)]

فرهنگ لغت اشیاء مختلف ، با شناسه متفاوت/مشخصات نمایه شده است. مدت زمان تخته سنگ باید حلقه شود تا طول تخته سنگ مورد نیاز به دست بیاید ، درج ناپیوستگی HLS بین تکرارها یا حلقه های جدید برای MPEG-DASH.

متغیر

Variantrendering یک نوع/پروفایل را در آگهی/تخته سنگ توصیف می کند.
نمایندگی JSON
{
  "segment_extension": string,
  "segment_durations": object(SegmentDurations),
}
فیلدها
segment_extension string

رشته ، یکی از: TS ، MP4 ، AAC ، AC3 ، EC3 ، M4A ، M4V. قسمت پسوند نام پرونده از URL های بخش.
segment_durations object(SegmentDurations)

اشیاء SegmentDurations. هر مدت زمان می تواند به یک URL بخش ترجمه شود.

بخش های

بخش های بخش مدت زمان توالی بخش ها را در یک واحد زمانی مشخص توصیف می کند.
نمایندگی JSON
{
  "timescale": number,
  "values": [],
}
فیلدها
timescale number

Timescale تعداد واحدهای در ثانیه (int) است که انتظار می رود: 1000 برای HLS (میلی ثانیه) 90000 برای Dash Video (PTS) نرخ نمونه صوتی برای صدای Dash.
values number

آرایه ای از مدت زمان بخش int ، در واحدهای بازه زمانی.

نمایش

DashReventation گره های بازنمایی را که در مانیفست های داش ارائه می شود ، توصیف می کند.
نمایندگی JSON
{
  "codecs": string,
  "bandwidth": number,
  "width": number,
  "height": number,
  "frame_rate": string,
  "audio_sampling_rate": number,
  "audio_channel_config": object(SchemeIDURIAndValue),
}
فیلدها
codecs string

کدک های نمایندگی.
bandwidth number

پهنای باند نمایندگی.
width number

عرض نمایندگی.
height number

ارتفاع نمایندگی.
frame_rate string

نرخ فریم نمایندگی.
audio_sampling_rate number

میزان نمونه برداری صوتی نمایندگی.
audio_channel_config object(SchemeIDURIAndValue)

پیکربندی کانال صوتی نمایندگی.

DashAdaptationset

DashAdaptationset گره های Adaptiationset را که در مانیفست های داش ارائه می شود ، توصیف می کند.
نمایندگی JSON
{
  "content_type": string,
  "mime_type": string,
  "role": object(SchemeIDURIAndValue),
  "inband_event_stream": object(SchemeIDURIAndValue),
  "min_frame_rate": string,
  "max_frame_rate": string,
  "scan_type": string,
  "start_with_sap": string,
  "segment_alignment": boolean,
  "representations": [],
}
فیلدها
content_type string

نوع محتوای مجموعه سازگاری.
mime_type string

نوع MIME از مجموعه سازگاری.
role object(SchemeIDURIAndValue)

نقش مجموعه سازگاری.
inband_event_stream object(SchemeIDURIAndValue)

جریان رویداد با مجموعه سازگاری.
min_frame_rate string

حداقل نرخ فریم مجموعه سازگاری.
max_frame_rate string

حداکثر نرخ فریم مجموعه سازگاری.
scan_type string

نوع اسکن مجموعه سازگاری.
start_with_sap string

با SAP از مجموعه سازگاری شروع کنید.
segment_alignment boolean

تراز بخش مجموعه سازگاری.
representations string

بازنمایی مجموعه سازگاری.

مقادیر خاص

SchemeIduriandValue یک جفت شناسه طرح و ارزش آن است.
نمایندگی JSON
{
  "scheme_id_uri": string,
  "value": string,
}
فیلدها
scheme_id_uri string

طرح id uri از مقدار.
value string

ارزش طرح URI.

نماد

نماد حاوی اطلاعاتی در مورد یک نماد گسترده است.
نمایندگی 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 حاوی اطلاعاتی در مورد یک تصویر گسترده برگشتی است.
نمایندگی 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

لفاف

بسته بندی حاوی اطلاعاتی در مورد تبلیغ بسته بندی است. اگر وجود نداشته باشد ، شناسه معامله را شامل نمی شود.
نمایندگی 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

شناسه معاملات اختیاری برای تبلیغ بسته بندی.

تأیید

تأیید حاوی اطلاعاتی برای اندازه گیری باز است ، که قابلیت مشاهده شخص ثالث و اندازه گیری تأیید را تسهیل می کند. در حال حاضر ، فقط از منابع JavaScript پشتیبانی می شود. به https://iabtechlab.com/standards/open-mupearment-sdk/ مراجعه کنید
نمایندگی JSON
{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}
فیلدها
vendor string

فروشنده تأیید
java_script_resources [object(JavaScriptResource)]

لیست منابع جاوا اسکریپت برای تأیید.
tracking_events [object(TrackingEvent)]

لیست رویدادهای ردیابی برای تأیید.
parameters string

یک رشته مات به کد تأیید بوت استرپ منتقل شد.

javascripcriptresource

JavaScripTresource حاوی اطلاعاتی برای تأیید از طریق JavaScript است.
نمایندگی JSON
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
فیلدها
script_url string

URI به JavaScript Payload.
api_framework string

ApiframeWork نام چارچوب ویدیویی است که از کد تأیید استفاده می کند.
browser_optional boolean

آیا این اسکریپت را می توان در خارج از مرورگر اجرا کرد.

ردیابی کننده

TrackingEvent شامل URL هایی است که باید در شرایط خاص توسط مشتری پینگ شوند.
نمایندگی JSON
{
  "event": string,
  "uri": string,
}
فیلدها
event string

نوع رویداد ردیابی.
uri string

رویداد پیگیری برای پینگ شدن.

جهانی الدی

Universaladid برای تهیه یک شناسه خلاق منحصر به فرد که در سیستم های AD نگهداری می شود ، استفاده می شود.
نمایندگی JSON
{
  "id_value": string,
  "id_registry": string,
}
فیلدها
id_value string

شناسه تبلیغاتی جهانی خلاق انتخاب شده برای تبلیغ.
id_registry string

رشته ای که برای شناسایی URL برای وب سایت رجیستری که در آن شناسه جهانی انتخاب شده خلاق انتخاب شده است ، استفاده می شود.

همراه

همراه حاوی اطلاعاتی برای تبلیغات همراه است که ممکن است همراه با AD نمایش داده شود.
نمایندگی 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> در وسیع اگر این یک همراه از نوع استاتیک باشد.
height int32

قد در پیکسل های این همراه.
width int32

عرض در پیکسل های این همراه.
resource string

برای همراهان استاتیک و Iframe این URL بارگیری و نمایش داده می شود. برای همراهان HTML ، این قطعه HTML خواهد بود که باید به عنوان همراه نشان داده شود.
type string

نوع این همراه این می تواند استاتیک ، iframe یا HTML باشد.
ad_slot_id string

شناسه شکاف برای این همراه.
api_framework string

چارچوب API برای این همراه.
tracking_events [object(TrackingEvent)]

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

تعاملی

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

مقدار گره <dparameters> در وسیع.