Class: Google::Apis::DfareportingV3_1::Placement

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



8471
8472
8473
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8471

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

Instance Attribute Details

#account_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8222
8223
8224
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8222

def 
  @account_id
end

#ad_blocking_opt_out ⇒ Boolean Also known as: ad_blocking_opt_out?

Whether this placement opts out of ad blocking. When true, ad blocking is disabled for this placement. When false, the campaign and site settings take effect. Corresponds to the JSON property adBlockingOptOut

Returns:

  • (Boolean) 


8229
8230
8231
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8229

def ad_blocking_opt_out
  @ad_blocking_opt_out
end

#advertiser_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



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

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) 


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

def archived
  @archived
end

#campaign_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

def campaign_id
  @campaign_id
end

#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV3_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue

Returns:



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

def campaign_id_dimension_value
  @campaign_id_dimension_value
end

#comment ⇒ String

Comments for this placement. Corresponds to the JSON property comment

Returns:

  • (String) 


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

def comment
  @comment
end

#compatibility ⇒ String

Placement compatibility. DISPLAY and DISPLAY_INTERSTITIAL refer to rendering on desktop, on mobile devices or in mobile apps for regular or interstitial ads respectively. APP and APP_INTERSTITIAL are no longer allowed for new placement insertions. Instead, use DISPLAY or DISPLAY_INTERSTITIAL. 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) 


8271
8272
8273
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8271

def compatibility
  @compatibility
end

#content_category_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8276
8277
8278
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8276

def content_category_id
  @content_category_id
end

#create_info ⇒ Google::Apis::DfareportingV3_1::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



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

def create_info
  @create_info
end

#directory_site_id ⇒ Fixnum

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:

  • (Fixnum) 


8288
8289
8290
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8288

def directory_site_id
  @directory_site_id
end

#directory_site_id_dimension_value ⇒ Google::Apis::DfareportingV3_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property directorySiteIdDimensionValue

Returns:



8293
8294
8295
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8293

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) 


8298
8299
8300
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8298

def external_id
  @external_id
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8303
8304
8305
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8303

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV3_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



8308
8309
8310
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8308

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) 


8313
8314
8315
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8313

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) 


8319
8320
8321
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8319

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV3_1::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



8324
8325
8326
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8324

def last_modified_info
  @last_modified_info
end

#lookback_configuration ⇒ Google::Apis::DfareportingV3_1::LookbackConfiguration

Lookback configuration settings. Corresponds to the JSON property lookbackConfiguration

Returns:



8329
8330
8331
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8329

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) 


8335
8336
8337
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8335

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) 


8341
8342
8343
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8341

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) 


8348
8349
8350
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8348

def payment_source
  @payment_source
end

#placement_group_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8353
8354
8355
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8353

def placement_group_id
  @placement_group_id
end

#placement_group_id_dimension_value ⇒ Google::Apis::DfareportingV3_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property placementGroupIdDimensionValue

Returns:



8358
8359
8360
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8358

def placement_group_id_dimension_value
  @placement_group_id_dimension_value
end

#placement_strategy_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8363
8364
8365
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8363

def placement_strategy_id
  @placement_strategy_id
end

#pricing_schedule ⇒ Google::Apis::DfareportingV3_1::PricingSchedule

Pricing Schedule Corresponds to the JSON property pricingSchedule

Returns:



8368
8369
8370
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8368

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) 


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

def primary
  @primary
end

#publisher_update_info ⇒ Google::Apis::DfareportingV3_1::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property publisherUpdateInfo

Returns:



8383
8384
8385
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8383

def publisher_update_info
  @publisher_update_info
end

#site_id ⇒ Fixnum

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:

  • (Fixnum) 


8390
8391
8392
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8390

def site_id
  @site_id
end

#site_id_dimension_value ⇒ Google::Apis::DfareportingV3_1::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property siteIdDimensionValue

Returns:



8395
8396
8397
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8395

def site_id_dimension_value
  @site_id_dimension_value
end

#size ⇒ Google::Apis::DfareportingV3_1::Size

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

Returns:



8400
8401
8402
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8400

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) 


8405
8406
8407
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8405

def ssl_required
  @ssl_required
end

#status ⇒ String

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

Returns:

  • (String) 


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

def status
  @status
end

#subaccount_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


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

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_INSTREAM_VIDEO_PREFETCH_VAST_3"
  • "PLACEMENT_TAG_INSTREAM_VIDEO_PREFETCH_VAST_4"
  • "PLACEMENT_TAG_TRACKING"
  • "PLACEMENT_TAG_TRACKING_IFRAME"
  • "PLACEMENT_TAG_TRACKING_JAVASCRIPT" Corresponds to the JSON property tagFormats

Returns:

  • (Array<String>) 


8438
8439
8440
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8438

def tag_formats
  @tag_formats
end

#tag_setting ⇒ Google::Apis::DfareportingV3_1::TagSetting

Tag Settings Corresponds to the JSON property tagSetting

Returns:



8443
8444
8445
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8443

def tag_setting
  @tag_setting
end

#video_active_view_opt_out ⇒ Boolean Also known as: video_active_view_opt_out?

Whether Verification and ActiveView are disabled for in-stream video creatives for this placement. The same setting videoActiveViewOptOut exists on the site level -- the opt out occurs if either of these settings are true. These settings are distinct from DirectorySites.settings.activeViewOptOut or Sites. siteSettings.activeViewOptOut which only apply to display ads. However, Accounts.activeViewOptOut opts out both video traffic, as well as display ads, from Verification and ActiveView. Corresponds to the JSON property videoActiveViewOptOut

Returns:

  • (Boolean) 


8454
8455
8456
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8454

def video_active_view_opt_out
  @video_active_view_opt_out
end

#video_settings ⇒ Google::Apis::DfareportingV3_1::VideoSettings

Video Settings Corresponds to the JSON property videoSettings

Returns:



8460
8461
8462
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8460

def video_settings
  @video_settings
end

#vpaid_adapter_choice ⇒ String

VPAID adapter setting for this placement. Controls which VPAID format the measurement adapter will use for in-stream video creatives assigned to this placement. Note: Flash is no longer supported. This field now defaults to HTML5 when the following values are provided: FLASH, BOTH. Corresponds to the JSON property vpaidAdapterChoice

Returns:

  • (String) 


8469
8470
8471
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8469

def vpaid_adapter_choice
  @vpaid_adapter_choice
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
 
# File 'generated/google/apis/dfareporting_v3_1/classes.rb', line 8476

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @ad_blocking_opt_out = args[:ad_blocking_opt_out] if args.key?(:ad_blocking_opt_out)
  @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)
  @video_active_view_opt_out = args[:video_active_view_opt_out] if args.key?(:video_active_view_opt_out)
  @video_settings = args[:video_settings] if args.key?(:video_settings)
  @vpaid_adapter_choice = args[:vpaid_adapter_choice] if args.key?(:vpaid_adapter_choice)
end