Method: projects.preview.write

モデルに基づいてユーザーのプロジェクト プレビューを更新します。

HTTP リクエスト

POST https://actions.googleapis.com/v2/{parent=projects/*}/preview:write

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。projects/{project} 形式の親リソース名。{project} は、プロジェクトに関連付けられた Cloud プロジェクト ID です。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "previewSettings": {
    object (PreviewSettings)
  },

  // Union field source can be only one of the following:
  "files": {
    object (Files)
  },
  "draft": {
    object (ContentFromDraft)
  },
  "submittedVersion": {
    object (ContentFromSubmittedVersion)
  }
  // End of list of possible types for union field source.
}
フィールド
previewSettings

object (PreviewSettings)

必須。ユーザーのプレビューを更新するための設定。

共用体フィールド source。プレビューの作成に使用されたデータソース。source は次のいずれかになります。
files

object (Files)

一度にサーバーに送信されるファイルのリスト。これは構成ファイルまたはデータファイルのリストです。1. 最初のリクエストは ConfigFiles である必要があります。2. 最初のリクエストには、「settings」を含む ConfigFile が必要です。3. 最初のリクエストには、「manifest」が指定された ConfigFile が必要です。4. インラインの Cloud Functions の関数に対応する Webhook ConfigFile は、ソースコードに対応する DataFile の前にストリーミングする必要があります。

draft

object (ContentFromDraft)

プロジェクトのドラフトからのコンテンツ。

submittedVersion

object (ContentFromSubmittedVersion)

既存のバージョンをソースとするコンテンツ。

レスポンスの本文

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

プレビュー リソースの定義。

JSON 表現
{
  "name": string,
  "validationResults": {
    object (ValidationResults)
  },
  "simulatorUrl": string
}
フィールド
name

string

プレビューの一意の識別子。形式: projects/{project}/preview

validationResults

object (ValidationResults)

ユーザー プロジェクトのプレビュー コンテンツに関連付けられた検証結果。

simulatorUrl

string

ユーザー プレビューをテストするためのシミュレータの URL。

ContentFromDraft

プレビュー コンテンツがドラフトから取得されることを示します。

ContentFromSubmittedVersion

現在のバージョンからプレビュー コンテンツが取得されることを示します。

JSON 表現
{
  "version": string
}
フィールド
version

string

必須。プレビューの作成に使用されるプロジェクトの送信済みバージョン。形式: projects/{project}/versions/{version}

PreviewSettings

プレビューを更新するための設定です。

JSON 表現
{
  "sandbox": boolean
}
フィールド
sandbox

boolean

取引などの特定の操作をサンドボックス モードで実行するかどうかを示します。デフォルトでは、プレビュー リクエストはこれらのオペレーションをサンドボックス モードで実行します。つまり、sandbox のデフォルト値は true です。