REST Resource: advertisers.insertionOrders

রিসোর্স: ইনসারশনঅর্ডার

একটিমাত্র সন্নিবেশ ক্রম।

JSON উপস্থাপনা 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "displayName": string,
  "insertionOrderType": enum (InsertionOrderType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "kpi": {
    object (Kpi)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "optimizationObjective": enum (OptimizationObjective)
}
ক্ষেত্র
name

string

শুধুমাত্র আউটপুট। সন্নিবেশ ক্রমের রিসোর্স নাম।

advertiserId

string ( int64 format)

শুধুমাত্র আউটপুট। যে বিজ্ঞাপনদাতার ইনসারশন অর্ডারটি রয়েছে, তার অনন্য আইডি।

campaignId

string ( int64 format)

আবশ্যক। অপরিবর্তনীয়। যে ক্যাম্পেইনের অন্তর্গত ইনসারশন অর্ডারটি, তার অনন্য আইডি।

insertionOrderId

string ( int64 format)

শুধুমাত্র আউটপুট। ইনসারশন অর্ডারের অনন্য আইডি। সিস্টেম দ্বারা নির্ধারিত।

displayName

string

আবশ্যক। সন্নিবেশ ক্রমের প্রদর্শিত নাম।

অবশ্যই UTF-8 এনকোড করা হতে হবে এবং এর সর্বোচ্চ আকার হবে ২৪০ বাইট।

insertionOrderType

enum ( InsertionOrderType )

ঐচ্ছিক। সন্নিবেশ ক্রমের ধরণ।

তৈরির সময় এই ফিল্ডটি নির্দিষ্ট করা না থাকলে, এর ডিফল্ট মান RTB হয়ে যায়।

entityStatus

enum ( EntityStatus )

প্রয়োজনীয়। এটি নিয়ন্ত্রণ করে যে ইনসারশন অর্ডারটি তার বাজেট ব্যয় করতে এবং ইনভেন্টরির জন্য বিড করতে পারবে কি না।

  • insertionOrders.create মেথডের জন্য শুধুমাত্র ENTITY_STATUS_DRAFT অনুমোদিত। একটি ইনসারশন অর্ডার সক্রিয় করতে, insertionOrders.patch মেথড ব্যবহার করুন এবং তৈরির পরে স্ট্যাটাসটি ENTITY_STATUS_ACTIVE এ আপডেট করুন।
  • একটি ইনসারশন অর্ডারকে অন্য কোনো স্ট্যাটাস থেকে পুনরায় ENTITY_STATUS_DRAFT স্ট্যাটাসে পরিবর্তন করা যায় না।
  • যদি কোনো ইনসারশন অর্ডারের প্যারেন্ট ক্যাম্পেইন সক্রিয় না থাকে, তাহলে সেটিকে ENTITY_STATUS_ACTIVE হিসেবে সেট করা যাবে না।
updateTime

string ( Timestamp format)

শুধুমাত্র আউটপুট। ইনসারশন অর্ডার সর্বশেষ আপডেট করার সময়কার টাইমস্ট্যাম্প। সিস্টেম দ্বারা নির্ধারিত।

RFC 3339 ব্যবহার করা হয়, যেখানে তৈরি হওয়া আউটপুট সর্বদা Z-নরম্যালাইজড হবে এবং এতে ০, ৩, ৬ বা ৯টি ভগ্নাংশীয় অঙ্ক ব্যবহৃত হবে। "Z" ছাড়াও অন্যান্য অফসেটও গ্রহণ করা হয়। উদাহরণ: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" অথবা "2014-10-02T15:01:23+05:30" ।

partnerCosts[]

object ( PartnerCost )

ঐচ্ছিক। ইনসারশন অর্ডারের সাথে সংশ্লিষ্ট অংশীদারী খরচসমূহ।

insertionOrders.create মেথডটি অনুপস্থিত বা খালি থাকলে, নতুন তৈরি হওয়া ইনসারশন অর্ডারটি পার্টনার সেটিংস থেকে পার্টনারের খরচ গ্রহণ করবে।

pacing

object ( Pacing )

প্রয়োজনীয়। ইনসারশন অর্ডারের বাজেট ব্যয়ের গতি নির্ধারণ।

pacingType PACING_TYPE_ASAP এবং pacingPeriod PACING_PERIOD_FLIGHT সামঞ্জস্যপূর্ণ নয়।

frequencyCap

object ( FrequencyCap )

প্রয়োজনীয়। ইনসারশন অর্ডারের ফ্রিকোয়েন্সি ক্যাপিং সেটিং।

integrationDetails

object ( IntegrationDetails )

ঐচ্ছিক। সন্নিবেশ ক্রমের অতিরিক্ত ইন্টিগ্রেশন বিবরণ।

kpi

object ( Kpi )

প্রয়োজনীয়। ইনসারশন অর্ডারের প্রধান কর্মক্ষমতা সূচক (KPI)।

ডিসপ্লে ও ভিডিও ৩৬০ ইন্টারফেসে এটিকে 'লক্ষ্য' (Goal) হিসাবে উল্লেখ করে দেখানো হয়।

budget

object ( InsertionOrderBudget )

প্রয়োজনীয়। ইনসারশন অর্ডারের বাজেট বরাদ্দ সেটিংস।

bidStrategy

object ( BiddingStrategy )

ঐচ্ছিক। ইনসারশন অর্ডারের বিডিং কৌশল। ডিফল্টরূপে, fixedBid সেট করা থাকে।

যদি budget ফিল্ডের automationType INSERTION_ORDER_AUTOMATION_TYPE_BUDGET বা INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET এ সেট করা থাকে, তাহলে ইনসারশন অর্ডারটি তার লাইন আইটেমগুলোর উপর এই বিডিং স্ট্র্যাটেজিটি আরোপ করবে। যদি আরোপিত কোনো বিডিং স্ট্র্যাটেজি কোনো লাইন আইটেমের enableOptimizedTargeting সেটিং-এর সাথে সামঞ্জস্যপূর্ণ না হয়, তাহলে অপটিমাইজড টার্গেটিং সেটিংটি আপডেট করা হবে।

reservationType

enum ( ReservationType )

শুধুমাত্র আউটপুট। ইনসারশন অর্ডারের রিজার্ভেশন টাইপ।

optimizationObjective

enum ( OptimizationObjective )

প্রয়োজনীয়। সন্নিবেশ ক্রমের অনুকূলকরণের উদ্দেশ্য।

ইনসারশনঅর্ডারটাইপ

সন্নিবেশ ক্রমের সম্ভাব্য প্রকারভেদ।

ইনসারশন অর্ডারের ধরন নির্ধারণ করে দেয় যে কোন কোন সেটিংস ও অপশন প্রযোজ্য হবে, যেমন বিজ্ঞাপনের ফরম্যাট বা টার্গেটিং অপশন।

এনাম
INSERTION_ORDER_TYPE_UNSPECIFIED সন্নিবেশ ক্রমের ধরণ নির্দিষ্ট করা হয়নি বা অজানা।
RTB রিয়েল-টাইম বিডিং।
OVER_THE_TOP বাড়াবাড়ি।

কেপিআই

এমন সেটিংস যা একটি ইনসারশন অর্ডারের মূল পারফরম্যান্স সূচক বা কেপিআই (KPI) নিয়ন্ত্রণ করে।

JSON উপস্থাপনা 
{
  "kpiType": enum (KpiType),
  "kpiAlgorithmId": string,

  // Union field kpi_value can be only one of the following:
  "kpiAmountMicros": string,
  "kpiPercentageMicros": string,
  "kpiString": string
  // End of list of possible types for union field kpi_value.
}
ক্ষেত্র
kpiType

enum ( KpiType )

প্রয়োজনীয়। কেপিআই-এর ধরণ।

kpiAlgorithmId

string ( int64 format)

ঐচ্ছিক। KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST-এর সাথে যুক্ত কাস্টম বিডিং অ্যালগরিদম আইডি। সঠিক KPI নির্বাচন করা না হলে এই ফিল্ডটি উপেক্ষা করা হয়।

ইউনিয়ন ফিল্ড kpi_value । আবশ্যক। এটি KPI-এর মান। প্রাসঙ্গিক ফিল্ডটি kpi_type এর সাথে সঙ্গতিপূর্ণ। kpi_value নিম্নলিখিতগুলির মধ্যে কেবল একটি হতে পারে:
kpiAmountMicros

string ( int64 format)

লক্ষ্যমাত্রা পরিমাণ, বিজ্ঞাপনদাতার মুদ্রার ক্ষুদ্র এককে।

যখন kpiType নিম্নলিখিতগুলির মধ্যে একটি হয় তখন প্রযোজ্য:

  • KPI_TYPE_CPM
  • KPI_TYPE_CPC
  • KPI_TYPE_CPA
  • KPI_TYPE_CPIAVC
  • KPI_TYPE_VCPM

উদাহরণস্বরূপ: ১৫০০০০০ সংখ্যাটি মুদ্রার ১.৫ স্ট্যান্ডার্ড ইউনিটকে বোঝায়।

kpiPercentageMicros

string ( int64 format)

লক্ষ্যের শতাংশের দশমিক উপস্থাপনা (মাইক্রোসেকেন্ডে)।

যখন kpiType নিম্নলিখিতগুলির মধ্যে একটি হয় তখন প্রযোজ্য:

  • KPI_TYPE_CTR
  • KPI_TYPE_VIEWABILITY
  • KPI_TYPE_CLICK_CVR
  • KPI_TYPE_IMPRESSION_CVR
  • KPI_TYPE_VTR
  • KPI_TYPE_AUDIO_COMPLETION_RATE
  • KPI_TYPE_VIDEO_COMPLETION_RATE

উদাহরণস্বরূপ: ৭০০০০ মানে ৭% (দশমিক ০.০৭)।

kpiString

string

একটি KPI স্ট্রিং, যা খালিও থাকতে পারে। এটিকে অবশ্যই UTF-8 এনকোড করা হতে হবে এবং এর দৈর্ঘ্য ১০০ অক্ষরের বেশি হবে না।

যখন kpiType হলো KPI_TYPE_OTHER , তখন প্রযোজ্য।

কেপিআইটাইপ

সম্ভাব্য প্রধান কর্মক্ষমতা সূচক (KPI) প্রকারভেদ।

এনাম
KPI_TYPE_UNSPECIFIED এই সংস্করণে KPI-এর ধরণ নির্দিষ্ট করা নেই অথবা তা অজানা।
KPI_TYPE_CPM কেপিআই হলো সিপিএম (কস্ট পার মিলে)।
KPI_TYPE_CPC কেপিআই হলো সিপিসি (ক্লিক প্রতি খরচ)।
KPI_TYPE_CPA কেপিআই হলো সিপিএ (প্রতিটি কাজের খরচ)।
KPI_TYPE_CTR কেপিআই হলো সিটিআর (ক্লিক-থ্রু রেট) শতাংশ।
KPI_TYPE_VIEWABILITY কেপিআই হলো ভিউএবিলিটি পার্সেন্টেজ।
KPI_TYPE_CPIAVC কেপিআই হলো সিপিআইএভিসি (সম্পূর্ণ হওয়ার পর শ্রবণযোগ্য ও দৃশ্যমান প্রতি ইম্প্রেশনের খরচ)।
KPI_TYPE_CPE কেপিআই হলো সিপিই (প্রতি এনগেজমেন্টের খরচ)।
KPI_TYPE_CPV কেপিআই (KPI) সিপিভি (CPV) (কস্ট পার ভিউ) এককে নির্ধারণ করা হয়।
KPI_TYPE_CLICK_CVR কেপিআই হলো ক্লিক কনভার্সন রেট (প্রতি ক্লিকে কনভার্সন) শতাংশ।
KPI_TYPE_IMPRESSION_CVR কেপিআই হলো ইম্প্রেশন কনভার্সন রেট (প্রতি ইম্প্রেশনে কনভার্সন) শতাংশ।
KPI_TYPE_VCPM কেপিআই হলো ভিসিপিএম (প্রতি হাজার দর্শনযোগ্য ইম্প্রেশনের খরচ)।
KPI_TYPE_VTR কেপিআই হলো ইউটিউব ভিউ রেট (প্রতি ইম্প্রেশনে ইউটিউব ভিউয়ের সংখ্যা) শতাংশ।
KPI_TYPE_AUDIO_COMPLETION_RATE কেপিআই হলো অডিও সম্পূর্ণ শোনার হার (প্রতি ইম্প্রেশনে সম্পূর্ণ অডিও শোনার শতাংশ)।
KPI_TYPE_VIDEO_COMPLETION_RATE কেপিআই হলো ভিডিও কমপ্লিশন রেট (প্রতি ইম্প্রেশনে সম্পূর্ণ ভিডিও দেখার হার) শতাংশ।
KPI_TYPE_CPCL কেপিআই (KPI) সিপিসিএল (CPCL) (প্রতিটি সম্পূর্ণ অডিও শোনার খরচ)-এর ভিত্তিতে নির্ধারণ করা হয়।
KPI_TYPE_CPCV কেপিআই (KPI) সিপিসিভি (CPCV) (প্রতিটি সম্পূর্ণ ভিডিও দেখার খরচ)-এর ভিত্তিতে নির্ধারণ করা হয়।
KPI_TYPE_TOS10 কেপিআই (KPI) নির্ধারণ করা হয় স্ক্রিনে ১০+ সেকেন্ড থাকার হারের ভিত্তিতে (পরিমাপযোগ্য, স্কিপ-অযোগ্য ইম্প্রেশনের শতাংশ, যা কমপক্ষে ১০ সেকেন্ড ধরে স্ক্রিনে ছিল)।
KPI_TYPE_MAXIMIZE_PACING সম্পূর্ণ বাজেট ব্যয়ের উপর অগ্রাধিকার দেওয়ার পাশাপাশি ব্র্যান্ডের প্রভাব সর্বাধিক করার জন্য কেপিআই (KPI) নির্ধারণ করা হয়েছে।
KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST কাস্টম ইম্প্রেশন ভ্যালুকে খরচ দিয়ে ভাগ করে কেপিআই (KPI) নির্ধারণ করা হয়।
KPI_TYPE_OTHER KPI হলো অন্য কোনো মান।

ইনসারশনঅর্ডারবাজেট

যেসব সেটিংস ইনসারশন অর্ডার বাজেট কীভাবে বরাদ্দ করা হবে তা নিয়ন্ত্রণ করে।

JSON উপস্থাপনা 
{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}
ক্ষেত্র
budgetUnit

enum ( BudgetUnit )

আবশ্যক। অপরিবর্তনীয়। বাজেট ইউনিট নির্দিষ্ট করে যে বাজেটটি মুদ্রা ভিত্তিক নাকি ইম্প্রেশন ভিত্তিক।

automationType

enum ( InsertionOrderAutomationType )

ঐচ্ছিক। ইনসারশন অর্ডারের জন্য বিড ও বাজেট ব্যবস্থাপনায় ব্যবহৃত অটোমেশনের ধরণ।

তৈরির সময় এই ফিল্ডটি নির্দিষ্ট করা না থাকলে, এর ডিফল্ট মান INSERTION_ORDER_AUTOMATION_TYPE_NONE হয়।

budgetSegments[]

object ( InsertionOrderBudgetSegment )

প্রয়োজনীয়। বাজেট সেগমেন্টের তালিকা। একটি ইনসারশন অর্ডার চালু থাকার নির্দিষ্ট সময়কালের জন্য একটি বিশেষ বাজেট নির্ধারণ করতে বাজেট সেগমেন্ট ব্যবহার করুন।

ইনসারশনঅর্ডারঅটোমেশনটাইপ

ইনসারশন অর্ডারের বিড ও বাজেট স্বয়ংক্রিয় করার সম্ভাব্য উপায়সমূহ।

এনাম
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED এই সংস্করণে ইনসারশন অর্ডার অটোমেশন অপশনটি নির্দিষ্ট করা নেই অথবা এটি অজানা।
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET স্বয়ংক্রিয় বাজেট বরাদ্দ। kpi দ্বারা সংজ্ঞায়িত কর্মক্ষমতা অপ্টিমাইজ করার জন্য সিস্টেমকে স্বয়ংক্রিয়ভাবে বাজেটকে সংশ্লিষ্ট লাইন আইটেমগুলিতে স্থানান্তর করার অনুমতি দিন। বিড সেটিংসে কোনো অটোমেশন নেই।
INSERTION_ORDER_AUTOMATION_TYPE_NONE ইনসারশন অর্ডার পর্যায়ে বিড বা বাজেটের কোনো অটোমেশন নেই। লাইন আইটেম পর্যায়ে বিড এবং বাজেট ম্যানুয়ালি কনফিগার করতে হবে।
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET bidStrategy দ্বারা সংজ্ঞায়িত পারফরম্যান্স অপ্টিমাইজ করার জন্য, সিস্টেমকে স্বয়ংক্রিয়ভাবে বিড সমন্বয় করতে এবং নিজস্ব লাইন আইটেমগুলিতে বাজেট স্থানান্তর করার অনুমতি দিন।

ইনসারশনঅর্ডারবাজেটসেগমেন্ট

এমন সেটিংস যা একটি নির্দিষ্ট বাজেট সেগমেন্টের বাজেট নিয়ন্ত্রণ করে।

JSON উপস্থাপনা 
{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}
ক্ষেত্র
budgetAmountMicros

string ( int64 format)

প্রয়োজনীয়। প্রদত্ত dateRange জন্য ইনসারশন অর্ডারটি যে বাজেট ব্যয় করবে। টাকার পরিমাণ মাইক্রো ইউনিটে (micros) হবে। অবশ্যই ০-এর চেয়ে বড় হতে হবে। উদাহরণস্বরূপ, 500000000 মানে হলো মুদ্রার ৫০০ স্ট্যান্ডার্ড ইউনিট।

description

string

ঐচ্ছিক। বাজেট সেগমেন্টের বিবরণ। এটি ব্যবহার করে প্রতিটি বাজেট সেগমেন্টের জন্য পারচেজ অর্ডার (ক্রয় আদেশ) তথ্য প্রবেশ করানো যায় এবং সেই তথ্য ইনভয়েসে প্রিন্ট করা যায়।

অবশ্যই UTF-8 এনকোড করা হতে হবে।

dateRange

object ( DateRange )

প্রয়োজনীয়। বাজেট সেগমেন্টের শুরু এবং শেষের তারিখের সেটিংস। এগুলি মূল বিজ্ঞাপনদাতার টাইম জোনের সাপেক্ষে নির্ধারিত হয়।

  • নতুন বাজেট সেগমেন্ট তৈরি করার সময়, startDate এবং endDate উভয়ই ভবিষ্যতের হতে হবে।
  • অতীতের কোনো startDate থাকা একটি বিদ্যমান বাজেট সেগমেন্টের endDate পরিবর্তনযোগ্য কিন্তু startDate অপরিবর্তনযোগ্য।
  • endDate অবশ্যই startDate বা তার পরের হতে হবে এবং উভয় তারিখই ২০৩৭ সালের আগে হতে হবে।
campaignBudgetId

string ( int64 format)

ঐচ্ছিক। এই ইনসারশন অর্ডার বাজেট সেগমেন্টটি যে ক্যাম্পেইন বাজেটের অংশ, তার budgetId ।

অপ্টিমাইজেশন উদ্দেশ্য

অপ্টিমাইজেশন উদ্দেশ্যগুলোর সম্ভাব্য প্রকারভেদ।

এনাম
OPTIMIZATION_OBJECTIVE_UNSPECIFIED এই সংস্করণে টাইপের মান নির্দিষ্ট করা নেই অথবা তা অজানা।
CONVERSION যেসব ইম্প্রেশন বিক্রয় ও কনভার্সন বাড়ায়, সেগুলোকে অগ্রাধিকার দিন।
CLICK যেসব ইম্প্রেশন ওয়েবসাইট ট্র্যাফিক, অ্যাপ ও অ্যাপ স্টোর বাড়ায়, সেগুলোকে অগ্রাধিকার দিন।
BRAND_AWARENESS নির্দিষ্ট গুণমানের ছাপগুলোকে অগ্রাধিকার দিন।
CUSTOM নির্ধারিত কাস্টম বিডিং অ্যালগরিদম দ্বারা উদ্দেশ্য সংজ্ঞায়িত করা হয়।
NO_OBJECTIVE উদ্দেশ্য সংজ্ঞায়িত করা হয়নি। যেকোনো কেপিআই (KPI) বা বিডিং কৌশল ব্যবহার করা যেতে পারে।

পদ্ধতি

create

 একটি নতুন সন্নিবেশ ক্রম তৈরি করে।

delete

 সন্নিবেশিত ক্রম মুছে ফেলে।

get

 একটি ইনসারশন অর্ডার পায়।

list

 একজন বিজ্ঞাপনদাতার ইনসারশন অর্ডার তালিকাভুক্ত করে।

patch

 বিদ্যমান সন্নিবেশ ক্রম আপডেট করে।