- Resource: Campaign
- CampaignGoal
- CampaignGoalType
- PerformanceGoal
- PerformanceGoalType
- CampaignFlight
- CampaignBudget
- ExternalBudgetSource
- PrismaConfig
- PrismaType
- PrismaCpeCode
- Methods
Resource: Campaign
A single campaign.
JSON representation |
---|
{ "name": string, "advertiserId": string, "campaignId": string, "displayName": string, "entityStatus": enum ( |
Fields | |
---|---|
name |
Output only. The resource name of the campaign. |
advertiserId |
Output only. The unique ID of the advertiser the campaign belongs to. |
campaignId |
Output only. The unique ID of the campaign. Assigned by the system. |
displayName |
Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes. |
entityStatus |
Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory.
|
updateTime |
Output only. The timestamp when the campaign was last updated. Assigned by the system. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
campaignGoal |
Required. The goal of the campaign. |
campaignFlight |
Required. The planned spend and duration of the campaign. |
frequencyCap |
Required. The frequency cap setting of the campaign. |
campaignBudgets[] |
The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget. |
CampaignGoal
Settings that control the goal of a campaign.
JSON representation |
---|
{ "campaignGoalType": enum ( |
Fields | |
---|---|
campaignGoalType |
Required. The type of the campaign goal. |
performanceGoal |
Required. The performance goal of the campaign. Acceptable values for
|
CampaignGoalType
Possible types of campaign goals.
Enums | |
---|---|
CAMPAIGN_GOAL_TYPE_UNSPECIFIED |
Goal value is not specified or unknown in this version. |
CAMPAIGN_GOAL_TYPE_APP_INSTALL |
Drive app installs or engagements. |
CAMPAIGN_GOAL_TYPE_BRAND_AWARENESS |
Raise awareness of a brand or product. |
CAMPAIGN_GOAL_TYPE_OFFLINE_ACTION |
Drive offline or in-store sales. |
CAMPAIGN_GOAL_TYPE_ONLINE_ACTION |
Drive online action or visits. |
PerformanceGoal
Settings that control the performance goal of a campaign.
JSON representation |
---|
{ "performanceGoalType": enum ( |
Fields | |
---|---|
performanceGoalType |
Required. The type of the performance goal. |
Union field performance_goal_value . Required. The performance goal value corresponding to a given performance_goal_type . performance_goal_value can be only one of the following: |
|
performanceGoalAmountMicros |
The goal amount, in micros of the advertiser's currency. Applicable when
For example 1500000 represents 1.5 standard units of the currency. |
performanceGoalPercentageMicros |
The decimal representation of the goal percentage in micros. Applicable when
For example, 70000 represents 7% (decimal 0.07). |
performanceGoalString |
A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when |
PerformanceGoalType
Possible types of performance goals.
Enums | |
---|---|
PERFORMANCE_GOAL_TYPE_UNSPECIFIED |
Performance goal type is not specified or is unknown in this version. |
PERFORMANCE_GOAL_TYPE_CPM |
The performance goal is set in CPM (cost per mille). |
PERFORMANCE_GOAL_TYPE_CPC |
The performance goal is set in CPC (cost per click). |
PERFORMANCE_GOAL_TYPE_CPA |
The performance goal is set in CPA (cost per action). |
PERFORMANCE_GOAL_TYPE_CTR |
The performance goal is set in CTR (click-through rate) percentage. |
PERFORMANCE_GOAL_TYPE_VIEWABILITY |
The performance goal is set in Viewability percentage. |
PERFORMANCE_GOAL_TYPE_CPIAVC |
The performance goal is set as CPIAVC (cost per impression audible and visible at completion). |
PERFORMANCE_GOAL_TYPE_CPE |
The performance goal is set in CPE (cost per engagement). |
PERFORMANCE_GOAL_TYPE_CLICK_CVR |
The performance goal is set in click conversion rate (conversions per click) percentage. |
PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR |
The performance goal is set in impression conversion rate (conversions per impression) percentage. |
PERFORMANCE_GOAL_TYPE_VCPM |
The performance goal is set in VCPM (cost per thousand viewable impressions). |
PERFORMANCE_GOAL_TYPE_VTR |
The performance goal is set in YouTube view rate (YouTube views per impression) percentage. |
PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE |
The performance goal is set in audio completion rate (complete audio listens per impression) percentage. |
PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE |
The performance goal is set in video completion rate (complete video views per impression) percentage. |
PERFORMANCE_GOAL_TYPE_OTHER |
The performance goal is set to Other. |
CampaignFlight
Settings that track the planned spend and duration of a campaign.
JSON representation |
---|
{
"plannedSpendAmountMicros": string,
"plannedDates": {
object ( |
Fields | |
---|---|
plannedSpendAmountMicros |
The amount the campaign is expected to spend for its given The amount is in micros. Must be greater than or equal to 0. For example, 500000000 represents 500 standard units of the currency. |
plannedDates |
Required. The dates that the campaign is expected to run. They are resolved relative to the parent advertiser's time zone.
|
CampaignBudget
Settings that control how the campaign budget is allocated.
JSON representation |
---|
{ "budgetId": string, "displayName": string, "budgetUnit": enum ( |
Fields | |
---|---|
budgetId |
The unique ID of the campaign budget. Assigned by the system. Do not set for new budgets. Must be included when updating or adding budgets to |
displayName |
Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes. |
budgetUnit |
Required. Immutable. Specifies whether the budget is measured in currency or impressions. |
budgetAmountMicros |
Required. The total amount the linked insertion order segments can budget. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. |
dateRange |
Required. The date range for the campaign budget. Linked budget segments may have a different date range. They are resolved relative to the parent advertiser's time zone. Both |
externalBudgetSource |
Required. The external source of the budget. |
externalBudgetId |
Immutable. The ID identifying this budget to the external source. If this field is set and the invoice detail level of the corresponding billing profile is set to "Budget level PO", all impressions served against this budget will include this ID on the invoice. Must be unique under the campaign. |
invoiceGroupingId |
Immutable. The ID used to group budgets to be included the same invoice. If this field is set and the invoice level of the corresponding billing profile is set to "Budget invoice grouping ID", all |
prismaConfig |
Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to |
ExternalBudgetSource
External source for a campaign budget segment.
Enums | |
---|---|
EXTERNAL_BUDGET_SOURCE_UNSPECIFIED |
External budget source value is not specified or unknown in this version. |
EXTERNAL_BUDGET_SOURCE_NONE |
Budget has no external source. |
EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN |
Budget source is Mediaocean. |
PrismaConfig
Settings specific to the Mediaocean Prisma tool.
JSON representation |
---|
{ "prismaType": enum ( |
Fields | |
---|---|
prismaType |
Required. The Prisma type. |
prismaCpeCode |
Required. Relevant client, product, and estimate codes from the Mediaocean Prisma tool. |
supplier |
Required. The entity allocated this budget (DSP, site, etc.). |
PrismaType
Possible types for a Prisma budget.
Enums | |
---|---|
PRISMA_TYPE_UNSPECIFIED |
Type is not specified or unknown in this version. |
PRISMA_TYPE_DISPLAY |
Display type. |
PRISMA_TYPE_SEARCH |
Search type. |
PRISMA_TYPE_VIDEO |
Video type. |
PRISMA_TYPE_AUDIO |
Audio type. |
PRISMA_TYPE_SOCIAL |
Social type. |
PRISMA_TYPE_FEE |
Fee type. |
PrismaCpeCode
Google Payments Center supports searching and filtering on the component fields of this code.
JSON representation |
---|
{ "prismaClientCode": string, "prismaProductCode": string, "prismaEstimateCode": string } |
Fields | |
---|---|
prismaClientCode |
The Prisma client code. |
prismaProductCode |
The Prisma product code. |
prismaEstimateCode |
The Prisma estimate code. |
Methods |
|
---|---|
|
Creates a new campaign. |
|
Permanently deletes a campaign. |
|
Gets a campaign. |
|
Lists campaigns in an advertiser. |
|
Lists assigned targeting options of a campaign across targeting types. |
|
Updates an existing campaign. |