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

Views Ad Experience Report data, and gets 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

Instance Method Summary collapse

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 site's Ad Experience Report summary.

Parameters:

  • name (String) —

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

  • 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



72
73
74
75
76
77
78
79
80
 
# File 'generated/google/apis/adexperiencereport_v1/service.rb', line 72

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 that are failing in the Ad Experience Report on at least one platform.

Parameters:

  • 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



101
102
103
104
105
106
107
108
 
# File 'generated/google/apis/adexperiencereport_v1/service.rb', line 101

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