Method: customers.searchAds360.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://searchads360.googleapis.com/v0/customers/{customerId}/searchAds360:search

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,
  "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 aucun jeton n'est spécifié, la première page de résultats est renvoyée. Utilisez la valeur obtenue à partir de nextPageToken dans la réponse précédente pour demander la page de résultats suivante.
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, est inclus dans la réponse. La valeur par défaut est "false".
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 la requête ont été renvoyés.

Corps de la réponse

Message de réponse pour SearchAds360Service.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 (SearchAds360Row)
    }
  ],
  "nextPageToken": string,
  "totalResultsCount": string,
  "fieldMask": string,
  "summaryRow": {
    object (SearchAds360Row)
  },
  "customColumnHeaders": [
    {
      object (CustomColumnHeader)
    }
  ],
  "conversionCustomMetricHeaders": [
    {
      object (ConversionCustomMetricHeader)
    }
  ],
  "conversionCustomDimensionHeaders": [
    {
      object (ConversionCustomDimensionHeader)
    }
  ],
  "rawEventConversionMetricHeaders": [
    {
      object (RawEventConversionMetricHeader)
    }
  ],
  "rawEventConversionDimensionHeaders": [
    {
      object (RawEventConversionDimensionHeader)
    }
  ]
}
Champs
results[]

object (SearchAds360Row)

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

Ligne de résumé contenant un résumé des métriques dans les résultats. Le résumé des métriques correspond à l'agrégation des métriques sur tous les résultats. Ici, 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 des dimensions personnalisées 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.

Niveaux d'accès des autorisations

Requiert le champ d'application OAuth suivant :

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