searchconsole
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Package searchconsole provides access to the Google Search Console API.
For product documentation, see:https://developers.google.com/webmaster-tools/about
Library status¶
These client libraries are officially supported by Google. However, thislibrary is considered complete and is in maintenance mode. This meansthat we will address critical bugs and security issues but will not addany new features.
When possible, we recommend using our newer[Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)that are still actively being worked and iterated on.
Creating a client¶
Usage example:
import "google.golang.org/api/searchconsole/v1"...ctx := context.Background()searchconsoleService, err := searchconsole.NewService(ctx)
In this example, Google Application Default Credentials are used forauthentication. For information on how to create and obtain ApplicationDefault Credentials, seehttps://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, usegoogle.golang.org/api/option.WithScopes:
searchconsoleService, err := searchconsole.NewService(ctx, option.WithScopes(searchconsole.WebmastersReadonlyScope))
To use an API key for authentication (note: some APIs do not support APIkeys), usegoogle.golang.org/api/option.WithAPIKey:
searchconsoleService, err := searchconsole.NewService(ctx, option.WithAPIKey("AIza..."))To use an OAuth token (e.g., a user token obtained via a three-legged OAuthflow, usegoogle.golang.org/api/option.WithTokenSource:
config := &oauth2.Config{...}// ...token, err := config.Exchange(ctx, ...)searchconsoleService, err := searchconsole.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))Seegoogle.golang.org/api/option.ClientOption for details on options.
Index¶
- Constants
- type AmpInspectionResult
- type AmpIssue
- type ApiDataRow
- type ApiDimensionFilter
- type ApiDimensionFilterGroup
- type BlockedResource
- type DetectedItems
- type Image
- type IndexStatusInspectionResult
- type InspectUrlIndexRequest
- type InspectUrlIndexResponse
- type Item
- type Metadata
- type MobileFriendlyIssue
- type MobileUsabilityInspectionResult
- type MobileUsabilityIssue
- type ResourceIssue
- type RichResultsInspectionResult
- type RichResultsIssue
- type RunMobileFriendlyTestRequest
- type RunMobileFriendlyTestResponse
- type SearchAnalyticsQueryRequest
- type SearchAnalyticsQueryResponse
- type SearchanalyticsQueryCall
- func (c *SearchanalyticsQueryCall) Context(ctx context.Context) *SearchanalyticsQueryCall
- func (c *SearchanalyticsQueryCall) Do(opts ...googleapi.CallOption) (*SearchAnalyticsQueryResponse, error)
- func (c *SearchanalyticsQueryCall) Fields(s ...googleapi.Field) *SearchanalyticsQueryCall
- func (c *SearchanalyticsQueryCall) Header() http.Header
- type SearchanalyticsService
- type Service
- type SitemapsDeleteCall
- type SitemapsGetCall
- func (c *SitemapsGetCall) Context(ctx context.Context) *SitemapsGetCall
- func (c *SitemapsGetCall) Do(opts ...googleapi.CallOption) (*WmxSitemap, error)
- func (c *SitemapsGetCall) Fields(s ...googleapi.Field) *SitemapsGetCall
- func (c *SitemapsGetCall) Header() http.Header
- func (c *SitemapsGetCall) IfNoneMatch(entityTag string) *SitemapsGetCall
- type SitemapsListCall
- func (c *SitemapsListCall) Context(ctx context.Context) *SitemapsListCall
- func (c *SitemapsListCall) Do(opts ...googleapi.CallOption) (*SitemapsListResponse, error)
- func (c *SitemapsListCall) Fields(s ...googleapi.Field) *SitemapsListCall
- func (c *SitemapsListCall) Header() http.Header
- func (c *SitemapsListCall) IfNoneMatch(entityTag string) *SitemapsListCall
- func (c *SitemapsListCall) SitemapIndex(sitemapIndex string) *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
- func (c *SitesGetCall) Context(ctx context.Context) *SitesGetCall
- func (c *SitesGetCall) Do(opts ...googleapi.CallOption) (*WmxSite, error)
- func (c *SitesGetCall) Fields(s ...googleapi.Field) *SitesGetCall
- func (c *SitesGetCall) Header() http.Header
- func (c *SitesGetCall) IfNoneMatch(entityTag string) *SitesGetCall
- type SitesListCall
- func (c *SitesListCall) Context(ctx context.Context) *SitesListCall
- func (c *SitesListCall) Do(opts ...googleapi.CallOption) (*SitesListResponse, error)
- func (c *SitesListCall) Fields(s ...googleapi.Field) *SitesListCall
- func (c *SitesListCall) Header() http.Header
- func (c *SitesListCall) IfNoneMatch(entityTag string) *SitesListCall
- type SitesListResponse
- type SitesService
- type TestStatus
- type UrlInspectionIndexInspectCall
- func (c *UrlInspectionIndexInspectCall) Context(ctx context.Context) *UrlInspectionIndexInspectCall
- func (c *UrlInspectionIndexInspectCall) Do(opts ...googleapi.CallOption) (*InspectUrlIndexResponse, error)
- func (c *UrlInspectionIndexInspectCall) Fields(s ...googleapi.Field) *UrlInspectionIndexInspectCall
- func (c *UrlInspectionIndexInspectCall) Header() http.Header
- type UrlInspectionIndexService
- type UrlInspectionResult
- type UrlInspectionService
- type UrlTestingToolsMobileFriendlyTestRunCall
- func (c *UrlTestingToolsMobileFriendlyTestRunCall) Context(ctx context.Context) *UrlTestingToolsMobileFriendlyTestRunCall
- func (c *UrlTestingToolsMobileFriendlyTestRunCall) Do(opts ...googleapi.CallOption) (*RunMobileFriendlyTestResponse, error)
- func (c *UrlTestingToolsMobileFriendlyTestRunCall) Fields(s ...googleapi.Field) *UrlTestingToolsMobileFriendlyTestRunCall
- func (c *UrlTestingToolsMobileFriendlyTestRunCall) Header() http.Header
- type UrlTestingToolsMobileFriendlyTestService
- type UrlTestingToolsService
- type WmxSite
- type WmxSitemap
- type WmxSitemapContent
Constants¶
const (// View and manage Search Console data for your verified sitesWebmastersScope = "https://www.googleapis.com/auth/webmasters"// View Search Console data for your verified sitesWebmastersReadonlyScope = "https://www.googleapis.com/auth/webmasters.readonly")
OAuth2 scopes used by this API.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeAmpInspectionResult¶added inv0.67.0
type AmpInspectionResult struct {// AmpIndexStatusVerdict: Index status of the AMP URL.//// Possible values:// "VERDICT_UNSPECIFIED" - Unknown verdict.// "PASS" - Equivalent to "Valid" for the page or item in Search Console.// "PARTIAL" - Reserved, no longer in use.// "FAIL" - Equivalent to "Error" or "Invalid" for the page or item in Search// Console.// "NEUTRAL" - Equivalent to "Excluded" for the page or item in Search// Console.AmpIndexStatusVerdictstring `json:"ampIndexStatusVerdict,omitempty"`// AmpUrl: URL of the AMP that was inspected. If the submitted URL is a desktop// page that refers to an AMP version, the AMP version will be inspected.AmpUrlstring `json:"ampUrl,omitempty"`// IndexingState: Whether or not the page blocks indexing through a noindex// rule.//// Possible values:// "AMP_INDEXING_STATE_UNSPECIFIED" - Unknown indexing status.// "AMP_INDEXING_ALLOWED" - Indexing allowed.// "BLOCKED_DUE_TO_NOINDEX" - Indexing not allowed, 'noindex' detected.// "BLOCKED_DUE_TO_EXPIRED_UNAVAILABLE_AFTER" - Indexing not allowed,// 'unavailable_after' date expired.IndexingStatestring `json:"indexingState,omitempty"`// Issues: A list of zero or more AMP issues found for the inspected URL.Issues []*AmpIssue `json:"issues,omitempty"`// LastCrawlTime: Last time this AMP version was crawled by Google. Absent if// the URL was never crawled successfully.LastCrawlTimestring `json:"lastCrawlTime,omitempty"`// PageFetchState: Whether or not Google could fetch the AMP.//// Possible values:// "PAGE_FETCH_STATE_UNSPECIFIED" - Unknown fetch state.// "SUCCESSFUL" - Successful fetch.// "SOFT_404" - Soft 404.// "BLOCKED_ROBOTS_TXT" - Blocked by robots.txt.// "NOT_FOUND" - Not found (404).// "ACCESS_DENIED" - Blocked due to unauthorized request (401).// "SERVER_ERROR" - Server error (5xx).// "REDIRECT_ERROR" - Redirection error.// "ACCESS_FORBIDDEN" - Blocked due to access forbidden (403).// "BLOCKED_4XX" - Blocked due to other 4xx issue (not 403, 404).// "INTERNAL_CRAWL_ERROR" - Internal error.// "INVALID_URL" - Invalid URL.PageFetchStatestring `json:"pageFetchState,omitempty"`// RobotsTxtState: Whether or not the page is blocked to Google by a robots.txt// rule.//// Possible values:// "ROBOTS_TXT_STATE_UNSPECIFIED" - Unknown robots.txt state, typically// because the page wasn't fetched or found, or because robots.txt itself// couldn't be reached.// "ALLOWED" - Crawl allowed by robots.txt.// "DISALLOWED" - Crawl blocked by robots.txt.RobotsTxtStatestring `json:"robotsTxtState,omitempty"`// Verdict: The status of the most severe error on the page. If a page has both// warnings and errors, the page status is error. Error status means the page// cannot be shown in Search results.//// Possible values:// "VERDICT_UNSPECIFIED" - Unknown verdict.// "PASS" - Equivalent to "Valid" for the page or item in Search Console.// "PARTIAL" - Reserved, no longer in use.// "FAIL" - Equivalent to "Error" or "Invalid" for the page or item in Search// Console.// "NEUTRAL" - Equivalent to "Excluded" for the page or item in Search// Console.Verdictstring `json:"verdict,omitempty"`// ForceSendFields is a list of field names (e.g. "AmpIndexStatusVerdict") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AmpIndexStatusVerdict") to// include in API requests with the JSON null value. By default, fields with// empty values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}AmpInspectionResult: AMP inspection result of the live page or the currentinformation from Google's index, depending on whether you requested a liveinspection or not.
func (AmpInspectionResult)MarshalJSON¶added inv0.67.0
func (sAmpInspectionResult) MarshalJSON() ([]byte,error)
typeAmpIssue¶added inv0.67.0
type AmpIssue struct {// IssueMessage: Brief description of this issue.IssueMessagestring `json:"issueMessage,omitempty"`// Severity: Severity of this issue: WARNING or ERROR.//// Possible values:// "SEVERITY_UNSPECIFIED" - Unknown severity.// "WARNING" - Warning.// "ERROR" - Error.Severitystring `json:"severity,omitempty"`// ForceSendFields is a list of field names (e.g. "IssueMessage") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "IssueMessage") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}AmpIssue: AMP issue.
func (AmpIssue)MarshalJSON¶added inv0.67.0
typeApiDataRow¶added inv0.33.0
type ApiDataRow struct {Clicksfloat64 `json:"clicks,omitempty"`Ctrfloat64 `json:"ctr,omitempty"`Impressionsfloat64 `json:"impressions,omitempty"`Keys []string `json:"keys,omitempty"`Positionfloat64 `json:"position,omitempty"`// ForceSendFields is a list of field names (e.g. "Clicks") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}func (ApiDataRow)MarshalJSON¶added inv0.33.0
func (sApiDataRow) MarshalJSON() ([]byte,error)
func (*ApiDataRow)UnmarshalJSON¶added inv0.33.0
func (s *ApiDataRow) UnmarshalJSON(data []byte)error
typeApiDimensionFilter¶added inv0.33.0
type ApiDimensionFilter struct {// Possible values:// "QUERY"// "PAGE"// "COUNTRY"// "DEVICE"// "SEARCH_APPEARANCE"Dimensionstring `json:"dimension,omitempty"`Expressionstring `json:"expression,omitempty"`// Possible values:// "EQUALS"// "NOT_EQUALS"// "CONTAINS"// "NOT_CONTAINS"// "INCLUDING_REGEX"// "EXCLUDING_REGEX"Operatorstring `json:"operator,omitempty"`// ForceSendFields is a list of field names (e.g. "Dimension") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ApiDimensionFilter: A filter test to be applied to each row in the data set,where a match can return the row. Filters are string comparisons, and valuesand dimension names are not case-sensitive. Individual filters are eitherAND'ed or OR'ed within their parent filter group, according to the group'sgroup type. You do not need to group by a specified dimension to filteragainst it.
func (ApiDimensionFilter)MarshalJSON¶added inv0.33.0
func (sApiDimensionFilter) MarshalJSON() ([]byte,error)
typeApiDimensionFilterGroup¶added inv0.33.0
type ApiDimensionFilterGroup struct {Filters []*ApiDimensionFilter `json:"filters,omitempty"`// Possible values:// "AND"GroupTypestring `json:"groupType,omitempty"`// ForceSendFields is a list of field names (e.g. "Filters") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ApiDimensionFilterGroup: A set of dimension value filters to test againsteach row. Only rows that pass all filter groups will be returned. Allresults within a filter group are either AND'ed or OR'ed together, dependingon the group type selected. All filter groups are AND'ed together.
func (ApiDimensionFilterGroup)MarshalJSON¶added inv0.33.0
func (sApiDimensionFilterGroup) MarshalJSON() ([]byte,error)
typeBlockedResource¶
type BlockedResource struct {// Url: URL of the blocked resource.Urlstring `json:"url,omitempty"`// ForceSendFields is a list of field names (e.g. "Url") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Url") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}BlockedResource: Blocked resource.
func (BlockedResource)MarshalJSON¶
func (sBlockedResource) MarshalJSON() ([]byte,error)
typeDetectedItems¶added inv0.67.0
type DetectedItems struct {// Items: List of Rich Results items.Items []*Item `json:"items,omitempty"`// RichResultType: Rich Results typeRichResultTypestring `json:"richResultType,omitempty"`// ForceSendFields is a list of field names (e.g. "Items") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Items") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}DetectedItems: Rich Results items grouped by type.
func (DetectedItems)MarshalJSON¶added inv0.67.0
func (sDetectedItems) MarshalJSON() ([]byte,error)
typeImage¶
type Image struct {// Data: Image data in format determined by the mime type. Currently, the// format will always be "image/png", but this might change in the future.Datastring `json:"data,omitempty"`// MimeType: The mime-type of the image data.MimeTypestring `json:"mimeType,omitempty"`// ForceSendFields is a list of field names (e.g. "Data") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Data") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Image: Describe image data.
func (Image)MarshalJSON¶
typeIndexStatusInspectionResult¶added inv0.67.0
type IndexStatusInspectionResult struct {// CoverageState: Could Google find and index the page. More details about page// indexing appear in 'indexing_state'.CoverageStatestring `json:"coverageState,omitempty"`// CrawledAs: Primary crawler that was used by Google to crawl your site.//// Possible values:// "CRAWLING_USER_AGENT_UNSPECIFIED" - Unknown user agent.// "DESKTOP" - Desktop user agent.// "MOBILE" - Mobile user agent.CrawledAsstring `json:"crawledAs,omitempty"`// GoogleCanonical: The URL of the page that Google selected as canonical. If// the page was not indexed, this field is absent.GoogleCanonicalstring `json:"googleCanonical,omitempty"`// IndexingState: Whether or not the page blocks indexing through a noindex// rule.//// Possible values:// "INDEXING_STATE_UNSPECIFIED" - Unknown indexing status.// "INDEXING_ALLOWED" - Indexing allowed.// "BLOCKED_BY_META_TAG" - Indexing not allowed, 'noindex' detected in// 'robots' meta tag.// "BLOCKED_BY_HTTP_HEADER" - Indexing not allowed, 'noindex' detected in// 'X-Robots-Tag' http header.// "BLOCKED_BY_ROBOTS_TXT" - Reserved, no longer in use.IndexingStatestring `json:"indexingState,omitempty"`// LastCrawlTime: Last time this URL was crawled by Google using the primary// crawler// (https://support.google.com/webmasters/answer/7440203#primary_crawler).// Absent if the URL was never crawled successfully.LastCrawlTimestring `json:"lastCrawlTime,omitempty"`// PageFetchState: Whether or not Google could retrieve the page from your// server. Equivalent to "page fetch"// (https://support.google.com/webmasters/answer/9012289#index_coverage) in the// URL inspection report.//// Possible values:// "PAGE_FETCH_STATE_UNSPECIFIED" - Unknown fetch state.// "SUCCESSFUL" - Successful fetch.// "SOFT_404" - Soft 404.// "BLOCKED_ROBOTS_TXT" - Blocked by robots.txt.// "NOT_FOUND" - Not found (404).// "ACCESS_DENIED" - Blocked due to unauthorized request (401).// "SERVER_ERROR" - Server error (5xx).// "REDIRECT_ERROR" - Redirection error.// "ACCESS_FORBIDDEN" - Blocked due to access forbidden (403).// "BLOCKED_4XX" - Blocked due to other 4xx issue (not 403, 404).// "INTERNAL_CRAWL_ERROR" - Internal error.// "INVALID_URL" - Invalid URL.PageFetchStatestring `json:"pageFetchState,omitempty"`// ReferringUrls: URLs that link to the inspected URL, directly and indirectly.ReferringUrls []string `json:"referringUrls,omitempty"`// RobotsTxtState: Whether or not the page is blocked to Google by a robots.txt// rule.//// Possible values:// "ROBOTS_TXT_STATE_UNSPECIFIED" - Unknown robots.txt state, typically// because the page wasn't fetched or found, or because robots.txt itself// couldn't be reached.// "ALLOWED" - Crawl allowed by robots.txt.// "DISALLOWED" - Crawl blocked by robots.txt.RobotsTxtStatestring `json:"robotsTxtState,omitempty"`// Sitemap: Any sitemaps that this URL was listed in, as known by Google. Not// guaranteed to be an exhaustive list, especially if Google did not discover// this URL through a sitemap. Absent if no sitemaps were found.Sitemap []string `json:"sitemap,omitempty"`// UserCanonical: The URL that your page or site declares as canonical// (https://developers.google.com/search/docs/advanced/crawling/consolidate-duplicate-urls?#define-canonical).// If you did not declare a canonical URL, this field is absent.UserCanonicalstring `json:"userCanonical,omitempty"`// Verdict: High level verdict about whether the URL *is* indexed (indexed// status), or *can be* indexed (live inspection).//// Possible values:// "VERDICT_UNSPECIFIED" - Unknown verdict.// "PASS" - Equivalent to "Valid" for the page or item in Search Console.// "PARTIAL" - Reserved, no longer in use.// "FAIL" - Equivalent to "Error" or "Invalid" for the page or item in Search// Console.// "NEUTRAL" - Equivalent to "Excluded" for the page or item in Search// Console.Verdictstring `json:"verdict,omitempty"`// ForceSendFields is a list of field names (e.g. "CoverageState") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "CoverageState") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}IndexStatusInspectionResult: Results of index status inspection for eitherthe live page or the version in Google's index, depending on whether yourequested a live inspection or not. For more information, see the Indexcoverage report documentation(https://support.google.com/webmasters/answer/7440203).
func (IndexStatusInspectionResult)MarshalJSON¶added inv0.67.0
func (sIndexStatusInspectionResult) MarshalJSON() ([]byte,error)
typeInspectUrlIndexRequest¶added inv0.67.0
type InspectUrlIndexRequest struct {// InspectionUrl: Required. URL to inspect. Must be under the property// specified in "site_url".InspectionUrlstring `json:"inspectionUrl,omitempty"`// LanguageCode: Optional. An IETF BCP-47// (https://en.wikipedia.org/wiki/IETF_language_tag) language code representing// the requested language for translated issue messages, e.g. "en-US", "or// "de-CH". Default value is "en-US".LanguageCodestring `json:"languageCode,omitempty"`// SiteUrl: Required. The URL of the property as defined in Search Console.// **Examples:** `http://www.example.com/` for a URL-prefix property, or// `sc-domain:example.com` for a Domain property.SiteUrlstring `json:"siteUrl,omitempty"`// ForceSendFields is a list of field names (e.g. "InspectionUrl") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "InspectionUrl") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}InspectUrlIndexRequest: Index inspection request.
func (InspectUrlIndexRequest)MarshalJSON¶added inv0.67.0
func (sInspectUrlIndexRequest) MarshalJSON() ([]byte,error)
typeInspectUrlIndexResponse¶added inv0.67.0
type InspectUrlIndexResponse struct {// InspectionResult: URL inspection results.InspectionResult *UrlInspectionResult `json:"inspectionResult,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "InspectionResult") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "InspectionResult") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}InspectUrlIndexResponse: Index-Status inspection response.
func (InspectUrlIndexResponse)MarshalJSON¶added inv0.67.0
func (sInspectUrlIndexResponse) MarshalJSON() ([]byte,error)
typeItem¶added inv0.67.0
type Item struct {// Issues: A list of zero or more rich result issues found for this instance.Issues []*RichResultsIssue `json:"issues,omitempty"`// Name: The user-provided name of this item.Namestring `json:"name,omitempty"`// ForceSendFields is a list of field names (e.g. "Issues") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Issues") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Item: A specific rich result found on the page.
func (Item)MarshalJSON¶added inv0.67.0
typeMetadata¶added inv0.242.0
type Metadata struct {// FirstIncompleteDate: The first date for which the data is still being// collected and processed, presented in `YYYY-MM-DD` format (ISO-8601 extended// local date format). This field is populated only when the request's// `dataState` is "all", data is grouped by "DATE", and the requested date// range contains incomplete data points. All values after the// `first_incomplete_date` may still change noticeably.FirstIncompleteDatestring `json:"firstIncompleteDate,omitempty"`// FirstIncompleteHour: The first hour for which the data is still being// collected and processed, presented in `YYYY-MM-DDThh:mm:ss[+|-]hh:mm` format// (ISO-8601 extended offset date-time format). This field is populated only// when the request's `dataState` is "hourly_all", data is grouped by// "HOUR" and the requested date range contains incomplete data points. All// values after the `first_incomplete_hour` may still change noticeably.FirstIncompleteHourstring `json:"firstIncompleteHour,omitempty"`// ForceSendFields is a list of field names (e.g. "FirstIncompleteDate") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "FirstIncompleteDate") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}Metadata: An object that may be returned with your query results, providingcontext about the state of the data. When you request recent data (using`all` or `hourly_all` for `dataState`), some of the rows returned mayrepresent data that is incomplete, which means that the data is still beingcollected and processed. This metadata object helps you identify exactlywhen this starts and ends. All dates and times provided in this object arein the `America/Los_Angeles` time zone. The specific field returned withinthis object depends on how you've grouped your data in the request. Seedetails in inner fields.
func (Metadata)MarshalJSON¶added inv0.242.0
typeMobileFriendlyIssue¶
type MobileFriendlyIssue struct {// Rule: Rule violated.//// Possible values:// "MOBILE_FRIENDLY_RULE_UNSPECIFIED" - Unknown rule. Sorry, we don't have// any description for the rule that was broken.// "USES_INCOMPATIBLE_PLUGINS" - Plugins incompatible with mobile devices are// being used. [Learn more]// (https://support.google.com/webmasters/answer/6352293#flash_usage).// "CONFIGURE_VIEWPORT" - Viewport is not specified using the meta viewport// tag. [Learn more]// (https://support.google.com/webmasters/answer/6352293#viewport_not_configured).// "FIXED_WIDTH_VIEWPORT" - Viewport defined to a fixed width. [Learn more]// (https://support.google.com/webmasters/answer/6352293#fixed-width_viewport).// "SIZE_CONTENT_TO_VIEWPORT" - Content not sized to viewport. [Learn more]// (https://support.google.com/webmasters/answer/6352293#content_not_sized_to_viewport).// "USE_LEGIBLE_FONT_SIZES" - Font size is too small for easy reading on a// small screen. [Learn More]// (https://support.google.com/webmasters/answer/6352293#small_font_size).// "TAP_TARGETS_TOO_CLOSE" - Touch elements are too close to each other.// [Learn more]// (https://support.google.com/webmasters/answer/6352293#touch_elements_too_close).Rulestring `json:"rule,omitempty"`// ForceSendFields is a list of field names (e.g. "Rule") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Rule") to include in API requests// with the JSON null value. By default, fields with empty values are omitted// from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MobileFriendlyIssue: Mobile-friendly issue.
func (MobileFriendlyIssue)MarshalJSON¶
func (sMobileFriendlyIssue) MarshalJSON() ([]byte,error)
typeMobileUsabilityInspectionResult¶added inv0.67.0
type MobileUsabilityInspectionResult struct {// Issues: A list of zero or more mobile-usability issues detected for this// URL.Issues []*MobileUsabilityIssue `json:"issues,omitempty"`// Verdict: High-level mobile-usability inspection result for this URL.//// Possible values:// "VERDICT_UNSPECIFIED" - Unknown verdict.// "PASS" - Equivalent to "Valid" for the page or item in Search Console.// "PARTIAL" - Reserved, no longer in use.// "FAIL" - Equivalent to "Error" or "Invalid" for the page or item in Search// Console.// "NEUTRAL" - Equivalent to "Excluded" for the page or item in Search// Console.Verdictstring `json:"verdict,omitempty"`// ForceSendFields is a list of field names (e.g. "Issues") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Issues") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MobileUsabilityInspectionResult: Mobile-usability inspection results.
func (MobileUsabilityInspectionResult)MarshalJSON¶added inv0.67.0
func (sMobileUsabilityInspectionResult) MarshalJSON() ([]byte,error)
typeMobileUsabilityIssue¶added inv0.67.0
type MobileUsabilityIssue struct {// IssueType: Mobile-usability issue type.//// Possible values:// "MOBILE_USABILITY_ISSUE_TYPE_UNSPECIFIED" - Unknown issue. Sorry, we don't// have any description for the rule that was broken.// "USES_INCOMPATIBLE_PLUGINS" - Plugins incompatible with mobile devices are// being used. [Learn more]// (https://support.google.com/webmasters/answer/6352293#flash_usage#error-list).// "CONFIGURE_VIEWPORT" - Viewport is not specified using the meta viewport// tag. [Learn more]// (https://support.google.com/webmasters/answer/6352293#viewport_not_configured#error-list).// "FIXED_WIDTH_VIEWPORT" - Viewport defined to a fixed width. [Learn more]// (https://support.google.com/webmasters/answer/6352293#fixed-width_viewport#error-list).// "SIZE_CONTENT_TO_VIEWPORT" - Content not sized to viewport. [Learn more]// (https://support.google.com/webmasters/answer/6352293#content_not_sized_to_viewport#error-list).// "USE_LEGIBLE_FONT_SIZES" - Font size is too small for easy reading on a// small screen. [Learn More]// (https://support.google.com/webmasters/answer/6352293#small_font_size#error-list).// "TAP_TARGETS_TOO_CLOSE" - Touch elements are too close to each other.// [Learn more]// (https://support.google.com/webmasters/answer/6352293#touch_elements_too_close#error-list).IssueTypestring `json:"issueType,omitempty"`// Message: Additional information regarding the issue.Messagestring `json:"message,omitempty"`// Severity: Not returned; reserved for future use.//// Possible values:// "SEVERITY_UNSPECIFIED" - Unknown severity.// "WARNING" - Warning.// "ERROR" - Error.Severitystring `json:"severity,omitempty"`// ForceSendFields is a list of field names (e.g. "IssueType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "IssueType") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}MobileUsabilityIssue: Mobile-usability issue.
func (MobileUsabilityIssue)MarshalJSON¶added inv0.67.0
func (sMobileUsabilityIssue) MarshalJSON() ([]byte,error)
typeResourceIssue¶
type ResourceIssue struct {// BlockedResource: Describes a blocked resource issue.BlockedResource *BlockedResource `json:"blockedResource,omitempty"`// ForceSendFields is a list of field names (e.g. "BlockedResource") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "BlockedResource") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}ResourceIssue: Information about a resource with issue.
func (ResourceIssue)MarshalJSON¶
func (sResourceIssue) MarshalJSON() ([]byte,error)
typeRichResultsInspectionResult¶added inv0.67.0
type RichResultsInspectionResult struct {// DetectedItems: A list of zero or more rich results detected on this page.// Rich results that cannot even be parsed due to syntactic issues will not be// listed here.DetectedItems []*DetectedItems `json:"detectedItems,omitempty"`// Verdict: High-level rich results inspection result for this URL.//// Possible values:// "VERDICT_UNSPECIFIED" - Unknown verdict.// "PASS" - Equivalent to "Valid" for the page or item in Search Console.// "PARTIAL" - Reserved, no longer in use.// "FAIL" - Equivalent to "Error" or "Invalid" for the page or item in Search// Console.// "NEUTRAL" - Equivalent to "Excluded" for the page or item in Search// Console.Verdictstring `json:"verdict,omitempty"`// ForceSendFields is a list of field names (e.g. "DetectedItems") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "DetectedItems") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}RichResultsInspectionResult: Rich-Results inspection result, including anyrich results found at this URL.
func (RichResultsInspectionResult)MarshalJSON¶added inv0.67.0
func (sRichResultsInspectionResult) MarshalJSON() ([]byte,error)
typeRichResultsIssue¶added inv0.67.0
type RichResultsIssue struct {// IssueMessage: Rich Results issue type.IssueMessagestring `json:"issueMessage,omitempty"`// Severity: Severity of this issue: WARNING, or ERROR. Items with an issue of// status ERROR cannot appear with rich result features in Google Search// results.//// Possible values:// "SEVERITY_UNSPECIFIED" - Unknown severity.// "WARNING" - Warning.// "ERROR" - Error.Severitystring `json:"severity,omitempty"`// ForceSendFields is a list of field names (e.g. "IssueMessage") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "IssueMessage") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}RichResultsIssue: Severity and status of a single issue affecting a singlerich result instance on a page.
func (RichResultsIssue)MarshalJSON¶added inv0.67.0
func (sRichResultsIssue) MarshalJSON() ([]byte,error)
typeRunMobileFriendlyTestRequest¶
type RunMobileFriendlyTestRequest struct {// RequestScreenshot: Whether or not screenshot is requested. Default is false.RequestScreenshotbool `json:"requestScreenshot,omitempty"`// Url: URL for inspection.Urlstring `json:"url,omitempty"`// ForceSendFields is a list of field names (e.g. "RequestScreenshot") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "RequestScreenshot") to include in// API requests with the JSON null value. By default, fields with empty values// are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}RunMobileFriendlyTestRequest: Mobile-friendly test request.
func (RunMobileFriendlyTestRequest)MarshalJSON¶
func (sRunMobileFriendlyTestRequest) MarshalJSON() ([]byte,error)
typeRunMobileFriendlyTestResponse¶
type RunMobileFriendlyTestResponse struct {// MobileFriendliness: Test verdict, whether the page is mobile friendly or// not.//// Possible values:// "MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED" - Internal error when running// this test. Please try running the test again.// "MOBILE_FRIENDLY" - The page is mobile friendly.// "NOT_MOBILE_FRIENDLY" - The page is not mobile friendly.MobileFriendlinessstring `json:"mobileFriendliness,omitempty"`// MobileFriendlyIssues: List of mobile-usability issues.MobileFriendlyIssues []*MobileFriendlyIssue `json:"mobileFriendlyIssues,omitempty"`// ResourceIssues: Information about embedded resources issues.ResourceIssues []*ResourceIssue `json:"resourceIssues,omitempty"`// Screenshot: Screenshot of the requested URL.Screenshot *Image `json:"screenshot,omitempty"`// TestStatus: Final state of the test, can be either complete or an error.TestStatus *TestStatus `json:"testStatus,omitempty"`// ServerResponse contains the HTTP response code and headers from the server.googleapi.ServerResponse `json:"-"`// ForceSendFields is a list of field names (e.g. "MobileFriendliness") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "MobileFriendliness") to include// in API requests with the JSON null value. By default, fields with empty// values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}RunMobileFriendlyTestResponse: Mobile-friendly test response, includingmobile-friendly issues and resource issues.
func (RunMobileFriendlyTestResponse)MarshalJSON¶
func (sRunMobileFriendlyTestResponse) MarshalJSON() ([]byte,error)
typeSearchAnalyticsQueryRequest¶added inv0.33.0
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.//// Possible values:// "AUTO"// "BY_PROPERTY"// "BY_PAGE"// "BY_NEWS_SHOWCASE_PANEL"AggregationTypestring `json:"aggregationType,omitempty"`// DataState: The data state to be fetched, can be full or all, the latter// including full and partial data.//// Possible values:// "DATA_STATE_UNSPECIFIED" - Default value, should not be used.// "FINAL" - Include full final data only, without partial.// "ALL" - Include all data, full and partial.// "HOURLY_ALL" - Include hourly data, full and partial. Required when// grouping by HOUR.DataStatestring `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.//// Possible values:// "DATE" - Group by date, which is returned in YYYY-MM-DD format, in PT time// (UTC - 7:00/8:00).// "QUERY" - Group by query string.// "PAGE" - Group by page, a URI string.// "COUNTRY" - Group by country, specified by 3-letter country code ([ISO// 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)).// "DEVICE" - Group by device type (DESKTOP, MOBILE and TABLET).// "SEARCH_APPEARANCE" - Group by search result feature.// "HOUR" - Group by hour, which is returned in YYYY-MM-DDThh:mm:ss[+|-]hh:mm// format (ISO-8601 extended offset date-time format) in PT time (UTC -// 7:00/8:00). Data is available up to 10 days. Requires setting the dataState// to HOURLY_ALL.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.EndDatestring `json:"endDate,omitempty"`// RowLimit: [Optional; Default is 1000] The maximum number of rows to return.// Must be a number from 1 to 25,000 (inclusive).RowLimitint64 `json:"rowLimit,omitempty"`// SearchType: [Optional; Default is \"web\"] The search type to filter for.//// Possible values:// "WEB"// "IMAGE"// "VIDEO"// "NEWS" - News tab in search.// "DISCOVER" - Discover.// "GOOGLE_NEWS" - Google News (news.google.com or mobile app).SearchTypestring `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.StartDatestring `json:"startDate,omitempty"`// StartRow: [Optional; Default is 0] Zero-based index of the first row in the// response. Must be a non-negative number.StartRowint64 `json:"startRow,omitempty"`// Type: Optional. [Optional; Default is \"web\"] Type of report: search type,// or either Discover or Gnews.//// Possible values:// "WEB"// "IMAGE"// "VIDEO"// "NEWS" - News tab in search.// "DISCOVER" - Discover.// "GOOGLE_NEWS" - Google News (news.google.com or mobile app).Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "AggregationType") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}func (SearchAnalyticsQueryRequest)MarshalJSON¶added inv0.33.0
func (sSearchAnalyticsQueryRequest) MarshalJSON() ([]byte,error)
typeSearchAnalyticsQueryResponse¶added inv0.33.0
type SearchAnalyticsQueryResponse struct {// Metadata: An object that may be returned with your query results, providing// context about the state of the data. See details in Metadata object// documentation.Metadata *Metadata `json:"metadata,omitempty"`// ResponseAggregationType: How the results were aggregated.//// Possible values:// "AUTO"// "BY_PROPERTY"// "BY_PAGE"// "BY_NEWS_SHOWCASE_PANEL"ResponseAggregationTypestring `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. "Metadata") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Metadata") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SearchAnalyticsQueryResponse: A list of rows, one per result, grouped bykey. Metrics in each row are aggregated for all data grouped by that keyeither by page or property, as specified by the aggregation type parameter.
func (SearchAnalyticsQueryResponse)MarshalJSON¶added inv0.33.0
func (sSearchAnalyticsQueryResponse) MarshalJSON() ([]byte,error)
typeSearchanalyticsQueryCall¶added inv0.33.0
type SearchanalyticsQueryCall struct {// contains filtered or unexported fields}func (*SearchanalyticsQueryCall)Context¶added inv0.33.0
func (c *SearchanalyticsQueryCall) Context(ctxcontext.Context) *SearchanalyticsQueryCall
Context sets the context to be used in this call's Do method.
func (*SearchanalyticsQueryCall)Do¶added inv0.33.0
func (c *SearchanalyticsQueryCall) Do(opts ...googleapi.CallOption) (*SearchAnalyticsQueryResponse,error)
Do executes the "webmasters.searchanalytics.query" call.Any non-2xx status code is an error. Response headers are in either*SearchAnalyticsQueryResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*SearchanalyticsQueryCall)Fields¶added inv0.33.0
func (c *SearchanalyticsQueryCall) Fields(s ...googleapi.Field) *SearchanalyticsQueryCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SearchanalyticsQueryCall)Header¶added inv0.33.0
func (c *SearchanalyticsQueryCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeSearchanalyticsService¶added inv0.33.0
type SearchanalyticsService struct {// contains filtered or unexported fields}funcNewSearchanalyticsService¶added inv0.33.0
func NewSearchanalyticsService(s *Service) *SearchanalyticsService
func (*SearchanalyticsService)Query¶added inv0.33.0
func (r *SearchanalyticsService) Query(siteUrlstring, searchanalyticsqueryrequest *SearchAnalyticsQueryRequest) *SearchanalyticsQueryCall
Query: Query your data with filters and parameters that you define. Returnszero or more rows grouped by the row keys that you define. You must define adate range of one or more days. When date is one of the group by values, anydays without data are omitted from the result list. If you need to knowwhich days have data, issue a broad date range query grouped by date for anymetric, and see which day rows are returned.
- siteUrl: The site's URL, including protocol. For example:`http://www.example.com/`.
typeService¶
type Service struct {BasePathstring// API endpoint base URLUserAgentstring// optional additional User-Agent fragmentSearchanalytics *SearchanalyticsServiceSitemaps *SitemapsServiceSites *SitesServiceUrlInspection *UrlInspectionServiceUrlTestingTools *UrlTestingToolsService// contains filtered or unexported fields} funcNewdeprecated
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.
funcNewService¶added inv0.3.0
NewService creates a new Service.
typeSitemapsDeleteCall¶added inv0.33.0
type SitemapsDeleteCall struct {// contains filtered or unexported fields}func (*SitemapsDeleteCall)Context¶added inv0.33.0
func (c *SitemapsDeleteCall) Context(ctxcontext.Context) *SitemapsDeleteCall
Context sets the context to be used in this call's Do method.
func (*SitemapsDeleteCall)Do¶added inv0.33.0
func (c *SitemapsDeleteCall) Do(opts ...googleapi.CallOption)error
Do executes the "webmasters.sitemaps.delete" call.
func (*SitemapsDeleteCall)Fields¶added inv0.33.0
func (c *SitemapsDeleteCall) Fields(s ...googleapi.Field) *SitemapsDeleteCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SitemapsDeleteCall)Header¶added inv0.33.0
func (c *SitemapsDeleteCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeSitemapsGetCall¶added inv0.33.0
type SitemapsGetCall struct {// contains filtered or unexported fields}func (*SitemapsGetCall)Context¶added inv0.33.0
func (c *SitemapsGetCall) Context(ctxcontext.Context) *SitemapsGetCall
Context sets the context to be used in this call's Do method.
func (*SitemapsGetCall)Do¶added inv0.33.0
func (c *SitemapsGetCall) Do(opts ...googleapi.CallOption) (*WmxSitemap,error)
Do executes the "webmasters.sitemaps.get" call.Any non-2xx status code is an error. Response headers are in either*WmxSitemap.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SitemapsGetCall)Fields¶added inv0.33.0
func (c *SitemapsGetCall) Fields(s ...googleapi.Field) *SitemapsGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SitemapsGetCall)Header¶added inv0.33.0
func (c *SitemapsGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SitemapsGetCall)IfNoneMatch¶added inv0.33.0
func (c *SitemapsGetCall) IfNoneMatch(entityTagstring) *SitemapsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeSitemapsListCall¶added inv0.33.0
type SitemapsListCall struct {// contains filtered or unexported fields}func (*SitemapsListCall)Context¶added inv0.33.0
func (c *SitemapsListCall) Context(ctxcontext.Context) *SitemapsListCall
Context sets the context to be used in this call's Do method.
func (*SitemapsListCall)Do¶added inv0.33.0
func (c *SitemapsListCall) Do(opts ...googleapi.CallOption) (*SitemapsListResponse,error)
Do executes the "webmasters.sitemaps.list" call.Any non-2xx status code is an error. Response headers are in either*SitemapsListResponse.ServerResponse.Header or (if a response was returnedat all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*SitemapsListCall)Fields¶added inv0.33.0
func (c *SitemapsListCall) Fields(s ...googleapi.Field) *SitemapsListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SitemapsListCall)Header¶added inv0.33.0
func (c *SitemapsListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SitemapsListCall)IfNoneMatch¶added inv0.33.0
func (c *SitemapsListCall) IfNoneMatch(entityTagstring) *SitemapsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
func (*SitemapsListCall)SitemapIndex¶added inv0.33.0
func (c *SitemapsListCall) SitemapIndex(sitemapIndexstring) *SitemapsListCall
SitemapIndex sets the optional parameter "sitemapIndex": A URL of a site'ssitemap index. For example: `http://www.example.com/sitemapindex.xml`.
typeSitemapsListResponse¶added inv0.33.0
type SitemapsListResponse struct {// Sitemap: Contains detailed information about a specific URL submitted as a// sitemap (https://support.google.com/webmasters/answer/156184).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 or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SitemapsListResponse: List of sitemaps.
func (SitemapsListResponse)MarshalJSON¶added inv0.33.0
func (sSitemapsListResponse) MarshalJSON() ([]byte,error)
typeSitemapsService¶added inv0.33.0
type SitemapsService struct {// contains filtered or unexported fields}funcNewSitemapsService¶added inv0.33.0
func NewSitemapsService(s *Service) *SitemapsService
func (*SitemapsService)Delete¶added inv0.33.0
func (r *SitemapsService) Delete(siteUrlstring, feedpathstring) *SitemapsDeleteCall
Delete: Deletes a sitemap from the Sitemaps report. Does not stop Googlefrom crawling this sitemap or the URLs that were previously crawled in thedeleted sitemap.
- feedpath: The URL of the actual sitemap. For example:`http://www.example.com/sitemap.xml`.
- siteUrl: The site's URL, including protocol. For example:`http://www.example.com/`.
func (*SitemapsService)Get¶added inv0.33.0
func (r *SitemapsService) Get(siteUrlstring, feedpathstring) *SitemapsGetCall
Get: Retrieves information about a specific sitemap.
- feedpath: The URL of the actual sitemap. For example:`http://www.example.com/sitemap.xml`.
- siteUrl: The site's URL, including protocol. For example:`http://www.example.com/`.
func (*SitemapsService)List¶added inv0.33.0
func (r *SitemapsService) List(siteUrlstring) *SitemapsListCall
List: Lists the sitemaps-entries (/webmaster-tools/v3/sitemaps) submittedfor this site, or included in the sitemap index file (if `sitemapIndex` isspecified in the request).
- siteUrl: The site's URL, including protocol. For example:`http://www.example.com/`.
func (*SitemapsService)Submit¶added inv0.33.0
func (r *SitemapsService) Submit(siteUrlstring, feedpathstring) *SitemapsSubmitCall
Submit: Submits a sitemap for a site.
- feedpath: The URL of the actual sitemap. For example:`http://www.example.com/sitemap.xml`.
- siteUrl: The site's URL, including protocol. For example:`http://www.example.com/`.
typeSitemapsSubmitCall¶added inv0.33.0
type SitemapsSubmitCall struct {// contains filtered or unexported fields}func (*SitemapsSubmitCall)Context¶added inv0.33.0
func (c *SitemapsSubmitCall) Context(ctxcontext.Context) *SitemapsSubmitCall
Context sets the context to be used in this call's Do method.
func (*SitemapsSubmitCall)Do¶added inv0.33.0
func (c *SitemapsSubmitCall) Do(opts ...googleapi.CallOption)error
Do executes the "webmasters.sitemaps.submit" call.
func (*SitemapsSubmitCall)Fields¶added inv0.33.0
func (c *SitemapsSubmitCall) Fields(s ...googleapi.Field) *SitemapsSubmitCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SitemapsSubmitCall)Header¶added inv0.33.0
func (c *SitemapsSubmitCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeSitesAddCall¶added inv0.33.0
type SitesAddCall struct {// contains filtered or unexported fields}func (*SitesAddCall)Context¶added inv0.33.0
func (c *SitesAddCall) Context(ctxcontext.Context) *SitesAddCall
Context sets the context to be used in this call's Do method.
func (*SitesAddCall)Do¶added inv0.33.0
func (c *SitesAddCall) Do(opts ...googleapi.CallOption)error
Do executes the "webmasters.sites.add" call.
func (*SitesAddCall)Fields¶added inv0.33.0
func (c *SitesAddCall) Fields(s ...googleapi.Field) *SitesAddCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SitesAddCall)Header¶added inv0.33.0
func (c *SitesAddCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeSitesDeleteCall¶added inv0.33.0
type SitesDeleteCall struct {// contains filtered or unexported fields}func (*SitesDeleteCall)Context¶added inv0.33.0
func (c *SitesDeleteCall) Context(ctxcontext.Context) *SitesDeleteCall
Context sets the context to be used in this call's Do method.
func (*SitesDeleteCall)Do¶added inv0.33.0
func (c *SitesDeleteCall) Do(opts ...googleapi.CallOption)error
Do executes the "webmasters.sites.delete" call.
func (*SitesDeleteCall)Fields¶added inv0.33.0
func (c *SitesDeleteCall) Fields(s ...googleapi.Field) *SitesDeleteCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SitesDeleteCall)Header¶added inv0.33.0
func (c *SitesDeleteCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeSitesGetCall¶added inv0.33.0
type SitesGetCall struct {// contains filtered or unexported fields}func (*SitesGetCall)Context¶added inv0.33.0
func (c *SitesGetCall) Context(ctxcontext.Context) *SitesGetCall
Context sets the context to be used in this call's Do method.
func (*SitesGetCall)Do¶added inv0.33.0
func (c *SitesGetCall) Do(opts ...googleapi.CallOption) (*WmxSite,error)
Do executes the "webmasters.sites.get" call.Any non-2xx status code is an error. Response headers are in either*WmxSite.ServerResponse.Header or (if a response was returned at all) inerror.(*googleapi.Error).Header. Use googleapi.IsNotModified to checkwhether the returned error was because http.StatusNotModified was returned.
func (*SitesGetCall)Fields¶added inv0.33.0
func (c *SitesGetCall) Fields(s ...googleapi.Field) *SitesGetCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SitesGetCall)Header¶added inv0.33.0
func (c *SitesGetCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SitesGetCall)IfNoneMatch¶added inv0.33.0
func (c *SitesGetCall) IfNoneMatch(entityTagstring) *SitesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeSitesListCall¶added inv0.33.0
type SitesListCall struct {// contains filtered or unexported fields}func (*SitesListCall)Context¶added inv0.33.0
func (c *SitesListCall) Context(ctxcontext.Context) *SitesListCall
Context sets the context to be used in this call's Do method.
func (*SitesListCall)Do¶added inv0.33.0
func (c *SitesListCall) Do(opts ...googleapi.CallOption) (*SitesListResponse,error)
Do executes the "webmasters.sites.list" call.Any non-2xx status code is an error. Response headers are in either*SitesListResponse.ServerResponse.Header or (if a response was returned atall) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified tocheck whether the returned error was because http.StatusNotModified wasreturned.
func (*SitesListCall)Fields¶added inv0.33.0
func (c *SitesListCall) Fields(s ...googleapi.Field) *SitesListCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*SitesListCall)Header¶added inv0.33.0
func (c *SitesListCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
func (*SitesListCall)IfNoneMatch¶added inv0.33.0
func (c *SitesListCall) IfNoneMatch(entityTagstring) *SitesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if theobject's ETag matches the given value. This is useful for getting updatesonly after the object has changed since the last request.
typeSitesListResponse¶added inv0.33.0
type SitesListResponse struct {// SiteEntry: Contains permission level information about a Search Console// site. For more information, see Permissions in Search Console// (https://support.google.com/webmasters/answer/2451999).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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}SitesListResponse: List of sites with access level information.
func (SitesListResponse)MarshalJSON¶added inv0.33.0
func (sSitesListResponse) MarshalJSON() ([]byte,error)
typeSitesService¶added inv0.33.0
type SitesService struct {// contains filtered or unexported fields}funcNewSitesService¶added inv0.33.0
func NewSitesService(s *Service) *SitesService
func (*SitesService)Add¶added inv0.33.0
func (r *SitesService) Add(siteUrlstring) *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¶added inv0.33.0
func (r *SitesService) Delete(siteUrlstring) *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 `sc-domain:example.com`.
func (*SitesService)Get¶added inv0.33.0
func (r *SitesService) Get(siteUrlstring) *SitesGetCall
Get: Retrieves information about specific site.
- siteUrl: The URI of the property as defined in Search Console.**Examples:** `http://www.example.com/` or `sc-domain:example.com`.
func (*SitesService)List¶added inv0.33.0
func (r *SitesService) List() *SitesListCall
List: Lists the user's Search Console sites.
typeTestStatus¶
type TestStatus struct {// Details: Error details if applicable.Detailsstring `json:"details,omitempty"`// Status: Status of the test.//// Possible values:// "TEST_STATUS_UNSPECIFIED" - Internal error when running this test. Please// try running the test again.// "COMPLETE" - Inspection has completed without errors.// "INTERNAL_ERROR" - Inspection terminated in an error state. This indicates// a problem in Google's infrastructure, not a user error. Please try again// later.// "PAGE_UNREACHABLE" - Google can not access the URL because of a user error// such as a robots.txt blockage, a 403 or 500 code etc. Please make sure that// the URL provided is accessible by Googlebot and is not password protected.Statusstring `json:"status,omitempty"`// ForceSendFields is a list of field names (e.g. "Details") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "Details") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}TestStatus: Final state of the test, including error details if necessary.
func (TestStatus)MarshalJSON¶
func (sTestStatus) MarshalJSON() ([]byte,error)
typeUrlInspectionIndexInspectCall¶added inv0.67.0
type UrlInspectionIndexInspectCall struct {// contains filtered or unexported fields}func (*UrlInspectionIndexInspectCall)Context¶added inv0.67.0
func (c *UrlInspectionIndexInspectCall) Context(ctxcontext.Context) *UrlInspectionIndexInspectCall
Context sets the context to be used in this call's Do method.
func (*UrlInspectionIndexInspectCall)Do¶added inv0.67.0
func (c *UrlInspectionIndexInspectCall) Do(opts ...googleapi.CallOption) (*InspectUrlIndexResponse,error)
Do executes the "searchconsole.urlInspection.index.inspect" call.Any non-2xx status code is an error. Response headers are in either*InspectUrlIndexResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*UrlInspectionIndexInspectCall)Fields¶added inv0.67.0
func (c *UrlInspectionIndexInspectCall) Fields(s ...googleapi.Field) *UrlInspectionIndexInspectCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*UrlInspectionIndexInspectCall)Header¶added inv0.67.0
func (c *UrlInspectionIndexInspectCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeUrlInspectionIndexService¶added inv0.67.0
type UrlInspectionIndexService struct {// contains filtered or unexported fields}funcNewUrlInspectionIndexService¶added inv0.67.0
func NewUrlInspectionIndexService(s *Service) *UrlInspectionIndexService
func (*UrlInspectionIndexService)Inspect¶added inv0.67.0
func (r *UrlInspectionIndexService) Inspect(inspecturlindexrequest *InspectUrlIndexRequest) *UrlInspectionIndexInspectCall
Inspect: Index inspection.
typeUrlInspectionResult¶added inv0.67.0
type UrlInspectionResult struct {// AmpResult: Result of the AMP analysis. Absent if the page is not an AMP// page.AmpResult *AmpInspectionResult `json:"ampResult,omitempty"`// IndexStatusResult: Result of the index status analysis.IndexStatusResult *IndexStatusInspectionResult `json:"indexStatusResult,omitempty"`// InspectionResultLink: Link to Search Console URL inspection.InspectionResultLinkstring `json:"inspectionResultLink,omitempty"`// MobileUsabilityResult: Result of the Mobile usability analysis.MobileUsabilityResult *MobileUsabilityInspectionResult `json:"mobileUsabilityResult,omitempty"`// RichResultsResult: Result of the Rich Results analysis. Absent if there are// no rich results found.RichResultsResult *RichResultsInspectionResult `json:"richResultsResult,omitempty"`// ForceSendFields is a list of field names (e.g. "AmpResult") to// unconditionally include in API requests. By default, fields with empty or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.ForceSendFields []string `json:"-"`// NullFields is a list of field names (e.g. "AmpResult") to include in API// requests with the JSON null value. By default, fields with empty values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}UrlInspectionResult: URL inspection result, including all inspectionresults.
func (UrlInspectionResult)MarshalJSON¶added inv0.67.0
func (sUrlInspectionResult) MarshalJSON() ([]byte,error)
typeUrlInspectionService¶added inv0.67.0
type UrlInspectionService struct {Index *UrlInspectionIndexService// contains filtered or unexported fields}funcNewUrlInspectionService¶added inv0.67.0
func NewUrlInspectionService(s *Service) *UrlInspectionService
typeUrlTestingToolsMobileFriendlyTestRunCall¶
type UrlTestingToolsMobileFriendlyTestRunCall struct {// contains filtered or unexported fields}func (*UrlTestingToolsMobileFriendlyTestRunCall)Context¶
func (c *UrlTestingToolsMobileFriendlyTestRunCall) Context(ctxcontext.Context) *UrlTestingToolsMobileFriendlyTestRunCall
Context sets the context to be used in this call's Do method.
func (*UrlTestingToolsMobileFriendlyTestRunCall)Do¶
func (c *UrlTestingToolsMobileFriendlyTestRunCall) Do(opts ...googleapi.CallOption) (*RunMobileFriendlyTestResponse,error)
Do executes the "searchconsole.urlTestingTools.mobileFriendlyTest.run" call.Any non-2xx status code is an error. Response headers are in either*RunMobileFriendlyTestResponse.ServerResponse.Header or (if a response wasreturned at all) in error.(*googleapi.Error).Header. Usegoogleapi.IsNotModified to check whether the returned error was becausehttp.StatusNotModified was returned.
func (*UrlTestingToolsMobileFriendlyTestRunCall)Fields¶
func (c *UrlTestingToolsMobileFriendlyTestRunCall) Fields(s ...googleapi.Field) *UrlTestingToolsMobileFriendlyTestRunCall
Fields allows partial responses to be retrieved. Seehttps://developers.google.com/gdata/docs/2.0/basics#PartialResponse for moredetails.
func (*UrlTestingToolsMobileFriendlyTestRunCall)Header¶
func (c *UrlTestingToolsMobileFriendlyTestRunCall) Header()http.Header
Header returns a http.Header that can be modified by the caller to addheaders to the request.
typeUrlTestingToolsMobileFriendlyTestService¶
type UrlTestingToolsMobileFriendlyTestService struct {// contains filtered or unexported fields}funcNewUrlTestingToolsMobileFriendlyTestService¶
func NewUrlTestingToolsMobileFriendlyTestService(s *Service) *UrlTestingToolsMobileFriendlyTestService
func (*UrlTestingToolsMobileFriendlyTestService)Run¶
func (r *UrlTestingToolsMobileFriendlyTestService) Run(runmobilefriendlytestrequest *RunMobileFriendlyTestRequest) *UrlTestingToolsMobileFriendlyTestRunCall
Run: Runs Mobile-Friendly Test for a given URL.
typeUrlTestingToolsService¶
type UrlTestingToolsService struct {MobileFriendlyTest *UrlTestingToolsMobileFriendlyTestService// contains filtered or unexported fields}funcNewUrlTestingToolsService¶
func NewUrlTestingToolsService(s *Service) *UrlTestingToolsService
typeWmxSite¶added inv0.33.0
type WmxSite struct {// PermissionLevel: The user's permission level for the site.//// Possible values:// "SITE_PERMISSION_LEVEL_UNSPECIFIED"// "SITE_OWNER" - Owner has complete access to the site.// "SITE_FULL_USER" - Full users can access all data, and perform most of the// operations.// "SITE_RESTRICTED_USER" - Restricted users can access most of the data, and// perform some operations.// "SITE_UNVERIFIED_USER" - Unverified user has no access to site's data.PermissionLevelstring `json:"permissionLevel,omitempty"`// SiteUrl: The URL of the site.SiteUrlstring `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}WmxSite: Contains permission level information about a Search Console site.For more information, see Permissions in Search Console(https://support.google.com/webmasters/answer/2451999).
func (WmxSite)MarshalJSON¶added inv0.33.0
typeWmxSitemap¶added inv0.33.0
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.Errorsint64 `json:"errors,omitempty,string"`// IsPending: If true, the sitemap has not been processed.IsPendingbool `json:"isPending,omitempty"`// IsSitemapsIndex: If true, the sitemap is a collection of sitemaps.IsSitemapsIndexbool `json:"isSitemapsIndex,omitempty"`// LastDownloaded: Date & time in which this sitemap was last downloaded. Date// format is inRFC 3339 format (yyyy-mm-dd).LastDownloadedstring `json:"lastDownloaded,omitempty"`// LastSubmitted: Date & time in which this sitemap was submitted. Date format// is inRFC 3339 format (yyyy-mm-dd).LastSubmittedstring `json:"lastSubmitted,omitempty"`// Path: The url of the sitemap.Pathstring `json:"path,omitempty"`// Type: The type of the sitemap. For example: `rssFeed`.//// Possible values:// "NOT_SITEMAP"// "URL_LIST"// "SITEMAP"// "RSS_FEED"// "ATOM_FEED"// "PATTERN_SITEMAP" - Unsupported sitemap types.// "OCEANFRONT"Typestring `json:"type,omitempty"`// Warnings: Number of warnings for the sitemap. These are generally// non-critical issues with URLs in the sitemaps.Warningsint64 `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 or// default values are omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}WmxSitemap: Contains detailed information about a specific URL submitted asa sitemap (https://support.google.com/webmasters/answer/156184).
func (WmxSitemap)MarshalJSON¶added inv0.33.0
func (sWmxSitemap) MarshalJSON() ([]byte,error)
typeWmxSitemapContent¶added inv0.33.0
type WmxSitemapContent struct {// Indexed: *Deprecated; do not use.*Indexedint64 `json:"indexed,omitempty,string"`// Submitted: The number of URLs in the sitemap (of the content type).Submittedint64 `json:"submitted,omitempty,string"`// Type: The specific type of content in this sitemap. For example: `web`.//// Possible values:// "WEB"// "IMAGE"// "VIDEO"// "NEWS"// "MOBILE"// "ANDROID_APP"// "PATTERN" - Unsupported content type.// "IOS_APP"// "DATA_FEED_ELEMENT" - Unsupported content type.Typestring `json:"type,omitempty"`// ForceSendFields is a list of field names (e.g. "Indexed") to unconditionally// include in API requests. By default, fields with empty or default values are// omitted from API requests. See//https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more// details.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. See//https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.NullFields []string `json:"-"`}WmxSitemapContent: Information about the various content types in thesitemap.
func (WmxSitemapContent)MarshalJSON¶added inv0.33.0
func (sWmxSitemapContent) MarshalJSON() ([]byte,error)