Method: cse.list

Renvoie les métadonnées relatives à la recherche effectuée, les métadonnées relatives au moteur utilisé pour la recherche et les résultats de recherche.

Requête HTTP :

GET https://customsearch.googleapis.com/customsearch/v1

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de requête

Paramètres
c2coff

string

Active ou désactive la recherche en chinois simplifié et traditionnel.

La valeur par défaut de ce paramètre est 0 (zéro), ce qui signifie que la fonctionnalité est activée. Voici les valeurs possibles :

  • 1: désactivé

  • 0 : Activé (par défaut)
cr

string

Limite les résultats de recherche aux documents provenant d'un pays spécifique. Vous pouvez utiliser des opérateurs booléens dans la valeur du paramètre cr.

La recherche Google détermine le pays d'un document en analysant:

  • Le domaine de premier niveau de l'URL du document

  • L'emplacement géographique de l'adresse IP du serveur Web

Consultez la page Valeurs des paramètres du pays pour obtenir la liste des valeurs valides pour ce paramètre.
cx

string

Identifiant Programmable Search Engine à utiliser pour cette requête.
dateRestrict

string

Limite les résultats aux URL en fonction de la date. Les valeurs autorisées incluent les suivantes :

  • d[number] : demande les résultats du nombre de jours spécifié.

  • w[number] : demande les résultats du nombre de semaines spécifié précédent.

  • m[number] : demande les résultats du nombre de mois précédents spécifié.

  • y[number]: demande les résultats du nombre d'années précédentes.
exactTerms

string

Identifie une expression que tous les documents des résultats de recherche doivent contenir.
excludeTerms

string

Identifie un mot ou une expression qui ne doit figurer dans aucun document des résultats de recherche.
fileType

string

Limite les résultats aux fichiers d'une extension spécifiée. Une liste des types de fichiers indexables par Google est disponible dans le Centre d'aide de la Search Console.
filter

string

Permet d'activer ou de désactiver le filtre de contenu en double.

  • Pour plus d'informations sur les filtres de résultats de recherche Google, consultez la page Filtrage automatique. Notez que le filtrage des groupes d'hôtes ne s'applique qu'aux recherches sur plusieurs sites.

  • Par défaut, Google applique un filtrage à tous les résultats de recherche afin d'améliorer leur qualité.

Les valeurs acceptées sont les suivantes :

  • 0 : désactive le filtre de contenu en double.

  • 1 : active le filtre de contenu en double.
gl

string

Géolocalisation de l'utilisateur final.

  • La valeur du paramètre gl correspond à un code pays à deux lettres. Le paramètre gl booste les résultats de recherche dont le pays d'origine correspond à la valeur du paramètre. Consultez la page Codes des pays pour obtenir la liste des valeurs valides.

  • Spécifier une valeur de paramètre gl permet d'obtenir des résultats plus pertinents. Cela est particulièrement vrai pour les clients internationaux et, plus précisément, pour les clients anglophones autres que les États-Unis.
googlehost

string

Obsolète. Utilisez le paramètre gl pour obtenir un effet similaire.

Domaine Google local (par exemple, google.com, google.de ou google.fr) à utiliser pour effectuer la recherche.
highRange

string

Spécifie la valeur de fin d'une plage de recherche.

  • Utilisez lowRange et highRange pour ajouter une plage de recherche inclusive de lowRange...highRange à la requête.
hl

string

Définit la langue de l'interface utilisateur.
hq

string

Ajoute les termes de requête spécifiés à la requête, comme s'ils étaient combinés avec un opérateur logique AND.
imgColorType

enum (ImgColorType)

Renvoie des images en noir et blanc, en nuances de gris, transparentes ou en couleur. Les valeurs acceptées sont les suivantes :

  • "color"

  • "gray"

  • "mono": noir et blanc

  • "trans": arrière-plan transparent
imgDominantColor

enum (ImgDominantColor)

Renvoie des images d'une couleur dominante spécifique. Les valeurs acceptées sont les suivantes :

  • "black"

  • "blue"

  • "brown"

  • "gray"

  • "green"

  • "orange"

  • "pink"

  • "purple"

  • "red"

  • "teal"

  • "white"

  • "yellow"
imgSize

enum (ImgSize)

Renvoie les images d'une taille spécifiée. Les valeurs acceptées sont les suivantes :

  • "huge"

  • "icon"

  • "large"

  • "medium"

  • "small"

  • "xlarge"

  • "xxlarge"
imgType

enum (ImgType)

Renvoie des images d'un type. Les valeurs acceptées sont les suivantes :

  • "clipart"

  • "face"

  • "lineart"

  • "stock"

  • "photo"

  • "animated"
lowRange

string

Spécifie la valeur de départ d'une plage de recherche. Utilisez lowRange et highRange pour ajouter une plage de recherche inclusive de lowRange...highRange à la requête.
lr

string

Limite la recherche aux documents rédigés dans une langue spécifique (par exemple, lr=lang_ja).

Les valeurs acceptées sont les suivantes :

  • "lang_ar": arabe

  • "lang_bg" : bulgare

  • "lang_ca": catalan

  • "lang_cs": tchèque

  • "lang_da" : danois

  • "lang_de": allemand

  • "lang_el" : grec

  • "lang_en": anglais

  • "lang_es": espagnol

  • "lang_et" : estonien

  • "lang_fi": finnois

  • "lang_fr" : français

  • "lang_hr" : croate

  • "lang_hu" : hongrois

  • "lang_id": indonésien

  • "lang_is" : islandais

  • "lang_it" : italien

  • "lang_iw" : hébreu

  • "lang_ja" : japonais

  • "lang_ko": coréen

  • "lang_lt" : lituanien

  • "lang_lv": letton

  • "lang_nl" : néerlandais

  • "lang_no" : norvégien

  • "lang_pl": polonais

  • "lang_pt": portugais

  • "lang_ro": roumain

  • "lang_ru": russe

  • "lang_sk": slovaque

  • "lang_sl" : slovène

  • "lang_sr": serbe

  • "lang_sv" : suédois

  • "lang_tr": turc

  • "lang_zh-CN" : chinois (simplifié)

  • "lang_zh-TW" : chinois (traditionnel)
num

integer

Nombre de résultats de recherche à renvoyer.

  • Les valeurs valides sont des entiers compris entre 1 et 10 inclus.
orTerms

string

Fournit des termes de recherche supplémentaires à rechercher dans un document, où chaque document figurant dans les résultats de recherche doit contenir au moins l'un des termes de recherche supplémentaires.
q

string

Requête
relatedSite

string

Spécifie que tous les résultats de recherche doivent être des pages liées à l'URL spécifiée.
rights

string

Filtres basés sur les licences. Les valeurs acceptées sont les suivantes: cc_publicdomain, cc_attribute, cc_sharealike, cc_noncommercial et cc_nonderived. Voir combinaisons types.
safe

enum (Safe)

Niveau de sécurité de la recherche. Les valeurs acceptées sont les suivantes :

  • "active": active le filtrage SafeSearch.

  • "off" : désactive le filtrage SafeSearch. (par défaut)
searchType

enum (SearchType)

Spécifie le type de recherche: image. Si ce paramètre n'est pas spécifié, les résultats sont limités aux pages Web.

Les valeurs acceptées sont les suivantes :

  • "image" : recherche personnalisée d'images.
siteSearchFilter

enum (SiteSearchFilter)

Détermine si les résultats du site nommé dans le paramètre siteSearch doivent être inclus ou exclus.

Les valeurs acceptées sont les suivantes :

  • "e": exclure

  • "i" : inclure
sort

string

Expression de tri à appliquer aux résultats. Le paramètre de tri spécifie que les résultats doivent être triés en fonction de l'expression spécifiée, c'est-à-dire en les triant par date. Exemple: sort=date.
start

integer (uint32 format)

Index du premier résultat à renvoyer. Le nombre de résultats par page étant par défaut de 10, &start=11 apparaît en haut de la deuxième page de résultats. Remarque : L'API JSON ne renverra jamais plus de 100 résultats, même si plus de 100 documents correspondent à la requête. Par conséquent, définir la somme de start + num sur un nombre supérieur à 100 générera une erreur. Notez également que la valeur maximale de num est 10.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de Search.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cse

Pour en savoir plus, consultez la présentation d'OAuth 2.0.