<ph type="x-smartling-placeholder"></ph>
현재 Apigee Edge 문서를 보고 있습니다.
Apigee X 문서. 정보
소개
수익 창출 보고서를 통해 집중적 사용 정보 및 거래 활동에 액세스할 수 있습니다. 예를 들어 어떤 애플리케이션, 개발자, API 제품 번들 또는 API 제품에 특정 기간의 거래 활동입니다. 수익 창출을 사용하면 요약 또는 상세한 보고서를 제공합니다.
수익 창출 보고서 유형
다음 유형의 수익 창출 보고서를 생성할 수 있습니다.
신고 | 설명 |
---|---|
결제 | 한 달 결제 월 동안 개발자 활동을 보고 요율이 계획이 올바르게 적용되었습니다. |
선불 잔액 | 선불 개발자가 결제 월 또는 월의 예상 수입이 달라야 하므로 결제 대행업체와 함께합니다. |
수익 | 특정 기간 동안 개발자가 생성한 활동과 수익을 조회하여 다음을 수행할 수 있습니다. 개발자 (및 개발자) 전반의 API 제품 번들 및 제품 실적을 있습니다. |
분산 |
두 기간에 개발자가 발생시킨 활동과 수익을 비교하여 API 패키지 및 제품 성능의 상승 또는 하락 추세를 분석할 수 있습니다. 애플리케이션 전체에 적용됩니다 |
데이터 보관 정보
Apigee Edge 퍼블릭 클라우드에서 수익 창출 데이터 보관은 요금제 권리입니다. 자세한 내용은 자세한 내용은 https://cloud.google.com/apigee/specsheets를 참조하세요. 수익 창출 데이터를 사용 권한을 벗어나도 유지하려면 Apigee 영업팀에 문의하세요. 있습니다. 데이터 보관 연장이 요청 시점에 활성화되었으며 사용할 수 없습니다. 원래 데이터 보관 기간보다 이전인 데이터를 포함하도록 소급하여 활성화할 수 있습니다.
중복 거래 정보
수익 창출 거래 보고서와 애널리틱스 데이터를 비교할 때 중복 거래 수 이는 수익 창출 시스템이 매일 수백만 건의 거래를 처리하며 수많은 거래가 동시에 처리됨 확인할 수 있습니다 평균적으로 거래의 약 0.1% 가 중복일 수 있습니다.
수익 창출 보고서 페이지 살펴보기
아래에 설명된 대로 수익 창출 보고서 페이지에 액세스합니다.
에지
Edge UI를 사용하여 보고서 페이지에 액세스하려면 다음 안내를 따르세요.
- apigee.com/edge에 로그인합니다.
- 게시 > 수익 창출 > 보고서를 클릭합니다.
보고서 페이지가 표시됩니다.
그림에 강조 표시된 것처럼 보고서 페이지에서는 다음 작업을 수행할 수 있습니다.
- 이름 및 설명, 보고서 유형 및 기간, 최종 수정일 등 모든 보고서의 요약 정보 보기
- 보고서 구성하기
- CSV 또는 ZIP 파일 형식으로 보고서를 생성하고 다운로드합니다.
- 보고서 수정
- 보고서 소거
- 보고서 목록 검색
Classic Edge (Private Cloud)
기본 Edge UI를 사용하여 보고서 페이지에 액세스하려면 다음 안내를 따르세요.
http://ms-ip:9000
에 로그인합니다. 여기서 ms-ip는 관리 서버 노드의 IP 주소 또는 DNS 이름입니다.- 수익 창출 > 수익 창출 보고서를 클릭합니다.
보고서 페이지가 표시됩니다.
- 보고서의 현재 목록 보기
- 보고서 구성하기
- CSV 형식의 보고서 생성 및 다운로드
- 보고서 수정
- 보고서 소거
보고서 구성하기
다음 섹션에 설명된 대로 UI를 사용하여 보고서를 구성합니다.
보고서 구성 단계
Edge UI 또는 Classice Edge UI를 사용하여 보고서를 구성합니다.
에지
Edge UI를 사용하여 보고서를 구성하려면 다음 안내를 따르세요.
- 게시 > 수익 창출 > 보고서를 클릭합니다.
- + 보고서를 클릭합니다.
- 다음 표에 정의된 보고서 세부정보를 구성합니다.
필드 설명 이름 보고서의 고유한 이름입니다. 설명 보고서에 대한 설명입니다. 보고서 유형 수익 창출 보고서 유형을 참고하세요. - 다음 섹션에 설명된 대로 선택한 보고서 유형에 따라 나머지 보고서 세부정보를 구성합니다. <ph type="x-smartling-placeholder">
- 보고서 창에 정보를 입력하면 다음 작업을 수행할 수 있습니다.
<ph type="x-smartling-placeholder">
- </ph>
- 보고서 저장을 클릭하여 보고서 구성을 저장합니다.
상세 보고서에 한해 작업 제출을 클릭하여 보고서를 비동기식으로 실행합니다. 나중에 결과를 가져올 수도 있습니다 자세한 내용은 보고서 생성 및 다운로드를 참조하세요.
- CSV로 저장 또는 Zip으로 저장을 클릭하여 생성된 보고서를 로컬 컴퓨터에 CSV (쉼표로 구분된 값) 또는 CSV가 포함된 압축된 zip 파일로 압축됩니다. Zip 파일 다운로드는 더 효과적으로 다운로드할 수 있습니다.
Classic Edge (Private Cloud)
기본 Edge UI를 사용하여 보고서를 만들려면 다음 안내를 따르세요.
- 수익 창출 > 수익 창출 보고서를 클릭합니다.
- 드롭다운 메뉴에서 만들려는 보고서 유형을 선택합니다. 수익 창출 보고서 유형을 참고하세요.
- + 보고서를 클릭합니다.
- 다음 섹션에 설명된 대로 선택한 결제 유형에 따라 보고서 세부정보를 구성합니다.
<ph type="x-smartling-placeholder">
- </ph>
- 결제 보고서 구성
- 선불 잔액 보고서 구성하기
- 수익 보고서 구성하기
- 분산 보고서 구성 (지원 중단됨)
- 보고서 창에 정보를 입력하면 다음 작업을 수행할 수 있습니다.
<ph type="x-smartling-placeholder">
- </ph>
- 다른 이름으로 저장을 클릭하여 보고서 구성을 저장하고 나중에 보고서를 다운로드합니다.
상세 보고서에 한해 작업 제출을 클릭하여 보고서를 비동기식으로 실행합니다. 나중에 결과를 가져올 수도 있습니다 자세한 내용은 보고서 생성 및 다운로드를 참조하세요.
- CSV 다운로드를 클릭하여 보고서를 생성하고 쉼표로 구분된 값 (CSV) 파일.
결제 보고서 구성
보고서를 구성하는 단계를 따르고 보고서 페이지에 다음 정보를 입력합니다.
필드 | 설명 |
---|---|
결제 월 |
보고서의 청구 월입니다. |
보고 수준 |
보고 수준 유효한 값으로 다음이 포함되어 있습니다.
|
제품 번들 |
참고: 기본 Edge UI에서는 API 제품 번들을 API 패키지라고 합니다. 보고서에 포함할 API 제품 번들을 선택합니다. 아무것도 선택하지 않으면 모든 API 제품 번들이 보고서. 보고서에는 선택한 각 API 제품 번들에 대한 별도의 행이 포함됩니다. 요약 보고서의 경우 요약 표시 옵션에서 표시 안함을 선택할 수도 있습니다. 이 경우 보고서는 모든(또는 선택된) API 제품 번들의 정보를 집계하며 각 API 제품 번들에 대한 개별적인 정보를 제공합니다. |
제품 |
보고서에 포함할 API 제품을 선택합니다. 아무것도 선택하지 않으면 모든 API 제품이 보고서. 보고서에는 선택한 각 API 제품에 대한 별도의 행이 포함됩니다. 요약 보고서의 경우 요약 표시 옵션에서 표시 안함을 선택할 수도 있습니다. 이 경우 보고서는 모든(또는 선택된) 개발자의 정보를 집계하며 (선정된 개발자 1명당 별도). |
회사 | 보고서에 포함할 회사를 선택합니다. 아무것도 선택하지 않으면 모든 회사가 보고서. |
요금제 |
보고서에 포함할 요금제입니다. 다음 중 하나를 선택합니다.
|
선불 잔액 보고서 구성하기
보고서를 구성하는 단계를 따르고 보고서 페이지에 다음 정보를 입력합니다.필드 | 설명 |
---|---|
결제 월 |
보고서의 청구 월입니다. |
보고 수준 |
보고 수준 유효한 값으로 다음이 포함되어 있습니다.
|
회사 | 보고서에 포함할 회사를 선택합니다. 아무것도 선택하지 않으면 모든 회사가 보고서. |
수익 보고서 구성하기
보고서를 구성하는 단계를 따르고 보고서 페이지에 다음 정보를 입력합니다.
필드 | 설명 |
---|---|
기간 |
보고서의 날짜 범위입니다. 다음 중 하나를 선택합니다.
|
통화 선택 |
보고서의 통화입니다. 유효한 값으로 다음이 포함되어 있습니다.
|
보고 수준 |
보고 수준 유효한 값으로 다음이 포함되어 있습니다.
|
제품 번들 |
참고: 기본 Edge UI에서는 API 제품 번들을 API 패키지라고 합니다. 보고서에 포함할 API 제품 번들을 선택합니다. 아무것도 선택하지 않으면 모든 API 제품 번들이 보고서. 보고서에는 선택한 각 API 제품 번들에 대한 별도의 행이 포함됩니다. 요약 보고서의 경우 요약 표시 옵션에서 표시 안함을 선택할 수도 있습니다. 이 경우 보고서는 모든(또는 선택된) API 제품 번들의 정보를 집계하며 각 API 제품 번들에 대한 개별적인 정보를 제공합니다. |
제품 |
보고서에 포함할 API 제품을 선택합니다. 아무것도 선택하지 않으면 모든 API 제품이 보고서. 보고서에는 선택한 각 API 제품에 대한 별도의 행이 포함됩니다. 요약 보고서의 경우 요약 표시 옵션에서 표시 안함을 선택할 수도 있습니다. 이 경우 보고서는 모든(또는 선택된) 개발자의 정보를 집계하며 (선정된 개발자 1명당 별도). |
회사 | 보고서에 포함할 회사를 선택합니다. 아무것도 선택하지 않으면 모든 회사가 보고서. 요약 보고서의 경우 선택사항에서 표시 안함을 선택할 수 있습니다. 요약 표시 옵션 섹션 이 경우 보고서는 모든 (또는 선택된) 회사에 대한 정보를 집계합니다. (선택한 각 회사의 정보를 개별적으로 나열하지 않음) |
앱 |
실행할 애플리케이션 선택 포함할 수 있습니다. 아무것도 선택하지 않으면 모든 애플리케이션이 있습니다. 보고서에는 선택한 애플리케이션별로 별도의 행이 포함됩니다. 요약 보고서의 경우 선택사항에서 표시 안함을 선택할 수 있습니다. 요약 표시 옵션 섹션 이 경우 보고서는 모든 (또는 선택된) 애플리케이션 (선택한 각 애플리케이션에 대한 정보를 표시하지 않음) 있습니다. |
요약 표시 옵션 |
열이 그룹화되고 보고서에서 표시되는 순서입니다. 번호 선택 는 그룹화에서 해당 섹션의 상대적 순서를 나타냅니다 (1이 첫 번째 합니다. 예를 들어 다음은 보고서를 먼저 패키지별로 그룹화한 다음 그 다음에는 개발자, 애플리케이션이 있습니다. 섹션을 표시하지 않으려면 표시 안함을 선택한 다음 나머지 필드를 순서대로 선택합니다. 한 섹션의 상대적인 순서를 변경하거나 보고서에 섹션을 표시하지 않도록 선택할 수 있습니다. |
수익 요약 보고서에 맞춤 거래 속성 포함
거래 기록 정책을 사용하면 거래에서 맞춤 속성 데이터를 캡처할 수 있습니다.
요약 수익 보고서에 이러한 맞춤 속성을 포함할 수 있습니다. 기본
수익 창출 데이터베이스 표에 포함된 커스텀 속성을
조직의 MINT.SUMMARY_CUSTOM_ATTRIBUTES
속성을 설정합니다.
이 기능을 사용하려면 몇 가지 생각과 계획이 필요하므로 아래의 고려사항을 검토하세요.
클라우드 고객이라면 Apigee Edge 지원팀에 문의하여 속성 프라이빗 클라우드용 Apigee Edge 고객은 PUT 요청을 사용하여 플래그를 설정합니다. 시스템 관리자 사용자 인증 정보로 다음 API에 연결할 수 있습니다.
curl -u email:password -X PUT -H "Content-type:application/xml" http://host:port/v1/o/{myorg} -d \ "<Organization type="trial" name="MyOrganization"> <Properties> <Property name="features.isMonetizationEnabled">true</Property> <Property name="MINT.SUMMARY_CUSTOM_ATTRIBUTES">["partner_id","tax_source"]</Property> <Property name="features.topLevelDevelopersAreCompanies">false</Property> </Properties> </Organization>"
이 예에서 API 호출은 기능을 사용 설정하고
partner_id
및 tax_source
열을
수익 창출 데이터베이스입니다. API 호출의 맞춤 속성 배열은
URL 인코딩됨
보고서에 맞춤 거래 속성을 포함할 때의 고려사항
- API로 속성 이름을 만들기 전에 사용할 속성 이름을 확실하게 정하세요. 즉, 데이터베이스의 열 이름이고 맞춤 속성 데이터는 항상 데이터베이스에 저장됩니다.
- 각 트랜잭션 기록 정책에는 다음과 같이 사용 가능한 맞춤 속성 슬롯이 10개 있습니다.
다음 이미지에 나와 있습니다. 동일한 속성에 동일한 속성 이름 및 위치를 사용하세요.
속성 값을 정의합니다. 예를 들어
거래 기록 정책,
partner_id
및tax_source
맞춤 속성은 각각 상자 4와 5를 차지합니다. 이 이름은 해당 사용자의 이름과 직위여야 합니다. 보고에 포함되는 제품의 거래 기록 정책
기능을 사용 설정한 후 요약 수익 보고서에 맞춤 속성을 포함하려면
보고서 API에 transactionCustomAttributes
를 추가하여
MintCriteria
기준 구성 보기
옵션을 참조하세요.
분산 보고서 구성하기 (지원 중단됨)
보고서를 구성하는 단계를 따르고 보고서 페이지에 다음 정보를 입력합니다.
필드 | 설명 |
---|---|
기간 |
보고서의 날짜 범위입니다. 다음 중 하나를 선택합니다.
|
패키지 |
보고서에 포함할 API 패키지입니다. 다음 중 하나를 선택합니다.
보고서에는 선택한 각 API 패키지에 대한 별도의 행이 포함됩니다. 요약 보고서의 경우 선택사항으로 요약에서 표시하지 않음 (패키지)을 선택할 수 있습니다. 표시 옵션 섹션 이 경우 보고서는 모든 (또는 선택) API 패키지 (각 API 패키지에 대한 정보를 표시하지 않음) 분리). |
제품 |
보고서에 포함할 API 제품입니다. 다음 중 하나를 선택합니다.
보고서에는 선택한 각 API 제품에 대한 별도의 행이 포함됩니다. 요약 보고서의 경우 선택적으로 요약 보고서에서 표시하지 않음 (제품)을 선택할 수 있습니다. 표시 옵션 섹션 이 경우 보고서는 모든 (또는 API 제품이 선택됨 (각 API 제품에 대한 정보가 표시되지 않음) 분리). |
회사 |
보고서에 포함할 회사입니다. 다음 중 하나를 선택합니다.
보고서에는 선택한 회사별로 별도의 행이 포함됩니다. 요약 보고서의 경우 '표시하지 않음 (회사)'을 선택할 수 있습니다. 요약 표시 옵션 섹션 이 경우 보고서는 모든 회사 (또는 선택된) 회사 (선택한 각 회사에 대한 정보를 표시하지 않음) 분리). |
앱 |
보고서에 포함할 애플리케이션입니다. 다음 중 하나를 선택합니다.
보고서에는 선택한 애플리케이션별로 별도의 행이 포함됩니다. 요약 보고서의 경우 선택사항에서 표시하지 않음 (애플리케이션)을 선택할 수 있습니다. 요약 표시 옵션 섹션 이 경우 보고서는 모든 (또는 선택된) 애플리케이션 (선택한 각 애플리케이션에 대한 정보를 표시하지 않음) 있습니다. |
통화 |
보고서의 통화입니다. 유효한 값으로 다음이 포함되어 있습니다.
|
요약 표시 옵션 |
열이 그룹화되고 보고서에서 표시되는 순서입니다. 번호 선택 는 그룹화에서 해당 섹션의 상대적 순서를 나타냅니다 (1이 첫 번째 합니다. 예를 들어 다음은 보고서를 먼저 패키지별로 그룹화한 다음 그 다음에는 개발자, 애플리케이션이 있습니다. 섹션을 표시하지 않으려면 표시 안함을 선택한 다음 나머지 필드를 순서대로 선택합니다. 한 섹션의 상대적인 순서를 변경하거나 보고서에 섹션을 표시하지 않도록 선택할 수 있습니다. |
보고서 생성 및 다운로드
보고서를 만든 후 보고서 결과를 CSV 또는 ZIP 파일 형식으로 다운로드할 수 있습니다. CSV 또는 ZIP 파일은 동기식 또는 비동기식으로 생성할 수 있습니다.
동기식 보고서의 경우 보고서 요청을 실행하면 분석 서버가 응답을 제공할 때까지 요청이 차단됩니다. 그러나 보고서가 많은 데이터 양(예: 100GB의 데이터)을 처리해야 할 수 있으므로 타임아웃으로 동기식 보고서가 실패할 수 있습니다.
요약 보고서 수준은 동기 생성만 지원합니다.
비동기식 보고서의 경우 보고서 요청을 실행하면 나중에 결과를 검색합니다. 다음은 비동기식 쿼리 처리가 좋은 대안이 될 수 있는 경우입니다.
- 여러 시간 간격에 걸친 보고서를 분석하고 만드는 경우
- 쿼리를 복잡하게 만드는 다양한 그룹화 측정기준과 기타 제약조건으로 데이터를 분석하는 경우
- 일부 사용자 또는 조직에 대한 데이터 볼륨이 현저히 높아진 때 쿼리를 관리하는 경우
상세 보고서 수준은 비동기 생성을 지원합니다.
CSV 또는 ZIP 파일 형식으로 보고서를 생성하고 다운로드하려면 다음 작업 중 하나를 수행하세요.
- 보고서 페이지에 액세스합니다.
- 다운로드할 보고서 위에 커서를 놓습니다.
수정됨 열에서 다음 중 하나를 클릭합니다.
- 아이콘 또는 아이콘 (요약 보고서용)을 클릭합니다. 보고서는 동시에 CSV 또는 ZIP 파일로 저장됩니다.
- 작업 제출 (상세 보고서용) 비동기 작업이 시작됩니다.
Modified 열에서 작업 상태를 모니터링합니다.
보고서를 다운로드할 준비가 되면 디스크 아이콘이 나타납니다.
- 작업이 완료되면 디스크 아이콘을 클릭하여 보고서를 다운로드합니다.
다음은 결제 요약 보고서 CSV 파일의 예입니다.
보고서 수정
보고서를 수정하는 방법은 다음과 같습니다.
- 보고서 페이지에 액세스합니다.
- 수정할 보고서 위에 커서를 놓고 작업 메뉴에서 를 클릭합니다.
- 필요에 따라 보고서 구성을 업데이트합니다.
- 보고서 업데이트를 클릭하여 업데이트된 보고서 구성을 저장합니다.
보고서 삭제
보고서를 삭제하려면 다음 단계를 따르세요.
- 보고서 페이지에 액세스합니다.
- 삭제할 보고서 위에 커서를 놓습니다.
- 작업 메뉴에서 를 클릭합니다.
API를 사용하여 수익 창출 보고서 관리
다음 섹션에서는 API를 사용하여 수익 창출 보고서를 관리하는 방법을 설명합니다.
API를 사용하여 보고서 구성하기
전체 조직에 대해 보고서를 구성하려면 POST 요청을 발행하세요.
/organizations/{org_name}/report-definitions
특정 개발자를 위해 보고서를 구성하려면
/organizations/{org_name}/developers/{dev_id}/report-definitions
, 각 항목의 의미는 다음과 같습니다.
{dev_id}
는 개발자를 식별합니다.
요청할 때 보고서의 이름과 유형을 지정해야 합니다. 유형은
BILLING
, REVENUE
, VARIANCE
(지원 중단됨) 또는
PREPAID_BALANCE
입니다. 또한
보고서를 추가로 구성하는 mintCriteria
속성입니다. 데이터 레이크와
지정할 수 있는 기준이 있습니다. 이렇게 하면 보고서를 보다 유연하게 구성할 수 있습니다.
기준으로 지정할 수 있는 항목은 다음과 같습니다.
- 결제 또는 선불 잔액 보고서의 경우 보고서의 결제 월
- 수익 보고서의 경우 보고서에서 다루는 거래 유형(예: 구매) 거래, 청구 거래, 환불
- 선불 잔액 보고서의 경우 보고서가 적용되는 개발자
- 수익 보고서의 경우 대상 API 제품 번들 (또는 API 패키지), 제품, 요금제 및 애플리케이션 보고서 적용
- 수익 또는 변동 보고서의 경우 보고서에 적용되는 통화
- 결제, 선불 잔액 또는 수익 보고서의 경우 보고서가 요약 보고서인지 아니면 상세 보고서
- 수익 요약 보고서의 경우 보고서에 맞춤 거래 속성을 포함합니다.
전체 목록은 보고서 구성 옵션을 참고하세요. 보고서 기준을 만듭니다.
예를 들어 다음은
2015년 7월입니다. 이 보고서에는
transactionTypes
속성으로 구성되고, 특히 Payment API 제품 번들에 적용됩니다.
Payment API 제품입니다. 보고서에 특정 개발자나 애플리케이션이 명시되어 있지 않으므로
모든 개발자와 애플리케이션에 보고서가 적용됩니다. 왜냐하면
currencyOption
속성이 LOCAL
로 설정되면 보고서의 각 줄에
해당 요금제의 통화를 사용하여 표시됩니다. 또한
groupBy
속성은 보고서의 열이
다음 순서: PACKAGE, PRODUCT, DEVELOPER, APPLICATION, RATEPLAN (요금제 이름 포함)
ID)을 입력합니다.
$ curl -H "Content-Type: application/json" -X POST -d \ '{ "name": "July 2015 revenue report", "description": " July 2015 revenue report for Payment product", "type": "REVENUE", "mintCriteria":{ "fromDate":"2015-07-01 00:00:00", "toDate":"2015-08-01 13:35:00", "showTxDetail":true, "showSummary":true, "transactionTypes":[ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ], "monetizationPackageIds":[ "payment" ], "productIds":[ "payment" ], "currencyOption":"LOCAL", "groupBy":[ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ] } }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions" \ -u email:password
다음은 개발자 DEV의 활동을 보여주는 자세한 결제 보고서를 생성합니다. 2015년 6월의 경우 5입니다.
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "name": "June billing report, DEV FIVE", "description": "June billing report, DEV FIVE", "type": "BILLING", "mintCriteria":{ "billingMonth": "JUNE", "billingYear": 2015, "showTxDetail":true, "showSummary":false, "currencyOption":"LOCAL" }, "devCriteria":[{ "id":"RtHAeZ6LtkSbEH56", "orgId":"myorg"}] }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xU/report-definitions" \ -u email:password
API를 사용하여 보고서 구성 보기
조직의 특정 보고서 구성 또는 모든 보고서 구성을 볼 수 있습니다. 나 개별 개발자의 보고서 구성도 확인할 수 있습니다.
조직의 특정 보고서 구성을 보려면
/organizations/{org_name}/report-definitions/{report_definition_id}
, 각 항목의 의미는 다음과 같습니다.
{report_definition_id}
는 특정 보고서 구성(
보고서 구성을 만들 때 응답에서 ID가 반환됩니다. 예를 들면 다음과 같습니다.
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/1f7fa53b-de5a-431d-9438-62131e1396c5" \ -u email:password
조직의 모든 보고서 구성을 보려면
/organizations/{org_name}/report-definitions
다음 쿼리 매개변수를 전달하여 결과를 필터링하고 정렬할 수 있습니다.
쿼리 매개변수 | 설명 |
---|---|
all |
모든 API 제품 번들의 반환 여부를 지정하는 플래그입니다. false로 설정된 경우 페이지당 반환되는 API 제품 번들의 수는 다음과 같습니다.
size 쿼리 매개변수로 정의됩니다. 기본값은 false입니다. |
size |
페이지당 반환된 API 제품 번들의 수입니다. 기본값은 20입니다. all 쿼리가
매개변수가 true 로 설정되면 이 매개변수는 무시됩니다. |
page |
반환할 페이지의 번호입니다 (콘텐츠에 페이지가 매겨진 경우). 만약
all 쿼리 매개변수가 true 로 설정되어 있으면
매개변수는 무시됩니다. |
sort |
정보를 정렬할 기준 필드입니다. all 쿼리가
매개변수가 true 로 설정되면 이 매개변수는 무시됩니다. 기본값은 UPDATED:DESC 입니다. |
예를 들어 다음은 조직에 대한 보고서 구성을 반환하고 최대 5개의 보고서 구성까지 가져올 수 있습니다.
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions?size=5" \ -u email:password
응답은 다음과 같아야 합니다(응답의 일부만 표시됨).
{ "reportDefinition" : [ { "description" : "Test revenue report", "developer" : null, "id" : "1f7fa53b-de5a-431d-9438-62131e1396c5", "lastModified" : "2015-08-27 15:44:03", "mintCriteria" : { "asXorg" : false, "currencyOption" : "LOCAL", "fromDate" : "2015-07-01 00:00:00", "groupBy" : [ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ], "monetizationPackageIds" : [ "payment" ], "productIds" : [ "payment" ], "showRevSharePct" : false, "showSummary" : true, "showTxDetail" : true, "showTxType" : false, "toDate" : "2015-08-01 00:05:00", "transactionTypes" : [ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ] }, "name" : "Test revenue report", "organization" : { ... }, "type" : "REVENUE" }, { "description" : "June billing report, DEV FIVE", "developer" : null, "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb", "lastModified" : "2015-08-27 17:13:20", "mintCriteria" : { "asXorg" : false, "billingMonth" : "JUNE", "billingYear" : 2015, "currencyOption" : "LOCAL", "showRevSharePct" : false, "showSummary" : false, "showTxDetail" : true, "showTxType" : false }, "name" : "June billing report, DEV FIVE", "organization" : { ... }, "type" : "BILLING" } ], "totalRecords" : 2 }
특정 개발자의 보고서 설정을 보려면 GET 요청을 실행하여
/organizations/{org_name}/developers/{dev_id}/report-definitions
, 각 항목의 의미는 다음과 같습니다.
{dev_id}
는 개발자를 식별합니다. 요청할 때
위에서 설명한 쿼리 매개변수를 지정하여 데이터를 필터링하고 정렬합니다.
예를 들어 다음은 특정 개발자의 보고서 구성을 반환하고 보고서 이름별 응답:
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/5cTWgdUvdr6JW3xUreport-definitions?sort=name" \ -u email:password
API를 사용하여 보고서 구성 업데이트
보고서 구성을 업데이트하려면 PUT 요청을 실행하여
/organizations/{org_name}/report-definitions/{report_definition_id}
, 각 항목의 의미는 다음과 같습니다.
{report_definition_id}
는 특정 보고서 구성을 식별합니다. 날짜
업데이트하는 경우 요청 본문에서 업데이트된 구성 값과
변경할 수 있습니다 예를 들어 다음 요청은 보고서를 요약 보고서로 업데이트합니다.
(업데이트된 속성이 강조표시됨):
$ curl -H "Content-Type: application/json" -X PUT -d \ '{ "id": "fedac696-ce57-469b-b62c-a77b535fd0eb", "name": "June billing report, DEV FIVE", "description": "June billing report, DEV FIVE", "type": "BILLING", "mintCriteria":{ "billingMonth": "JUNE", "billingYear": 2015, "showTxDetail":false, "showSummary":true } }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \ -u email:password
응답은 다음과 같아야 합니다(응답의 일부만 표시됨).
{ "description" : "June billing report, DEV FIVE", "developer" : null, "id" : "fedac696-ce57-469b-b62c-a77b535fd0eb", "lastModified" : "2015-08-27 17:47:29", "mintCriteria" : { "asXorg" : false, "billingMonth" : "JUNE", "billingYear" : 2015, "showRevSharePct" : false, "showSummary" : true, "showTxDetail" : false, "showTxType" : false }, "name" : "June billing report, DEV FIVE", "organization" : { ... }, "type" : "BILLING" }
API를 사용하여 보고서 구성 삭제
보고서 구성을 삭제하려면 다음에 DELETE 요청을 실행하세요.
/organizations/{org_namer}/report-definitions/{report_definition_id}
, 각 항목의 의미는 다음과 같습니다.
{report_definition_id}
는 삭제할 보고서 구성을 식별합니다.
예를 들면 다음과 같습니다.
$ curl -H "Accept:application/json" -X DELETE \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/report-definitions/fedac696-ce57-469b-b62c-a77b535fd0eb" \ -u email:password
API를 사용하여 보고서 생성
보고서를 구성한 후 쉼표로 구분된 값으로 보고서를 생성할 수 있습니다. (CSV) 파일 형식을 사용합니다.
보고서를 생성하려면 POST 요청을
organizations/{org_id}/{report_type}
, 여기서 {report_type}
는
선택합니다. 유형은 다음과 같습니다.
billing-reports
revenue-reports
prepaid-balance-reports
variance-reports
예를 들어 청구 보고서를 생성하려면 POST 요청을 실행하여
organizations/{org_name}/billing-reports
모든 유형의 보고서에 대한 요청 본문에서 보고서의 검색 기준을 지정합니다. 사용
mintCriteria
속성을 사용하여 검색 기준을 지정합니다. 자세한 내용은 기준 구성 옵션을 참고하세요.
예를 들어 다음 요청은 다양한 기준에 따라 수익 보고서를 검색합니다. 보고서 시작일 및 종료일, 거래 유형 등의 항목을 설정할 수 있습니다
$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \ '{ "fromDate":"2015-07-01 00:00:00", "toDate":"2015-08-01 13:35:00", "showTxDetail":true, "showSummary":true, "transactionTypes":[ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ], "currencyOption":"LOCAL", "groupBy":[ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN"] }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \ -u email:password
발견되면 수익 보고서가 CSV 파일 형식으로 생성됩니다. 다음은 보고서 출력 예는 다음과 같습니다.
Reporting Period:,From:,2015-07-01, To:,2015-07-31 API Product:,All Developer:,All Application:,All Currency:,Local Type of Report:,Summary Revenue Report Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate, Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000, Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000, Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000, Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,
다음을 사용하여 수익 보고서에 개발자 맞춤 속성 포함 API
수익 보고서에 한해 보고서에 맞춤 속성을 포함할 수 있습니다. 속성이 개발자에 대해 정의된 것입니다. 개발자를 추가할 때 맞춤 속성을 정의합니다. 앱 개발자 관리에 설명된 대로 조직에 권한을 부여할 수 있습니다.
수익 보고서에 맞춤 속성을 포함하려면 POST 요청을 실행하여
organizations/{org_name}/revenue-reports
하고
요청 본문 내의 devCustomAttributes
배열:
"devCustomAttributes": [ "custom_attribute1", "custom_attribute2", ... ]
참고: 사전 정의된 MINT_*
및
devCustomAttributes
배열의 ADMIN_*
속성
예를 들어 다음 예에는 세 가지 커스텀 속성이 포함되어 있습니다.
보고서의 BILLING_TYPE
, SFID
및 ORG_EXT
(정의된 경우)
(개발자의 경우):
$ curl -H "Content-Type:application/json" -H "Accept: application/octet-stream" -X POST -d \ '{ "fromDate":"2015-07-01 00:00:00", "toDate":"2015-08-01 13:35:00", "showTxDetail":true, "showSummary":true, "transactionTypes":[ "PURCHASE", "CHARGE", "REFUND", "CREDIT", "SETUPFEES", "TERMINATIONFEES", "RECURRINGFEES" ], "currencyOption":"LOCAL", "groupBy":[ "PACKAGE", "PRODUCT", "DEVELOPER", "APPLICATION", "RATEPLAN" ], "devCustomAttributes": [ "BILLING_TYPE", "SFID", "ORG_EXT" ] }' \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/revenue-reports" \ -u email:password
다음은 두 맞춤 측정기준의 값이 포함된 보고서 출력의 예입니다. 속성:
Reporting Period:,From:,2015-07-01, To:,2015-07-31 API Product:,All Developer:,All Application:,All Currency:,Local Type of Report:,Summary Revenue Report Monetization Package,Package ID,API Product,Product ID,Developer Name,Developer ID,Application Name,Application ID,Rate Plan,Plan ID,Currency,Transaction Type,Provider Status,Total Volume,Charged Rate,BILLING_TYPE,SFID,ORG_EXT Location,location,foo_product,foo_product,Apigee,QQ7uxeMGf3w9W08B,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA, Location,location,foo_product,foo_product,BarCompany,barcompany,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA, Location,location,foo_product,foo_product,fremont,fremont,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA, Location,location,foo_product,foo_product,Juan's Taco Shack,juan-s-taco-sha,my_app,my_app,rate_plan_1,location_rate_plan_1,USD,SETUPFEES,SUCCESS,1,15.0000,PREPAID,123,3AA,
API를 사용하여 거래 활동 보고
POST 요청을 실행하여 조직의 거래 활동을
/organizations/{org_name}/transaction-search
요청할 때 다음을 수행해야 합니다.
가져오기 기준을 지정할 수 있습니다. 기준으로 지정할 수 있는 항목은 다음과 같습니다.
- 거래가 발행된 하나 이상의 API 제품의 ID입니다.
- 거래가 이루어진 결제 연도와 월입니다.
- 거래를 실행한 개발자입니다.
- 구매 및 설정 수수료와 같은 거래 유형입니다.
- 성공 및 실패와 같은 트랜잭션의 상태입니다.
기준 구성 옵션에서 있습니다.
예를 들어 다음은 특정 개발자가 결제를 위해 실행한 거래를 반환합니다. 월:
$ curl -H "Content-Type:application/json" -X POST -d \ '{ "billingMonth": "JUNE", "billingYear": 2015, "devCriteria": [{ "id": "RtHAeZ6LtkSbEH56", "orgId":"myorg"}], "transactionTypes": ["PURCHASE", "CHARGE", "SETUPFEES"], "transactionStatus": ["SUCCESS", "FAILED"] }' "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/transaction-search \ -u email:password
또한 어떤 애플리케이션, 개발자, API 제품 번들 또는 API 제품이 거래 활동 내역을 확인할 수 있습니다. 이 정보는 각각에 대해 개별적으로 확인합니다. 객체 유형입니다. 예를 들어, 리소스에 액세스하는 애플리케이션에 대한 구체적인 정보를 지정된 시작일 및 종료일 이내에 수익 창출 API 제품 번들의 API
거래 활동에 대한 정보를 보려면 다음 중 하나로 GET 요청을 실행합니다. 리소스:
리소스 | 반환 값 |
---|---|
/organizations/{org_name}/applications-with-transactions |
트랜잭션이 있는 애플리케이션 |
/organizations/{org_name}/developers-with-transactions |
거래가 있는 개발자 |
/organizations/{org_name}/products-with-transactions |
거래가 있는 제품 |
/organizations/{org_name}/packages-with-transactions |
거래가 포함된 API 제품 번들 (또는 API 패키지) |
요청 실행 시 시작일과 종료일을 쿼리 매개변수로 지정해야 합니다. 확인할 수 있습니다. 예를 들어 다음 요청은 트랜잭션이 있는 개발자를 반환합니다. 2015년 8월 동안
$ curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers-with-transactions?START_DATE=2015-08-01&END_DATE=2015-08-31" \ -u email:password
응답은 다음과 같아야 합니다(응답의 일부만 표시됨).
{ "developer" : [ { "address" : [ { "address1" : "Dev Five Address", "city" : "Pleasanton", "country" : "US", "id" : "0917f15f-9521-4e69-9376-07aa7b7b32ca", "isPrimary" : true, "state" : "CA", "zip" : "94588" } ], "approxTaxRate" : 0.0900, "billingType" : "POSTPAID", "broker" : false, "developerRole" : [ ], "email" : "dev5@myorg.com", "hasSelfBilling" : false, "id" : "tJZG6broTpGGGeLV", "legalName" : "DEV FIVE", "name" : "Dev Five", "organization" : { ... }, "registrationId" : "dev5", "status" : "ACTIVE", "type" : "UNTRUSTED" }, { "address" : [ { "address1" : "Dev Seven Address", "city" : "Pleasanton", "country" : "US", "id" : "f86d8c9f-6ed1-4323-b050-6adf494096c9", "isPrimary" : true, "state" : "CA", "zip" : "94588" } ], "approxTaxRate" : 0.0900, "billingType" : "POSTPAID", "broker" : false, "developerRole" : [ ], "email" : "dev7@myorg.com", "hasSelfBilling" : false, "id" : "VI3l8m8IPAvJTvjS", "legalName" : "DEV SEVEN", "name" : "Dev Seven", "organization" : { ... }, "registrationId" : "dev7", "status" : "ACTIVE", "type" : "UNTRUSTED" }, ... ] }
API의 보고서 구성 옵션
API에서 사용할 수 있는 보고서 구성 옵션은 다음과 같습니다.
이름 | 설명 | 기본값 | 필수 여부 |
---|---|---|---|
name |
보고서의 이름입니다. |
해당 사항 없음 | 예 |
description |
보고서에 대한 설명입니다. |
해당 사항 없음 | 아니요 |
mintCriteria |
보고서 구성을 위한 기준입니다. 기준 보기 구성 옵션을 참조하세요. |
해당 사항 없음 | 아니요 |
type |
보고서의 유형입니다. 이 값은 다음 중 하나일 수 있습니다.
|
해당 사항 없음 | 예 |
기준 구성 옵션
다음 구성 옵션은
mintCriteria
속성:
이름 | 설명 | 기본값 | 필수 여부 |
---|---|---|---|
appCriteria |
보고서에 포함할 특정 애플리케이션의 ID 및 조직입니다. 만약 속성이 지정되지 않으면 모든 애플리케이션이 보고서에 포함됩니다. |
해당 사항 없음 | 아니요 |
billingMonth |
참고: 이 속성은 수익 보고서에 사용할 수 없습니다. 보고서의 청구 월입니다(예: 7월). |
해당 없음 | 예 |
billingYear |
참고: 이 속성은 수익 보고서에 사용할 수 없습니다. 보고서의 결제 연도입니다(예: 2015). |
해당 없음 | 예 |
currCriteria |
보고서에 포함할 특정 통화의 ID 및 조직입니다. 만약 속성이 지정되지 않으면 지원되는 모든 통화가 보고서에 포함됩니다. |
해당 사항 없음 | 아니요 |
currencyOption |
보고서의 통화입니다. 유효한 값으로 다음이 포함되어 있습니다.
|
해당 사항 없음 | 아니요 |
devCriteria |
특정 개발자의 개발자 ID (이메일 주소) 및 조직 이름 확인할 수 있습니다 이 속성을 지정하지 않으면 모든 개발자가 있습니다. 예를 들면 다음과 같습니다. "devCriteria":[{ "id":"RtHAeZ6LtkSbEH56", "orgId":"my_org"} ] |
해당 사항 없음 | 아니요 |
devCustomAttributes |
참고: 이 속성은 수익 보고서에만 적용됩니다. 개발자에 대해 정의된 경우 보고서에 포함할 맞춤 속성입니다. 예를 들어 다음과 같습니다. "devCustomAttributes": [ "custom_attribute1", "custom_attribute2", ... ] 참고: 사전 정의된 |
해당 사항 없음 | 아니요 |
fromDate |
참고: 이 속성은 수익, 분산, 거래 활동 보고서 보고서의 시작일(UTC)입니다. |
해당 사항 없음 | 수익 보고서에 필수 다른 보고서 유형에는 필요하지 않습니다. |
groupBy |
보고서에서 열이 그룹화되는 순서입니다. 유효한 값으로 다음이 포함되어 있습니다.
|
해당 사항 없음 | 아니요 |
monetizationPackageId |
보고서에 포함할 하나 이상의 API 제품 번들의 ID입니다. 이 속성이 를 지정하면 모든 API 제품 번들이 보고서에 포함됩니다. 참고: 이 속성은 거래 활동 ( |
해당 사항 없음 | 아니요 |
pkgCriteria |
보고서에 포함할 특정 API 제품 번들의 ID 및 조직입니다. 만약
속성이 지정되지 않으면 모든 API 제품 번들이 보고서에 포함됩니다. 이 속성은
참고: 이 속성은 거래 활동 ( |
해당 사항 없음 | 아니요 |
prevFromDate |
참고: 이 속성은 분산 보고서에만 적용됩니다. 이전 기간의 시작일(UTC)입니다. 이전 기간에 대한 보고서를 만드는 데 현재 보고서와 비교할 수 있습니다. |
해당 사항 없음 | 아니요 |
prevToDate |
참고: 이 속성은 분산 보고서에만 적용됩니다. 이전 기간의 종료일(UTC)입니다. 이전 기간에 대한 보고서를 만드는 데 사용됨 현재 보고서와 비교할 수 있습니다. |
해당 사항 없음 | 아니요 |
prodCriteria |
보고서에 포함할 특정 API 제품의 ID 및 조직입니다. 만약
속성이 지정되지 않으면 모든 API 제품이 보고서에 포함됩니다. 이 속성은
참고: 이 속성은 거래 활동 ( |
해당 사항 없음 | N |
productIds |
보고서에 포함할 하나 이상의 API 제품의 ID입니다. 이 속성이 지정하면 모든 API 제품이 보고서에 포함됩니다. API 제품 ID는 |
해당 사항 없음 | 아니요 |
pricingTypes |
보고서에 포함할 요금제의 가격 유형입니다. 유효한 값으로 다음이 포함되어 있습니다.
이 속성을 지정하지 않으면 모든 가격 유형의 요금제가 보고서. |
해당 사항 없음 | 아니요 |
ratePlanLevels |
보고서에 포함할 요금제 유형입니다. 유효한 값으로 다음이 포함되어 있습니다.
이 속성을 지정하지 않으면 개발자별 요금제와 표준 요금제가 모두 사용됩니다. 확인할 수 있습니다 |
해당 사항 없음 | 아니요 |
showRevSharePct |
보고서에 수익 공유 비율을 표시할지 지정하는 플래그입니다. 유효한 값 포함:
|
해당 사항 없음 | 아니요 |
showSummary |
보고서가 요약인지 여부를 지정하는 플래그. 유효한 값으로 다음이 포함되어 있습니다.
|
해당 사항 없음 | 아니요 |
showTxDetail |
참고: 이 속성은 수익 보고서에만 적용됩니다. 보고서에 거래 수준 세부정보를 표시할지 지정하는 플래그입니다. 유효한 값 포함:
|
해당 사항 없음 | 아니요 |
showTxType |
보고서에 각 거래의 유형을 표시할지 지정하는 플래그입니다. 유효함 값에는 다음이 포함됩니다.
|
해당 사항 없음 | 아니요 |
toDate |
참고: 이 속성은 수익, 분산, 거래 활동 보고서 보고서의 종료일입니다(UTC 기준). 보고서에는 지정된 날짜 전 하루 동안 수집된 데이터가 포함됩니다. 지정된 종료일에 수집된 보고서 데이터는 제외됩니다. 삭제할 수 있습니다. 예를 들어 2016년 12월 31일에 요금제가 만료되도록 하려면 toDate 값을 2017-01-01로 설정해야 합니다. 이 경우 보고서에는 2016년 12월 31일 2017년 1월 1일의 보고서 데이터는 제외됩니다. |
해당 사항 없음 | 수익 보고서에 필수 다른 보고서 유형에는 필요하지 않습니다. |
transactionStatus |
보고서에 포함할 거래의 상태입니다. 유효한 값으로 다음이 포함되어 있습니다.
|
해당 사항 없음 | 아니요 |
transactionCustomAttributes |
요약 수익 보고서에 포함할 맞춤 거래 속성입니다. 사용 설정해야 합니다. 사용할 수 있습니다 다음을 참조하세요. 맞춤 설정 수익 요약 보고서의 거래 속성에 나와 있습니다. |
해당 사항 없음 | 아니요 |
transactionTypes |
보고서에 포함할 거래 유형입니다. 유효한 값으로 다음이 포함되어 있습니다.
이 속성을 지정하지 않으면 모든 거래 유형이 보고서. |
해당 사항 없음 | 아니요 |