Class: Google::Apis::DfareportingV2_7::Campaign

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

Overview

Contains properties of a DCM campaign.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Campaign

Returns a new instance of Campaign



1561
1562
1563
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1561

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#account_id ⇒ Fixnum

Account ID of this campaign. This is a read-only field that can be left blank. Corresponds to the JSON property accountId

Returns:

  • (Fixnum) 


1413
1414
1415
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1413

def 
  @account_id
end

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

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

Returns:



1418
1419
1420
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1418

def additional_creative_optimization_configurations
  @additional_creative_optimization_configurations
end

#advertiser_group_id ⇒ Fixnum

Advertiser group ID of the associated advertiser. Corresponds to the JSON property advertiserGroupId

Returns:

  • (Fixnum) 


1423
1424
1425
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1423

def advertiser_group_id
  @advertiser_group_id
end

#advertiser_id ⇒ Fixnum

Advertiser ID of this campaign. This is a required field. Corresponds to the JSON property advertiserId

Returns:

  • (Fixnum) 


1428
1429
1430
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1428

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV2_7::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



1433
1434
1435
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1433

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) 


1438
1439
1440
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1438

def archived
  @archived
end

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

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

Returns:



1445
1446
1447
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1445

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) 


1451
1452
1453
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1451

def billing_invoice_code
  @billing_invoice_code
end

#click_through_url_suffix_properties ⇒ Google::Apis::DfareportingV2_7::ClickThroughUrlSuffixProperties

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

Returns:



1456
1457
1458
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1456

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) 


1461
1462
1463
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1461

def comment
  @comment
end

#create_info ⇒ Google::Apis::DfareportingV2_7::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



1466
1467
1468
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1466

def create_info
  @create_info
end

#creative_group_ids ⇒ Array<Fixnum>

List of creative group IDs that are assigned to the campaign. Corresponds to the JSON property creativeGroupIds

Returns:

  • (Array<Fixnum>) 


1471
1472
1473
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1471

def creative_group_ids
  @creative_group_ids
end

#creative_optimization_configuration ⇒ Google::Apis::DfareportingV2_7::CreativeOptimizationConfiguration

Creative optimization settings. Corresponds to the JSON property creativeOptimizationConfiguration

Returns:



1476
1477
1478
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1476

def creative_optimization_configuration
  @creative_optimization_configuration
end

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



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

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) 


1493
1494
1495
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1493

def end_date
  @end_date
end

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

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

Returns:



1498
1499
1500
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1498

def event_tag_overrides
  @event_tag_overrides
end

#external_id ⇒ String

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

Returns:

  • (String) 


1503
1504
1505
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1503

def external_id
  @external_id
end

#id ⇒ Fixnum

ID of this campaign. This is a read-only auto-generated field. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


1508
1509
1510
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1508

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV2_7::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



1513
1514
1515
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1513

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) 


1519
1520
1521
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1519

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV2_7::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



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

def last_modified_info
  @last_modified_info
end

#lookback_configuration ⇒ Google::Apis::DfareportingV2_7::LookbackConfiguration

Lookback configuration settings. Corresponds to the JSON property lookbackConfiguration

Returns:



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

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) 


1535
1536
1537
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1535

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) 


1540
1541
1542
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1540

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) 


1548
1549
1550
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1548

def start_date
  @start_date
end

#subaccount_id ⇒ Fixnum

Subaccount ID of this campaign. This is a read-only field that can be left blank. Corresponds to the JSON property subaccountId

Returns:

  • (Fixnum) 


1554
1555
1556
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1554

def subaccount_id
  @subaccount_id
end

#trafficker_emails ⇒ Array<String>

Campaign trafficker contact emails. Corresponds to the JSON property traffickerEmails

Returns:

  • (Array<String>) 


1559
1560
1561
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1559

def trafficker_emails
  @trafficker_emails
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 1566

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)
  @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