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-normalized خواهد بود و از ارقام کسری ۰، ۳، ۶ یا ۹ استفاده می‌کند. آفست‌های غیر از "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

برای مثال، ۷۰۰۰۰ نشان دهنده ۷٪ (اعشاری ۰.۰۷) است.

performanceGoalString

string

یک رشته شاخص عملکرد کلیدی (KPI)، که می‌تواند خالی باشد. باید با UTF-8 کدگذاری شده و طول آن بیش از ۱۰۰ کاراکتر نباشد.

زمانی اعمال می‌شود که performanceGoalType روی PERFORMANCE_GOAL_TYPE_OTHER تنظیم شده باشد.

نوع هدف عملکرد

انواع احتمالی اهداف عملکردی

انوم‌ها
PERFORMANCE_GOAL_TYPE_UNSPECIFIED نوع هدف عملکردی در این نسخه مشخص نشده یا ناشناخته است.
PERFORMANCE_GOAL_TYPE_CPM هدف عملکرد بر اساس 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 استفاده خواهد شد.

مبلغ به میکرو است. باید بزرگتر یا مساوی 0 باشد. برای مثال، 500000000 نشان دهنده 500 واحد استاندارد از ارز است.

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)

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

مبلغ به میکرو است. باید بزرگتر از 0 باشد. برای مثال، 500000000 نشان دهنده 500 واحد استاندارد از ارز است.

dateRange

object ( DateRange )

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

هر دو startDate و endDate باید قبل از سال ۲۰۳۷ باشند.

externalBudgetSource

enum ( ExternalBudgetSource )

الزامی. منبع خارجی بودجه.

externalBudgetId

string

تغییرناپذیر. شناسه‌ای که این بودجه را به منبع خارجی معرفی می‌کند.

اگر این فیلد تنظیم شود و سطح جزئیات فاکتور پروفایل صورتحساب مربوطه روی "سطح بودجه سفارش" تنظیم شود، تمام نمایش‌هایی که با این بودجه نمایش داده می‌شوند، این شناسه را در فاکتور درج خواهند کرد.

باید تحت کمپین منحصر به فرد باشد.

invoiceGroupingId

string

تغییرناپذیر. شناسه‌ای که برای گروه‌بندی بودجه‌ها استفاده می‌شد، در همان فاکتور لحاظ می‌شد.

اگر این فیلد تنظیم شود و سطح فاکتور پروفایل صورتحساب مربوطه روی "شناسه گروه‌بندی فاکتور بودجه" تنظیم شود، تمام externalBudgetId که دارای invoiceGroupingId یکسانی هستند، در یک فاکتور گروه‌بندی می‌شوند.

prismaConfig

object ( PrismaConfig )

ابرداده‌های اضافی برای استفاده توسط ابزار Mediaocean Prisma.

برای بودجه‌های مدیااوشن مورد نیاز است.

فقط برای تبلیغ‌کنندگان prismaEnabled قابل اجرا است.

منبع بودجه خارجی

منبع خارجی برای بخش بودجه کمپین.

انوم‌ها
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED مقدار منبع بودجه خارجی در این نسخه مشخص نشده یا ناشناخته است.
EXTERNAL_BUDGET_SOURCE_NONE بودجه هیچ منبع خارجی ندارد.
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN منبع بودجه Mediaocean است.

پریسما کانفیگ

تنظیمات مخصوص ابزار Mediaocean Prisma.

نمایش JSON 
{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}
فیلدها
prismaType

enum ( PrismaType )

الزامی. نوع Prisma.

prismaCpeCode

object ( PrismaCpeCode )

الزامی. کدهای مربوط به مشتری، محصول و برآورد از ابزار Mediaocean Prisma.

supplier

string

الزامی. نهاد مربوطه این بودجه را اختصاص داده است (DSP، سایت و غیره).

پریسما تایپ

انواع احتمالی بودجه پریسما.

انوم‌ها
PRISMA_TYPE_UNSPECIFIED نوع در این نسخه مشخص نشده یا ناشناخته است.
PRISMA_TYPE_DISPLAY نوع نمایش.
PRISMA_TYPE_VIDEO نوع ویدئو.
PRISMA_TYPE_AUDIO نوع صوتی.
PRISMA_TYPE_SOCIAL نوع اجتماعی.
PRISMA_TYPE_FEE نوع کارمزد.

پریسما سی پی کد

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

نمایش JSON 
{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}
فیلدها
prismaClientCode

string

کد کلاینت پریسما.

prismaProductCode

string

کد محصول پریسما.

prismaEstimateCode

string

کد تخمین پریسما.

روش‌ها

create

 یک کمپین جدید ایجاد می‌کند.

delete

 یک کمپین را به طور دائم حذف می‌کند.

get

 یک کمپین تبلیغاتی راه می‌اندازد.

list

 کمپین‌ها را در یک تبلیغ‌کننده فهرست می‌کند.

patch

 یک کمپین موجود را به‌روزرسانی می‌کند.