Insert
|
|||||
|
|
||||
Inserts a new campaign
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your DoubleClick Campaign Manager's (DCM) display ad campaigns
Input
This building block consumes 79 input parameters
| Name | Format | Description |
|---|---|---|
profileId Required |
INTEGER |
User profile ID associated with this request |
accountId |
INTEGER |
Account ID of this campaign. This is a read-only field that can be left blank |
adBlockingConfiguration |
OBJECT |
Campaign ad blocking settings |
adBlockingConfiguration.clickThroughUrl |
STRING |
Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true |
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 |
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[] |
OBJECT |
Creative optimization settings |
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 |
additionalCreativeOptimizationConfigurations[].name |
STRING |
Name of this creative optimization config. This is a required field and must be less than 129 characters long |
additionalCreativeOptimizationConfigurations[].optimizationActivitys[] |
OBJECT |
Creative optimization activity |
additionalCreativeOptimizationConfigurations[].optimizationActivitys[].floodlightActivityId |
INTEGER |
Floodlight activity ID of this optimization activity. This is a required field |
additionalCreativeOptimizationConfigurations[].optimizationActivitys[].floodlightActivityIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
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 |
ENUMERATION |
Optimization model for this configuration |
advertiserGroupId |
INTEGER |
Advertiser group ID of the associated advertiser |
advertiserId |
INTEGER |
Advertiser ID of this campaign. This is a required field |
advertiserIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
advertiserIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
advertiserIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
advertiserIdDimensionValue.id |
STRING |
The ID associated with the value if available |
advertiserIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
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 |
advertiserIdDimensionValue.value |
STRING |
The value of the dimension |
archived |
BOOLEAN |
Whether this campaign has been archived |
audienceSegmentGroups[] |
OBJECT |
Audience Segment Group |
audienceSegmentGroups[].audienceSegments[] |
OBJECT |
Audience Segment |
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 |
INTEGER |
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 |
INTEGER |
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 |
OBJECT |
Click Through URL Suffix settings |
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 |
OBJECT |
Modification timestamp |
createInfo.time |
INTEGER |
Timestamp of the last change in milliseconds since epoch |
creativeGroupIds[] |
INTEGER |
|
creativeOptimizationConfiguration |
OBJECT |
Creative optimization settings |
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 |
creativeOptimizationConfiguration.name |
STRING |
Name of this creative optimization config. This is a required field and must be less than 129 characters long |
creativeOptimizationConfiguration.optimizationActivitys[] |
OBJECT |
Creative optimization activity |
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityId |
INTEGER |
Floodlight activity ID of this optimization activity. This is a required field |
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.id |
STRING |
The ID associated with the value if available |
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.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 |
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.value |
STRING |
The value of the dimension |
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 |
ENUMERATION |
Optimization model for this configuration |
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 |
defaultClickThroughEventTagProperties.defaultClickThroughEventTagId |
INTEGER |
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 |
INTEGER |
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[] |
OBJECT |
Event tag override information |
eventTagOverrides[].enabled |
BOOLEAN |
Whether this override is enabled |
eventTagOverrides[].id |
INTEGER |
ID of this event tag override. This is a read-only, auto-generated field |
externalId |
STRING |
External ID for this campaign |
id |
INTEGER |
ID of this campaign. This is a read-only auto-generated field |
idDimensionValue |
OBJECT |
Represents a DimensionValue resource |
idDimensionValue.dimensionName |
STRING |
The name of the dimension |
idDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
idDimensionValue.id |
STRING |
The ID associated with the value if available |
idDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
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 |
idDimensionValue.value |
STRING |
The value of the dimension |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign" |
lastModifiedInfo |
OBJECT |
Modification timestamp |
lastModifiedInfo.time |
INTEGER |
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 |
INTEGER |
Subaccount ID of this campaign. This is a read-only field that can be left blank |
traffickerEmails[] |
STRING |
= Parameter name
= Format
|
profileId INTEGER Required User profile ID associated with this request |
|
accountId INTEGER Account ID of this campaign. This is a read-only field that can be left blank |
|
adBlockingConfiguration OBJECT Campaign ad blocking settings |
|
adBlockingConfiguration.clickThroughUrl STRING Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true |
|
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 |
|
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[] OBJECT Creative optimization settings |
|
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 |
|
additionalCreativeOptimizationConfigurations[].name STRING Name of this creative optimization config. This is a required field and must be less than 129 characters long |
|
additionalCreativeOptimizationConfigurations[].optimizationActivitys[] OBJECT Creative optimization activity |
|
additionalCreativeOptimizationConfigurations[].optimizationActivitys[].floodlightActivityId INTEGER Floodlight activity ID of this optimization activity. This is a required field |
|
additionalCreativeOptimizationConfigurations[].optimizationActivitys[].floodlightActivityIdDimensionValue OBJECT Represents a DimensionValue resource |
|
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 ENUMERATION Optimization model for this configuration |
|
advertiserGroupId INTEGER Advertiser group ID of the associated advertiser |
|
advertiserId INTEGER Advertiser ID of this campaign. This is a required field |
|
advertiserIdDimensionValue OBJECT Represents a DimensionValue resource |
|
advertiserIdDimensionValue.dimensionName STRING The name of the dimension |
|
advertiserIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
advertiserIdDimensionValue.id STRING The ID associated with the value if available |
|
advertiserIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
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 |
|
advertiserIdDimensionValue.value STRING The value of the dimension |
|
archived BOOLEAN Whether this campaign has been archived |
|
audienceSegmentGroups[] OBJECT Audience Segment Group |
|
audienceSegmentGroups[].audienceSegments[] OBJECT Audience Segment |
|
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 INTEGER 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 INTEGER 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 OBJECT Click Through URL Suffix settings |
|
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 OBJECT Modification timestamp |
|
createInfo.time INTEGER Timestamp of the last change in milliseconds since epoch |
|
creativeGroupIds[] INTEGER |
|
creativeOptimizationConfiguration OBJECT Creative optimization settings |
|
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 |
|
creativeOptimizationConfiguration.name STRING Name of this creative optimization config. This is a required field and must be less than 129 characters long |
|
creativeOptimizationConfiguration.optimizationActivitys[] OBJECT Creative optimization activity |
|
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityId INTEGER Floodlight activity ID of this optimization activity. This is a required field |
|
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue OBJECT Represents a DimensionValue resource |
|
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.dimensionName STRING The name of the dimension |
|
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.id STRING The ID associated with the value if available |
|
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.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 |
|
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.value STRING The value of the dimension |
|
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 ENUMERATION Optimization model for this configuration |
|
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 |
|
defaultClickThroughEventTagProperties.defaultClickThroughEventTagId INTEGER 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 INTEGER 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[] OBJECT Event tag override information |
|
eventTagOverrides[].enabled BOOLEAN Whether this override is enabled |
|
eventTagOverrides[].id INTEGER ID of this event tag override. This is a read-only, auto-generated field |
|
externalId STRING External ID for this campaign |
|
id INTEGER ID of this campaign. This is a read-only auto-generated field |
|
idDimensionValue OBJECT Represents a DimensionValue resource |
|
idDimensionValue.dimensionName STRING The name of the dimension |
|
idDimensionValue.etag STRING The eTag of this response for caching purposes |
|
idDimensionValue.id STRING The ID associated with the value if available |
|
idDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
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 |
|
idDimensionValue.value STRING The value of the dimension |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign" |
|
lastModifiedInfo OBJECT Modification timestamp |
|
lastModifiedInfo.time INTEGER 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 INTEGER Subaccount ID of this campaign. This is a read-only field that can be left blank |
|
traffickerEmails[] STRING |
Output
This building block provides 78 output parameters
| Name | Format | Description |
|---|---|---|
accountId |
INTEGER |
Account ID of this campaign. This is a read-only field that can be left blank |
adBlockingConfiguration |
OBJECT |
Campaign ad blocking settings |
adBlockingConfiguration.clickThroughUrl |
STRING |
Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true |
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 |
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[] |
OBJECT |
Creative optimization settings |
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 |
additionalCreativeOptimizationConfigurations[].name |
STRING |
Name of this creative optimization config. This is a required field and must be less than 129 characters long |
additionalCreativeOptimizationConfigurations[].optimizationActivitys[] |
OBJECT |
Creative optimization activity |
additionalCreativeOptimizationConfigurations[].optimizationActivitys[].floodlightActivityId |
INTEGER |
Floodlight activity ID of this optimization activity. This is a required field |
additionalCreativeOptimizationConfigurations[].optimizationActivitys[].floodlightActivityIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
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 |
ENUMERATION |
Optimization model for this configuration |
advertiserGroupId |
INTEGER |
Advertiser group ID of the associated advertiser |
advertiserId |
INTEGER |
Advertiser ID of this campaign. This is a required field |
advertiserIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
advertiserIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
advertiserIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
advertiserIdDimensionValue.id |
STRING |
The ID associated with the value if available |
advertiserIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
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 |
advertiserIdDimensionValue.value |
STRING |
The value of the dimension |
archived |
BOOLEAN |
Whether this campaign has been archived |
audienceSegmentGroups[] |
OBJECT |
Audience Segment Group |
audienceSegmentGroups[].audienceSegments[] |
OBJECT |
Audience Segment |
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 |
INTEGER |
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 |
INTEGER |
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 |
OBJECT |
Click Through URL Suffix settings |
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 |
OBJECT |
Modification timestamp |
createInfo.time |
INTEGER |
Timestamp of the last change in milliseconds since epoch |
creativeGroupIds[] |
INTEGER |
|
creativeOptimizationConfiguration |
OBJECT |
Creative optimization settings |
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 |
creativeOptimizationConfiguration.name |
STRING |
Name of this creative optimization config. This is a required field and must be less than 129 characters long |
creativeOptimizationConfiguration.optimizationActivitys[] |
OBJECT |
Creative optimization activity |
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityId |
INTEGER |
Floodlight activity ID of this optimization activity. This is a required field |
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue |
OBJECT |
Represents a DimensionValue resource |
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.dimensionName |
STRING |
The name of the dimension |
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.id |
STRING |
The ID associated with the value if available |
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.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 |
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.value |
STRING |
The value of the dimension |
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 |
ENUMERATION |
Optimization model for this configuration |
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 |
defaultClickThroughEventTagProperties.defaultClickThroughEventTagId |
INTEGER |
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 |
INTEGER |
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[] |
OBJECT |
Event tag override information |
eventTagOverrides[].enabled |
BOOLEAN |
Whether this override is enabled |
eventTagOverrides[].id |
INTEGER |
ID of this event tag override. This is a read-only, auto-generated field |
externalId |
STRING |
External ID for this campaign |
id |
INTEGER |
ID of this campaign. This is a read-only auto-generated field |
idDimensionValue |
OBJECT |
Represents a DimensionValue resource |
idDimensionValue.dimensionName |
STRING |
The name of the dimension |
idDimensionValue.etag |
STRING |
The eTag of this response for caching purposes |
idDimensionValue.id |
STRING |
The ID associated with the value if available |
idDimensionValue.kind |
STRING |
The kind of resource this is, in this case dfareporting#dimensionValue |
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 |
idDimensionValue.value |
STRING |
The value of the dimension |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign" |
lastModifiedInfo |
OBJECT |
Modification timestamp |
lastModifiedInfo.time |
INTEGER |
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 |
INTEGER |
Subaccount ID of this campaign. This is a read-only field that can be left blank |
traffickerEmails[] |
STRING |
= Parameter name
= Format
|
accountId INTEGER Account ID of this campaign. This is a read-only field that can be left blank |
|
adBlockingConfiguration OBJECT Campaign ad blocking settings |
|
adBlockingConfiguration.clickThroughUrl STRING Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true |
|
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 |
|
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[] OBJECT Creative optimization settings |
|
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 |
|
additionalCreativeOptimizationConfigurations[].name STRING Name of this creative optimization config. This is a required field and must be less than 129 characters long |
|
additionalCreativeOptimizationConfigurations[].optimizationActivitys[] OBJECT Creative optimization activity |
|
additionalCreativeOptimizationConfigurations[].optimizationActivitys[].floodlightActivityId INTEGER Floodlight activity ID of this optimization activity. This is a required field |
|
additionalCreativeOptimizationConfigurations[].optimizationActivitys[].floodlightActivityIdDimensionValue OBJECT Represents a DimensionValue resource |
|
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 ENUMERATION Optimization model for this configuration |
|
advertiserGroupId INTEGER Advertiser group ID of the associated advertiser |
|
advertiserId INTEGER Advertiser ID of this campaign. This is a required field |
|
advertiserIdDimensionValue OBJECT Represents a DimensionValue resource |
|
advertiserIdDimensionValue.dimensionName STRING The name of the dimension |
|
advertiserIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
advertiserIdDimensionValue.id STRING The ID associated with the value if available |
|
advertiserIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
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 |
|
advertiserIdDimensionValue.value STRING The value of the dimension |
|
archived BOOLEAN Whether this campaign has been archived |
|
audienceSegmentGroups[] OBJECT Audience Segment Group |
|
audienceSegmentGroups[].audienceSegments[] OBJECT Audience Segment |
|
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 INTEGER 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 INTEGER 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 OBJECT Click Through URL Suffix settings |
|
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 OBJECT Modification timestamp |
|
createInfo.time INTEGER Timestamp of the last change in milliseconds since epoch |
|
creativeGroupIds[] INTEGER |
|
creativeOptimizationConfiguration OBJECT Creative optimization settings |
|
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 |
|
creativeOptimizationConfiguration.name STRING Name of this creative optimization config. This is a required field and must be less than 129 characters long |
|
creativeOptimizationConfiguration.optimizationActivitys[] OBJECT Creative optimization activity |
|
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityId INTEGER Floodlight activity ID of this optimization activity. This is a required field |
|
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue OBJECT Represents a DimensionValue resource |
|
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.dimensionName STRING The name of the dimension |
|
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.etag STRING The eTag of this response for caching purposes |
|
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.id STRING The ID associated with the value if available |
|
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.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 |
|
creativeOptimizationConfiguration.optimizationActivitys[].floodlightActivityIdDimensionValue.value STRING The value of the dimension |
|
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 ENUMERATION Optimization model for this configuration |
|
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 |
|
defaultClickThroughEventTagProperties.defaultClickThroughEventTagId INTEGER 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 INTEGER 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[] OBJECT Event tag override information |
|
eventTagOverrides[].enabled BOOLEAN Whether this override is enabled |
|
eventTagOverrides[].id INTEGER ID of this event tag override. This is a read-only, auto-generated field |
|
externalId STRING External ID for this campaign |
|
id INTEGER ID of this campaign. This is a read-only auto-generated field |
|
idDimensionValue OBJECT Represents a DimensionValue resource |
|
idDimensionValue.dimensionName STRING The name of the dimension |
|
idDimensionValue.etag STRING The eTag of this response for caching purposes |
|
idDimensionValue.id STRING The ID associated with the value if available |
|
idDimensionValue.kind STRING The kind of resource this is, in this case dfareporting#dimensionValue |
|
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 |
|
idDimensionValue.value STRING The value of the dimension |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign" |
|
lastModifiedInfo OBJECT Modification timestamp |
|
lastModifiedInfo.time INTEGER 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 INTEGER Subaccount ID of this campaign. This is a read-only field that can be left blank |
|
traffickerEmails[] STRING |