Class: Google::Apis::ChromeuxreportV1::ChromeUXReportService

Inherits:
Google::Apis::Core::BaseService
  • Object
show all
Defined in:
lib/google/apis/chromeuxreport_v1/service.rb

Overview

Chrome UX Report API

The Chrome UX Report API lets you view real user experience data for millions of websites.

Examples:

require 'google/apis/chromeuxreport_v1'

Chromeuxreport = Google::Apis::ChromeuxreportV1 # Alias the module
service = Chromeuxreport::ChromeUXReportService.new

See Also:

Constant Summary collapse

DEFAULT_ENDPOINT_TEMPLATE = 
"https://chromeuxreport.$UNIVERSE_DOMAIN$/"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ChromeUXReportService

Returns a new instance of ChromeUXReportService.



48
49
50
51
52
53
 
# File 'lib/google/apis/chromeuxreport_v1/service.rb', line 48

def initialize
  super(DEFAULT_ENDPOINT_TEMPLATE, '',
        client_name: 'google-apis-chromeuxreport_v1',
        client_version: Google::Apis::ChromeuxreportV1::GEM_VERSION)
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



41
42
43
 
# File 'lib/google/apis/chromeuxreport_v1/service.rb', line 41

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



46
47
48
 
# File 'lib/google/apis/chromeuxreport_v1/service.rb', line 46

def quota_user
  @quota_user
end

Instance Method Details

#query_record_history_record(query_history_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromeuxreportV1::QueryHistoryResponse

Queries the Chrome User Experience Report for a timeseries history record for a given site. Returns a history record that contains one or more metric timeseries corresponding to performance data about the requested site.

Parameters:

  • query_history_request_object (Google::Apis::ChromeuxreportV1::QueryHistoryRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/google/apis/chromeuxreport_v1/service.rb', line 76

def query_record_history_record(query_history_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/records:queryHistoryRecord', options)
  command.request_representation = Google::Apis::ChromeuxreportV1::QueryHistoryRequest::Representation
  command.request_object = query_history_request_object
  command.response_representation = Google::Apis::ChromeuxreportV1::QueryHistoryResponse::Representation
  command.response_class = Google::Apis::ChromeuxreportV1::QueryHistoryResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#query_record_record(query_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ChromeuxreportV1::QueryResponse

Queries the Chrome User Experience for a single record for a given site. Returns a record that contains one or more metrics corresponding to performance data about the requested site.

Parameters:

  • query_request_object (Google::Apis::ChromeuxreportV1::QueryRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



108
109
110
111
112
113
114
115
116
117
 
# File 'lib/google/apis/chromeuxreport_v1/service.rb', line 108

def query_record_record(query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1/records:queryRecord', options)
  command.request_representation = Google::Apis::ChromeuxreportV1::QueryRequest::Representation
  command.request_object = query_request_object
  command.response_representation = Google::Apis::ChromeuxreportV1::QueryResponse::Representation
  command.response_class = Google::Apis::ChromeuxreportV1::QueryResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end