Method: projects.locations.privateOffers.documents.list

Lista PrivateOfferDocuments para o recurso pai especificado.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. Valor principal para ListPrivateOfferDocumentsRequest.

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. Número máximo de resultados a serem retornados. O serviço pode retornar um valor inferior a este. O valor máximo é 500. Valores maiores serão convertidos para 500. Se não for especificado, o servidor vai usar o valor máximo.
pageToken

string

Opcional. Um token de página recebido de uma mensagem de resposta de lista anterior. Forneça isso para recuperar a página subsequente.

Na paginação, todos os outros parâmetros da solicitação de lista precisam corresponder à solicitação que retornou o token da página.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta para listar PrivateOfferDocuments

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "privateOfferDocuments": [
    {
      object (PrivateOfferDocument)
    }
  ],
  "nextPageToken": string
}
Campos
privateOfferDocuments[]

object (PrivateOfferDocument)

A lista de PrivateOfferDocuments.
nextPageToken

string

Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • commerceproducer.privateOfferDocuments.list

Para mais informações, consulte a documentação do IAM.