API利用方法について - APIを利用してデータポイントを使用したテストを作成する – Game Tester

APIの利用方法について

この記事では、Game Testerのテスト作成時にAPIの利用を選択した際の利用方法についての記事となります。Game Testerを初めてご利用の方は、「ご利用の流れ」をご覧ください。

テストの提出をする前に、開発環境で実行することが推奨されております。開発者によるAPIの利用方法を紹介します。

事前準備

APIを利用するためにはプラットフォーム上から取得できる3つのパラメーターが必要です。

Developer Api Token
Player Connect Url
Testing PIN

1. 「Developer Api Token」「Player Connect Url」を取得

作成したテストを選択

「Run A Test」→ 「Tests」からテストを選択します。

Summaryを選択

作成したテストのSummaryをクリックし、選択します。

Developer Api Tokenをコピー

「Developer Api Token」と「Player Connect Url」をコピーします。

2. 「Testing PIN」を取得

API Validationをクリック

Testing PINをコピー

これでAPI利用のためのパラメータの3つを取得することができました。
次はこの値を使用してAPIの利用の流れを確認します。

APIを利用する

APIドキュメントについて

今回は、このWeb向けのゲームにGame TesterのAPIを組み込みます。Game Testerから公開されているAPIの資料は2種類あります。

・API Overview Game Tester API Overview

・API Documentation Game Tester API Documentation

プラットフォームログイン後Game Testerプラットフォームのサイドバーの「Documentation」から資料をダウンロードすることができます。

Game TesterのAPIを利用したテストの実施ついて

Game TesterのAPIを利用する場合には、REST APIを使用して、ゲームと、Game TesterのAPIサーバーと通信をしてテスターのゲームの起動・データポイント・テスト完了の動作を記録することができます。

手順

作成したテストをユーザーに実施する前に、Game Testerの開発環境を使用して組み込みを行う際にAPIを利用したテストの実施はこちらの流れで行います。
　
1. テスターの認証(Auth)

テスターの認証をします

エンドポイント

https://server.gametester.gg/dev-api/v1/auth

Curl

curl -X POST \
 https://server.gametester.gg/dev-api/v1/auth \
-H 'content-type: application/json' \
-d '{
"developerToken": "コピーしたdeveloperToken",
"connectToken": "コピーしたconnectToken",
"playerPin": "コピーしたTesting PIN"
}'

レスポンス

認証に成功した場合、playerName, playerTokenがレスポンスとして取得できます。

「データポイント」・「テストの終了」をする際にこちらの値を使用します。

{ 
　　　　"code": -1, 
　　　　"message": "Authentication successful",
　　　 "playerName": "__DEVELOPER__",
　　　 "playerToken": "xxxxxxxxxxxxxxxx"
}

2. データポイント(API Datapoints)の確認

データポイントは、テスト中のプレイヤーの行動を把握できるものです。このテストでは、下記の3つのデータポイントが設定されています。

「レベル2に到達」(id 1)
「隠されたアイテムを手に入れた」(id 2)
「ショップの画面を開いた」(id 3)

「レベル2に到達」(id 1)のデータポイントのエンドポイントを呼び出す

それぞれのデータポイントには、それぞれ整数のidが割り振られています。

「レベル2に到達」(id 1)を呼び出す場合には、「テスターの認証」のレスポンス内のplayerTokenとdatapointIdのidをパラメータに追加をしてエンドポイントを呼び出します。

エンドポイント

https://server.gametester.gg/dev-api/v1/

Curl

curl -X POST \
https://server.gametester.gg/dev-api/v1/ \
-d '{
"developerToken": "コピーしたdeveloperToken",
"playerToken": "xxxxxxxxxxxxxxxx",
"datapointId": 1
}'

成功した場合

__________2021-04-02_23.48.50.png

エンドポイントを正しく呼び出すことができた場合には、プラットフォーム上のエンドポイントのHitsの値が増え、アイコンが緑色のチェックマークになります。

成功した場合（レスポンス）

{ 
    "code": -1, 
    "message": "Datapoint logged", 
}

3. テストの終了(Functions)の確認

最後にテストが終了をする際のデータポイントを呼び出し、テストの終了をプラットフォームに通知します。

エンドポイント

https://server.gametester.gg/dev-api/v1/unlock

Curl

curl -X POST \
https://server.gametester.gg/dev-api/v1/unlock \
-H 'content-type: application/json' \
-d '{
"developerToken": "コピーしたdeveloperToken ",
"playerToken": "xxxxxxxxxxxxxxxx"
}'

成功した場合

成功した場合（レスポンス）

 { 
    "code": -1, 
    "message": "Unlock completed" 
}

これでAPIの設定をすることができました。対応している各ゲームエンジンへの組み込み方法はこちらをご覧ください。

「Unity | unity-example - GitHub」

「Game Maker | game-maker-studio-api-wrapper - GitHub」

APIの利用方法について

事前準備

1. 「Developer Api Token」「Player Connect Url」を取得

2. 「Testing PIN」を取得

APIを利用する

手順

関連記事