Class: Google::Apis::DfareportingV3_4::Placement

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



8770
8771
8772
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8770

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) 


8515
8516
8517
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8515

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) 


8522
8523
8524
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8522

def ad_blocking_opt_out
  @ad_blocking_opt_out
end

#additional_sizes ⇒ Array<Google::Apis::DfareportingV3_4::Size>

Additional sizes associated with this placement. When inserting or updating a placement, only the size ID field is used. Corresponds to the JSON property additionalSizes

Returns:



8529
8530
8531
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8529

def additional_sizes
  @additional_sizes
end

#advertiser_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


8534
8535
8536
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8534

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



8539
8540
8541
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8539

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) 


8544
8545
8546
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8544

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) 


8550
8551
8552
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8550

def campaign_id
  @campaign_id
end

#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV3_4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue

Returns:



8555
8556
8557
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8555

def campaign_id_dimension_value
  @campaign_id_dimension_value
end

#comment ⇒ String

Comments for this placement. Corresponds to the JSON property comment

Returns:

  • (String) 


8560
8561
8562
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8560

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) 


8570
8571
8572
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8570

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) 


8575
8576
8577
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8575

def content_category_id
  @content_category_id
end

#create_info ⇒ Google::Apis::DfareportingV3_4::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



8580
8581
8582
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8580

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) 


8587
8588
8589
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8587

def directory_site_id
  @directory_site_id
end

#directory_site_id_dimension_value ⇒ Google::Apis::DfareportingV3_4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property directorySiteIdDimensionValue

Returns:



8592
8593
8594
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8592

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) 


8597
8598
8599
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8597

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) 


8602
8603
8604
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8602

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV3_4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



8607
8608
8609
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8607

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) 


8612
8613
8614
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8612

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) 


8618
8619
8620
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8618

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV3_4::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



8623
8624
8625
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8623

def last_modified_info
  @last_modified_info
end

#lookback_configuration ⇒ Google::Apis::DfareportingV3_4::LookbackConfiguration

Lookback configuration settings. Corresponds to the JSON property lookbackConfiguration

Returns:



8628
8629
8630
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8628

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) 


8634
8635
8636
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8634

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) 


8640
8641
8642
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8640

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) 


8647
8648
8649
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8647

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) 


8652
8653
8654
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8652

def placement_group_id
  @placement_group_id
end

#placement_group_id_dimension_value ⇒ Google::Apis::DfareportingV3_4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property placementGroupIdDimensionValue

Returns:



8657
8658
8659
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8657

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) 


8662
8663
8664
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8662

def placement_strategy_id
  @placement_strategy_id
end

#pricing_schedule ⇒ Google::Apis::DfareportingV3_4::PricingSchedule

Pricing Schedule Corresponds to the JSON property pricingSchedule

Returns:



8667
8668
8669
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8667

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) 


8676
8677
8678
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8676

def primary
  @primary
end

#publisher_update_info ⇒ Google::Apis::DfareportingV3_4::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property publisherUpdateInfo

Returns:



8682
8683
8684
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8682

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) 


8689
8690
8691
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8689

def site_id
  @site_id
end

#site_id_dimension_value ⇒ Google::Apis::DfareportingV3_4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property siteIdDimensionValue

Returns:



8694
8695
8696
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8694

def site_id_dimension_value
  @site_id_dimension_value
end

#size ⇒ Google::Apis::DfareportingV3_4::Size

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

Returns:



8699
8700
8701
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8699

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) 


8704
8705
8706
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8704

def ssl_required
  @ssl_required
end

#status ⇒ String

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

Returns:

  • (String) 


8710
8711
8712
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8710

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) 


8715
8716
8717
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8715

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


8737
8738
8739
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8737

def tag_formats
  @tag_formats
end

#tag_setting ⇒ Google::Apis::DfareportingV3_4::TagSetting

Tag Settings Corresponds to the JSON property tagSetting

Returns:



8742
8743
8744
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8742

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) 


8753
8754
8755
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8753

def video_active_view_opt_out
  @video_active_view_opt_out
end

#video_settings ⇒ Google::Apis::DfareportingV3_4::VideoSettings

Video Settings Corresponds to the JSON property videoSettings

Returns:



8759
8760
8761
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8759

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) 


8768
8769
8770
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8768

def vpaid_adapter_choice
  @vpaid_adapter_choice
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 8775

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)
  @additional_sizes = args[:additional_sizes] if args.key?(:additional_sizes)
  @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