Method: partners.list

현재 사용자가 액세스할 수 있는 파트너를 나열합니다.

순서는 orderBy 매개변수로 정의됩니다.

HTTP 요청

GET https://displayvideo.googleapis.com/v3/partners

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

쿼리 매개변수

매개변수
pageSize

integer

요청한 페이지 크기입니다. 1~200의 값이어야 합니다. 지정하지 않으면 기본값은 100입니다.
pageToken

string

서버에서 반환할 결과 페이지를 식별하는 토큰입니다. 일반적으로 이는 이전 partners.list 메서드 호출에서 반환된 nextPageToken 값입니다. 지정하지 않으면 결과의 첫 번째 페이지가 반환됩니다.
orderBy

string

목록을 정렬할 필드입니다. 사용 가능한 값:

  • displayName

기본 정렬 순서는 오름차순입니다. 필드에서 내림차순으로 지정하려면 서픽스 'desc'를 필드 이름에 추가해야 합니다. 예를 들면 displayName desc입니다.
filter

string

파트너 필드별로 필터링할 수 있습니다.

지원되는 구문:

  • 필터 표현식은 하나 이상의 제한으로 구성됩니다.
  • 제한 조건은 AND 또는 OR 논리 연산자를 사용하여 결합할 수 있습니다. 제약 조건의 시퀀스는 AND를 암시적으로 사용합니다.
  • 제한은 {field} {operator} {value} 형식입니다.
  • 모든 필드는 EQUALS (=) 연산자를 사용해야 합니다.

지원되는 필드:

  • entityStatus

예:

  • 모든 활성 파트너: entityStatus="ENTITY_STATUS_ACTIVE"

이 필드의 길이는 500자(영문 기준) 이하여야 합니다.

자세한 내용은 LIST 요청 필터링 가이드를 참고하세요.

요청 본문

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

응답 본문

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

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

object (Partner)

파트너 목록입니다.

비어 있으면 이 목록이 표시되지 않습니다.
nextPageToken

string

결과의 다음 페이지를 검색하는 토큰입니다. 이후 partners.list 메서드 호출에서 pageToken 필드에 이 값을 전달하여 결과의 다음 페이지를 검색합니다.

승인 범위

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

  • https://www.googleapis.com/auth/display-video

자세한 내용은 OAuth 2.0 개요를 참고하세요.