Method: customers.searchAds360.searchStream

Renvoie toutes les lignes correspondant à la requête du flux de recherche.

Liste des erreurs générées: AuthenticationError AuthorizationError HeaderError InternalError QueryError QuotaError RequestError

Requête HTTP

POST https://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360: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,
  "batchSize": integer,
  "summaryRowSetting": enum (SummaryRowSetting)
}
Champs
query

string

Obligatoire. Chaîne de requête.
batchSize

integer

Nombre de lignes renvoyées dans chaque lot de réponse de flux. Lorsque le lot demandé est trop volumineux, le serveur peut décider de limiter davantage le nombre de lignes renvoyées.
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 elle est demandée, la ligne de résumé est 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 SearchAds360Service.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 (SearchAds360Row)
    }
  ],
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ],
  "requestId": string
}
Champs
results[]

object (SearchAds360Row)

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 (SearchAds360Row)

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.
customColumnHeaders[]

object (CustomColumnHeader)

En-têtes des colonnes personnalisées dans les résultats.
conversionCustomMetricHeaders[]

object (ConversionCustomMetricHeader)

En-têtes des métriques personnalisées de conversion dans les résultats.
conversionCustomDimensionHeaders[]

object (ConversionCustomDimensionHeader)

En-têtes de la dimension personnalisée de conversion dans les résultats.
rawEventConversionMetricHeaders[]

object (RawEventConversionMetricHeader)

En-têtes des métriques de conversion d'événement bruts dans les résultats.
rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

En-têtes des dimensions de conversion d'événement brutes dans les résultats.
requestId

string

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

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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