REST Resource: advertisers.campaigns

Resource: Campaign

A single campaign.

JSON representation 
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "campaignGoal": {
    object (CampaignGoal)
  },
  "campaignFlight": {
    object (CampaignFlight)
  },
  "frequencyCap": {
    object (FrequencyCap)
  }
}
Fields
name

string

Output only. The resource name of the campaign.
advertiserId

string (int64 format)

Output only. The unique ID of the advertiser the campaign belongs to.
campaignId

string (int64 format)

Output only. The unique ID of the campaign. Assigned by the system.
displayName

string

Required. The display name of the campaign.

Must be UTF-8 encoded with a maximum size of 240 bytes.
entityStatus

enum (EntityStatus)

Required. Controls whether or not the insertion orders under this campaign can spend their budgets and bid on inventory.

  • Accepted values are ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED, and ENTITY_STATUS_PAUSED.
  • For campaigns.create method, ENTITY_STATUS_ARCHIVED is not allowed.
updateTime

string (Timestamp format)

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: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
campaignGoal

object (CampaignGoal)

Required. The goal of the campaign.
campaignFlight

object (CampaignFlight)

Required. The planned spend and duration of the campaign.
frequencyCap

object (FrequencyCap)

Required. The frequency cap setting of the campaign.

CampaignGoal

Settings that control the goal of a campaign.

JSON representation 
{
  "campaignGoalType": enum (CampaignGoalType),
  "performanceGoal": {
    object (PerformanceGoal)
  }
}
Fields
campaignGoalType

enum (CampaignGoalType)

Required. The type of the campaign goal.
performanceGoal

object (PerformanceGoal)

Required. The performance goal of the campaign.

Acceptable values for performanceGoalType are:

  • 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

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 (DateRange)
  }
}
Fields
plannedSpendAmountMicros

string (int64 format)

The amount the campaign is expected to spend for its given plannedDates. This will not limit serving, but will be used for tracking spend in the DV360 UI.

The amount is in micros. Must be greater than or equal to 0. For example, 500000000 represents 500 standard units of the currency.
plannedDates

object (DateRange)

Required. The dates that the campaign is expected to run. They are resolved relative to the parent advertiser's time zone.

  • The dates specified here will not affect serving. They are used to generate alerts and warnings. For example, if the flight date of any child insertion order is outside the range of these dates, the user interface will show a warning.
  • startDate is required and must be the current date or later.
  • endDate is optional. If specified, it must be the startDate or later.
  • Any specified date must be before the year 2037.

Methods

create

 Creates a new campaign.

delete

 Permanently deletes a campaign.

get

 Gets a campaign.

list

 Lists campaigns in an advertiser.

patch

 Updates an existing campaign.