- 资源:Campaign
- CampaignGoal
- CampaignGoalType
- PerformanceGoal
- PerformanceGoalType
- CampaignFlight
- CampaignBudget
- ExternalBudgetSource
- PrismaConfig
- PrismaType
- PrismaCpeCode
- 方法
资源:广告系列
单个广告系列。
JSON 表示法 |
---|
{ "name": string, "advertiserId": string, "campaignId": string, "displayName": string, "entityStatus": enum ( |
字段 | |
---|---|
name |
仅限输出。相应广告系列的资源名称。 |
advertiserId |
仅限输出。相应广告系列所属广告客户的唯一 ID。 |
campaignId |
仅限输出。广告系列的唯一 ID。由系统分配。 |
displayName |
必需。广告系列的显示名称。 必须采用 UTF-8 编码,大小上限为 240 字节。 |
entityStatus |
必需。控制相应广告系列下的广告订单能否使用其预算并对广告资源出价。
|
updateTime |
仅限输出。上次更新广告系列时的时间戳。由系统分配。 采用 RFC 3339 标准,生成的输出将始终在末尾带 Z,并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例: |
campaignGoal |
必需。广告系列的目标。 |
campaignFlight |
必需。广告系列的计划支出和时长。 |
frequencyCap |
必需。相应广告系列的频次上限设置。 |
campaignBudgets[] |
可供相应广告系列使用的预算列表。 如果未设置此字段,则广告系列会使用无限预算。 |
CampaignGoal
用于控制广告系列目标的设置。
JSON 表示法 |
---|
{ "campaignGoalType": enum ( |
字段 | |
---|---|
campaignGoalType |
必需。广告系列目标的类型。 |
performanceGoal |
必需。广告系列的效果目标。
|
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 |
必需。效果目标的类型。 |
联合字段 performance_goal_value 。必需。与给定 performance_goal_type 对应的效果目标值。performance_goal_value 只能是下列其中一项: |
|
performanceGoalAmountMicros |
目标金额,以广告客户币种的微单位表示。 当
例如,1500000 表示 1.5 个标准货币单位。 |
performanceGoalPercentageMicros |
以微单位表示的目标百分比的十进制表示形式。 当
例如,70000 表示 7%(小数形式为 0.07)。 |
performanceGoalString |
关键绩效指标 (KPI) 字符串,可以为空。必须采用 UTF-8 编码,长度不得超过 100 个字符。 当 |
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 ( |
字段 | |
---|---|
plannedSpendAmountMicros |
广告系列在给定 金额以微单位表示。必须大于或等于 0。例如,500000000 表示 500 个标准货币单位。 |
plannedDates |
必需。广告系列的预计投放日期。它们是根据父级广告客户的时区来确定的。
|
CampaignBudget
用于控制广告系列预算分配方式的设置。
JSON 表示法 |
---|
{ "budgetId": string, "displayName": string, "budgetUnit": enum ( |
字段 | |
---|---|
budgetId |
广告系列预算的唯一 ID。由系统分配。不适用于新预算。 向 |
displayName |
必需。相应预算的显示名称。 必须采用 UTF-8 编码,大小上限为 240 字节。 |
budgetUnit |
必需。不可变。指定预算是以币种还是展示次数来衡量。 |
budgetAmountMicros |
必需。关联的广告订单期可设置的预算总额。 金额以微单位表示。必须大于 0。例如,500000000 表示 500 个标准货币单位。 |
dateRange |
必需。广告系列预算的日期范围。关联的预算细分可能具有不同的日期范围。它们是根据父级广告客户的时区来确定的。
|
externalBudgetSource |
必需。预算的外部来源。 |
externalBudgetId |
不可变。用于向外部来源标识相应预算的 ID。 如果设置了此字段,并且相应结算资料的账单明细级别设置为“预算级采购订单”,则针对相应预算投放的所有展示次数都将在账单中包含此 ID。 在相应广告系列中必须是唯一的。 |
invoiceGroupingId |
不可变。用于对要包含在同一账单中的预算进行分组的 ID。 如果设置了此字段,并且相应结算资料的账单级别设置为“预算账单分组 ID”,则所有共用同一 |
prismaConfig |
供 Mediaocean Prisma 工具使用的其他元数据。 对于 Mediaocean 预算,此字段为必填字段。 仅适用于 |
ExternalBudgetSource
广告系列预算细分的外部来源。
枚举 | |
---|---|
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED |
在此版本中,未指定或未知外部预算来源值。 |
EXTERNAL_BUDGET_SOURCE_NONE |
相应预算没有外部来源。 |
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN |
预算来源为 Mediaocean。 |
PrismaConfig
Mediaocean Prisma 工具的专用设置。
JSON 表示法 |
---|
{ "prismaType": enum ( |
字段 | |
---|---|
prismaType |
必需。Prisma 类型。 |
prismaCpeCode |
必需。Mediaocean Prisma 工具中的相关客户、产品和估算代码。 |
supplier |
必需。分配此预算的实体(DSP、网站等)。 |
PrismaType
Prisma 预算的可能类型。
枚举 | |
---|---|
PRISMA_TYPE_UNSPECIFIED |
此版本中未指定或未知类型。 |
PRISMA_TYPE_DISPLAY |
显示类型。 |
PRISMA_TYPE_SEARCH |
搜索类型。 |
PRISMA_TYPE_VIDEO |
视频类型。 |
PRISMA_TYPE_AUDIO |
音频类型。 |
PRISMA_TYPE_SOCIAL |
社交类型。 |
PRISMA_TYPE_FEE |
费用类型。 |
PrismaCpeCode
Google Payments 中心支持按此代码的组成字段进行搜索和过滤。
JSON 表示法 |
---|
{ "prismaClientCode": string, "prismaProductCode": string, "prismaEstimateCode": string } |
字段 | |
---|---|
prismaClientCode |
Prisma 客户端代码。 |
prismaProductCode |
Prisma 产品代码。 |
prismaEstimateCode |
Prisma 估算代码。 |
方法 |
|
---|---|
|
创建一个新广告系列。 |
|
永久删除广告系列。 |
|
获取宣传活动。 |
|
列出广告客户中的广告系列。 |
|
列出广告系列在各种定位类型中分配的定位选项。 |
|
更新现有广告系列。 |