Resource: Campaign
Contains properties of a Campaign Manager campaign.
JSON representation |
---|
{ "id": string, "accountId": string, "subaccountId": string, "advertiserId": string, "advertiserGroupId": string, "name": string, "archived": boolean, "startDate": string, "endDate": string, "comment": string, "billingInvoiceCode": string, "audienceSegmentGroups": [ { object ( |
Fields | |
---|---|
id |
ID of this campaign. This is a read-only auto-generated field. |
accountId |
Account ID of this campaign. This is a read-only field that can be left blank. |
subaccountId |
Subaccount ID of this campaign. This is a read-only field that can be left blank. |
advertiserId |
Advertiser ID of this campaign. This is a required field. |
advertiserGroupId |
Advertiser group ID of the associated advertiser. |
name |
Name of this campaign. This is a required field and must be less than 512 characters long and unique among campaigns of the same advertiser. |
archived |
Whether this campaign has been archived. |
startDate |
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 |
Date on which the campaign will stop running. On insert, the end date must be today or a future date. The end date must be later than or be the same as the start date. If, for example, you set 6/25/2015 as both the start and end dates, the effective campaign run date is just that day only, 6/25/2015. The hours, minutes, and seconds of the end date should not be set, as doing so will result in an error. This is a required field. |
comment |
Arbitrary comments about this campaign. Must be less than 256 characters long. |
billingInvoiceCode |
Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. |
audienceSegmentGroups[] |
Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. |
eventTagOverrides[] |
Overrides that can be used to activate or deactivate advertiser event tags. |
clickThroughUrlSuffixProperties |
Click-through URL suffix override properties for this campaign. |
defaultClickThroughEventTagProperties |
Click-through event tag ID override properties for this campaign. |
creativeGroupIds[] |
accountPermissionGroups.list of creative group IDs that are assigned to the campaign. |
creativeOptimizationConfiguration |
Creative optimization configuration for the campaign. |
additionalCreativeOptimizationConfigurations[] |
Additional creative optimization configurations for the campaign. |
kind |
Identifies what kind of resource this is. Value: the fixed string
. |
createInfo |
Information about the creation of this campaign. This is a read-only field. |
lastModifiedInfo |
Information about the most recent modification of this campaign. This is a read-only field. |
traffickerEmails[] |
Campaign trafficker contact emails. |
idDimensionValue |
Dimension value for the ID of this campaign. This is a read-only, auto-generated field. |
advertiserIdDimensionValue |
Dimension value for the advertiser ID of this campaign. This is a read-only, auto-generated field. |
externalId |
External ID for this campaign. |
nielsenOcrEnabled |
Whether Nielsen reports are enabled for this campaign. |
adBlockingConfiguration |
Ad blocking settings for this campaign. |
defaultLandingPageId |
The default landing page ID for this campaign. |
measurementPartnerLink |
Measurement partner campaign link for tag wrapping. |
AudienceSegmentGroup
Audience Segment Group.
JSON representation |
---|
{
"id": string,
"name": string,
"audienceSegments": [
{
object ( |
Fields | |
---|---|
id |
ID of this audience segment group. This is a read-only, auto-generated field. |
name |
Name of this audience segment group. This is a required field and must be less than 65 characters long. |
audienceSegments[] |
Audience segments assigned to this group. The number of segments must be between 2 and 100. |
AudienceSegment
Audience Segment.
JSON representation |
---|
{ "id": string, "name": string, "allocation": integer } |
Fields | |
---|---|
id |
ID of this audience segment. This is a read-only, auto-generated field. |
name |
Name of this audience segment. This is a required field and must be less than 65 characters long. |
allocation |
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
to
, inclusive. |
CreativeOptimizationConfiguration
Creative optimization settings.
JSON representation |
---|
{ "optimizationModel": enum ( |
Fields | |
---|---|
optimizationModel |
Optimization model for this configuration. |
optimizationActivitys[] |
accountPermissionGroups.list of optimization activities associated with this configuration. |
id |
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 |
Name of this creative optimization config. This is a required field and must be less than 129 characters long. |
OptimizationModel
Enums | |
---|---|
CLICK |
|
POST_CLICK |
|
POST_IMPRESSION |
|
POST_CLICK_AND_IMPRESSION |
|
VIDEO_COMPLETION |
OptimizationActivity
Creative optimization activity.
JSON representation |
---|
{
"floodlightActivityId": string,
"weight": integer,
"floodlightActivityIdDimensionValue": {
object ( |
Fields | |
---|---|
floodlightActivityId |
Floodlight activity ID of this optimization activity. This is a required field. |
weight |
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
. |
floodlightActivityIdDimensionValue |
Dimension value for the ID of the floodlight activity. This is a read-only, auto-generated field. |
AdBlockingConfiguration
Campaign ad blocking settings.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
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. |
MeasurementPartnerCampaignLink
JSON representation |
---|
{ "measurementPartner": enum ( |
Fields | |
---|---|
measurementPartner |
Measurement partner used for tag wrapping. |
linkStatus |
. |
partnerCampaignId |
Partner campaign ID needed for establishing linking with Measurement partner. |
MeasurementPartner
Enums | |
---|---|
NONE |
|
INTEGRAL_AD_SCIENCE |
|
DOUBLE_VERIFY |
LinkStatus
Enums | |
---|---|
MEASUREMENT_PARTNER_UNLINKED |
|
MEASUREMENT_PARTNER_LINKED |
|
MEASUREMENT_PARTNER_LINK_PENDING |
|
MEASUREMENT_PARTNER_LINK_FAILURE |
|
MEASUREMENT_PARTNER_LINK_OPT_OUT |
|
MEASUREMENT_PARTNER_LINK_OPT_OUT_PENDING |
|
MEASUREMENT_PARTNER_LINK_WRAPPING_PENDING |
|
MEASUREMENT_PARTNER_MODE_CHANGE_PENDING |
Methods |
|
---|---|
|
Gets one campaign by ID. |
|
Inserts a new campaign. |
|
Retrieves a list of campaigns, possibly filtered. |
|
Updates an existing campaign. |
|
Updates an existing campaign. |