webmasters

package
v0.48.1-0...-67a0a95 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 22, 2021 License: BSD-3-Clause Imports: 15 Imported by: 0

Documentation

Overview

Package webmasters provides access to the Search Console API.

For product documentation, see: https://developers.google.com/webmaster-tools/

Creating a client

Usage example: 

import "google.golang.org/api/webmasters/v3"
...
ctx := context.Background()
webmastersService, err := webmasters.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

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes: 

webmastersService, err := webmasters.NewService(ctx, option.WithScopes(webmasters.WebmastersReadonlyScope))

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

webmastersService, err := webmasters.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, ...)
webmastersService, err := webmasters.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

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

Index

Constants

View Source 
const (
	// View and manage Search Console data for your verified sites
	WebmastersScope = "https://www.googleapis.com/auth/webmasters"

	// View Search Console data for your verified sites
	WebmastersReadonlyScope = "https://www.googleapis.com/auth/webmasters.readonly"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiDataRow 

type ApiDataRow struct {
	Clicks float64 `json:"clicks,omitempty"`

	Ctr float64 `json:"ctr,omitempty"`

	Impressions float64 `json:"impressions,omitempty"`

	Keys []string `json:"keys,omitempty"`

	Position float64 `json:"position,omitempty"`

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

func (*ApiDataRow) MarshalJSON 

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

func (*ApiDataRow) UnmarshalJSON 

func (s *ApiDataRow) UnmarshalJSON(data []byte) error

type ApiDimensionFilter 

type ApiDimensionFilter struct {
	Dimension string `json:"dimension,omitempty"`

	Expression string `json:"expression,omitempty"`

	Operator string `json:"operator,omitempty"`

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

func (*ApiDimensionFilter) MarshalJSON 

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

type ApiDimensionFilterGroup 

type ApiDimensionFilterGroup struct {
	Filters []*ApiDimensionFilter `json:"filters,omitempty"`

	GroupType string `json:"groupType,omitempty"`

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

func (*ApiDimensionFilterGroup) MarshalJSON 

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

type SearchAnalyticsQueryRequest 

type SearchAnalyticsQueryRequest struct {
	// AggregationType: [Optional; Default is "auto"] How data is
	// aggregated. If aggregated by property, all data for the same property
	// is aggregated; if aggregated by page, all data is aggregated by
	// canonical URI. If you filter or group by page, choose AUTO; otherwise
	// you can aggregate either by property or by page, depending on how you
	// want your data calculated; see  the help documentation to learn how
	// data is calculated differently by site versus by page.
	//
	// Note: If you group or filter by page, you cannot aggregate by
	// property.
	//
	// If you specify any value other than AUTO, the aggregation type in the
	// result will match the requested type, or if you request an invalid
	// type, you will get an error. The API will never change your
	// aggregation type if the requested type is invalid.
	AggregationType string `json:"aggregationType,omitempty"`

	// DataState: [Optional] If "all" (case-insensitive), data will include
	// fresh data. If "final" (case-insensitive) or if this parameter is
	// omitted, the returned data will include only finalized data.
	DataState string `json:"dataState,omitempty"`

	// DimensionFilterGroups: [Optional] Zero or more filters to apply to
	// the dimension grouping values; for example, 'query contains "buy"' to
	// see only data where the query string contains the substring "buy"
	// (not case-sensitive). You can filter by a dimension without grouping
	// by it.
	DimensionFilterGroups []*ApiDimensionFilterGroup `json:"dimensionFilterGroups,omitempty"`

	// Dimensions: [Optional] Zero or more dimensions to group results by.
	// Dimensions are the group-by values in the Search Analytics page.
	// Dimensions are combined to create a unique row key for each row.
	// Results are grouped in the order that you supply these dimensions.
	Dimensions []string `json:"dimensions,omitempty"`

	// EndDate: [Required] End date of the requested date range, in
	// YYYY-MM-DD format, in PST (UTC - 8:00). Must be greater than or equal
	// to the start date. This value is included in the range.
	EndDate string `json:"endDate,omitempty"`

	// RowLimit: [Optional; Default is 1000] The maximum number of rows to
	// return. Must be a number from 1 to 5,000 (inclusive).
	RowLimit int64 `json:"rowLimit,omitempty"`

	// SearchType: [Optional; Default is "web"] The search type to filter
	// for.
	SearchType string `json:"searchType,omitempty"`

	// StartDate: [Required] Start date of the requested date range, in
	// YYYY-MM-DD format, in PST time (UTC - 8:00). Must be less than or
	// equal to the end date. This value is included in the range.
	StartDate string `json:"startDate,omitempty"`

	// StartRow: [Optional; Default is 0] Zero-based index of the first row
	// in the response. Must be a non-negative number.
	StartRow int64 `json:"startRow,omitempty"`

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

func (*SearchAnalyticsQueryRequest) MarshalJSON 

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

type SearchAnalyticsQueryResponse 

type SearchAnalyticsQueryResponse struct {
	// ResponseAggregationType: How the results were aggregated.
	ResponseAggregationType string `json:"responseAggregationType,omitempty"`

	// Rows: A list of rows grouped by the key values in the order given in
	// the query.
	Rows []*ApiDataRow `json:"rows,omitempty"`

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

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

SearchAnalyticsQueryResponse: A list of rows, one per result, grouped by key. Metrics in each row are aggregated for all data grouped by that key either by page or property, as specified by the aggregation type parameter.

func (*SearchAnalyticsQueryResponse) MarshalJSON 

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

type SearchanalyticsQueryCall 

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

func (*SearchanalyticsQueryCall) Context 

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

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 (*SearchanalyticsQueryCall) Do 

func (c *SearchanalyticsQueryCall) Do(opts ...googleapi.CallOption) (*SearchAnalyticsQueryResponse, error)

Do executes the "webmasters.searchanalytics.query" call. Exactly one of *SearchAnalyticsQueryResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SearchAnalyticsQueryResponse.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 (*SearchanalyticsQueryCall) Fields 

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

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

func (*SearchanalyticsQueryCall) Header 

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

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

type SearchanalyticsService 

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

func NewSearchanalyticsService 

func NewSearchanalyticsService(s *Service) *SearchanalyticsService

func (*SearchanalyticsService) Query 

func (r *SearchanalyticsService) Query(siteUrl string, searchanalyticsqueryrequest *SearchAnalyticsQueryRequest) *SearchanalyticsQueryCall

Query: Query your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of one or more days.

When date is one of the group by values, any days without data are omitted from the result list. If you need to know which days have data, issue a broad date range query grouped by date for any metric, and see which day rows are returned.

type Service 

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

	Searchanalytics *SearchanalyticsService

	Sitemaps *SitemapsService

	Sites *SitesService
	// contains filtered or unexported fields
}

func New deprecated 

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 SitemapsDeleteCall 

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

func (*SitemapsDeleteCall) Context 

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

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 (*SitemapsDeleteCall) Do 

func (c *SitemapsDeleteCall) Do(opts ...googleapi.CallOption) error

Do executes the "webmasters.sitemaps.delete" call.

func (*SitemapsDeleteCall) Fields 

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

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

func (*SitemapsDeleteCall) Header 

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

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

type SitemapsGetCall 

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

func (*SitemapsGetCall) Context 

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

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 (*SitemapsGetCall) Do 

func (c *SitemapsGetCall) Do(opts ...googleapi.CallOption) (*WmxSitemap, error)

Do executes the "webmasters.sitemaps.get" call. Exactly one of *WmxSitemap or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *WmxSitemap.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 (*SitemapsGetCall) Fields 

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

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

func (*SitemapsGetCall) Header 

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

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

func (*SitemapsGetCall) IfNoneMatch 

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

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 SitemapsListCall 

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

func (*SitemapsListCall) Context 

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

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 (*SitemapsListCall) Do 

func (c *SitemapsListCall) Do(opts ...googleapi.CallOption) (*SitemapsListResponse, error)

Do executes the "webmasters.sitemaps.list" call. Exactly one of *SitemapsListResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SitemapsListResponse.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 (*SitemapsListCall) Fields 

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

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

func (*SitemapsListCall) Header 

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

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

func (*SitemapsListCall) IfNoneMatch 

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

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.

func (*SitemapsListCall) SitemapIndex 

func (c *SitemapsListCall) SitemapIndex(sitemapIndex string) *SitemapsListCall

SitemapIndex sets the optional parameter "sitemapIndex": A URL of a site's sitemap index. For example: http://www.example.com/sitemapindex.xml

type SitemapsListResponse 

type SitemapsListResponse struct {
	// Sitemap: Contains detailed information about a specific URL submitted
	// as a sitemap.
	Sitemap []*WmxSitemap `json:"sitemap,omitempty"`

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

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

SitemapsListResponse: List of sitemaps.

func (*SitemapsListResponse) MarshalJSON 

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

type SitemapsService 

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

func NewSitemapsService 

func NewSitemapsService(s *Service) *SitemapsService

func (*SitemapsService) Delete 

func (r *SitemapsService) Delete(siteUrl string, feedpath string) *SitemapsDeleteCall

Delete: Deletes a sitemap from this site.

func (*SitemapsService) Get 

func (r *SitemapsService) Get(siteUrl string, feedpath string) *SitemapsGetCall

Get: Retrieves information about a specific sitemap.

func (*SitemapsService) List 

func (r *SitemapsService) List(siteUrl string) *SitemapsListCall

List: Lists the sitemaps-entries submitted for this site, or included in the sitemap index file (if sitemapIndex is specified in the request).

func (*SitemapsService) Submit 

func (r *SitemapsService) Submit(siteUrl string, feedpath string) *SitemapsSubmitCall

Submit: Submits a sitemap for a site.

type SitemapsSubmitCall 

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

func (*SitemapsSubmitCall) Context 

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

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 (*SitemapsSubmitCall) Do 

func (c *SitemapsSubmitCall) Do(opts ...googleapi.CallOption) error

Do executes the "webmasters.sitemaps.submit" call.

func (*SitemapsSubmitCall) Fields 

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

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

func (*SitemapsSubmitCall) Header 

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

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

type SitesAddCall 

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

func (*SitesAddCall) Context 

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

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 (*SitesAddCall) Do 

func (c *SitesAddCall) Do(opts ...googleapi.CallOption) error

Do executes the "webmasters.sites.add" call.

func (*SitesAddCall) Fields 

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

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

func (*SitesAddCall) Header 

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

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

type SitesDeleteCall 

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

func (*SitesDeleteCall) Context 

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

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 (*SitesDeleteCall) Do 

func (c *SitesDeleteCall) Do(opts ...googleapi.CallOption) error

Do executes the "webmasters.sites.delete" call.

func (*SitesDeleteCall) Fields 

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

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

func (*SitesDeleteCall) Header 

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

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

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) (*WmxSite, error)

Do executes the "webmasters.sites.get" call. Exactly one of *WmxSite or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *WmxSite.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 SitesListCall 

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

func (*SitesListCall) Context 

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

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 (*SitesListCall) Do 

func (c *SitesListCall) Do(opts ...googleapi.CallOption) (*SitesListResponse, error)

Do executes the "webmasters.sites.list" call. Exactly one of *SitesListResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *SitesListResponse.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 (*SitesListCall) Fields 

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

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

func (*SitesListCall) Header 

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

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

func (*SitesListCall) IfNoneMatch 

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

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 SitesListResponse 

type SitesListResponse struct {
	// SiteEntry: Contains permission level information about a Search
	// Console site. For more information, see Permissions in Search
	// Console.
	SiteEntry []*WmxSite `json:"siteEntry,omitempty"`

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

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

SitesListResponse: List of sites with access level information.

func (*SitesListResponse) MarshalJSON 

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

type SitesService 

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

func NewSitesService 

func NewSitesService(s *Service) *SitesService

func (*SitesService) Add 

func (r *SitesService) Add(siteUrl string) *SitesAddCall

Add: Adds a site to the set of the user's sites in Search Console.

- siteUrl: The URL of the site to add.

func (*SitesService) Delete 

func (r *SitesService) Delete(siteUrl string) *SitesDeleteCall

Delete: Removes a site from the set of the user's Search Console sites.

  • siteUrl: The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs.

func (*SitesService) Get 

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

Get: Retrieves information about specific site.

  • siteUrl: The URI of the property as defined in Search Console. Examples: http://www.example.com/ or android-app://com.example/ Note: for property-sets, use the URI that starts with sc-set: which is used in Search Console URLs.

func (*SitesService) List 

func (r *SitesService) List() *SitesListCall

List: Lists the user's Search Console sites.

type WmxSite 

type WmxSite struct {
	// PermissionLevel: The user's permission level for the site.
	PermissionLevel string `json:"permissionLevel,omitempty"`

	// SiteUrl: The URL of the site.
	SiteUrl string `json:"siteUrl,omitempty"`

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

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

WmxSite: Contains permission level information about a Search Console site. For more information, see Permissions in Search Console.

func (*WmxSite) MarshalJSON 

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

type WmxSitemap 

type WmxSitemap struct {
	// Contents: The various content types in the sitemap.
	Contents []*WmxSitemapContent `json:"contents,omitempty"`

	// Errors: Number of errors in the sitemap. These are issues with the
	// sitemap itself that need to be fixed before it can be processed
	// correctly.
	Errors int64 `json:"errors,omitempty,string"`

	// IsPending: If true, the sitemap has not been processed.
	IsPending bool `json:"isPending,omitempty"`

	// IsSitemapsIndex: If true, the sitemap is a collection of sitemaps.
	IsSitemapsIndex bool `json:"isSitemapsIndex,omitempty"`

	// LastDownloaded: Date & time in which this sitemap was last
	// downloaded. Date format is in RFC 3339 format (yyyy-mm-dd).
	LastDownloaded string `json:"lastDownloaded,omitempty"`

	// LastSubmitted: Date & time in which this sitemap was submitted. Date
	// format is in RFC 3339 format (yyyy-mm-dd).
	LastSubmitted string `json:"lastSubmitted,omitempty"`

	// Path: The url of the sitemap.
	Path string `json:"path,omitempty"`

	// Type: The type of the sitemap. For example: rssFeed.
	Type string `json:"type,omitempty"`

	// Warnings: Number of warnings for the sitemap. These are generally
	// non-critical issues with URLs in the sitemaps.
	Warnings int64 `json:"warnings,omitempty,string"`

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

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

WmxSitemap: Contains detailed information about a specific URL submitted as a sitemap.

func (*WmxSitemap) MarshalJSON 

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

type WmxSitemapContent 

type WmxSitemapContent struct {
	// Indexed: The number of URLs from the sitemap that were indexed (of
	// the content type).
	Indexed int64 `json:"indexed,omitempty,string"`

	// Submitted: The number of URLs in the sitemap (of the content type).
	Submitted int64 `json:"submitted,omitempty,string"`

	// Type: The specific type of content in this sitemap. For example: web.
	Type string `json:"type,omitempty"`

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

WmxSitemapContent: Information about the various content types in the sitemap.

func (*WmxSitemapContent) MarshalJSON 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.