소개
보고서 API를 통해 표준 및 사용자 정의 Rakuten Advertising 보고서를 모두 실행할 수 있습니다. 이렇게 하면 계정에 로그인하지 않고도 보고서를 실행할 수 있습니다.
지침
다음 단계에 따라 보고서의 API URL을 얻으십시오.
- 보고서 인터페이스에 액세스합니다.
- 보고서 선택 드롭다운 메뉴에서 표준 보고서를 선택하거나 직접 보고서를 작성하십시오.
- 날짜 범위 매개변수를 선택하십시오.
- 원하시는 경우 필터를 적용하거나 지표 및 데이터 포인트 열을 추가 또는 제거 하여 보고서를 사용자 정의한 다음 보고서 저장 을 클릭합니다.
-
보고서 보기 옆에 있는 화살표를 클릭하고 API 가져오기 를 선택합니다.
- API URL 가져오기 팝업이 나타납니다. 웹 토큰이 포함된 URL이 표시됩니다. API URL을 복사하여 안전한 위치에 저장하십시오.
주의
API URL에는 계정에 로그인하지 않고도 보고 데이터에 액세스할 수 있는 토큰이 포함되어 있습니다. 사용자 아이디와 비밀번호를 보관할 때와 마찬가지로 안전하게 보관해야 합니다. 토큰 매개변수에 관한 자세한 내용은 아래 API URL 섹션을 참조하십시오.
애플리케이션
보고서 인터페이스에 액세스할 필요 없이 언제든지 API URL을 브라우저에 붙여넣어 보고서를 생성할 수 있습니다. 보고서 데이터가 포함된 CSV 파일이 컴퓨터로 다운로드됩니다. CSV 파일은 Excel에서 열 수 있습니다.
API URL
보고서 인터페이스로 돌아가지 않고도 현재 사용 중인 기존 API 매개변수를 수정하거나 새 보고 API URL을 작성할 수 있습니다. 다음은 API URL의 예시입니다.
https://ran-reporting.rakutenmarketing.com/en/reports/revenue-report-by-day/filters?start_date=20XX-10-25&end_date=20XX-10-26&include_summary=Y&network=1&previous-start-date=20XX-09-25&; previous-end-date=20XX-09-26&tz=GMT&date_type=process&date_format=m-d-yy&token=xxxxxxx
위의 녹색으로 표시된 모든 부분은 편집할 수 있습니다. 자세한 내용을 보려면 각 매개변수 이름 옆에 있는 +를 클릭하십시오.
설명: 보고서 데이터의 첫 번째 날짜 범위의 시작일입니다. YYYY-MM-DD 형식입니다.
설명: 보고서 날짜의 첫 번째 날짜 범위의 종료일입니다. YYYY-MM-DD 형식입니다.
설명: 다운로드하는 파일 상단에 6행 보고서 요약이 표시되도록 하려면 이 값을 Y 로 설정하십시오. 그렇지 않으면 "N"으로 설정합니다. 기본값은 Y 입니다.
설명: 이 필터를 사용하면 한 번에 하나의 네트워크에 대한 데이터를 표시할 수 있으므로 동일한 보고서에 여러 통화가 표시되지 않습니다.
- US=1
- UK=3
- CA=5
- BR=8
- AU=41
- FR=7
- DE=9
- JP=11
설명: 보고서 데이터의 두 번째 범위의 시작일입니다. YYYY-MM-DD 형식입니다.
설명: 보고서 데이터의 두 번째 날짜 범위의 종료일입니다. YYYY-MM-DD 형식입니다.
설명: 보고서에서 사용하는 시간대입니다. GMT가 기본 시간대입니다. 사용자는 날짜 선택 시 시간대를 변경하여 API에 반영된 것을 확인할 수 있습니다.
설명: 날짜 유형. 처리 일자의 경우 처리 를 사용하고 거래 일자의 경우 거래 를 사용합니다
설명: 기본값이 있는 선택적 매개변수입니다. 아래 필드 중 하나를 사용하여 보고서의 날짜 서식을 지정합니다. 지정하지 않으면 모든 네트워크의 기본값이 일본 네트워크가 아닌 경우 m/d/yy로, 일본 네트워크의 경우 yyyy/mm/dd로 설정됩니다. 이 매개변수에 허용되는 값은 다음과 같습니다.
- m/d/YY
- YYYY/mm/dd
- mm/dd/YY
- dd/mm/YY
- dd/mm/YYYY
- m-d-yy
- YYYY-mm-dd
- mm-dd-YY
- dd-mm-YY
- dd-mm-YYYY
설명: 이 토큰은 귀하의 데이터 보안을 보장합니다. 보안 토큰 에서 파생됩니다. 토큰을 안전하게 보관하세요. 이 값을 수정하지 마십시오. 토큰을 업데이트하려면 퍼블리셔 대시보드에서 업데이트할 수 있습니다.
사전 설정된 날짜 범위
사전 설정된 날짜 범위 및 start_date 와 end_date 값에 지정된 정확한 날짜 범위를 모두 지원합니다.
이로 인해 API 날짜를 생성하기 위한 추가 논리의 필요성이 줄어듭니다. 보고서 인터페이스는 날짜 범위 드롭다운 메뉴에서 사전 설정된 기간을 선택하면 API URL이 그 사전 설정된 기간을 사용하도록 설정합니다.
| 사전 설정된 날짜 범위 | date_range 매개 변수의 현재 기간 값 |
|---|---|
| 어제 | 어제 |
| 지난 7일 | 지난-7-일 |
| 이번 달 | 이번-달 |
| 지난 달 | 지난-달 |
| 이번 분기 | 이번-분기 |
| 지난 분기 | 지난-분기 |
| 올해 | 올-해 |
| 작년 | 작-년 |
다른 기간과 비교할 때 이전_날짜_범위 값은 다음과 같습니다.
| 날짜 범위 | 날짜 범위 값 |
|---|---|
| 지난주 | 지난-주 |
| 지난 달 | 지난-달 |
| 이전 분기 | 이전-분기 |
| 전년도 | 전-년도 |
날짜 선택기에서 사용자 지정 날짜 범위를 선택하면 인터페이스에서 특정 날짜가 포함된 API URL을 생성합니다. 예를 들어 20XX년 4월 22일을 시작 날짜로, 20XX년 5월 5일을 종료 날짜로 사용자 지정 날짜 범위를 선택한 경우 API URL은 다음과 같이 표시됩니다:
/filters?start_date=20XX-04-22&end_date=20XX-05-05
선택한 표준 시간대 오프셋이 보고서에 적용됩니다. 날짜 및 시간은 거래 일자, 거래 시간, 처리 일자 및 처리 시간 열에만 시간대를 반영합니다.
판매 및 활동 보고서 와 같이 이러한 열이 없는 보고서에는 시간대 오프셋이 적용됩니다. 개별 항목 보고서 와 같이 이러한 열을 포함하는 보고서에도 변환된 거래 일자 및 시간에 표시된 대로 시간대 오프셋이 적용됩니다.
그러나 다음 날짜 및 시간 열에 대해서는 시간대 변환이 수행되지 않습니다:
- 예약 소비 날짜
- 클릭 날짜
- 주문 배송일
- 시그니쳐 매치 날짜
- 시그니쳐 매치 시간
- 거래 생성 날짜
- 정시에 생성된 거래
날짜 형식 매개변수
이는 기본값이 있는 선택적 매개 변수입니다. Get API URL에 인코딩되거나 인코딩되지 않은 date_format 매개변수 값을 입력할 수 있습니다.
주의
현지 설정에 따라 Excel 또는 기타 파일 애플리케이션이 특정 날짜 형식에서 날짜 형식 매개변수를 지원하지 않거나 재정의할 수 있습니다. 날짜 형식 매개변수를 지원하도록 애플리케이션을 조정해야 할 수도 있습니다.
API 제한
보고 API를 사용하는 요청은 언제든지 한 번의 동시 호출로 제한됩니다. 동시에 실행 중인 요청이 두 개 이상 수신되는 경우, 기존 요청 중 하나 이상이 완료될 때까지 모든 추가 요청에 대해 오류가 표시됩니다. 이 오류는 "이 세션에 대한 요청 제한을 초과했습니다. 나중에 다시 시도하십시오."라는 메시지가 포함된 HTTP 429 응답입니다.
발생할 수 있는 API 오류의 더 많은 예를 확인하세요.
스크립트 호출을 사용하는 경우 스레드 루프와 같이 두 개 이상의 호출을 동시에 수행하지 않도록 하십시오. 무제한 API 호출을 실행하는 경우 코드에 호출을 일시 중지하거나 제한을 설정하십시오.
댓글
댓글을 남기려면 로그인하세요.