Method: customers.googleAds.search

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/v16/customers/{customerId}/googleAds:search

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
customerId

string

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 (SummaryRowSetting)
}
Champs
query

string

Obligatoire. Chaîne de requête.
pageToken

string

Jeton de la page à récupérer. Si aucune valeur n'est spécifiée, la première page de résultats est affichée. Pour demander la page de résultats suivante, utilisez la valeur obtenue à partir de nextPageToken dans la réponse précédente.
pageSize

integer

Nombre d'éléments à récupérer sur une seule page. Lorsqu'une page trop volumineuse est demandée, le serveur peut décider de limiter davantage le nombre de ressources renvoyées.
validateOnly

boolean

Si la valeur est "true", la requête est validée, mais pas exécutée.
returnTotalResultsCount

boolean

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

enum (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 après le renvoi de tous les autres résultats de requête.

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 (GoogleAdsRow)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string,
  "fieldMask": string,
  "summaryRow": {
    object (GoogleAdsRow)
  },
  "queryResourceConsumption": string
}
Champs
results[]

object (GoogleAdsRow)

Liste des lignes correspondant à la requête.
nextPageToken

string

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 pageToken de la requête suivante. nextPageToken n'est pas renvoyé pour la dernière page.
totalResultsCount

string (int64 format)

Nombre total de résultats correspondant à la requête en ignorant la clause LIMIT.
fieldMask

string (FieldMask format)

FieldMask, qui représente les champs demandés par l'utilisateur.

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo"
summaryRow

object (GoogleAdsRow)

Ligne récapitulative contenant un résumé des métriques dans les résultats. Le résumé des métriques correspond à l'agrégation des métriques de tous les résultats. Ici, l'agrégation peut être la somme, la moyenne, le taux, etc.
queryResourceConsumption

string (int64 format)

Quantité de ressources consommées pour répondre à la requête.

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.