Method: projects.preview.write

Aktualisiert die Projektvorschau des Nutzers auf Grundlage des Modells.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Erforderlich. Der Name der übergeordneten Ressource im Format projects/{project}. Die {project} ist die mit dem Projekt verknüpfte Cloud-Projekt-ID.

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "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.
}
Felder
previewSettings

object (PreviewSettings)

Erforderlich. Die Einstellungen zum Aktualisieren der Vorschau des Nutzers.
Union-Feld source. Datenquelle, die zum Erstellen der Vorschau verwendet wurde. Für source ist nur einer der folgenden Werte zulässig:
files

object (Files)

Liste der Dateien, die gleichzeitig an den Server gesendet wurden. Dies ist eine Liste von Konfigurationsdateien oder Datendateien. 1. Die erste Anfrage muss eine ConfigFiles sein. 2. Die erste Anfrage muss eine ConfigFile mit „settings“ haben. 3. Die erste Anfrage muss eine ConfigFile mit „manifest“ haben. 4. Die Webhook-Konfigurationsdatei, die der Inline-Cloud Functions-Funktion entspricht, muss vor der DataFile gestreamt werden, die ihrem Quellcode entspricht.
draft

object (ContentFromDraft)

Inhalte aus dem Projektentwurf.
submittedVersion

object (ContentFromSubmittedVersion)

Inhalte aus einer bestehenden Version

Antworttext

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

Definition der Vorschauressource.

JSON-Darstellung 
{
  "name": string,
  "validationResults": {
    object (ValidationResults)
  },
  "simulatorUrl": string
}
Felder
name

string

Die eindeutige ID der Vorschau. Format: projects/{project}/preview
validationResults

object (ValidationResults)

Validierungsergebnisse, die mit dem Vorschauinhalt des Nutzerprojekts verknüpft sind.
simulatorUrl

string

Die Simulator-URL zum Testen der Nutzervorschau.

ContentFromDraft

Gibt an, dass der Vorschauinhalt aus dem Entwurf stammt.

ContentFromSubmittedVersion

Gibt an, dass der Vorschauinhalt aus einer schließenden Version stammt.

JSON-Darstellung 
{
  "version": string
}
Felder
version

string

Erforderlich. Eingereichte Version des Projekts, die zum Erstellen einer Vorschau verwendet werden soll. Format: projects/{project}/versions/{version}

PreviewSettings

Einstellungen zum Aktualisieren der Vorschau.

JSON-Darstellung 
{
  "sandbox": boolean
}
Felder
sandbox

boolean

Gibt an, ob bestimmte Vorgänge, z. B. Transaktionen, im Sandbox-Modus ausgeführt werden sollen. Bei Vorschauanfragen werden diese Vorgänge standardmäßig im Sandbox-Modus ausgeführt. Mit anderen Worten: Der Standardwert für sandbox ist true.