Documentation
¶
Overview ¶
Package webmasters provides access to the Webmaster Tools API.
See https://developers.google.com/webmaster-tools/v3/welcome
Usage example:
import "google.golang.org/api/webmasters/v3" ... webmastersService, err := webmasters.New(oauthHttpClient)
Index ¶
- Constants
- type Service
- type SitemapsDeleteCall
- type SitemapsGetCall
- type SitemapsListCall
- type SitemapsListResponse
- type SitemapsService
- func (r *SitemapsService) Delete(siteUrl string, feedpath string) *SitemapsDeleteCall
- func (r *SitemapsService) Get(siteUrl string, feedpath string) *SitemapsGetCall
- func (r *SitemapsService) List(siteUrl string) *SitemapsListCall
- func (r *SitemapsService) Submit(siteUrl string, feedpath string) *SitemapsSubmitCall
- type SitemapsSubmitCall
- type SitesAddCall
- type SitesDeleteCall
- type SitesGetCall
- type SitesListCall
- type SitesListResponse
- type SitesService
- type UrlCrawlErrorCount
- type UrlCrawlErrorCountsPerType
- type UrlCrawlErrorsCountsQueryResponse
- type UrlCrawlErrorsSample
- type UrlCrawlErrorsSamplesListResponse
- type UrlSampleDetails
- type UrlcrawlerrorscountsQueryCall
- func (c *UrlcrawlerrorscountsQueryCall) Category(category string) *UrlcrawlerrorscountsQueryCall
- func (c *UrlcrawlerrorscountsQueryCall) Do() (*UrlCrawlErrorsCountsQueryResponse, error)
- func (c *UrlcrawlerrorscountsQueryCall) Fields(s ...googleapi.Field) *UrlcrawlerrorscountsQueryCall
- func (c *UrlcrawlerrorscountsQueryCall) LatestCountsOnly(latestCountsOnly bool) *UrlcrawlerrorscountsQueryCall
- func (c *UrlcrawlerrorscountsQueryCall) Platform(platform string) *UrlcrawlerrorscountsQueryCall
- type UrlcrawlerrorscountsService
- type UrlcrawlerrorssamplesGetCall
- type UrlcrawlerrorssamplesListCall
- type UrlcrawlerrorssamplesMarkAsFixedCall
- type UrlcrawlerrorssamplesService
- func (r *UrlcrawlerrorssamplesService) Get(siteUrl string, url string, category string, platform string) *UrlcrawlerrorssamplesGetCall
- func (r *UrlcrawlerrorssamplesService) List(siteUrl string, category string, platform string) *UrlcrawlerrorssamplesListCall
- func (r *UrlcrawlerrorssamplesService) MarkAsFixed(siteUrl string, url string, category string, platform string) *UrlcrawlerrorssamplesMarkAsFixedCall
- type WmxSite
- type WmxSitemap
- type WmxSitemapContent
Constants ¶
const ( // View and modify Webmaster Tools data for your verified sites WebmastersScope = "https://www.googleapis.com/auth/webmasters" // View Webmaster Tools 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 Service ¶
type Service struct {
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Sitemaps *SitemapsService
Sites *SitesService
Urlcrawlerrorscounts *UrlcrawlerrorscountsService
Urlcrawlerrorssamples *UrlcrawlerrorssamplesService
// contains filtered or unexported fields
}
type SitemapsDeleteCall ¶
type SitemapsDeleteCall struct {
// contains filtered or unexported fields
}
func (*SitemapsDeleteCall) Do ¶
func (c *SitemapsDeleteCall) Do() error
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.
type SitemapsGetCall ¶
type SitemapsGetCall struct {
// contains filtered or unexported fields
}
func (*SitemapsGetCall) Do ¶
func (c *SitemapsGetCall) Do() (*WmxSitemap, error)
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.
type SitemapsListCall ¶
type SitemapsListCall struct {
// contains filtered or unexported fields
}
func (*SitemapsListCall) Do ¶
func (c *SitemapsListCall) Do() (*SitemapsListResponse, error)
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) SitemapIndex ¶
func (c *SitemapsListCall) SitemapIndex(sitemapIndex string) *SitemapsListCall
SitemapIndex sets the optional parameter "sitemapIndex": A URL of a site's sitemap index.
type SitemapsListResponse ¶
type SitemapsListResponse struct {
// Sitemap: Information about a sitemap entry.
Sitemap []*WmxSitemap `json:"sitemap,omitempty"`
}
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 sitemaps uploaded to the site.
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) Do ¶
func (c *SitemapsSubmitCall) Do() error
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.
type SitesAddCall ¶
type SitesAddCall struct {
// contains filtered or unexported fields
}
func (*SitesAddCall) Do ¶
func (c *SitesAddCall) Do() error
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.
type SitesDeleteCall ¶
type SitesDeleteCall struct {
// contains filtered or unexported fields
}
func (*SitesDeleteCall) Do ¶
func (c *SitesDeleteCall) Do() error
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.
type SitesGetCall ¶
type SitesGetCall struct {
// contains filtered or unexported fields
}
func (*SitesGetCall) Do ¶
func (c *SitesGetCall) Do() (*WmxSite, error)
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.
type SitesListCall ¶
type SitesListCall struct {
// contains filtered or unexported fields
}
func (*SitesListCall) Do ¶
func (c *SitesListCall) Do() (*SitesListResponse, error)
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.
type SitesListResponse ¶
type SitesListResponse struct {
// SiteEntry: Access level information for a Webmaster Tools site.
SiteEntry []*WmxSite `json:"siteEntry,omitempty"`
}
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 Webmaster Tools.
func (*SitesService) Delete ¶
func (r *SitesService) Delete(siteUrl string) *SitesDeleteCall
Delete: Removes a site from the set of the user's Webmaster Tools sites.
func (*SitesService) Get ¶
func (r *SitesService) Get(siteUrl string) *SitesGetCall
Get: Retrieves information about specific site.
func (*SitesService) List ¶
func (r *SitesService) List() *SitesListCall
List: Lists your Webmaster Tools sites.
type UrlCrawlErrorCount ¶
type UrlCrawlErrorCountsPerType ¶
type UrlCrawlErrorCountsPerType struct {
// Category: The crawl error type.
Category string `json:"category,omitempty"`
// Entries: The error count entries time series.
Entries []*UrlCrawlErrorCount `json:"entries,omitempty"`
// Platform: Corresponding to the user agent that made the request.
Platform string `json:"platform,omitempty"`
}
type UrlCrawlErrorsCountsQueryResponse ¶
type UrlCrawlErrorsCountsQueryResponse struct {
// CountPerTypes: The time series of the number of URL crawl errors for
// per error category and platform.
CountPerTypes []*UrlCrawlErrorCountsPerType `json:"countPerTypes,omitempty"`
}
type UrlCrawlErrorsSample ¶
type UrlCrawlErrorsSample struct {
// FirstDetected: The time the error was first detected, in RFC 3339
// format.
FirstDetected string `json:"first_detected,omitempty"`
// LastCrawled: The time when the URL was last crawled, in RFC 3339
// format.
LastCrawled string `json:"last_crawled,omitempty"`
// PageUrl: The URL of an error, relative to the site.
PageUrl string `json:"pageUrl,omitempty"`
// ResponseCode: The HTTP response code, if any.
ResponseCode int64 `json:"responseCode,omitempty"`
// UrlDetails: Additional details about the URL, set only when calling
// get().
UrlDetails *UrlSampleDetails `json:"urlDetails,omitempty"`
}
type UrlCrawlErrorsSamplesListResponse ¶
type UrlCrawlErrorsSamplesListResponse struct {
// UrlCrawlErrorSample: Information about the sample URL and its crawl
// error.
UrlCrawlErrorSample []*UrlCrawlErrorsSample `json:"urlCrawlErrorSample,omitempty"`
}
type UrlSampleDetails ¶
type UrlcrawlerrorscountsQueryCall ¶
type UrlcrawlerrorscountsQueryCall struct {
// contains filtered or unexported fields
}
func (*UrlcrawlerrorscountsQueryCall) Category ¶
func (c *UrlcrawlerrorscountsQueryCall) Category(category string) *UrlcrawlerrorscountsQueryCall
Category sets the optional parameter "category": The crawl error category, for example 'serverError'. If not specified, we return results for all categories.
Possible values:
"authPermissions" "manyToOneRedirect" "notFollowed" "notFound" "other" "roboted" "serverError" "soft404"
func (*UrlcrawlerrorscountsQueryCall) Do ¶
func (c *UrlcrawlerrorscountsQueryCall) Do() (*UrlCrawlErrorsCountsQueryResponse, error)
func (*UrlcrawlerrorscountsQueryCall) Fields ¶
func (c *UrlcrawlerrorscountsQueryCall) Fields(s ...googleapi.Field) *UrlcrawlerrorscountsQueryCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
func (*UrlcrawlerrorscountsQueryCall) LatestCountsOnly ¶
func (c *UrlcrawlerrorscountsQueryCall) LatestCountsOnly(latestCountsOnly bool) *UrlcrawlerrorscountsQueryCall
LatestCountsOnly sets the optional parameter "latestCountsOnly": If true, returns only the latest crawl error counts.
func (*UrlcrawlerrorscountsQueryCall) Platform ¶
func (c *UrlcrawlerrorscountsQueryCall) Platform(platform string) *UrlcrawlerrorscountsQueryCall
Platform sets the optional parameter "platform": The user agent type (platform) that made the request, for example 'web'. If not specified, we return results for all platforms.
Possible values:
"mobile" "smartphoneOnly" "web"
type UrlcrawlerrorscountsService ¶
type UrlcrawlerrorscountsService struct {
// contains filtered or unexported fields
}
func NewUrlcrawlerrorscountsService ¶
func NewUrlcrawlerrorscountsService(s *Service) *UrlcrawlerrorscountsService
func (*UrlcrawlerrorscountsService) Query ¶
func (r *UrlcrawlerrorscountsService) Query(siteUrl string) *UrlcrawlerrorscountsQueryCall
Query: Retrieves a time series of the number of URL crawl errors per error category and platform.
type UrlcrawlerrorssamplesGetCall ¶
type UrlcrawlerrorssamplesGetCall struct {
// contains filtered or unexported fields
}
func (*UrlcrawlerrorssamplesGetCall) Do ¶
func (c *UrlcrawlerrorssamplesGetCall) Do() (*UrlCrawlErrorsSample, error)
func (*UrlcrawlerrorssamplesGetCall) Fields ¶
func (c *UrlcrawlerrorssamplesGetCall) Fields(s ...googleapi.Field) *UrlcrawlerrorssamplesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type UrlcrawlerrorssamplesListCall ¶
type UrlcrawlerrorssamplesListCall struct {
// contains filtered or unexported fields
}
func (*UrlcrawlerrorssamplesListCall) Do ¶
func (c *UrlcrawlerrorssamplesListCall) Do() (*UrlCrawlErrorsSamplesListResponse, error)
func (*UrlcrawlerrorssamplesListCall) Fields ¶
func (c *UrlcrawlerrorssamplesListCall) Fields(s ...googleapi.Field) *UrlcrawlerrorssamplesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type UrlcrawlerrorssamplesMarkAsFixedCall ¶
type UrlcrawlerrorssamplesMarkAsFixedCall struct {
// contains filtered or unexported fields
}
func (*UrlcrawlerrorssamplesMarkAsFixedCall) Do ¶
func (c *UrlcrawlerrorssamplesMarkAsFixedCall) Do() error
func (*UrlcrawlerrorssamplesMarkAsFixedCall) Fields ¶
func (c *UrlcrawlerrorssamplesMarkAsFixedCall) Fields(s ...googleapi.Field) *UrlcrawlerrorssamplesMarkAsFixedCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.
type UrlcrawlerrorssamplesService ¶
type UrlcrawlerrorssamplesService struct {
// contains filtered or unexported fields
}
func NewUrlcrawlerrorssamplesService ¶
func NewUrlcrawlerrorssamplesService(s *Service) *UrlcrawlerrorssamplesService
func (*UrlcrawlerrorssamplesService) Get ¶
func (r *UrlcrawlerrorssamplesService) Get(siteUrl string, url string, category string, platform string) *UrlcrawlerrorssamplesGetCall
Get: Retrieves details about crawl errors for a site's sample URL.
func (*UrlcrawlerrorssamplesService) List ¶
func (r *UrlcrawlerrorssamplesService) List(siteUrl string, category string, platform string) *UrlcrawlerrorssamplesListCall
List: Lists a site's sample URLs for the specified crawl error category and platform.
func (*UrlcrawlerrorssamplesService) MarkAsFixed ¶
func (r *UrlcrawlerrorssamplesService) MarkAsFixed(siteUrl string, url string, category string, platform string) *UrlcrawlerrorssamplesMarkAsFixedCall
MarkAsFixed: Marks the provided site's sample URL as fixed, and removes it from the samples list.
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 - issues with the sitemap
// itself, that needs 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 "sitemap").
Type string `json:"type,omitempty"`
// Warnings: Number of warnings for the sitemap - issues with URLs in
// the sitemaps.
Warnings int64 `json:"warnings,omitempty,string"`
}
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", "images").
Type string `json:"type,omitempty"`
}