Class: Google::Apis::DfareportingV2_3::Placement

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

Overview

Contains properties of a placement.

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

Returns a new instance of Placement.



7479
7480
7481
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7479

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) 


7267
7268
7269
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7267

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) 


7272
7273
7274
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7272

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV2_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



7277
7278
7279
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7277

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) 


7282
7283
7284
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7282

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) 


7288
7289
7290
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7288

def campaign_id
  @campaign_id
end

#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV2_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue

Returns:



7293
7294
7295
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7293

def campaign_id_dimension_value
  @campaign_id_dimension_value
end

#comment ⇒ String

Comments for this placement. Corresponds to the JSON property comment

Returns:

  • (String) 


7298
7299
7300
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7298

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) 


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

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) 


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

def content_category_id
  @content_category_id
end

#create_info ⇒ Google::Apis::DfareportingV2_3::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



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

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) 


7324
7325
7326
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7324

def directory_site_id
  @directory_site_id
end

#directory_site_id_dimension_value ⇒ Google::Apis::DfareportingV2_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property directorySiteIdDimensionValue

Returns:



7329
7330
7331
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7329

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) 


7334
7335
7336
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7334

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) 


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

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV2_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



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

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) 


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

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) 


7355
7356
7357
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7355

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV2_3::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



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

def last_modified_info
  @last_modified_info
end

#lookback_configuration ⇒ Google::Apis::DfareportingV2_3::LookbackConfiguration

Lookback configuration settings. Corresponds to the JSON property lookbackConfiguration

Returns:



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

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) 


7371
7372
7373
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7371

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) 


7377
7378
7379
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7377

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) 


7384
7385
7386
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7384

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) 


7389
7390
7391
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7389

def placement_group_id
  @placement_group_id
end

#placement_group_id_dimension_value ⇒ Google::Apis::DfareportingV2_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property placementGroupIdDimensionValue

Returns:



7394
7395
7396
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7394

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) 


7399
7400
7401
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7399

def placement_strategy_id
  @placement_strategy_id
end

#pricing_schedule ⇒ Google::Apis::DfareportingV2_3::PricingSchedule

Pricing Schedule Corresponds to the JSON property pricingSchedule

Returns:



7404
7405
7406
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7404

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) 


7413
7414
7415
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7413

def primary
  @primary
end

#publisher_update_info ⇒ Google::Apis::DfareportingV2_3::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property publisherUpdateInfo

Returns:



7419
7420
7421
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7419

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) 


7426
7427
7428
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7426

def site_id
  @site_id
end

#site_id_dimension_value ⇒ Google::Apis::DfareportingV2_3::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property siteIdDimensionValue

Returns:



7431
7432
7433
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7431

def site_id_dimension_value
  @site_id_dimension_value
end

#size ⇒ Google::Apis::DfareportingV2_3::Size

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

Returns:



7436
7437
7438
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7436

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) 


7441
7442
7443
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7441

def ssl_required
  @ssl_required
end

#status ⇒ String

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

Returns:

  • (String) 


7447
7448
7449
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7447

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) 


7452
7453
7454
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7452

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


7472
7473
7474
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7472

def tag_formats
  @tag_formats
end

#tag_setting ⇒ Google::Apis::DfareportingV2_3::TagSetting

Tag Settings Corresponds to the JSON property tagSetting

Returns:



7477
7478
7479
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7477

def tag_setting
  @tag_setting
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
 
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 7484

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)
  @comment = args[:comment] if args.key?(:comment)
  @compatibility = args[:compatibility] if args.key?(:compatibility)
  @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)
  @key_name = args[:key_name] if args.key?(:key_name)
  @kind = args[:kind] if args.key?(:kind)
  @last_modified_info = args[:last_modified_info] if args.key?(:last_modified_info)
  @lookback_configuration = args[:lookback_configuration] if args.key?(:lookback_configuration)
  @name = args[:name] if args.key?(:name)
  @payment_approved = args[:payment_approved] if args.key?(:payment_approved)
  @payment_source = args[:payment_source] if args.key?(:payment_source)
  @placement_group_id = args[:placement_group_id] if args.key?(:placement_group_id)
  @placement_group_id_dimension_value = args[:placement_group_id_dimension_value] if args.key?(:placement_group_id_dimension_value)
  @placement_strategy_id = args[:placement_strategy_id] if args.key?(:placement_strategy_id)
  @pricing_schedule = args[:pricing_schedule] if args.key?(:pricing_schedule)
  @primary = args[:primary] if args.key?(:primary)
  @publisher_update_info = args[:publisher_update_info] if args.key?(:publisher_update_info)
  @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)
  @size = args[:size] if args.key?(:size)
  @ssl_required = args[:ssl_required] if args.key?(:ssl_required)
  @status = args[:status] if args.key?(:status)
  @subaccount_id = args[:subaccount_id] if args.key?(:subaccount_id)
  @tag_formats = args[:tag_formats] if args.key?(:tag_formats)
  @tag_setting = args[:tag_setting] if args.key?(:tag_setting)
end