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 more...

Overview

Contains properties of a Campaign Manager campaign.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Campaign

Returns a new instance of Campaign.

[View source]

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

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) 

1422
1423
1424
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1422

def 
  @account_id
end

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

Campaign ad blocking settings. Corresponds to the JSON property adBlockingConfiguration

Returns:


1427
1428
1429
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1427

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:


1432
1433
1434
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1432

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) 

1437
1438
1439
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1437

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) 

1442
1443
1444
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1442

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:


1447
1448
1449
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1447

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) 

1452
1453
1454
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1452

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:


1459
1460
1461
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1459

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) 

1465
1466
1467
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1465

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:


1470
1471
1472
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1470

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) 

1475
1476
1477
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1475

def comment
  @comment
end

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

Modification timestamp. Corresponds to the JSON property createInfo

Returns:


1480
1481
1482
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1480

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

1485
1486
1487
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1485

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:


1490
1491
1492
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1490

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:


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

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) 

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

def default_landing_page_id
  @default_landing_page_id
end

#end_date ⇒ Date

Corresponds to the JSON property endDate

Returns:

  • (Date) 

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

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:


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

def event_tag_overrides
  @event_tag_overrides
end

#external_id ⇒ String

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

Returns:

  • (String) 

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

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) 

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

def id
  @id
end

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

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:


1527
1528
1529
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1527

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) 

1533
1534
1535
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1533

def kind
  @kind
end

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

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:


1538
1539
1540
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1538

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) 

1544
1545
1546
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1544

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) 

1549
1550
1551
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1549

def nielsen_ocr_enabled
  @nielsen_ocr_enabled
end

#start_date ⇒ Date

Corresponds to the JSON property startDate

Returns:

  • (Date) 

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

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) 

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

def subaccount_id
  @subaccount_id
end

#trafficker_emails ⇒ Array<String>

Campaign trafficker contact emails. Corresponds to the JSON property traffickerEmails

Returns:

  • (Array<String>) 

1566
1567
1568
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1566

def trafficker_emails
  @trafficker_emails
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 1573

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