로그인

저희 지원센터에 오신 것을 환영합니다

광고 진행을 위한 작업과 라이브를 위해 도움을 드리겠습니다.

저희 지원센터에 오신 것을 환영합니다. 광고 진행을 위한 작업과 라이브를 위해 도움을 드리겠습니다.

Criteo API로 보고서 정보를 호출하려면 어떻게 해야 합니까?

Criteo API를 사용하여 보고서를 호출하려면 다음 쿼리를 사용하십시오. 
  1. clientLogin
  2. scheduleReportJob
  3. getJobStatus
  4. getReportDownloadUrl

 

API 호출과 응답 목록

 
1. clientLogin
모든 후속 호출에 사용할 authToken을 반환합니다.

파라미터:
필드 유형 설명
사용자명 xsd:string 광고주의 사용자 이름
암호 xsd:string 광고주의 암호
소스 xsd:string 애플리케이션을 나타내는 짧은 문자열로, 로깅에 사용됩니다. 이 문자열의 형식은 "companyName-applicationName-versionID"여야 합니다.

응답:
필드 유형 설명
clientLoginResult xsd:string clientLoginResult는 다른 모든 호출에 사용되는 인증 토큰(authToken)으로, 48시간 동안 유효합니다.
 
2. getAccount
기본적인 계정 정보 반환

파라미터:
해당 없음

응답:
필드 유형 설명
광고주 name xsd:string 이 계정의 이름
email xsd:string 광고주를 위한 주 담당자 이메일
통화 xsd:string 이 계정의 통화. 열거
Time zone xsd:string 이 계정의 시간대. 열거
국가 xsd:string 이 계정의 국가. 열거
 
3. getBudgets
선택 기준에 맞는 예산 목록을 반환합니다.

파라미터:
필드 유형 설명
budgetSelector BudgetIDs[] 조회할 예산 ID의 목록입니다. 비어 있으면 모든 예산을 조회합니다.

응답:
필드 유형 설명
getBudgetsResult Budget[] 예산 오브젝트의 목록입니다.
 
4. getCampaigns
선택 기준에 맞는 캠페인 목록을 반환합니다.

파라미터:
필드 유형 설명
campaignSelector CampaignSelector BudgetID, CampaignID, CampaignStatus 및 BiddingStrategy를 사용하여 캠페인을 조회할 수 있습니다.

응답:
필드 유형 설명
getCampaignsResult Campaign[] 캠페인 오브젝트의 목록
 
5. getCategories
선택 기준에 맞는 범주 목록을 반환합니다.

파라미터:
필드 유형 설명
categorySelector CategorySelector CategoryID 및 Selected를 사용하여 범주를 조회할 수 있습니다.

응답:
필드 유형 설명
getCategoriesResult Category[] 범주 오브젝트의 목록
 
6. mutateCategories
범주를 업데이트합니다.

파라미터:
필드 유형 설명
mutateCategories CategoryMutates[] 돌연변이 작업 목록입니다. SET 작업만 지원됩니다.

응답:
필드 유형 설명
jobResponse categoryMutateJobResponse[] categoryJobResponseObjects 목록입니다. 작업마다 자체 jobID가 있으며, getJobStatus로 확인할 수 있습니다.
 
7. mutateCampaigns
캠페인을 업데이트합니다.

파라미터:
필드 유형 설명
mutateCampaigns CampaignMutates[] 돌연변이 작업 목록입니다. SET 작업만 지원됩니다.


응답:
필드 유형 설명
jobResponse campaignMutateJobResponse[] campaignJobResponseObjects의 목록입니다. 작업마다 자체 jobID가 있으며, getJobStatus로 확인할 수 있습니다.


8. scheduleReportJob
보고서 작업의 실행 일정을 예약합니다.

파라미터:
필드 유형 설명
reportJob ReportJob 요청된 보고서에 대해 설명하는 reportJob 오브젝트를 전달합니다.

응답:
필드 유형 설명
jobID xsd:int 요청된 작업의 ID입니다. getJobStatus 및 getReportDownloadURL에 사용할 수 있습니다.
jobStatus xsd:string 요청의 상태입니다. reportJob이 수락된 경우 ‘Pending’을 반환합니다.
reportJob ReportJob 최초의 reportJob 요청입니다.


9. getJobStatus
작업 ID를 기준으로 작업의 상태를 조회합니다.

파라미터:
필드 유형 설명
jobID xsd:int 상태를 조회한 작업의 jobID입니다.

응답:
필드 유형 설명
getJobStatusResult xsd:String 요청된 작업의 상태입니다. 열거


10. getReportDownloadUrl
주어진 작업 ID의 보고서를 다운로드할 수 있는 URL을 반환합니다. 이 메서드를 호출한 사람은 반환된 URL에서 일반적인 HTTP GET 명령으로 보고서를 조회할 수 있습니다. 보고서는 XML 형식으로 되어 있습니다.

파라미터:
필드 유형 설명
jobID xsd:int 다운로드 URL을 조회한 jobID입니다.

응답:
필드 유형 설명
jobURL xsd:String 보고서를 다운로드할 수 있는 정식 URL입니다.


11. getStatisticsLastUpdate
관련된 통계 유형(ClicksAndImpressions, 여기서는 판매)의 "장부 마감"을 나타내는 StatUpdate 오브젝트의 목록을 반환합니다.

파라미터:
없습니다.

응답:
필드 유형 설명
getStatisticsLastUpdateResult StatUpdate[] StatUpdateObjects의 목록입니다. StatUpdate에는 유형과 날짜가 들어 있습니다.

 

오브젝트 설명

 
캠페인 유형
필드 유형 설명
campaignID xsd:int 캠페인의 ID
campaignName xsd:string 캠페인의 이름
campaignBid BidInformation 캠페인의 BidInformation
budgetID xsd:decimal 캠페인에 사용되는 예산의 ID입니다.
remainingDays xsd:int 기존 예산으로 이 캠페인을 진행할 수 있는 기간(일)입니다. 이 값은 현재의 지출 경향을 토대로 추정합니다.
상태 xsd:string 캠페인 상태:
  • RUNNING: 캠페인이 현재 활성 상태
  • NOT_RUNNING: 캠피인이 비활성 상태
  • DEAD: 캠페인이 아카이브된 읽기 전용 상태
categoryBids CategoryBid[] 범주에 연결된 BidInformation의 목록입니다.


유형 범주
필드 유형 설명
categoryID xsd:int 범주의 ID
categoryName xsd:string 카테고리명(카탈로그 feed에서 조회)입니다.
avgPrice xsd:double 이 범주에 속하는 제품의 평균 가격입니다.
numberOfProducts xsd:int 이 범주의 태그가 부착된 제품 수입니다.
selected xsd:boolean 해당 범주가 선택된 범주인 경우 참입니다(선택된 범주는 입찰 및 보고에 사용 가능).


Budget 유형
필드 유형 설명
budgetID xsd:int 예산의 ID입니다.
budgetName xsd:string 예산의 이름입니다.
totalAmount xsd:int 이 예산에 추가된 총액입니다.
remainingBudget xsd:decimal 사용 가능한 금액입니다.
remainingBudgetUpdated xsd:dateTime remainingBudget을 계산한 시간입니다.


BidInformation 유형
필드 유형 설명
biddingStrategy xsd:string 입찰 전략:
  • CPC: 클릭당 비용
  • CPA: 작업당 비용
  • CPM: 천 단위당 비용
참고: CPC만 지원됩니다.
cpcBid xsd:double 클릭당 비용의 가치입니다.
cpaBid CPABid CPABid에는 postClick, postView, commission 및 percent가 포함됩니다. (아직 지원되지는 않습니다.)


CategoryBid 유형
필드 유형 설명
campaignCategoryUID xsd:int 특정 캠페인의 범주를 나타내는 글로벌 UID입니다.
campaignID xsd:int 이 카테고리의 입찰을 수행한 캠페인의 ID입니다.
categoryID xsd:int 이 입찰을 수행한 카테고리의 ID입니다.
selected xsd:boolean 해당 범주가 선택된 범주인 경우 참입니다(선택된 범주는 입찰 및 보고에 사용 가능).
bidInformation BidInformation 범주 입찰의 BidInformation입니다.


ReportJob 유형
필드 유형 설명
reportSelector CategoryIDs
CampaignIDs
보고서에서 데이터를 조회해야 하는 범주 또는 캠페인 ID의 목록입니다.
reportType xsd:string 실행할 보고서 유형:
  • 캠페인
  • 카테고리
aggregationType xsd:string 보고서의 집계 유형:
  • 시간별
  • 일별
startDate xsd:string 보고서의 startDate(YYYY-MM-DD)입니다.
endDate xsd:string 보고서의 endDate입니다(YYYY-MM-DD).
selectedColumns ReportColumn[] 보고서에서 요청된 열 목록:
  • clicks
  • impressions
  • ctr
  • revcpc
  • ecpm
  • cost
  • sales
  • convRate
  • orderValue
  • salesPostView
  • convRatePostView
  • orderValuePostView
  • costOfSale
  • impressionWin
  • costPerOrder
isResultGzipped xsd:boolean 참이면 보고서를 압축해야 합니다.

 

이 문서가 도움이 되었습니까?
1명 중 0명이 유용하다고 평가하였습니다.
Zendesk 제공