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



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

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) 


8356
8357
8358
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8356

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) 


8361
8362
8363
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8361

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:



8366
8367
8368
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8366

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) 


8371
8372
8373
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8371

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) 


8377
8378
8379
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8377

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:



8382
8383
8384
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8382

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


8388
8389
8390
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8388

def child_placement_ids
  @child_placement_ids
end

#comment ⇒ String

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

Returns:

  • (String) 


8393
8394
8395
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8393

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) 


8398
8399
8400
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8398

def content_category_id
  @content_category_id
end

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

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



8403
8404
8405
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8403

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) 


8411
8412
8413
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8411

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:



8416
8417
8418
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8416

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) 


8421
8422
8423
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8421

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) 


8426
8427
8428
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8426

def id
  @id
end

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

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



8431
8432
8433
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8431

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) 


8437
8438
8439
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8437

def kind
  @kind
end

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

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



8442
8443
8444
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8442

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) 


8448
8449
8450
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8448

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) 


8458
8459
8460
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8458

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) 


8463
8464
8465
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8463

def placement_strategy_id
  @placement_strategy_id
end

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

Pricing Schedule Corresponds to the JSON property pricingSchedule

Returns:



8468
8469
8470
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8468

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) 


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

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:



8480
8481
8482
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8480

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) 


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

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:



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

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) 


8499
8500
8501
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8499

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8506
8507
8508
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
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 8506

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