Class: Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ResourcesCustomColumn

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

Overview

A custom column. See Search Ads 360 custom column at https://support.google. com/sa360/answer/9633916

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V0ResourcesCustomColumn

Returns a new instance of GoogleAdsSearchads360V0ResourcesCustomColumn.



2985
2986
2987
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2985

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

Instance Attribute Details

#description ⇒ String

Output only. User-defined description of the custom column. Corresponds to the JSON property description

Returns:

  • (String) 


2935
2936
2937
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2935

def description
  @description
end

#id ⇒ Fixnum

Output only. ID of the custom column. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


2940
2941
2942
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2940

def id
  @id
end

#name ⇒ String

Output only. User-defined name of the custom column. Corresponds to the JSON property name

Returns:

  • (String) 


2945
2946
2947
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2945

def name
  @name
end

#queryable ⇒ Boolean Also known as: queryable?

Output only. True when the custom column is available to be used in the query of SearchAds360Service.Search and SearchAds360Service.SearchStream. Corresponds to the JSON property queryable

Returns:

  • (Boolean) 


2951
2952
2953
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2951

def queryable
  @queryable
end

#referenced_system_columns ⇒ Array<String>

Output only. The list of the referenced system columns of this custom column. For example, A custom column "sum of impressions and clicks" has referenced system columns of "metrics.clicks", "metrics.impressions". Corresponds to the JSON property referencedSystemColumns

Returns:

  • (Array<String>) 


2959
2960
2961
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2959

def referenced_system_columns
  @referenced_system_columns
end

#references_attributes ⇒ Boolean Also known as: references_attributes?

Output only. True when the custom column is referring to one or more attributes. Corresponds to the JSON property referencesAttributes

Returns:

  • (Boolean) 


2965
2966
2967
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2965

def references_attributes
  @references_attributes
end

#references_metrics ⇒ Boolean Also known as: references_metrics?

Output only. True when the custom column is referring to one or more metrics. Corresponds to the JSON property referencesMetrics

Returns:

  • (Boolean) 


2971
2972
2973
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2971

def references_metrics
  @references_metrics
end

#resource_name ⇒ String

Immutable. The resource name of the custom column. Custom column resource names have the form: customers/customer_id/customColumns/custom_column_id` Corresponds to the JSON propertyresourceName`

Returns:

  • (String) 


2978
2979
2980
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2978

def resource_name
  @resource_name
end

#value_type ⇒ String

Output only. The type of the result value of the custom column. Corresponds to the JSON property valueType

Returns:

  • (String) 


2983
2984
2985
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2983

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 2990

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @id = args[:id] if args.key?(:id)
  @name = args[:name] if args.key?(:name)
  @queryable = args[:queryable] if args.key?(:queryable)
  @referenced_system_columns = args[:referenced_system_columns] if args.key?(:referenced_system_columns)
  @references_attributes = args[:references_attributes] if args.key?(:references_attributes)
  @references_metrics = args[:references_metrics] if args.key?(:references_metrics)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @value_type = args[:value_type] if args.key?(:value_type)
end