通过应用程序界面运行报告

概述

您可以通过报告应用程序界面运行任何Rakuten Advertising报告,包括标准报告和定制报告。这样,您就可以在不登录账户的情况下运行报告。

说明

请按照以下步骤获取报告的应用程序界面URL:

  1. 访问报告界面
  2. 选择报告下拉菜单中选择标准报告,或创建自己的报告。
  3. 选择日期范围参数。
  4. 如果您愿意,可应用任何筛选器或添加或删除任何指标列和数据点来定制报告,然后点击保存报告
  5. 点击查看报告旁边的箭头,然后选择获取应用程序界面

    get api.png

  6. 将出现“获取应用程序界面URL”弹出窗口。它会显示一个包含网络令牌的URL。复制应用程序界面URL并将其保存到安全位置。

 注意事项

您的应用程序界面URL包含一个令牌,无需登录账户即可访问报告数据。应像保管用户名和密码一样将其妥善保管。有关令牌参数的更多信息,请参阅下面的“应用程序界面URL”部分。

应用

您可以随时将应用程序界面URL粘贴到任何浏览器中,无需访问报告界面即可生成报告。包含报告数据的CSV 文件将下载到您的电脑。CSV文件可在Excel中打开。

应用程序界面URL

您可以修改当前使用的现有应用程序界面参数或创建新的报告应用程序界面URL,而无需返回报告界面。应用程序界面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

以上绿色部分均可编辑。点击每个参数名称旁边的+号,了解更多信息:

主要开始日期
显示文本: start-date=20XX-10-25

说明:报告日期第一个日期范围的开始日期。格式为年-月-日。

主要结束日期
显示文本: end-date=20XX-10-26

说明:报告日期第一个日期范围的结束日期。格式为年-月-日。

包括摘要
显示文本: include_summary=Y

说明:如果您希望在下载文件的顶部显示六行报告摘要,请将此设置为 Y 。如果您不需要摘要,请将其设置为“N”。默认为 Y

联盟
显示文本: network=1

说明:使用此过滤器一次只显示一个联盟的数据,因此不会在同一报告中出现多种货币。

  • 美国=1
  • 英国=3
  • 加拿大=5
  • 巴西=8
  • 澳大利亚=41
  • 法国=7
  • 德国=9
  • 日本=11
上一个开始日期
显示文本: previous-start-date=20XX-09-25

说明:报告数据第二个日期范围的开始日期。格式为年-月-日。

上一个结束日期
显示文本: previous-end-date=20XX-09-26

说明:报告数据第二个日期范围的结束日期。格式为年-月-日。

时区
显示文本: tz=GMT

说明:这是报告使用的时区。默认时区为 GMT。用户可在选择日期时改变时区,并可在应用程序界面中看到经更改的时区。

日期类型
显示文本: date_type=process

说明:日期类型。处理日期用 process,交易日期用 transaction

日期格式
显示文本: date_format=XXXX/XX/XX

说明:这是一个可选参数,有默认值。使用以下字段之一来格式化报告中的日期。如果未指定,我们会将所有网络的默认值设置为:非日语联盟为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
令牌
显示文本: token=xxxxxxxxxxxx

说明:该令牌可确保您的数据安全。它源自您的安全令牌。妥善保管令牌。请勿修改该值。如果您想更新令牌,可以在推广者控制面板中进行更新

预设日期范围

我们既支持预设日期范围,也支持在 start_dateend_date 值中指定的精确日期范围。

这就减少了为应用程序界面生成日期所需的额外逻辑。当您从日期范围下拉菜单中选择预设日期范围时,报告界面会将应用程序界面URL设置为使用预设日期范围。

预设日期范围 date_range 参数在当前周期的值
昨天 昨天
最近7天 最近7天
本月 本月
上月 上月
本季度 本季度
上季度 上季度
本年 本年
去年 去年

与其他时期相比,以下是 previous_date_range 值:

日期范围 日期范围标准用语
上周 上周
上个月 上个-月
上季度 上-季度
上年 previous-year

如果从日期选择器中选择“自定义日期范围”,界面将生成包含特定日期的应用程序界面URL。例如,如果您选择了一个自定义日期范围,将20XX年4月22日作为开始日期,20XX年5月5日作为结束日期,则您的应用程序界面URL将如下所示:

/filters?start_date=20XX-04-22&end_date=20XX-05-05

选定的时区调整将应用到您的报告中。日期和时间将仅反映交易日期、交易时间、处理日期和处理时间列的时区。

没有这些列的报告(如销售和活动报表)将应用时区偏移。包含这些列的报告(如单个项目报表)也会应用时区偏移,如转换后的交易日期和时间所示。

但是,下列日期和时间列不进行时区转换:

  • 预订消费日期
  • 点击日期
  • 订单发货日期
  • 签名日期
  • 签名时间
  • 交易创建日期
  • 交易创建时间

日期格式参数

这是一个带默认值的可选参数。您可以在“获取应用程序界面URL”中输入已编码或未编码的 date_format 参数值。

 注意

根据您的语言区域设置,您的 Excel 或其他文件应用程序可能不支持或可能在某些日期格式中覆盖我们的日期格式参数。您可能需要调整您的应用程序,以支持我们的日期格式参数。

应用程序界面限制

使用报告 API 的请求在任何时候都被限制为一个并发调用。如果我们收到一个以上的请求同时运行,在一个或多个现有请求完成之前,所有其他请求都会出错。错误类型为HTTP 429,错误提示信息为“ 您已超出此次会话的请求限制,请稍后再试 ”。

查看更多可能的应用程序界面错误示例

如果使用脚本调用,请确保不要同时进行多个调用,例如在线程循环中。如果您正在执行无限制应用程序界面调用,请在代码中设置暂停或限制调用。

本文是否有帮助?
2 人中有 2 人觉得有帮助

评论

0 条评论

登录写评论。