Method: projects.preview.write

Met à jour l'aperçu du projet de l'utilisateur en fonction du modèle.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de la ressource parente au format projects/{project}. {project} est l'ID de projet Cloud associé au projet.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation 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.
}
Champs
previewSettings

object (PreviewSettings)

Obligatoire. Paramètres permettant de mettre à jour l'aperçu de l'utilisateur.

Champ d'union source. Source de données utilisée pour créer l'aperçu. source ne peut être qu'un des éléments suivants :
files

object (Files)

Liste des fichiers envoyés à la fois au serveur. Il s'agit d'une liste de fichiers de configuration ou de fichiers de données. 1. La première requête doit être un fichier ConfigFiles. 2. La première requête doit comporter un ConfigFile avec "settings". 3. La première requête doit comporter un fichier ConfigFile contenant "manifest". 4. Le fichier ConfigFile du webhook correspondant à la fonction Cloud intégrée doit être diffusé avant le fichier DataFile correspondant à son code source.

draft

object (ContentFromDraft)

Contenu provenant du brouillon du projet.

submittedVersion

object (ContentFromSubmittedVersion)

Contenu provenant d'une version existante

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Définition de la ressource d'aperçu.

Représentation JSON
{
  "name": string,
  "validationResults": {
    object (ValidationResults)
  },
  "simulatorUrl": string
}
Champs
name

string

Identifiant unique de l'aperçu. Format : projects/{project}/preview

validationResults

object (ValidationResults)

Résultats de validation associés au contenu de l'aperçu du projet utilisateur.

simulatorUrl

string

URL du simulateur pour tester l'aperçu utilisateur.

ContentFromDraft

Indique que le contenu de l'aperçu proviendra du brouillon.

ContentFromSubmittedVersion

Indique que le contenu de l'aperçu proviendra d'une version existante.

Représentation JSON
{
  "version": string
}
Champs
version

string

Obligatoire. Version envoyée du projet à utiliser pour créer un aperçu. Format : projects/{project}/versions/{version}

PreviewSettings

Paramètres de mise à jour de l'aperçu.

Représentation JSON
{
  "sandbox": boolean
}
Champs
sandbox

boolean

Indique si certaines opérations, telles que les transactions, doivent être exécutées ou non en mode bac à sable. Par défaut, les requêtes de prévisualisation exécutent ces opérations en mode bac à sable. En d'autres termes, la valeur par défaut de sandbox est true.