Class: Google::Apis::DfareportingV3_0::PlacementGroup

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



8573
8574
8575
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8573

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) 


8428
8429
8430
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8428

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) 


8433
8434
8435
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8433

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_0::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



8438
8439
8440
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8438

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) 


8443
8444
8445
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8443

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) 


8449
8450
8451
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8449

def campaign_id
  @campaign_id
end

#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV3_0::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue

Returns:



8454
8455
8456
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8454

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


8460
8461
8462
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8460

def child_placement_ids
  @child_placement_ids
end

#comment ⇒ String

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

Returns:

  • (String) 


8465
8466
8467
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8465

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) 


8470
8471
8472
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8470

def content_category_id
  @content_category_id
end

#create_info ⇒ Google::Apis::DfareportingV3_0::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



8475
8476
8477
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8475

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) 


8483
8484
8485
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8483

def directory_site_id
  @directory_site_id
end

#directory_site_id_dimension_value ⇒ Google::Apis::DfareportingV3_0::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property directorySiteIdDimensionValue

Returns:



8488
8489
8490
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8488

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) 


8493
8494
8495
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8493

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) 


8498
8499
8500
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8498

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV3_0::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



8503
8504
8505
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8503

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) 


8509
8510
8511
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8509

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV3_0::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



8514
8515
8516
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8514

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) 


8520
8521
8522
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8520

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) 


8530
8531
8532
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8530

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) 


8535
8536
8537
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8535

def placement_strategy_id
  @placement_strategy_id
end

#pricing_schedule ⇒ Google::Apis::DfareportingV3_0::PricingSchedule

Pricing Schedule Corresponds to the JSON property pricingSchedule

Returns:



8540
8541
8542
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8540

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) 


8547
8548
8549
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8547

def primary_placement_id
  @primary_placement_id
end

#primary_placement_id_dimension_value ⇒ Google::Apis::DfareportingV3_0::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property primaryPlacementIdDimensionValue

Returns:



8552
8553
8554
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8552

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) 


8560
8561
8562
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8560

def site_id
  @site_id
end

#site_id_dimension_value ⇒ Google::Apis::DfareportingV3_0::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property siteIdDimensionValue

Returns:



8565
8566
8567
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8565

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) 


8571
8572
8573
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8571

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
 
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 8578

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