ステップに添付された画像のサムネイルを一覧表示します。
次の正規エラー コードのいずれかを返す場合があります。 - PERMISSION_DENIED - ユーザーがプロジェクトまたはイメージから読み取る権限がない場合 - INVALID_ARGUMENT - リクエストの形式が不正な場合 - NOT_FOUND - ステップが存在しない場合、またはいずれかの画像が存在しない場合
HTTPリクエスト
GET https://toolresults.googleapis.com/toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails
URL はgRPC トランスコーディング構文を使用します。
パスパラメータ
パラメーター | |
---|---|
projectId | プロジェクト ID。 必須。 |
historyId | 履歴ID。 必須。 |
executionId | 実行ID。 必須。 |
stepId | ステップID。 必須。 |
クエリパラメータ
パラメーター | |
---|---|
pageToken | 次の項目でクエリを再開するための継続トークン。 オプション。 |
pageSize | 取得するサムネイルの最大数。 デフォルト値: 50。フィールドが設定されていないか、値が 0 の場合、サーバーはこのデフォルトを使用します。 オプション。 |
リクエストボディ
リクエストの本文は空である必要があります。
レスポンスボディ
ステップ内のサムネイルを含む応答。
成功した場合、応答本文には次の構造のデータが含まれます。
JSON表現 |
---|
{
"thumbnails": [
{
object ( |
田畑 | |
---|---|
thumbnails[] | 画像データの一覧です。 画像は決定的な順序で返されます。それらは、重要度の順に、次の要素によって並べられます。 * まず、関連するテスト ケースによって並べられます。テスト ケースのないイメージは、テスト ケースのあるイメージよりも優れていると見なされます。 * 次に、作成時間による。作成時刻のないイメージは、作成時刻のあるイメージよりも優れています。 * 3 番目に、ステップに追加された順序 (steps.create またはsteps.patch の呼び出しによって)。 |
nextPageToken | 次の項目でクエリを再開するための継続トークン。 設定されている場合、pageToken フィールドにこの値を指定して list を再度呼び出すことにより、読み取るサムネイルがさらにあることを示します。 |
認可範囲
次の OAuth スコープが必要です。
-
https://www.googleapis.com/auth/cloud-platform
詳細については、 「認証の概要」を参照してください。
画像
メイン画像とサムネイルへのリンクを含む画像。
JSON表現 |
---|
{ "stepId": string, "sourceImage": { object ( |
田畑 | |
---|---|
stepId | イメージが添付されるステップ。 常に設定します。 |
sourceImage | フルサイズの元の画像への参照。 これは、そのステップの下にある画像のtoolOutputsエントリと同じです。 常に設定します。 |
ユニオンフィールドthumbnail_or_error 。画像のサムネイル、またはサムネイルをレンダリングできなかった理由を説明するエラー。 thumbnail_or_error 次のいずれか 1 つだけです。 | |
thumbnail | サムネイル。 |
error | サムネイルをレンダリングできなかった理由を説明するエラー。 |
サムネイル
単一のサムネイルとそのサイズと形式。
JSON表現 |
---|
{ "contentType": string, "heightPx": integer, "widthPx": integer, "data": string } |
田畑 | |
---|---|
contentType | サムネイルのコンテンツ タイプ、つまり「image/png」。 常に設定します。 |
heightPx | サムネイルの高さ (ピクセル単位)。 常に設定します。 |
widthPx | サムネイルの幅 (ピクセル単位)。 常に設定します。 |
data | サムネイル ファイル自体。 つまり、ここでのバイトはまさにサムネイル ファイルを構成するバイトです。これらは、(適切なコンテンツ タイプを使用して)そのままの画像として提供できます。 常に設定します。 Base64 でエンコードされた文字列。 |
状態
Status
タイプは、REST API や RPC API などのさまざまなプログラミング環境に適した論理エラー モデルを定義します。 gRPCによって使用されます。各Status
メッセージには、エラー コード、エラー メッセージ、エラーの詳細という 3 つのデータが含まれています。
このエラー モデルとその操作方法の詳細については、 「API 設計ガイド」を参照してください。
JSON表現 |
---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
田畑 | |
---|---|
code | ステータス コード。 |
message | 開発者向けのエラー メッセージ。英語である必要があります。ユーザー向けのエラー メッセージはローカライズして |
details[] | エラーの詳細を伝えるメッセージのリスト。 API で使用する共通のメッセージ タイプのセットがあります。 任意の型のフィールドを含むオブジェクト。追加フィールド |