profileId INTEGER Required

User profile ID associated with this request

advertiserGroupIds INTEGER

Select only campaigns whose advertisers belong to these advertiser groups

advertiserIds INTEGER

Select only campaigns that belong to these advertisers

archived BOOLEAN

Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns

atLeastOneOptimizationActivity BOOLEAN

Select only campaigns that have at least one optimization activity

excludedIds INTEGER

Exclude campaigns with these IDs

ids INTEGER

Select only campaigns with these IDs

maxResults INTEGER

Maximum number of results to return

overriddenEventTagId INTEGER

Select only campaigns that have overridden this event tag ID

pageToken STRING

Value of the nextPageToken from the previous result page

searchString STRING

Allows searching for campaigns by name or ID. Wildcards () are allowed. For example, "campaign2015" will return campaigns with names like "campaign June 2015", "campaign April 2015", or simply "campaign 2015". Most of the searches also add wildcards implicitly at the start and the end of the search string. For example, a search string of "campaign" will match campaigns with name "my campaign", "campaign 2015", or simply "campaign"

sortField ENUMERATION

Field by which to sort the list

sortOrder ENUMERATION

Order of sorted results

subaccountId INTEGER

Select only campaigns that belong to this subaccount

campaigns[] OBJECT

Contains properties of a Campaign Manager campaign

campaigns[].accountId INTEGER

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

campaigns[].adBlockingConfiguration OBJECT

Campaign ad blocking settings

campaigns[].adBlockingConfiguration.clickThroughUrl STRING

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

campaigns[].adBlockingConfiguration.creativeBundleId INTEGER

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

campaigns[].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

campaigns[].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

campaigns[].additionalCreativeOptimizationConfigurations[] OBJECT

Creative optimization settings

campaigns[].additionalCreativeOptimizationConfigurations[].id INTEGER

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

campaigns[].additionalCreativeOptimizationConfigurations[].name STRING

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

campaigns[].additionalCreativeOptimizationConfigurations[].optimizationModel ENUMERATION

Optimization model for this configuration

campaigns[].advertiserGroupId INTEGER

Advertiser group ID of the associated advertiser

campaigns[].advertiserId INTEGER

Advertiser ID of this campaign. This is a required field

campaigns[].advertiserIdDimensionValue OBJECT

Represents a DimensionValue resource

campaigns[].advertiserIdDimensionValue.dimensionName STRING

The name of the dimension

campaigns[].advertiserIdDimensionValue.etag STRING

The eTag of this response for caching purposes

campaigns[].advertiserIdDimensionValue.id STRING

The ID associated with the value if available

campaigns[].advertiserIdDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

campaigns[].advertiserIdDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

campaigns[].advertiserIdDimensionValue.value STRING

The value of the dimension

campaigns[].archived BOOLEAN

Whether this campaign has been archived

campaigns[].audienceSegmentGroups[] OBJECT

Audience Segment Group

campaigns[].audienceSegmentGroups[].id INTEGER

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

campaigns[].audienceSegmentGroups[].name STRING

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

campaigns[].billingInvoiceCode STRING

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

campaigns[].clickThroughUrlSuffixProperties OBJECT

Click Through URL Suffix settings

campaigns[].clickThroughUrlSuffixProperties.clickThroughUrlSuffix STRING

Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long

campaigns[].clickThroughUrlSuffixProperties.overrideInheritedSuffix BOOLEAN

Whether this entity should override the inherited click-through URL suffix with its own defined value

campaigns[].comment STRING

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

campaigns[].createInfo OBJECT

Modification timestamp

campaigns[].createInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

campaigns[].creativeGroupIds[] INTEGER

campaigns[].creativeOptimizationConfiguration OBJECT

Creative optimization settings

campaigns[].creativeOptimizationConfiguration.id INTEGER

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

campaigns[].creativeOptimizationConfiguration.name STRING

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

campaigns[].creativeOptimizationConfiguration.optimizationActivitys[] OBJECT

Creative optimization activity

campaigns[].creativeOptimizationConfiguration.optimizationModel ENUMERATION

Optimization model for this configuration

campaigns[].defaultClickThroughEventTagProperties OBJECT

Properties of inheriting and overriding the default click-through event tag. A campaign may override the event tag defined at the advertiser level, and an ad may also override the campaign's setting further

campaigns[].defaultClickThroughEventTagProperties.defaultClickThroughEventTagId INTEGER

ID of the click-through event tag to apply to all ads in this entity's scope

campaigns[].defaultClickThroughEventTagProperties.overrideInheritedEventTag BOOLEAN

Whether this entity should override the inherited default click-through event tag with its own defined value

campaigns[].defaultLandingPageId INTEGER

The default landing page ID for this campaign

campaigns[].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

campaigns[].eventTagOverrides[] OBJECT

Event tag override information

campaigns[].eventTagOverrides[].enabled BOOLEAN

Whether this override is enabled

campaigns[].eventTagOverrides[].id INTEGER

ID of this event tag override. This is a read-only, auto-generated field

campaigns[].externalId STRING

External ID for this campaign

campaigns[].id INTEGER

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

campaigns[].idDimensionValue OBJECT

Represents a DimensionValue resource

campaigns[].idDimensionValue.dimensionName STRING

The name of the dimension

campaigns[].idDimensionValue.etag STRING

The eTag of this response for caching purposes

campaigns[].idDimensionValue.id STRING

The ID associated with the value if available

campaigns[].idDimensionValue.kind STRING

The kind of resource this is, in this case dfareporting#dimensionValue

campaigns[].idDimensionValue.matchType ENUMERATION

Determines how the 'value' field is matched when filtering. If not specified, defaults to EXACT. If set to WILDCARD_EXPRESSION, '' is allowed as a placeholder for variable length character sequences, and it can be escaped with a backslash. Note, only paid search dimensions ('dfa:paidSearch') allow a matchType other than EXACT

campaigns[].idDimensionValue.value STRING

The value of the dimension

campaigns[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign"

campaigns[].lastModifiedInfo OBJECT

Modification timestamp

campaigns[].lastModifiedInfo.time INTEGER

Timestamp of the last change in milliseconds since epoch

campaigns[].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

campaigns[].nielsenOcrEnabled BOOLEAN

Whether Nielsen reports are enabled for this campaign

campaigns[].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

campaigns[].subaccountId INTEGER

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

campaigns[].traffickerEmails[] STRING

kind STRING

Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse"

nextPageToken STRING

Pagination token to be used for the next list operation