管理报告

您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。信息

简介

通过创收报告，您可以访问重点使用情况信息和交易活动。 例如，您可以确定在给定日期范围内哪些应用、开发者、API 产品套装或 API 产品有交易活动。借助获利功能，您可以生成摘要或 用于跟踪 API 使用情况的详细报告。

创收报告类型

您可以生成以下类型的创收报告。

数据保留简介

在 Apigee Edge 公有云中，创收数据保留是一项方案权限。请参阅 创收权益，请访问 https://cloud.google.com/apigee/specsheets。 如果您希望在权限期结束后保留创收数据，请与 Apigee 销售团队联系。延长数据保留期限功能会在您提出请求时启用，无法以追溯方式启用，以涵盖原始数据保留期限之前的数据。

关于重复交易

如果您将创收交易报告与 Google Analytics 数据进行比较，可能会发现一个小小的 重复交易的数量。这是正常现象，因为创收系统 每天处理数百万个交易，同时并行处理许多交易 特定时刻。平均而言，大约 0.1% 的交易可能是重复的。

探索“创收报告”页面

访问“创收报告”页面（如下所述）。

配置报告

使用界面配置报告，如以下部分所述。

配置报告的步骤

使用 Edge 界面或传统版 Edge 界面配置报告。

配置结算报告

按照报告配置步骤操作，并在报告页面中输入以下信息：

配置预付款余额报告

配置收入报告

按照配置报告的步骤操作，然后在报告页面中输入以下信息：

在收入摘要报告中加入自定义交易属性

借助事务记录政策，您可以从交易中捕获自定义属性数据，并在摘要收入报告中包含这些自定义属性。定义默认的 通过设置将自定义属性列入获利数据库表 贵组织的 MINT.SUMMARY_CUSTOM_ATTRIBUTES 属性。

使用该功能需要一些考虑和计划，因此请查看以下注意事项。

如果您是 Cloud 客户，请与 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">[&quot;partner_id&quot;,&quot;tax_source&quot;]</Property>
        <Property name="features.topLevelDevelopersAreCompanies">false</Property>
    </Properties>
</Organization>"

在此示例中，API 调用会启用 将 partner_id 和 tax_source 列添加到 创收数据库。请注意，API 调用中的自定义属性数组已进行网址编码。

在报告中添加自定义交易属性的注意事项

• 在使用 API 创建属性之前，请确定要使用的属性名称。 这些是数据库中的列名称，自定义属性数据始终存储在其中。
• 每项交易记录政策中有 10 个可用的自定义属性位置， 如下图所示请为报告中包含的商品中的相同属性使用完全相同的属性名称和位置。例如，在以下 交易记录政策、partner_id和tax_source自定义 属性分别占据了方框 4 和 5。这应是所有交易记录政策中相应产品的负责人的姓名和职位，以便将相应产品纳入报告中。
  
  

要在启用此功能后将自定义属性添加到摘要收入报告中，请使用 方法是将 transactionCustomAttributes 添加到 MintCriteria。请参阅条件配置选项。

配置差异报告（已弃用）

按照配置报告的步骤操作，然后在报告页面中输入以下信息：

生成和下载报告

创建报告后，您即可以 CSV 或 ZIP 文件格式下载报告结果。 您可以同步或异步生成 CSV 或 ZIP 文件。

• 对于同步报告，您运行报告请求，并且在分析服务器提供响应之前，该请求会被阻止。但是，由于报告可能需要处理大量数据（例如 100 GB），同步报告可能会由于超时而失败。

  摘要报表级别仅支持同步生成。

• 对于异步报告，您运行报告请求并在稍后检索结果。适合使用异步查询处理的情况包括：

  • 分析和生成跨越很长时间间隔的报告。
  • 使用各种分组维度以及增加查询复杂性的其他限制条件来分析数据
  • 在发现某些用户或组织的数据量大幅增加时管理查询。

  详细报告级别支持异步生成。

要生成和下载 CSV 或 zip 文件格式的报告，请执行以下任务之一：

1. 访问“报告”页面。
2. 将光标悬停在要下载的报告上。

3. 在“修改时间”列下，点击以下任一选项：

   1. 图标或 图标（适用于摘要报告）。报告会同步保存到 CSV 或 ZIP 文件中。
   2. 提交作业（针对详细报告）。异步作业开始运行。

      1. 在修改时间列中监控作业的状态。

         当报告可供下载时，系统会显示磁盘图标：

         
      2. 作业完成后，点击磁盘图标下载报告。

以下是摘要结算报告的 CSV 文件示例。

修改报告

要修改报告，请执行以下操作：

1. 访问“报告”页面。
2. 将光标置于要修改的报告上，然后点击操作菜单中的 。
3. 根据需要更新报告配置。
4. 点击更新报告以保存更新后的报告配置。

删除报告

要删除报告，请执行以下操作：

1. 访问“报告”页面。
2. 将光标置于要删除的报告上。
3. 点击操作菜单中的 。

使用 API 管理创收报告

以下部分介绍了如何使用 API 管理创收报告。

使用 API 配置报告

要为整个组织配置报告，请将 POST 请求发送至 /organizations/{org_name}/report-definitions。

如需为特定开发者配置报告，请向 /organizations/{org_name}/developers/{dev_id}/report-definitions 发出 POST 请求，其中 {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 FIVE 在 2015 年 6 月的活动。

$ 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 查看报告配置

您可以查看组织的特定报告配置或所有报告配置。您 也可以查看单个开发者的报告配置

要查看某个组织的特定报告配置，请向以下地址发出 GET 请求： /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 发出 GET 请求。

您可以传递以下查询参数来对结果进行过滤和排序：

例如，以下代码会返回组织的报告配置，并将检索限制为最多五个报告配置：

$ 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 更新报告配置

如需更新报告配置，请向 /organizations/{org_name}/report-definitions/{report_definition_id} 发出 PUT 请求，其中 {report_definition_id} 是特定报告配置的标识。进行更新时，您需要在请求正文中指定更新后的配置值和报告配置的 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 删除报告配置

如需删除报告配置，请向 /organizations/{org_namer}/report-definitions/{report_definition_id} 发出 DELETE 请求，其中 {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

例如，如需生成结算报告，请向 organizations/{org_name}/billing-reports 发出 POST 请求。

在请求正文（适用于任何类型的报告）中，指定报告的搜索条件。使用 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

如果自定义 属性。您可以在向组织添加开发者时定义自定义属性，如管理应用开发者中所述。

如需在收入报告中添加自定义属性，请向 organizations/{org_name}/revenue-reports 发出 POST 请求，并在请求正文中添加 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 报告交易活动

您可以向 /organizations/{org_name}/transaction-search 发出 POST 请求，查看组织的交易活动。提出请求时，您需要 指定检索条件。您可以将以下内容指定为条件：

• 已发出交易的一个或多个 API 产品的 ID。
• 交易的结算月份和年份。
• 发起交易的开发者。
• 交易类型，例如购买费和设置费。
• 交易状态，例如成功和失败。

如需查看完整的标准列表，请参阅标准配置选项。

例如，以下查询会返回特定开发者在 2015 年 6 月的结算月份发出的交易：

$ 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 请求 资源：

发出请求时，您需要将日期范围的开始日期和结束日期作为查询参数指定。例如，以下请求会返回在 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 使用：

标准配置选项

您可以通过 mintCriteria 属性为报告使用以下配置选项：

"devCriteria":[{
    "id":"RtHAeZ6LtkSbEH56",
    "orgId":"my_org"}
]
                

"devCustomAttributes": [
    "custom_attribute1",
    "custom_attribute2",
    ...
]