检索日志

分析允許您通過 API 查詢在 BigQuery 中收集的數據。

準備¶

要使用數據查詢 API，您必須通過 Hive 控制台 → 分析 → 日誌定義菜單完成日誌查詢 API 的申請。申請完成後，將為您可以查詢的日誌發放 AccessKey 和 SecondAccessKey。AccessKey 和 SecondAccessKey 的功能相同，SecondAccessKey 是在 AccessKey 出現問題時發放的額外密鑰。

※ AccessKey 和 SecondAccessKey 應保持機密，並且不得外部公開。 ※ 如果 AccessKey 或 SecondAccessKey 被公開，必須立即刷新或撤銷。

如何申請數據查詢 OpenAPI¶

在日誌定義菜單中選擇您想要發出 AccessKey 的遊戲，然後單擊您想要發出的日誌名稱以進入詳細頁面。單擊“申請 OpenAPI”按鈕，然後按“確認”按鈕以發出密鑰。

如何更新或撤銷 AccessKey¶

在日誌定義菜單中選擇您想要續訂或撤銷 AccessKey 的遊戲，然後點擊日誌名稱以進入詳細頁面。續訂：點擊「續訂」按鈕以發出新的 AccessKey，之前發出的 AccessKey 將變得無法使用。撤銷：點擊「撤銷」按鈕以刪除現有的 AccessKey，該密鑰將不再可用。

常見的 API 資訊¶

服務類型	域名
生產	analytics-openapi.com2us.com
沙盒	sandbox-analytics-openapi.com2us.com

必要的標頭參數：X-Analyitcs-Accesskey 您必須在請求標頭中包含此密鑰值，以驗證對OpenAPI數據查詢的訪問權限。

數據查詢 API¶

URL: https://{domain}/data/query/{logName}
描述：檢索符合指定查詢條件的數據。

請求 (POST, application/json)¶

名稱	類型	必填	描述	範例
startDate	字串	O	搜尋開始時間（UTC格式：yyyy-MM-dd hh:mm:ss）（如果發送nextToken值：不需要）	2024-01-01 00:00:00
endDate	字串	O	搜尋結束時間（UTC格式：yyyy-MM-dd hh:mm:ss）（如果發送nextToken值：不需要）	2024-01-02 00:00:00
properties	JSON	X	JSON格式的搜尋條件 {BigQuery欄位名稱：搜尋值，...}	{"vid":123, "market":"A"}
QueryType	字串	X	"0"：僅包含自定義欄位，"1"：包含所有欄位（預設："0"）	"0"
nextPageToken	字串	X	用於檢索下一頁數據的令牌值，每頁返回20條數據，查詢此值時不需要其他參數。	f3ebf4b6859a4f248b283a4fff1ded13

回應 (application/json)¶

名稱	類型	描述	範例
totalRows	整數	搜尋結果中的總行數	123
nextPageToken	字串	用於檢索下一頁的令牌 * 如果是最後一頁，則為 null	f3ebf4b6859a4f248b283a4fff1ded13
datas	列表[JSON]	檢索到的數據	[ { "dateTime": "2024-01-01T23:38:24Z", "vid": 123, "characterLv": 1 }, ... ]

請求範例¶

curl -X 'POST' \
'https://sandbox-analytics-openapi.com2us.com/data/query/hive_login_log' \
-H 'accept: application/json' \
-H 'X-Analyitcs-Accesskey: Your access key' \
-H 'Content-Type: application/json' \
-d '{
"startDate": "2024-04-16 00:00:00",
"endDate": "2024-04-17 00:00:00"
}'

數據檢查 API¶

URL: https://{domain}/data/check/{logName}
Description: 檢查在過去一年內，是否存在符合搜索條件的日誌在 BigQuery 中。

請求 (POST, application/json)¶

名稱	類型	必填	描述	範例
properties	JSON	O	JSON格式的搜索條件 {BigQuery字段名稱: 搜索值, ...}	{"guid":"52e10350-fe3d-487f-8631-1dc640010c87"}

回應 (application/json)¶

名稱	類型	描述	範例
isExists	布林值	資料是否存在	true
datas	列表[JSON]	現有資料的最新5個樣本值包括符合搜尋條件的日期時間和GUID值以及欄位值。	[ { "vid": 123, "dateTime": "2024-04-16T23:09:24Z", "guid": "52e10350-fe3d-487f-8631-1dc640010c87" }, ... ]

請求範例¶

curl -X 'POST' \
'https://sandbox-analytics-openapi.com2us.com/data/check/hive_login_log' \
-H 'accept: application/json' \
-H 'X-Analyitcs-Accesskey: Your access key' \
-H 'Content-Type: application/json' \
-d '{
"properties": {"guid":"52e10350-fe3d-487f-8631-1dc640010c87"}
}'

錯誤代碼¶

有關每個錯誤代碼的詳細信息，請參閱返回值中的詳細消息。

40x: 存取金鑰錯誤
- 存取金鑰必須與您嘗試查詢的公司、遊戲和日誌名稱的存取金鑰相符。如果發生此錯誤，您需要驗證存取金鑰是否正確。
50x: 系統錯誤
- 在數據檢索和處理過程中發生的錯誤。
- 確保查詢條件中的欄位名稱或值類型正確。
- 如果詳細信息顯示“系統錯誤”，表示未知錯誤，請稍後再試。