Class: Google::Apis::DfareportingV2_7::PlacementGroup

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



8375
8376
8377
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8375

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

Instance Attribute Details

#account_id ⇒ String

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) 


8230
8231
8232
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8230

def 
  @account_id
end

#advertiser_id ⇒ String

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

Returns:

  • (String) 


8235
8236
8237
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8235

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV2_7::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



8240
8241
8242
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8240

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) 


8245
8246
8247
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8245

def archived
  @archived
end

#campaign_id ⇒ String

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

Returns:

  • (String) 


8251
8252
8253
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8251

def campaign_id
  @campaign_id
end

#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV2_7::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue

Returns:



8256
8257
8258
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8256

def campaign_id_dimension_value
  @campaign_id_dimension_value
end

#child_placement_ids ⇒ Array<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>) 


8262
8263
8264
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8262

def child_placement_ids
  @child_placement_ids
end

#comment ⇒ String

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

Returns:

  • (String) 


8267
8268
8269
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8267

def comment
  @comment
end

#content_category_id ⇒ String

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

Returns:

  • (String) 


8272
8273
8274
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8272

def content_category_id
  @content_category_id
end

#create_info ⇒ Google::Apis::DfareportingV2_7::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



8277
8278
8279
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8277

def create_info
  @create_info
end

#directory_site_id ⇒ String

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) 


8285
8286
8287
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8285

def directory_site_id
  @directory_site_id
end

#directory_site_id_dimension_value ⇒ Google::Apis::DfareportingV2_7::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property directorySiteIdDimensionValue

Returns:



8290
8291
8292
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8290

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) 


8295
8296
8297
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8295

def external_id
  @external_id
end

#id ⇒ String

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

Returns:

  • (String) 


8300
8301
8302
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8300

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV2_7::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



8305
8306
8307
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8305

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) 


8311
8312
8313
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8311

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV2_7::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



8316
8317
8318
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8316

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) 


8322
8323
8324
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8322

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) 


8332
8333
8334
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8332

def placement_group_type
  @placement_group_type
end

#placement_strategy_id ⇒ String

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

Returns:

  • (String) 


8337
8338
8339
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8337

def placement_strategy_id
  @placement_strategy_id
end

#pricing_schedule ⇒ Google::Apis::DfareportingV2_7::PricingSchedule

Pricing Schedule Corresponds to the JSON property pricingSchedule

Returns:



8342
8343
8344
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8342

def pricing_schedule
  @pricing_schedule
end

#primary_placement_id ⇒ String

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) 


8349
8350
8351
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8349

def primary_placement_id
  @primary_placement_id
end

#primary_placement_id_dimension_value ⇒ Google::Apis::DfareportingV2_7::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property primaryPlacementIdDimensionValue

Returns:



8354
8355
8356
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8354

def primary_placement_id_dimension_value
  @primary_placement_id_dimension_value
end

#site_id ⇒ String

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) 


8362
8363
8364
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8362

def site_id
  @site_id
end

#site_id_dimension_value ⇒ Google::Apis::DfareportingV2_7::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property siteIdDimensionValue

Returns:



8367
8368
8369
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8367

def site_id_dimension_value
  @site_id_dimension_value
end

#subaccount_id ⇒ String

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) 


8373
8374
8375
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8373

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 8380

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