Se usó la API de Cloud Translation para traducir esta página.

Search Analytics: 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. 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. Si quieres saber qué días tienen datos, emite una consulta sin filtros agrupados por fecha para el período que te interesa.

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

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

La API está limitada por limitaciones internas de Search Console y no garantiza que se muestren todas las filas de datos, sino las principales.

Consulta los límites de la cantidad de datos disponibles.

Ejemplo de JSON POST:

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

Pruébalo ahora.

Solicitud

Solicitud HTTP

POST https://www.googleapis.com/webmasters/v3/sites/siteUrl/searchAnalytics/query

Parámetros

Nombre del parámetro	Valor	Descripción
Parámetros de ruta de acceso
`siteUrl`	`string`	Es la URL de la propiedad según se define en Search Console. Ejemplos: `http://www.example.com/` (para una propiedad de prefijo de URL) o `sc-domain:example.com` (para una Propiedad de dominio)

Autorización

Esta solicitud requiere autorización con al menos uno de los siguientes alcances (obtén más información acerca de la autenticación y autorización).

Alcance
`https://www.googleapis.com/auth/webmasters.readonly`
`https://www.googleapis.com/auth/webmasters`

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporciona datos con la siguiente estructura:

{
  "startDate": string,
  "endDate": string,
  "dimensions": [
    string
  ],
  "type": string,
  "dimensionFilterGroups": [
    {
      "groupType": string,
      "filters": [
        {
          "dimension": string,
          "operator": string,
          "expression": string
        }
      ]
    }
  ],
  "aggregationType": string,
  "rowLimit": integer,
  "startRow": integer
}

Nombre de la propiedad	Valor	Descripción
`startDate`	`string`	[Obligatorio] Es la fecha de inicio del período solicitado, en formato AAAA-MM-DD, y en hora del Pacífico (UTC - 7:00/8:00). Debe ser menor o igual que la fecha de finalización. Este valor se incluye en el rango.
`endDate`	`string`	[Obligatorio] Es la fecha de finalización del período solicitado, en formato AAAA-MM-DD, y la hora PT (UTC: 7:00/8:00). Debe ser posterior o igual a la fecha de inicio. Este valor se incluye en el rango.
`dimensions[]`	`list`	[Opcional] Cero o más dimensiones para agrupar los resultadosLos resultados se agrupan según el orden en que proporcionas las dimensiones.Puedes usar cualquier nombre de dimensión en `dimensionFilterGroups[].filters[].dimension`, además de "fecha".Los valores de las dimensiones de agrupación se combinan para crear una clave única para cada fila de resultados. Si no se especifican dimensiones, todos los valores se combinarán en una sola fila. No hay límite para la cantidad de dimensiones que puedes agrupar, pero no puedes agrupar por la misma dimensión dos veces. Ejemplo: [país, dispositivo]
`searchType`	`string`	Obsoleto; usa `type` en su lugar
`type`	`string`	[Opcional] Filtra los resultados según el siguiente tipo: "`discover`": Resultados de Descubre "`googleNews`": Resultados de news.google.com y la app de Google Noticias en iOS y Android. No incluye resultados de la pestaña "Noticias" de la Búsqueda de Google. "`news`": Son los resultados de la búsqueda de la pestaña "Noticias" de la Búsqueda de Google. "`image`": Resultados de la búsqueda de la pestaña "Imagen" en la Búsqueda de Google. "`video`": Resultados de la búsqueda de videos "`web`": [Predeterminada] Filtra los resultados según la pestaña combinada ("Todos") en la Búsqueda de Google. No incluye los resultados de Descubre ni de Google Noticias.
`dimensionFilterGroups[]`	`list`	[Opcional] Cero o más grupos de filtros que se aplicarán a los valores de la agrupación de dimensiones. Todos los grupos de filtros deben coincidir para que se muestre una fila en la respuesta. Dentro de un solo grupo de filtros, puedes especificar si todos los filtros deben coincidir o si al menos uno debe coincidir.
`dimensionFilterGroups[].groupType`	`string`	Indica si todos los filtros de este grupo deben mostrar verdadero ("and"), o si uno o más deben mostrar verdadero (aún no se admite). Los valores aceptables son los siguientes: “`and`”: Todos los filtros del grupo deben mostrar el valor true para el grupo de filtros po que sean verdaderos.
`dimensionFilterGroups[].filters[]`	`list`	[Opcional] Cero o más filtros para comparar con la fila Cada filtro consiste en el nombre de la dimensión, un operador y un valor. La longitud máxima es de 4,096 caracteres. Ejemplos: country equals FRA query contains mobile use device notContains tablet
`dimensionFilterGroups[].filters[].dimension`	`string`	Es la dimensión a la que se aplica este filtro. Puedes filtrar por cualquier dimensión que aparezca aquí, incluso si no estás agrupando por esa dimensión. Los valores aceptables son los siguientes: "`country`": Filtra según el país especificado, como se indica con el código de país de 3 letras (ISO 3166-1 alpha-3). "`device`": Filtra los resultados según el tipo de dispositivo especificado. Valores admitidos: COMPUTADORAS DE ESCRITORIO DISPOSITIVOS MÓVILES TABLET "`page`": Filtra según la string de URI especificada. "`query`": Filtra según la cadena de consulta especificada. "`searchAppearance`": Filtra según una función específica de los resultados de la búsqueda. Para ver una lista de los valores disponibles, ejecuta una consulta agrupada por "searchAppearance".
`dimensionFilterGroups[].filters[].operator`	`string`	[Opcional] Indica cómo el valor que especificaste debe coincidir (o no) con el valor de la dimensión de la fila. Los valores aceptables son los siguientes: “`contains`”: El valor de la fila debe contener o ser igual a tu expresión (no distingue mayúsculas de minúsculas). "`equals`": [Predeterminado] La expresión debe ser exactamente igual al valor de la fila (distingue mayúsculas de minúsculas para las dimensiones de la página y la búsqueda). “`notContains`”: El valor de la fila no debe contener tu expresión como una substring o una coincidencia completa (que no distingue mayúsculas de minúsculas). "`notEquals`": La expresión no debe ser exactamente igual al valor de la fila (distingue mayúsculas de minúsculas para las dimensiones de la página y de la búsqueda). "`includingRegex`": Una expresión regular de la sintaxis RE2 con la que debe coincidir. "`excludingRegex`": Es una expresión regular de la sintaxis RE2 que no debe coincidir.
`dimensionFilterGroups[].filters[].expression`	`string`	Es el valor del filtro que debe coincidir o excluir, según el operador.
`aggregationType`	`string`	[Opcional] Cómo se agregan los datos. Si se agregan por propiedad, se agrupan todos los datos de la misma propiedad. Si se agregan por página, todos los datos se agrupan por URI canónico. Si filtras o agrupas por página, elige automático. De lo contrario, puedes agregar por propiedad o por página, según cómo quieras que se calculen tus datos. Consulta la documentación de ayuda para obtener información sobre cómo se calculan los datos de manera diferente por sitio o por página. Nota: Si agrupas o filtras por página, no puedes agregar por propiedad. Si especificas cualquier valor distinto de automático, el tipo de agregación en el resultado coincidirá con el tipo solicitado. Si solicitas un tipo no válido, recibirás un error. La API nunca cambiará tu tipo de agregación si el tipo solicitado no es válido. Los valores aceptables son los siguientes: "`auto`": [Predeterminada] Permite que el servicio decida el tipo de agregación apropiado. "`byNewsShowcasePanel`": Valores agregados del panel de News Showcase. Se debe usar junto con el filtro `NEWS_SHOWCASE` `searchAppearance` y `type=discover` o `type=googleNews`. Si agrupas por página, filtras por página o filtras por otro `searchAppearance`, no puedes agregar por `byNewsShowcasePanel`. "`byPage`": Agrega valores por URI. "`byProperty`": Valores agregados por propiedad. No se admite en `type=discover` ni `type=googleNews`
`rowLimit`	`integer`	[Opcional; el rango válido es de 1 a 25,000; el valor predeterminado es de 1,000] La cantidad máxima de filas que se mostrarán. Para desplazarse por los resultados, usa el desplazamiento `startRow`.
`startRow`	`integer`	[Opcional; el valor predeterminado es 0] Índice basado en cero de la primera fila en la respuesta. Debe ser un número no negativo. Si `startRow` supera la cantidad de resultados de la consulta, la respuesta será una respuesta correcta con cero filas.
`dataState`	`string`	[Opcional] Si se selecciona "todos" (no distingue mayúsculas de minúsculas), los datos incluirán datos actualizados. Si es "final" (no distingue mayúsculas de minúsculas) o si se omite este parámetro, los datos devueltos solo incluirán los datos finalizados.

Respuesta

Los resultados se agrupan según las dimensiones especificadas en la solicitud. Todos los valores con el mismo conjunto de valores de dimensión se agruparán en una sola fila. Por ejemplo, si agrupas por dimensión de país, todos los resultados para "usa" se agruparán, todos los resultados para "mdv" se agruparán, y así sucesivamente. Si agrupaste por país y dispositivo, se agruparán todos los resultados para "EE.UU., tablet", se agruparán todos los resultados para "EE.UU., dispositivo móvil", y así sucesivamente. Consulta la documentación del informe de estadísticas de la Búsqueda para conocer detalles específicos sobre cómo se calculan los clics, las impresiones, etc., y su significado.

Los resultados se ordenan por recuento de clics, en orden descendente, a menos que los agrupes por fecha, en cuyo caso los resultados se ordenan por fecha, en orden ascendente (más antiguos primero, más recientes al final). Si hay un empate entre dos filas, el orden es arbitrario.

Consulta la propiedad rowLimit en la solicitud para conocer la cantidad máxima de valores que se pueden mostrar.

{
  "rows": [
    {
      "keys": [
        string
      ],
      "clicks": double,
      "impressions": double,
      "ctr": double,
      "position": double
    }
  ],
  "responseAggregationType": string
}

Nombre de la propiedad	Valor	Descripción
`rows[]`	`list`	Una lista de filas agrupadas por valores clave en el orden dado en la consulta.
`rows[].keys[]`	`list`	Una lista de los valores de las dimensiones de esa fila, agrupados según las dimensiones de la solicitud, en el orden especificado en la solicitud.
`rows[].clicks`	`double`	Cantidad de clics de la fila.
`rows[].impressions`	`double`	Recuento de impresiones de la fila.
`rows[].ctr`	`double`	Porcentaje de clics (CTR) de la fila. Los valores varían de 0 a 1.0, inclusive.
`rows[].position`	`double`	Posición promedio en los resultados de la búsqueda.
`responseAggregationType`	`string`	Cómo se agregaron los resultados.Consulta la documentación de ayuda para obtener información sobre cómo se calculan los datos de manera diferente por sitio o por página. Los valores aceptables son los siguientes: "`auto`" "`byPage`": Los resultados se agruparon por página. "`byProperty`": Los resultados se agregaron por propiedad.

Pruébalo

Usa el Explorador de APIs que aparece a continuación para llamar a este método con los datos en tiempo real y ver la respuesta.