Method: projects.locations.privateOffers.documents.list

Listet PrivateOfferDocuments für das angegebene übergeordnete Element auf.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Übergeordneter Wert für ListPrivateOfferDocumentsRequest.

Suchparameter

Parameter
pageSize

integer

Optional. Maximale Anzahl der zurückzugebenden Ergebnisse. Der Dienst gibt möglicherweise weniger als diesen Wert zurück. Der Maximalwert ist 500. Werte über 500 werden auf 500 festgelegt. Wenn nicht angegeben, verwendet der Server den Standardwert.
pageToken

string

Optional. Ein Seitentoken, das von einer vorherigen Listenantwortnachricht empfangen wurde. Geben Sie dieses an, um die nachfolgende Seite abzurufen.

Beim Paginieren müssen alle anderen Parameter der Listenanfrage mit der Anfrage übereinstimmen, die das Seitentoken zurückgegeben hat.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Nachricht für die Antwort auf die Auflistung von PrivateOfferDocuments

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "privateOfferDocuments": [
    {
      object (PrivateOfferDocument)
    }
  ],
  "nextPageToken": string
}
Felder
privateOfferDocuments[]

object (PrivateOfferDocument)

Die Liste der PrivateOfferDocuments.
nextPageToken

string

Ein Token, das als pageToken gesendet werden kann, um die nächste Seite abzurufen. Wenn dieses Feld weggelassen wird, gibt es keine nachfolgenden Seiten.

Autorisierungsbereiche

Erfordert den folgenden OAuth-Bereich:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource parent:

  • commerceproducer.privateOfferDocuments.list

Weitere Informationen finden Sie in der IAM-Dokumentation.