REST Resource: advertisers.campaigns

{
  "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)
    }
  ]
}

string

Output only. The resource name of the campaign.

string (int64 format)

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

string (int64 format)

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

string

Required. The display name of the campaign.

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

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.

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".

object (CampaignGoal)

Required. The goal of the campaign.

object (CampaignFlight)

Required. The planned spend and duration of the campaign.

object (FrequencyCap)

Required. The frequency cap setting of the campaign.

object (CampaignBudget)

The list of budgets available to this campaign.

If this field is not set, the campaign uses an unlimited budget.

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

enum (CampaignGoalType)

Required. The type of the campaign goal.

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

{
  "plannedSpendAmountMicros": string,
  "plannedDates": {
    object (DateRange)
  }
}

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.

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.

{
  "budgetId": string,
  "displayName": string,
  "budgetUnit": enum (BudgetUnit),
  "budgetAmountMicros": string,
  "dateRange": {
    object (DateRange)
  },
  "externalBudgetSource": enum (ExternalBudgetSource),
  "externalBudgetId": string,
  "invoiceGroupingId": string,
  "prismaConfig": {
    object (PrismaConfig)
  }
}

string (int64 format)

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 campaignBudgets. Otherwise, a new ID will be generated and assigned.

string

Required. The display name of the budget.

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

enum (BudgetUnit)

Required. Immutable. Specifies whether the budget is measured in currency or impressions.

string (int64 format)

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.

object (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 startDate and endDate must be before the year 2037.

enum (ExternalBudgetSource)

Required. The external source of the budget.

string

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.

string

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 externalBudgetId sharing the same invoiceGroupingId will be grouped in the same invoice.

object (PrismaConfig)

Additional metadata for use by the Mediaocean Prisma tool.

Required for Mediaocean budgets.

Only applicable to prismaEnabled advertisers.

{
  "prismaType": enum (PrismaType),
  "prismaCpeCode": {
    object (PrismaCpeCode)
  },
  "supplier": string
}

enum (PrismaType)

Required. The Prisma type.

object (PrismaCpeCode)

Required. Relevant client, product, and estimate codes from the Mediaocean Prisma tool.

string

Required. The entity allocated this budget (DSP, site, etc.).

{
  "prismaClientCode": string,
  "prismaProductCode": string,
  "prismaEstimateCode": string
}

string

The Prisma client code.

string

The Prisma product code.

string

The Prisma estimate code.