Method: projects.locations.privateOffers.documents.list

Enumera los PrivateOfferDocuments para el elemento superior determinado.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
parent

string

Obligatorio. Es el valor principal de ListPrivateOfferDocumentsRequest.

Parámetros de consulta

Parámetros
pageSize

integer

Es opcional. Cantidad máxima de resultados que se devolverán. El servicio puede mostrar menos que este valor. El valor máximo es 500, y los valores superiores se convertirán a 500. Si no se especifica, el servidor usará el valor máximo de forma predeterminada.
pageToken

string

Es opcional. Es un token de página que se recibió de un mensaje de respuesta de lista anterior. Proporciona esto para recuperar la página siguiente.

Cuando se realiza la paginación, todos los demás parámetros de la solicitud de lista deben coincidir con la solicitud que devolvió el token de página.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Mensaje para la respuesta a la lista de PrivateOfferDocuments

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON 
{
  "privateOfferDocuments": [
    {
      object (PrivateOfferDocument)
    }
  ],
  "nextPageToken": string
}
Campos
privateOfferDocuments[]

object (PrivateOfferDocument)

Es la lista de PrivateOfferDocuments.
nextPageToken

string

Un token, que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

Alcances de autorización

Requiere el siguiente permiso de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso parent:

  • commerceproducer.privateOfferDocuments.list

Para obtener más información, consulta la documentación de IAM.