ডাইনামিক অ্যাড ইনসারশন এপিআই আপনাকে ডিএআই লাইভস্ট্রিম অনুরোধ করতে এবং ট্র্যাক করতে দেয়।
পরিষেবা: dai.google.com
সমস্ত ইউআরআই 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প্রকাশকের গুগল অ্যাড ম্যানেজার নেটওয়ার্ক কোড। |
custom_asset_key | stringকাস্টম আইডেন্টিফায়ারটি গুগল অ্যাড ম্যানেজারে এই ইভেন্টটিকে যুক্ত করেছে। |
অনুরোধকারী শরীর
অনুরোধের বডিটি application/x-www-form-urlencoded ধরনের এবং এতে নিম্নলিখিত প্যারামিটারগুলো রয়েছে:
| প্যারামিটার | ||
|---|---|---|
| ডিএফপি টার্গেটিং প্যারামিটার | ঐচ্ছিক | অতিরিক্ত টার্গেটিং প্যারামিটার। |
| স্ট্রিম প্যারামিটার ওভাররাইড করুন | ঐচ্ছিক | স্ট্রিম তৈরির প্যারামিটারের ডিফল্ট মানগুলো পরিবর্তন করুন। |
| HMAC প্রমাণীকরণ | ঐচ্ছিক | HMAC-ভিত্তিক টোকেন ব্যবহার করে প্রমাণীকরণ করুন। |
প্রতিক্রিয়া সংস্থা
সফল হলে, রেসপন্স বডিতে একটি নতুন Stream অবজেক্ট থাকে।
উন্মুক্ত পরিমাপ
DAI API-এর 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প্রকাশকের গুগল অ্যাড ম্যানেজার নেটওয়ার্ক কোড। |
custom_asset_key | stringকাস্টম আইডেন্টিফায়ারটি গুগল অ্যাড ম্যানেজারে এই ইভেন্টটিকে যুক্ত করেছে। |
pod_identifier | নিম্নলিখিত ফরম্যাটগুলো সমর্থিত: pod/{integer} বর্তমান বিজ্ঞাপন বিরতির সাংখ্যিক শনাক্তকারী। প্রতিটি বিজ্ঞাপন বিরতি ইভেন্টের জন্য বিজ্ঞাপন পড আইডি ad_break_id/{string}বর্তমান বিজ্ঞাপন বিরতির স্ট্রিং শনাক্তকারী। ওই এন্ডপয়েন্টে কোনো অজানা বিজ্ঞাপন বিরতি আইডি প্রদান করা হলে লাইভস্ট্রিম ইভেন্টের জন্য একটি নতুন বিজ্ঞাপন বিরতি তৈরি হয়। কাস্টম অ্যাডব্রেক আইডিগুলোর ক্ষেত্রে নিম্নলিখিত বিধিনিষেধগুলো প্রযোজ্য:
|
profile_name | stringঅনুরোধকৃত গুগল অ্যাড ম্যানেজার DAI এনকোডিং প্রোফাইলের নাম । এনকোডিং প্রোফাইলটি অবশ্যই নির্বাচিত ইভেন্টের জন্য কনফিগার করা এনকোডিং প্রোফাইলগুলোর মধ্যে একটি হতে হবে। |
segment_number | integerবর্তমান অ্যাড পডের মধ্যে অনুরোধকৃত সেগমেন্টের সূচক, যা শূন্য থেকে শুরু হয়। |
segment_format | string অনুরোধকৃত সেগমেন্ট ফরম্যাটের সাথে সংশ্লিষ্ট ফাইল এক্সটেনশন। গ্রহণযোগ্য এক্সটেনশনগুলো হলো: |
কোয়েরি প্যারামিটার
| প্যারামিটার | ||||||
|---|---|---|---|---|---|---|
stream_id | প্রয়োজনীয় | string বর্তমান ব্যবহারকারীর সেশনের স্ট্রিম আইডি। | ||||
sd | required 1 | integerঅনুরোধকৃত অংশটির সময়কাল, মিলিসেকেন্ডে। | ||||
so | ঐচ্ছিক | অ্যাড পডের মধ্যে অনুরোধ করা সেগমেন্টের অফসেট, মিলিসেকেন্ডে। যদি আপনি ' | ||||
pd | প্রয়োজনীয় ২ | integerঅ্যাড পডটির স্থায়িত্বকাল, মিলিসেকেন্ডে। | ||||
auth-token | প্রয়োজনীয় | string
| ||||
last | ঐচ্ছিক | booleanবিজ্ঞাপন বিরতির শেষ অংশ নির্দেশ করে। অন্য সব অংশের জন্য এই প্যারামিটারটি বাদ দিন। | ||||
scte35 | ঐচ্ছিক | stringএই বিজ্ঞাপন বিরতির জন্য বেস৬৪-এনকোডেড SCTE-35 সংকেত। | ||||
cust_params | ঐচ্ছিক | stringঅ্যাড ম্যানেজার ক্যাম্পেইন টার্গেটিং-এর জন্য ব্যবহৃত কী-ভ্যালু পেয়ারের একটি সেট। এই পেয়ারগুলোকে অবশ্যই একটি ইউআরএল-এনকোডেড কোয়েরি স্ট্রিং হিসেবে উপস্থাপন করতে হবে। উদাহরণ:
| ||||
পাদটীকা
- প্রারম্ভিক পর্বের জন্য
sdপ্রয়োজন নেই। ↩ - যেসব ইভেন্টে অনির্দিষ্টকালের বিজ্ঞাপন বিরতি চালু আছে, সেগুলোর জন্য
pdপ্রয়োজন নেই। ↩
উদাহরণ
GET 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-99d7-860aa4a674cb:TEST
GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/pod/2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST
প্রতিক্রিয়া সংস্থা
সফল হলে, রেসপন্স বডিটি হবে অনুরোধে নির্দিষ্ট করা ফরম্যাট ও প্যারামিটারের সাথে মিলে যাওয়া একটি প্লেয়েবল স্ট্রিম সেগমেন্ট।
পদ্ধতি: এইচএলএস পড ম্যানিফেস্ট
একটি লাইভস্ট্রিমের HLS অ্যাড পড ম্যানিফেস্ট পুনরুদ্ধার করে, যা ক্লায়েন্ট ভিডিও প্লেয়ারের লোড ও প্লে করার জন্য প্রস্তুত থাকে।
| পদ্ধতি | |
|---|---|
GET | GET /linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset}/{pod_identifier}.m3u8;একটি অ্যাড পডের জন্য HLS মাল্টিভেরিয়েন্ট প্লেলিস্ট পুনরুদ্ধার করার API। |
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প্রকাশকের গুগল অ্যাড ম্যানেজার নেটওয়ার্ক কোড। |
custom_asset_key | stringকাস্টম আইডেন্টিফায়ারটি গুগল অ্যাড ম্যানেজারে এই ইভেন্টটিকে যুক্ত করেছে। |
pod_identifier | নিম্নলিখিত ফরম্যাটগুলো সমর্থিত: pod/{integer} বর্তমান বিজ্ঞাপন বিরতির সাংখ্যিক শনাক্তকারী। প্রতিটি বিজ্ঞাপন বিরতি ইভেন্টের জন্য বিজ্ঞাপন পড আইডি ad_break_id/{string}বর্তমান বিজ্ঞাপন বিরতির স্ট্রিং শনাক্তকারী। ওই এন্ডপয়েন্টে কোনো অজানা বিজ্ঞাপন বিরতি আইডি প্রদান করা হলে লাইভস্ট্রিম ইভেন্টের জন্য একটি নতুন বিজ্ঞাপন বিরতি তৈরি হয়। কাস্টম অ্যাডব্রেক আইডিগুলোর ক্ষেত্রে নিম্নলিখিত বিধিনিষেধগুলো প্রযোজ্য:
|
কোয়েরি প্যারামিটার
| প্যারামিটার | ||||||
|---|---|---|---|---|---|---|
stream_id | প্রয়োজনীয় | string বর্তমান ব্যবহারকারীর সেশনের স্ট্রিম আইডি। | ||||
pd | প্রয়োজনীয় | integerঅ্যাড পডটির স্থায়িত্বকাল, মিলিসেকেন্ডে। | ||||
scte35 | ঐচ্ছিক | stringএই বিজ্ঞাপন বিরতির জন্য বেস৬৪-এনকোডেড SCTE-35 সংকেত। | ||||
cust_params | ঐচ্ছিক | stringঅ্যাড ম্যানেজার ক্যাম্পেইন টার্গেটিং-এর জন্য ব্যবহৃত কী-ভ্যালু পেয়ারের একটি সেট। এই পেয়ারগুলোকে অবশ্যই একটি ইউআরএল-এনকোডেড কোয়েরি স্ট্রিং হিসেবে উপস্থাপন করতে হবে। উদাহরণ:
| ||||
auth-token | প্রয়োজনীয় | string
| ||||
প্রতিক্রিয়া সংস্থা
সফল হলে, প্রতিক্রিয়া বডিটি একটি HLS মাল্টিভেরিয়েন্ট প্লেলিস্ট হয়।
পদ্ধতি: ড্যাশ পড ম্যানিফেস্ট
একটি লাইভস্ট্রিমের MPEG-DASH অ্যাড পড ম্যানিফেস্ট পুনরুদ্ধার করে, যা ক্লায়েন্ট ভিডিও প্লেয়ারের লোড ও প্লে করার জন্য প্রস্তুত থাকে।
| পদ্ধতি | |
|---|---|
GET | GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/{pod_identifier}/manifest.mpdএকটি অ্যাড পডের জন্য এমপেগ-ড্যাশ এমপিডি প্লেলিস্ট পুনরুদ্ধার করার এপিআই। |
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প্রকাশকের গুগল অ্যাড ম্যানেজার নেটওয়ার্ক কোড। |
custom_asset_key | stringকাস্টম আইডেন্টিফায়ারটি গুগল অ্যাড ম্যানেজারে এই ইভেন্টটিকে যুক্ত করেছে। |
stream_id | string বর্তমান ব্যবহারকারীর সেশনের স্ট্রিম আইডি। |
pod_identifier | নিম্নলিখিত ফরম্যাটগুলো সমর্থিত: pod/{integer} বর্তমান বিজ্ঞাপন বিরতির সাংখ্যিক শনাক্তকারী। প্রতিটি বিজ্ঞাপন বিরতি ইভেন্টের জন্য বিজ্ঞাপন পড আইডি ad_break_id/{string}বর্তমান বিজ্ঞাপন বিরতির স্ট্রিং শনাক্তকারী। ওই এন্ডপয়েন্টে কোনো অজানা বিজ্ঞাপন বিরতি আইডি প্রদান করা হলে লাইভস্ট্রিম ইভেন্টের জন্য একটি নতুন বিজ্ঞাপন বিরতি তৈরি হয়। কাস্টম অ্যাডব্রেক আইডিগুলোর ক্ষেত্রে নিম্নলিখিত বিধিনিষেধগুলো প্রযোজ্য:
|
কোয়েরি প্যারামিটার
| প্যারামিটার | ||||||
|---|---|---|---|---|---|---|
pd | প্রয়োজনীয় | integerঅ্যাড পডটির স্থায়িত্বকাল, মিলিসেকেন্ডে। | ||||
scte35 | ঐচ্ছিক | stringএই বিজ্ঞাপন বিরতির জন্য বেস৬৪-এনকোডেড SCTE-35 সংকেত। | ||||
cust_params | ঐচ্ছিক | stringঅ্যাড ম্যানেজার ক্যাম্পেইন টার্গেটিং-এর জন্য ব্যবহৃত কী-ভ্যালু পেয়ারের একটি সেট। এই পেয়ারগুলোকে অবশ্যই একটি ইউআরএল-এনকোডেড কোয়েরি স্ট্রিং হিসেবে উপস্থাপন করতে হবে। উদাহরণ:
| ||||
auth-token | প্রয়োজনীয় | string
| ||||
প্রতিক্রিয়া সংস্থা
সফল হলে, প্রতিক্রিয়া অংশটি একটি MPEG-DASH mpd প্লেলিস্ট হয়।
পদ্ধতি: ড্যাশ পড পিরিয়ড টেমপ্লেট
| পদ্ধতি | |
|---|---|
pods | GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.jsonগুগল অ্যাড ম্যানেজার থেকে একটি ড্যাশ পিরিয়ড টেমপ্লেটের জন্য অনুরোধ করা হয়। এই টেমপ্লেটটিতে ম্যাক্রো থাকে, যা আপনাকে আপনার স্ট্রিম প্যারামিটার দিয়ে পূরণ করতে হবে। এই ম্যাক্রোগুলো পূরণ করা হয়ে গেলে, টেমপ্লেটটি আপনার বিজ্ঞাপন বিরতির সময়কাল হয়ে যায় এবং এটিকে আপনার ড্যাশ ম্যানিফেস্টের সাথে যুক্ত করা যায়। |
HTTP অনুরোধ
GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json
পথের পরামিতি
| প্যারামিটার | |
|---|---|
network_code | stringপ্রকাশকের গুগল অ্যাড ম্যানেজার নেটওয়ার্ক কোড। |
custom_asset_key | stringকাস্টম আইডেন্টিফায়ারটি গুগল অ্যাড ম্যানেজারে এই ইভেন্টটিকে যুক্ত করেছে। |
কোয়েরি প্যারামিটার
| প্যারামিটার | ||
|---|---|---|
stream_id | প্রয়োজনীয় | string বর্তমান ব্যবহারকারীর সেশনের স্ট্রিম আইডি। |
tv | ঐচ্ছিক | integer টেমপ্লেট সংস্করণ। ডিফল্ট মান
|
প্রতিক্রিয়া সংস্থা
সফল হলে, রেসপন্স বডিতে একটি নতুন 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প্রকাশকের গুগল অ্যাড ম্যানেজার নেটওয়ার্ক কোড। |
custom_asset_key | stringগুগল অ্যাড ম্যানেজারে এই লাইভস্ট্রিমের সাথে যুক্ত কাস্টম আইডেন্টিফায়ার। |
কোয়েরি প্যারামিটার
| প্যারামিটার | ||
|---|---|---|
stream_id | প্রয়োজনীয় | stringক্লায়েন্ট ভিডিও প্লেয়ার অ্যাপ থেকে প্রাপ্ত অ্যাড ম্যানেজার স্ট্রিম আইডি। |
ad_break_id | প্রয়োজনীয় | stringপরবর্তী আসন্ন বিজ্ঞাপন বিরতির আইডি। অ্যাড ব্রেক আইডিগুলো স্টিচিং সার্ভার বা VTP দ্বারা সরবরাহ করা হয় এবং একই অ্যাড ব্রেকের জন্য আর্লি অ্যাড ব্রেক নোটিফিকেশন, অ্যাড পড টাইমিং মেটাডেটা রিকোয়েস্ট এবং সেগমেন্ট রিডাইরেক্ট রিকোয়েস্ট জুড়ে এগুলো অবশ্যই মিলতে হবে। কাস্টম অ্যাডব্রেক আইডিগুলোর ক্ষেত্রে নিম্নলিখিত বিধিনিষেধগুলো প্রযোজ্য:
|
auth-token | প্রয়োজনীয় | string
|
timeout | ঐচ্ছিক | integerবিজ্ঞাপনের সিদ্ধান্ত নেওয়ার জন্য অপেক্ষা করতে DAI এই অনুরোধটিকে যত মিলিসেকেন্ড পর্যন্ত ব্লক করতে পারে, সেই সংখ্যা। যে অনুরোধগুলিতে প্রথম অনুরোধেই বিজ্ঞাপন দেখানো আবশ্যক, যেমন প্রি-রোল অ্যাড ব্রেক, সেগুলিতে এই প্যারামিটারটি ব্যবহার করুন। নির্ধারিত সময়সীমা অতিক্রম করলে, অনুরোধটির অবস্থা 'পেন্ডিং' হিসেবে প্রদর্শিত হয়। অন্তর্ভুক্ত করা হলে, টাইমআউট মান অবশ্যই ১০০০ থেকে ১৫০০০ মিলিসেকেন্ডের মধ্যে হতে হবে। এটি বাদ দেওয়া হলে, বিজ্ঞাপনের সিদ্ধান্ত নেওয়ার জন্য অপেক্ষা করে প্রতিক্রিয়ায় কোনো বিলম্ব হয় না। |
final | ঐচ্ছিক | boolean DAI-কে এটা বোঝাতে যে এই অ্যাড পডের জন্য VTP আর কোনো অনুরোধ করতে ইচ্ছুক নয়, এটিকে ' ডিফল্টরূপে |
বিজ্ঞাপন সিদ্ধান্ত গ্রহণের পরামিতি | ||
pd | ঐচ্ছিক | integerবিজ্ঞাপন বিরতির সময়কাল (মিলিসেকেন্ডে)। একে অ্যাড পড ডিউরেশনও বলা হয়। যদি EABN ব্যবহার করা হয়, তাহলে pd ভ্যালুটি আপনার বিজ্ঞাপন বিরতির নোটিফিকেশনে দেওয়া সময়কালের সাথে অবশ্যই মিলতে হবে। যদি সময়কালগুলো না মেলে, তাহলে EABN ভ্যালুটি অগ্রাধিকার পাবে। |
cust_params | ঐচ্ছিক | stringঅ্যাড ম্যানেজার হেল্প সেন্টারে বর্ণিত অ্যাড ব্রেক টার্গেটিং-এর জন্য কাস্টম প্যারামিটার। |
scte35 | ঐচ্ছিক | stringএকটি বেস৬৪-এনকোডেড SCTE-35 সংকেত। যদি সিগন্যালটি অবৈধ হয়, তাহলে রেসপন্সের |
প্রতিক্রিয়া সংস্থা
সফল হলে, রেসপন্স বডিতে একটি নতুন AdPodTimingMetadataResponse অবজেক্ট থাকে।
পদ্ধতি: মিডিয়া যাচাইকরণ
প্লেব্যাকের সময় কোনো বিজ্ঞাপন মিডিয়া আইডেন্টিফায়ার পেলে, উপরে উল্লিখিত স্ট্রিম এন্ডপয়েন্ট থেকে প্রাপ্ত media_verification_url ব্যবহার করে অবিলম্বে একটি অনুরোধ করুন। সার্ভার-সাইড-বিকনিং স্ট্রিমের জন্য এই অনুরোধগুলির প্রয়োজন নেই, যেখানে সার্ভার নিজেই মিডিয়া যাচাইকরণ শুরু করে।
media verification এন্ডপয়েন্টে করা অনুরোধগুলো আইডম্পোটেন্ট।
| পদ্ধতি | |
|---|---|
media verification | GET /{media_verification_url}/{ad_media_id}মিডিয়া যাচাইকরণ ইভেন্ট সম্পর্কে এপিআই-কে অবহিত করে। |
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 ট্রান্সপোর্ট স্ট্রিমের জন্য টাইমড মেটাডেটা, অথবা mp4 ফাইলের জন্য emsg। বিজ্ঞাপন মিডিয়া আইডেন্টিফায়ারগুলো সর্বদা google_ স্ট্রিং দিয়ে শুরু হবে।
প্রতিটি বিজ্ঞাপন যাচাইয়ের অনুরোধ করার আগে মেটাডেটা এন্ট্রির সম্পূর্ণ পাঠ্য বিষয়বস্তু বিজ্ঞাপন যাচাই URL-এর সাথে যুক্ত করতে হবে।
পদ্ধতি: মেটাডেটা
metadata_url এ থাকা মেটাডেটা এন্ডপয়েন্টটি বিজ্ঞাপনের UI তৈরি করতে ব্যবহৃত তথ্য ফেরত দেয়। সার্ভার-সাইড-বিকনিং স্ট্রিমের জন্য মেটাডেটা এন্ডপয়েন্টটি উপলব্ধ নয়, যেখানে বিজ্ঞাপন মিডিয়া যাচাইকরণ শুরু করার দায়িত্ব সার্ভারের থাকে।
| পদ্ধতি | |
|---|---|
metadata | GET /{metadata_url}/{ad-media-id}GET /{metadata_url}বিজ্ঞাপনের মেটাডেটা তথ্য পুনরুদ্ধার করে। |
HTTP অনুরোধ
GET https://{metadata_url}/{ad-media-id}
GET https://{metadata_url}
কোয়েরি প্যারামিটার
| প্যারামিটার | ||
|---|---|---|
delta_token | ঐচ্ছিক | string একটি অস্বচ্ছ টোকেন যা ক্লায়েন্টের বর্তমান সিঙ্ক্রোনাইজেশন অবস্থা নির্দেশ করে। এটি প্রদান করা হলে, সার্ভার প্রতিক্রিয়ায় একটি নতুন |
প্রতিক্রিয়া সংস্থা
সফল হলে, প্রতিক্রিয়াটি PodMetadata এর একটি ইনস্ট্যান্স ফেরত দেয়।
মেটাডেটা পার্সিং
মেটাডেটার তিনটি স্বতন্ত্র বিভাগ রয়েছে: tags , ads এবং বিজ্ঞাপন breaks । ডেটাতে প্রবেশের পথ হলো tags বিভাগ। সেখান থেকে, ট্যাগগুলোর মধ্যে দিয়ে যান এবং প্রথম সেই এন্ট্রিটি খুঁজুন যার নামটি ভিডিও স্ট্রিমে পাওয়া বিজ্ঞাপন মিডিয়া আইডির একটি প্রিফিক্স। উদাহরণস্বরূপ, আপনার কাছে এমন একটি বিজ্ঞাপন মিডিয়া আইডি থাকতে পারে:
google_1234567890
এরপর আপনি google_12345 নামের একটি ট্যাগ অবজেক্ট খুঁজে পাবেন। এক্ষেত্রে, এটি আপনার অ্যাড মিডিয়া আইডির সাথে মিলে যায়। সঠিক অ্যাড মিডিয়া প্রিফিক্স অবজেক্টটি খুঁজে পাওয়ার পর, আপনি অ্যাড আইডি, অ্যাড ব্রেক আইডি এবং ইভেন্ট টাইপ খুঁজে বের করতে পারবেন। এরপর ads অবজেক্টগুলোকে ইন্ডেক্স করার জন্য অ্যাড আইডি এবং breaks অবজেক্টগুলোকে ইন্ডেক্স করার জন্য অ্যাড ব্রেক আইডি ব্যবহার করা হয়।
এপিআই অবজেক্ট
স্ট্রিম
নতুন তৈরি করা স্ট্রিমের রিসোর্সসমূহের তালিকা JSON ফরম্যাটে রেন্ডার করতে Stream ব্যবহৃত হয়।| 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 | stringGAM স্ট্রিম শনাক্তকারী। |
media_verification_url | stringপ্লেব্যাক ইভেন্ট ট্র্যাক করার জন্য বেস এন্ডপয়েন্ট হিসেবে মিডিয়া ভেরিফিকেশন ইউআরএল ব্যবহার করা হয়। |
metadata_url | stringআসন্ন স্ট্রিম বিজ্ঞাপন ইভেন্ট সম্পর্কে পর্যায়ক্রমিক তথ্য জানতে পোল করার জন্য ব্যবহৃত মেটাডেটা ইউআরএল। |
session_update_url | stringএই স্ট্রিমের টার্গেটিং প্যারামিটারগুলো আপডেট করতে সেশনের আপডেট ইউআরএল ব্যবহার করা হয়। প্রাথমিক স্ট্রিম তৈরির অনুরোধের সময় টার্গেটিং প্যারামিটারগুলোর মূল মানগুলো সংগ্রহ করা হয়। |
heartbeat_url | stringসার্ভার সাইড বীকনিং স্ট্রিম সচল রাখার জন্য ব্যবহৃত হার্টবিট ইউআরএলটিকে প্রতি {PollingFrequency} সেকেন্ডে পিং করতে হবে। সার্ভার সাইড বীকনিং স্ট্রিমগুলোর জন্য এটি স্বয়ংক্রিয়ভাবে পূরণ করা হয়। |
polling_frequency | numbermetadata_url বা heartbeat_url অনুরোধ করার সময় পোলিং ফ্রিকোয়েন্সি, সেকেন্ডে। |
pod_manifest_url | stringপড ম্যানিফেস্ট ইউআরএল টেমপ্লেটটি একটি স্ট্রিমের পড ম্যানিফেস্ট পুনরুদ্ধার করার জন্য ইউআরএল তৈরি করতে ব্যবহৃত হয়, যা HLS-এর মাল্টিভেরিয়েন্ট প্লেলিস্টের ইউআরএল অথবা DASH-এর MPD-এর সাথে সঙ্গতিপূর্ণ। এটি POD_SERVING_MANIFEST ধরনের ডাইনামিক অ্যাড ইনসারশনের লাইভস্ট্রিম ইভেন্টগুলির জন্য পূরণ করা হয়। https://developers.google.com/ad-manager/api/reference/v202305/LiveStreamEventService.DynamicAdInsertionType |
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)],
"next_delta_token": string,
"obsolete_ad_break_ids": [],
} |
| ক্ষেত্র | |
|---|---|
tags | map[string, object(TagSegment)]ট্যাগ প্রিফিক্স দ্বারা সূচিত ট্যাগ সেগমেন্টগুলোর মানচিত্র। |
ads | map[string, object(Ad)]বিজ্ঞাপন আইডি দ্বারা সূচিবদ্ধ বিজ্ঞাপনগুলোর মানচিত্র। |
ad_breaks | map[string, object(AdBreak)]বিজ্ঞাপন বিরতি আইডি দ্বারা সূচিত বিজ্ঞাপন বিরতির মানচিত্র। |
next_delta_token | stringপরবর্তী পোলে ব্যবহারের জন্য ক্লায়েন্টের একটি অস্বচ্ছ টোকেন। |
obsolete_ad_break_ids | stringঅপ্রচলিত বিজ্ঞাপন বিরতি আইডিগুলোর একটি তালিকা, যেগুলো ক্লায়েন্টের ক্যাশ থেকে মুছে ফেলা উচিত। |
ট্যাগসেগমেন্ট
TagSegment-এ একটি বিজ্ঞাপন, তার বিজ্ঞাপন বিরতি এবং ইভেন্টের ধরণ উল্লেখ থাকে। type="progress" যুক্ত TagSegment-কে বিজ্ঞাপন মিডিয়া যাচাইকরণ এন্ডপয়েন্টে পিং করা উচিত নয়।| 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বিজ্ঞাপন বিরতিতে এই বিজ্ঞাপনটির অবস্থান, যা ১ থেকে শুরু হচ্ছে। |
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 | stringঐচ্ছিক ক্লিক ট্র্যাকিং ইউআরএল। |
verifications | [object(Verification)]ঐচ্ছিক ওপেন মেজারমেন্ট যাচাইকরণ এন্ট্রি, যা ক্রিয়েটিভ প্লেব্যাক যাচাই করার জন্য থার্ড-পার্টি মেজারমেন্ট কোড কার্যকর করতে প্রয়োজনীয় রিসোর্স এবং মেটাডেটার তালিকা প্রদান করে। |
slate | booleanঐচ্ছিক বুলিয়ান যা নির্দেশ করে যে বর্তমান এন্ট্রিটি স্লেট। |
icons | [object(Icon)]আইকনগুলির একটি তালিকা, খালি থাকলে বাদ দেওয়া হবে। |
wrappers | [object(Wrapper)]র্যাপারগুলির একটি তালিকা, যা খালি থাকলে বাদ দেওয়া হয়। |
universal_ad_id | object(UniversalAdID)ঐচ্ছিক সার্বজনীন বিজ্ঞাপন আইডি। |
extensions | stringVAST-এর অন্তর্গত সকল <Extension> নোডের ঐচ্ছিক তালিকা। |
companions | [object(Companion)]ঐচ্ছিক সহযোগী যা এই বিজ্ঞাপনের সাথে প্রদর্শিত হতে পারে। |
interactive_file | object(InteractiveFile)ঐচ্ছিক ইন্টারেক্টিভ ক্রিয়েটিভ (SIMID) যা বিজ্ঞাপন চলার সময় দেখানো হবে। |
পড টেমপ্লেট প্রতিক্রিয়া
PodTemplateResponse হলো সেই JSON পেলোড যা পড স্টিচিংয়ের জন্য একটি VTP-তে ফেরত পাঠানো হয়।| JSON উপস্থাপনা |
|---|
{
"dash_period_template": string,
"segment_duration_ms": int64,
} |
| ক্ষেত্র | |
|---|---|
dash_period_template | stringDashPeriodTemplate হলো পিরিয়ডের জন্য একটি এক্সএমএল টেমপ্লেট, যা স্টিচিং করার আগে উপযুক্ত ডেটা দিয়ে পূরণ করতে হবে। |
segment_duration_ms | int64SegmentDurationMS হলো পিরিয়ড সেগমেন্টগুলোর সময়কাল, যা মিলিসেকেন্ডে পরিমাপ করা হয়। |
AdpodTimingMetadataResponse
AdpodTimingMetadataResponse-এ অ্যাড পড সম্পর্কিত তথ্য এবং এর জন্য কীভাবে সেগমেন্ট ইউআরএল তৈরি করতে হয়, সেই বিবরণ থাকে।| 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)]অ্যাড সেগমেন্ট ইউআরএলগুলো কীভাবে রেন্ডার করতে হবে তা বর্ণনা করে এমন Ad অবজেক্টের অ্যারে, যার ইন্ডেক্স ০ থেকে শুরু হয়। |
slate | object(SlateRendering)স্লেট সেগমেন্ট ইউআরএলগুলো কীভাবে রেন্ডার করতে হয়, তার বর্ণনা। |
dash_representations | map[string, object(DASHRepresentation)]DASH ম্যানিফেস্টে রেন্ডার করার জন্য সেই অ্যাড পডের DASH রিপ্রেজেন্টেশনগুলোর তালিকা। |
dash_adaptation_sets | map[string, object(DASHAdaptationSet)]DASH ম্যানিফেস্টে রেন্ডার করার জন্য সেই ad pod-এর DASH অ্যাডাপটেশন সেটগুলির তালিকা। |
অ্যাডরেন্ডারিং
AdRendering বর্ণনা করে কীভাবে একটি সিদ্ধান্ত নেওয়া বিজ্ঞাপন রেন্ডার করতে হয়।| JSON উপস্থাপনা |
|---|
{ "duration_ms": number, "variants": map[string, object(VariantRendering)], } |
| ক্ষেত্র | |
|---|---|
duration_ms | numberবিজ্ঞাপনটির সময়কাল, মিলিসেকেন্ডে (পূর্ণসংখ্যা)। |
variants | map[string, object(VariantRendering)]UI থেকে কনফিগার করা ভ্যারিয়েন্ট/প্রোফাইল আইডি দ্বারা সূচিত ভ্যারিয়েন্ট অবজেক্টের অভিধান (নিচে দেখুন)। |
স্লেট রেন্ডারিং
স্লেট রেন্ডারিং বর্ণনা করে কীভাবে স্লেটের বিষয়বস্তু রেন্ডার করতে হয়।| JSON উপস্থাপনা |
|---|
{ "duration_ms": number, "variants": map[string, object(VariantRendering)], } |
| ক্ষেত্র | |
|---|---|
duration_ms | numberস্লেটের সময়কাল, মিলিসেকেন্ডে (পূর্ণসংখ্যা)। |
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। ফাইলের নামের এক্সটেনশনটি ইউআরএল সেগমেন্টের একটি অংশ। |
segment_durations | object(SegmentDurations)SegmentDurations অবজেক্ট। প্রতিটি সেগমেন্টের সময়কালকে একটি সেগমেন্ট URL-এ রূপান্তর করা যায়। |
সেগমেন্ট সময়কাল
SegmentDurations একটি নির্দিষ্ট সময় এককে, একাধিক সেগমেন্টের সময়কাল বর্ণনা করে।| JSON উপস্থাপনা |
|---|
{
"timescale": number,
"values": [],
} |
| ক্ষেত্র | |
|---|---|
timescale | numberটাইমস্কেল হলো প্রতি সেকেন্ডে এককের সংখ্যা (পূর্ণসংখ্যা)। প্রত্যাশিত মান: HLS-এর জন্য ১০০০ (মিলিসেকেন্ড), DASH ভিডিওর জন্য ৯০০০০ (PTS)। DASH অডিওর জন্য অডিও স্যাম্পল রেট। |
values | numberটাইমস্কেল এককে, পূর্ণসংখ্যায় প্রকাশিত সেগমেন্টের সময়কালের অ্যারে। |
ড্যাশরিপ্রেজেন্টেশন
DASHRepresentation, DASH ম্যানিফেস্টে রেন্ডার করার জন্য Representation নোডগুলোকে বর্ণনা করে।| 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, DASH ম্যানিফেস্টে রেন্ডার করার জন্য AdaptationSet নোডগুলোকে বর্ণনা করে।| 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মানটির স্কিম আইডি ইউআরআই। |
value | stringস্কিম আইডি ইউআরআই-এর মান। |
আইকন
আইকনটিতে একটি 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-তে একটি আইকনে ক্লিক করার তথ্য থাকে।| JSON উপস্থাপনা |
|---|
{
"url": string,
} |
| ক্ষেত্র | |
|---|---|
url | string |
ফলব্যাকইমেজ
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 |
মোড়ক
র্যাপারে একটি র্যাপার বিজ্ঞাপন সম্পর্কিত তথ্য থাকে। যদি ডিল আইডি না থাকে, তবে এটিতে তা অন্তর্ভুক্ত করা হয় না।| 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-এ জাভাস্ক্রিপ্টের মাধ্যমে যাচাইয়ের জন্য তথ্য থাকে।| JSON উপস্থাপনা |
|---|
{
"script_url": string,
"api_framework": string,
"browser_optional": boolean,
} |
| ক্ষেত্র | |
|---|---|
script_url | stringজাভাস্ক্রিপ্ট পেলোডের ইউআরআই। |
api_framework | stringAPIFramework হলো সেই ভিডিও ফ্রেমওয়ার্কটির নাম যা ভেরিফিকেশন কোডটি প্রয়োগ করে। |
browser_optional | booleanএই স্ক্রিপ্টটি ব্রাউজারের বাইরে চালানো যাবে কিনা। |
ট্র্যাকিংইভেন্ট
TrackingEvent-এ এমন URL-গুলো থাকে যেগুলো নির্দিষ্ট পরিস্থিতিতে ক্লায়েন্ট দ্বারা পিং করা উচিত।| JSON উপস্থাপনা |
|---|
{
"event": string,
"uri": string,
} |
| ক্ষেত্র | |
|---|---|
event | stringট্র্যাকিং ইভেন্টের ধরণ। |
uri | stringযে ট্র্যাকিং ইভেন্টটিকে পিং করা হবে। |
ইউনিভার্সাল অ্যাড আইডি
UniversalAdID একটি অনন্য ক্রিয়েটিভ আইডেন্টিফায়ার প্রদান করতে ব্যবহৃত হয়, যা বিভিন্ন অ্যাড সিস্টেম জুড়ে বজায় রাখা হয়।| JSON উপস্থাপনা |
|---|
{ "id_value": string, "id_registry": string, } |
| ক্ষেত্র | |
|---|---|
id_value | stringবিজ্ঞাপনের জন্য নির্বাচিত ক্রিয়েটিভের ইউনিভার্সাল অ্যাড আইডি। |
id_registry | stringরেজিস্ট্রি ওয়েবসাইটের URL শনাক্ত করার জন্য ব্যবহৃত একটি স্ট্রিং, যেখানে নির্বাচিত ক্রিয়েটিভের ইউনিভার্সাল অ্যাড আইডি তালিকাভুক্ত থাকে। |
সঙ্গী
কম্প্যানিয়নে সেইসব সহযোগী বিজ্ঞাপনের তথ্য থাকে যা মূল বিজ্ঞাপনের সাথে প্রদর্শিত হতে পারে।| 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 | stringVAST-এর <StaticResource> নোডে CreativeType অ্যাট্রিবিউটটি যুক্ত হবে, যদি এটি static টাইপের একটি সহযোগী নোড হয়। |
height | int32এই সঙ্গীর উচ্চতা পিক্সেলে। |
width | int32এই সঙ্গীর প্রস্থ (পিক্সেল এককে)। |
resource | stringস্ট্যাটিক এবং আইফ্রেম কম্প্যানিয়নের ক্ষেত্রে, এটি হবে সেই URL যা লোড এবং প্রদর্শন করা হবে। HTML কম্প্যানিয়নের ক্ষেত্রে, এটি হবে সেই HTML স্নিপেট যা কম্প্যানিয়ন হিসেবে দেখানো উচিত। |
type | stringএই কম্প্যানিয়নের ধরণ। এটি স্ট্যাটিক, আইফ্রেম বা এইচটিএমএল হতে পারে। |
ad_slot_id | stringএই সঙ্গীর জন্য স্লট আইডি। |
api_framework | stringএই সহায়কটির জন্য এপিআই ফ্রেমওয়ার্ক। |
tracking_events | [object(TrackingEvent)]এই সহচরের জন্য ট্র্যাকিং ইভেন্টগুলির তালিকা। |
ইন্টারেক্টিভফাইল
ইন্টারেক্টিভ ফাইলে ইন্টারেক্টিভ ক্রিয়েটিভের (যেমন SIMID) তথ্য থাকে, যা বিজ্ঞাপন চলার সময় প্রদর্শিত হওয়া উচিত।| JSON উপস্থাপনা |
|---|
{ "resource": string, "type": string, "variable_duration": boolean, "ad_parameters": string, } |
| ক্ষেত্র | |
|---|---|
resource | stringইন্টারেক্টিভ ক্রিয়েটিভটির ইউআরএল। |
type | stringরিসোর্স হিসেবে প্রদত্ত ফাইলটির MIME টাইপ। |
variable_duration | booleanএই সৃজনশীল ব্যক্তি সময়কাল বাড়ানোর জন্য অনুরোধ করতে পারেন কিনা। |
ad_parameters | stringVAST-এ থাকা <AdParameters> নোডের মান। |
ডাইনামিক অ্যাড ইনসারশন এপিআই আপনাকে ডিএআই লাইভস্ট্রিম অনুরোধ করতে এবং ট্র্যাক করতে দেয়।
পরিষেবা: dai.google.com
সমস্ত ইউআরআই 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প্রকাশকের গুগল অ্যাড ম্যানেজার নেটওয়ার্ক কোড। |
custom_asset_key | stringকাস্টম আইডেন্টিফায়ারটি গুগল অ্যাড ম্যানেজারে এই ইভেন্টটিকে যুক্ত করেছে। |
অনুরোধকারী শরীর
অনুরোধের বডিটি application/x-www-form-urlencoded ধরনের এবং এতে নিম্নলিখিত প্যারামিটারগুলো রয়েছে:
| প্যারামিটার | ||
|---|---|---|
| ডিএফপি টার্গেটিং প্যারামিটার | ঐচ্ছিক | অতিরিক্ত টার্গেটিং প্যারামিটার। |
| স্ট্রিম প্যারামিটার ওভাররাইড করুন | ঐচ্ছিক | স্ট্রিম তৈরির প্যারামিটারের ডিফল্ট মানগুলো পরিবর্তন করুন। |
| HMAC প্রমাণীকরণ | ঐচ্ছিক | HMAC-ভিত্তিক টোকেন ব্যবহার করে প্রমাণীকরণ করুন। |
প্রতিক্রিয়া সংস্থা
সফল হলে, রেসপন্স বডিতে একটি নতুন Stream অবজেক্ট থাকে।
উন্মুক্ত পরিমাপ
DAI API-এর 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প্রকাশকের গুগল অ্যাড ম্যানেজার নেটওয়ার্ক কোড। |
custom_asset_key | stringকাস্টম আইডেন্টিফায়ারটি গুগল অ্যাড ম্যানেজারে এই ইভেন্টটিকে যুক্ত করেছে। |
pod_identifier | নিম্নলিখিত ফরম্যাটগুলো সমর্থিত: pod/{integer} বর্তমান বিজ্ঞাপন বিরতির সাংখ্যিক শনাক্তকারী। প্রতিটি বিজ্ঞাপন বিরতি ইভেন্টের জন্য বিজ্ঞাপন পড আইডি ad_break_id/{string}বর্তমান বিজ্ঞাপন বিরতির স্ট্রিং শনাক্তকারী। ওই এন্ডপয়েন্টে কোনো অজানা বিজ্ঞাপন বিরতি আইডি প্রদান করা হলে লাইভস্ট্রিম ইভেন্টের জন্য একটি নতুন বিজ্ঞাপন বিরতি তৈরি হয়। কাস্টম অ্যাডব্রেক আইডিগুলোর ক্ষেত্রে নিম্নলিখিত বিধিনিষেধগুলো প্রযোজ্য:
|
profile_name | stringঅনুরোধকৃত গুগল অ্যাড ম্যানেজার DAI এনকোডিং প্রোফাইলের নাম । এনকোডিং প্রোফাইলটি অবশ্যই নির্বাচিত ইভেন্টের জন্য কনফিগার করা এনকোডিং প্রোফাইলগুলোর মধ্যে একটি হতে হবে। |
segment_number | integerবর্তমান অ্যাড পডের মধ্যে অনুরোধকৃত সেগমেন্টের সূচক, যা শূন্য থেকে শুরু হয়। |
segment_format | string অনুরোধকৃত সেগমেন্ট ফরম্যাটের সাথে সংশ্লিষ্ট ফাইল এক্সটেনশন। গ্রহণযোগ্য এক্সটেনশনগুলো হলো: |
কোয়েরি প্যারামিটার
| প্যারামিটার | ||||||
|---|---|---|---|---|---|---|
stream_id | প্রয়োজনীয় | string বর্তমান ব্যবহারকারীর সেশনের স্ট্রিম আইডি। | ||||
sd | required 1 | integerঅনুরোধকৃত অংশটির সময়কাল, মিলিসেকেন্ডে। | ||||
so | ঐচ্ছিক | অ্যাড পডের মধ্যে অনুরোধ করা সেগমেন্টের অফসেট, মিলিসেকেন্ডে। যদি আপনি ' | ||||
pd | প্রয়োজনীয় ২ | integerঅ্যাড পডটির স্থায়িত্বকাল, মিলিসেকেন্ডে। | ||||
auth-token | প্রয়োজনীয় | string
| ||||
last | ঐচ্ছিক | booleanবিজ্ঞাপন বিরতির শেষ অংশ নির্দেশ করে। অন্য সব অংশের জন্য এই প্যারামিটারটি বাদ দিন। | ||||
scte35 | ঐচ্ছিক | stringএই বিজ্ঞাপন বিরতির জন্য বেস৬৪-এনকোডেড SCTE-35 সংকেত। | ||||
cust_params | ঐচ্ছিক | stringঅ্যাড ম্যানেজার ক্যাম্পেইন টার্গেটিং-এর জন্য ব্যবহৃত কী-ভ্যালু পেয়ারের একটি সেট। এই পেয়ারগুলোকে অবশ্যই একটি ইউআরএল-এনকোডেড কোয়েরি স্ট্রিং হিসেবে উপস্থাপন করতে হবে। উদাহরণ:
| ||||
পাদটীকা
- প্রারম্ভিক পর্বের জন্য
sdপ্রয়োজন নেই। ↩ - যেসব ইভেন্টে অনির্দিষ্টকালের বিজ্ঞাপন বিরতি চালু আছে, সেগুলোর জন্য
pdপ্রয়োজন নেই। ↩
উদাহরণ
GET 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-99d7-860aa4a674cb:TEST
GET https://dai.google.com/linear/pods/v1/seg/network/sandbox_dev/custom_asset/podserving-segredirect-custom-key/pod/2/profile/8b8888cf79ad43f0800482ffc035a1ac_ts_a/1.ts?so=0&sd=10000&pd=30000&stream_id=8e19cbc6-850b-404c-99d7-860aa4a674cb:TEST
প্রতিক্রিয়া সংস্থা
সফল হলে, রেসপন্স বডিটি হবে অনুরোধে নির্দিষ্ট করা ফরম্যাট ও প্যারামিটারের সাথে মিলে যাওয়া একটি প্লেয়েবল স্ট্রিম সেগমেন্ট।
পদ্ধতি: এইচএলএস পড ম্যানিফেস্ট
একটি লাইভস্ট্রিমের HLS অ্যাড পড ম্যানিফেস্ট পুনরুদ্ধার করে, যা ক্লায়েন্ট ভিডিও প্লেয়ারের লোড ও প্লে করার জন্য প্রস্তুত থাকে।
| পদ্ধতি | |
|---|---|
GET | GET /linear/pods/v1/hls/network/{network_code}/custom_asset/{custom_asset}/{pod_identifier}.m3u8;একটি অ্যাড পডের জন্য HLS মাল্টিভেরিয়েন্ট প্লেলিস্ট পুনরুদ্ধার করার API। |
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প্রকাশকের গুগল অ্যাড ম্যানেজার নেটওয়ার্ক কোড। |
custom_asset_key | stringকাস্টম আইডেন্টিফায়ারটি গুগল অ্যাড ম্যানেজারে এই ইভেন্টটিকে যুক্ত করেছে। |
pod_identifier | নিম্নলিখিত ফরম্যাটগুলো সমর্থিত: pod/{integer} বর্তমান বিজ্ঞাপন বিরতির সাংখ্যিক শনাক্তকারী। প্রতিটি বিজ্ঞাপন বিরতি ইভেন্টের জন্য বিজ্ঞাপন পড আইডি ad_break_id/{string}বর্তমান বিজ্ঞাপন বিরতির স্ট্রিং শনাক্তকারী। ওই এন্ডপয়েন্টে কোনো অজানা বিজ্ঞাপন বিরতি আইডি প্রদান করা হলে লাইভস্ট্রিম ইভেন্টের জন্য একটি নতুন বিজ্ঞাপন বিরতি তৈরি হয়। কাস্টম অ্যাডব্রেক আইডিগুলোর ক্ষেত্রে নিম্নলিখিত বিধিনিষেধগুলো প্রযোজ্য:
|
কোয়েরি প্যারামিটার
| প্যারামিটার | ||||||
|---|---|---|---|---|---|---|
stream_id | প্রয়োজনীয় | string বর্তমান ব্যবহারকারীর সেশনের স্ট্রিম আইডি। | ||||
pd | প্রয়োজনীয় | integerঅ্যাড পডটির স্থায়িত্বকাল, মিলিসেকেন্ডে। | ||||
scte35 | ঐচ্ছিক | stringএই বিজ্ঞাপন বিরতির জন্য বেস৬৪-এনকোডেড SCTE-35 সংকেত। | ||||
cust_params | ঐচ্ছিক | stringঅ্যাড ম্যানেজার ক্যাম্পেইন টার্গেটিং-এর জন্য ব্যবহৃত কী-ভ্যালু পেয়ারের একটি সেট। এই পেয়ারগুলোকে অবশ্যই একটি ইউআরএল-এনকোডেড কোয়েরি স্ট্রিং হিসেবে উপস্থাপন করতে হবে। উদাহরণ:
| ||||
auth-token | প্রয়োজনীয় | string
| ||||
প্রতিক্রিয়া সংস্থা
সফল হলে, প্রতিক্রিয়া বডিটি একটি HLS মাল্টিভেরিয়েন্ট প্লেলিস্ট হয়।
পদ্ধতি: ড্যাশ পড ম্যানিফেস্ট
একটি লাইভস্ট্রিমের MPEG-DASH অ্যাড পড ম্যানিফেস্ট পুনরুদ্ধার করে, যা ক্লায়েন্ট ভিডিও প্লেয়ারের লোড ও প্লে করার জন্য প্রস্তুত থাকে।
| পদ্ধতি | |
|---|---|
GET | GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset}/stream/{stream_id}/{pod_identifier}/manifest.mpdএকটি অ্যাড পডের জন্য এমপেগ-ড্যাশ এমপিডি প্লেলিস্ট পুনরুদ্ধার করার এপিআই। |
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প্রকাশকের গুগল অ্যাড ম্যানেজার নেটওয়ার্ক কোড। |
custom_asset_key | stringকাস্টম আইডেন্টিফায়ারটি গুগল অ্যাড ম্যানেজারে এই ইভেন্টটিকে যুক্ত করেছে। |
stream_id | string বর্তমান ব্যবহারকারীর সেশনের স্ট্রিম আইডি। |
pod_identifier | নিম্নলিখিত ফরম্যাটগুলো সমর্থিত: pod/{integer} বর্তমান বিজ্ঞাপন বিরতির সাংখ্যিক শনাক্তকারী। প্রতিটি বিজ্ঞাপন বিরতি ইভেন্টের জন্য বিজ্ঞাপন পড আইডি ad_break_id/{string}বর্তমান বিজ্ঞাপন বিরতির স্ট্রিং শনাক্তকারী। ওই এন্ডপয়েন্টে কোনো অজানা বিজ্ঞাপন বিরতি আইডি প্রদান করা হলে লাইভস্ট্রিম ইভেন্টের জন্য একটি নতুন বিজ্ঞাপন বিরতি তৈরি হয়। কাস্টম অ্যাডব্রেক আইডিগুলোর ক্ষেত্রে নিম্নলিখিত বিধিনিষেধগুলো প্রযোজ্য:
|
কোয়েরি প্যারামিটার
| প্যারামিটার | ||||||
|---|---|---|---|---|---|---|
pd | প্রয়োজনীয় | integerঅ্যাড পডটির স্থায়িত্বকাল, মিলিসেকেন্ডে। | ||||
scte35 | ঐচ্ছিক | stringএই বিজ্ঞাপন বিরতির জন্য বেস৬৪-এনকোডেড SCTE-35 সংকেত। | ||||
cust_params | ঐচ্ছিক | stringঅ্যাড ম্যানেজার ক্যাম্পেইন টার্গেটিং-এর জন্য ব্যবহৃত কী-ভ্যালু পেয়ারের একটি সেট। এই পেয়ারগুলোকে অবশ্যই একটি ইউআরএল-এনকোডেড কোয়েরি স্ট্রিং হিসেবে উপস্থাপন করতে হবে। উদাহরণ:
| ||||
auth-token | প্রয়োজনীয় | string
| ||||
প্রতিক্রিয়া সংস্থা
সফল হলে, প্রতিক্রিয়া অংশটি একটি MPEG-DASH mpd প্লেলিস্ট হয়।
পদ্ধতি: ড্যাশ পড পিরিয়ড টেমপ্লেট
| পদ্ধতি | |
|---|---|
pods | GET /linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.jsonগুগল অ্যাড ম্যানেজার থেকে একটি ড্যাশ পিরিয়ড টেমপ্লেটের জন্য অনুরোধ করা হয়। এই টেমপ্লেটটিতে ম্যাক্রো থাকে, যা আপনাকে আপনার স্ট্রিম প্যারামিটার দিয়ে পূরণ করতে হবে। এই ম্যাক্রোগুলো পূরণ করা হয়ে গেলে, টেমপ্লেটটি আপনার বিজ্ঞাপন বিরতির সময়কাল হয়ে যায় এবং এটিকে আপনার ড্যাশ ম্যানিফেস্টের সাথে যুক্ত করা যায়। |
HTTP অনুরোধ
GET https://dai.google.com/linear/pods/v1/dash/network/{network_code}/custom_asset/{custom_asset_key}/pods.json
পথের পরামিতি
| প্যারামিটার | |
|---|---|
network_code | stringপ্রকাশকের গুগল অ্যাড ম্যানেজার নেটওয়ার্ক কোড। |
custom_asset_key | stringকাস্টম আইডেন্টিফায়ারটি গুগল অ্যাড ম্যানেজারে এই ইভেন্টটিকে যুক্ত করেছে। |
কোয়েরি প্যারামিটার
| প্যারামিটার | ||
|---|---|---|
stream_id | প্রয়োজনীয় | string বর্তমান ব্যবহারকারীর সেশনের স্ট্রিম আইডি। |
tv | ঐচ্ছিক | integer টেমপ্লেট সংস্করণ। ডিফল্ট মান
|
প্রতিক্রিয়া সংস্থা
সফল হলে, রেসপন্স বডিতে একটি নতুন 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প্রকাশকের গুগল অ্যাড ম্যানেজার নেটওয়ার্ক কোড। |
custom_asset_key | stringগুগল অ্যাড ম্যানেজারে এই লাইভস্ট্রিমের সাথে যুক্ত কাস্টম আইডেন্টিফায়ার। |
কোয়েরি প্যারামিটার
| প্যারামিটার | ||
|---|---|---|
stream_id | প্রয়োজনীয় | stringক্লায়েন্ট ভিডিও প্লেয়ার অ্যাপ থেকে প্রাপ্ত অ্যাড ম্যানেজার স্ট্রিম আইডি। |
ad_break_id | প্রয়োজনীয় | stringপরবর্তী আসন্ন বিজ্ঞাপন বিরতির আইডি। অ্যাড ব্রেক আইডিগুলো স্টিচিং সার্ভার বা VTP দ্বারা সরবরাহ করা হয় এবং একই অ্যাড ব্রেকের জন্য আর্লি অ্যাড ব্রেক নোটিফিকেশন, অ্যাড পড টাইমিং মেটাডেটা রিকোয়েস্ট এবং সেগমেন্ট রিডাইরেক্ট রিকোয়েস্ট জুড়ে এগুলো অবশ্যই মিলতে হবে। কাস্টম অ্যাডব্রেক আইডিগুলোর ক্ষেত্রে নিম্নলিখিত বিধিনিষেধগুলো প্রযোজ্য:
|
auth-token | প্রয়োজনীয় | string The
|
timeout | ঐচ্ছিক | integerThe number of milliseconds that DAI can block this request to wait for ad decisioning. Use this parameter on requests that must return populated ads on the first request, such as pre-roll ad breaks. If timeout is exceeded, the request returns a status of pending. If included, the timeout value must be between 1000 and 15000 milliseconds. If omitted, responses are not delayed to wait for ad decisioning. |
final | ঐচ্ছিক | boolean Set to Defaults to |
Ad decisioning parameters | ||
pd | ঐচ্ছিক | integerThe duration of the ad break (in milliseconds). Also referred to as ad pod duration. If EABN is used, the pd value must match the duration provided in your ad break notification. If the durations don't match, the EABN value will be given priority. |
cust_params | ঐচ্ছিক | stringCustom parameters for ad break targeting, as described in the Ad Manager Help Center . |
scte35 | ঐচ্ছিক | stringA base64-encoded SCTE-35 signal. If the signal is invalid, a message will be sent in the |
প্রতিক্রিয়া সংস্থা
If successful, the response body contains a new AdPodTimingMetadataResponse object.
Method: media verification
After encountering an ad media identifier during playback, immediately make a request using the media_verification_url obtained from the stream endpoint, above. These requests aren't necessary for server-side-beaconing streams, where the server initiates media verification.
Requests to the media verification endpoint are idempotent.
| পদ্ধতি | |
|---|---|
media verification | GET /{media_verification_url}/{ad_media_id}Notifies the API of a media verification event. |
HTTP অনুরোধ
GET https://{media-verification-url}/{ad-media-id}
প্রতিক্রিয়া সংস্থা
media verification returns the following responses:
-
HTTP/1.1 204 No Contentif media verification succeeds and all pings are sent. -
HTTP/1.1 404 Not Foundif the request can't verify the media due to incorrect URL formatting or expiration. -
HTTP/1.1 404 Not Foundif a previous verification request for this ID succeeded. -
HTTP/1.1 409 Conflictif another request is already sending pings at this time.
Ad media IDs
Ad media identifiers will be encoded in a separate metadata track — timed metadata for HLS transport stream, or emsg for mp4 files. Ad media identifiers will always begin with the string google_ .
The entire text contents of the metadata entry should be appended to the ad verification URL prior to making each ad verification request.
Method: metadata
The metadata endpoint at metadata_url returns information used to build an ad UI. The metadata endpoint isn't available for server-side-beaconing streams, where the server is responsible for initiating ad media verification.
| পদ্ধতি | |
|---|---|
metadata | GET /{metadata_url}/{ad-media-id}GET /{metadata_url}Retrieves ad metadata information. |
HTTP অনুরোধ
GET https://{metadata_url}/{ad-media-id}
GET https://{metadata_url}
কোয়েরি প্যারামিটার
| প্যারামিটার | ||
|---|---|---|
delta_token | ঐচ্ছিক | string An opaque token representing the client's current synchronization state. If provided, the server returns only the metadata that has changed since the token was generated, along with a new |
প্রতিক্রিয়া সংস্থা
If successful, the response returns an instance of PodMetadata .
Parsing Metadata
Metadata has three discrete sections: tags , ads , and ad breaks . The entry point into the data is the tags section. From there, iterate through the tags and find the first entry whose name is a prefix for the ad media ID found in the video stream. For example, you might have an ad media ID that looks like:
google_1234567890
Then you find a tag object named google_12345 . In this case, it matches your ad media id. Once you find the correct ad media prefix object, you can look up ad ids, ad break ids, and the event type. Ad ids are then used to index the ads objects and ad break ids are used to index the breaks objects.
API Objects
স্ট্রিম
Stream is used to render a list of resources for a newly created stream in JSON format.| 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 | stringThe GAM stream identifier. |
media_verification_url | stringThe media verification URL used as base endpoint for tracking playback events. |
metadata_url | stringMetadata URL used to poll for periodic information about upcoming stream ad events. |
session_update_url | stringThe session's update URL used to update the targeting parameters for this stream. The original values for the targeting parameters are captured during the initial stream create request. |
heartbeat_url | stringThe heartbeat URL, used to keep the server side beaconing stream alive, it must be pinged every {PollingFrequency} seconds. Populated for server side beaconing streams. |
polling_frequency | numberThe polling frequency, in seconds, when requesting metadata_url or heartbeat_url. |
pod_manifest_url | stringThe pod manifest URL template is used to generate the URL to retrieve a stream's pod manifest, corresponding to the URL of the multivariant playlist in HLS or the MPD in DASH. Populated for Livestream events of Dynamic Ad Insertion type POD_SERVING_MANIFEST. https://developers.google.com/ad-manager/api/reference/v202305/LiveStreamEventService.DynamicAdInsertionType |
manifest_format | stringManifest format is the format of the manifest retrieved from pod_manifest_url, either dash or hls. |
PodMetadata
PodMetadata contains metadata information on ads, ad breaks, and media ID tags.| JSON উপস্থাপনা |
|---|
{
"tags": map[string, object(TagSegment)],
"ads": map[string, object(Ad)],
"ad_breaks": map[string, object(AdBreak)],
"next_delta_token": string,
"obsolete_ad_break_ids": [],
} |
| ক্ষেত্র | |
|---|---|
tags | map[string, object(TagSegment)]Map of tag segments indexed by tag prefix. |
ads | map[string, object(Ad)]Map of ads indexed by ad ID. |
ad_breaks | map[string, object(AdBreak)]Map of ad breaks indexed by ad break ID. |
next_delta_token | stringAn opaque token for the client to use on the next poll. |
obsolete_ad_break_ids | stringA list of ad break IDs that are obsolete and should be removed from the client's cache. |
TagSegment
TagSegment contains a reference to an ad, its ad break, and event type. TagSegment with type="progress" should not be pinged to the ad media verification endpoint.| JSON উপস্থাপনা |
|---|
{ "ad": string, "ad_break_id": string, "type": string, } |
| ক্ষেত্র | |
|---|---|
ad | stringThe ID of this tag's ad. |
ad_break_id | stringThe ID of this tag's ad break. |
type | stringThis tag's event type. |
AdBreak
AdBreak describes a single ad break in the stream. It contains a duration, a type (mid/pre/post) and the number of ads.| JSON উপস্থাপনা |
|---|
{ "type": string, "duration": number, "expected_duration": number, "ads": number, } |
| ক্ষেত্র | |
|---|---|
type | stringValid break types are: pre, mid, and post. |
duration | numberTotal ad duration for this ad break, in seconds. |
expected_duration | numberExpected duration of the ad break (in seconds), including all ads and any slate. |
ads | numberNumber of ads in the ad break. |
বিজ্ঞাপন
Ad describes an ad in the stream.| 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 | stringThe ID of this ad's ad break. |
position | numberPosition of this ad in the ad break, starting at 1. |
duration | numberDuration of the ad, in seconds. |
title | stringOptional title of the ad. |
description | stringOptional description of the ad. |
advertiser | stringOptional advertiser identifier. |
ad_system | stringOptional ad system. |
ad_id | stringOptional ad ID. |
creative_id | stringOptional creative ID. |
creative_ad_id | stringOptional creative ad ID. |
deal_id | stringOptional deal ID. |
clickthrough_url | stringOptional clickthrough URL. |
click_tracking_urls | stringOptional click tracking URLs. |
verifications | [object(Verification)]Optional Open Measurement verification entries which list the resources and metadata required to execute third-party measurement code to verify creative playback. |
slate | booleanOptional bool indicating the current entry is slate. |
icons | [object(Icon)]A list of icons, omitted if empty. |
wrappers | [object(Wrapper)]A list of Wrappers, omitted if empty. |
universal_ad_id | object(UniversalAdID)Optional universal ad ID. |
extensions | stringOptional list of all <Extension> nodes in the VAST. |
companions | [object(Companion)]Optional companions that may be displayed along with this ad. |
interactive_file | object(InteractiveFile)Optional interactive creative (SIMID) that should be displayed during ad playback. |
PodTemplateResponse
PodTemplateResponse represents the JSON payload returned to a VTP for pod stitching.| JSON উপস্থাপনা |
|---|
{
"dash_period_template": string,
"segment_duration_ms": int64,
} |
| ক্ষেত্র | |
|---|---|
dash_period_template | stringDashPeriodTemplate is the xml template for the period to be filled with appropriate data before stitching. |
segment_duration_ms | int64SegmentDurationMS is the duration of the period segments in milliseconds. |
AdpodTimingMetadataResponse
AdpodTimingMetadataResponse contains information about the Ad Pod and how to build segment URLs for it.| JSON উপস্থাপনা |
|---|
{
"status": string,
"ads": [object(AdRendering)],
"slate": object(SlateRendering),
"dash_representations": map[string, object(DASHRepresentation)],
"dash_adaptation_sets": map[string, object(DASHAdaptationSet)],
} |
| ক্ষেত্র | |
|---|---|
status | stringDecision status for the ad pod. |
ads | [object(AdRendering)]Array of Ad objects describing how to render the ad segment urls, indexed starting at 0. |
slate | object(SlateRendering)Slate describing how to render the slate segment urls. |
dash_representations | map[string, object(DASHRepresentation)]List of DASH Representations for that ad pod to be rendered in DASH manifests. |
dash_adaptation_sets | map[string, object(DASHAdaptationSet)]List of DASH Adaptation Sets for that ad pod to be rendered in DASH manifests. |
AdRendering
AdRendering describes how to render a decisioned ad.| JSON উপস্থাপনা |
|---|
{ "duration_ms": number, "variants": map[string, object(VariantRendering)], } |
| ক্ষেত্র | |
|---|---|
duration_ms | numberDuration of the ad, in milliseconds (int). |
variants | map[string, object(VariantRendering)]Dictionary of Variant objects (see below), indexed by the variant/profile ID, as configured from the UI. |
SlateRendering
SlateRendering describes how to render slate content.| JSON উপস্থাপনা |
|---|
{ "duration_ms": number, "variants": map[string, object(VariantRendering)], } |
| ক্ষেত্র | |
|---|---|
duration_ms | numberDuration of the slate, in milliseconds (int). |
variants | map[string, object(VariantRendering)]Dictionary of Variant objects, indexed by variant/profile ID. Slate durations must be looped until the required slate length is reached, inserting HLS discontinuities between iterations, or looping new periods for MPEG-DASH. |
VariantRendering
VariantRendering describes one variant/profile within the ad/slate.| JSON উপস্থাপনা |
|---|
{
"segment_extension": string,
"segment_durations": object(SegmentDurations),
} |
| ক্ষেত্র | |
|---|---|
segment_extension | stringString, one of: ts, mp4, aac, ac3, ec3, m4a, m4v. Filename extension part of the segment URLs. |
segment_durations | object(SegmentDurations)SegmentDurations objects. Each segment duration can be translated into a segment URL. |
SegmentDurations
SegmentDurations describes the duration of a sequence of segments, in a specified time unit.| JSON উপস্থাপনা |
|---|
{
"timescale": number,
"values": [],
} |
| ক্ষেত্র | |
|---|---|
timescale | numberTimescale is the number of units per second (int) Expected to be: 1000 for HLS (milliseconds) 90000 for DASH video (PTS) Audio sample rate for DASH audio. |
values | numberArray of int segment durations, in timescale units. |
DASHRepresentation
DASHRepresentation describes Representation nodes to be rendered in DASH manifests.| JSON উপস্থাপনা |
|---|
{
"codecs": string,
"bandwidth": number,
"width": number,
"height": number,
"frame_rate": string,
"audio_sampling_rate": number,
"audio_channel_config": object(SchemeIDURIAndValue),
} |
| ক্ষেত্র | |
|---|---|
codecs | stringCodecs of the representation. |
bandwidth | numberBandwidth of the representation. |
width | numberWidth of the representation. |
height | numberHeight of the representation. |
frame_rate | stringFrame rate of the representation. |
audio_sampling_rate | numberAudio sampling rate of the representation. |
audio_channel_config | object(SchemeIDURIAndValue)Audio channel configuration of the representation. |
DASHAdaptationSet
DASHAdaptationSet describes AdaptationSet nodes to be rendered in DASH manifests.| 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 | stringContent type of the adaptation set. |
mime_type | stringMIME type of the adaptation set. |
role | object(SchemeIDURIAndValue)Role of the adaptation set. |
inband_event_stream | object(SchemeIDURIAndValue)Inband event stream of the adaptation set. |
min_frame_rate | stringMinimum frame rate of the adaptation set. |
max_frame_rate | stringMaximum frame rate of the adaptation set. |
scan_type | stringScan type of the adaptation set. |
start_with_sap | stringStart with SAP of the adaptation set. |
segment_alignment | booleanSegment alignment of the adaptation set. |
representations | stringRepresentations of the adaptation set. |
SchemeIDURIAndValue
SchemeIDURIAndValue is a pair of a scheme ID and its value.| JSON উপস্থাপনা |
|---|
{
"scheme_id_uri": string,
"value": string,
} |
| ক্ষেত্র | |
|---|---|
scheme_id_uri | stringScheme ID URI of the value. |
value | stringValue of the scheme ID URI. |
আইকন
Icon contains information about a VAST Icon.| 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 contains information about an icon clickthrough.| JSON উপস্থাপনা |
|---|
{
"url": string,
} |
| ক্ষেত্র | |
|---|---|
url | string |
FallbackImage
FallbackImage contains information about a VAST fallback image.| 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 contains information about a wrapper ad. It does not include a Deal ID if it does not exist.| JSON উপস্থাপনা |
|---|
{
"system": string,
"ad_id": string,
"creative_id": string,
"creative_ad_id": string,
"deal_id": string,
} |
| ক্ষেত্র | |
|---|---|
system | stringAd system identifier. |
ad_id | stringAd ID used for the wrapper ad. |
creative_id | stringCreative ID used for the wrapper ad. |
creative_ad_id | stringCreative Ad ID used for the wrapper ad. |
deal_id | stringOptional deal ID for the wrapper ad. |
যাচাইকরণ
Verification contains information for Open Measurement, which facilitates third-party viewability and verification measurement. Currently, only JavaScript resources are supported. See https://iabtechlab.com/standards/open-measurement-sdk/| JSON উপস্থাপনা |
|---|
{
"vendor": string,
"java_script_resources": [object(JavaScriptResource)],
"tracking_events": [object(TrackingEvent)],
"parameters": string,
} |
| ক্ষেত্র | |
|---|---|
vendor | stringThe verification vendor. |
java_script_resources | [object(JavaScriptResource)]List of JavaScript resources for the verification. |
tracking_events | [object(TrackingEvent)]List of tracking events for the verification. |
parameters | stringAn opaque string passed to bootstrap verification code. |
JavaScriptResource
JavaScriptResource contains information for verification via JavaScript.| JSON উপস্থাপনা |
|---|
{
"script_url": string,
"api_framework": string,
"browser_optional": boolean,
} |
| ক্ষেত্র | |
|---|---|
script_url | stringURI to javascript payload. |
api_framework | stringAPIFramework is the name of the video framework exercising the verification code. |
browser_optional | booleanWhether this script can be run outside of a browser. |
TrackingEvent
TrackingEvent contains URLs that should be pinged by the client in certain situations.| JSON উপস্থাপনা |
|---|
{
"event": string,
"uri": string,
} |
| ক্ষেত্র | |
|---|---|
event | stringThe type of the tracking event. |
uri | stringThe tracking event to be pinged. |
UniversalAdID
UniversalAdID is used to provide a unique creative identifier that is maintained across ad systems.| JSON উপস্থাপনা |
|---|
{ "id_value": string, "id_registry": string, } |
| ক্ষেত্র | |
|---|---|
id_value | stringThe Universal Ad ID of the selected creative for the ad. |
id_registry | stringA string used to identify the URL for the registry website where the selected creative's Universal Ad ID is cataloged. |
সঙ্গী
Companion contains information for companion ads that may be displayed along with 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)The click data for this companion. |
creative_type | stringThe CreativeType attribute on the <StaticResource> node in the VAST if this is a companion of type static. |
height | int32The height in pixels of this companion. |
width | int32The width in pixels of this companion. |
resource | stringFor static and iframe companions this will be the URL to be loaded and displayed. For HTML companions, this will be the HTML snippet that should be shown as the companion. |
type | stringType of this companion. It can be either static, iframe or HTML. |
ad_slot_id | stringThe slot ID for this companion. |
api_framework | stringThe API framework for this companion. |
tracking_events | [object(TrackingEvent)]List of tracking events for this companion. |
InteractiveFile
InteractiveFile contains information for interactive creative (ie SIMID) that should be displayed during ad playback.| JSON উপস্থাপনা |
|---|
{ "resource": string, "type": string, "variable_duration": boolean, "ad_parameters": string, } |
| ক্ষেত্র | |
|---|---|
resource | stringThe URL to the interactive creative. |
type | stringThe MIME type of the file provided as the resource. |
variable_duration | booleanWhether this creative may ask for the duration to be extended. |
ad_parameters | stringThe value of the <AdParameters> node in the VAST. |