본문으로 건너뛰기
API docs by Redocly

성과 API

Download OpenAPI specification:Download

GFA 광고 계정 / 캠페인 / 광고 그룹 / 소재 단위로 과거 및 실시간 성과를 조회할 수 있습니다.

과거 성과 조회

특정 광고 계정 / 캠페인 / 광고 그룹 / 소재의 과거 성과를 조회합니다.

조회 단위보다 하위 요소로 집계한 결과가 제공되며, 성과는 날짜, 광고주, 캠페인, 광고 그룹, 소재 번호 순으로 오름차순 정렬되어 제공됩니다.

조회 기간은 최대 31일이며, 2년 전부터 전일 데이터까지 조회가 가능합니다. (전일 데이터는 금일 02시부터 조회가 가능합니다.)

한 번에 최대 1000개 까지 조회가 가능하며, 이를 초과하는 개수가 존재하는 경우 페이징이 적용됩니다. 응답의 next 필드 값을 다음 요청의 next 파라미터로 포함시키면 다음 페이지를 조회할 수 있으며, 해당 토큰은 10분간 유효합니다.

광고 계정 과거 성과 조회

특정 광고 계정의 과거 성과를 캠페인 / 광고 그룹 / 소재 단위로 집계하여 조회합니다.

path Parameters
aggregationType
required
string
Enum: "campaigns" "adSets" "creatives"

성과 집계 단위 ( 캠페인 : campaigns, 광고 그룹 : adSets, 소재 : creatives )

version
required
float
Default: "1.0"

API 버전

adAccountNo
required
integer <int64>
Example: 1234

광고 계정 번호

query Parameters
startDate
required
string <date>
Example: startDate=2023-01-01

조회 시작일 (yyyy-MM-dd 형식)

endDate
required
string <date>
Example: endDate=2023-01-30

조회 종료일 (yyyy-MM-dd 형식)

next
string
Example: next=zwMvjK6XRhyiJoFGZZkqhw:1707978058060

다음 페이지 조회를 위한 토큰

limit
int
Default: "1000"

조회할 레코드 수

timeUnit
string
Default: "daily"
Enum: "daily" "hourly"

조회 시간 단위 ( 일자별 : daily, 시간별 : hourly )

header Parameters
AccessManagerAccountNo
required
integer <int64>

해당 광고 계정의 성과에 대한 접근 권한이 있는 관리 계정 번호

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "next": "string"
}

소재 과거 성과 조회

특정 소재의 과거 성과를 조회합니다.

path Parameters
creativeNo
required
integer <int64>
Example: 5678

소재 번호

aggregationType
required
string
Value: "creatives"

성과 집계 단위 ( 소재 : creatives )

version
required
float
Default: "1.0"

API 버전

adAccountNo
required
integer <int64>
Example: 1234

광고 계정 번호

query Parameters
startDate
required
string <date>
Example: startDate=2023-01-01

조회 시작일 (yyyy-MM-dd 형식)

endDate
required
string <date>
Example: endDate=2023-01-30

조회 종료일 (yyyy-MM-dd 형식)

next
string
Example: next=zwMvjK6XRhyiJoFGZZkqhw:1707978058060

다음 페이지 조회를 위한 토큰

limit
int
Default: "1000"

조회할 레코드 수

timeUnit
string
Default: "daily"
Enum: "daily" "hourly"

조회 시간 단위 ( 일자별 : daily, 시간별 : hourly )

header Parameters
AccessManagerAccountNo
required
integer <int64>

해당 광고 계정의 성과에 대한 접근 권한이 있는 관리 계정 번호

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "next": "string"
}

캠페인 과거 성과 조회

특정 캠페인의 과거 성과를 광고 그룹 / 소재 단위로 집계하여 조회합니다.

path Parameters
campaignNo
required
integer <int64>
Example: 5678

캠페인 번호

aggregationType
required
string
Enum: "adSets" "creatives"

성과 집계 단위 ( 광고 그룹 : adSets, 소재 : creatives )

version
required
float
Default: "1.0"

API 버전

adAccountNo
required
integer <int64>
Example: 1234

광고 계정 번호

query Parameters
startDate
required
string <date>
Example: startDate=2023-01-01

조회 시작일 (yyyy-MM-dd 형식)

endDate
required
string <date>
Example: endDate=2023-01-30

조회 종료일 (yyyy-MM-dd 형식)

next
string
Example: next=zwMvjK6XRhyiJoFGZZkqhw:1707978058060

다음 페이지 조회를 위한 토큰

limit
int
Default: "1000"

조회할 레코드 수

timeUnit
string
Default: "daily"
Enum: "daily" "hourly"

조회 시간 단위 ( 일자별 : daily, 시간별 : hourly )

header Parameters
AccessManagerAccountNo
required
integer <int64>

해당 광고 계정의 성과에 대한 접근 권한이 있는 관리 계정 번호

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "next": "string"
}

광고 그룹 과거 성과 조회

특정 광고 그룹의 과거 성과를 소재 단위로 집계하여 조회합니다.

path Parameters
adSetNo
required
integer <int64>
Example: 5678

광고 그룹 번호

aggregationType
required
string
Value: "creatives"

성과 집계 단위 ( 소재 : creatives )

version
required
float
Default: "1.0"

API 버전

adAccountNo
required
integer <int64>
Example: 1234

광고 계정 번호

query Parameters
startDate
required
string <date>
Example: startDate=2023-01-01

조회 시작일 (yyyy-MM-dd 형식)

endDate
required
string <date>
Example: endDate=2023-01-30

조회 종료일 (yyyy-MM-dd 형식)

next
string
Example: next=zwMvjK6XRhyiJoFGZZkqhw:1707978058060

다음 페이지 조회를 위한 토큰

limit
int
Default: "1000"

조회할 레코드 수

timeUnit
string
Default: "daily"
Enum: "daily" "hourly"

조회 시간 단위 ( 일자별 : daily, 시간별 : hourly )

header Parameters
AccessManagerAccountNo
required
integer <int64>

해당 광고 계정의 성과에 대한 접근 권한이 있는 관리 계정 번호

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "next": "string"
}

실시간 성과 조회

특정 광고 계정 / 캠페인 / 광고 그룹 / 소재의 실시간 성과를 소재 단위로 조회합니다.

오늘 또는 어제 데이터를 조회할 수 있으며, 성과는 업데이트 시점을 기준으로 오름차순 정렬되어 제공됩니다.

응답의 until 필드 값을 다음 요청의 since 파라미터로 포함시키면 이전 요청 시점 이후에 업데이트된 소재만을 조회할 수 있습니다.

실시간 성과는 조회 시점 이후라도 정합성 검증 및 보정 작업에 따라 변동이 발생할 수 있습니다.

광고 계정 실시간 성과 조회

특정 광고 계정의 실시간 성과를 조회합니다.

path Parameters
version
required
float
Default: "1.0"

API 버전

adAccountNo
required
integer <int64>
Example: 1234

광고 계정 번호

query Parameters
targetDate
string
Default: "today"
Enum: "today" "yesterday"

조회 대상 일자 ( 오늘 : today, 어제 : yesterday )

since
integer <int64>
Example: since=1675907423

특정 시점 이후 성과가 업데이트된 소재만을 조회하기 위한 타임스탬프

timeUnit
string
Default: "daily"
Enum: "daily" "hourly"

조회 시간 단위 ( 일자별 : daily, 시간별 : hourly )

header Parameters
AccessManagerAccountNo
required
integer <int64>

해당 광고 계정의 성과에 대한 접근 권한이 있는 관리 계정 번호

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "until": 0
}

소재 실시간 성과 조회

특정 소재의 실시간 성과를 조회합니다.

path Parameters
creativeNo
required
integer <int64>
Example: 5678

소재 번호

version
required
float
Default: "1.0"

API 버전

adAccountNo
required
integer <int64>
Example: 1234

광고 계정 번호

query Parameters
targetDate
string
Default: "today"
Enum: "today" "yesterday"

조회 대상 일자 ( 오늘 : today, 어제 : yesterday )

since
integer <int64>
Example: since=1675907423

특정 시점 이후 성과가 업데이트된 소재만을 조회하기 위한 타임스탬프

timeUnit
string
Default: "daily"
Enum: "daily" "hourly"

조회 시간 단위 ( 일자별 : daily, 시간별 : hourly )

header Parameters
AccessManagerAccountNo
required
integer <int64>

해당 광고 계정의 성과에 대한 접근 권한이 있는 관리 계정 번호

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "until": 0
}

캠페인 실시간 성과 조회

특정 캠페인의 실시간 성과를 조회합니다.

path Parameters
campaignNo
required
integer <int64>
Example: 5678

캠페인 번호

version
required
float
Default: "1.0"

API 버전

adAccountNo
required
integer <int64>
Example: 1234

광고 계정 번호

query Parameters
targetDate
string
Default: "today"
Enum: "today" "yesterday"

조회 대상 일자 ( 오늘 : today, 어제 : yesterday )

since
integer <int64>
Example: since=1675907423

특정 시점 이후 성과가 업데이트된 소재만을 조회하기 위한 타임스탬프

timeUnit
string
Default: "daily"
Enum: "daily" "hourly"

조회 시간 단위 ( 일자별 : daily, 시간별 : hourly )

header Parameters
AccessManagerAccountNo
required
integer <int64>

해당 광고 계정의 성과에 대한 접근 권한이 있는 관리 계정 번호

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "until": 0
}

광고 그룹 실시간 성과 조회

특정 광고 그룹의 실시간 성과를 조회합니다.

path Parameters
adSetNo
required
integer <int64>
Example: 5678

광고 그룹 번호

version
required
float
Default: "1.0"

API 버전

adAccountNo
required
integer <int64>
Example: 1234

광고 계정 번호

query Parameters
targetDate
string
Default: "today"
Enum: "today" "yesterday"

조회 대상 일자 ( 오늘 : today, 어제 : yesterday )

since
integer <int64>
Example: since=1675907423

특정 시점 이후 성과가 업데이트된 소재만을 조회하기 위한 타임스탬프

timeUnit
string
Default: "daily"
Enum: "daily" "hourly"

조회 시간 단위 ( 일자별 : daily, 시간별 : hourly )

header Parameters
AccessManagerAccountNo
required
integer <int64>

해당 광고 계정의 성과에 대한 접근 권한이 있는 관리 계정 번호

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "until": 0
}

과거 전환 성과 조회

특정 광고 계정 / 캠페인 / 광고 그룹 / 소재의 과거 전환 성과를 조회합니다.

조회 단위보다 하위 요소로 집계한 결과가 제공되며, 성과는 날짜, 광고주, 캠페인, 광고 그룹, 소재 번호 순으로 오름차순 정렬되어 제공됩니다.

조회 기간은 최대 31일이며, 2년 전부터 전일 데이터까지 조회가 가능합니다. (전일 데이터는 금일 02시부터 조회가 가능합니다.)

한 번에 최대 1000개 까지 조회가 가능하며, 이를 초과하는 개수가 존재하는 경우 페이징이 적용됩니다. 응답의 next 필드 값을 다음 요청의 next 파라미터로 포함시키면 다음 페이지를 조회할 수 있으며, 해당 토큰은 10분간 유효합니다.

전환 성과는 시간 단위 조회를 지원하지 않으며 일별 조회만 가능하며, 응답의 convType, convPartner 필드에 대한 설명은 '시작하기 > 성과 관리 > 전환 성과 조회' 페이지를 참고해주세요.

광고 계정 과거 전환 성과 조회

특정 광고 계정의 과거 전환 성과를 캠페인 / 광고 그룹 / 소재 단위로 집계하여 조회합니다.

path Parameters
aggregationType
required
string
Enum: "campaigns" "adSets" "creatives"

성과 집계 단위 ( 캠페인 : campaigns, 광고 그룹 : adSets, 소재 : creatives )

version
required
float
Default: "1.0"

API 버전

adAccountNo
required
integer <int64>
Example: 1234

광고 계정 번호

query Parameters
timeUnit
string
Default: "daily"
Value: "daily"

조회 시간 단위 ( 일자별 : daily )

startDate
required
string <date>
Example: startDate=2023-01-01

조회 시작일 (yyyy-MM-dd 형식)

endDate
required
string <date>
Example: endDate=2023-01-30

조회 종료일 (yyyy-MM-dd 형식)

next
string
Example: next=zwMvjK6XRhyiJoFGZZkqhw:1707978058060

다음 페이지 조회를 위한 토큰

limit
int
Default: "1000"

조회할 레코드 수

header Parameters
AccessManagerAccountNo
required
integer <int64>

해당 광고 계정의 성과에 대한 접근 권한이 있는 관리 계정 번호

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "next": "string"
}

소재 과거 전환 성과 조회

특정 소재의 과거 전환 성과를 조회합니다.

path Parameters
creativeNo
required
integer <int64>
Example: 5678

소재 번호

aggregationType
required
string
Value: "creatives"

성과 집계 단위 ( 소재 : creatives )

version
required
float
Default: "1.0"

API 버전

adAccountNo
required
integer <int64>
Example: 1234

광고 계정 번호

query Parameters
timeUnit
string
Default: "daily"
Value: "daily"

조회 시간 단위 ( 일자별 : daily )

startDate
required
string <date>
Example: startDate=2023-01-01

조회 시작일 (yyyy-MM-dd 형식)

endDate
required
string <date>
Example: endDate=2023-01-30

조회 종료일 (yyyy-MM-dd 형식)

next
string
Example: next=zwMvjK6XRhyiJoFGZZkqhw:1707978058060

다음 페이지 조회를 위한 토큰

limit
int
Default: "1000"

조회할 레코드 수

header Parameters
AccessManagerAccountNo
required
integer <int64>

해당 광고 계정의 성과에 대한 접근 권한이 있는 관리 계정 번호

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "next": "string"
}

캠페인 과거 전환 성과 조회

특정 캠페인의 과거 전환 성과를 광고 그룹 / 소재 단위로 집계하여 조회합니다.

path Parameters
campaignNo
required
integer <int64>
Example: 5678

캠페인 번호

aggregationType
required
string
Enum: "adSets" "creatives"

성과 집계 단위 ( 광고 그룹 : adSets, 소재 : creatives )

version
required
float
Default: "1.0"

API 버전

adAccountNo
required
integer <int64>
Example: 1234

광고 계정 번호

query Parameters
timeUnit
string
Default: "daily"
Value: "daily"

조회 시간 단위 ( 일자별 : daily )

startDate
required
string <date>
Example: startDate=2023-01-01

조회 시작일 (yyyy-MM-dd 형식)

endDate
required
string <date>
Example: endDate=2023-01-30

조회 종료일 (yyyy-MM-dd 형식)

next
string
Example: next=zwMvjK6XRhyiJoFGZZkqhw:1707978058060

다음 페이지 조회를 위한 토큰

limit
int
Default: "1000"

조회할 레코드 수

header Parameters
AccessManagerAccountNo
required
integer <int64>

해당 광고 계정의 성과에 대한 접근 권한이 있는 관리 계정 번호

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "next": "string"
}

광고 그룹 과거 전환 성과 조회

특정 광고 그룹의 과거 전환 성과를 소재 단위로 집계하여 조회합니다.

path Parameters
adSetNo
required
integer <int64>
Example: 5678

광고 그룹 번호

aggregationType
required
string
Value: "creatives"

성과 집계 단위 ( 소재 : creatives )

version
required
float
Default: "1.0"

API 버전

adAccountNo
required
integer <int64>
Example: 1234

광고 계정 번호

query Parameters
timeUnit
string
Default: "daily"
Value: "daily"

조회 시간 단위 ( 일자별 : daily )

startDate
required
string <date>
Example: startDate=2023-01-01

조회 시작일 (yyyy-MM-dd 형식)

endDate
required
string <date>
Example: endDate=2023-01-30

조회 종료일 (yyyy-MM-dd 형식)

next
string
Example: next=zwMvjK6XRhyiJoFGZZkqhw:1707978058060

다음 페이지 조회를 위한 토큰

limit
int
Default: "1000"

조회할 레코드 수

header Parameters
AccessManagerAccountNo
required
integer <int64>

해당 광고 계정의 성과에 대한 접근 권한이 있는 관리 계정 번호

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "next": "string"
}

실시간 전환 성과 조회

특정 광고 계정 / 캠페인 / 광고 그룹 / 소재의 실시간 전환 성과를 소재 단위로 조회합니다.

오늘 또는 어제 데이터를 조회할 수 있으며, 성과는 업데이트 시점을 기준으로 오름차순 정렬되어 제공됩니다.

응답의 until 필드 값을 다음 요청의 since 파라미터로 포함시키면 이전 요청 시점 이후에 업데이트된 소재만을 조회할 수 있습니다.

실시간 성과는 조회 시점 이후라도 정합성 검증 및 보정 작업에 따라 변동이 발생할 수 있습니다.

전환 성과는 시간 단위 조회를 지원하지 않으며 일별 조회만 가능하며, 응답의 convType, convPartner 필드에 대한 설명은 '시작하기 > 성과 관리 > 전환 성과 조회' 페이지를 참고해주세요.

광고 계정 실시간 전환 성과 조회

특정 광고 계정의 실시간 전환 성과를 조회합니다.

path Parameters
version
required
float
Default: "1.0"

API 버전

adAccountNo
required
integer <int64>
Example: 1234

광고 계정 번호

query Parameters
timeUnit
string
Default: "daily"
Value: "daily"

조회 시간 단위 ( 일자별 : daily )

targetDate
string
Default: "today"
Enum: "today" "yesterday"

조회 대상 일자 ( 오늘 : today, 어제 : yesterday )

since
integer <int64>
Example: since=1675907423

특정 시점 이후 성과가 업데이트된 소재만을 조회하기 위한 타임스탬프

header Parameters
AccessManagerAccountNo
required
integer <int64>

해당 광고 계정의 성과에 대한 접근 권한이 있는 관리 계정 번호

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "until": 0
}

소재 실시간 전환 성과 조회

특정 소재의 실시간 전환 성과를 조회합니다.

path Parameters
creativeNo
required
integer <int64>
Example: 5678

소재 번호

version
required
float
Default: "1.0"

API 버전

adAccountNo
required
integer <int64>
Example: 1234

광고 계정 번호

query Parameters
timeUnit
string
Default: "daily"
Value: "daily"

조회 시간 단위 ( 일자별 : daily )

targetDate
string
Default: "today"
Enum: "today" "yesterday"

조회 대상 일자 ( 오늘 : today, 어제 : yesterday )

since
integer <int64>
Example: since=1675907423

특정 시점 이후 성과가 업데이트된 소재만을 조회하기 위한 타임스탬프

header Parameters
AccessManagerAccountNo
required
integer <int64>

해당 광고 계정의 성과에 대한 접근 권한이 있는 관리 계정 번호

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "until": 0
}

캠페인 실시간 전환 성과 조회

특정 캠페인의 실시간 전환 성과를 조회합니다.

path Parameters
campaignNo
required
integer <int64>
Example: 5678

캠페인 번호

version
required
float
Default: "1.0"

API 버전

adAccountNo
required
integer <int64>
Example: 1234

광고 계정 번호

query Parameters
timeUnit
string
Default: "daily"
Value: "daily"

조회 시간 단위 ( 일자별 : daily )

targetDate
string
Default: "today"
Enum: "today" "yesterday"

조회 대상 일자 ( 오늘 : today, 어제 : yesterday )

since
integer <int64>
Example: since=1675907423

특정 시점 이후 성과가 업데이트된 소재만을 조회하기 위한 타임스탬프

header Parameters
AccessManagerAccountNo
required
integer <int64>

해당 광고 계정의 성과에 대한 접근 권한이 있는 관리 계정 번호

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "until": 0
}

광고 그룹 실시간 전환 성과 조회

특정 광고 그룹의 실시간 전환 성과를 조회합니다.

path Parameters
adSetNo
required
integer <int64>
Example: 5678

광고 그룹 번호

version
required
float
Default: "1.0"

API 버전

adAccountNo
required
integer <int64>
Example: 1234

광고 계정 번호

query Parameters
timeUnit
string
Default: "daily"
Value: "daily"

조회 시간 단위 ( 일자별 : daily )

targetDate
string
Default: "today"
Enum: "today" "yesterday"

조회 대상 일자 ( 오늘 : today, 어제 : yesterday )

since
integer <int64>
Example: since=1675907423

특정 시점 이후 성과가 업데이트된 소재만을 조회하기 위한 타임스탬프

header Parameters
AccessManagerAccountNo
required
integer <int64>

해당 광고 계정의 성과에 대한 접근 권한이 있는 관리 계정 번호

Responses

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "until": 0
}