Class: Google::Apis::SearchconsoleV1::SearchAnalyticsQueryResponse

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

Overview

A list of rows, one per result, grouped by key. Metrics in each row are aggregated for all data grouped by that key either by page or property, as specified by the aggregation type parameter.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ SearchAnalyticsQueryResponse

Returns a new instance of SearchAnalyticsQueryResponse.



848
849
850
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 848

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

Instance Attribute Details

#metadata ⇒ Google::Apis::SearchconsoleV1::Metadata

An object that may be returned with your query results, providing context about the state of the data. When you request recent data (using all or hourly_all for dataState), some of the rows returned may represent data that is incomplete, which means that the data is still being collected and processed. This metadata object helps you identify exactly when this starts and ends. All dates and times provided in this object are in the America/ Los_Angeles time zone. The specific field returned within this object depends on how you've grouped your data in the request. See details in inner fields. Corresponds to the JSON property metadata

Returns:



836
837
838
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 836

def metadata
  @metadata
end

#response_aggregation_type ⇒ String

How the results were aggregated. Corresponds to the JSON property responseAggregationType

Returns:

  • (String) 


841
842
843
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 841

def response_aggregation_type
  @response_aggregation_type
end

#rows ⇒ Array<Google::Apis::SearchconsoleV1::ApiDataRow>

A list of rows grouped by the key values in the order given in the query. Corresponds to the JSON property rows

Returns:



846
847
848
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 846

def rows
  @rows
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



853
854
855
856
857
 
# File 'lib/google/apis/searchconsole_v1/classes.rb', line 853

def update!(**args)
  @metadata = args[:metadata] if args.key?(:metadata)
  @response_aggregation_type = args[:response_aggregation_type] if args.key?(:response_aggregation_type)
  @rows = args[:rows] if args.key?(:rows)
end