Method: projects.locations.privateOffers.documents.list

지정된 상위 항목의 PrivateOfferDocuments를 나열합니다.

HTTP 요청

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

URL은 gRPC 트랜스코딩 문법을 사용합니다.

경로 매개변수

매개변수
parent

string

필수 항목입니다. ListPrivateOfferDocumentsRequest의 상위 값입니다.

쿼리 파라미터

파라미터
pageSize

integer

선택사항입니다. 반환할 최대 결과 수입니다. 서비스가 이 값보다 더 적게 반환할 수 있습니다. 최댓값은 500이며, 500을 초과하는 값은 500으로 변환됩니다. 지정하지 않으면 서버에서 최댓값을 기본값으로 사용합니다.
pageToken

string

선택사항입니다. 이전 목록 응답 메시지에서 수신된 페이지 토큰입니다. 후속 페이지를 검색하려면 이를 입력합니다.

페이지를 나눌 때는 목록 요청의 다른 모든 매개변수가 페이지 토큰을 반환한 요청과 일치해야 합니다.

요청 본문

요청 본문은 비어 있어야 합니다.

응답 본문

PrivateOfferDocuments 나열에 대한 응답 메시지입니다.

성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.

JSON 표현 
{
  "privateOfferDocuments": [
    {
      object (PrivateOfferDocument)
    }
  ],
  "nextPageToken": string
}
필드
privateOfferDocuments[]

object (PrivateOfferDocument)

PrivateOfferDocuments의 목록입니다.
nextPageToken

string

다음 페이지를 검색하기 위해 pageToken으로 전송할 수 있는 토큰입니다. 이 필드를 생략하면 후속 페이지가 표시되지 않습니다.

승인 범위

다음 OAuth 범위가 필요합니다.

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

자세한 내용은 Authentication Overview를 참조하세요.

IAM 권한

parent 리소스에 대해서는 다음 IAM 권한이 필요합니다.

  • commerceproducer.privateOfferDocuments.list

자세한 내용은 IAM 문서를 참조하세요.