Class: Google::Apis::DfareportingV3_3::Placement
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV3_3::Placement
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dfareporting_v3_3/classes.rb,
generated/google/apis/dfareporting_v3_3/representations.rb,
generated/google/apis/dfareporting_v3_3/representations.rb
Overview
Contains properties of a placement.
Instance Attribute Summary collapse
-
#account_id ⇒ Fixnum
Account ID of this placement.
-
#ad_blocking_opt_out ⇒ Boolean
(also: #ad_blocking_opt_out?)
Whether this placement opts out of ad blocking.
-
#additional_sizes ⇒ Array<Google::Apis::DfareportingV3_3::Size>
Additional sizes associated with this placement.
-
#advertiser_id ⇒ Fixnum
Advertiser ID of this placement.
-
#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
-
#archived ⇒ Boolean
(also: #archived?)
Whether this placement is archived.
-
#campaign_id ⇒ Fixnum
Campaign ID of this placement.
-
#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
-
#comment ⇒ String
Comments for this placement.
-
#compatibility ⇒ String
Placement compatibility.
-
#content_category_id ⇒ Fixnum
ID of the content category assigned to this placement.
-
#create_info ⇒ Google::Apis::DfareportingV3_3::LastModifiedInfo
Modification timestamp.
-
#directory_site_id ⇒ Fixnum
Directory site ID of this placement.
-
#directory_site_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
-
#external_id ⇒ String
External ID for this placement.
-
#id ⇒ Fixnum
ID of this placement.
-
#id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
-
#key_name ⇒ String
Key name of this placement.
-
#kind ⇒ String
Identifies what kind of resource this is.
-
#last_modified_info ⇒ Google::Apis::DfareportingV3_3::LastModifiedInfo
Modification timestamp.
-
#lookback_configuration ⇒ Google::Apis::DfareportingV3_3::LookbackConfiguration
Lookback configuration settings.
-
#name ⇒ String
Name of this placement.This is a required field and must be less than 256 characters long.
-
#payment_approved ⇒ Boolean
(also: #payment_approved?)
Whether payment was approved for this placement.
-
#payment_source ⇒ String
Payment source for this placement.
-
#placement_group_id ⇒ Fixnum
ID of this placement's group, if applicable.
-
#placement_group_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
-
#placement_strategy_id ⇒ Fixnum
ID of the placement strategy assigned to this placement.
-
#pricing_schedule ⇒ Google::Apis::DfareportingV3_3::PricingSchedule
Pricing Schedule Corresponds to the JSON property
pricingSchedule
. -
#primary ⇒ Boolean
(also: #primary?)
Whether this placement is the primary placement of a roadblock (placement group).
-
#publisher_update_info ⇒ Google::Apis::DfareportingV3_3::LastModifiedInfo
Modification timestamp.
-
#site_id ⇒ Fixnum
Site ID associated with this placement.
-
#site_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
-
#size ⇒ Google::Apis::DfareportingV3_3::Size
Represents the dimensions of ads, placements, creatives, or creative assets.
-
#ssl_required ⇒ Boolean
(also: #ssl_required?)
Whether creatives assigned to this placement must be SSL-compliant.
-
#status ⇒ String
Third-party placement status.
-
#subaccount_id ⇒ Fixnum
Subaccount ID of this placement.
-
#tag_formats ⇒ Array<String>
Tag formats to generate for this placement.
-
#tag_setting ⇒ Google::Apis::DfareportingV3_3::TagSetting
Tag Settings Corresponds to the JSON property
tagSetting
. -
#video_active_view_opt_out ⇒ Boolean
(also: #video_active_view_opt_out?)
Whether Verification and ActiveView are disabled for in-stream video creatives for this placement.
-
#video_settings ⇒ Google::Apis::DfareportingV3_3::VideoSettings
Video Settings Corresponds to the JSON property
videoSettings
. -
#vpaid_adapter_choice ⇒ String
VPAID adapter setting for this placement.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Placement
constructor
A new instance of Placement.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Placement
Returns a new instance of Placement.
8359 8360 8361 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8359 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
8104 8105 8106 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8104 def account_id @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
8111 8112 8113 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8111 def ad_blocking_opt_out @ad_blocking_opt_out end |
#additional_sizes ⇒ Array<Google::Apis::DfareportingV3_3::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
8118 8119 8120 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8118 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
8123 8124 8125 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8123 def advertiser_id @advertiser_id end |
#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property advertiserIdDimensionValue
8128 8129 8130 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8128 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
8133 8134 8135 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8133 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
8139 8140 8141 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8139 def campaign_id @campaign_id end |
#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property campaignIdDimensionValue
8144 8145 8146 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8144 def campaign_id_dimension_value @campaign_id_dimension_value end |
#comment ⇒ String
Comments for this placement.
Corresponds to the JSON property comment
8149 8150 8151 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8149 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
8159 8160 8161 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8159 def compatibility @compatibility end |
#content_category_id ⇒ Fixnum
ID of the content category assigned to this placement.
Corresponds to the JSON property contentCategoryId
8164 8165 8166 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8164 def content_category_id @content_category_id end |
#create_info ⇒ Google::Apis::DfareportingV3_3::LastModifiedInfo
Modification timestamp.
Corresponds to the JSON property createInfo
8169 8170 8171 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8169 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
8176 8177 8178 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8176 def directory_site_id @directory_site_id end |
#directory_site_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property directorySiteIdDimensionValue
8181 8182 8183 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8181 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
8186 8187 8188 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8186 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
8191 8192 8193 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8191 def id @id end |
#id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property idDimensionValue
8196 8197 8198 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8196 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
8201 8202 8203 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8201 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
8207 8208 8209 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8207 def kind @kind end |
#last_modified_info ⇒ Google::Apis::DfareportingV3_3::LastModifiedInfo
Modification timestamp.
Corresponds to the JSON property lastModifiedInfo
8212 8213 8214 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8212 def last_modified_info @last_modified_info end |
#lookback_configuration ⇒ Google::Apis::DfareportingV3_3::LookbackConfiguration
Lookback configuration settings.
Corresponds to the JSON property lookbackConfiguration
8217 8218 8219 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8217 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
8223 8224 8225 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8223 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
8229 8230 8231 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8229 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
8236 8237 8238 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8236 def payment_source @payment_source end |
#placement_group_id ⇒ Fixnum
ID of this placement's group, if applicable.
Corresponds to the JSON property placementGroupId
8241 8242 8243 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8241 def placement_group_id @placement_group_id end |
#placement_group_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property placementGroupIdDimensionValue
8246 8247 8248 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8246 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
8251 8252 8253 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8251 def placement_strategy_id @placement_strategy_id end |
#pricing_schedule ⇒ Google::Apis::DfareportingV3_3::PricingSchedule
Pricing Schedule
Corresponds to the JSON property pricingSchedule
8256 8257 8258 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8256 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
8265 8266 8267 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8265 def primary @primary end |
#publisher_update_info ⇒ Google::Apis::DfareportingV3_3::LastModifiedInfo
Modification timestamp.
Corresponds to the JSON property publisherUpdateInfo
8271 8272 8273 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8271 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
8278 8279 8280 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8278 def site_id @site_id end |
#site_id_dimension_value ⇒ Google::Apis::DfareportingV3_3::DimensionValue
Represents a DimensionValue resource.
Corresponds to the JSON property siteIdDimensionValue
8283 8284 8285 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8283 def site_id_dimension_value @site_id_dimension_value end |
#size ⇒ Google::Apis::DfareportingV3_3::Size
Represents the dimensions of ads, placements, creatives, or creative assets.
Corresponds to the JSON property size
8288 8289 8290 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8288 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
8293 8294 8295 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8293 def ssl_required @ssl_required end |
#status ⇒ String
Third-party placement status.
Corresponds to the JSON property status
8299 8300 8301 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8299 def status @status end |
#subaccount_id ⇒ Fixnum
Subaccount ID of this placement. This field can be left blank.
Corresponds to the JSON property subaccountId
8304 8305 8306 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8304 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
8326 8327 8328 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8326 def tag_formats @tag_formats end |
#tag_setting ⇒ Google::Apis::DfareportingV3_3::TagSetting
Tag Settings
Corresponds to the JSON property tagSetting
8331 8332 8333 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8331 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
8342 8343 8344 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8342 def video_active_view_opt_out @video_active_view_opt_out end |
#video_settings ⇒ Google::Apis::DfareportingV3_3::VideoSettings
Video Settings
Corresponds to the JSON property videoSettings
8348 8349 8350 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8348 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
8357 8358 8359 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8357 def vpaid_adapter_choice @vpaid_adapter_choice end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
8364 8365 8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 8402 8403 8404 8405 8406 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 8364 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 |