Class: Google::Apis::DfareportingV2_3::Campaign
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV2_3::Campaign
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dfareporting_v2_3/classes.rb,
generated/google/apis/dfareporting_v2_3/representations.rb,
generated/google/apis/dfareporting_v2_3/representations.rb
Overview
Contains properties of a DCM campaign.
Instance Attribute Summary collapse
-
#account_id ⇒ String
Account ID of this campaign.
-
#additional_creative_optimization_configurations ⇒ Array<Google::Apis::DfareportingV2_3::CreativeOptimizationConfiguration>
Additional creative optimization configurations for the campaign.
-
#advertiser_group_id ⇒ String
Advertiser group ID of the associated advertiser.
-
#advertiser_id ⇒ String
Advertiser ID of this campaign.
-
#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV2_3::DimensionValue
Represents a DimensionValue resource.
-
#archived ⇒ Boolean
(also: #archived?)
Whether this campaign has been archived.
-
#audience_segment_groups ⇒ Array<Google::Apis::DfareportingV2_3::AudienceSegmentGroup>
Audience segment groups assigned to this campaign.
-
#billing_invoice_code ⇒ String
Billing invoice code included in the DCM client billing invoices associated with the campaign.
-
#click_through_url_suffix_properties ⇒ Google::Apis::DfareportingV2_3::ClickThroughUrlSuffixProperties
Click Through URL Suffix settings.
-
#comment ⇒ String
Arbitrary comments about this campaign.
-
#comscore_vce_enabled ⇒ Boolean
(also: #comscore_vce_enabled?)
Whether comScore vCE reports are enabled for this campaign.
-
#create_info ⇒ Google::Apis::DfareportingV2_3::LastModifiedInfo
Modification timestamp.
-
#creative_group_ids ⇒ Array<String>
List of creative group IDs that are assigned to the campaign.
-
#creative_optimization_configuration ⇒ Google::Apis::DfareportingV2_3::CreativeOptimizationConfiguration
Creative optimization settings.
-
#default_click_through_event_tag_properties ⇒ Google::Apis::DfareportingV2_3::DefaultClickThroughEventTagProperties
Properties of inheriting and overriding the default click-through event tag.
-
#end_date ⇒ Date
Date on which the campaign will stop running.
-
#event_tag_overrides ⇒ Array<Google::Apis::DfareportingV2_3::EventTagOverride>
Overrides that can be used to activate or deactivate advertiser event tags.
-
#external_id ⇒ String
External ID for this campaign.
-
#id ⇒ String
ID of this campaign.
-
#id_dimension_value ⇒ Google::Apis::DfareportingV2_3::DimensionValue
Represents a DimensionValue resource.
-
#kind ⇒ String
Identifies what kind of resource this is.
-
#last_modified_info ⇒ Google::Apis::DfareportingV2_3::LastModifiedInfo
Modification timestamp.
-
#lookback_configuration ⇒ Google::Apis::DfareportingV2_3::LookbackConfiguration
Lookback configuration settings.
-
#name ⇒ String
Name of this campaign.
-
#nielsen_ocr_enabled ⇒ Boolean
(also: #nielsen_ocr_enabled?)
Whether Nielsen reports are enabled for this campaign.
-
#start_date ⇒ Date
Date on which the campaign starts running.
-
#subaccount_id ⇒ String
Subaccount ID of this campaign.
-
#trafficker_emails ⇒ Array<String>
Campaign trafficker contact emails.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Campaign
constructor
A new instance of Campaign.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Campaign
Returns a new instance of Campaign.
1546 1547 1548 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1546 def initialize(**args) update!(**args) end |
Instance Attribute Details
#account_id ⇒ String
Account ID of this campaign. This is a read-only field that can be left blank.
Corresponds to the JSON property accountId
1392 1393 1394 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1392 def account_id @account_id end |
#additional_creative_optimization_configurations ⇒ Array<Google::Apis::DfareportingV2_3::CreativeOptimizationConfiguration>
Additional creative optimization configurations for the campaign.
Corresponds to the JSON property additionalCreativeOptimizationConfigurations
1397 1398 1399 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1397 def additional_creative_optimization_configurations @additional_creative_optimization_configurations end |
#advertiser_group_id ⇒ String
Advertiser group ID of the associated advertiser.
Corresponds to the JSON property advertiserGroupId
1402 1403 1404 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1402 def advertiser_group_id @advertiser_group_id end |
#advertiser_id ⇒ String
Advertiser ID of this campaign. This is a required field.
Corresponds to the JSON property advertiserId
1407 1408 1409 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1407 def advertiser_id @advertiser_id end |
#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV2_3::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property advertiserIdDimensionValue
1412 1413 1414 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1412 def advertiser_id_dimension_value @advertiser_id_dimension_value end |
#archived ⇒ Boolean Also known as: archived?
Whether this campaign has been archived.
Corresponds to the JSON property archived
1417 1418 1419 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1417 def archived @archived end |
#audience_segment_groups ⇒ Array<Google::Apis::DfareportingV2_3::AudienceSegmentGroup>
Audience segment groups assigned to this campaign. Cannot have more than 300
segment groups.
Corresponds to the JSON property audienceSegmentGroups
1424 1425 1426 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1424 def audience_segment_groups @audience_segment_groups end |
#billing_invoice_code ⇒ String
Billing invoice code included in the DCM client billing invoices associated
with the campaign.
Corresponds to the JSON property billingInvoiceCode
1430 1431 1432 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1430 def billing_invoice_code @billing_invoice_code end |
#click_through_url_suffix_properties ⇒ Google::Apis::DfareportingV2_3::ClickThroughUrlSuffixProperties
Click Through URL Suffix settings.
Corresponds to the JSON property clickThroughUrlSuffixProperties
1435 1436 1437 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1435 def click_through_url_suffix_properties @click_through_url_suffix_properties end |
#comment ⇒ String
Arbitrary comments about this campaign. Must be less than 256 characters long.
Corresponds to the JSON property comment
1440 1441 1442 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1440 def comment @comment end |
#comscore_vce_enabled ⇒ Boolean Also known as: comscore_vce_enabled?
Whether comScore vCE reports are enabled for this campaign.
Corresponds to the JSON property comscoreVceEnabled
1445 1446 1447 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1445 def comscore_vce_enabled @comscore_vce_enabled end |
#create_info ⇒ Google::Apis::DfareportingV2_3::LastModifiedInfo
Modification timestamp.
Corresponds to the JSON property createInfo
1451 1452 1453 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1451 def create_info @create_info end |
#creative_group_ids ⇒ Array<String>
List of creative group IDs that are assigned to the campaign.
Corresponds to the JSON property creativeGroupIds
1456 1457 1458 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1456 def creative_group_ids @creative_group_ids end |
#creative_optimization_configuration ⇒ Google::Apis::DfareportingV2_3::CreativeOptimizationConfiguration
Creative optimization settings.
Corresponds to the JSON property creativeOptimizationConfiguration
1461 1462 1463 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1461 def creative_optimization_configuration @creative_optimization_configuration end |
#default_click_through_event_tag_properties ⇒ Google::Apis::DfareportingV2_3::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.
Corresponds to the JSON property defaultClickThroughEventTagProperties
1468 1469 1470 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1468 def default_click_through_event_tag_properties @default_click_through_event_tag_properties end |
#end_date ⇒ Date
Date on which the campaign will stop running. On insert, the end date must be
today or a future date. The end date must be later than or be the same as the
start date. If, for example, you set 6/25/2015 as both the start and end dates,
the effective campaign run date is just that day only, 6/25/2015. The hours,
minutes, and seconds of the end date should not be set, as doing so will
result in an error. This is a required field.
Corresponds to the JSON property endDate
1478 1479 1480 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1478 def end_date @end_date end |
#event_tag_overrides ⇒ Array<Google::Apis::DfareportingV2_3::EventTagOverride>
Overrides that can be used to activate or deactivate advertiser event tags.
Corresponds to the JSON property eventTagOverrides
1483 1484 1485 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1483 def event_tag_overrides @event_tag_overrides end |
#external_id ⇒ String
External ID for this campaign.
Corresponds to the JSON property externalId
1488 1489 1490 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1488 def external_id @external_id end |
#id ⇒ String
ID of this campaign. This is a read-only auto-generated field.
Corresponds to the JSON property id
1493 1494 1495 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1493 def id @id end |
#id_dimension_value ⇒ Google::Apis::DfareportingV2_3::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property idDimensionValue
1498 1499 1500 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1498 def id_dimension_value @id_dimension_value end |
#kind ⇒ String
Identifies what kind of resource this is. Value: the fixed string "
dfareporting#campaign".
Corresponds to the JSON property kind
1504 1505 1506 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1504 def kind @kind end |
#last_modified_info ⇒ Google::Apis::DfareportingV2_3::LastModifiedInfo
Modification timestamp.
Corresponds to the JSON property lastModifiedInfo
1509 1510 1511 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1509 def last_modified_info @last_modified_info end |
#lookback_configuration ⇒ Google::Apis::DfareportingV2_3::LookbackConfiguration
Lookback configuration settings.
Corresponds to the JSON property lookbackConfiguration
1514 1515 1516 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1514 def lookback_configuration @lookback_configuration end |
#name ⇒ String
Name of this campaign. This is a required field and must be less than 256
characters long and unique among campaigns of the same advertiser.
Corresponds to the JSON property name
1520 1521 1522 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1520 def name @name end |
#nielsen_ocr_enabled ⇒ Boolean Also known as: nielsen_ocr_enabled?
Whether Nielsen reports are enabled for this campaign.
Corresponds to the JSON property nielsenOcrEnabled
1525 1526 1527 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1525 def nielsen_ocr_enabled @nielsen_ocr_enabled end |
#start_date ⇒ Date
Date on which the campaign starts running. The start date can be any date. The
hours, minutes, and seconds of the start date should not be set, as doing so
will result in an error. This is a required field.
Corresponds to the JSON property startDate
1533 1534 1535 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1533 def start_date @start_date end |
#subaccount_id ⇒ String
Subaccount ID of this campaign. This is a read-only field that can be left
blank.
Corresponds to the JSON property subaccountId
1539 1540 1541 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1539 def subaccount_id @subaccount_id end |
#trafficker_emails ⇒ Array<String>
Campaign trafficker contact emails.
Corresponds to the JSON property traffickerEmails
1544 1545 1546 |
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 1544 def trafficker_emails @trafficker_emails end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 |
# 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 |