adexperiencereport

Documentation

Overview

Package adexperiencereport provides access to the Google Ad Experience Report API.

See https://developers.google.com/ad-experience-report/

Usage example:

import "google.golang.org/api/adexperiencereport/v1"
...
adexperiencereportService, err := adexperiencereport.New(oauthHttpClient)

Index

• Constants
• type PlatformSummary
  • func (s *PlatformSummary) MarshalJSON() ([]byte, error)
• type Service
  • func New(client *http.Client) (*Service, error)
• type SiteSummaryResponse
  • func (s *SiteSummaryResponse) MarshalJSON() ([]byte, error)
• type SitesGetCall
  • func (c *SitesGetCall) Context(ctx context.Context) *SitesGetCall
  • func (c *SitesGetCall) Do(opts ...googleapi.CallOption) (*SiteSummaryResponse, error)
  • func (c *SitesGetCall) Fields(s ...googleapi.Field) *SitesGetCall
  • func (c *SitesGetCall) Header() http.Header
  • func (c *SitesGetCall) IfNoneMatch(entityTag string) *SitesGetCall
• type SitesService
  • func NewSitesService(s *Service) *SitesService
  • func (r *SitesService) Get(name string) *SitesGetCall
• type ViolatingSitesListCall
  • func (c *ViolatingSitesListCall) Context(ctx context.Context) *ViolatingSitesListCall
  • func (c *ViolatingSitesListCall) Do(opts ...googleapi.CallOption) (*ViolatingSitesResponse, error)
  • func (c *ViolatingSitesListCall) Fields(s ...googleapi.Field) *ViolatingSitesListCall
  • func (c *ViolatingSitesListCall) Header() http.Header
  • func (c *ViolatingSitesListCall) IfNoneMatch(entityTag string) *ViolatingSitesListCall
• type ViolatingSitesResponse
  • func (s *ViolatingSitesResponse) MarshalJSON() ([]byte, error)
• type ViolatingSitesService
  • func NewViolatingSitesService(s *Service) *ViolatingSitesService
  • func (r *ViolatingSitesService) List() *ViolatingSitesListCall

Constants

const (
	// Test scope for access to the Zoo service
	XapiZooScope = "https://www.googleapis.com/auth/xapi.zoo"
)

OAuth2 scopes used by this API.

Types

type PlatformSummary

type PlatformSummary struct {
	// BetterAdsStatus: The status of the site reviewed for the Better Ads
	// Standards.
	//
	// Possible values:
	//   "UNKNOWN" - Not reviewed.
	//   "PASSING" - Passing.
	//   "WARNING" - Warning.
	//   "FAILING" - Failing.
	BetterAdsStatus string `json:"betterAdsStatus,omitempty"`

	// EnforcementTime: The date on which ad filtering begins.
	EnforcementTime string `json:"enforcementTime,omitempty"`

	// FilterStatus: The ad filtering status of the site.
	//
	// Possible values:
	//   "UNKNOWN" - N/A.
	//   "ON" - Ad filtering is on.
	//   "OFF" - Ad filtering is off.
	//   "PAUSED" - Ad filtering is paused.
	//   "PENDING" - Ad filtering is pending.
	FilterStatus string `json:"filterStatus,omitempty"`

	// LastChangeTime: The last time that the site changed status.
	LastChangeTime string `json:"lastChangeTime,omitempty"`

	// Region: The assigned regions for the site and platform.
	//
	// Possible values:
	//   "REGION_UNKNOWN" - Ad standard not yet defined for your region.
	//   "REGION_A" - Region A.
	//   "REGION_B" - Region B.
	Region []string `json:"region,omitempty"`

	// ReportUrl: A link that leads to a full ad experience report.
	ReportUrl string `json:"reportUrl,omitempty"`

	// UnderReview: Whether the site is currently under review.
	UnderReview bool `json:"underReview,omitempty"`

	// ForceSendFields is a list of field names (e.g. "BetterAdsStatus") 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. "BetterAdsStatus") 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:"-"`
}

PlatformSummary: Summary of the ad experience rating of a site for a specific platform.

func (*PlatformSummary) MarshalJSON

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

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)

type SiteSummaryResponse

type SiteSummaryResponse struct {
	// DesktopSummary: Summary for the desktop review of the site.
	DesktopSummary *PlatformSummary `json:"desktopSummary,omitempty"`

	// MobileSummary: Summary for the mobile review of the site.
	MobileSummary *PlatformSummary `json:"mobileSummary,omitempty"`

	// ReviewedSite: The name of the site reviewed.
	ReviewedSite string `json:"reviewedSite,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "DesktopSummary") 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. "DesktopSummary") 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

func (c *SitesGetCall) Do(opts ...googleapi.CallOption) (*SiteSummaryResponse, error)

Do executes the "adexperiencereport.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 summary of the ad experience rating of a site.

type ViolatingSitesListCall

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

func (*ViolatingSitesListCall) Context

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

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

func (c *ViolatingSitesListCall) Do(opts ...googleapi.CallOption) (*ViolatingSitesResponse, error)

Do executes the "adexperiencereport.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

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

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: A list of summaries 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

func (r *ViolatingSitesService) List() *ViolatingSitesListCall

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