class Google::Apis::DfareportingV2_3::Placement

Contains properties of a placement.

Attributes

account_id[RW]

Account ID of this placement. This field can be left blank. Corresponds to the JSON property `accountId` @return [String]

advertiser_id[RW]

Advertiser ID of this placement. This field can be left blank. Corresponds to the JSON property `advertiserId` @return [String]

advertiser_id_dimension_value[RW]

Represents a DimensionValue resource. Corresponds to the JSON property `advertiserIdDimensionValue` @return [Google::Apis::DfareportingV2_3::DimensionValue]

archived[RW]

Whether this placement is archived. Corresponds to the JSON property `archived` @return [Boolean]

archived?[RW]

Whether this placement is archived. Corresponds to the JSON property `archived` @return [Boolean]

campaign_id[RW]

Campaign ID of this placement. This field is a required field on insertion. Corresponds to the JSON property `campaignId` @return [String]

campaign_id_dimension_value[RW]

Represents a DimensionValue resource. Corresponds to the JSON property `campaignIdDimensionValue` @return [Google::Apis::DfareportingV2_3::DimensionValue]

comment[RW]

Comments for this placement. Corresponds to the JSON property `comment` @return [String]

compatibility[RW]

Placement compatibility. WEB and WEB_INTERSTITIAL refer to rendering either on desktop or on mobile devices for regular or interstitial ads, respectively. APP and APP_INTERSTITIAL are for rendering in mobile apps. 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]

content_category_id[RW]

ID of the content category assigned to this placement. Corresponds to the JSON property `contentCategoryId` @return [String]

create_info[RW]

Modification timestamp. Corresponds to the JSON property `createInfo` @return [Google::Apis::DfareportingV2_3::LastModifiedInfo]

directory_site_id[RW]

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 [String]

directory_site_id_dimension_value[RW]

Represents a DimensionValue resource. Corresponds to the JSON property `directorySiteIdDimensionValue` @return [Google::Apis::DfareportingV2_3::DimensionValue]

external_id[RW]

External ID for this placement. Corresponds to the JSON property `externalId` @return [String]

id[RW]

ID of this placement. This is a read-only, auto-generated field. Corresponds to the JSON property `id` @return [String]

id_dimension_value[RW]

Represents a DimensionValue resource. Corresponds to the JSON property `idDimensionValue` @return [Google::Apis::DfareportingV2_3::DimensionValue]

key_name[RW]

Key name of this placement. This is a read-only, auto-generated field. Corresponds to the JSON property `keyName` @return [String]

kind[RW]

Identifies what kind of resource this is. Value: the fixed string “ dfareporting#placement”. Corresponds to the JSON property `kind` @return [String]

last_modified_info[RW]

Modification timestamp. Corresponds to the JSON property `lastModifiedInfo` @return [Google::Apis::DfareportingV2_3::LastModifiedInfo]

lookback_configuration[RW]

Lookback configuration settings. Corresponds to the JSON property `lookbackConfiguration` @return [Google::Apis::DfareportingV2_3::LookbackConfiguration]

name[RW]

Name of this placement.This is a required field and must be less than 256 characters long. Corresponds to the JSON property `name` @return [String]

payment_approved[RW]

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_approved?[RW]

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[RW]

Payment source for this placement. This is a required field that is read-only after insertion. Corresponds to the JSON property `paymentSource` @return [String]

placement_group_id[RW]

ID of this placement's group, if applicable. Corresponds to the JSON property `placementGroupId` @return [String]

placement_group_id_dimension_value[RW]

Represents a DimensionValue resource. Corresponds to the JSON property `placementGroupIdDimensionValue` @return [Google::Apis::DfareportingV2_3::DimensionValue]

placement_strategy_id[RW]

ID of the placement strategy assigned to this placement. Corresponds to the JSON property `placementStrategyId` @return [String]

pricing_schedule[RW]

Pricing Schedule Corresponds to the JSON property `pricingSchedule` @return [Google::Apis::DfareportingV2_3::PricingSchedule]

primary[RW]

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]

primary?[RW]

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]

publisher_update_info[RW]

Modification timestamp. Corresponds to the JSON property `publisherUpdateInfo` @return [Google::Apis::DfareportingV2_3::LastModifiedInfo]

site_id[RW]

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 [String]

site_id_dimension_value[RW]

Represents a DimensionValue resource. Corresponds to the JSON property `siteIdDimensionValue` @return [Google::Apis::DfareportingV2_3::DimensionValue]

size[RW]

Represents the dimensions of ads, placements, creatives, or creative assets. Corresponds to the JSON property `size` @return [Google::Apis::DfareportingV2_3::Size]

ssl_required[RW]

Whether creatives assigned to this placement must be SSL-compliant. Corresponds to the JSON property `sslRequired` @return [Boolean]

ssl_required?[RW]

Whether creatives assigned to this placement must be SSL-compliant. Corresponds to the JSON property `sslRequired` @return [Boolean]

status[RW]

Third-party placement status. Corresponds to the JSON property `status` @return [String]

subaccount_id[RW]

Subaccount ID of this placement. This field can be left blank. Corresponds to the JSON property `subaccountId` @return [String]

tag_formats[RW]

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_TRACKING”

  • “PLACEMENT_TAG_TRACKING_IFRAME”

  • “PLACEMENT_TAG_TRACKING_JAVASCRIPT”

Corresponds to the JSON property `tagFormats` @return [Array<String>]

tag_setting[RW]

Tag Settings Corresponds to the JSON property `tagSetting` @return [Google::Apis::DfareportingV2_3::TagSetting]

Public Class Methods

new(**args) click to toggle source
# File generated/google/apis/dfareporting_v2_3/classes.rb, line 7470
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File generated/google/apis/dfareporting_v2_3/classes.rb, line 7475
def update!(**args)
  @account_id = args[:account_id] if args.key?(:account_id)
  @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)
end