Class: Google::Apis::DfareportingV2_8::PlacementGroup

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



8504
8505
8506
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8504

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) 


8359
8360
8361
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8359

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) 


8364
8365
8366
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8364

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV2_8::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



8369
8370
8371
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8369

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) 


8374
8375
8376
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8374

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) 


8380
8381
8382
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8380

def campaign_id
  @campaign_id
end

#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV2_8::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue

Returns:



8385
8386
8387
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8385

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


8391
8392
8393
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8391

def child_placement_ids
  @child_placement_ids
end

#comment ⇒ String

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

Returns:

  • (String) 


8396
8397
8398
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8396

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) 


8401
8402
8403
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8401

def content_category_id
  @content_category_id
end

#create_info ⇒ Google::Apis::DfareportingV2_8::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



8406
8407
8408
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8406

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) 


8414
8415
8416
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8414

def directory_site_id
  @directory_site_id
end

#directory_site_id_dimension_value ⇒ Google::Apis::DfareportingV2_8::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property directorySiteIdDimensionValue

Returns:



8419
8420
8421
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8419

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) 


8424
8425
8426
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8424

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) 


8429
8430
8431
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8429

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV2_8::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



8434
8435
8436
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8434

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) 


8440
8441
8442
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8440

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV2_8::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



8445
8446
8447
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8445

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) 


8451
8452
8453
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8451

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) 


8461
8462
8463
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8461

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) 


8466
8467
8468
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8466

def placement_strategy_id
  @placement_strategy_id
end

#pricing_schedule ⇒ Google::Apis::DfareportingV2_8::PricingSchedule

Pricing Schedule Corresponds to the JSON property pricingSchedule

Returns:



8471
8472
8473
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8471

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) 


8478
8479
8480
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8478

def primary_placement_id
  @primary_placement_id
end

#primary_placement_id_dimension_value ⇒ Google::Apis::DfareportingV2_8::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property primaryPlacementIdDimensionValue

Returns:



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

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) 


8491
8492
8493
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8491

def site_id
  @site_id
end

#site_id_dimension_value ⇒ Google::Apis::DfareportingV2_8::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property siteIdDimensionValue

Returns:



8496
8497
8498
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8496

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) 


8502
8503
8504
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8502

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8509

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