Class: Google::Apis::DfareportingV3_2::PlacementGroup

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

Overview

Contains properties of a package or roadblock.

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

Returns a new instance of PlacementGroup



8755
8756
8757
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8755

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

Instance Attribute Details

#account_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8610
8611
8612
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8610

def 
  @account_id
end

#advertiser_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8615
8616
8617
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8615

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_2::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



8620
8621
8622
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8620

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) 


8625
8626
8627
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8625

def archived
  @archived
end

#campaign_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8631
8632
8633
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8631

def campaign_id
  @campaign_id
end

#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV3_2::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue

Returns:



8636
8637
8638
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8636

def campaign_id_dimension_value
  @campaign_id_dimension_value
end

#child_placement_ids ⇒ Array<Fixnum>

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


8642
8643
8644
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8642

def child_placement_ids
  @child_placement_ids
end

#comment ⇒ String

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

Returns:

  • (String) 


8647
8648
8649
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8647

def comment
  @comment
end

#content_category_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8652
8653
8654
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8652

def content_category_id
  @content_category_id
end

#create_info ⇒ Google::Apis::DfareportingV3_2::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



8657
8658
8659
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8657

def create_info
  @create_info
end

#directory_site_id ⇒ Fixnum

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:

  • (Fixnum) 


8665
8666
8667
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8665

def directory_site_id
  @directory_site_id
end

#directory_site_id_dimension_value ⇒ Google::Apis::DfareportingV3_2::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property directorySiteIdDimensionValue

Returns:



8670
8671
8672
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8670

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) 


8675
8676
8677
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8675

def external_id
  @external_id
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8680
8681
8682
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8680

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV3_2::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



8685
8686
8687
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8685

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) 


8691
8692
8693
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8691

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV3_2::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



8696
8697
8698
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8696

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) 


8702
8703
8704
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8702

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) 


8712
8713
8714
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8712

def placement_group_type
  @placement_group_type
end

#placement_strategy_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8717
8718
8719
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8717

def placement_strategy_id
  @placement_strategy_id
end

#pricing_schedule ⇒ Google::Apis::DfareportingV3_2::PricingSchedule

Pricing Schedule Corresponds to the JSON property pricingSchedule

Returns:



8722
8723
8724
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8722

def pricing_schedule
  @pricing_schedule
end

#primary_placement_id ⇒ Fixnum

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:

  • (Fixnum) 


8729
8730
8731
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8729

def primary_placement_id
  @primary_placement_id
end

#primary_placement_id_dimension_value ⇒ Google::Apis::DfareportingV3_2::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property primaryPlacementIdDimensionValue

Returns:



8734
8735
8736
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8734

def primary_placement_id_dimension_value
  @primary_placement_id_dimension_value
end

#site_id ⇒ Fixnum

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:

  • (Fixnum) 


8742
8743
8744
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8742

def site_id
  @site_id
end

#site_id_dimension_value ⇒ Google::Apis::DfareportingV3_2::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property siteIdDimensionValue

Returns:



8747
8748
8749
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8747

def site_id_dimension_value
  @site_id_dimension_value
end

#subaccount_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8753
8754
8755
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8753

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 8760

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