Method: projects.locations.privateOffers.documents.list

Liste les PrivateOfferDocuments pour le parent donné.

Requête HTTP

GET https://commerceproducer.googleapis.com/v1beta/{parent=projects/*/locations/*/privateOffers/*}/documents

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Valeur parent pour ListPrivateOfferDocumentsRequest.

Paramètres de requête

Paramètres
pageSize

integer

Facultatif. Nombre maximal de résultats à renvoyer. Le service peut renvoyer un nombre inférieur à cette valeur. La valeur maximale est 500. Les valeurs supérieures à 500 sont forcées à 500. Si aucune valeur n'est spécifiée, le serveur utilise la valeur maximale par défaut.
pageToken

string

Facultatif. Jeton de page reçu d'un message de réponse de liste précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres de la requête de liste doivent correspondre à la requête qui a renvoyé le jeton de page.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse à la liste des PrivateOfferDocuments

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "privateOfferDocuments": [
    {
      object (PrivateOfferDocument)
    }
  ],
  "nextPageToken": string
}
Champs
privateOfferDocuments[]

object (PrivateOfferDocument)

Liste des PrivateOfferDocuments.
nextPageToken

string

Jeton pouvant être envoyé en tant que pageToken pour récupérer la page suivante. Si ce champ est omis, il n'y a pas d'autres pages.

Niveaux d'accès des autorisations

Requiert le niveau d'accès OAuth suivant :

  • https://www.googleapis.com/auth/cloud-platform

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • commerceproducer.privateOfferDocuments.list

Pour en savoir plus, consultez la documentation IAM.