class Google::Apis::AbusiveexperiencereportV1::AbusiveExperienceReportService

Abusive Experience Report API

Views Abusive Experience Report data, and gets a list of sites that have a

significant number of abusive experiences.

@example

require 'google/apis/abusiveexperiencereport_v1'

Abusiveexperiencereport = Google::Apis::AbusiveexperiencereportV1 # Alias the module
service = Abusiveexperiencereport::AbusiveExperienceReportService.new

@see developers.google.com/abusive-experience-report/

Attributes

key[RW]

@return [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.
quota_user[RW]

@return [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.

Public Class Methods

new() click to toggle source
Calls superclass method
# File lib/google/apis/abusiveexperiencereport_v1/service.rb, line 46
def initialize
  super('https://abusiveexperiencereport.googleapis.com/', '',
        client_name: 'google-apis-abusiveexperiencereport_v1',
        client_version: Google::Apis::AbusiveexperiencereportV1::GEM_VERSION)
  @batch_path = 'batch'
end

Public Instance Methods

get_site(name, fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Gets a site's Abusive Experience Report summary. @param [String] name

Required. The name of the site whose summary to get, e.g. `sites/http%3A%2F%
2Fwww.google.com%2F`. Format: `sites/`site``

@param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AbusiveexperiencereportV1::SiteSummaryResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AbusiveexperiencereportV1::SiteSummaryResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/abusiveexperiencereport_v1/service.rb, line 74
def get_site(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/{+name}', options)
  command.response_representation = Google::Apis::AbusiveexperiencereportV1::SiteSummaryResponse::Representation
  command.response_class = Google::Apis::AbusiveexperiencereportV1::SiteSummaryResponse
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end
list_violating_sites(fields: nil, quota_user: nil, options: nil, &block) click to toggle source

Lists sites that are failing in the Abusive Experience Report. @param [String] fields

Selector specifying which fields to include in a partial response.

@param [String] quota_user

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.

@param [Google::Apis::RequestOptions] options

Request-specific options

@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::AbusiveexperiencereportV1::ViolatingSitesResponse] parsed result object @yieldparam err [StandardError] error object if request failed

@return [Google::Apis::AbusiveexperiencereportV1::ViolatingSitesResponse]

@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required

# File lib/google/apis/abusiveexperiencereport_v1/service.rb, line 102
def list_violating_sites(fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1/violatingSites', options)
  command.response_representation = Google::Apis::AbusiveexperiencereportV1::ViolatingSitesResponse::Representation
  command.response_class = Google::Apis::AbusiveexperiencereportV1::ViolatingSitesResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

Protected Instance Methods

apply_command_defaults(command) click to toggle source
# File lib/google/apis/abusiveexperiencereport_v1/service.rb, line 113
def apply_command_defaults(command)
  command.query['key'] = key unless key.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
end