Gets one campaign by ID.
insert(profileId, defaultLandingPageName, defaultLandingPageUrl, body)
Inserts a new campaign.
Retrieves a list of campaigns, possibly filtered. This method supports paging.
list_next(previous_request, previous_response)
Retrieves the next page of results.
Updates an existing campaign. This method supports patch semantics.
Updates an existing campaign.
get(profileId, id)
Gets one campaign by ID.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Campaign ID. (required)
Returns:
An object of the form:
{ # Contains properties of a DCM campaign.
"comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
"startDate": "A 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": "A 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.
"clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
"clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
"overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
},
"advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
{ # Event tag override information.
"enabled": True or False, # Whether this override is enabled.
"id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
},
],
"creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
"optimizationActivitys": [ # List of optimization activities associated with this configuration.
{ # Creative optimization activity.
"floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
"floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"weight": 42, # 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.
},
],
"optimizationModel": "A String", # Optimization model for this configuration.
"id": "A String", # 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": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
},
"id": "A String", # ID of this campaign. This is a read-only auto-generated field.
"accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
"traffickerEmails": [ # Campaign trafficker contact emails.
"A String",
],
"archived": True or False, # Whether this campaign has been archived.
"externalId": "A String", # External ID for this campaign.
"advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
"creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
"A String",
],
"additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
{ # Creative optimization settings.
"optimizationActivitys": [ # List of optimization activities associated with this configuration.
{ # Creative optimization activity.
"floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
"floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"weight": 42, # 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.
},
],
"optimizationModel": "A String", # Optimization model for this configuration.
"id": "A String", # 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": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
},
],
"createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"defaultClickThroughEventTagProperties": { # 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. # Click-through event tag ID override properties for this campaign.
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
"adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign.
"creativeBundleId": "A String", # 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.
"clickThroughUrl": "A String", # Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true.
"enabled": True or False, # 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": True or False, # 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.
},
"kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
"subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
"name": "A 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.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
},
"nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
{ # Audience Segment Group.
"audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
{ # Audience Segment.
"allocation": 42, # 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.
"id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
"name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
},
],
"id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
"name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
},
],
}
insert(profileId, defaultLandingPageName, defaultLandingPageUrl, body)
Inserts a new campaign.
Args:
profileId: string, User profile ID associated with this request. (required)
defaultLandingPageName: string, Default landing page name for this new campaign. Must be less than 256 characters long. (required)
defaultLandingPageUrl: string, Default landing page URL for this new campaign. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Contains properties of a DCM campaign.
"comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
"startDate": "A 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": "A 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.
"clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
"clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
"overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
},
"advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
{ # Event tag override information.
"enabled": True or False, # Whether this override is enabled.
"id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
},
],
"creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
"optimizationActivitys": [ # List of optimization activities associated with this configuration.
{ # Creative optimization activity.
"floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
"floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"weight": 42, # 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.
},
],
"optimizationModel": "A String", # Optimization model for this configuration.
"id": "A String", # 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": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
},
"id": "A String", # ID of this campaign. This is a read-only auto-generated field.
"accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
"traffickerEmails": [ # Campaign trafficker contact emails.
"A String",
],
"archived": True or False, # Whether this campaign has been archived.
"externalId": "A String", # External ID for this campaign.
"advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
"creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
"A String",
],
"additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
{ # Creative optimization settings.
"optimizationActivitys": [ # List of optimization activities associated with this configuration.
{ # Creative optimization activity.
"floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
"floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"weight": 42, # 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.
},
],
"optimizationModel": "A String", # Optimization model for this configuration.
"id": "A String", # 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": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
},
],
"createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"defaultClickThroughEventTagProperties": { # 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. # Click-through event tag ID override properties for this campaign.
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
"adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign.
"creativeBundleId": "A String", # 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.
"clickThroughUrl": "A String", # Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true.
"enabled": True or False, # 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": True or False, # 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.
},
"kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
"subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
"name": "A 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.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
},
"nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
{ # Audience Segment Group.
"audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
{ # Audience Segment.
"allocation": 42, # 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.
"id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
"name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
},
],
"id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
"name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
},
],
}
Returns:
An object of the form:
{ # Contains properties of a DCM campaign.
"comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
"startDate": "A 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": "A 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.
"clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
"clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
"overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
},
"advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
{ # Event tag override information.
"enabled": True or False, # Whether this override is enabled.
"id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
},
],
"creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
"optimizationActivitys": [ # List of optimization activities associated with this configuration.
{ # Creative optimization activity.
"floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
"floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"weight": 42, # 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.
},
],
"optimizationModel": "A String", # Optimization model for this configuration.
"id": "A String", # 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": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
},
"id": "A String", # ID of this campaign. This is a read-only auto-generated field.
"accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
"traffickerEmails": [ # Campaign trafficker contact emails.
"A String",
],
"archived": True or False, # Whether this campaign has been archived.
"externalId": "A String", # External ID for this campaign.
"advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
"creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
"A String",
],
"additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
{ # Creative optimization settings.
"optimizationActivitys": [ # List of optimization activities associated with this configuration.
{ # Creative optimization activity.
"floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
"floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"weight": 42, # 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.
},
],
"optimizationModel": "A String", # Optimization model for this configuration.
"id": "A String", # 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": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
},
],
"createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"defaultClickThroughEventTagProperties": { # 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. # Click-through event tag ID override properties for this campaign.
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
"adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign.
"creativeBundleId": "A String", # 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.
"clickThroughUrl": "A String", # Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true.
"enabled": True or False, # 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": True or False, # 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.
},
"kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
"subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
"name": "A 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.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
},
"nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
{ # Audience Segment Group.
"audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
{ # Audience Segment.
"allocation": 42, # 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.
"id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
"name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
},
],
"id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
"name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
},
],
}
list(profileId, overriddenEventTagId=None, archived=None, advertiserIds=None, pageToken=None, sortOrder=None, maxResults=None, excludedIds=None, advertiserGroupIds=None, searchString=None, subaccountId=None, ids=None, sortField=None, atLeastOneOptimizationActivity=None)
Retrieves a list of campaigns, possibly filtered. This method supports paging.
Args:
profileId: string, User profile ID associated with this request. (required)
overriddenEventTagId: string, Select only campaigns that have overridden this event tag ID.
archived: boolean, Select only archived campaigns. Don't set this field to select both archived and non-archived campaigns.
advertiserIds: string, Select only campaigns that belong to these advertisers. (repeated)
pageToken: string, Value of the nextPageToken from the previous result page.
sortOrder: string, Order of sorted results.
Allowed values
ASCENDING -
DESCENDING -
maxResults: integer, Maximum number of results to return.
excludedIds: string, Exclude campaigns with these IDs. (repeated)
advertiserGroupIds: string, Select only campaigns whose advertisers belong to these advertiser groups. (repeated)
searchString: string, Allows searching for campaigns by name or ID. Wildcards (*) are allowed. For example, "campaign*2015" 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".
subaccountId: string, Select only campaigns that belong to this subaccount.
ids: string, Select only campaigns with these IDs. (repeated)
sortField: string, Field by which to sort the list.
Allowed values
ID -
NAME -
atLeastOneOptimizationActivity: boolean, Select only campaigns that have at least one optimization activity.
Returns:
An object of the form:
{ # Campaign List Response
"campaigns": [ # Campaign collection.
{ # Contains properties of a DCM campaign.
"comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
"startDate": "A 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": "A 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.
"clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
"clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
"overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
},
"advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
{ # Event tag override information.
"enabled": True or False, # Whether this override is enabled.
"id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
},
],
"creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
"optimizationActivitys": [ # List of optimization activities associated with this configuration.
{ # Creative optimization activity.
"floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
"floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"weight": 42, # 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.
},
],
"optimizationModel": "A String", # Optimization model for this configuration.
"id": "A String", # 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": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
},
"id": "A String", # ID of this campaign. This is a read-only auto-generated field.
"accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
"traffickerEmails": [ # Campaign trafficker contact emails.
"A String",
],
"archived": True or False, # Whether this campaign has been archived.
"externalId": "A String", # External ID for this campaign.
"advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
"creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
"A String",
],
"additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
{ # Creative optimization settings.
"optimizationActivitys": [ # List of optimization activities associated with this configuration.
{ # Creative optimization activity.
"floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
"floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"weight": 42, # 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.
},
],
"optimizationModel": "A String", # Optimization model for this configuration.
"id": "A String", # 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": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
},
],
"createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"defaultClickThroughEventTagProperties": { # 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. # Click-through event tag ID override properties for this campaign.
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
"adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign.
"creativeBundleId": "A String", # 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.
"clickThroughUrl": "A String", # Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true.
"enabled": True or False, # 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": True or False, # 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.
},
"kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
"subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
"name": "A 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.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
},
"nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
{ # Audience Segment Group.
"audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
{ # Audience Segment.
"allocation": 42, # 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.
"id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
"name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
},
],
"id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
"name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
},
],
},
],
"nextPageToken": "A String", # Pagination token to be used for the next list operation.
"kind": "dfareporting#campaignsListResponse", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaignsListResponse".
}
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
patch(profileId, id, body)
Updates an existing campaign. This method supports patch semantics.
Args:
profileId: string, User profile ID associated with this request. (required)
id: string, Campaign ID. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Contains properties of a DCM campaign.
"comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
"startDate": "A 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": "A 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.
"clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
"clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
"overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
},
"advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
{ # Event tag override information.
"enabled": True or False, # Whether this override is enabled.
"id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
},
],
"creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
"optimizationActivitys": [ # List of optimization activities associated with this configuration.
{ # Creative optimization activity.
"floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
"floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"weight": 42, # 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.
},
],
"optimizationModel": "A String", # Optimization model for this configuration.
"id": "A String", # 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": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
},
"id": "A String", # ID of this campaign. This is a read-only auto-generated field.
"accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
"traffickerEmails": [ # Campaign trafficker contact emails.
"A String",
],
"archived": True or False, # Whether this campaign has been archived.
"externalId": "A String", # External ID for this campaign.
"advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
"creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
"A String",
],
"additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
{ # Creative optimization settings.
"optimizationActivitys": [ # List of optimization activities associated with this configuration.
{ # Creative optimization activity.
"floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
"floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"weight": 42, # 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.
},
],
"optimizationModel": "A String", # Optimization model for this configuration.
"id": "A String", # 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": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
},
],
"createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"defaultClickThroughEventTagProperties": { # 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. # Click-through event tag ID override properties for this campaign.
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
"adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign.
"creativeBundleId": "A String", # 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.
"clickThroughUrl": "A String", # Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true.
"enabled": True or False, # 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": True or False, # 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.
},
"kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
"subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
"name": "A 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.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
},
"nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
{ # Audience Segment Group.
"audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
{ # Audience Segment.
"allocation": 42, # 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.
"id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
"name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
},
],
"id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
"name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
},
],
}
Returns:
An object of the form:
{ # Contains properties of a DCM campaign.
"comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
"startDate": "A 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": "A 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.
"clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
"clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
"overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
},
"advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
{ # Event tag override information.
"enabled": True or False, # Whether this override is enabled.
"id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
},
],
"creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
"optimizationActivitys": [ # List of optimization activities associated with this configuration.
{ # Creative optimization activity.
"floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
"floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"weight": 42, # 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.
},
],
"optimizationModel": "A String", # Optimization model for this configuration.
"id": "A String", # 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": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
},
"id": "A String", # ID of this campaign. This is a read-only auto-generated field.
"accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
"traffickerEmails": [ # Campaign trafficker contact emails.
"A String",
],
"archived": True or False, # Whether this campaign has been archived.
"externalId": "A String", # External ID for this campaign.
"advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
"creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
"A String",
],
"additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
{ # Creative optimization settings.
"optimizationActivitys": [ # List of optimization activities associated with this configuration.
{ # Creative optimization activity.
"floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
"floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"weight": 42, # 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.
},
],
"optimizationModel": "A String", # Optimization model for this configuration.
"id": "A String", # 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": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
},
],
"createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"defaultClickThroughEventTagProperties": { # 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. # Click-through event tag ID override properties for this campaign.
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
"adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign.
"creativeBundleId": "A String", # 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.
"clickThroughUrl": "A String", # Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true.
"enabled": True or False, # 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": True or False, # 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.
},
"kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
"subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
"name": "A 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.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
},
"nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
{ # Audience Segment Group.
"audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
{ # Audience Segment.
"allocation": 42, # 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.
"id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
"name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
},
],
"id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
"name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
},
],
}
update(profileId, body)
Updates an existing campaign.
Args:
profileId: string, User profile ID associated with this request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Contains properties of a DCM campaign.
"comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
"startDate": "A 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": "A 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.
"clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
"clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
"overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
},
"advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
{ # Event tag override information.
"enabled": True or False, # Whether this override is enabled.
"id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
},
],
"creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
"optimizationActivitys": [ # List of optimization activities associated with this configuration.
{ # Creative optimization activity.
"floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
"floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"weight": 42, # 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.
},
],
"optimizationModel": "A String", # Optimization model for this configuration.
"id": "A String", # 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": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
},
"id": "A String", # ID of this campaign. This is a read-only auto-generated field.
"accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
"traffickerEmails": [ # Campaign trafficker contact emails.
"A String",
],
"archived": True or False, # Whether this campaign has been archived.
"externalId": "A String", # External ID for this campaign.
"advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
"creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
"A String",
],
"additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
{ # Creative optimization settings.
"optimizationActivitys": [ # List of optimization activities associated with this configuration.
{ # Creative optimization activity.
"floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
"floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"weight": 42, # 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.
},
],
"optimizationModel": "A String", # Optimization model for this configuration.
"id": "A String", # 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": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
},
],
"createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"defaultClickThroughEventTagProperties": { # 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. # Click-through event tag ID override properties for this campaign.
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
"adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign.
"creativeBundleId": "A String", # 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.
"clickThroughUrl": "A String", # Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true.
"enabled": True or False, # 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": True or False, # 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.
},
"kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
"subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
"name": "A 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.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
},
"nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
{ # Audience Segment Group.
"audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
{ # Audience Segment.
"allocation": 42, # 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.
"id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
"name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
},
],
"id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
"name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
},
],
}
Returns:
An object of the form:
{ # Contains properties of a DCM campaign.
"comment": "A String", # Arbitrary comments about this campaign. Must be less than 256 characters long.
"startDate": "A 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": "A 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.
"clickThroughUrlSuffixProperties": { # Click Through URL Suffix settings. # Click-through URL suffix override properties for this campaign.
"clickThroughUrlSuffix": "A String", # Click-through URL suffix to apply to all ads in this entity's scope. Must be less than 128 characters long.
"overrideInheritedSuffix": True or False, # Whether this entity should override the inherited click-through URL suffix with its own defined value.
},
"advertiserId": "A String", # Advertiser ID of this campaign. This is a required field.
"advertiserIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"eventTagOverrides": [ # Overrides that can be used to activate or deactivate advertiser event tags.
{ # Event tag override information.
"enabled": True or False, # Whether this override is enabled.
"id": "A String", # ID of this event tag override. This is a read-only, auto-generated field.
},
],
"creativeOptimizationConfiguration": { # Creative optimization settings. # Creative optimization configuration for the campaign.
"optimizationActivitys": [ # List of optimization activities associated with this configuration.
{ # Creative optimization activity.
"floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
"floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"weight": 42, # 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.
},
],
"optimizationModel": "A String", # Optimization model for this configuration.
"id": "A String", # 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": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
},
"id": "A String", # ID of this campaign. This is a read-only auto-generated field.
"accountId": "A String", # Account ID of this campaign. This is a read-only field that can be left blank.
"traffickerEmails": [ # Campaign trafficker contact emails.
"A String",
],
"archived": True or False, # Whether this campaign has been archived.
"externalId": "A String", # External ID for this campaign.
"advertiserGroupId": "A String", # Advertiser group ID of the associated advertiser.
"idDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of this campaign. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"billingInvoiceCode": "A String", # Billing invoice code included in the DCM client billing invoices associated with the campaign.
"creativeGroupIds": [ # List of creative group IDs that are assigned to the campaign.
"A String",
],
"additionalCreativeOptimizationConfigurations": [ # Additional creative optimization configurations for the campaign.
{ # Creative optimization settings.
"optimizationActivitys": [ # List of optimization activities associated with this configuration.
{ # Creative optimization activity.
"floodlightActivityId": "A String", # Floodlight activity ID of this optimization activity. This is a required field.
"floodlightActivityIdDimensionValue": { # Represents a DimensionValue resource. # Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field.
"kind": "dfareporting#dimensionValue", # The kind of resource this is, in this case dfareporting#dimensionValue.
"value": "A String", # The value of the dimension.
"dimensionName": "A String", # The name of the dimension.
"etag": "A String", # The eTag of this response for caching purposes.
"matchType": "A String", # 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.
"id": "A String", # The ID associated with the value if available.
},
"weight": 42, # 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.
},
],
"optimizationModel": "A String", # Optimization model for this configuration.
"id": "A String", # 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": "A String", # Name of this creative optimization config. This is a required field and must be less than 129 characters long.
},
],
"createInfo": { # Modification timestamp. # Information about the creation of this campaign. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"defaultClickThroughEventTagProperties": { # 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. # Click-through event tag ID override properties for this campaign.
"overrideInheritedEventTag": True or False, # Whether this entity should override the inherited default click-through event tag with its own defined value.
"defaultClickThroughEventTagId": "A String", # ID of the click-through event tag to apply to all ads in this entity's scope.
},
"adBlockingConfiguration": { # Campaign ad blocking settings. # Ad blocking settings for this campaign.
"creativeBundleId": "A String", # 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.
"clickThroughUrl": "A String", # Click-through URL used by brand-neutral ads. This is a required field when overrideClickThroughUrl is set to true.
"enabled": True or False, # 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": True or False, # 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.
},
"kind": "dfareporting#campaign", # Identifies what kind of resource this is. Value: the fixed string "dfareporting#campaign".
"subaccountId": "A String", # Subaccount ID of this campaign. This is a read-only field that can be left blank.
"name": "A 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.
"lookbackConfiguration": { # Lookback configuration settings. # Lookback window settings for the campaign.
"clickDuration": 42, # Lookback window, in days, from the last time a given user clicked on one of your ads. If you enter 0, clicks will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
"postImpressionActivitiesDuration": 42, # Lookback window, in days, from the last time a given user viewed one of your ads. If you enter 0, impressions will not be considered as triggering events for floodlight tracking. If you leave this field blank, the default value for your account will be used. Acceptable values are 0 to 90, inclusive.
},
"nielsenOcrEnabled": True or False, # Whether Nielsen reports are enabled for this campaign.
"lastModifiedInfo": { # Modification timestamp. # Information about the most recent modification of this campaign. This is a read-only field.
"time": "A String", # Timestamp of the last change in milliseconds since epoch.
},
"audienceSegmentGroups": [ # Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups.
{ # Audience Segment Group.
"audienceSegments": [ # Audience segments assigned to this group. The number of segments must be between 2 and 100.
{ # Audience Segment.
"allocation": 42, # 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.
"id": "A String", # ID of this audience segment. This is a read-only, auto-generated field.
"name": "A String", # Name of this audience segment. This is a required field and must be less than 65 characters long.
},
],
"id": "A String", # ID of this audience segment group. This is a read-only, auto-generated field.
"name": "A String", # Name of this audience segment group. This is a required field and must be less than 65 characters long.
},
],
}