Class: Google::Apis::DfareportingV3_3::Campaign

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

Overview

Contains properties of a Campaign Manager 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.



1646
1647
1648
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1646

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) 


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

def 
  @account_id
end

#ad_blocking_configuration ⇒ Google::Apis::DfareportingV3_3::AdBlockingConfiguration

Campaign ad blocking settings. Corresponds to the JSON property adBlockingConfiguration

Returns:



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

def ad_blocking_configuration
  @ad_blocking_configuration
end

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

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

Returns:



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

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) 


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

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) 


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

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



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

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) 


1523
1524
1525
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1523

def archived
  @archived
end

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

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

Returns:



1530
1531
1532
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1530

def audience_segment_groups
  @audience_segment_groups
end

#billing_invoice_code ⇒ String

Billing invoice code included in the Campaign Manager client billing invoices associated with the campaign. Corresponds to the JSON property billingInvoiceCode

Returns:

  • (String) 


1536
1537
1538
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1536

def billing_invoice_code
  @billing_invoice_code
end

#click_through_url_suffix_properties ⇒ Google::Apis::DfareportingV3_3::ClickThroughUrlSuffixProperties

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

Returns:



1541
1542
1543
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1541

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) 


1546
1547
1548
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1546

def comment
  @comment
end

#create_info ⇒ Google::Apis::DfareportingV3_3::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



1551
1552
1553
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1551

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


1556
1557
1558
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1556

def creative_group_ids
  @creative_group_ids
end

#creative_optimization_configuration ⇒ Google::Apis::DfareportingV3_3::CreativeOptimizationConfiguration

Creative optimization settings. Corresponds to the JSON property creativeOptimizationConfiguration

Returns:



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

def creative_optimization_configuration
  @creative_optimization_configuration
end

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

Returns:



1568
1569
1570
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1568

def default_click_through_event_tag_properties
  @default_click_through_event_tag_properties
end

#default_landing_page_id ⇒ Fixnum

The default landing page ID for this campaign. Corresponds to the JSON property defaultLandingPageId

Returns:

  • (Fixnum) 


1573
1574
1575
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1573

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


1583
1584
1585
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1583

def end_date
  @end_date
end

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

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

Returns:



1588
1589
1590
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1588

def event_tag_overrides
  @event_tag_overrides
end

#external_id ⇒ String

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

Returns:

  • (String) 


1593
1594
1595
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1593

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) 


1598
1599
1600
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1598

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



1603
1604
1605
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1603

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) 


1609
1610
1611
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1609

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV3_3::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



1614
1615
1616
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1614

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


1620
1621
1622
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1620

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) 


1625
1626
1627
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1625

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) 


1633
1634
1635
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1633

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) 


1639
1640
1641
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1639

def subaccount_id
  @subaccount_id
end

#trafficker_emails ⇒ Array<String>

Campaign trafficker contact emails. Corresponds to the JSON property traffickerEmails

Returns:

  • (Array<String>) 


1644
1645
1646
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1644

def trafficker_emails
  @trafficker_emails
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1651

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @ad_blocking_configuration = args[:ad_blocking_configuration] if args.key?(:ad_blocking_configuration)
  @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)
  @default_landing_page_id = args[:default_landing_page_id] if args.key?(:default_landing_page_id)
  @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)
  @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