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)

فهرست بودجه‌های دردسترس برای این پویش.

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

CampaignGoal

تنظیماتی که هدف پویش را کنترل می‌کند.

نمایش 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

CampaignGoalType

انواع احتمالی اهداف پویش.

شمارشی‌ها
CAMPAIGN_GOAL_TYPE_UNSPECIFIED مقدار هدف در این نسخه مشخص نشده است یا ناشناخته است.
CAMPAIGN_GOAL_TYPE_APP_INSTALL نصب‌ها یا تعامل‌های برنامه Drive.
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS آگاهی از نمانام یا محصول را افزایش دهید.
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION فروش آفلاین یا درون‌فروشگاهی را افزایش دهید.
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION کنش یا بازدید آنلاین را افزایش دهید.

PerformanceGoal

تنظیماتی که هدف عملکرد پویش را کنترل می‌کند.

نمایش JSON 
{
  "performanceGoalType": enum (PerformanceGoalType),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "performanceGoalAmountMicros": string,
  "performanceGoalPercentageMicros": string,
  "performanceGoalString": string
  // End of mutually exclusive fields.
}
فیلدها
performanceGoalType

enum (PerformanceGoalType)

الزامی. نوع هدف عملکرد.
الزامی. مقدار هدف عملکرد مربوط به performance_goal_type داده‌شده. در زیر فهرستی از فیلدهای متقابلاً انحصاری آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
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 تنظیم شده باشد، قابل‌اعمال است.
پایان فیلدهای متقابلاً انحصاری.

PerformanceGoalType

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

شمارشی‌ها
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 هدف عملکرد به‌صورت درصد نرخ بازدید YouTube (بازدیدهای YouTube به‌ازای هر ظهور) تنظیم می‌شود.
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE هدف عملکرد براساس درصد نرخ تکمیل صدا (تعداد گوش دادن کامل به صدا به‌ازای هر ظهور) تنظیم می‌شود.
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE هدف عملکرد براساس درصد نرخ تکمیل ویدیو (بازدیدهای کامل ویدیو به‌ازای هر ظهور) تنظیم می‌شود.
PERFORMANCE_GOAL_TYPE_OTHER هدف عملکرد روی «دیگر» تنظیم شده است.

CampaignFlight

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

نمایش JSON 
{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}
فیلدها
plannedSpendAmountMicros

string (int64 format)

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

مقدار به میکرو است. باید بزرگ‌تر یا مساوی با ۰ باشد. برای مثال، ۵۰۰۰۰۰۰۰۰ نشان‌دهنده ۵۰۰ واحد استاندارد از ارز است.
plannedDates

object (DateRange)

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

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

CampaignBudget

تنظیماتی که نحوه تخصیص بودجه پویش را کنترل می‌کنند.

نمایش 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)

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

مقدار به میکرو است. باید بزرگ‌تر از ۰ باشد. برای مثال، ۵۰۰۰۰۰۰۰۰ نشان‌دهنده ۵۰۰ واحد استاندارد از ارز است.
dateRange

object (DateRange)

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

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

enum (ExternalBudgetSource)

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

string

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

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

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

string

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

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

object (PrismaConfig)

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

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

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

ExternalBudgetSource

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

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

PrismaConfig

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

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

enum (PrismaType)

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

object (PrismaCpeCode)

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

string

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

PrismaType

انواع ممکن برای بودجه Prisma.

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

PrismaCpeCode

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

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

string

کد کارخواه Prisma.
prismaProductCode

string

کد محصول Prisma.
prismaEstimateCode

string

کد برآورد Prisma.

روش‌ها

create

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

delete

 کمپین را برای همیشه حذف می‌کند.

get

 پویشی را دریافت می‌کند.

list

 پویش‌ها را در آگهی‌دهنده فهرست می‌کند.

patch

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