Method: accounts.reports.search

Récupère un rapport défini par une requête de recherche. La réponse peut contenir moins de lignes que spécifié par pageSize. Utilisez nextPageToken pour déterminer si d'autres lignes doivent être demandées.

Requête HTTP

POST https://merchantapi.googleapis.com/reports/v1beta/{parent=accounts/*}/reports:search

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. ID du compte à l'origine de l'appel. Il doit s'agir d'un compte individuel ou d'un sous-compte de MC. Format: accounts/{account}

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,
  "pageSize": integer,
  "pageToken": string
}
Champs
query

string

Obligatoire. Requête qui définit un rapport à récupérer.

Pour savoir comment créer votre requête, consultez le guide du langage de requête. Pour obtenir la liste complète des tables et des champs disponibles, consultez la section "Champs disponibles".
pageSize

integer

Facultatif. Nombre de ReportRows à récupérer sur une seule page. Valeur par défaut : 1 000. Les valeurs supérieures à 5 000 sont réduites à 5 000.
pageToken

string

Facultatif. Jeton de la page à récupérer. Si cette option n'est pas spécifiée, la première page de résultats est renvoyée. Pour demander la page de résultats suivante, vous devez utiliser la valeur obtenue à partir de nextPageToken dans la réponse précédente.

Corps de la réponse

Message de réponse pour la méthode ReportService.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 (ReportRow)
    }
  ],
  "nextPageToken": string
}
Champs
results[]

object (ReportRow)

Lignes correspondant à la requête de recherche.
nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si cet attribut est omis, aucune page suivante n'existe.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

Pour en savoir plus, consultez la présentation d'OAuth 2.0.