Cloud Tool Results API

デベロッパー ツールの結果を公開してアクセスするための API。

サービス: toolresults.googleapis.com

このサービスを呼び出すには、Google が提供するクライアント ライブラリを使用することをおすすめします。アプリケーションで独自のライブラリを使用してこのサービスを呼び出す必要がある場合は、API リクエストの際に次の情報を使用してください。

ディスカバリ ドキュメント

ディスカバリ ドキュメントは、REST API を記述して使用するための機械可読仕様です。クライアント ライブラリ、IDE プラグイン、Google API と連携するその他のツールのビルドに使用されます。1 つのサービスで複数のディスカバリ ドキュメントを提供できます。このサービスには、次の検索ドキュメントが用意されています。

サービス エンドポイント

サービス エンドポイントは、API サービスのネットワーク アドレスを指定するベース URL です。1 つのサービスに複数のサービス エンドポイントが存在することもあります。このサービスには次のサービス エンドポイントがあり、以下のすべての URI がこのサービス エンドポイントに関連しています。

  • https://toolresults.googleapis.com

REST リソース: v1beta3.projects

メソッド
getSettings GET /toolresults/v1beta3/projects/{projectId}/settings
プロジェクトのツール結果の設定を取得します。
initializeSettings POST /toolresults/v1beta3/projects/{projectId}:initializeSettings
まだ設定されていない設定用のリソースを作成します。

REST リソース: v1beta3.projects.histories

メソッド
create POST /toolresults/v1beta3/projects/{projectId}/histories
履歴を作成します。
get GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}
履歴を取得します。
list GET /toolresults/v1beta3/projects/{projectId}/histories
指定されたプロジェクトの履歴を一覧表示します。

REST リソース: v1beta3.projects.histories.executions

メソッド
create POST /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions
実行を作成します。
get GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}
実行を取得します。
list GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions
指定された履歴の実行を一覧表示します。
patch PATCH /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}
指定された部分エンティティで既存の実行を更新します。

REST リソース: v1beta3.projects.histories.executions.clusters

メソッド
get GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters/{clusterId}
単一のスクリーンショット クラスタを ID で取得します。
list GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters

スクリーンショット クラスタを一覧表示します。

実行に対応するスクリーンショット クラスタのリストを返します。

REST リソース: v1beta3.projects.histories.executions.environments

メソッド
get GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments/{environmentId}
環境を取得します。
list GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments
指定された実行の環境を一覧表示します。

REST リソース: v1beta3.projects.histories.executions.steps

メソッド
accessibilityClusters GET /toolresults/v1beta3/{name=projects/*/histories/*/executions/*/steps/*}:accessibilityClusters

指定されたステップのユーザー補助クラスタを一覧表示します

次の標準的なエラーコードのいずれかを返すことがあります。

  • PERMISSION_DENIED - プロジェクトを読み込む権限がユーザーにない場合
  • INVALID_ARGUMENT - リクエストの形式が正しくない場合
  • FAILED_PRECONDITION - リクエスト内の引数が無効な場合。例:
create POST /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps
ステップを作成します。
get GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}
ステップを取得します。
getPerfMetricsSummary GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary
PerfMetricsSummary を取得します。
list GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps
指定された実行のステップを一覧表示します。
patch PATCH /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}
指定された部分エンティティで既存の Step を更新します。
publishXunitXmlFiles POST /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}:publishXunitXmlFiles
XML ファイルを既存のステップにパブリッシュします。

REST リソース: v1beta3.projects.histories.executions.steps.perfMetricsSummary

メソッド
create POST /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary
PerfMetricsSummary リソースを作成します。

REST リソース: v1beta3.projects.histories.executions.steps.perfSampleSeries

メソッド
create POST /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries
PerfSampleSeries を作成します。
get GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}
PerfSampleSeries を取得します。
list GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries
指定されたステップの PerfSampleSeries を一覧表示します。

REST リソース: v1beta3.projects.histories.executions.steps.perfSampleSeries.samples

メソッド
batchCreate POST /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples:batchCreate
PerfSamples のバッチを作成します。クライアントはこのメソッドを繰り返し呼び出して Perf サンプルのバッチを複数送信し、大きなリクエスト ペイロードを分割できます。重複し、既存のタイムスタンプ エントリは無視されます。
list GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples

指定されたサンプルシリーズのパフォーマンス サンプルを一覧表示します。- リストの結果は、タイムスタンプの昇順で並べ替えられます。- デフォルトのページサイズは 500 サンプルです。5000 - レスポンス トークンは、最後に返された PerfSample タイムスタンプを示します。結果のサイズがページサイズを超えた場合、ページトークンを含む後続のリクエストを送信して、ページ制限までの残りのサンプルを返します。

次のいずれかの正規エラーコードが返される可能性があります。- OUT_OF_RANGE - 指定されたリクエスト page_token が有効な範囲外です - NOT_FOUND - 含まれる PerfSampleSeries が存在しません

REST リソース: v1beta3.projects.histories.executions.steps.testCases

メソッド
get GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases/{testCaseId}
ステップのテストケースの詳細を取得します。
list GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases
ステップに接続されているテストケースを一覧表示します。

REST リソース: v1beta3.projects.histories.executions.steps.thumbnails

メソッド
list GET /toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails
ステップに添付された画像のサムネイルを一覧表示します。