Method: guaranteedOrders.list

현재 사용자가 액세스할 수 있는 보장된 주문을 나열합니다.

순서는 orderBy 매개변수로 정의됩니다. entityStatus의 filter를 지정하지 않으면 항목 상태가 ENTITY_STATUS_ARCHIVED인 보장 주문이 결과에 포함되지 않습니다.

HTTP 요청

GET https://displayvideo.googleapis.com/v1/guaranteedOrders

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

쿼리 매개변수

매개변수
pageSize

integer

요청한 페이지 크기입니다. 1에서 200 사이여야 합니다. 지정하지 않으면 기본값은 100입니다.
pageToken

string

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

string

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

  • displayName(기본)

기본 정렬 순서는 오름차순입니다. 필드의 내림차순을 지정하려면 접미사 'desc'를 사용하세요. 필드 이름에 추가해야 합니다. 예를 들면 displayName desc입니다.
filter

string

보장된 주문 필드로 필터링할 수 있습니다.

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

지원되는 필드: * guaranteedOrderId * exchange * displayName * status.entityStatus

예:

  • 모든 활성 보장 주문: status.entityStatus="ENTITY_STATUS_ACTIVE"
  • Google Ad Manager 또는 Rubicon 거래소에 속한 보장된 주문: exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"

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

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

통합 매개변수 accessor입니다. 필수 항목입니다.

요청이 이루어진 DV360 항목을 식별합니다. LIST 요청은 accessor에서 식별된 DV360 항목에 액세스할 수 있는 보장된 주문 항목만 반환합니다. accessor은 다음 중 하나여야 합니다.
partnerId

string (int64 format)

보장 주문에 액세스할 수 있는 파트너의 ID입니다.
advertiserId

string (int64 format)

보장 주문에 액세스할 수 있는 광고주의 ID입니다.

요청 본문

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

응답 본문

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

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

object (GuaranteedOrder)

보장된 주문의 목록입니다.

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

string

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

승인 범위

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

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

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