Class: Google::Apis::AdexperiencereportV1::AdExperienceReportService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/adexperiencereport_v1/service.rb

Overview

Ad Experience Report API

View Ad Experience Report data, and get a list of sites that have a significant number of annoying ads.

Examples:

require 'google/apis/adexperiencereport_v1'

Adexperiencereport = Google::Apis::AdexperiencereportV1 # Alias the module
service = Adexperiencereport::AdExperienceReportService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ AdExperienceReportService

Returns a new instance of AdExperienceReportService



46
47
48
49
 
# File 'generated/google/apis/adexperiencereport_v1/service.rb', line 46

def initialize
  super('https://adexperiencereport.googleapis.com/', '')
  @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.



39
40
41
 
# File 'generated/google/apis/adexperiencereport_v1/service.rb', line 39

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.



44
45
46
 
# File 'generated/google/apis/adexperiencereport_v1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#get_site(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::AdexperiencereportV1::SiteSummaryResponse

Gets a summary of the ad experience rating of a site.

Parameters:

  • name (String) —

    The required site name. It should be the site property whose ad experiences may have been reviewed, and it should be URL-encoded. For example, sites/https%3A%2F%2Fwww.google.com. The server will return an error of BAD_REQUEST if this field is not filled in. Note that if the site property is not yet verified in Search Console, the reportUrl field returned by the API will lead to the verification page, prompting the user to go through that process before they can gain access to the Ad Experience Report.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



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

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::AdexperiencereportV1::SiteSummaryResponse::Representation
  command.response_class = Google::Apis::AdexperiencereportV1::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) {|result, err| ... } ⇒ Google::Apis::AdexperiencereportV1::ViolatingSitesResponse

Lists sites with Ad Experience Report statuses of "Failing" or "Warning".

Parameters:

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (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.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



105
106
107
108
109
110
111
112
 
# File 'generated/google/apis/adexperiencereport_v1/service.rb', line 105

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::AdexperiencereportV1::ViolatingSitesResponse::Representation
  command.response_class = Google::Apis::AdexperiencereportV1::ViolatingSitesResponse
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end