取得ログ
Analyticsは、APIを介してBigQueryに収集されたデータをクエリすることを可能にします。
参照: Analytics Operation Structure
準備¶
データクエリAPIを使用するには、Hiveコンソール → アナリティクス → ログ定義メニューを通じてログクエリAPIの申請を完了する必要があります。申請が完了すると、クエリできるログに対してAccessKeyとSecondAccessKeyが発行されます。AccessKeyとSecondAccessKeyはどちらも同じ機能を持ち、SecondAccessKeyはAccessKeyに問題が発生した場合に使用するために発行される追加のキーです。
※ AccessKey と SecondAccessKey は機密として保持し、外部に公開してはいけません。 ※ AccessKey または SecondAccessKey が公開された場合は、直ちに更新または取り消す必要があります。
データクエリOpenAPIに申し込む方法¶
ログ定義メニューでアクセスキーを発行したいゲームを選択し、次に発行したいログ名をクリックして詳細ページに入ります。 'OpenAPIに申請'ボタンをクリックし、次に'確認'ボタンを押してキーを発行します。
アクセスキーを更新または取り消す方法¶
ログ定義メニューで更新または取り消したいゲームを選択し、ログ名をクリックして詳細ページに入ります。 更新: '更新'ボタンをクリックして新しい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 | STRING | O | UTCでの検索開始時間 (フォーマット: yyyy-MM-dd hh:mm:ss) (次のトークン値を送信する場合は必須: いいえ) | 2024-01-01 00:00:00 |
| endDate | STRING | O | UTCでの検索終了時間 (フォーマット: yyyy-MM-dd hh:mm:ss) (次のトークン値を送信する場合は必須: いいえ) | 2024-01-02 00:00:00 |
| properties | JSON | X | JSON形式の検索条件 {BigQueryフィールド名: 検索値, ...} | {"vid":123, "market":"A"} |
| QueryType | STRING | X | "0": カスタムフィールドのみを含む, "1": すべてのフィールドを含む (デフォルト: "0") | "0" |
| nextPageToken | STRING | 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}
- 説明: 検索条件に一致するログが過去1年以内にBigQueryに存在するかどうかを確認します。
リクエスト (POST, application/json)¶
| 名前 | タイプ | 必須 | 説明 | 例 |
| properties | JSON | O | JSON形式の検索条件 {BigQueryフィールド名: 検索値, ...} | {"guid":"52e10350-fe3d-487f-8631-1dc640010c87"} |
応答 (application/json)¶
| 名前 | タイプ | 説明 | 例 |
| isExists | BOOLEAN | データが存在するかどうか | true |
| datas | LIST[JSON] | 既存データの最新の5つのサンプル値 検索条件に一致するフィールド値とともに、dateTimeおよび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: システムエラー
- データの取得および処理中に発生したエラーです。
- クエリ条件のフィールド名または値の型が正しいことを確認してください。
- 詳細に「システムエラー」と表示され、未知のエラーを示している場合は、しばらくしてから再試行してください。