REST Resource: advertisers.campaigns

{
  "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)
    }
  ]
}

string

فقط خروجی نام منبع کمپین

string ( int64 format)

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

string ( int64 format)

فقط خروجی شناسه منحصر به فرد کمپین. توسط سیستم تعیین شده است.

string

مورد نیاز. نام نمایشی کمپین

باید UTF-8 با حداکثر اندازه 240 بایت کدگذاری شود.

enum ( EntityStatus )

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

• مقادیر پذیرفته شده عبارتند از ENTITY_STATUS_ACTIVE ، ENTITY_STATUS_ARCHIVED ، و ENTITY_STATUS_PAUSED .
• برای روش campaigns.create ، ENTITY_STATUS_ARCHIVED مجاز نیست.

string ( Timestamp format)

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

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

object ( CampaignGoal )

مورد نیاز. هدف کمپین.

object ( CampaignFlight )

مورد نیاز. هزینه برنامه ریزی شده و مدت زمان کمپین.

object ( FrequencyCap )

مورد نیاز. تنظیم سقف فرکانس کمپین.

object ( CampaignBudget )

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

اگر این قسمت تنظیم نشده باشد، کمپین از بودجه نامحدود استفاده می کند.

{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}

enum ( CampaignGoalType )

مورد نیاز. نوع هدف کمپین

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

{
  "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.
}

enum ( PerformanceGoalType )

مورد نیاز. نوع هدف عملکرد

string ( int64 format)

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

زمانی قابل استفاده است که performanceGoalType یکی از موارد زیر باشد:

• PERFORMANCE_GOAL_TYPE_CPM
• PERFORMANCE_GOAL_TYPE_CPC
• PERFORMANCE_GOAL_TYPE_CPA
• PERFORMANCE_GOAL_TYPE_CPIAVC
• PERFORMANCE_GOAL_TYPE_VCPM

به عنوان مثال 1500000 نشان دهنده 1.5 واحد استاندارد واحد پول است.

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

string

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

زمانی که performanceGoalType روی PERFORMANCE_GOAL_TYPE_OTHER تنظیم شده باشد قابل استفاده است.

{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}

string ( int64 format)

مبلغی که انتظار می‌رود کمپین برای plannedDates خود هزینه کند. این سرویس دهی را محدود نمی کند، بلکه برای ردیابی هزینه در رابط کاربری DV360 استفاده می شود.

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

object ( DateRange )

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

• تاریخ‌های مشخص‌شده در اینجا تأثیری بر ارائه خدمات نخواهد داشت. آنها برای ایجاد هشدار و هشدار استفاده می شوند. به عنوان مثال، اگر تاریخ پرواز هر سفارش درج فرزند خارج از محدوده این تاریخ ها باشد، رابط کاربری یک هشدار نشان می دهد.
• startDate الزامی است و باید تاریخ فعلی یا بالاتر باشد.
• endDate اختیاری است. اگر مشخص شده باشد، باید startDate یا بالاتر باشد.
• هر تاریخ مشخص شده باید قبل از سال 2037 باشد.

{
  "budgetId": string,
  "displayName": string,
  "budgetUnit": enum (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}

string ( int64 format)

شناسه منحصر به فرد بودجه کمپین. توسط سیستم تعیین شده است. برای بودجه های جدید تعیین نکنید.

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

string

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

باید UTF-8 با حداکثر اندازه 240 بایت کدگذاری شود.

enum ( BudgetUnit )

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

string ( int64 format)

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

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

object ( DateRange )

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

هم startDate و هم endDate باید قبل از سال 2037 باشد.

enum ( ExternalBudgetSource )

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

string

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

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

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

string

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

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

object ( PrismaConfig )

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

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

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

{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}

enum ( PrismaType )

مورد نیاز. نوع پریسما

object ( PrismaCpeCode )

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

string

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

{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}

string

کد مشتری Prisma.

string

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

string

کد برآورد پریسما