Method: projects.locations.dataStores.widgetConfigs.get

הפונקציה מחזירה את ה-WidgetConfig.

בקשת HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/dataStores/*/widgetConfigs/*}

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
name

string

חובה. שם המשאב המלא של WidgetConfig. פורמט: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}

פרמטרים של שאילתה

פרמטרים
acceptCache

boolean

זה שינוי אופציונלי. האם אפשר לטעון את הגדרות הווידג'ט מהמטמון. אם המדיניות מוגדרת כ-True, יכול להיות שיעברו כמה דקות עד שהשינויים האחרונים בהגדרות הווידג'ט ישתקפו בתצוגה של משתמש הקצה. מומלץ להגדיר את הערך כ-true בווידג'טים שפותחו באופן מלא, כי זה משפר את הביצועים של הווידג'ט. אם הווידג'ט נמצא בפיתוח, אפשר להגדיר את הערך כ-false כדי שהשינויים ישתקפו בסביבת הייצור באופן מיידי.
getWidgetConfigRequestOption

object (GetWidgetConfigRequestOption)

זה שינוי אופציונלי. אפשרויות ל-GetWidgetConfigRequest.
languageCode

string

זה שינוי אופציונלי. תג שפה מסוג BCP-47 (לדוגמה, en או fr-CA). הפרמטר הזה משמש ללוקליזציה של מחרוזות שניתנות לקריאה על ידי בני אדם בתגובה, כמו בורר המודלים displayName / description ב-WidgetConfig.UiSettings.ModelConfigInfo. אם השדה ריק או לא מוגדר, המערכת תחזור לשפת ברירת המחדל (אנגלית).

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של WidgetConfig.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב name:

  • discoveryengine.widgetConfigs.get

מידע נוסף מופיע במאמרי העזרה בנושא IAM.