REST Resource: projects.locations.apps.deployments

משאב: פריסה

פריסה מייצגת גרסה של האפליקציה שלא ניתן לשנות, שאפשר להריץ עליה שאילתות. היא משמשת לפריסת גרסה של האפליקציה עם פרופיל ערוץ ספציפי.

ייצוג ב-JSON 
{
  "name": string,
  "displayName": string,
  "appVersion": string,
  "channelProfile": {
    object (ChannelProfile)
  },
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "experimentConfig": {
    object (ExperimentConfig)
  },
  "whatsappCredentials": {
    object (WhatsAppCredentials)
  },
  "instagramCredentials": {
    object (InstagramCredentials)
  },
  "modelSettings": {
    object (ModelSettings)
  },
  "modality": enum (Deployment.Modality),
  "agentRegistryDeployment": {
    object (AgentRegistryDeployment)
  }
}
שדות
name

string

מזהה. שם המשאב של הפריסה. פורמט: projects/{project}/locations/{location}/apps/{app}/deployments/{deployment}
displayName

string

חובה. השם המוצג של הפריסה.
appVersion

string

זה שינוי אופציונלי. שם המשאב של גרסת האפליקציה שרוצים לפרוס. פורמט: projects/{project}/locations/{location}/apps/{app}/versions/{version} משתמשים ב-projects/{project}/locations/{location}/apps/{app}/versions/- כדי להשתמש באפליקציה בטיוטה.
channelProfile

object (ChannelProfile)

חובה. פרופיל הערוץ שבו נעשה שימוש בהטמעה.
createTime

string (Timestamp format)

פלט בלבד. חותמת זמן של מועד היצירה של הפריסה הזו.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

פלט בלבד. חותמת הזמן של העדכון האחרון של הפריסה הזו.

הפורמט הוא RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
etag

string

פלט בלבד. תג Etag שמשמש כדי לוודא שהאובייקט לא השתנה במהלך פעולת קריאה-שינוי-כתיבה. אם ה-etag ריק, העדכון יחליף את כל השינויים המקבילים.
experimentConfig

object (ExperimentConfig)

זה שינוי אופציונלי. הגדרת הניסוי לפריסה.
whatsappCredentials

object (WhatsAppCredentials)

זה שינוי אופציונלי. קלט בלבד. כשמגדירים פרופיל של ערוץ וואטסאפ, צריך להזין פרטי כניסה זמניים לוואטסאפ.
instagramCredentials

object (InstagramCredentials)

זה שינוי אופציונלי. קלט בלבד. כשמגדירים פרופיל ערוץ באינסטגרם, צריך להזין פרטי כניסה זמניים לאינסטגרם.
modelSettings

object (ModelSettings)

זה שינוי אופציונלי. הגדרות המודל לפריסה. ההגדרה הזו מחליפה את הגדרות המודל שהוגדרו ברמת האפליקציה או הסוכן. הערה: כדי לבטל את הגדרות המודל ברמת הפריסה, צריך להיות ברשימת ההיתרים. כדי להפעיל את השדה הזה, צריך לפנות לצוות CXAS.
modality

enum (Deployment.Modality)

זה שינוי אופציונלי. אופן הפריסה. הערה: כדי להשתמש בהחלפת מודאליות ברמת הפריסה, צריך להיות ברשימת ההיתרים. כדי להפעיל את השדה הזה, צריך לפנות לצוות CXAS.
agentRegistryDeployment

object (AgentRegistryDeployment)

זה שינוי אופציונלי. הגדרה לפריסת הפריסה הזו ב-Agent Registry. אם יש פריסה כזו, היא תפורסם ב-Agent Registry.

ExperimentConfig

ניסוי לפריסה.

ייצוג ב-JSON 
{
  "versionRelease": {
    object (ExperimentConfig.VersionRelease)
  }
}
שדות
versionRelease

object (ExperimentConfig.VersionRelease)

זה שינוי אופציונלי. גרסת הפרסום של הניסוי.

ExperimentConfig.VersionRelease

גרסת הפרסום של הניסוי.

ייצוג ב-JSON 
{
  "state": enum (ExperimentConfig.State),
  "trafficAllocations": [
    {
      object (ExperimentConfig.VersionRelease.TrafficAllocation)
    }
  ]
}
שדות
state

enum (ExperimentConfig.State)

זה שינוי אופציונלי. המצב של פרסום הגרסה.
trafficAllocations[]

object (ExperimentConfig.VersionRelease.TrafficAllocation)

זה שינוי אופציונלי. הקצאות תנועה לגרסת ההפצה.

ExperimentConfig.State

מצב הניסוי.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED מצב לא מוגדר.
PENDING הוצא משימוש: המצב הזה כבר לא בשימוש.
RUNNING מצב הפעלה. הניסוי פועל ותקף.
DONE הוצא משימוש: המצב הזה כבר לא בשימוש.
EXPIRED הוצא משימוש: המצב הזה כבר לא בשימוש.

ExperimentConfig.VersionRelease.TrafficAllocation

הקצאת תנועה לגרסת ההפצה.

ייצוג ב-JSON 
{
  "id": string,
  "trafficPercentage": integer,
  "appVersion": string
}
שדות
id

string

זה שינוי אופציונלי. המזהה של הקצאת התנועה. מחרוזת בפורמט חופשי, עד 128 תווים.
trafficPercentage

integer

זה שינוי אופציונלי. אחוז התנועה בהקצאת התנועה. הערך צריך להיות בין 0 ל-100.
appVersion

string

זה שינוי אופציונלי. גרסת האפליקציה של הקצאת התנועה. פורמט: projects/{project}/locations/{location}/apps/{app}/versions/{version}

WhatsAppCredentials

פרטי כניסה זמניים של מטא לשילוב מובנה של וואטסאפ.

ייצוג ב-JSON 
{
  "authCode": string,
  "pin": string,
  "phoneNumber": string,
  "businessAccountId": string,
  "wabaId": string,
  "conversationProfileId": string
}
שדות
authCode

string

חובה. קוד האימות של Meta שמופיע בתהליך ההרשמה המוטמע.
pin

string

חובה. קוד האימות בן 6 הספרות שנוצר על ידי המשתמש לאימות דו-שלבי.
phoneNumber

string

חובה. מספר הטלפון שרוצים להירשם איתו לוואטסאפ.
businessAccountId

string

חובה. מזהה החשבון העסקי שבו יש להשתמש עבור מספר הטלפון.
wabaId

string

חובה. מספר החשבון ב-WhatsApp Business.
conversationProfileId

string

זה שינוי אופציונלי. מזהה פרופיל השיחה שבו רוצים להשתמש לפריסה.

InstagramCredentials

פרטי כניסה זמניים ל-Meta לצורך שילוב מובנה של אינסטגרם.

ייצוג ב-JSON 
{
  "authCode": string,
  "conversationProfileId": string
}
שדות
authCode

string

חובה. קוד האימות של Meta שמופיע בתהליך ההרשמה המוטמע.
conversationProfileId

string

זה שינוי אופציונלי. מזהה פרופיל השיחה שבו רוצים להשתמש לפריסה.

Deployment.Modality

אופן הפריסה.

טיפוסים בני מנייה (enum)
MODALITY_UNSPECIFIED אמצעי לא ידוע.
MODALITY_TEXT אופן הצגת הטקסט.
MODALITY_VOICE אמצעי תקשורת קולי.
MODALITY_VIDEO שיטת הצגת הסרטון.

AgentRegistryDeployment

ההגדרה והסטטוס של הפריסה של Agent Registry.

ייצוג ב-JSON 
{
  "agentRegistryServiceName": string
}
שדות
agentRegistryServiceName

string

זה שינוי אופציונלי. פלט בלבד. שם המשאב של שירות Agent Registry שנפרס. פורמט: projects/{project}/locations/{location}/services/{service}

Methods

create

 יצירת פריסה חדשה באפליקציה הנתונה.

delete

 מחיקת הפריסה שצוינה.

get

 קבלת פרטים על הפריסה שצוינה.

getExtendedAgentCard

 מקבל את כרטיס הסוכן המורחב של הסוכן שאומת.

list

 מציג את הפריסות באפליקציה הנתונה.

patch

 מעדכנים את הפריסה שצוינה.