Autorisation requise
Interrogez vos données sur le trafic de recherche à l'aide de filtres et de paramètres que vous définissez. La méthode renvoie zéro ou plusieurs lignes regroupées par les clés de ligne (dimensions) que vous définissez. Vous devez définir une plage de dates d'un ou plusieurs jours.
Lorsque la date est l'une des dimensions, les jours sans données sont exclus de la liste des résultats. Pour savoir quels jours contiennent des données, exécutez une requête sans filtres, groupée par date, pour la période qui vous intéresse.
Les résultats sont triés par nombre de clics décroissant. Si deux lignes ont le même nombre de clics, elles sont triées de manière arbitraire.
Consultez l'exemple Python pour savoir comment appeler cette méthode.
L'API est limitée par les contraintes internes de la Search Console. Elle ne garantit pas de renvoyer toutes les lignes de données, mais plutôt les principales.
Consultez les limites de la quantité de données disponibles.
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"]
}Requête
Requête HTTP
POST https://www.googleapis.com/webmasters/v3/sites/siteUrl/searchAnalytics/query
Paramètres
| Nom du paramètre | Valeur | Description |
|---|---|---|
| Paramètres de chemin d'accès | ||
siteUrl |
string |
URL de la propriété telle qu'elle est définie dans la Search Console. Exemples :
http://www.example.com/ (pour une propriété avec préfixe d'URL) ou
sc-domain:example.com (pour une propriété de domaine)
|
Autorisation
Une autorisation est requise pour cette requête. Celle-ci doit inclure au moins l'un des champs d'application suivants. En savoir plus sur le processus d'authentification et d'autorisation
| Champ d'application |
|---|
https://www.googleapis.com/auth/webmasters.readonly |
https://www.googleapis.com/auth/webmasters |
Corps de la requête
Dans le corps de la requête, indiquez des données en utilisant la structure suivante :
{
"startDate": string,
"endDate": string,
"dimensions": [
string
],
"type": string,
"dimensionFilterGroups": [
{
"groupType": string,
"filters": [
{
"dimension": string,
"operator": string,
"expression": string
}
]
}
],
"aggregationType": string,
"rowLimit": integer,
"startRow": integer
}| Nom de propriété | Valeur | Description | Remarques |
|---|---|---|---|
startDate |
string |
[Obligatoire] Date de début de la période demandée, au format AAAA-MM-JJ, dans le fuseau horaire du Pacifique (UTC-7:00/8:00). Doit être antérieure ou égale à la date de fin. Cette valeur est incluse dans la plage. | |
endDate |
string |
[Obligatoire] Date de fin de la période demandée, au format AAAA-MM-JJ, en heure du Pacifique (UTC-7:00/8:00). Doit être supérieure ou égale à la date de début. Cette valeur est incluse dans la plage. | |
dimensions[] |
list |
[Facultatif] Zéro ou plusieurs dimensions selon lesquelles regrouper les résultats. Les résultats sont regroupés dans l'ordre dans lequel vous fournissez ces dimensions. Vous pouvez utiliser n'importe quel nom de dimension dans dimensionFilterGroups[].filters[].dimension, ainsi que "date" et "hour". Les valeurs de la dimension de regroupement sont combinées pour créer une clé unique pour chaque ligne de résultat. Si aucune dimension n'est spécifiée, toutes les valeurs seront combinées en une seule ligne. Le nombre de dimensions selon lesquelles vous pouvez regrouper les données n'est pas limité, mais vous ne pouvez pas regrouper les données selon la même dimension deux fois. Exemple : [pays, appareil] | |
searchType |
string |
Obsolète, utilisez plutôt type
|
|
type |
string |
[Facultatif] Filtrez les résultats selon le type suivant :
|
|
dimensionFilterGroups[] |
list |
[Facultatif] Zéro, un ou plusieurs groupes de filtres à appliquer aux valeurs de regroupement de dimensions. Pour qu'une ligne soit renvoyée dans la réponse, tous les groupes de filtres doivent correspondre. Dans un même groupe de filtres, vous pouvez spécifier si tous les filtres doivent correspondre ou si au moins un doit correspondre. | |
dimensionFilterGroups[].groupType |
string |
Indique si tous les filtres de ce groupe doivent renvoyer la valeur "true" ("and") ou si un ou plusieurs d'entre eux doivent renvoyer la valeur "true" (non encore pris en charge).
Les valeurs acceptées sont les suivantes :
|
|
dimensionFilterGroups[].filters[] |
list |
[Facultatif] Zéro ou plusieurs filtres à tester par rapport à la ligne. Chaque filtre se compose d'un nom de dimension, d'un opérateur et d'une valeur. Longueur maximale : 4 096 caractères. Exemples :
country equals FRA query contains mobile use device notContains tablet |
|
dimensionFilterGroups[].filters[].dimension |
string |
Dimension à laquelle ce filtre s'applique. Vous pouvez filtrer les données selon n'importe quelle dimension listée ici, même si vous ne les regroupez pas selon cette dimension.
Les valeurs acceptées sont les suivantes :
|
|
dimensionFilterGroups[].filters[].operator |
string |
[Facultatif] Indique comment la valeur que vous avez spécifiée doit correspondre (ou non) à la valeur de dimension de la ligne.
Les valeurs acceptées sont les suivantes :
|
|
dimensionFilterGroups[].filters[].expression |
string |
Valeur à laquelle le filtre doit correspondre ou qu'il doit exclure, selon l'opérateur. | |
aggregationType |
string |
[Facultatif] Méthode d'agrégation des données. Si les données sont agrégées par propriété, toutes les données de la même propriété sont agrégées. Si elles sont agrégées par page, toutes les données sont agrégées par URI canonique. Si vous filtrez ou regroupez les données par page, sélectionnez "Automatique". Sinon, vous pouvez les agréger par propriété ou par page, selon la façon dont vous souhaitez que vos données soient calculées. Consultez la documentation d'aide pour découvrir comment les données sont calculées différemment par site et par page. Remarque : Si vous regroupez ou filtrez par page, vous ne pouvez pas agréger par propriété. Si vous spécifiez une valeur autre que "auto", le type d'agrégation dans le résultat correspondra au type demandé. Si vous demandez un type non valide, vous recevrez un message d'erreur. L'API ne modifiera jamais votre type d'agrégation si le type demandé n'est pas valide. Les valeurs acceptées sont les suivantes :
|
|
rowLimit |
integer |
[Facultatif ; la plage de valeurs valides est comprise entre 1 et 25 000 ; la valeur par défaut est 1 000] Nombre maximal de lignes à renvoyer. Pour parcourir les résultats, utilisez le décalage startRow. |
|
startRow |
integer |
[Facultatif ; la valeur par défaut est 0] Index basé sur zéro de la première ligne de la réponse. Doit être un nombre non négatif. Si startRow dépasse le nombre de résultats de la requête, la réponse sera positive et ne comportera aucune ligne. |
|
dataState |
string |
[Facultatif] Si la valeur est "all" (non sensible à la casse), les données incluront des données récentes. Si la valeur est "final" (non sensible à la casse) ou si ce paramètre est omis, les données renvoyées n'incluront que les données finalisées. Si la valeur est "hourly_all" (non sensible à la casse), les données incluront une répartition horaire. Cela indique que les données horaires incluent des données partielles et doivent être utilisées lors du regroupement par la dimension d'API HOUR. |
Réponse
Les résultats sont regroupés en fonction des dimensions spécifiées dans la requête. Toutes les valeurs ayant le même ensemble de valeurs de dimension seront regroupées dans une même ligne. Par exemple, si vous regroupez les résultats par dimension "Pays", tous les résultats pour "usa" seront regroupés, tous les résultats pour "mdv" seront regroupés, et ainsi de suite. Si vous avez regroupé les résultats par pays et par appareil, tous les résultats pour "usa, tablette" seront regroupés, tous les résultats pour "usa, mobile" seront regroupés, et ainsi de suite. Consultez la documentation sur le rapport "Analyse de la recherche" pour en savoir plus sur le calcul des clics, des impressions, etc., et sur leur signification.
Les résultats sont triés par nombre de clics, par ordre décroissant, sauf si vous les regroupez par date. Dans ce cas, ils sont triés par date, par ordre croissant (du plus ancien au plus récent). En cas d'égalité entre deux lignes, l'ordre de tri est arbitraire.
Consultez la propriété rowLimit dans la requête pour connaître le nombre maximal de valeurs pouvant être renvoyées.
{
"rows": [
{
"keys": [
string
],
"clicks": double,
"impressions": double,
"ctr": double,
"position": double
}
],
"responseAggregationType": string
}| Nom de propriété | Valeur | Description | Remarques |
|---|---|---|---|
rows[] |
list |
Liste de lignes regroupées par valeurs clés dans l'ordre indiqué dans la requête. | |
rows[].keys[] |
list |
Liste des valeurs de dimension pour cette ligne, regroupées en fonction des dimensions de la requête, dans l'ordre spécifié dans la requête. | |
rows[].clicks |
double |
Nombre de clics pour la ligne. | |
rows[].impressions |
double |
Nombre d'impressions pour la ligne. | |
rows[].ctr |
double |
Taux de clics (CTR) pour la ligne. Les valeurs sont comprises entre 0 et 1.0, inclus. | |
rows[].position |
double |
Position moyenne dans les résultats de recherche. | |
responseAggregationType |
string |
La façon dont les résultats ont été agrégés. Consultez la documentation d'aide pour découvrir comment les données sont calculées différemment par site ou par page.
Les valeurs acceptées sont les suivantes :
|
|
metadata |
object |
Objet pouvant être renvoyé avec les résultats de votre requête, fournissant un contexte sur l'état des données. Lorsque vous demandez des données récentes (à l'aide de Toutes les dates et heures fournies dans cet objet sont indiquées dans le fuseau horaire Le champ spécifique renvoyé dans cet objet dépend de la façon dont vous avez regroupé vos données dans la requête :
|
Essayer
Utilisez l'explorateur d'API ci-dessous pour appeler cette méthode sur des données en direct, puis observez la réponse.