Campaigns

For a list of methods for this resource, see the end of this page.

Resource representations

Contains properties of a Campaign Manager campaign.

{
  "kind": "dfareporting#campaign",
  "id": long,
  "idDimensionValue": dimensionValues Resource,
  "accountId": long,
  "subaccountId": long,
  "advertiserId": long,
  "advertiserIdDimensionValue": dimensionValues Resource,
  "advertiserGroupId": long,
  "name": string,
  "archived": boolean,
  "startDate": date,
  "endDate": date,
  "comment": string,
  "billingInvoiceCode": string,
  "audienceSegmentGroups": [
    {
      "id": long,
      "name": string,
      "audienceSegments": [
        {
          "id": long,
          "name": string,
          "allocation": integer
        }
      ]
    }
  ],
  "eventTagOverrides": [
    {
      "id": long,
      "enabled": boolean
    }
  ],
  "clickThroughUrlSuffixProperties": {
    "overrideInheritedSuffix": boolean,
    "clickThroughUrlSuffix": string
  },
  "defaultClickThroughEventTagProperties": {
    "overrideInheritedEventTag": boolean,
    "defaultClickThroughEventTagId": long
  },
  "creativeGroupIds": [
    long
  ],
  "creativeOptimizationConfiguration": {
    "optimizationModel": string,
    "optimizationActivitys": [
      {
        "floodlightActivityId": long,
        "floodlightActivityIdDimensionValue": dimensionValues Resource,
        "weight": integer
      }
    ],
    "id": long,
    "name": string
  },
  "additionalCreativeOptimizationConfigurations": [
    {
      "optimizationModel": string,
      "optimizationActivitys": [
        {
          "floodlightActivityId": long,
          "floodlightActivityIdDimensionValue": dimensionValues Resource,
          "weight": integer
        }
      ],
      "id": long,
      "name": string
    }
  ],
  "createInfo": {
    "time": long
  },
  "lastModifiedInfo": {
    "time": long
  },
  "traffickerEmails": [
    string
  ],
  "externalId": string,
  "nielsenOcrEnabled": boolean,
  "adBlockingConfiguration": {
    "enabled": boolean,
    "overrideClickThroughUrl": boolean,
    "clickThroughUrl": string,
    "creativeBundleId": long
  },
  "defaultLandingPageId": long
}

Property name	Value	Description
`accountId`	`long`	Account ID of this campaign. This is a read-only field that can be left blank.
`adBlockingConfiguration`	`nested object`	Ad blocking settings for this campaign.
`adBlockingConfiguration.clickThroughUrl`	`string`	Click-through URL used by brand-neutral ads. This is a required field when `overrideClickThroughUrl` is set to true.
`adBlockingConfiguration.creativeBundleId`	`long`	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.
`adBlockingConfiguration.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.
`adBlockingConfiguration.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.
`additionalCreativeOptimizationConfigurations[]`	`list`	Additional creative optimization configurations for the campaign.
`additionalCreativeOptimizationConfigurations[].id`	`long`	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.
`additionalCreativeOptimizationConfigurations[].name`	`string`	Name of this creative optimization config. This is a required field and must be less than 129 characters long.
`additionalCreativeOptimizationConfigurations[].optimizationActivitys[]`	`list`	List of optimization activities associated with this configuration.
`additionalCreativeOptimizationConfigurations[].optimizationActivitys[].floodlightActivityId`	`long`	Floodlight activity ID of this optimization activity. This is a required field.
`additionalCreativeOptimizationConfigurations[].optimizationActivitys[].floodlightActivityIdDimensionValue`	`nested object`	Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
`additionalCreativeOptimizationConfigurations[].optimizationActivitys[].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`.
`additionalCreativeOptimizationConfigurations[].optimizationModel`	`string`	Optimization model for this configuration. Acceptable values are: "`CLICK`" "`POST_CLICK`" "`POST_CLICK_AND_IMPRESSION`" "`POST_IMPRESSION`" "`VIDEO_COMPLETION`"
`advertiserGroupId`	`long`	Advertiser group ID of the associated advertiser.
`advertiserId`	`long`	Advertiser ID of this campaign. This is a required field.
`advertiserIdDimensionValue`	`nested object`	Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
`archived`	`boolean`	Whether this campaign has been archived.
`audienceSegmentGroups[]`	`list`	Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
`audienceSegmentGroups[].audienceSegments[]`	`list`	Audience segments assigned to this group. The number of segments must be between 2 and 100.
`audienceSegmentGroups[].audienceSegments[].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.
`audienceSegmentGroups[].audienceSegments[].id`	`long`	ID of this audience segment. This is a read-only, auto-generated field.
`audienceSegmentGroups[].audienceSegments[].name`	`string`	Name of this audience segment. This is a required field and must be less than 65 characters long.
`audienceSegmentGroups[].id`	`long`	ID of this audience segment group. This is a read-only, auto-generated field.
`audienceSegmentGroups[].name`	`string`	Name of this audience segment group. This is a required field and must be less than 65 characters long.
`billingInvoiceCode`	`string`	Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign.
`clickThroughUrlSuffixProperties`	`nested object`	Click-through URL suffix override properties for this campaign.
`clickThroughUrlSuffixProperties.clickThroughUrlSuffix`	`string`	Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
`clickThroughUrlSuffixProperties.overrideInheritedSuffix`	`boolean`	Whether this entity should override the inherited click-through URL suffix with its own defined value.
`comment`	`string`	Arbitrary comments about this campaign. Must be less than 256 characters long.
`createInfo`	`nested object`	Information about the creation of this campaign. This is a read-only field.
`createInfo.time`	`long`	Timestamp of the last change in milliseconds since epoch.
`creativeGroupIds[]`	`list`	List of creative group IDs that are assigned to the campaign.
`creativeOptimizationConfiguration`	`nested object`	Creative optimization configuration for the campaign.
`creativeOptimizationConfiguration.id`	`long`	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.
`creativeOptimizationConfiguration.name`	`string`	Name of this creative optimization config. This is a required field and must be less than 129 characters long.
`creativeOptimizationConfiguration.optimizationActivitys[]`	`list`	List of optimization activities associated with this configuration.
`creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityId`	`long`	Floodlight activity ID of this optimization activity. This is a required field.
`creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue`	`nested object`	Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
`creativeOptimizationConfiguration.optimizationActivitys[].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`.
`creativeOptimizationConfiguration.optimizationModel`	`string`	Optimization model for this configuration. Acceptable values are: "`CLICK`" "`POST_CLICK`" "`POST_CLICK_AND_IMPRESSION`" "`POST_IMPRESSION`" "`VIDEO_COMPLETION`"
`defaultClickThroughEventTagProperties`	`nested object`	Click-through event tag ID override properties for this campaign.
`defaultClickThroughEventTagProperties.defaultClickThroughEventTagId`	`long`	ID of the click-through event tag to apply to all ads in this entity's scope.
`defaultClickThroughEventTagProperties.overrideInheritedEventTag`	`boolean`	Whether this entity should override the inherited default click-through event tag with its own defined value.
`defaultLandingPageId`	`long`	The default landing page ID for this campaign.
`endDate`	`date`	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.
`eventTagOverrides[]`	`list`	Overrides that can be used to activate or deactivate advertiser event tags.
`eventTagOverrides[].enabled`	`boolean`	Whether this override is enabled.
`eventTagOverrides[].id`	`long`	ID of this event tag override. This is a read-only, auto-generated field.
`externalId`	`string`	External ID for this campaign.
`id`	`long`	ID of this campaign. This is a read-only auto-generated field.
`idDimensionValue`	`nested object`	Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
`kind`	`string`	Identifies what kind of resource this is. Value: the fixed string `"dfareporting#campaign"`.
`lastModifiedInfo`	`nested object`	Information about the most recent modification of this campaign. This is a read-only field.
`lastModifiedInfo.time`	`long`	Timestamp of the last change in milliseconds since epoch.
`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.
`nielsenOcrEnabled`	`boolean`	Whether Nielsen reports are enabled for this campaign.
`startDate`	`date`	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.
`subaccountId`	`long`	Subaccount ID of this campaign. This is a read-only field that can be left blank.
`traffickerEmails[]`	`list`	Campaign trafficker contact emails.

Methods

get: Gets one campaign by ID.
insert: Inserts a new campaign.
list: Retrieves a list of campaigns, possibly filtered. This method supports paging.
patch: Updates an existing campaign. This method supports patch semantics.
update: Updates an existing campaign.