class Google::Apis::DfareportingV2_3::Campaign
Contains properties of a DCM campaign.
Attributes
Account ID of this campaign. This is a read-only field that can be left blank. Corresponds to the JSON property `accountId` @return [String]
Additional creative optimization configurations for the campaign. Corresponds to the JSON property `additionalCreativeOptimizationConfigurations` @return [Array<Google::Apis::DfareportingV2_3::CreativeOptimizationConfiguration>]
Advertiser group ID of the associated advertiser. Corresponds to the JSON property `advertiserGroupId` @return [String]
Advertiser ID of this campaign. This is a required field. Corresponds to the JSON property `advertiserId` @return [String]
Represents a DimensionValue resource. Corresponds to the JSON property `advertiserIdDimensionValue` @return [Google::Apis::DfareportingV2_3::DimensionValue]
Whether this campaign has been archived. Corresponds to the JSON property `archived` @return [Boolean]
Whether this campaign has been archived. Corresponds to the JSON property `archived` @return [Boolean]
Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. Corresponds to the JSON property `audienceSegmentGroups` @return [Array<Google::Apis::DfareportingV2_3::AudienceSegmentGroup>]
Billing invoice code included in the DCM client billing invoices associated with the campaign. Corresponds to the JSON property `billingInvoiceCode` @return [String]
Click Through URL Suffix settings. Corresponds to the JSON property `clickThroughUrlSuffixProperties` @return [Google::Apis::DfareportingV2_3::ClickThroughUrlSuffixProperties]
Arbitrary comments about this campaign. Must be less than 256 characters long. Corresponds to the JSON property `comment` @return [String]
Whether comScore vCE reports are enabled for this campaign. Corresponds to the JSON property `comscoreVceEnabled` @return [Boolean]
Whether comScore vCE reports are enabled for this campaign. Corresponds to the JSON property `comscoreVceEnabled` @return [Boolean]
Modification timestamp. Corresponds to the JSON property `createInfo` @return [Google::Apis::DfareportingV2_3::LastModifiedInfo]
List of creative group IDs that are assigned to the campaign. Corresponds to the JSON property `creativeGroupIds` @return [Array<String>]
Creative optimization settings. Corresponds to the JSON property `creativeOptimizationConfiguration` @return [Google::Apis::DfareportingV2_3::CreativeOptimizationConfiguration]
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. Corresponds to the JSON property `defaultClickThroughEventTagProperties` @return [Google::Apis::DfareportingV2_3::DefaultClickThroughEventTagProperties]
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. Corresponds to the JSON property `endDate` @return [Date]
Overrides that can be used to activate or deactivate advertiser event tags. Corresponds to the JSON property `eventTagOverrides` @return [Array<Google::Apis::DfareportingV2_3::EventTagOverride>]
External ID for this campaign. Corresponds to the JSON property `externalId` @return [String]
ID of this campaign. This is a read-only auto-generated field. Corresponds to the JSON property `id` @return [String]
Represents a DimensionValue resource. Corresponds to the JSON property `idDimensionValue` @return [Google::Apis::DfareportingV2_3::DimensionValue]
Identifies what kind of resource this is. Value: the fixed string “ dfareporting#campaign”. Corresponds to the JSON property `kind` @return [String]
Modification timestamp. Corresponds to the JSON property `lastModifiedInfo` @return [Google::Apis::DfareportingV2_3::LastModifiedInfo]
Lookback configuration settings. Corresponds to the JSON property `lookbackConfiguration` @return [Google::Apis::DfareportingV2_3::LookbackConfiguration]
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. Corresponds to the JSON property `name` @return [String]
Whether Nielsen reports are enabled for this campaign. Corresponds to the JSON property `nielsenOcrEnabled` @return [Boolean]
Whether Nielsen reports are enabled for this campaign. Corresponds to the JSON property `nielsenOcrEnabled` @return [Boolean]
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. Corresponds to the JSON property `startDate` @return [Date]
Subaccount ID of this campaign. This is a read-only field that can be left blank. Corresponds to the JSON property `subaccountId` @return [String]
Campaign trafficker contact emails. Corresponds to the JSON property `traffickerEmails` @return [Array<String>]
Public Class Methods
# File generated/google/apis/dfareporting_v2_3/classes.rb, line 1546 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File generated/google/apis/dfareporting_v2_3/classes.rb, line 1551 def update!(**args) @account_id = args[:account_id] if args.key?(:account_id) @additional_creative_optimization_configurations = args[:additional_creative_optimization_configurations] if args.key?(:additional_creative_optimization_configurations) @advertiser_group_id = args[:advertiser_group_id] if args.key?(:advertiser_group_id) @advertiser_id = args[:advertiser_id] if args.key?(:advertiser_id) @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] if args.key?(:advertiser_id_dimension_value) @archived = args[:archived] if args.key?(:archived) @audience_segment_groups = args[:audience_segment_groups] if args.key?(:audience_segment_groups) @billing_invoice_code = args[:billing_invoice_code] if args.key?(:billing_invoice_code) @click_through_url_suffix_properties = args[:click_through_url_suffix_properties] if args.key?(:click_through_url_suffix_properties) @comment = args[:comment] if args.key?(:comment) @comscore_vce_enabled = args[:comscore_vce_enabled] if args.key?(:comscore_vce_enabled) @create_info = args[:create_info] if args.key?(:create_info) @creative_group_ids = args[:creative_group_ids] if args.key?(:creative_group_ids) @creative_optimization_configuration = args[:creative_optimization_configuration] if args.key?(:creative_optimization_configuration) @default_click_through_event_tag_properties = args[:default_click_through_event_tag_properties] if args.key?(:default_click_through_event_tag_properties) @end_date = args[:end_date] if args.key?(:end_date) @event_tag_overrides = args[:event_tag_overrides] if args.key?(:event_tag_overrides) @external_id = args[:external_id] if args.key?(:external_id) @id = args[:id] if args.key?(:id) @id_dimension_value = args[:id_dimension_value] if args.key?(:id_dimension_value) @kind = args[:kind] if args.key?(:kind) @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info) @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration) @name = args[:name] if args.key?(:name) @nielsen_ocr_enabled = args[:nielsen_ocr_enabled] if args.key?(:nielsen_ocr_enabled) @start_date = args[:start_date] if args.key?(:start_date) @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id) @trafficker_emails = args[:trafficker_emails] if args.key?(:trafficker_emails) end