Class: Google::Apis::DfareportingV2_3::PlacementGroup

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v2_3/classes.rb,
generated/google/apis/dfareporting_v2_3/representations.rb,
generated/google/apis/dfareporting_v2_3/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.


7718
7719
7720
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7718

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

Instance Attribute Details

#account_idString

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)

7573
7574
7575
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7573

def 
  @account_id
end

#advertiser_idString

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

Returns:

  • (String)

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

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_valueGoogle::Apis::DfareportingV2_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue


7583
7584
7585
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7583

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#archivedBoolean Also known as: archived?

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

Returns:

  • (Boolean)

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

def archived
  @archived
end

#campaign_idString

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

Returns:

  • (String)

7594
7595
7596
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7594

def campaign_id
  @campaign_id
end

#campaign_id_dimension_valueGoogle::Apis::DfareportingV2_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue


7599
7600
7601
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7599

def campaign_id_dimension_value
  @campaign_id_dimension_value
end

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

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

def child_placement_ids
  @child_placement_ids
end

#commentString

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

Returns:

  • (String)

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

def comment
  @comment
end

#content_category_idString

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

Returns:

  • (String)

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

def 
  @content_category_id
end

#create_infoGoogle::Apis::DfareportingV2_3::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo


7620
7621
7622
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7620

def create_info
  @create_info
end

#directory_site_idString

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)

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

def directory_site_id
  @directory_site_id
end

#directory_site_id_dimension_valueGoogle::Apis::DfareportingV2_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property directorySiteIdDimensionValue


7633
7634
7635
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7633

def directory_site_id_dimension_value
  @directory_site_id_dimension_value
end

#external_idString

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

Returns:

  • (String)

7638
7639
7640
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7638

def external_id
  @external_id
end

#idString

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

Returns:

  • (String)

7643
7644
7645
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7643

def id
  @id
end

#id_dimension_valueGoogle::Apis::DfareportingV2_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue


7648
7649
7650
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7648

def id_dimension_value
  @id_dimension_value
end

#kindString

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

Returns:

  • (String)

7654
7655
7656
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7654

def kind
  @kind
end

#last_modified_infoGoogle::Apis::DfareportingV2_3::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo


7659
7660
7661
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7659

def last_modified_info
  @last_modified_info
end

#nameString

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)

7665
7666
7667
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7665

def name
  @name
end

#placement_group_typeString

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)

7675
7676
7677
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7675

def placement_group_type
  @placement_group_type
end

#placement_strategy_idString

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

Returns:

  • (String)

7680
7681
7682
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7680

def placement_strategy_id
  @placement_strategy_id
end

#pricing_scheduleGoogle::Apis::DfareportingV2_3::PricingSchedule

Pricing Schedule Corresponds to the JSON property pricingSchedule


7685
7686
7687
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7685

def pricing_schedule
  @pricing_schedule
end

#primary_placement_idString

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)

7692
7693
7694
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7692

def primary_placement_id
  @primary_placement_id
end

#primary_placement_id_dimension_valueGoogle::Apis::DfareportingV2_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property primaryPlacementIdDimensionValue


7697
7698
7699
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7697

def primary_placement_id_dimension_value
  @primary_placement_id_dimension_value
end

#site_idString

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)

7705
7706
7707
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7705

def site_id
  @site_id
end

#site_id_dimension_valueGoogle::Apis::DfareportingV2_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property siteIdDimensionValue


7710
7711
7712
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7710

def site_id_dimension_value
  @site_id_dimension_value
end

#subaccount_idString

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)

7716
7717
7718
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7716

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7723

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