searchconsole/v1 library

Google Search Console API - v1

The Search Console API provides access to both Search Console data (verified users only) and to public information on an URL basis (anyone)

For more information, see developers.google.com/webmaster-tools/search-console-api/

Create an instance of SearchConsoleApi to access these resources:

Classes

AmpInspectionResult
AMP inspection result of the live page or the current information from Google's index, depending on whether you requested a live inspection or not.
AmpIssue
AMP issue.
ApiDataRow
ApiDimensionFilter
A filter test to be applied to each row in the data set, where a match can return the row.
ApiDimensionFilterGroup
A set of dimension value filters to test against each row.
BlockedResource
Blocked resource.
DetectedItems
Rich Results items grouped by type.
Image
Describe image data.
IndexStatusInspectionResult
Results of index status inspection for either the live page or the version in Google's index, depending on whether you requested a live inspection or not.
InspectUrlIndexRequest
Index inspection request.
InspectUrlIndexResponse
Index-Status inspection response.
Item
A specific rich result found on the page.
MobileFriendlyIssue
Mobile-friendly issue.
MobileUsabilityInspectionResult
Mobile-usability inspection results.
MobileUsabilityIssue
Mobile-usability issue.
ResourceIssue
Information about a resource with issue.
RichResultsInspectionResult
Rich-Results inspection result, including any rich results found at this URL.
RichResultsIssue
Severity and status of a single issue affecting a single rich result instance on a page.
RunMobileFriendlyTestRequest
Mobile-friendly test request.
RunMobileFriendlyTestResponse
Mobile-friendly test response, including mobile-friendly issues and resource issues.
SearchAnalyticsQueryRequest
SearchAnalyticsQueryResponse
A list of rows, one per result, grouped by key.
SearchanalyticsResource
SearchConsoleApi
The Search Console API provides access to both Search Console data (verified users only) and to public information on an URL basis (anyone)
SitemapsListResponse
List of sitemaps.
SitemapsResource
SitesListResponse
List of sites with access level information.
SitesResource
TestStatus
Final state of the test, including error details if necessary.
UrlInspectionIndexResource
UrlInspectionResource
UrlInspectionResult
URL inspection result, including all inspection results.
UrlTestingToolsMobileFriendlyTestResource
UrlTestingToolsResource
WmxSite
Contains permission level information about a Search Console site.
WmxSitemap
Contains detailed information about a specific URL submitted as a sitemap.
WmxSitemapContent
Information about the various content types in the sitemap.

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.