Method: customers.googleAds.searchStream

Renvoie toutes les lignes correspondant à la requête de flux 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:searchStream

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,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Champs
query

string

Obligatoire. Chaîne de requête.
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.SearchStream.

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

object (GoogleAdsRow)

Liste des lignes correspondant à la requête.
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.
requestId

string

Identifiant unique de la requête utilisé à des fins de débogage.
queryResourceConsumption

string (int64 format)

Quantité de ressources consommées pour répondre à la requête. queryResourceConsumption pour la ligne récapitulative et les réponses non récapitulatives sont renvoyées séparément dans leurs lignes respectives. queryResourceConsumption pour les réponses non récapitulatives est renvoyée dans le dernier lot de résultats.

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.