The Campaign Manager 360 API v3.4 is deprecated and will be sunset on Jan 10th, 2022. All users must migrate to a newer API version by that date.

REST Resource: campaigns

Resource: Campaign

Contains properties of a Campaign Manager campaign.

JSON representation
{
  "id": string,
  "accountId": string,
  "subaccountId": string,
  "advertiserId": string,
  "advertiserGroupId": string,
  "name": string,
  "archived": boolean,
  "startDate": string,
  "endDate": string,
  "comment": string,
  "billingInvoiceCode": string,
  "audienceSegmentGroups": [
    {
      object (AudienceSegmentGroup)
    }
  ],
  "eventTagOverrides": [
    {
      object (EventTagOverride)
    }
  ],
  "clickThroughUrlSuffixProperties": {
    object (ClickThroughUrlSuffixProperties)
  },
  "defaultClickThroughEventTagProperties": {
    object (DefaultClickThroughEventTagProperties)
  },
  "creativeGroupIds": [
    string
  ],
  "creativeOptimizationConfiguration": {
    object (CreativeOptimizationConfiguration)
  },
  "additionalCreativeOptimizationConfigurations": [
    {
      object (CreativeOptimizationConfiguration)
    }
  ],
  "kind": string,
  "createInfo": {
    object (LastModifiedInfo)
  },
  "lastModifiedInfo": {
    object (LastModifiedInfo)
  },
  "traffickerEmails": [
    string
  ],
  "idDimensionValue": {
    object (DimensionValue)
  },
  "advertiserIdDimensionValue": {
    object (DimensionValue)
  },
  "externalId": string,
  "nielsenOcrEnabled": boolean,
  "adBlockingConfiguration": {
    object (AdBlockingConfiguration)
  },
  "defaultLandingPageId": string
}
Fields
id

string (int64 format)

ID of this campaign. This is a read-only auto-generated field.

accountId

string (int64 format)

Account ID of this campaign. This is a read-only field that can be left blank.

subaccountId

string (int64 format)

Subaccount ID of this campaign. This is a read-only field that can be left blank.

advertiserId

string (int64 format)

Advertiser ID of this campaign. This is a required field.

advertiserGroupId

string (int64 format)

Advertiser group ID of the associated advertiser.

name

string

Name of this campaign. This is a required field and must be less than 256 characters long and unique among campaigns of the same advertiser.

archived

boolean

Whether this campaign has been archived.

startDate

string

Date on which the campaign starts running. The start date can be any date. The hours, minutes, and seconds of the start date should not be set, as doing so will result in an error. This is a required field.

endDate

string

Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field.

comment

string

Arbitrary comments about this campaign. Must be less than 256 characters long.

billingInvoiceCode

string

Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.

audienceSegmentGroups[]

object (AudienceSegmentGroup)

Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.

eventTagOverrides[]

object (EventTagOverride)

Overrides that can be used to activate or deactivate advertiser event tags.

clickThroughUrlSuffixProperties

object (ClickThroughUrlSuffixProperties)

Click-through URL suffix override properties for this campaign.

defaultClickThroughEventTagProperties

object (DefaultClickThroughEventTagProperties)

Click-through event tag ID override properties for this campaign.

creativeGroupIds[]

string (int64 format)

accountPermissionGroups.list of creative group IDs that are assigned to the campaign.

creativeOptimizationConfiguration

object (CreativeOptimizationConfiguration)

Creative optimization configuration for the campaign.

additionalCreativeOptimizationConfigurations[]

object (CreativeOptimizationConfiguration)

Additional creative optimization configurations for the campaign.

kind

string

Identifies what kind of resource this is. Value: the fixed string

"dfareporting#campaign"

.

createInfo

object (LastModifiedInfo)

Information about the creation of this campaign. This is a read-only field.

lastModifiedInfo

object (LastModifiedInfo)

Information about the most recent modification of this campaign. This is a read-only field.

traffickerEmails[]

string

Campaign trafficker contact emails.

idDimensionValue

object (DimensionValue)

Dimension value for the ID of this campaign. This is a read-only, auto-generated field.

advertiserIdDimensionValue

object (DimensionValue)

Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.

externalId

string

External ID for this campaign.

nielsenOcrEnabled

boolean

Whether Nielsen reports are enabled for this campaign.

adBlockingConfiguration

object (AdBlockingConfiguration)

Ad blocking settings for this campaign.

defaultLandingPageId

string (int64 format)

The default landing page ID for this campaign.

AudienceSegmentGroup

Audience Segment Group.

JSON representation
{
  "id": string,
  "name": string,
  "audienceSegments": [
    {
      object (AudienceSegment)
    }
  ]
}
Fields
id

string (int64 format)

ID of this audience segment group. This is a read-only, auto-generated field.

name

string

Name of this audience segment group. This is a required field and must be less than 65 characters long.

audienceSegments[]

object (AudienceSegment)

Audience segments assigned to this group. The number of segments must be between 2 and 100.

AudienceSegment

Audience Segment.

JSON representation
{
  "id": string,
  "name": string,
  "allocation": integer
}
Fields
id

string (int64 format)

ID of this audience segment. This is a read-only, auto-generated field.

name

string

Name of this audience segment. This is a required field and must be less than 65 characters long.

allocation

integer

Weight allocated to this segment. The weight assigned will be understood in proportion to the weights assigned to other segments in the same segment group. Acceptable values are

1

to

1000

, inclusive.

CreativeOptimizationConfiguration

Creative optimization settings.

JSON representation
{
  "optimizationModel": enum (OptimizationModel),
  "optimizationActivitys": [
    {
      object (OptimizationActivity)
    }
  ],
  "id": string,
  "name": string
}
Fields
optimizationModel

enum (OptimizationModel)

Optimization model for this configuration.

optimizationActivitys[]

object (OptimizationActivity)

accountPermissionGroups.list of optimization activities associated with this configuration.

id

string (int64 format)

ID of this creative optimization config. This field is auto-generated when the campaign is inserted or updated. It can be null for existing campaigns.

name

string

Name of this creative optimization config. This is a required field and must be less than 129 characters long.

OptimizationModel

Enums
CLICK
POST_CLICK
POST_IMPRESSION
POST_CLICK_AND_IMPRESSION
VIDEO_COMPLETION

OptimizationActivity

Creative optimization activity.

JSON representation
{
  "floodlightActivityId": string,
  "weight": integer,
  "floodlightActivityIdDimensionValue": {
    object (DimensionValue)
  }
}
Fields
floodlightActivityId

string (int64 format)

Floodlight activity ID of this optimization activity. This is a required field.

weight

integer

Weight associated with this optimization. The weight assigned will be understood in proportion to the weights assigned to the other optimization activities. Value must be greater than or equal to

1

.

floodlightActivityIdDimensionValue

object (DimensionValue)

Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.

AdBlockingConfiguration

Campaign ad blocking settings.

JSON representation
{
  "enabled": boolean,
  "overrideClickThroughUrl": boolean,
  "clickThroughUrl": string,
  "creativeBundleId": string
}
Fields
enabled

boolean

Whether this campaign has enabled ad blocking. When true, ad blocking is enabled for placements in the campaign, but this may be overridden by site and placement settings. When false, ad blocking is disabled for all placements under the campaign, regardless of site and placement settings.

overrideClickThroughUrl

boolean

Whether the brand-neutral ad's click-through URL comes from the campaign's creative bundle or the override URL. Must be set to true if ad blocking is enabled and no creative bundle is configured.

clickThroughUrl

string

Click-through URL used by brand-neutral ads. This is a required field when

overrideClickThroughUrl

is set to true.

creativeBundleId

string (int64 format)

ID of a creative bundle to use for this campaign. If set, brand-neutral ads will select creatives from this bundle. Otherwise, a default transparent pixel will be used.

Methods

get

Gets one campaign by ID.

insert

Inserts a new campaign.

list

Retrieves a list of campaigns, possibly filtered.

patch

Updates an existing campaign.

update

Updates an existing campaign.