Class: Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSearchSearchAds360Response

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

Response message for SearchAds360Service.Search.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAdsSearchads360V23ServicesSearchSearchAds360Response

Returns a new instance of GoogleAdsSearchads360V23ServicesSearchSearchAds360Response.



54991
54992
54993
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 54991

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

Instance Attribute Details

#conversion_custom_dimension_headers ⇒ Array<Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesConversionCustomDimensionHeader>

The headers of the conversion custom dimensions in the results. Corresponds to the JSON property conversionCustomDimensionHeaders

Returns:



54932
54933
54934
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 54932

def conversion_custom_dimension_headers
  @conversion_custom_dimension_headers
end

#conversion_custom_metric_headers ⇒ Array<Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesConversionCustomMetricHeader>

The headers of the conversion custom metrics in the results. Corresponds to the JSON property conversionCustomMetricHeaders

Returns:



54937
54938
54939
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 54937

def conversion_custom_metric_headers
  @conversion_custom_metric_headers
end

#custom_column_headers ⇒ Array<Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesCustomColumnHeader>

The headers of the custom columns in the results. Corresponds to the JSON property customColumnHeaders

Returns:



54942
54943
54944
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 54942

def custom_column_headers
  @custom_column_headers
end

#field_mask ⇒ String

FieldMask that represents what fields were requested by the user. Corresponds to the JSON property fieldMask

Returns:

  • (String) 


54947
54948
54949
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 54947

def field_mask
  @field_mask
end

#metric_attributes ⇒ Array<Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesMetricAttributes>

The metric attributes of the metrics in the results. Corresponds to the JSON property metricAttributes

Returns:



54952
54953
54954
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 54952

def metric_attributes
  @metric_attributes
end

#next_page_token ⇒ String

Pagination token used to retrieve the next page of results. Pass the content of this string as the page_token attribute of the next request. next_page_token is not returned for the last page. Corresponds to the JSON property nextPageToken

Returns:

  • (String) 


54959
54960
54961
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 54959

def next_page_token
  @next_page_token
end

#query_resource_consumption ⇒ Fixnum

The amount of resources consumed to serve the query. Corresponds to the JSON property queryResourceConsumption

Returns:

  • (Fixnum) 


54964
54965
54966
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 54964

def query_resource_consumption
  @query_resource_consumption
end

#raw_event_conversion_dimension_headers ⇒ Array<Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRawEventConversionDimensionHeader>

The headers of the raw event conversion dimensions in the results. Corresponds to the JSON property rawEventConversionDimensionHeaders

Returns:



54969
54970
54971
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 54969

def raw_event_conversion_dimension_headers
  @raw_event_conversion_dimension_headers
end

#raw_event_conversion_metric_headers ⇒ Array<Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesRawEventConversionMetricHeader>

The headers of the raw event conversion metrics in the results. Corresponds to the JSON property rawEventConversionMetricHeaders

Returns:



54974
54975
54976
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 54974

def raw_event_conversion_metric_headers
  @raw_event_conversion_metric_headers
end

#results ⇒ Array<Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSearchAds360Row>

The list of rows that matched the query. Corresponds to the JSON property results

Returns:



54979
54980
54981
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 54979

def results
  @results
end

#summary_row ⇒ Google::Apis::Searchads360V23::GoogleAdsSearchads360V23ServicesSearchAds360Row

A returned row from the query. Corresponds to the JSON property summaryRow

Returns:



54984
54985
54986
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 54984

def summary_row
  @summary_row
end

#total_results_count ⇒ Fixnum

Total number of results that match the query ignoring the LIMIT clause. Corresponds to the JSON property totalResultsCount

Returns:

  • (Fixnum) 


54989
54990
54991
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 54989

def total_results_count
  @total_results_count
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



54996
54997
54998
54999
55000
55001
55002
55003
55004
55005
55006
55007
55008
55009
 
# File 'lib/google/apis/searchads360_v23/classes.rb', line 54996

def update!(**args)
  @conversion_custom_dimension_headers = args[:conversion_custom_dimension_headers] if args.key?(:conversion_custom_dimension_headers)
  @conversion_custom_metric_headers = args[:conversion_custom_metric_headers] if args.key?(:conversion_custom_metric_headers)
  @custom_column_headers = args[:custom_column_headers] if args.key?(:custom_column_headers)
  @field_mask = args[:field_mask] if args.key?(:field_mask)
  @metric_attributes = args[:metric_attributes] if args.key?(:metric_attributes)
  @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
  @query_resource_consumption = args[:query_resource_consumption] if args.key?(:query_resource_consumption)
  @raw_event_conversion_dimension_headers = args[:raw_event_conversion_dimension_headers] if args.key?(:raw_event_conversion_dimension_headers)
  @raw_event_conversion_metric_headers = args[:raw_event_conversion_metric_headers] if args.key?(:raw_event_conversion_metric_headers)
  @results = args[:results] if args.key?(:results)
  @summary_row = args[:summary_row] if args.key?(:summary_row)
  @total_results_count = args[:total_results_count] if args.key?(:total_results_count)
end