Method: customers.googleAds.searchStream

Renvoie toutes les lignes correspondant à la requête du 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/v19/customers/{customerId}/googleAds:searchStream

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
customerId

string

Obligatoire. ID du client faisant l'objet de la requête.

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 est renvoyée. Par défaut, la ligne récapitulative n'est pas renvoyée. Si vous le demandez, la ligne récapitulative sera envoyée seule dans une réponse une fois tous les autres résultats de la requête renvoyés.

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 signifie l'agrégation des métriques pour l'ensemble des résultats. L'agrégation peut être la somme, la moyenne, le taux, etc.
requestId

string

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

string (int64 format)

Quantité de ressources consommées pour traiter la requête. queryResourceConsumption pour la ligne "Résumé" et les réponses autres que le résumé sont renvoyées séparément dans leurs lignes respectives. queryResourceConsumption pour les réponses autres que le résumé est renvoyé 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 OAuth 2.0 Overview.

SummaryRowSetting

Énumération décrivant les paramètres de la ligne récapitulative des retours.

Enums
UNSPECIFIED Non spécifié.
UNKNOWN Représente les valeurs inconnues de la ligne récapitulative des retours.
NO_SUMMARY_ROW Ne pas renvoyer de ligne récapitulative.
SUMMARY_ROW_WITH_RESULTS Renvoie la ligne récapitulative avec les résultats. La ligne récapitulative ne sera renvoyée que dans le dernier lot (qui ne contiendra aucun résultat).
SUMMARY_ROW_ONLY Renvoyez uniquement la ligne récapitulative et aucun résultat.