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. |
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. |
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.
|
Methods |
|
---|---|
|
Lists assigned targeting options of a campaign across targeting types. |
|
Creates a new campaign. |
|
Permanently deletes a campaign. |
|
Gets a campaign. |
|
Lists campaigns in an advertiser. |
|
Updates an existing campaign. |