Class: Google::Apis::DfareportingV2_6::PlacementGroup

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


8294
8295
8296
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8294

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)

8149
8150
8151
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8149

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)

8154
8155
8156
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8154

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_valueGoogle::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue


8159
8160
8161
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8159

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)

8164
8165
8166
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8164

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)

8170
8171
8172
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8170

def campaign_id
  @campaign_id
end

#campaign_id_dimension_valueGoogle::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue


8175
8176
8177
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8175

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

8181
8182
8183
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8181

def child_placement_ids
  @child_placement_ids
end

#commentString

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

Returns:

  • (String)

8186
8187
8188
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8186

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)

8191
8192
8193
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8191

def 
  @content_category_id
end

#create_infoGoogle::Apis::DfareportingV2_6::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo


8196
8197
8198
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8196

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)

8204
8205
8206
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8204

def directory_site_id
  @directory_site_id
end

#directory_site_id_dimension_valueGoogle::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property directorySiteIdDimensionValue


8209
8210
8211
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8209

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)

8214
8215
8216
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8214

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)

8219
8220
8221
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8219

def id
  @id
end

#id_dimension_valueGoogle::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue


8224
8225
8226
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8224

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)

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

def kind
  @kind
end

#last_modified_infoGoogle::Apis::DfareportingV2_6::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo


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

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)

8241
8242
8243
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8241

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)

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

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)

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

def placement_strategy_id
  @placement_strategy_id
end

#pricing_scheduleGoogle::Apis::DfareportingV2_6::PricingSchedule

Pricing Schedule Corresponds to the JSON property pricingSchedule


8261
8262
8263
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8261

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)

8268
8269
8270
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8268

def primary_placement_id
  @primary_placement_id
end

#primary_placement_id_dimension_valueGoogle::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property primaryPlacementIdDimensionValue


8273
8274
8275
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8273

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)

8281
8282
8283
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8281

def site_id
  @site_id
end

#site_id_dimension_valueGoogle::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property siteIdDimensionValue


8286
8287
8288
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8286

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)

8292
8293
8294
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8292

def subaccount_id
  @subaccount_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8299

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