Class: Google::Apis::DfareportingV5::FeedField

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dfareporting_v5/classes.rb,
lib/google/apis/dfareporting_v5/representations.rb,
lib/google/apis/dfareporting_v5/representations.rb

Overview

Each field of the element. This is a required field.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FeedField

Returns a new instance of FeedField.



6759
6760
6761
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 6759

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

Instance Attribute Details

#default_value ⇒ String

Optional. The default value of the field. Corresponds to the JSON property defaultValue

Returns:

  • (String) 


6711
6712
6713
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 6711

def default_value
  @default_value
end

#filterable ⇒ Boolean Also known as: filterable?

Optional. Whether the field is filterable. Could be set as true when the field type is any of the following and is not renderable: - STRING - BOOL - COUNTRY_CODE_ISO - CM360_SITE_ID - CM360_KEYWORD - CM360_CREATIVE_ID - CM360_PLACEMENT_ID - CM360_AD_ID - CM360_ADVERTISER_ID - CM360_CAMPAIGN_ID - CITY - REGION - POSTAL_CODE - METRO - CUSTOM_VALUE - REMARKETING_VALUE - GEO_CANONICAL - STRING_LIST - CREATIVE_DIMENSION - USERLIST_ID - CM360_DYNAMIC_TARGETING_KEY - DV360_LINE_ITEM_ID Corresponds to the JSON property filterable

Returns:

  • (Boolean) 


6722
6723
6724
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 6722

def filterable
  @filterable
end

#id ⇒ Fixnum

Required. The ID of the field. The ID is based on the column index starting from 0, and it should match the column index in the resource link. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


6729
6730
6731
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 6729

def id
  @id
end

#name ⇒ String

Required. The name of the field. Corresponds to the JSON property name

Returns:

  • (String) 


6734
6735
6736
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 6734

def name
  @name
end

#renderable ⇒ Boolean Also known as: renderable?

Optional. Whether the field is able to display. Could be set as true when the field type is not in any of the following and the field is not filterable: - COUNTRY_CODE_ISO - CITY - REGION - POSTAL_CODE - METRO - GEO_CANONICAL - USERLIST_ID - CONTEXTUAL_KEYWORD - CM360_DYNAMIC_TARGETING_KEY - WEIGHT Corresponds to the JSON property renderable

Returns:

  • (Boolean) 


6742
6743
6744
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 6742

def renderable
  @renderable
end

#required ⇒ Boolean Also known as: required?

Optional. Whether the field is required and should not be empty in the feed. Could be set as true when the field type is any of the following: - GPA_SERVED_IMAGE_URL - GPA_SERVED_ASSET_URL - ASSET_LIBRARY_HANDLE - ASSET_LIBRARY_VIDEO_HANDLE - ASSET_LIBRARY_DIRECTORY_HANDLE Corresponds to the JSON property required

Returns:

  • (Boolean) 


6751
6752
6753
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 6751

def required
  @required
end

#type ⇒ String

Required. The type of the field. Corresponds to the JSON property type

Returns:

  • (String) 


6757
6758
6759
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 6757

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6764
6765
6766
6767
6768
6769
6770
6771
6772
 
# File 'lib/google/apis/dfareporting_v5/classes.rb', line 6764

def update!(**args)
  @default_value = args[:default_value] if args.key?(:default_value)
  @filterable = args[:filterable] if args.key?(:filterable)
  @id = args[:id] if args.key?(:id)
  @name = args[:name] if args.key?(:name)
  @renderable = args[:renderable] if args.key?(:renderable)
  @required = args[:required] if args.key?(:required)
  @type = args[:type] if args.key?(:type)
end