Class: Google::Apis::DfareportingV2_1::PlacementGroup

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 package or roadblock.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ PlacementGroup

Returns a new instance of PlacementGroup.



7636
7637
7638
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7636

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

Instance Attribute Details

#account_id ⇒ String

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

Returns:

  • (String) 


7486
7487
7488
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7486

def 
  @account_id
end

#advertiser_id ⇒ String

Advertiser ID of this placement group. This is a required field on insertion. Corresponds to the JSON property advertiserId

Returns:

  • (String) 


7491
7492
7493
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7491

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:



7496
7497
7498
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7496

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#archived ⇒ Boolean Also known as: archived?

Whether this placement group is archived. Corresponds to the JSON property archived

Returns:

  • (Boolean) 


7501
7502
7503
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7501

def archived
  @archived
end

#campaign_id ⇒ String

Campaign ID of this placement group. This field is required on insertion. Corresponds to the JSON property campaignId

Returns:

  • (String) 


7507
7508
7509
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7507

def campaign_id
  @campaign_id
end

#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue

Returns:



7512
7513
7514
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7512

def campaign_id_dimension_value
  @campaign_id_dimension_value
end

#child_placement_ids ⇒ Array<String>

IDs of placements which are assigned to this placement group. This is a read- only, auto-generated field. Corresponds to the JSON property childPlacementIds

Returns:

  • (Array<String>) 


7518
7519
7520
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7518

def child_placement_ids
  @child_placement_ids
end

#comment ⇒ String

Comments for this placement group. Corresponds to the JSON property comment

Returns:

  • (String) 


7523
7524
7525
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7523

def comment
  @comment
end

#content_category_id ⇒ String

ID of the content category assigned to this placement group. Corresponds to the JSON property contentCategoryId

Returns:

  • (String) 


7528
7529
7530
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7528

def content_category_id
  @content_category_id
end

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

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



7533
7534
7535
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7533

def create_info
  @create_info
end

#directory_site_id ⇒ String

Directory site ID associated with this placement group. On insert, you must set either this field or the site_id field to specify the site associated with this placement group. This is a required field that is read-only after insertion. Corresponds to the JSON property directorySiteId

Returns:

  • (String) 


7541
7542
7543
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7541

def directory_site_id
  @directory_site_id
end

#directory_site_id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property directorySiteIdDimensionValue

Returns:



7546
7547
7548
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7546

def directory_site_id_dimension_value
  @directory_site_id_dimension_value
end

#external_id ⇒ String

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

Returns:

  • (String) 


7551
7552
7553
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7551

def external_id
  @external_id
end

#id ⇒ String

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

Returns:

  • (String) 


7556
7557
7558
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7556

def id
  @id
end

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

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



7561
7562
7563
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7561

def id_dimension_value
  @id_dimension_value
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string " dfareporting#placementGroup". Corresponds to the JSON property kind

Returns:

  • (String) 


7567
7568
7569
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7567

def kind
  @kind
end

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

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



7572
7573
7574
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7572

def last_modified_info
  @last_modified_info
end

#name ⇒ String

Name of this placement group. This is a required field and must be less than 256 characters long. Corresponds to the JSON property name

Returns:

  • (String) 


7578
7579
7580
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7578

def name
  @name
end

#placement_group_type ⇒ String

Type of this placement group. A package is a simple group of placements that acts as a single pricing point for a group of tags. A roadblock is a group of placements that not only acts as a single pricing point, but also assumes that all the tags in it will be served at the same time. A roadblock requires one of its assigned placements to be marked as primary for reporting. This field is required on insertion. Corresponds to the JSON property placementGroupType

Returns:

  • (String) 


7588
7589
7590
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7588

def placement_group_type
  @placement_group_type
end

#placement_strategy_id ⇒ String

ID of the placement strategy assigned to this placement group. Corresponds to the JSON property placementStrategyId

Returns:

  • (String) 


7593
7594
7595
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7593

def placement_strategy_id
  @placement_strategy_id
end

#pricing_schedule ⇒ Google::Apis::DfareportingV2_1::PricingSchedule

Pricing Schedule Corresponds to the JSON property pricingSchedule

Returns:



7598
7599
7600
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7598

def pricing_schedule
  @pricing_schedule
end

#primary_placement_id ⇒ String

ID of the primary placement, used to calculate the media cost of a roadblock ( placement group). Modifying this field will automatically modify the primary field on all affected roadblock child placements. Corresponds to the JSON property primaryPlacementId

Returns:

  • (String) 


7605
7606
7607
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7605

def primary_placement_id
  @primary_placement_id
end

#primary_placement_id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property primaryPlacementIdDimensionValue

Returns:



7610
7611
7612
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7610

def primary_placement_id_dimension_value
  @primary_placement_id_dimension_value
end

#programmatic_setting ⇒ Google::Apis::DfareportingV2_1::ProgrammaticSetting

Programmatic Setting Corresponds to the JSON property programmaticSetting

Returns:



7615
7616
7617
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7615

def programmatic_setting
  @programmatic_setting
end

#site_id ⇒ String

Site ID associated with this placement group. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement group. This is a required field that is read-only after insertion. Corresponds to the JSON property siteId

Returns:

  • (String) 


7623
7624
7625
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7623

def site_id
  @site_id
end

#site_id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property siteIdDimensionValue

Returns:



7628
7629
7630
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7628

def site_id_dimension_value
  @site_id_dimension_value
end

#subaccount_id ⇒ String

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

Returns:

  • (String) 


7634
7635
7636
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7634

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7641

def update!(**args)
  @account_id = args[:account_id] unless args[:account_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?
  @campaign_id = args[:campaign_id] unless args[:campaign_id].nil?
  @campaign_id_dimension_value = args[:campaign_id_dimension_value] unless args[:campaign_id_dimension_value].nil?
  @child_placement_ids = args[:child_placement_ids] unless args[:child_placement_ids].nil?
  @comment = args[:comment] unless args[:comment].nil?
  @content_category_id = args[:content_category_id] unless args[:content_category_id].nil?
  @create_info = args[:create_info] unless args[:create_info].nil?
  @directory_site_id = args[:directory_site_id] unless args[:directory_site_id].nil?
  @directory_site_id_dimension_value = args[:directory_site_id_dimension_value] unless args[:directory_site_id_dimension_value].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?
  @name = args[:name] unless args[:name].nil?
  @placement_group_type = args[:placement_group_type] unless args[:placement_group_type].nil?
  @placement_strategy_id = args[:placement_strategy_id] unless args[:placement_strategy_id].nil?
  @pricing_schedule = args[:pricing_schedule] unless args[:pricing_schedule].nil?
  @primary_placement_id = args[:primary_placement_id] unless args[:primary_placement_id].nil?
  @primary_placement_id_dimension_value = args[:primary_placement_id_dimension_value] unless args[:primary_placement_id_dimension_value].nil?
  @programmatic_setting = args[:programmatic_setting] unless args[:programmatic_setting].nil?
  @site_id = args[:site_id] unless args[:site_id].nil?
  @site_id_dimension_value = args[:site_id_dimension_value] unless args[:site_id_dimension_value].nil?
  @subaccount_id = args[:subaccount_id] unless args[:subaccount_id].nil?
end