Method: advertisers.creatives.list

광고주의 광고 소재를 표시합니다.

순서는 orderBy 매개변수로 정의됩니다. entityStatusfilter가 지정되지 않으면 ENTITY_STATUS_ARCHIVED가 있는 광고 소재가 결과에 포함되지 않습니다.

HTTP 요청

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

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

경로 매개변수

매개변수
advertiserId

string (int64 format)

필수 항목입니다. 광고 소재를 표시할 광고주의 ID입니다.

쿼리 매개변수

매개변수
pageSize

integer

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

pageToken

string

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

orderBy

string

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

  • creativeId(기본)
  • createTime
  • mediaDuration
  • dimensions(너비를 기준으로 먼저 정렬한 다음 높이를 기준으로 정렬)

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

filter

string

광고 소재 라벨로 필터링할 수 있습니다.

지원되는 구문:

  • 필터 표현식은 하나 이상의 제한으로 구성됩니다.
  • 제한 조건은 AND 또는 OR 논리 연산자를 사용하여 결합할 수 있습니다. 제약 조건의 시퀀스는 AND를 암시적으로 사용합니다.
  • 제한은 {field} {operator} {value} 형식입니다.
  • lineItemIds 필드는 HAS (:) 연산자를 사용해야 합니다.
  • updateTime 필드는 GREATER THAN OR EQUAL TO (>=) 또는 LESS THAN OR EQUAL TO (<=) 연산자를 사용해야 합니다.
  • 다른 모든 필드는 EQUALS (=) 연산자를 사용해야 합니다.
  • entityStatus, minDuration, maxDuration, updateTime, dynamic 필드의 경우 제한사항이 최대 1개 있을 수 있습니다.

지원되는 필드:

  • approvalStatus
  • creativeId
  • creativeType
  • dimensions({width}x{height} 형식의 입력)
  • dynamic
  • entityStatus
  • exchangeReviewStatus ({exchange}-{reviewStatus} 형식으로 입력)
  • lineItemIds
  • maxDuration({duration}s 형식의 입력) 초만 지원됨)
  • minDuration({duration}s 형식의 입력) 초만 지원됨)
  • updateTime(ISO 8601 형식 또는 YYYY-MM-DDTHH:MM:SSZ으로 입력)

참고:

  • updateTime의 경우 광고 소재 리소스의 필드 값은 광고 소재가 마지막으로 업데이트된 시간을 반영하며 여기에는 시스템에서 실행한 업데이트(예: 광고 소재 검토 업데이트)도 포함됩니다.

예:

  • 모든 네이티브 광고 소재: creativeType="CREATIVE_TYPE_NATIVE"
  • 크기가 300x400 또는 50x100인 모든 활성 광고 소재: entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")
  • AdX 또는 AppNexus에서 승인한 모든 동적 광고 소재(최소 재생 시간 5초 200밀리초): dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")
  • 광고 항목 ID 1 또는 2와 연결된 모든 동영상 광고 소재: creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)
  • 여러 광고 소재 ID로 광고 소재 찾기: creativeId=1 OR creativeId=2
  • 업데이트 시간이 2020-11-04T18:54:47Z (ISO 8601 형식) 이상인 모든 광고 소재: updateTime>="2020-11-04T18:54:47Z"

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

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

요청 본문

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

응답 본문

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

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

object (Creative)

광고 소재 목록입니다.

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

nextPageToken

string

결과의 다음 페이지를 검색하는 토큰입니다. 이후 ListCreativesRequest 메서드 호출에서 pageToken 필드에 이 값을 전달하여 결과의 다음 페이지를 검색합니다. 이 필드가 null이면 마지막 페이지를 의미합니다.

승인 범위

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

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

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