Method: advertisers.campaigns.list

광고주의 캠페인을 나열합니다.

순서는 orderBy 매개변수로 정의됩니다. entityStatus의 filter를 지정하지 않으면 ENTITY_STATUS_ARCHIVED이(가) 포함된 캠페인은 결과에 포함되지 않습니다.

HTTP 요청

GET https://displayvideo.googleapis.com/v2/advertisers/{advertiserId}/campaigns

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

경로 매개변수

매개변수
advertiserId

string (int64 format)

캠페인을 나열할 광고주의 ID입니다.

쿼리 매개변수

매개변수
pageSize

integer

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

string

서버에서 반환할 결과 페이지를 식별하는 토큰입니다. 일반적으로 이전 campaigns.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)

예:

  • 광고주의 모든 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 표현 
{
  "campaigns": [
    {
      object (Campaign)
    }
  ],
  "nextPageToken": string
}
필드
campaigns[]

object (Campaign)

캠페인 목록입니다.

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

string

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

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

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