Skip to main content
광고 캠페인은 유료 광고의 최상위 컨테이너입니다. 하위 광고 그룹과 광고가 공유하는 목표와 예산 전략을 설정합니다. Ad Campaigns API를 사용하면 캠페인을 생성하고, 계정의 캠페인을 나열하고, 캠페인 설정을 조회하거나 업데이트하고, 캠페인 게재를 일시 중지하거나 재개할 수 있습니다. 광고 청구는 계정의 모든 캠페인에서 발생한 청구 대상 지출을 합산합니다. 결제가 실패하면 설정된 active/paused status는 유지되지만 delivery_status: payment_failed로 게재가 차단됩니다. 계정의 결제 수단을 수정하고 계정에 대해 광고 결제를 한 번 재시도하세요. 재시도는 비동기적으로 진행되며, 요청이 수락되었다고 해서 결제가 확정된 것은 아닙니다. 정산이 성공하면 차단이 해제되며, 활성 캠페인은 다른 요건을 충족하면 재개될 수 있고 일시 중지된 캠페인은 일시 중지 상태로 유지됩니다. 청구 및 재시도를 참고하세요.

엔드포인트

속성

string
필수
adcamp_ 접두사가 붙은 광고 캠페인의 고유 식별자입니다.
object | null
필수
이 캠페인을 운영하는 비즈니스와, 광고에 표시되는 그 이름 및 로고입니다.

속성

string
필수
biz_ 접두사가 붙은 계정 ID입니다.
string | null
필수
계정 로고 이미지 URL입니다. 계정이 설정하지 않은 경우 null입니다.
string
필수
whop.com/\{route} 스토어프런트 경로에 사용되는 계정의 공개 경로 식별자입니다.
string
필수
계정 표시 이름입니다.
number
필수
장바구니 담기 이벤트에 귀속된 USD 가치입니다. 각 이벤트와 함께 전송된 값을 USD로 정규화해 합산하며, 값이 없는 이벤트는 0으로 계산됩니다.
number
필수
Whop 픽셀에 귀속된 장바구니 담기 이벤트 수(라스트 클릭 기준)입니다.
number | null
필수
캠페인의 예산(USD)으로, 예산이 저장되고 청구되는 통화입니다. 대신 각 광고 그룹이 자체 예산을 설정하면 null입니다.
number | null
필수
계정의 광고 보고 통화로 표시하기 위해 오늘 환율로 budget_currency로 나타낸 동일한 예산입니다. budget_amount가 null이면 null입니다.
string
필수
budget_amount_local의 ISO 4217 코드로, 계정의 ads_reporting_currency 설정입니다. 계정이 변경하지 않았다면 usd입니다.
string | null
필수
예산을 소유하는 수준입니다. 캠페인 전체(ad_campaign) 또는 각 광고 그룹 개별(ad_group) 중 하나입니다.사용 가능한 옵션: ad_campaign, ad_group
string | null
필수
budget_amount를 하루 단위로 지출하는지(daily), 캠페인 전체 기간에 걸쳐 지출하는지(lifetime) 여부입니다.사용 가능한 옵션: daily, lifetime
string
필수
생성 시 고정되는 캠페인 종류입니다. standard는 이미지 및 동영상 광고를 게재하고, search는 광고 그룹의 키워드에 대한 검색 결과에 텍스트 광고를 표시합니다.사용 가능한 옵션: standard, search
number
필수
클릭 수를 노출 수로 나눈 값으로, 0과 1 사이입니다.
number
필수
클릭 수입니다.
number
필수
등록 완료 이벤트에 귀속된 USD 가치입니다. 각 이벤트와 함께 전송된 값을 USD로 정규화해 합산하며, 값이 없는 이벤트는 0으로 계산됩니다.
number
필수
Whop 픽셀에 귀속된 등록 완료 이벤트 수(라스트 클릭 기준)입니다.
number
필수
문의 이벤트에 귀속된 USD 가치입니다. 각 이벤트와 함께 전송된 값을 USD로 정규화해 합산하며, 값이 없는 이벤트는 0으로 계산됩니다.
number
필수
Whop 픽셀에 귀속된 문의 이벤트 수(라스트 클릭 기준)입니다.
number | null
필수
지출을 귀속된 장바구니 담기 이벤트 수로 나눈 값입니다. 해당 이벤트가 목표가 아니고 귀속된 이벤트가 없으면 null입니다.
number
필수
지출을 클릭 수로 나눈 값입니다. 클릭이 없으면 0입니다.
number | null
필수
지출을 귀속된 등록 완료 이벤트 수로 나눈 값입니다. 해당 이벤트가 목표가 아니고 귀속된 이벤트가 없으면 null입니다.
number | null
필수
지출을 귀속된 문의 이벤트 수로 나눈 값입니다. 문의가 목표가 아니고 귀속된 이벤트가 없으면 null입니다.
number | null
필수
지출을 귀속된 리드 수로 나눈 값입니다. 리드가 목표가 아니고 귀속된 리드가 없으면 null입니다.
number
필수
노출 1,000회당 지출입니다. 노출이 없으면 0입니다.
number | null
필수
지출을 귀속된 구매 수로 나눈 값입니다. 구매가 목표가 아니고 귀속된 구매가 없으면 null입니다.
number | null
필수
지출을 Whop 픽셀에 귀속된 결과 수로 나눈 값입니다. Whop에 귀속될 수 있는 항목을 최적화하지 않으면 null입니다.
number | null
필수
지출을 귀속된 일정 예약 이벤트 수로 나눈 값입니다. 일정 예약이 목표가 아니고 귀속된 이벤트가 없으면 null입니다.
number | null
필수
지출을 귀속된 신청서 제출 이벤트 수로 나눈 값입니다. 해당 이벤트가 목표가 아니고 귀속된 이벤트가 없으면 null입니다.
number | null
필수
지출을 고유 클릭 수로 나눈 값입니다. 고유 클릭이 없으면 null입니다.
number | null
필수
지출을 귀속된 콘텐츠 조회 이벤트 수로 나눈 값입니다. 해당 이벤트가 목표가 아니고 귀속된 이벤트가 없으면 null입니다.
string
필수
캠페인이 생성된 시각(ISO 8601 타임스탬프)입니다.
number
필수
모든 맞춤 이벤트 이름에 걸쳐 Whop 픽셀에 귀속된 맞춤(판매자 정의) 전환 이벤트 수(라스트 클릭 기준)입니다.
object
필수
Whop 픽셀에 귀속된 맞춤 전환으로, 이벤트 이름을 키로, 라스트 클릭 기준 횟수를 값으로 가집니다. 귀속된 이름 있는 맞춤 이벤트가 없으면 비어 있습니다. 이름 없이 발생한 맞춤 이벤트는 custom_conversions에는 집계되지만 여기서는 제외되므로, 이 값들의 합은 최대 custom_conversions입니다.
object
필수
custom_event_counts와 마찬가지로 이벤트 이름을 키로 하여 각 맞춤 이벤트에 귀속된 전환 가치입니다. whop.track에 전달된 값을 USD로 정규화해 합산하며, 값 없이 발생한 이벤트는 0으로 계산됩니다.
string
필수
캠페인의 광고가 현재 게재 중인지 여부와, 게재 중이 아니라면 그 이유입니다. 콘텐츠 검토 중이면 in_review이고, 시작을 기다리는 캠페인은 processing입니다. 계정 청구 실패 시 설정된 status는 변경하지 않고 payment_failed로 설정됩니다. 결제 재시도에 성공하면 차단이 해제되고 게재 상태가 다시 계산됩니다. 여러 상태가 동시에 해당하면 우선순위가 가장 높은 상태가 반환됩니다.사용 가능한 옵션: payment_failed, all_ads_rejected, draft, paused, in_review, learning, processing, revise_content, issues, scheduled, completed, active
number | null
광고주가 이 캠페인에서 달성하고자 하는 결과당 비용(USD)입니다. 목표값일 뿐이며 입찰가, 비용 한도, 입찰 한도가 아니고 캠페인 광고의 입찰 방식을 바꾸지 않습니다. 목표가 설정되지 않으면 null입니다.
string | null
필수
캠페인 게재가 종료되는 시각(ISO 8601 타임스탬프)입니다. 일시 중지할 때까지 게재되거나 광고 그룹이 자체 일정을 설정하면 null입니다.
number | null
필수
노출 수를 도달 수로 나눈 값입니다.
number
필수
노출 수입니다.
object[]
필수
캠페인과 그 하위 광고 그룹 및 광고에 영향을 주는 미해결 이슈입니다.

속성

string
필수
이슈의 고유 식별자입니다.
string
필수
이슈의 종류입니다. 게재에 관한 정보, 경고 또는 조치가 필요한 오류 중 하나입니다.사용 가능한 옵션: information, warning, error
string
필수
이슈의 내용과 해결 방법에 대한 설명입니다.
string | null
필수
이슈가 연결된 캠페인, 광고 그룹 또는 광고의 ID입니다.
string
필수
이슈가 연결된 리소스의 유형입니다.사용 가능한 옵션: ad_campaign, ad_group, ad
string
필수
크리에이터에게 표시되는 이슈의 짧은 제목입니다. 콘텐츠 검토 거부 시 지목된 규칙 또는 일반 레이블입니다.
number
필수
리드 이벤트에 귀속된 USD 가치입니다. 각 이벤트와 함께 전송된 값을 USD로 정규화해 합산하며, 값이 없는 이벤트는 0으로 계산됩니다.
number
필수
Whop 픽셀에 귀속된 리드 수(라스트 클릭 기준)입니다.
광고를 클릭한 사람들이 도착 페이지에서 발생시킨 페이지 조회 수로, Whop 픽셀이 기록합니다. 모든 광고 플랫폼에서 동일한 방식으로 집계됩니다.
string | null
필수
캠페인이 최적화하는 목표입니다. awareness는 폐지되기 전에 생성된 캠페인에만 나타나며, 그런 캠페인은 게재를 시작할 수 없습니다.사용 가능한 옵션: awareness, traffic, engagement, leads, sales
number
필수
픽셀에 귀속된 구매의 USD 가치입니다.
number
필수
Whop 픽셀에 귀속된 구매 수(라스트 클릭 기준)입니다.
number
필수
이를 본 고유 사용자 수입니다.
string | null
필수
귀속된 횟수가 결과를 나타내는 Whop 픽셀 전환 이벤트입니다. 최적화 목표이거나, 광고 그룹별로 예산을 설정하는 캠페인의 경우 귀속된 횟수가 가장 많은 이벤트입니다. 목표가 Whop에 귀속되는 이벤트가 아니면 null입니다.사용 가능한 옵션: purchase, lead, schedule, submit_application, contact, complete_registration, view_content, add_to_cart, custom, messaging_conversation
string | null
필수
result_event가 custom일 때의 판매자 정의 이벤트 이름입니다. 표준 이벤트에서는 null입니다.
number | null
필수
result_event의 기반이 되는 Whop 픽셀 귀속 횟수입니다. 캠페인의 광고 그룹들이 서로 다른 목표를 최적화하면 단일 result_event가 없으며(null), 이 값은 대신 각 광고 그룹의 귀속 결과를 합산한 값입니다. Whop에 귀속될 수 있는 항목을 최적화하지 않으면 null입니다.
number
필수
구매 가치를 지출로 나눈 값으로, 둘 다 USD 기준입니다(통화 중립적인 비율). 지출이 없으면 0입니다.
number
필수
일정 예약 이벤트에 귀속된 USD 가치입니다. 각 이벤트와 함께 전송된 값을 USD로 정규화해 합산하며, 값이 없는 이벤트는 0으로 계산됩니다.
number
필수
Whop 픽셀에 귀속된 일정 예약 이벤트 수(라스트 클릭 기준)입니다.
string[]
필수
캠페인이 해당한다고 선언된 규제 카테고리입니다. 이 카테고리의 광고에는 추가 타기팅 제한이 적용됩니다. 해당 사항이 없으면 비어 있습니다.사용 가능한 옵션: housing, employment, financial_products, politics
number
필수
spend_currency로 표시된 청구 금액입니다.
string | null
필수
모든 금액 지표의 ISO 4217 통화 코드입니다.
string | null
필수
캠페인 게재가 시작되는 시각(ISO 8601 타임스탬프)입니다. 게재 시작 즉시 시작되거나 광고 그룹이 자체 일정을 설정하면 null입니다.
string
필수
광고 캠페인에 설정된 수명 주기 상태입니다. 청구 실패 시 이 값은 active 또는 paused로 유지되고 delivery_status가 payment_failed로 설정됩니다.사용 가능한 옵션: active, paused, inactive, payment_failed, draft, duplicating
number
필수
신청서 제출 이벤트에 귀속된 USD 가치입니다. 각 이벤트와 함께 전송된 값을 USD로 정규화해 합산하며, 값이 없는 이벤트는 0으로 계산됩니다.
number
필수
Whop 픽셀에 귀속된 신청서 제출 이벤트 수(라스트 클릭 기준)입니다.
number | null
필수
target_result_event에 대한 목표 결과당 비용(USD)입니다. 설정되지 않으면 null입니다.
string | null
필수
target_cost_per_result의 단가 기준이 되는 이벤트로, purchase나 lead 등입니다. 캠페인에 단일 목표가 없으면 null입니다.
string
필수
광고 캠페인의 표시 이름입니다.
number | null
필수
고유 클릭 수를 노출 수로 나눈 값으로, 0과 1 사이입니다.
number
필수
Whop 픽셀이 보고한 클릭한 사람 수로, 사람당 한 번만 집계됩니다.
string
필수
캠페인이 마지막으로 업데이트된 시각(ISO 8601 타임스탬프)입니다.
number
필수
콘텐츠 조회 이벤트에 귀속된 USD 가치입니다. 각 이벤트와 함께 전송된 값을 USD로 정규화해 합산하며, 값이 없는 이벤트는 0으로 계산됩니다.
number
필수
Whop 픽셀에 귀속된 콘텐츠 조회 이벤트 수(라스트 클릭 기준)입니다.
AdCampaign