Class: Google::Apis::DfareportingV4::Placement

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

Overview

Contains properties of a placement.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Placement

Returns a new instance of Placement.



9250
9251
9252
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9250

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) 


8993
8994
8995
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8993

def 
  @account_id
end

#active_status ⇒ String

Whether this placement is active, inactive, archived or permanently archived. Corresponds to the JSON property activeStatus

Returns:

  • (String) 


8998
8999
9000
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 8998

def active_status
  @active_status
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) 


9005
9006
9007
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9005

def ad_blocking_opt_out
  @ad_blocking_opt_out
end

#additional_sizes ⇒ Array<Google::Apis::DfareportingV4::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:



9012
9013
9014
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9012

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) 


9017
9018
9019
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9017

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



9022
9023
9024
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9022

def advertiser_id_dimension_value
  @advertiser_id_dimension_value
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) 


9027
9028
9029
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9027

def campaign_id
  @campaign_id
end

#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue

Returns:



9032
9033
9034
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9032

def campaign_id_dimension_value
  @campaign_id_dimension_value
end

#comment ⇒ String

Comments for this placement. Corresponds to the JSON property comment

Returns:

  • (String) 


9037
9038
9039
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9037

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) 


9047
9048
9049
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9047

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) 


9052
9053
9054
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9052

def content_category_id
  @content_category_id
end

#create_info ⇒ Google::Apis::DfareportingV4::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



9057
9058
9059
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9057

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) 


9064
9065
9066
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9064

def directory_site_id
  @directory_site_id
end

#directory_site_id_dimension_value ⇒ Google::Apis::DfareportingV4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property directorySiteIdDimensionValue

Returns:



9069
9070
9071
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9069

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) 


9074
9075
9076
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9074

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) 


9079
9080
9081
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9079

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



9084
9085
9086
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9084

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) 


9089
9090
9091
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9089

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) 


9095
9096
9097
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9095

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV4::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



9100
9101
9102
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9100

def last_modified_info
  @last_modified_info
end

#lookback_configuration ⇒ Google::Apis::DfareportingV4::LookbackConfiguration

Lookback configuration settings. Corresponds to the JSON property lookbackConfiguration

Returns:



9105
9106
9107
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9105

def lookback_configuration
  @lookback_configuration
end

#name ⇒ String

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

Returns:

  • (String) 


9111
9112
9113
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9111

def name
  @name
end

#partner_wrapping_data ⇒ Google::Apis::DfareportingV4::MeasurementPartnerWrappingData

Placement tag wrapping Corresponds to the JSON property partnerWrappingData

Returns:



9116
9117
9118
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9116

def partner_wrapping_data
  @partner_wrapping_data
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) 


9122
9123
9124
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9122

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) 


9129
9130
9131
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9129

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) 


9134
9135
9136
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9134

def placement_group_id
  @placement_group_id
end

#placement_group_id_dimension_value ⇒ Google::Apis::DfareportingV4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property placementGroupIdDimensionValue

Returns:



9139
9140
9141
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9139

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) 


9144
9145
9146
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9144

def placement_strategy_id
  @placement_strategy_id
end

#pricing_schedule ⇒ Google::Apis::DfareportingV4::PricingSchedule

Pricing Schedule Corresponds to the JSON property pricingSchedule

Returns:



9149
9150
9151
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9149

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) 


9158
9159
9160
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9158

def primary
  @primary
end

#publisher_update_info ⇒ Google::Apis::DfareportingV4::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property publisherUpdateInfo

Returns:



9164
9165
9166
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9164

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) 


9171
9172
9173
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9171

def site_id
  @site_id
end

#site_id_dimension_value ⇒ Google::Apis::DfareportingV4::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property siteIdDimensionValue

Returns:



9176
9177
9178
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9176

def site_id_dimension_value
  @site_id_dimension_value
end

#size ⇒ Google::Apis::DfareportingV4::Size

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

Returns:



9181
9182
9183
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9181

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) 


9186
9187
9188
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9186

def ssl_required
  @ssl_required
end

#status ⇒ String

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

Returns:

  • (String) 


9192
9193
9194
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9192

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) 


9197
9198
9199
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9197

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


9212
9213
9214
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9212

def tag_formats
  @tag_formats
end

#tag_setting ⇒ Google::Apis::DfareportingV4::TagSetting

Tag Settings Corresponds to the JSON property tagSetting

Returns:



9217
9218
9219
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9217

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) 


9228
9229
9230
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9228

def video_active_view_opt_out
  @video_active_view_opt_out
end

#video_settings ⇒ Google::Apis::DfareportingV4::VideoSettings

Video Settings Corresponds to the JSON property videoSettings

Returns:



9234
9235
9236
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9234

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) 


9242
9243
9244
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9242

def vpaid_adapter_choice
  @vpaid_adapter_choice
end

#wrapping_opt_out ⇒ Boolean Also known as: wrapping_opt_out?

Whether this placement opts out of tag wrapping. Corresponds to the JSON property wrappingOptOut

Returns:

  • (Boolean) 


9247
9248
9249
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9247

def wrapping_opt_out
  @wrapping_opt_out
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 9255

def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @active_status = args[:active_status] if args.key?(:active_status)
  @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)
  @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)
  @partner_wrapping_data = args[:partner_wrapping_data] if args.key?(:partner_wrapping_data)
  @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)
  @wrapping_opt_out = args[:wrapping_opt_out] if args.key?(:wrapping_opt_out)
end