API Reference

La API de Search Console ofrece los siguientes servicios:

  • Estadísticas de búsqueda: Consulta datos del tráfico de tu sitio.
  • Mapas del sitio: Incluye todos tus mapas del sitio, solicita información sobre uno específico y envíalos a Google.
  • Sitios: Muestra, agrega o quita propiedades de tu cuenta de Search Console.
  • Inspección de URL: Inspecciona el estado de una página en el índice de Google (equivalente a la inspección de URL en Search Console).

Estadísticas de la Búsqueda

Para obtener detalles sobre los recursos de estadísticas de búsqueda, consulta la página Representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/webmasters/v3, a menos que se indique lo contrario
query POST  /sites/siteUrl/searchAnalytics/query

Consulta tus datos de tráfico de búsqueda con los filtros y parámetros que definas. El método muestra cero o más filas agrupadas por las claves de fila (dimensiones) que definas. Debe definir un período de uno o más días.

Cuando la fecha es una de las dimensiones, los días sin datos se omiten de la lista de resultados. Para saber qué días tienen datos, emita una consulta sin filtros agrupados por fecha para el período de interés.

Los resultados se ordenan de forma descendente según la cantidad de clics. Si dos filas tienen el mismo recuento de clics, se ordenan de forma arbitraria.

Consulta la muestra de Python para llamar a este método.

Ejemplo de JSON POST:
POST https://www.googleapis.com/webmasters/v3/sites/https%3A%2F%2Fwww.example.com%2F/searchAnalytics/query
{
  "startDate": "2015-04-01",
  "endDate": "2015-05-01",
  "dimensions": ["country","device"]
}

Mapas del sitio

Para obtener información detallada sobre los recursos de mapas del sitio, consulta la página Representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/webmasters/v3, a menos que se indique lo contrario
borrar DELETE  /sites/siteUrl/sitemaps/feedpath Borra un mapa del sitio de este sitio.
obtener GET  /sites/siteUrl/sitemaps/feedpath Recupera información sobre un mapa del sitio específico.
list GET  /sites/siteUrl/sitemaps Enumera las sitemaps-entries enviadas para este sitio o incluidas en el archivo de índice de mapas del sitio (si se especifica sitemapIndex en la solicitud).
enviar PUT  /sites/siteUrl/sitemaps/feedpath Envía un mapa del sitio para un sitio.

Sitios

Para obtener detalles sobre los recursos de Sites, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relativos a https://www.googleapis.com/webmasters/v3, a menos que se indique lo contrario
agregar PUT  /sites/siteUrl Agrega un sitio al conjunto de sitios del usuario en Search Console.
borrar DELETE  /sites/siteUrl Quita un sitio del conjunto de sitios de Search Console del usuario.
obtener GET  /sites/siteUrl Recupera información sobre un sitio específico.
list GET  /sites Enumera los sitios de Search Console del usuario.

Inspección de URL

Para obtener información sobre el recurso de inspección de URL, consulta la página Representación de recursos.

Método Solicitud HTTP Descripción
URI en relación con https://searchconsole.googleapis.com/v1
index.inspect. POST /urlInspection/index:inspect

Información sobre la URL proporcionada en el índice de Google.

Ejemplo de JSON POST:
POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect
{
  "inspectionUrl": "https://www.example.com/mypage",
  "siteUrl": "https://www.example.com/",
  "languageCode": "en-US"}