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)
}
שדות
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.

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 אופן הצגת הווידאו.

Methods

create

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

delete

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

get

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

getExtendedAgentCard

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

list

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

patch

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