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

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

advertiser Id

string ( int64 format)

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

campaign Id

string ( int64 format)

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

display Name

string

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

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

entity Status

enum ( EntityStatus )

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

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

string ( Timestamp format)

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

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

campaign Goal

object ( CampaignGoal )

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

campaign Flight

object ( CampaignFlight )

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

frequency Cap

object ( FrequencyCap )

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

campaign Budgets[]

object ( CampaignBudget )

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

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

CampaignGoal

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

نمایندگی JSON 
{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}
فیلدها
campaign Goal Type

enum ( CampaignGoalType )

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

performance Goal

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

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

Enums
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.
}
فیلدها
performance Goal Type

enum ( PerformanceGoalType )

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

performance_goal_value فیلد اتحادیه. مورد نیاز. مقدار هدف عملکرد مربوط به یک performance_goal_type معین. performance_goal_value تنها می تواند یکی از موارد زیر باشد:
performance Goal Amount Micros

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 واحد استاندارد واحد پول است.

performance Goal Percentage Micros

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

performance Goal String

string

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

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

PerformanceGoalType

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

Enums
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 (بازدیدهای یوتیوب در هر نمایش) تنظیم شده است.
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE هدف عملکرد بر حسب درصد میزان تکمیل صدا (شنوایی کامل صوتی در هر نمایش) تنظیم شده است.
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE هدف عملکرد بر اساس درصد تکمیل ویدیو (بازدید کامل ویدیو در هر نمایش) تنظیم شده است.
PERFORMANCE_GOAL_TYPE_OTHER هدف عملکرد روی Other تنظیم شده است.

CampaignFlight

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

نمایندگی JSON 
{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}
فیلدها
planned Spend Amount Micros

string ( int64 format)

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

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

planned Dates

object ( DateRange )

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

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

بودجه کمپین

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

نمایندگی JSON 
{
  "budgetId": string,
  "displayName": string,
  "budgetUnit": enum (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}
فیلدها
budget Id

string ( int64 format)

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

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

display Name

string

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

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

budget Unit

enum ( BudgetUnit )

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

budget Amount Micros

string ( int64 format)

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

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

date Range

object ( DateRange )

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

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

external Budget Source

enum ( ExternalBudgetSource )

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

external Budget Id

string

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

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

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

invoice Grouping Id

string

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

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

prisma Config

object ( PrismaConfig )

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

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

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

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

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

Enums
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
}
فیلدها
prisma Type

enum ( PrismaType )

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

prisma Cpe Code

object ( PrismaCpeCode )

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

supplier

string

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

PrismaType

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

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

PrismaCpeCode

Google Payments Center از جستجو و فیلتر کردن فیلدهای مؤلفه این کد پشتیبانی می کند.

نمایندگی JSON 
{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}
فیلدها
prisma Client Code

string

کد مشتری Prisma.

prisma Product Code

string

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

prisma Estimate Code

string

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

روش ها

create

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

delete

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

get

 کمپین دریافت می کند.

list

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

list Assigned Targeting Options

 گزینه های هدف گذاری اختصاص داده شده یک کمپین را در بین انواع هدف فهرست می کند.

patch

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