webmasters

package
v0.0.0-...-375ceb8 Latest Latest
Warning

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

 Go to latest Published: Jul 31, 2015 License: BSD-3-Clause Imports: 11 Imported by: 0

Documentation

Overview

Package webmasters provides access to the Webmaster Tools API.

See https://developers.google.com/webmaster-tools/

Usage example: 

import "google.golang.org/api/webmasters/v3"
...
webmastersService, err := webmasters.New(oauthHttpClient)

Index

Constants

View Source 
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 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"`
}

type ApiDimensionFilter 

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

	Expression string `json:"expression,omitempty"`

	Operator string `json:"operator,omitempty"`
}

type ApiDimensionFilterGroup 

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

	GroupType string `json:"groupType,omitempty"`
}

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"`

	// DimensionFilterGroups: [Optional] Zero or more filters to apply to
	// the dimension grouping values; for example, 'Country CONTAINS
	// "Guinea"' to see only data where the country contains the substring
	// "Guinea". 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 1,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"`
}

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"`
}

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.

type SearchanalyticsQueryCall 

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

func (*SearchanalyticsQueryCall) Do 

func (c *SearchanalyticsQueryCall) Do() (*SearchAnalyticsQueryResponse, error)

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.

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: [LIMITED ACCESS]

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

	Urlcrawlerrorscounts *UrlcrawlerrorscountsService

	Urlcrawlerrorssamples *UrlcrawlerrorssamplesService
	// contains filtered or unexported fields
}

func New 

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

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. 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"`
}

SitemapsListResponse: List of sitemaps.

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) 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: Contains permission level information about a Webmaster
	// Tools site. For more information, see Permissions in Webmaster Tools.
	SiteEntry []*WmxSite `json:"siteEntry,omitempty"`
}

SitesListResponse: List of sites with access level information.

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 the user's Webmaster Tools sites.

type UrlCrawlErrorCount 

type UrlCrawlErrorCount struct {
	// Count: The error count at the given timestamp.
	Count int64 `json:"count,omitempty,string"`

	// Timestamp: The date and time when the crawl attempt took place, in
	// RFC 3339 format.
	Timestamp string `json:"timestamp,omitempty"`
}

UrlCrawlErrorCount: An entry in a URL crawl errors time series.

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: The general type of Googlebot that made the request (see
	// list of Googlebot user-agents for the user-agents used).
	Platform string `json:"platform,omitempty"`
}

UrlCrawlErrorCountsPerType: Number of errors per day for a specific error type (defined by platform and category).

type UrlCrawlErrorsCountsQueryResponse 

type UrlCrawlErrorsCountsQueryResponse struct {
	// CountPerTypes: The time series of the number of URL crawl errors per
	// error category and platform.
	CountPerTypes []*UrlCrawlErrorCountsPerType `json:"countPerTypes,omitempty"`
}

UrlCrawlErrorsCountsQueryResponse: A time series of the number of URL crawl errors per error category and platform.

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"`
}

UrlCrawlErrorsSample: Contains information about specific crawl errors.

type UrlCrawlErrorsSamplesListResponse 

type UrlCrawlErrorsSamplesListResponse struct {
	// UrlCrawlErrorSample: Information about the sample URL and its crawl
	// error.
	UrlCrawlErrorSample []*UrlCrawlErrorsSample `json:"urlCrawlErrorSample,omitempty"`
}

UrlCrawlErrorsSamplesListResponse: List of crawl error samples.

type UrlSampleDetails 

type UrlSampleDetails struct {
	// ContainingSitemaps: List of sitemaps pointing at this URL.
	ContainingSitemaps []string `json:"containingSitemaps,omitempty"`

	// LinkedFromUrls: A sample set of URLs linking to this URL.
	LinkedFromUrls []string `json:"linkedFromUrls,omitempty"`
}

UrlSampleDetails: Additional details about the URL, set only when calling get().

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, returns 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, returns 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 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"`
}

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

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"`
}

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

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"`
}

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

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.