Class: Google::Apis::DfareportingV2_1::Campaign

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable
Defined in:
generated/google/apis/dfareporting_v2_1/classes.rb,
generated/google/apis/dfareporting_v2_1/representations.rb,
generated/google/apis/dfareporting_v2_1/representations.rb

Overview

Contains properties of a DCM campaign.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Campaign

Returns a new instance of Campaign.



1531
1532
1533
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1531

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

Returns:

  • (String) 


1377
1378
1379
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1377

def 
  @account_id
end

#additional_creative_optimization_configurations ⇒ Array<Google::Apis::DfareportingV2_1::CreativeOptimizationConfiguration>

Additional creative optimization configurations for the campaign. Corresponds to the JSON property additionalCreativeOptimizationConfigurations

Returns:



1382
1383
1384
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1382

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

Returns:

  • (String) 


1387
1388
1389
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1387

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

Returns:

  • (String) 


1392
1393
1394
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1392

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



1397
1398
1399
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1397

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

Returns:

  • (Boolean) 


1402
1403
1404
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1402

def archived
  @archived
end

#audience_segment_groups ⇒ Array<Google::Apis::DfareportingV2_1::AudienceSegmentGroup>

Audience segment groups assigned to this campaign. Cannot have more than 300 segment groups. Corresponds to the JSON property audienceSegmentGroups

Returns:



1409
1410
1411
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1409

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

Returns:

  • (String) 


1415
1416
1417
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1415

def billing_invoice_code
  @billing_invoice_code
end

#click_through_url_suffix_properties ⇒ Google::Apis::DfareportingV2_1::ClickThroughUrlSuffixProperties

Click Through URL Suffix settings. Corresponds to the JSON property clickThroughUrlSuffixProperties

Returns:



1420
1421
1422
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1420

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

Returns:

  • (String) 


1425
1426
1427
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1425

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

Returns:

  • (Boolean) 


1430
1431
1432
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1430

def comscore_vce_enabled
  @comscore_vce_enabled
end

#create_info ⇒ Google::Apis::DfareportingV2_1::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



1436
1437
1438
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1436

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

Returns:

  • (Array<String>) 


1441
1442
1443
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1441

def creative_group_ids
  @creative_group_ids
end

#creative_optimization_configuration ⇒ Google::Apis::DfareportingV2_1::CreativeOptimizationConfiguration

Creative optimization settings. Corresponds to the JSON property creativeOptimizationConfiguration

Returns:



1446
1447
1448
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1446

def creative_optimization_configuration
  @creative_optimization_configuration
end

#default_click_through_event_tag_properties ⇒ Google::Apis::DfareportingV2_1::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

Returns:



1453
1454
1455
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1453

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

Returns:

  • (Date) 


1463
1464
1465
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1463

def end_date
  @end_date
end

#event_tag_overrides ⇒ Array<Google::Apis::DfareportingV2_1::EventTagOverride>

Overrides that can be used to activate or deactivate advertiser event tags. Corresponds to the JSON property eventTagOverrides

Returns:



1468
1469
1470
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1468

def event_tag_overrides
  @event_tag_overrides
end

#external_id ⇒ String

External ID for this campaign. Corresponds to the JSON property externalId

Returns:

  • (String) 


1473
1474
1475
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1473

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

Returns:

  • (String) 


1478
1479
1480
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1478

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



1483
1484
1485
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1483

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

Returns:

  • (String) 


1489
1490
1491
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1489

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV2_1::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



1494
1495
1496
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1494

def last_modified_info
  @last_modified_info
end

#lookback_configuration ⇒ Google::Apis::DfareportingV2_1::LookbackConfiguration

Lookback configuration settings. Corresponds to the JSON property lookbackConfiguration

Returns:



1499
1500
1501
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1499

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

Returns:

  • (String) 


1505
1506
1507
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1505

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

Returns:

  • (Boolean) 


1510
1511
1512
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1510

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

Returns:

  • (Date) 


1518
1519
1520
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1518

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

Returns:

  • (String) 


1524
1525
1526
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1524

def subaccount_id
  @subaccount_id
end

#trafficker_emails ⇒ Array<String>

Campaign trafficker contact emails. Corresponds to the JSON property traffickerEmails

Returns:

  • (Array<String>) 


1529
1530
1531
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1529

def trafficker_emails
  @trafficker_emails
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 1536

def update!(**args)
  @account_id = args[:account_id] unless args[:account_id].nil?
  @additional_creative_optimization_configurations = args[:additional_creative_optimization_configurations] unless args[:additional_creative_optimization_configurations].nil?
  @advertiser_group_id = args[:advertiser_group_id] unless args[:advertiser_group_id].nil?
  @advertiser_id = args[:advertiser_id] unless args[:advertiser_id].nil?
  @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] unless args[:advertiser_id_dimension_value].nil?
  @archived = args[:archived] unless args[:archived].nil?
  @audience_segment_groups = args[:audience_segment_groups] unless args[:audience_segment_groups].nil?
  @billing_invoice_code = args[:billing_invoice_code] unless args[:billing_invoice_code].nil?
  @click_through_url_suffix_properties = args[:click_through_url_suffix_properties] unless args[:click_through_url_suffix_properties].nil?
  @comment = args[:comment] unless args[:comment].nil?
  @comscore_vce_enabled = args[:comscore_vce_enabled] unless args[:comscore_vce_enabled].nil?
  @create_info = args[:create_info] unless args[:create_info].nil?
  @creative_group_ids = args[:creative_group_ids] unless args[:creative_group_ids].nil?
  @creative_optimization_configuration = args[:creative_optimization_configuration] unless args[:creative_optimization_configuration].nil?
  @default_click_through_event_tag_properties = args[:default_click_through_event_tag_properties] unless args[:default_click_through_event_tag_properties].nil?
  @end_date = args[:end_date] unless args[:end_date].nil?
  @event_tag_overrides = args[:event_tag_overrides] unless args[:event_tag_overrides].nil?
  @external_id = args[:external_id] unless args[:external_id].nil?
  @id = args[:id] unless args[:id].nil?
  @id_dimension_value = args[:id_dimension_value] unless args[:id_dimension_value].nil?
  @kind = args[:kind] unless args[:kind].nil?
  @last_modified_info = args[:last_modified_info] unless args[:last_modified_info].nil?
  @lookback_configuration = args[:lookback_configuration] unless args[:lookback_configuration].nil?
  @name = args[:name] unless args[:name].nil?
  @nielsen_ocr_enabled = args[:nielsen_ocr_enabled] unless args[:nielsen_ocr_enabled].nil?
  @start_date = args[:start_date] unless args[:start_date].nil?
  @subaccount_id = args[:subaccount_id] unless args[:subaccount_id].nil?
  @trafficker_emails = args[:trafficker_emails] unless args[:trafficker_emails].nil?
end