Class: Google::Apis::Searchads360V0::GoogleAdsSearchads360V0ResourcesSearchAds360Field

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 field or resource (artifact) used by SearchAds360Service.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V0ResourcesSearchAds360Field

Returns a new instance of GoogleAdsSearchads360V0ResourcesSearchAds360Field.



4154
4155
4156
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4154

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

Instance Attribute Details

#attribute_resources ⇒ Array<String>

Output only. The names of all resources that are selectable with the described artifact. Fields from these resources do not segment metrics when included in search queries. This field is only set for artifacts whose category is RESOURCE. Corresponds to the JSON property attributeResources

Returns:

  • (Array<String>) 


4071
4072
4073
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4071

def attribute_resources
  @attribute_resources
end

#category ⇒ String

Output only. The category of the artifact. Corresponds to the JSON property category

Returns:

  • (String) 


4076
4077
4078
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4076

def category
  @category
end

#data_type ⇒ String

Output only. This field determines the operators that can be used with the artifact in WHERE clauses. Corresponds to the JSON property dataType

Returns:

  • (String) 


4082
4083
4084
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4082

def data_type
  @data_type
end

#enum_values ⇒ Array<String>

Output only. Values the artifact can assume if it is a field of type ENUM. This field is only set for artifacts of category SEGMENT or ATTRIBUTE. Corresponds to the JSON property enumValues

Returns:

  • (Array<String>) 


4088
4089
4090
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4088

def enum_values
  @enum_values
end

#filterable ⇒ Boolean Also known as: filterable?

Output only. Whether the artifact can be used in a WHERE clause in search queries. Corresponds to the JSON property filterable

Returns:

  • (Boolean) 


4094
4095
4096
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4094

def filterable
  @filterable
end

#is_repeated ⇒ Boolean Also known as: is_repeated?

Output only. Whether the field artifact is repeated. Corresponds to the JSON property isRepeated

Returns:

  • (Boolean) 


4100
4101
4102
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4100

def is_repeated
  @is_repeated
end

#metrics ⇒ Array<String>

Output only. This field lists the names of all metrics that are selectable with the described artifact when it is used in the FROM clause. It is only set for artifacts whose category is RESOURCE. Corresponds to the JSON property metrics

Returns:

  • (Array<String>) 


4108
4109
4110
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4108

def metrics
  @metrics
end

#name ⇒ String

Output only. The name of the artifact. Corresponds to the JSON property name

Returns:

  • (String) 


4113
4114
4115
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4113

def name
  @name
end

#resource_name ⇒ String

Output only. The resource name of the artifact. Artifact resource names have the form: SearchAds360Fields/name` Corresponds to the JSON propertyresourceName`

Returns:

  • (String) 


4119
4120
4121
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4119

def resource_name
  @resource_name
end

#segments ⇒ Array<String>

Output only. This field lists the names of all artifacts, whether a segment or another resource, that segment metrics when included in search queries and when the described artifact is used in the FROM clause. It is only set for artifacts whose category is RESOURCE. Corresponds to the JSON property segments

Returns:

  • (Array<String>) 


4127
4128
4129
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4127

def segments
  @segments
end

#selectable ⇒ Boolean Also known as: selectable?

Output only. Whether the artifact can be used in a SELECT clause in search queries. Corresponds to the JSON property selectable

Returns:

  • (Boolean) 


4133
4134
4135
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4133

def selectable
  @selectable
end

#selectable_with ⇒ Array<String>

Output only. The names of all resources, segments, and metrics that are selectable with the described artifact. Corresponds to the JSON property selectableWith

Returns:

  • (Array<String>) 


4140
4141
4142
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4140

def selectable_with
  @selectable_with
end

#sortable ⇒ Boolean Also known as: sortable?

Output only. Whether the artifact can be used in a ORDER BY clause in search queries. Corresponds to the JSON property sortable

Returns:

  • (Boolean) 


4146
4147
4148
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4146

def sortable
  @sortable
end

#type_url ⇒ String

Output only. The URL of proto describing the artifact's data type. Corresponds to the JSON property typeUrl

Returns:

  • (String) 


4152
4153
4154
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4152

def type_url
  @type_url
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
 
# File 'lib/google/apis/searchads360_v0/classes.rb', line 4159

def update!(**args)
  @attribute_resources = args[:attribute_resources] if args.key?(:attribute_resources)
  @category = args[:category] if args.key?(:category)
  @data_type = args[:data_type] if args.key?(:data_type)
  @enum_values = args[:enum_values] if args.key?(:enum_values)
  @filterable = args[:filterable] if args.key?(:filterable)
  @is_repeated = args[:is_repeated] if args.key?(:is_repeated)
  @metrics = args[:metrics] if args.key?(:metrics)
  @name = args[:name] if args.key?(:name)
  @resource_name = args[:resource_name] if args.key?(:resource_name)
  @segments = args[:segments] if args.key?(:segments)
  @selectable = args[:selectable] if args.key?(:selectable)
  @selectable_with = args[:selectable_with] if args.key?(:selectable_with)
  @sortable = args[:sortable] if args.key?(:sortable)
  @type_url = args[:type_url] if args.key?(:type_url)
end