Class: Google::Apis::DfareportingV2_5::Placement

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



7865
7866
7867
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7865

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) 


7652
7653
7654
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7652

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) 


7657
7658
7659
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7657

def advertiser_id
  @advertiser_id
end

#advertiser_id_dimension_value ⇒ Google::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property advertiserIdDimensionValue

Returns:



7662
7663
7664
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7662

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) 


7667
7668
7669
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7667

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) 


7673
7674
7675
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7673

def campaign_id
  @campaign_id
end

#campaign_id_dimension_value ⇒ Google::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property campaignIdDimensionValue

Returns:



7678
7679
7680
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7678

def campaign_id_dimension_value
  @campaign_id_dimension_value
end

#comment ⇒ String

Comments for this placement. Corresponds to the JSON property comment

Returns:

  • (String) 


7683
7684
7685
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7683

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) 


7693
7694
7695
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7693

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) 


7698
7699
7700
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7698

def content_category_id
  @content_category_id
end

#create_info ⇒ Google::Apis::DfareportingV2_5::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property createInfo

Returns:



7703
7704
7705
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7703

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) 


7710
7711
7712
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7710

def directory_site_id
  @directory_site_id
end

#directory_site_id_dimension_value ⇒ Google::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property directorySiteIdDimensionValue

Returns:



7715
7716
7717
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7715

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) 


7720
7721
7722
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7720

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) 


7725
7726
7727
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7725

def id
  @id
end

#id_dimension_value ⇒ Google::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property idDimensionValue

Returns:



7730
7731
7732
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7730

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) 


7735
7736
7737
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7735

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) 


7741
7742
7743
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7741

def kind
  @kind
end

#last_modified_info ⇒ Google::Apis::DfareportingV2_5::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property lastModifiedInfo

Returns:



7746
7747
7748
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7746

def last_modified_info
  @last_modified_info
end

#lookback_configuration ⇒ Google::Apis::DfareportingV2_5::LookbackConfiguration

Lookback configuration settings. Corresponds to the JSON property lookbackConfiguration

Returns:



7751
7752
7753
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7751

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) 


7757
7758
7759
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7757

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) 


7763
7764
7765
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7763

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) 


7770
7771
7772
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7770

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) 


7775
7776
7777
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7775

def placement_group_id
  @placement_group_id
end

#placement_group_id_dimension_value ⇒ Google::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property placementGroupIdDimensionValue

Returns:



7780
7781
7782
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7780

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) 


7785
7786
7787
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7785

def placement_strategy_id
  @placement_strategy_id
end

#pricing_schedule ⇒ Google::Apis::DfareportingV2_5::PricingSchedule

Pricing Schedule Corresponds to the JSON property pricingSchedule

Returns:



7790
7791
7792
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7790

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) 


7799
7800
7801
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7799

def primary
  @primary
end

#publisher_update_info ⇒ Google::Apis::DfareportingV2_5::LastModifiedInfo

Modification timestamp. Corresponds to the JSON property publisherUpdateInfo

Returns:



7805
7806
7807
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7805

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) 


7812
7813
7814
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7812

def site_id
  @site_id
end

#site_id_dimension_value ⇒ Google::Apis::DfareportingV2_5::DimensionValue

Represents a DimensionValue resource. Corresponds to the JSON property siteIdDimensionValue

Returns:



7817
7818
7819
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7817

def site_id_dimension_value
  @site_id_dimension_value
end

#size ⇒ Google::Apis::DfareportingV2_5::Size

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

Returns:



7822
7823
7824
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7822

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) 


7827
7828
7829
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7827

def ssl_required
  @ssl_required
end

#status ⇒ String

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

Returns:

  • (String) 


7833
7834
7835
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7833

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) 


7838
7839
7840
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7838

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


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

def tag_formats
  @tag_formats
end

#tag_setting ⇒ Google::Apis::DfareportingV2_5::TagSetting

Tag Settings Corresponds to the JSON property tagSetting

Returns:



7863
7864
7865
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7863

def tag_setting
  @tag_setting
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
 
# File 'generated/google/apis/dfareporting_v2_5/classes.rb', line 7870

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