Documentation

Overview

Package abusiveexperiencereport provides access to the Abusive Experience Report API.

For product documentation, see: https://developers.google.com/abusive-experience-report/

Creating a client

Usage example:

import "google.golang.org/api/abusiveexperiencereport/v1"
...
ctx := context.Background()
abusiveexperiencereportService, err := abusiveexperiencereport.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:

abusiveexperiencereportService, err := abusiveexperiencereport.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
abusiveexperiencereportService, err := abusiveexperiencereport.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Service

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Sites *SitesService

	ViolatingSites *ViolatingSitesService
	// contains filtered or unexported fields
}

func New

func New(client *http.Client) (*Service, error)

    New creates a new Service. It uses the provided http.Client for requests.

    Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

    func NewService

    func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

      NewService creates a new Service.

      type SiteSummaryResponse

      type SiteSummaryResponse struct {
      	// AbusiveStatus: The site's Abusive Experience Report status.
      	//
      	// Possible values:
      	//   "UNKNOWN" - Not reviewed.
      	//   "PASSING" - Passing.
      	//   "FAILING" - Failing.
      	AbusiveStatus string `json:"abusiveStatus,omitempty"`
      
      	// EnforcementTime: The time at which enforcement
      	// (https://support.google.com/webtools/answer/7538608) against the site
      	// began or will begin. Not set when the filter_status is OFF.
      	EnforcementTime string `json:"enforcementTime,omitempty"`
      
      	// FilterStatus: The site's enforcement status
      	// (https://support.google.com/webtools/answer/7538608).
      	//
      	// Possible values:
      	//   "UNKNOWN" - N/A.
      	//   "ON" - Enforcement is on.
      	//   "OFF" - Enforcement is off.
      	//   "PAUSED" - Enforcement is paused.
      	//   "PENDING" - Enforcement is pending.
      	FilterStatus string `json:"filterStatus,omitempty"`
      
      	// LastChangeTime: The time at which the site's status last changed.
      	LastChangeTime string `json:"lastChangeTime,omitempty"`
      
      	// ReportUrl: A link to the full Abusive Experience Report for the site.
      	// Not set in ViolatingSitesResponse. Note that you must complete the
      	// Search Console verification process
      	// (https://support.google.com/webmasters/answer/9008080) for the site
      	// before you can access the full report.
      	ReportUrl string `json:"reportUrl,omitempty"`
      
      	// ReviewedSite: The name of the reviewed site, e.g. `google.com`.
      	ReviewedSite string `json:"reviewedSite,omitempty"`
      
      	// UnderReview: Whether the site is currently under review.
      	UnderReview bool `json:"underReview,omitempty"`
      
      	// ServerResponse contains the HTTP response code and headers from the
      	// server.
      	googleapi.ServerResponse `json:"-"`
      
      	// ForceSendFields is a list of field names (e.g. "AbusiveStatus") to
      	// unconditionally include in API requests. By default, fields with
      	// empty values are omitted from API requests. However, any non-pointer,
      	// non-interface field appearing in ForceSendFields will be sent to the
      	// server regardless of whether the field is empty or not. This may be
      	// used to include empty fields in Patch requests.
      	ForceSendFields []string `json:"-"`
      
      	// NullFields is a list of field names (e.g. "AbusiveStatus") to include
      	// in API requests with the JSON null value. By default, fields with
      	// empty values are omitted from API requests. However, any field with
      	// an empty value appearing in NullFields will be sent to the server as
      	// null. It is an error if a field in this list has a non-empty value.
      	// This may be used to include null fields in Patch requests.
      	NullFields []string `json:"-"`
      }

        SiteSummaryResponse: Response message for GetSiteSummary.

        func (*SiteSummaryResponse) MarshalJSON

        func (s *SiteSummaryResponse) MarshalJSON() ([]byte, error)

        type SitesGetCall

        type SitesGetCall struct {
        	// contains filtered or unexported fields
        }

        func (*SitesGetCall) Context

        func (c *SitesGetCall) Context(ctx context.Context) *SitesGetCall

          Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

          func (*SitesGetCall) Do

            Do executes the "abusiveexperiencereport.sites.get" call. Exactly one of *SiteSummaryResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SiteSummaryResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

            func (*SitesGetCall) Fields

            func (c *SitesGetCall) Fields(s ...googleapi.Field) *SitesGetCall

              Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

              func (*SitesGetCall) Header

              func (c *SitesGetCall) Header() http.Header

                Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

                func (*SitesGetCall) IfNoneMatch

                func (c *SitesGetCall) IfNoneMatch(entityTag string) *SitesGetCall

                  IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

                  type SitesService

                  type SitesService struct {
                  	// contains filtered or unexported fields
                  }

                  func NewSitesService

                  func NewSitesService(s *Service) *SitesService

                  func (*SitesService) Get

                  func (r *SitesService) Get(name string) *SitesGetCall

                    Get: Gets a site's Abusive Experience Report summary.

                    type ViolatingSitesListCall

                    type ViolatingSitesListCall struct {
                    	// contains filtered or unexported fields
                    }

                    func (*ViolatingSitesListCall) Context

                      Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

                      func (*ViolatingSitesListCall) Do

                        Do executes the "abusiveexperiencereport.violatingSites.list" call. Exactly one of *ViolatingSitesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ViolatingSitesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

                        func (*ViolatingSitesListCall) Fields

                          Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

                          func (*ViolatingSitesListCall) Header

                          func (c *ViolatingSitesListCall) Header() http.Header

                            Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

                            func (*ViolatingSitesListCall) IfNoneMatch

                            func (c *ViolatingSitesListCall) IfNoneMatch(entityTag string) *ViolatingSitesListCall

                              IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

                              type ViolatingSitesResponse

                              type ViolatingSitesResponse struct {
                              	// ViolatingSites: The list of violating sites.
                              	ViolatingSites []*SiteSummaryResponse `json:"violatingSites,omitempty"`
                              
                              	// ServerResponse contains the HTTP response code and headers from the
                              	// server.
                              	googleapi.ServerResponse `json:"-"`
                              
                              	// ForceSendFields is a list of field names (e.g. "ViolatingSites") to
                              	// unconditionally include in API requests. By default, fields with
                              	// empty values are omitted from API requests. However, any non-pointer,
                              	// non-interface field appearing in ForceSendFields will be sent to the
                              	// server regardless of whether the field is empty or not. This may be
                              	// used to include empty fields in Patch requests.
                              	ForceSendFields []string `json:"-"`
                              
                              	// NullFields is a list of field names (e.g. "ViolatingSites") to
                              	// include in API requests with the JSON null value. By default, fields
                              	// with empty values are omitted from API requests. However, any field
                              	// with an empty value appearing in NullFields will be sent to the
                              	// server as null. It is an error if a field in this list has a
                              	// non-empty value. This may be used to include null fields in Patch
                              	// requests.
                              	NullFields []string `json:"-"`
                              }

                                ViolatingSitesResponse: Response message for ListViolatingSites.

                                func (*ViolatingSitesResponse) MarshalJSON

                                func (s *ViolatingSitesResponse) MarshalJSON() ([]byte, error)

                                type ViolatingSitesService

                                type ViolatingSitesService struct {
                                	// contains filtered or unexported fields
                                }

                                func NewViolatingSitesService

                                func NewViolatingSitesService(s *Service) *ViolatingSitesService

                                func (*ViolatingSitesService) List

                                  List: Lists sites that are failing in the Abusive Experience Report.