Class: Google::Apis::DfareportingV2_6::Placement

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



8056
8057
8058
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8056

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#account_id ⇒ String

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

Returns:

  • (String) 


7843
7844
7845
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7843

def 
  @account_id
end

#advertiser_id ⇒ String

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

Returns:

  • (String) 


7848
7849
7850
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7848

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



7853
7854
7855
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7853

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) 


7858
7859
7860
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7858

def archived
  @archived
end

#campaign_id ⇒ String

Campaign ID of this placement. This field is a required field on insertion. Corresponds to the JSON property campaignId

Returns:

  • (String) 


7864
7865
7866
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7864

def campaign_id
  @campaign_id
end

#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue

Returns:



7869
7870
7871
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7869

def campaign_id_dimension_value
  @campaign_id_dimension_value
end

#comment ⇒ String

Comments for this placement. Corresponds to the JSON property comment

Returns:

  • (String) 


7874
7875
7876
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7874

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) 


7884
7885
7886
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7884

def compatibility
  @compatibility
end

#content_category_id ⇒ String

ID of the content category assigned to this placement. Corresponds to the JSON property contentCategoryId

Returns:

  • (String) 


7889
7890
7891
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7889

def content_category_id
  @content_category_id
end

#create_info ⇒ Google::Apis::DfareportingV2_6::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



7894
7895
7896
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7894

def create_info
  @create_info
end

#directory_site_id ⇒ String

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:

  • (String) 


7901
7902
7903
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7901

def directory_site_id
  @directory_site_id
end

#directory_site_id_dimension_value ⇒ Google::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property directorySiteIdDimensionValue

Returns:



7906
7907
7908
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7906

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) 


7911
7912
7913
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7911

def external_id
  @external_id
end

#id ⇒ String

ID of this placement. This is a read-only, auto-generated field. Corresponds to the JSON property id

Returns:

  • (String) 


7916
7917
7918
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7916

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



7921
7922
7923
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7921

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) 


7926
7927
7928
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7926

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) 


7932
7933
7934
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7932

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV2_6::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



7937
7938
7939
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7937

def last_modified_info
  @last_modified_info
end

#lookback_configuration ⇒ Google::Apis::DfareportingV2_6::LookbackConfiguration

Lookback configuration settings. Corresponds to the JSON property lookbackConfiguration

Returns:



7942
7943
7944
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7942

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) 


7948
7949
7950
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7948

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) 


7954
7955
7956
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7954

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) 


7961
7962
7963
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7961

def payment_source
  @payment_source
end

#placement_group_id ⇒ String

ID of this placement's group, if applicable. Corresponds to the JSON property placementGroupId

Returns:

  • (String) 


7966
7967
7968
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7966

def placement_group_id
  @placement_group_id
end

#placement_group_id_dimension_value ⇒ Google::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property placementGroupIdDimensionValue

Returns:



7971
7972
7973
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7971

def placement_group_id_dimension_value
  @placement_group_id_dimension_value
end

#placement_strategy_id ⇒ String

ID of the placement strategy assigned to this placement. Corresponds to the JSON property placementStrategyId

Returns:

  • (String) 


7976
7977
7978
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7976

def placement_strategy_id
  @placement_strategy_id
end

#pricing_schedule ⇒ Google::Apis::DfareportingV2_6::PricingSchedule

Pricing Schedule Corresponds to the JSON property pricingSchedule

Returns:



7981
7982
7983
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7981

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) 


7990
7991
7992
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7990

def primary
  @primary
end

#publisher_update_info ⇒ Google::Apis::DfareportingV2_6::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property publisherUpdateInfo

Returns:



7996
7997
7998
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 7996

def publisher_update_info
  @publisher_update_info
end

#site_id ⇒ String

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:

  • (String) 


8003
8004
8005
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8003

def site_id
  @site_id
end

#site_id_dimension_value ⇒ Google::Apis::DfareportingV2_6::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property siteIdDimensionValue

Returns:



8008
8009
8010
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8008

def site_id_dimension_value
  @site_id_dimension_value
end

#size ⇒ Google::Apis::DfareportingV2_6::Size

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

Returns:



8013
8014
8015
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8013

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) 


8018
8019
8020
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8018

def ssl_required
  @ssl_required
end

#status ⇒ String

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

Returns:

  • (String) 


8024
8025
8026
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8024

def status
  @status
end

#subaccount_id ⇒ String

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

Returns:

  • (String) 


8029
8030
8031
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8029

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_TRACKING"
  • "PLACEMENT_TAG_TRACKING_IFRAME"
  • "PLACEMENT_TAG_TRACKING_JAVASCRIPT" Corresponds to the JSON property tagFormats

Returns:

  • (Array<String>) 


8049
8050
8051
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8049

def tag_formats
  @tag_formats
end

#tag_setting ⇒ Google::Apis::DfareportingV2_6::TagSetting

Tag Settings Corresponds to the JSON property tagSetting

Returns:



8054
8055
8056
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8054

def tag_setting
  @tag_setting
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
 
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 8061

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