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)

仅限输出。广告系列所属广告客户的唯一 ID。
campaignId

string (int64 format)

仅限输出。广告系列的唯一 ID。由系统分配。
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，即“祖鲁时”）格式，精确到纳秒，最多九个小数位。示例："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

可能的广告系列目标类型。

枚举
CAMPAIGN_GOAL_TYPE_UNSPECIFIED 此版本中未指定目标值或目标值未知。
CAMPAIGN_GOAL_TYPE_APP_INSTALL 提高应用安装量或互动度。
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS 提高品牌或产品的认知度。
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION 提高线下或实体店销售额。
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION 提升在线操作量或访问量。

PerformanceGoal

用于控制广告系列效果目标的设置。

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

例如，1500000 表示 1.5 个标准货币单位。
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

例如，70000 表示 7%（十进制 0.07）。
performanceGoalString

string

关键绩效指标 (KPI) 字符串，可以为空。必须采用 UTF-8 编码，长度不得超过 100 个字符。

将 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 效果目标是根据每次观看费用而设置的。
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 界面中的支出。

金额以微单位表示。必须大于或等于 0。例如，500000000 代表该货币的 500 个标准单位。
plannedDates

object (DateRange)

必需。广告系列预计投放的日期。它们会根据父级广告客户的时区进行解析。

  • 此处指定的日期不会影响广告投放。用于生成提醒和警告。例如，如果任何子级广告订单的排期不在这些日期范围之内，界面就会显示警告。
  • startDate 是必需的，且必须为当前日期或之后的日期。
  • endDate 为可选项。如果指定，则必须是 startDate 或更高版本。
  • 任何指定日期都必须早于 2037 年。

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)

广告系列预算的唯一 ID。由系统分配。请勿为新预算设置。

在为“campaignBudgets”更新预算或添加预算时，必须添加此项。否则，系统会生成并分配一个新 ID。
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

不可变。向外部来源标识此预算的 ID。

如果设置了此字段，并且相应结算资料的账单明细级别设置为“预算级采购订单”，则根据此预算投放的所有展示次数都会在账单上包含此 ID。

在广告系列中必须是唯一的。
invoiceGroupingId

string

不可变。用于将要纳入同一账单的预算分组的 ID。

如果设置了此字段，并且相应结算资料的账单级别设为“预算账单分组 ID”，则共享同一 invoiceGroupingId 的所有 externalBudgetId 都将归入同一账单。
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

 列出广告客户名下的广告系列。

listAssignedTargetingOptions

 列出为广告系列的各个定位类型分配的定位选项。

patch

 更新现有广告系列。