Method: advertisers.insertionOrders.list

광고주의 게재 신청서를 나열합니다.

순서는 orderBy 매개변수로 정의됩니다. filter x entityStatus이 지정되지 않으면 ENTITY_STATUS_ARCHIVED이 있는 삽입 주문이 결과에 포함되지 않습니다.

HTTP 요청

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/insertionOrders

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

경로 매개변수

매개변수
advertiserId

string (int64 format)

필수 항목입니다. 게재 신청서를 나열할 광고주의 ID입니다.

쿼리 매개변수

매개변수
pageSize

integer

요청한 페이지 크기입니다. 1~100의 값이어야 합니다. 지정하지 않으면 기본값은 100입니다. 잘못된 값이 지정되면 오류 코드 INVALID_ARGUMENT를 반환합니다.
pageToken

string

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

string

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

  • 'displayName' (기본값)
  • 'entityStatus'
  • 'updateTime'

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

string

게재 신청서 필드로 필터링할 수 있습니다.

지원되는 문법:

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

지원되는 필드:

  • campaignId
  • displayName
  • entityStatus
  • updateTime (ISO 8601 형식 또는 YYYY-MM-DDTHH:MM:SSZ으로 입력)

예:

  • 캠페인에 속한 모든 게재 신청서: campaignId="1234"
  • 광고주에 속한 모든 ENTITY_STATUS_ACTIVE 또는 ENTITY_STATUS_PAUSED 게재 신청서: (entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • 업데이트 시간이 2020-11-04T18:54:47Z (ISO 8601 형식) 이하인 모든 삽입 주문: updateTime<="2020-11-04T18:54:47Z"
  • 업데이트 시간이 2020-11-04T18:54:47Z (ISO 8601 형식) 이상인 모든 삽입 주문: updateTime>="2020-11-04T18:54:47Z"

이 필드의 길이는 500자(영문 기준)를 초과할 수 없습니다.

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

요청 본문

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

응답 본문

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

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

object (InsertionOrder)

게재 신청서 목록입니다.

비어 있으면 이 목록이 없습니다.
nextPageToken

string

결과의 다음 페이지를 검색하는 토큰입니다. 결과의 다음 페이지를 가져오려면 insertionOrders.list 메서드에 대한 후속 호출의 pageToken 필드에 이 값을 전달하세요.

승인 범위

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

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

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