Class: Google::Apis::DfareportingV2_1::Placement

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable
Defined in:
generated/google/apis/dfareporting_v2_1/classes.rb,
generated/google/apis/dfareporting_v2_1/representations.rb,
generated/google/apis/dfareporting_v2_1/representations.rb

Overview

Contains properties of a placement.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Placement

Returns a new instance of Placement.



7392
7393
7394
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7392

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

Instance Attribute Details

#account_id ⇒ String

Account ID of this placement. This field can be left blank. Corresponds to the JSON property accountId

Returns:

  • (String) 


7180
7181
7182
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7180

def 
  @account_id
end

#advertiser_id ⇒ String

Advertiser ID of this placement. This field can be left blank. Corresponds to the JSON property advertiserId

Returns:

  • (String) 


7185
7186
7187
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7185

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



7190
7191
7192
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7190

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
end

#archived ⇒ Boolean Also known as: archived?

Whether this placement is archived. Corresponds to the JSON property archived

Returns:

  • (Boolean) 


7195
7196
7197
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7195

def archived
  @archived
end

#campaign_id ⇒ String

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

Returns:

  • (String) 


7201
7202
7203
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7201

def campaign_id
  @campaign_id
end

#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue

Returns:



7206
7207
7208
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7206

def campaign_id_dimension_value
  @campaign_id_dimension_value
end

#comment ⇒ String

Comments for this placement. Corresponds to the JSON property comment

Returns:

  • (String) 


7211
7212
7213
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7211

def comment
  @comment
end

#compatibility ⇒ String

Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps.IN_STREAM_VIDEO refers to rendering in in-stream video ads developed with the VAST standard. This field is required on insertion. Corresponds to the JSON property compatibility

Returns:

  • (String) 


7220
7221
7222
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7220

def compatibility
  @compatibility
end

#content_category_id ⇒ String

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

Returns:

  • (String) 


7225
7226
7227
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7225

def content_category_id
  @content_category_id
end

#create_info ⇒ Google::Apis::DfareportingV2_1::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



7230
7231
7232
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7230

def create_info
  @create_info
end

#directory_site_id ⇒ String

Directory site ID of this placement. On insert, you must set either this field or the siteId field to specify the site associated with this placement. This is a required field that is read-only after insertion. Corresponds to the JSON property directorySiteId

Returns:

  • (String) 


7237
7238
7239
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7237

def directory_site_id
  @directory_site_id
end

#directory_site_id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property directorySiteIdDimensionValue

Returns:



7242
7243
7244
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7242

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) 


7247
7248
7249
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7247

def external_id
  @external_id
end

#id ⇒ String

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

Returns:

  • (String) 


7252
7253
7254
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7252

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



7257
7258
7259
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7257

def id_dimension_value
  @id_dimension_value
end

#key_name ⇒ String

Key name of this placement. This is a read-only, auto-generated field. Corresponds to the JSON property keyName

Returns:

  • (String) 


7262
7263
7264
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7262

def key_name
  @key_name
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string " dfareporting#placement". Corresponds to the JSON property kind

Returns:

  • (String) 


7268
7269
7270
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7268

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV2_1::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



7273
7274
7275
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7273

def last_modified_info
  @last_modified_info
end

#lookback_configuration ⇒ Google::Apis::DfareportingV2_1::LookbackConfiguration

Lookback configuration settings. Corresponds to the JSON property lookbackConfiguration

Returns:



7278
7279
7280
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7278

def lookback_configuration
  @lookback_configuration
end

#name ⇒ String

Name of this placement.This is a required field and must be less than 256 characters long. Corresponds to the JSON property name

Returns:

  • (String) 


7284
7285
7286
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7284

def name
  @name
end

#payment_approved ⇒ Boolean Also known as: payment_approved?

Whether payment was approved for this placement. This is a read-only field relevant only to publisher-paid placements. Corresponds to the JSON property paymentApproved

Returns:

  • (Boolean) 


7290
7291
7292
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7290

def payment_approved
  @payment_approved
end

#payment_source ⇒ String

Payment source for this placement. This is a required field that is read-only after insertion. Corresponds to the JSON property paymentSource

Returns:

  • (String) 


7297
7298
7299
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7297

def payment_source
  @payment_source
end

#placement_group_id ⇒ String

ID of this placement's group, if applicable. Corresponds to the JSON property placementGroupId

Returns:

  • (String) 


7302
7303
7304
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7302

def placement_group_id
  @placement_group_id
end

#placement_group_id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property placementGroupIdDimensionValue

Returns:



7307
7308
7309
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7307

def placement_group_id_dimension_value
  @placement_group_id_dimension_value
end

#placement_strategy_id ⇒ String

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

Returns:

  • (String) 


7312
7313
7314
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7312

def placement_strategy_id
  @placement_strategy_id
end

#pricing_schedule ⇒ Google::Apis::DfareportingV2_1::PricingSchedule

Pricing Schedule Corresponds to the JSON property pricingSchedule

Returns:



7317
7318
7319
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7317

def pricing_schedule
  @pricing_schedule
end

#primary ⇒ Boolean Also known as: primary?

Whether this placement is the primary placement of a roadblock (placement group). You cannot change this field from true to false. Setting this field to true will automatically set the primary field on the original primary placement of the roadblock to false, and it will automatically set the roadblock's primaryPlacementId field to the ID of this placement. Corresponds to the JSON property primary

Returns:

  • (Boolean) 


7326
7327
7328
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7326

def primary
  @primary
end

#publisher_update_info ⇒ Google::Apis::DfareportingV2_1::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property publisherUpdateInfo

Returns:



7332
7333
7334
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7332

def publisher_update_info
  @publisher_update_info
end

#site_id ⇒ String

Site ID associated with this placement. On insert, you must set either this field or the directorySiteId field to specify the site associated with this placement. This is a required field that is read-only after insertion. Corresponds to the JSON property siteId

Returns:

  • (String) 


7339
7340
7341
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7339

def site_id
  @site_id
end

#site_id_dimension_value ⇒ Google::Apis::DfareportingV2_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property siteIdDimensionValue

Returns:



7344
7345
7346
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7344

def site_id_dimension_value
  @site_id_dimension_value
end

#size ⇒ Google::Apis::DfareportingV2_1::Size

Represents the dimensions of ads, placements, creatives, or creative assets. Corresponds to the JSON property size

Returns:



7349
7350
7351
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7349

def size
  @size
end

#ssl_required ⇒ Boolean Also known as: ssl_required?

Whether creatives assigned to this placement must be SSL-compliant. Corresponds to the JSON property sslRequired

Returns:

  • (Boolean) 


7354
7355
7356
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7354

def ssl_required
  @ssl_required
end

#status ⇒ String

Third-party placement status. Corresponds to the JSON property status

Returns:

  • (String) 


7360
7361
7362
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7360

def status
  @status
end

#subaccount_id ⇒ String

Subaccount ID of this placement. This field can be left blank. Corresponds to the JSON property subaccountId

Returns:

  • (String) 


7365
7366
7367
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7365

def subaccount_id
  @subaccount_id
end

#tag_formats ⇒ Array<String>

Tag formats to generate for this placement. This field is required on insertion. Acceptable values are:

  • "PLACEMENT_TAG_STANDARD"
  • "PLACEMENT_TAG_IFRAME_JAVASCRIPT"
  • "PLACEMENT_TAG_IFRAME_ILAYER"
  • "PLACEMENT_TAG_INTERNAL_REDIRECT"
  • "PLACEMENT_TAG_JAVASCRIPT"
  • "PLACEMENT_TAG_INTERSTITIAL_IFRAME_JAVASCRIPT"
  • "PLACEMENT_TAG_INTERSTITIAL_INTERNAL_REDIRECT"
  • "PLACEMENT_TAG_INTERSTITIAL_JAVASCRIPT"
  • "PLACEMENT_TAG_CLICK_COMMANDS"
  • "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH"
  • "PLACEMENT_TAG_TRACKING"
  • "PLACEMENT_TAG_TRACKING_IFRAME"
  • "PLACEMENT_TAG_TRACKING_JAVASCRIPT" Corresponds to the JSON property tagFormats

Returns:

  • (Array<String>) 


7385
7386
7387
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7385

def tag_formats
  @tag_formats
end

#tag_setting ⇒ Google::Apis::DfareportingV2_1::TagSetting

Tag Settings Corresponds to the JSON property tagSetting

Returns:



7390
7391
7392
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7390

def tag_setting
  @tag_setting
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 7397

def update!(**args)
  @account_id = args[:account_id] unless args[:account_id].nil?
  @advertiser_id = args[:advertiser_id] unless args[:advertiser_id].nil?
  @advertiser_id_dimension_value = args[:advertiser_id_dimension_value] unless args[:advertiser_id_dimension_value].nil?
  @archived = args[:archived] unless args[:archived].nil?
  @campaign_id = args[:campaign_id] unless args[:campaign_id].nil?
  @campaign_id_dimension_value = args[:campaign_id_dimension_value] unless args[:campaign_id_dimension_value].nil?
  @comment = args[:comment] unless args[:comment].nil?
  @compatibility = args[:compatibility] unless args[:compatibility].nil?
  @content_category_id = args[:content_category_id] unless args[:content_category_id].nil?
  @create_info = args[:create_info] unless args[:create_info].nil?
  @directory_site_id = args[:directory_site_id] unless args[:directory_site_id].nil?
  @directory_site_id_dimension_value = args[:directory_site_id_dimension_value] unless args[:directory_site_id_dimension_value].nil?
  @external_id = args[:external_id] unless args[:external_id].nil?
  @id = args[:id] unless args[:id].nil?
  @id_dimension_value = args[:id_dimension_value] unless args[:id_dimension_value].nil?
  @key_name = args[:key_name] unless args[:key_name].nil?
  @kind = args[:kind] unless args[:kind].nil?
  @last_modified_info = args[:last_modified_info] unless args[:last_modified_info].nil?
  @lookback_configuration = args[:lookback_configuration] unless args[:lookback_configuration].nil?
  @name = args[:name] unless args[:name].nil?
  @payment_approved = args[:payment_approved] unless args[:payment_approved].nil?
  @payment_source = args[:payment_source] unless args[:payment_source].nil?
  @placement_group_id = args[:placement_group_id] unless args[:placement_group_id].nil?
  @placement_group_id_dimension_value = args[:placement_group_id_dimension_value] unless args[:placement_group_id_dimension_value].nil?
  @placement_strategy_id = args[:placement_strategy_id] unless args[:placement_strategy_id].nil?
  @pricing_schedule = args[:pricing_schedule] unless args[:pricing_schedule].nil?
  @primary = args[:primary] unless args[:primary].nil?
  @publisher_update_info = args[:publisher_update_info] unless args[:publisher_update_info].nil?
  @site_id = args[:site_id] unless args[:site_id].nil?
  @site_id_dimension_value = args[:site_id_dimension_value] unless args[:site_id_dimension_value].nil?
  @size = args[:size] unless args[:size].nil?
  @ssl_required = args[:ssl_required] unless args[:ssl_required].nil?
  @status = args[:status] unless args[:status].nil?
  @subaccount_id = args[:subaccount_id] unless args[:subaccount_id].nil?
  @tag_formats = args[:tag_formats] unless args[:tag_formats].nil?
  @tag_setting = args[:tag_setting] unless args[:tag_setting].nil?
end