Method: projects.preview.write
จัดทุกอย่างให้เป็นระเบียบอยู่เสมอด้วยคอลเล็กชัน
บันทึกและจัดหมวดหมู่เนื้อหาตามค่ากำหนดของคุณ
อัปเดตตัวอย่างโปรเจ็กต์ของผู้ใช้ตามโมเดล
คำขอ HTTP
POST https://actions.googleapis.com/v2/{parent=projects/*}/preview:write
URL ใช้ไวยากรณ์การแปลง gRPC
พารามิเตอร์เส้นทาง
| พารามิเตอร์ |
parent |
string
ต้องระบุ ชื่อทรัพยากรระดับบนสุดในรูปแบบ projects/{project} โดย {project} คือรหัสโปรเจ็กต์ที่อยู่ในระบบคลาวด์ที่เชื่อมโยงกับโปรเจ็กต์ดังกล่าว
|
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
| ช่อง |
previewSettings |
object (PreviewSettings)
ต้องระบุ การตั้งค่าสำหรับการอัปเดตการแสดงตัวอย่างของผู้ใช้
|
ช่องการรวม source แหล่งข้อมูลที่ใช้สร้างพรีวิว source ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้ |
files |
object (Files)
รายการไฟล์ที่ส่งไปยังเซิร์ฟเวอร์ต่อครั้ง นี่คือรายการไฟล์การกำหนดค่าหรือไฟล์ข้อมูล 1. คำขอแรกต้องเป็น ConfigFiles 2. คำขอแรกต้องมี ConfigFile ที่มี "settings" 3. คำขอแรกต้องมี ConfigFile ที่มี "ไฟล์ Manifest" 4. ต้องสตรีม 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
|
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 4.0 และตัวอย่างโค้ดได้รับอนุญาตภายใต้ใบอนุญาต Apache 2.0 เว้นแต่จะระบุไว้เป็นอย่างอื่น โปรดดูรายละเอียดที่นโยบายเว็บไซต์ Google Developers Java เป็นเครื่องหมายการค้าจดทะเบียนของ Oracle และ/หรือบริษัทในเครือ
อัปเดตล่าสุด 2025-07-26 UTC
[null,null,["อัปเดตล่าสุด 2025-07-26 UTC"],[[["\u003cp\u003eUpdates a user's project preview using either draft content, an existing version, or uploaded files.\u003c/p\u003e\n"],["\u003cp\u003eRequires specifying the project ID and the preview settings, which include an optional sandbox mode.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must indicate the source of the preview content (draft, version, or files).\u003c/p\u003e\n"],["\u003cp\u003eA successful response provides the preview's name, validation results, and a simulator URL for testing.\u003c/p\u003e\n"],["\u003cp\u003eThe API uses gRPC Transcoding and expects the content to follow specific JSON structures for requests and responses.\u003c/p\u003e\n"]]],[],null,["# Method: projects.preview.write\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.Preview.SCHEMA_REPRESENTATION)\n- [ContentFromDraft](#ContentFromDraft)\n- [ContentFromSubmittedVersion](#ContentFromSubmittedVersion)\n - [JSON representation](#ContentFromSubmittedVersion.SCHEMA_REPRESENTATION)\n- [PreviewSettings](#PreviewSettings)\n - [JSON representation](#PreviewSettings.SCHEMA_REPRESENTATION)\n\nUpdates the user's project preview based on the model.\n\n### HTTP request\n\n`POST https://actions.googleapis.com/v2/{parent=projects/*}/preview:write`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The parent resource name in the format `projects/{project}`. The `{project}` is the cloud project ID associated with the project. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation ||\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"previewSettings\": { object (/assistant/actions/api/reference/rest/v2/projects.preview/write#PreviewSettings) }, // Union field `source` can be only one of the following: \"files\": { object (/assistant/actions/api/reference/rest/v2/Files) }, \"draft\": { object (/assistant/actions/api/reference/rest/v2/projects.preview/write#ContentFromDraft) }, \"submittedVersion\": { object (/assistant/actions/api/reference/rest/v2/projects.preview/write#ContentFromSubmittedVersion) } // End of list of possible types for union field `source`. } ``` |\n\n| Fields ||\n|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| `previewSettings` | `object (`[PreviewSettings](/assistant/actions/api/reference/rest/v2/projects.preview/write#PreviewSettings)`)` Required. The settings for updating the user's preview. |\n| Union field `source`. Data source used to created the preview. `source` can be only one of the following: |||\n| `files` | `object (`[Files](/assistant/actions/api/reference/rest/v2/Files)`)` List of files sent to the server at a time. This is a list of config files or data files. 1. The first request must be a ConfigFiles. 2. The first request must have a ConfigFile with 'settings'. 3. The first request must have a ConfigFile with 'manifest'. 4. The webhook ConfigFile corresponding to inline cloud function must be streamed before the DataFile corresponding to its source code. |\n| `draft` | `object (`[ContentFromDraft](/assistant/actions/api/reference/rest/v2/projects.preview/write#ContentFromDraft)`)` Content sourced from the project draft. |\n| `submittedVersion` | `object (`[ContentFromSubmittedVersion](/assistant/actions/api/reference/rest/v2/projects.preview/write#ContentFromSubmittedVersion)`)` Content sourced from the an exiting version. |\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nDefinition of preview resource.\n\n| JSON representation ||\n|--------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"name\": string, \"validationResults\": { object (/assistant/actions/api/reference/rest/v2/ValidationResults) }, \"simulatorUrl\": string } ``` |\n\n| Fields ||\n|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The unique identifier of the preview. Format: `projects/{project}/preview` |\n| `validationResults` | `object (`[ValidationResults](/assistant/actions/api/reference/rest/v2/ValidationResults)`)` Validation results associated with the user project preview content. |\n| `simulatorUrl` | `string` The simulator URL to test the user preview. |\n\nContentFromDraft\n----------------\n\nIndicates the preview content will be coming from the Draft.\n\nContentFromSubmittedVersion\n---------------------------\n\nIndicates the preview content will be coming from an exiting version.\n\n| JSON representation ||\n|-------------------------------|---|\n| ``` { \"version\": string } ``` |\n\n| Fields ||\n|-----------|-------------------------------------------------------------------------------------------------------------------------------------|\n| `version` | `string` Required. Submitted version of the project to be used to create a preview. Format: `projects/{project}/versions/{version}` |\n\nPreviewSettings\n---------------\n\nSettings for updating the preview.\n\n| JSON representation ||\n|--------------------------------|---|\n| ``` { \"sandbox\": boolean } ``` |\n\n| Fields ||\n|-----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `sandbox` | `boolean` Indicates whether or not to run certain operations, such as transactions, in sandbox mode. By default, preview requests run these operations in sandbox mode. In other words, the default value for `sandbox` is `true`. |"]]
