Class: Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ResourcesCustomColumn

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

Returns a new instance of GoogleAdsSearchads360V23ResourcesCustomColumn.



27243
27244
27245
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27243

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) 


27188
27189
27190
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27188

def description
  @description
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


27193
27194
27195
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27193

def id
  @id
end

#name ⇒ String

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

Returns:

  • (String) 


27198
27199
27200
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27198

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) 


27204
27205
27206
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27204

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


27212
27213
27214
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27212

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) 


27218
27219
27220
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27218

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) 


27224
27225
27226
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27224

def references_metrics
  @references_metrics
end

#render_type ⇒ String

Output only. How the result value of the custom column should be interpreted. Corresponds to the JSON property renderType

Returns:

  • (String) 


27230
27231
27232
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27230

def render_type
  @render_type
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) 


27236
27237
27238
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27236

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) 


27241
27242
27243
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27241

def value_type
  @value_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



27248
27249
27250
27251
27252
27253
27254
27255
27256
27257
27258
27259
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 27248

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)
  @render_type = args[:render_type] if args.key?(:render_type)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @value_type = args[:value_type] if args.key?(:value_type)
end