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 با حداکثر اندازه 240 بایت کدگذاری شود.

entityStatus

enum ( EntityStatus )

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

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

string ( Timestamp format)

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

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

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

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

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 اقدام یا بازدید آنلاین را هدایت کنید.

CampaignFlight

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

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

string ( int64 format)

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

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

plannedDates

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)
  }
}
فیلدها
budgetId

string ( int64 format)

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

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

displayName

string

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

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

budgetUnit

enum ( BudgetUnit )

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

budgetAmountMicros

string ( int64 format)

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

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

dateRange

object ( DateRange )

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

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

externalBudgetSource

enum ( ExternalBudgetSource )

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

externalBudgetId

string

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

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

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

invoiceGroupingId

string

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

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

prismaConfig

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
}
فیلدها
prismaType

enum ( PrismaType )

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

prismaCpeCode

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
}
فیلدها
prismaClientCode

string

کد مشتری Prisma.

prismaProductCode

string

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

prismaEstimateCode

string

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

روش ها

create

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

delete

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

get

 کمپین می گیرد.

list

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

listAssignedTargetingOptions

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

patch

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