REST Resource: advertisers.campaigns

উৎস: প্রচারাভিযান

একটি একক প্রচারণা।

JSON উপস্থাপনা 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "campaignGoal": {
    object (CampaignGoal)
  },
  "campaignFlight": {
    object (CampaignFlight)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "campaignBudgets": [
    {
      object (CampaignBudget)
    }
  ]
}
ক্ষেত্র
name

string

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

advertiserId

string ( int64 format)

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

campaignId

string ( int64 format)

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

displayName

string

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

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

entityStatus

enum ( EntityStatus )

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

  • গ্রহণযোগ্য মানগুলো হলো ENTITY_STATUS_ACTIVE , ENTITY_STATUS_ARCHIVED , এবং ENTITY_STATUS_PAUSED ।
  • campaigns.create মেথডের জন্য ENTITY_STATUS_ARCHIVED অনুমোদিত নয়।
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" ।

campaignGoal

object ( CampaignGoal )

প্রয়োজনীয়। প্রচারণার লক্ষ্য।

campaignFlight

object ( CampaignFlight )

প্রয়োজনীয়। প্রচারণার পরিকল্পিত ব্যয় ও সময়কাল।

frequencyCap

object ( FrequencyCap )

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

campaignBudgets[]

object ( CampaignBudget )

এই প্রচারণার জন্য উপলব্ধ বাজেটসমূহের তালিকা।

এই ফিল্ডটি সেট করা না থাকলে, ক্যাম্পেইনটি সীমাহীন বাজেট ব্যবহার করে।

প্রচারণার লক্ষ্য

ক্যাম্পেইনের লক্ষ্য নিয়ন্ত্রণকারী সেটিংস।

JSON উপস্থাপনা 
{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}
ক্ষেত্র
campaignGoalType

enum ( CampaignGoalType )

প্রয়োজনীয়। প্রচারণার লক্ষ্যের ধরণ।

performanceGoal

object ( PerformanceGoal )

প্রয়োজনীয়। ক্যাম্পেইনের কার্যসম্পাদনের লক্ষ্যমাত্রা।

performanceGoalType এর জন্য গ্রহণযোগ্য মানগুলি হলো:

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_OTHER

প্রচারাভিযানের লক্ষ্যের ধরণ

প্রচারণার লক্ষ্যের সম্ভাব্য প্রকারভেদ।

এনাম
CAMPAIGN_GOAL_TYPE_UNSPECIFIED এই সংস্করণে লক্ষ্যমাত্রা নির্দিষ্ট করা নেই বা অজানা।
CAMPAIGN_GOAL_TYPE_APP_INSTALL অ্যাপ ইনস্টল বা এনগেজমেন্ট বাড়ান।
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS কোনো ব্র্যান্ড বা পণ্য সম্পর্কে সচেতনতা বৃদ্ধি করা।
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION অফলাইন বা ইন-স্টোর বিক্রয় বাড়ান।
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION অনলাইন কার্যকলাপ বা ভিজিট বৃদ্ধি করুন।

পারফরম্যান্স গোল

ক্যাম্পেইনের পারফরম্যান্সের লক্ষ্য নিয়ন্ত্রণকারী সেটিংস।

JSON উপস্থাপনা 
{
  "performanceGoalType": enum (PerformanceGoalType),

  // Union field performance_goal_value can be only one of the following:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of list of possible types for union field performance_goal_value.
}
ক্ষেত্র
performanceGoalType

enum ( PerformanceGoalType )

প্রয়োজনীয়। কর্মসম্পাদন লক্ষ্যের ধরণ।

ইউনিয়ন ফিল্ড performance_goal_value । আবশ্যক। একটি প্রদত্ত performance_goal_type এর সাথে সঙ্গতিপূর্ণ পারফরম্যান্স লক্ষ্যের মান। performance_goal_value নিম্নলিখিতগুলির মধ্যে কেবল একটি হতে পারে:
performanceGoalAmountMicros

string ( int64 format)

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

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

  • PERFORMANCE_GOAL_TYPE_CPM
  • PERFORMANCE_GOAL_TYPE_CPC
  • PERFORMANCE_GOAL_TYPE_CPA
  • PERFORMANCE_GOAL_TYPE_CPIAVC
  • PERFORMANCE_GOAL_TYPE_VCPM

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

performanceGoalPercentageMicros

string ( int64 format)

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

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

  • PERFORMANCE_GOAL_TYPE_CTR
  • PERFORMANCE_GOAL_TYPE_VIEWABILITY
  • PERFORMANCE_GOAL_TYPE_CLICK_CVR
  • PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR
  • PERFORMANCE_GOAL_TYPE_VTR
  • PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE
  • PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE

উদাহরণস্বরূপ, 70000 মানে 7% (দশমিক 0.07)।

performanceGoalString

string

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

যখন performanceGoalType PERFORMANCE_GOAL_TYPE_OTHER এ সেট করা থাকে, তখন প্রযোজ্য।

পারফরম্যান্স লক্ষ্যের ধরণ

কর্মক্ষমতার লক্ষ্যের সম্ভাব্য প্রকারভেদ।

এনাম
PERFORMANCE_GOAL_TYPE_UNSPECIFIED এই সংস্করণে পারফরম্যান্স লক্ষ্যের ধরণ নির্দিষ্ট করা নেই বা অজানা।
PERFORMANCE_GOAL_TYPE_CPM পারফরম্যান্সের লক্ষ্যমাত্রা সিপিএম (কস্ট পার মিলে) এককে নির্ধারণ করা হয়।
PERFORMANCE_GOAL_TYPE_CPC পারফরম্যান্সের লক্ষ্যমাত্রা CPC (কস্ট পার ক্লিক)-এর ভিত্তিতে নির্ধারণ করা হয়।
PERFORMANCE_GOAL_TYPE_CPA পারফরম্যান্সের লক্ষ্যমাত্রা CPA (প্রতিটি কাজের খরচ)-এর ভিত্তিতে নির্ধারণ করা হয়।
PERFORMANCE_GOAL_TYPE_CTR পারফরম্যান্সের লক্ষ্যমাত্রা CTR (ক্লিক-থ্রু রেট) শতাংশের ভিত্তিতে নির্ধারণ করা হয়।
PERFORMANCE_GOAL_TYPE_VIEWABILITY পারফরম্যান্সের লক্ষ্যমাত্রা ভিউএবিলিটি শতাংশে নির্ধারণ করা হয়।
PERFORMANCE_GOAL_TYPE_CPIAVC কার্যকারিতার লক্ষ্যমাত্রা CPIAVC (সম্পূর্ণ হওয়ার পর শ্রবণযোগ্য ও দৃশ্যমান প্রতিটি প্রভাবের খরচ) হিসেবে নির্ধারণ করা হয়েছে।
PERFORMANCE_GOAL_TYPE_CPE কর্মক্ষমতার লক্ষ্যমাত্রা CPE (প্রতিটি এনগেজমেন্টের খরচ)-এর ভিত্তিতে নির্ধারণ করা হয়।
PERFORMANCE_GOAL_TYPE_CPV পারফরম্যান্সের লক্ষ্যমাত্রা CPV (প্রতি ভিউ খরচ)-এর ভিত্তিতে নির্ধারণ করা হয়।
PERFORMANCE_GOAL_TYPE_CLICK_CVR পারফরম্যান্সের লক্ষ্যমাত্রা ক্লিক কনভার্সন রেট (প্রতি ক্লিকে কনভার্সন) শতাংশের ভিত্তিতে নির্ধারণ করা হয়।
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR পারফরম্যান্সের লক্ষ্যমাত্রা ইম্প্রেশন কনভার্সন রেট (প্রতি ইম্প্রেশনে কনভার্সন) শতাংশের ভিত্তিতে নির্ধারণ করা হয়।
PERFORMANCE_GOAL_TYPE_VCPM পারফরম্যান্সের লক্ষ্যমাত্রা VCPM (প্রতি হাজার দর্শনযোগ্য ইম্প্রেশনের খরচ)-এর ভিত্তিতে নির্ধারণ করা হয়।
PERFORMANCE_GOAL_TYPE_VTR পারফরম্যান্সের লক্ষ্যমাত্রা ইউটিউব ভিউ রেট (প্রতি ইম্প্রেশনে ইউটিউব ভিউ) শতাংশের ভিত্তিতে নির্ধারণ করা হয়।
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE পারফরম্যান্সের লক্ষ্যমাত্রা অডিও সম্পূর্ণ শোনার হার (প্রতি ইম্প্রেশনে সম্পূর্ণ অডিও শোনার সংখ্যা) শতাংশের ভিত্তিতে নির্ধারণ করা হয়।
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE পারফরম্যান্সের লক্ষ্যমাত্রা ভিডিও সমাপ্তির হার (প্রতি ইম্প্রেশনে সম্পূর্ণ ভিডিও দেখার হার) শতাংশের ভিত্তিতে নির্ধারণ করা হয়।
PERFORMANCE_GOAL_TYPE_OTHER পারফরম্যান্সের লক্ষ্যমাত্রা 'অন্যান্য' হিসেবে নির্ধারণ করা হয়েছে।

ক্যাম্পেইনফ্লাইট

এমন সেটিংস যা একটি ক্যাম্পেইনের পরিকল্পিত ব্যয় এবং সময়কাল ট্র্যাক করে।

JSON উপস্থাপনা 
{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}
ক্ষেত্র
plannedSpendAmountMicros

string ( int64 format)

ক্যাম্পেইনটি তার নির্ধারিত plannedDates যে পরিমাণ অর্থ ব্যয় করবে বলে আশা করা হচ্ছে। এটি পরিষেবা প্রদানকে সীমিত করবে না, তবে DV360 UI-তে ব্যয় ট্র্যাক করার জন্য ব্যবহৃত হবে।

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

plannedDates

object ( DateRange )

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

  • এখানে উল্লেখিত তারিখগুলো পরিষেবা প্রদানে কোনো প্রভাব ফেলবে না। এগুলো অ্যালার্ট এবং সতর্কীকরণ বার্তা তৈরি করতে ব্যবহৃত হয়। উদাহরণস্বরূপ, যদি কোনো চাইল্ড ইনসারশন অর্ডারের ফ্লাইটের তারিখ এই তারিখগুলোর পরিসরের বাইরে হয়, তাহলে ইউজার ইন্টারফেসে একটি সতর্কীকরণ বার্তা দেখানো হবে।
  • startDate আবশ্যক এবং এটি অবশ্যই বর্তমান তারিখ বা তার পরবর্তী কোনো তারিখ হতে হবে।
  • endDate ঐচ্ছিক। যদি নির্দিষ্ট করা হয়, তবে তা অবশ্যই startDate ) বা তার পরবর্তী তারিখ হতে হবে।
  • যেকোনো নির্দিষ্ট তারিখ অবশ্যই ২০৩৭ সালের আগে হতে হবে।

প্রচারাভিযান বাজেট

যে সেটিংসগুলো ক্যাম্পেইন বাজেট কীভাবে বরাদ্দ করা হবে তা নিয়ন্ত্রণ করে।

JSON উপস্থাপনা 
{
  "budgetId": string,
  "displayName": string,
  "budgetUnit": enum (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}
ক্ষেত্র
budgetId

string ( int64 format)

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

campaignBudgets এ বাজেট আপডেট বা যোগ করার সময় এটি অবশ্যই অন্তর্ভুক্ত করতে হবে। অন্যথায়, একটি নতুন আইডি তৈরি করে বরাদ্দ করা হবে।

displayName

string

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

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

budgetUnit

enum ( BudgetUnit )

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

budgetAmountMicros

string ( int64 format)

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

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

dateRange

object ( DateRange )

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

startDate এবং endDate উভয়ই ২০৩৭ সালের আগে হতে হবে।

externalBudgetSource

enum ( ExternalBudgetSource )

প্রয়োজনীয়। বাজেটের বাহ্যিক উৎস।

externalBudgetId

string

অপরিবর্তনীয়। বাহ্যিক উৎসের কাছে এই বাজেটকে শনাক্তকারী আইডি।

যদি এই ফিল্ডটি সেট করা থাকে এবং সংশ্লিষ্ট বিলিং প্রোফাইলের ইনভয়েস ডিটেল লেভেল "বাজেট লেভেল পিও"-তে সেট করা থাকে, তাহলে এই বাজেটের অধীনে পরিবেশিত সমস্ত ইম্প্রেশনের ইনভয়েসে এই আইডিটি অন্তর্ভুক্ত থাকবে।

প্রচারণার অধীনে অবশ্যই অনন্য হতে হবে।

invoiceGroupingId

string

অপরিবর্তনীয়। একই ইনভয়েসে অন্তর্ভুক্ত করার জন্য বাজেটগুলোকে দলবদ্ধ করতে এই আইডিটি ব্যবহৃত হয়।

যদি এই ফিল্ডটি সেট করা থাকে এবং সংশ্লিষ্ট বিলিং প্রোফাইলের ইনভয়েস লেভেল "বাজেট ইনভয়েস গ্রুপিং আইডি" হিসেবে সেট করা থাকে, তাহলে একই invoiceGroupingId শেয়ার করা সমস্ত externalBudgetId একই ইনভয়েসে গ্রুপ করা হবে।

prismaConfig

object ( PrismaConfig )

মিডিয়াওশান প্রিজমা টুলের ব্যবহারের জন্য অতিরিক্ত মেটাডেটা।

মিডিয়াওশান বাজেটের জন্য আবশ্যক।

শুধুমাত্র prismaEnabled বিজ্ঞাপনদাতাদের জন্য প্রযোজ্য।

এক্সটার্নাল বাজেট সোর্স

প্রচারাভিযানের বাজেট অংশের জন্য বাহ্যিক উৎস।

এনাম
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED এই সংস্করণে বাহ্যিক বাজেট উৎসের মান নির্দিষ্ট করা নেই বা অজানা।
EXTERNAL_BUDGET_SOURCE_NONE বাজেটের কোনো বাহ্যিক উৎস নেই।
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN বাজেটের উৎস হলো মিডিয়াওশান।

প্রিজমাকনফিগ

মিডিয়াওশান প্রিজমা টুলের জন্য নির্দিষ্ট সেটিংস।

JSON উপস্থাপনা 
{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}
ক্ষেত্র
prismaType

enum ( PrismaType )

আবশ্যক। প্রিজমা টাইপ।

prismaCpeCode

object ( PrismaCpeCode )

মিডিয়াওশান প্রিজমা টুল থেকে প্রাসঙ্গিক ক্লায়েন্ট, প্রোডাক্ট এবং এস্টিমেট কোড প্রয়োজন।

supplier

string

প্রয়োজনীয়। সংশ্লিষ্ট প্রতিষ্ঠানটি এই বাজেট (ডিএসপি, সাইট, ইত্যাদি) বরাদ্দ করেছে।

প্রিজমাটাইপ

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

এনাম
PRISMA_TYPE_UNSPECIFIED এই সংস্করণে ধরণটি নির্দিষ্ট করা নেই বা অজানা।
PRISMA_TYPE_DISPLAY প্রদর্শনের ধরণ।
PRISMA_TYPE_VIDEO ভিডিওর ধরণ।
PRISMA_TYPE_AUDIO অডিওর ধরণ।
PRISMA_TYPE_SOCIAL সামাজিক ধরণ।
PRISMA_TYPE_FEE ফি-এর ধরণ।

PrismaCpeCode

গুগল পেমেন্টস সেন্টার এই কোডের উপাদান ক্ষেত্রগুলিতে অনুসন্ধান এবং ফিল্টারিং সমর্থন করে।

JSON উপস্থাপনা 
{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}
ক্ষেত্র
prismaClientCode

string

প্রিজমা ক্লায়েন্ট কোড।

prismaProductCode

string

প্রিজমা প্রোডাক্ট কোড।

prismaEstimateCode

string

প্রিজমা এস্টিমেট কোড।

পদ্ধতি

create

 একটি নতুন ক্যাম্পেইন তৈরি করে।

delete

 একটি ক্যাম্পেইন স্থায়ীভাবে মুছে দেয়।

get

 একটি প্রচারণা পায়।

list

 একজন বিজ্ঞাপনদাতার ক্যাম্পেইনগুলো তালিকাভুক্ত করে।

patch

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