Method: customers.searchAds360.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://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 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,
  "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. Si un lot trop volumineux est demandé, le serveur peut décider de limiter davantage le nombre de lignes renvoyées.
summaryRowSetting

enum (SummaryRowSetting)

Détermine si une ligne de résumé sera renvoyée. Par défaut, la ligne de résumé n'est pas renvoyée. Si elle est demandée, la ligne de résumé est envoyée dans une réponse distincte une fois que tous les autres résultats de requête ont été renvoyés.

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 représentant 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 de résumé contenant le résumé des métriques dans les résultats. Le résumé des métriques correspond à l'agrégation des métriques dans tous les résultats. L'agrégation peut être une somme, une moyenne, un 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énements bruts dans les résultats.
rawEventConversionDimensionHeaders[]

object (RawEventConversionDimensionHeader)

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

string

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

Niveaux d'accès des autorisations

Requiert le champ d'application OAuth suivant :

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