API Reference

La API de Search Console ofrece los siguientes servicios:

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

Análisis de búsqueda

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

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

Consulta los datos del tráfico de búsquedas con los filtros y parámetros que tú defines. El método muestra cero o más filas agrupadas por las claves de fila (dimensiones) que definas. Debes 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, emite una consulta sin filtros agrupados por fecha para el período en cuestión.

Los resultados se ordenan por recuento de clics en orden descendente. Si dos filas tienen la misma cantidad de clics, se ordenan de manera arbitraria.

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

Ejemplo de POST JSON:
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 de sitios

Para obtener más información sobre los recursos de mapas del sitio, consulta la página de representación de los recursos.

Método Solicitud HTTP Descripción
Los URI en relación con 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.
get GET  /sites/siteUrl/sitemaps/feedpath Recupera información sobre un mapa del sitio específico.
list GET  /sites/siteUrl/sitemaps Enumera las entradas del mapa del sitio enviadas para este sitio o incluidas en el archivo del índice del mapa del sitio (si se especifica sitemapIndex en la solicitud).
enviar PUT  /sites/siteUrl/sitemaps/feedpath Envía un mapa del sitio para un sitio.

Sites

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

Método Solicitud HTTP Descripción
Los URI en relación con 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.
get GET  /sites/siteUrl Recupera información sobre un sitio específico.
list GET  /sites Muestra una lista de los sitios de Search Console del usuario.

Inspección de URL

Para obtener más detalles sobre los recursos de inspección de URLs, consulta la página de representación de recursos.

Método Solicitud HTTP Descripción
URI relacionado 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 POST JSON:
POST https://searchconsole.googleapis.com/v1/urlInspection/index:inspect
{
  "inspectionUrl": "https://www.example.com/mypage",
  "siteUrl": "https://www.example.com/",
  "languageCode": "en-US"}