透過應用程式介面運行報告

介紹

您可以透過「報告應用程式介面」運行任何 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

說明:您的報告數據的第一個日期範圍的開始日期。格式為 YYYY-MM-DD。

主要結束日期
顯示文字: end-date=20XX-10-26

說明:您的報告數據的第一個日期範圍的結束日期。格式為 YYYY-MM-DD。

包括摘要
顯示文字: include_summary=Y

說明:如果您希望在下載的檔案頂部顯示六行報告摘要,請將此項目設為「 Y 」。如果您不希望這樣,則將其設置為「N」。預設為「 Y 」。

聯盟網
顯示文字network=1

說明:使用此篩選器一次顯示一個聯盟網的數據,這樣多種貨幣就不會出現在同一報告中。

  • 美國=1
  • 英國=3
  • 加拿大=5
  • 巴西=8
  • 澳大利亞=41
  • 法國=7
  • 德國=9
  • 日本=11
上一個開始日期
顯示文字: previous-start-date=20XX-09-25

說明:您的報告數據的第二個範圍的開始日期。格式為 YYYY-MM-DD。

上一個結束日期
顯示文字: previous-end-date=20XX-09-26

說明:您的報告數據的第二個日期範圍的結束日期。格式為 YYYY-MM-DD。

時區
顯示文字:tz=GMT

說明:這是報告使用的時區。GMT 是默認時區。用戶可以在選擇日期時更改時區,並看到它反映在應用程式介面中。

日期類型
顯示文字: date_type=process

說明:日期類型。對處理日期使用「處理」,對交易日則使用「交易」。

日期格式
顯示文字: 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=xxxxxxxxxx

說明:此令牌可確保您的數據安全。它源於您的安全令牌。請妥善保管令牌。請勿修改該值。如果您想要更新令牌,可以在推廣商控制面板中執行此操作

預設日期範圍

我們支援在 start_dateend_date 值中指定的預設日期範圍和確切日期範圍。

這減少了為應用程式介面生成日期所需的額外邏輯。當您從日期範圍下拉式選單中選擇預設日期範圍時,報告界面會將應用程式介面 URL 設定為使用預設日期範圍。

預設日期範圍 date_range 參數的當前期間值
昨天 昨天
最後 7 天 最近 7 天
這個月 這個月
上個月 上個月
本季度 本季度
上個季度 上個季度
今年 今年
去年 去年

在與另一個時期進行比較時,這些是 previous_date_range 的值:

日期範圍 日期範圍值
上個禮拜 上個禮拜
前一個月 前一個月
上個季度 上個季度
前一年 前一年

如果您從日期選擇器中選擇「自訂日期範圍」,介面將生成具有特定日期的應用程式介面 URL。例如,如果您選擇的自訂日期範圍以 20XX 年 4 月 22 日為開始日期,以 20XX 年 5 月 5 日為結束日期,您的應用程式介面 URL 將顯示如下:

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

所選時區偏移量將套用於您的報告。日期和時間將只反映「交易日期」「交易時間」「處理日期」和「處理時間」欄位的時區。

沒有這些欄位的報告(例如「銷售與活動報告」)將套用時區偏移。包含這些欄位的報告(例如「個別項目報告」)也會套用時區偏移,如轉換後的「交易日期和時間」所示。

但是,不會對以下日期和時間欄位進行時區轉換:

  • 預訂消費日期
  • 點擊日期
  • 訂單發貨日期
  • Signature 匹配日期
  • Signature 匹配時間
  • 交易創建日期
  • 交易創建時間

日期格式參數

這是一個具有默認值的可選參數。您可以在「取得應用程式介面 URL」中輸入編碼或未編碼的 date_format 參數值。

 注意

根據您的區域設置,您的 Excel 或其他文檔應用程式可能不支援或可能會覆蓋我們某些日期格式的日期格式參數。您可能需要調整您的應用程式以支援我們的日期格式參數。

應用程式介面限制

在任何給定時間,使用報告應用程式介面的請求都僅限於一個並發調用。如果我們收到多個同時運行的請求,您將在提出所有後續請求時收到錯誤,直到一個或多個現有請求完成為止。該錯誤將是一個 HTTP 429 回應,其中包含訊息「您已超出此會話的請求限制,請稍後再試」。

查看更多可能的應用程式介面錯誤示例

如果您使用腳本調用,請確保您沒有同時進行多個調用,例如在線程循環中。如果您正在執行無限制的應用程式介面調用,請在程式編碼中暫停或限制這些調用。

本文是否有幫助?
2 人中有 2 人覺得有幫助

評論

0 條評論

登入寫評論。