class Google::Apis::DfareportingV3_4::Placement
Contains properties of a placement.
Attributes
Account
ID of this placement. This field can be left blank. Corresponds to the JSON property `accountId` @return [Fixnum]
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` @return [Boolean]
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` @return [Boolean]
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` @return [Array<Google::Apis::DfareportingV3_4::Size>]
Advertiser
ID of this placement. This field can be left blank. Corresponds to the JSON property `advertiserId` @return [Fixnum]
Represents a DimensionValue
resource. Corresponds to the JSON property `advertiserIdDimensionValue` @return [Google::Apis::DfareportingV3_4::DimensionValue]
Whether this placement is archived. Corresponds to the JSON property `archived` @return [Boolean]
Whether this placement is archived. Corresponds to the JSON property `archived` @return [Boolean]
Campaign
ID of this placement. This field is a required field on insertion. Corresponds to the JSON property `campaignId` @return [Fixnum]
Represents a DimensionValue
resource. Corresponds to the JSON property `campaignIdDimensionValue` @return [Google::Apis::DfareportingV3_4::DimensionValue]
Comments for this placement. Corresponds to the JSON property `comment` @return [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` @return [String]
ID of the content category assigned to this placement. Corresponds to the JSON property `contentCategoryId` @return [Fixnum]
Modification timestamp. Corresponds to the JSON property `createInfo` @return [Google::Apis::DfareportingV3_4::LastModifiedInfo]
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` @return [Fixnum]
Represents a DimensionValue
resource. Corresponds to the JSON property `directorySiteIdDimensionValue` @return [Google::Apis::DfareportingV3_4::DimensionValue]
External ID for this placement. Corresponds to the JSON property `externalId` @return [String]
ID of this placement. This is a read-only, auto-generated field. Corresponds to the JSON property `id` @return [Fixnum]
Represents a DimensionValue
resource. Corresponds to the JSON property `idDimensionValue` @return [Google::Apis::DfareportingV3_4::DimensionValue]
Key name of this placement. This is a read-only, auto-generated field. Corresponds to the JSON property `keyName` @return [String]
Identifies what kind of resource this is. Value: the fixed string “ dfareporting#placement”. Corresponds to the JSON property `kind` @return [String]
Modification timestamp. Corresponds to the JSON property `lastModifiedInfo` @return [Google::Apis::DfareportingV3_4::LastModifiedInfo]
Lookback configuration settings. Corresponds to the JSON property `lookbackConfiguration` @return [Google::Apis::DfareportingV3_4::LookbackConfiguration]
Name of this placement.This is a required field and must be less than or equal to 256 characters long. Corresponds to the JSON property `name` @return [String]
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` @return [Boolean]
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` @return [Boolean]
Payment source for this placement. This is a required field that is read-only after insertion. Corresponds to the JSON property `paymentSource` @return [String]
ID of this placement's group, if applicable. Corresponds to the JSON property `placementGroupId` @return [Fixnum]
Represents a DimensionValue
resource. Corresponds to the JSON property `placementGroupIdDimensionValue` @return [Google::Apis::DfareportingV3_4::DimensionValue]
ID of the placement strategy assigned to this placement. Corresponds to the JSON property `placementStrategyId` @return [Fixnum]
Pricing
Schedule Corresponds to the JSON property `pricingSchedule` @return [Google::Apis::DfareportingV3_4::PricingSchedule]
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` @return [Boolean]
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` @return [Boolean]
Modification timestamp. Corresponds to the JSON property `publisherUpdateInfo` @return [Google::Apis::DfareportingV3_4::LastModifiedInfo]
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` @return [Fixnum]
Represents a DimensionValue
resource. Corresponds to the JSON property `siteIdDimensionValue` @return [Google::Apis::DfareportingV3_4::DimensionValue]
Represents the dimensions of ads, placements, creatives, or creative assets. Corresponds to the JSON property `size` @return [Google::Apis::DfareportingV3_4::Size]
Whether creatives assigned to this placement must be SSL-compliant. Corresponds to the JSON property `sslRequired` @return [Boolean]
Whether creatives assigned to this placement must be SSL-compliant. Corresponds to the JSON property `sslRequired` @return [Boolean]
Third-party placement status. Corresponds to the JSON property `status` @return [String]
Subaccount
ID of this placement. This field can be left blank. Corresponds to the JSON property `subaccountId` @return [Fixnum]
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` @return [Array<String>]
Tag Settings Corresponds to the JSON property `tagSetting` @return [Google::Apis::DfareportingV3_4::TagSetting]
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` @return [Boolean]
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` @return [Boolean]
Video Settings Corresponds to the JSON property `videoSettings` @return [Google::Apis::DfareportingV3_4::VideoSettings]
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` @return [String]
Public Class Methods
# File lib/google/apis/dfareporting_v3_4/classes.rb, line 9040 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/dfareporting_v3_4/classes.rb, line 9045 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