- Requête HTTP
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- Champs d'application des autorisations
- Essayer
Renvoie toutes les lignes correspondant à la requête de recherche.
Liste des erreurs générées: AuthenticationError AuthorizationError ChangeEventError ChangeStatusError ClickViewError HeaderError InternalError QueryError QuotaError RequestError
Requête HTTP
POST https://googleads.googleapis.com/v14/customers/{customerId}/googleAds:search
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres | |
---|---|
customerId |
Obligatoire. Identifiant du client interrogé. |
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
Représentation JSON |
---|
{
"query": string,
"pageToken": string,
"pageSize": integer,
"validateOnly": boolean,
"returnTotalResultsCount": boolean,
"summaryRowSetting": enum ( |
Champs | |
---|---|
query |
Obligatoire. La chaîne de requête. |
pageToken |
Jeton de la page à récupérer. Si aucune valeur n'est spécifiée, la première page de résultats est renvoyée. Pour demander la page de résultats suivante, utilisez la valeur obtenue à partir de |
pageSize |
Nombre d'éléments à récupérer sur une seule page. Lorsqu'une page demandée est trop volumineuse, le serveur peut décider de limiter davantage le nombre de ressources renvoyées. |
validateOnly |
Si la valeur est "true", la requête est validée, mais pas exécutée. |
returnTotalResultsCount |
Si la valeur est "true", le nombre total de résultats correspondant à la requête en ignorant la clause LIMIT sera inclus dans la réponse. La valeur par défaut est "false". |
summaryRowSetting |
Détermine si une ligne récapitulative sera renvoyée. Par défaut, la ligne récapitulative n'est pas renvoyée. Si elle est demandée, la ligne récapitulative sera envoyée seule dans une réponse une fois que tous les autres résultats de requête auront été renvoyés. |
Corps de la réponse
Message de réponse pour GoogleAdsService.Search
.
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Représentation JSON |
---|
{ "results": [ { object ( |
Champs | |
---|---|
results[] |
Liste des lignes correspondant à la requête. |
nextPageToken |
Jeton de pagination utilisé pour récupérer la page de résultats suivante. Transmettez le contenu de cette chaîne en tant qu'attribut |
totalResultsCount |
Nombre total de résultats correspondant à la requête en ignorant la clause LIMIT. |
fieldMask |
FieldMask qui représente les champs demandés par l'utilisateur. Il s'agit d'une liste de noms complets de champs séparés par une virgule. Exemple : |
summaryRow |
Ligne récapitulative contenant un résumé des métriques dans les résultats. Le résumé des métriques signifie l'agrégation des métriques pour tous les résultats. Ici, l'agrégation peut être somme, moyenne, taux, etc. |
Champs d'application des autorisations
Requiert le niveau d'accès OAuth suivant :
https://www.googleapis.com/auth/adwords
Pour en savoir plus, consultez la présentation d'OAuth 2.0.