REST Resource: projects.locations.collections.dataStores.widgetConfigs

משאב: WidgetConfig

ההגדרות נשמרות ב-WidgetConfig ברמת הווידג'ט.

ייצוג ב-JSON 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "enableAutocomplete": boolean,
  "fieldsUiComponentsMap": {
    string: {
      object (UIComponentField)
    },
    ...
  },
  "facetField": [
    {
      object (FacetField)
    }
  ],
  "dataStoreType": enum (DataStoreType),
  "contentSearchSpec": {
    object (ContentSearchSpec)
  },
  "enableSummarization": boolean,
  "enableSnippetResultSummary": boolean,
  "configId": string,
  "enableQualityFeedback": boolean,
  "solutionType": enum (SolutionType),
  "industryVertical": enum (IndustryVertical),
  "allowPublicAccess": boolean,
  "allowlistedDomains": [
    string
  ],
  "enableSafeSearch": boolean,
  "enableConversationalSearch": boolean,
  "llmEnabled": boolean,
  "enableResultScore": boolean,
  "resultDisplayType": enum (ResultDisplayType),
  "minimumDataTermAccepted": boolean,
  "enableWebApp": boolean,
  "dataStoreUiConfigs": [
    {
      object (DataStoreUiConfig)
    }
  ],
  "collectionComponents": [
    {
      object (CollectionComponent)
    }
  ],
  "enableSearchAsYouType": boolean,
  "defaultSearchRequestOrderBy": string,
  "uiSettings": {
    object (UiSettings)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "uiBranding": {
    object (UiBrandingSettings)
  },
  "homepageSetting": {
    object (HomepageSetting)
  },
  "assistantSettings": {
    object (AssistantSettings)
  },
  "customerProvidedConfig": {
    object (CustomerProvidedConfig)
  },
  "enablePrivateKnowledgeGraph": boolean,
  "geminiBundle": boolean,
  "batchAuthStatuses": [
    {
      object (BatchAuthStatus)
    }
  ],
  "nodes": [
    {
      object (Node)
    }
  ]
}
שדות
name

string

אי אפשר לשנות. שם המשאב המלא של הגדרת הווידג'ט. פורמט: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}/widgetConfigs/{widgetConfigId}

השדה הזה חייב להיות מחרוזת עם קידוד UTF-8, באורך של עד 1,024 תווים.
displayName

string

חובה. השם המוצג של הגדרת הווידג'ט שקריא לאנשים. היא משמשת בממשק המשתמש של Discovery.

השדה הזה חייב להיות מחרוזת עם קידוד UTF-8 באורך של עד 128 תווים. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.
createTime

string (Timestamp format)

פלט בלבד. חותמת הזמן שבה נוצר WidgetConfig.

הפורמט הוא 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)

פלט בלבד. חותמת הזמן שבה WidgetConfig עודכן.

הפורמט הוא 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".
enableAutocomplete
(deprecated)

boolean

האם להפעיל או לא להפעיל את ההשלמה האוטומטית.
fieldsUiComponentsMap
(deprecated)

map (key: string, value: object (UIComponentField))

המפתח הוא רכיב ממשק המשתמש. הדמיה. כרגע נתמכים title, thumbnail, url, custom1, custom2, custom3.

הערך הוא שם השדה יחד עם הרשאות הגישה למכשיר.

שלושת השדות המותאמים אישית הם אופציונליים ואפשר להוסיף או להסיר אותם. ‫title, ‏thumbnail ו-url הם רכיבי ממשק משתמש שחובה להשתמש בהם ואי אפשר להסיר אותם.
facetField[]
(deprecated)

object (FacetField)

ההגדרה והמראה של הפנים בתצוגה של משתמש הקצה.
dataStoreType

enum (DataStoreType)

פלט בלבד. הסוג של מאגר נתוני ההורה.
contentSearchSpec
(deprecated)

object (ContentSearchSpec)

מפרט חיפוש התוכן שקובע את ההתנהגות הרצויה של חיפוש התוכן.
enableSummarization
(deprecated)

boolean

מפעילים או משביתים את סיכום התשובה בחיפוש.
enableSnippetResultSummary
(deprecated)

boolean

מפעילים או משביתים את הסיכום לכל אחת מהתוצאות של הקטעים.
configId

string

פלט בלבד. מזהה ייחודי שעובר ערפול של WidgetConfig.
enableQualityFeedback
(deprecated)

boolean

להפעיל או להשבית את איסוף המשוב על איכות תוצאות החיפוש ממשתמשי הקצה.
solutionType

enum (SolutionType)

חובה. אי אפשר לשנות. מציין את סוג הפתרון שאפשר להשתמש בו ב-WidgetConfig הזה.
industryVertical

enum (IndustryVertical)

פלט בלבד. הענף שרכיב WidgetConfig רשום בו. הענף של WidgetConfig מבוסס על Engine המשויך.
allowPublicAccess
(deprecated)

boolean

האם יש הרשאה לשילוב ללא אימות עם הווידג'ט. אם הערך הוא True, מותרת גישה ציבורית לחיפוש או לפתרונות אחרים מהווידג'ט ללא טוקן אימות שסופק על ידי שרת בק-אנד שמתארח אצל הלקוח.
allowlistedDomains[]
(deprecated)

string

דומיינים ברשימת ההיתרים שיכולים לטעון את הווידג'ט הזה.
llmEnabled

boolean

פלט בלבד. האם מודל שפה גדול (LLM) מופעל במאגר הנתונים המתאים.
enableResultScore

boolean

האם להציג את ציון התוצאה.
resultDisplayType
(deprecated)

enum (ResultDisplayType)

סוג קטע הטקסט שיוצג בווידג'ט של UCS.

  • ‫RESULT_DISPLAY_TYPE_UNSPECIFIED למשתמשים קיימים.
  • תקציר למשתמשים חדשים בחיפוש שאינם משתמשים בחיפוש פנים-ארגוני.
  • EXTRACTIVE_ANSWER למשתמשים חדשים בחיפוש פנים-ארגוני.
minimumDataTermAccepted

boolean

פלט בלבד. האם הלקוח קיבל את התנאים לשימוש בנתונים.
enableWebApp
(deprecated)

boolean

האם להפעיל אפליקציית אינטרנט עצמאית.
dataStoreUiConfigs[]
(deprecated)

object (DataStoreUiConfig)

הגדרות ממשק משתמש שניתנות להגדרה לכל מאגר נתונים.
collectionComponents[]

object (CollectionComponent)

פלט בלבד. רכיבי איסוף שמציגים רשימה של כל האוספים ומאגרי הנתונים המשויכים להגדרת הווידג'ט. אפשר להשתמש במקורות הנתונים האלה לסינון בממשקי ה-API של שירות הווידג'ט, והמשתמשים יכולים לקבל תוצאות ממקורות נתונים נבחרים.

במנועי SaaS / Business, כשקוראים ל-LookupWidgetConfig עם view = WITH_AVAILABLE_CONNECTORS, הרשימה הזו מורחבת עם ערכי placeholder סינתטיים למחברים שהמתקשר יכול לצרף אבל עדיין לא צירף (ראו CollectionComponent לחוזה ה-placeholder). לכן, הקצה הקדמי יכול לעבד רשימה מאוחדת של מקורות שכבר צורפו ומקורות שזמינים לצירוף על ידי איטרציה של השדה היחיד הזה. במנועי Enterprise ובברירת המחדל view, מוחזרים רק מחברים שכבר צורפו (ההתנהגות הנוכחית).
enableSearchAsYouType
(deprecated)

boolean

האם להפעיל את ההתנהגות של חיפוש בזמן ההקלדה בווידג'ט חיפוש Google
defaultSearchRequestOrderBy
(deprecated)

string

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

משמש להגדרת SearchRequest#orderBy בבקשות רלוונטיות. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
uiSettings

object (UiSettings)

מאמר שמתאר הגדרות כלליות של חיפוש בווידג'טים, כפי שמופיעות בדף ההגדרות של הווידג'טים במסוף Cloud. הפונקציה מחליפה מאפיינים ברמה העליונה שהוצאו משימוש.
accessSettings

object (AccessSettings)

ההגדרה הזו תשמש לכל הגדרות הגישה לווידג'טים שמופיעות בדף השילוב של מסוף Cloud. הפונקציה מחליפה מאפיינים ברמה העליונה שהוצאו משימוש.
uiBranding

object (UiBrandingSettings)

תיאור של הגדרות המיתוג בממשק המשתמש של ווידג'ט החיפוש, כמו שם הווידג'ט, הלוגו, סמלי האתר והצבעים.
homepageSetting

object (HomepageSetting)

זה שינוי אופציונלי. תיאור של הגדרות דף הבית של הווידג'ט.
assistantSettings

object (AssistantSettings)

זה שינוי אופציונלי. פלט בלבד. תיאור של הגדרות העזרה של הווידג'ט.
customerProvidedConfig

object (CustomerProvidedConfig)

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

boolean

זה שינוי אופציונלי. פלט בלבד. האם להפעיל Knowledge Graph פרטי.
geminiBundle

boolean

פלט בלבד. האם המינוי הוא חבילת Gemini או לא.
batchAuthStatuses[]

object (BatchAuthStatus)

פלט בלבד. סטטוסי ההרשאה של המחברים של הווידג'ט.
nodes[]

object (Node)

פלט בלבד. הצמתים שמשויכים להגדרת הווידג'ט.

UIComponentField

שדה של היבט שממופה לרכיב בממשק המשתמש.

ייצוג ב-JSON 
{
  "field": string,
  "deviceVisibility": [
    enum (DeviceVisibility)
  ],
  "displayTemplate": string
}
שדות
field

string

חובה. שם השדה הרשום. הפורמט הוא field.abc.
deviceVisibility[]

enum (DeviceVisibility)

השדה 'חשיפה' בסוגים שונים של מכשירים.
displayTemplate

string

התבנית שמשמשת להתאמה אישית של אופן התצוגה של השדה. ערך לדוגמה יכול להיות מחרוזת שנראית כך: "מחיר: {value}".

DeviceVisibility

החשיפה של השדה בסוגים שונים של מכשירים.

טיפוסים בני מנייה (enum)
DEVICE_VISIBILITY_UNSPECIFIED ערך ברירת המחדל אם לא מציינים ערך. השרת מחזיר INVALID_ARGUMENT אם נעשה שימוש בבקשות.
MOBILE רכיב ממשק המשתמש גלוי במכשירים ניידים.
DESKTOP רכיב ממשק המשתמש גלוי בלקוח מבוסס-דפדפן.

FacetField

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

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

string

חובה. שם השדה הרשום. הפורמט הוא field.abc.
displayName

string

זה שינוי אופציונלי. שם השדה שמשתמשי הקצה יראו.

DataStoreType

הסוג של מאגר הנתונים הראשי של הווידג'ט.

טיפוסים בני מנייה (enum)
DATA_STORE_TYPE_UNSPECIFIED לא צוין סוג של מאגר נתונים.
STRUCTURED מאגר הנתונים הראשי מכיל מנוע חיפוש לנתונים מובְנים.
UNSTRUCTURED מאגר הנתונים הראשי מכיל מנוע חיפוש לנתונים לא מובְנים.
BLENDED מאגר נתוני ההורה מוצג בחיפוש משולב עם כמה מאגרי נתונים.

ResultDisplayType

סוג התוצאה שיוצג בווידג'ט של UCS.

טיפוסים בני מנייה (enum)
RESULT_DISPLAY_TYPE_UNSPECIFIED סוג התצוגה לא צוין (ברירת המחדל היא הצגת קטע קוד).
SNIPPET התוצאות מוצגות בשדה 'קטע טקסט'.
EXTRACTIVE_ANSWER הצגת תוצאות מהשדה 'תשובות חילוץ'.

DataStoreUiConfig

הגדרת רכיב ממשק המשתמש של מאגר הנתונים.

ייצוג ב-JSON 
{
  "name": string,
  "id": string,
  "facetField": [
    {
      object (FacetField)
    }
  ],
  "fieldsUiComponentsMap": {
    string: {
      object (UIComponentField)
    },
    ...
  }
}
שדות
name

string

השם של מאגר הנתונים. הפורמט של שם המשאב של מאגר הנתונים צריך להיות: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. בממשקי API ב-WidgetService, כמו WidgetService.LookupWidgetConfig, השדה הזה לא יכלול את מספר הפרויקט ואת המיקום.
id

string

פלט בלבד. המזהה של מאגר הנתונים, שמשמש לשירות הווידג'טים. בשלב הזה, השדה מתייחס ל-dataStoreId, אבל בעתיד נעביר את השדה ל-UUID של שם מאגר הנתונים המוצפן.
facetField[]

object (FacetField)

שדות של היבטים שמאחסנים את המיפוי של שדות למראה הווידג'ט של משתמש הקצה.
fieldsUiComponentsMap

map (key: string, value: object (UIComponentField))

המפתח הוא רכיב ממשק המשתמש. הדמיה. כרגע נתמכים title, thumbnail, url, custom1, custom2, custom3.

הערך הוא שם השדה יחד עם הרשאות הגישה למכשיר.

שלושת השדות המותאמים אישית הם אופציונליים ואפשר להוסיף או להסיר אותם. ‫title, ‏thumbnail ו-url הם רכיבי ממשק משתמש שחובה להשתמש בהם ואי אפשר להסיר אותם.

CollectionComponent

רכיב אוסף לקריאה בלבד שמכיל שדות של אוספים במאגר נתונים שאפשר להשתמש בהם לסינון.

במנועי SaaS / Business, כשמתבצעת קריאה ל-LookupWidgetConfig עם view = WITH_AVAILABLE_CONNECTORS, מופעים של ההודעה הזו משמשים גם לייצוג של רשומות placeholder סינתטיות למחברים שהמתקשר יכול לצרף אבל עדיין לא צירף. ערכים זמניים לשמירת מקום (פלייסהולדרים) מכילים connectorAuthState.auth_state == AUTH_STATE_UNSPECIFIED (או NO_AUTH), שדה ריק connectorAuthState.authorization_uri (הווידג'ט קורא ל-WidgetBuildAuthorizationUrl כשהמשתמש לוחץ על 'התחברות') וערכים זמניים סינתטיים לשמירת מקום בשדות name / id (ראו הערות בשדה). שדות שרלוונטיים רק לחיבורים מגובשים (dataStoreComponents, ‏ tenant, ‏ actionConnector) לא מוגדרים עבור רשומות placeholder.

ייצוג ב-JSON 
{
  "name": string,
  "id": string,
  "displayName": string,
  "dataStoreComponents": [
    {
      object (DataStoreComponent)
    }
  ],
  "dataSource": string,
  "dataSourceVersion": number,
  "dataSourceDisplayName": string,
  "dataSourceEndUserDisplayName": string,
  "connectorIconLink": string,
  "connectorAuthState": {
    object (ConnectorAuthState)
  },
  "metadata": {
    object (ConnectorMetadata)
  },
  "isFirstParty": boolean,
  "tag": string
}
שדות
name

string

שם האוסף. זה צריך להיות שם המשאב של האוסף. פורמט: projects/{project}/locations/{location}/collections/{collectionId} בממשקי API ב-WidgetService, כמו WidgetService.LookupWidgetConfig, השדה הזה לא יכלול את מספר הפרויקט ואת המיקום.

לרשומות של placeholder סינתטי (ראו הערה ברמת ההודעה) מועבר מזהה של אוסף placeholder סינתטי שלא תואם לאוסף אמיתי. פונקציות קריאה חוזרת לא צריכות לנסות לפתור / לקבל את המשאב הזה עד שהמשתמש יאשר את המחבר.
id

string

פלט בלבד. המזהה של האוסף, שמשמש לשירות הווידג'טים. בשלב הזה הוא מתייחס ל-collectionId, אבל בעתיד נעביר את השדה ל-UUID של שם האוסף המוצפן.

לערכי placeholder סינתטיים (ראו הערה ברמת ההודעה), זהו מזהה placeholder סינתטי, ולא collectionId אמיתי.
displayName

string

השם המוצג של האוסף.
dataStoreComponents[]

object (DataStoreComponent)

ברשימת מאגרי הנתונים של הילדים, מאגר הנתונים של האוסף.
dataSource

string

שם מקור הנתונים, שאוחזר מ-Collection.data_connector.data_source.
dataSourceVersion

number

פלט בלבד. הגרסה של הגדרת המחבר שתומכת באוסף הזה, שיקוף DataConnector.data_source_version.
dataSourceDisplayName

string

פלט בלבד. השם המוצג של מקור הנתונים.
dataSourceEndUserDisplayName

string

פלט בלבד. השם המוצג של מקור הנתונים שגלוי למשתמשים, שמקורו ב-ConnectorSource.end_user_display_name. אם לא מוגדר ערך, הלקוחות חוזרים לערך dataSourceDisplayName.
connectorAuthState

object (ConnectorAuthState)

פלט בלבד. ה-URI של האימות של מקור המחבר.
metadata

object (ConnectorMetadata)

פלט בלבד. מטא-נתונים של מחבר שמוצגים למשתמשים (title, ‏ description, ‏ shortDescription, ‏ author, ‏ note), שאוחזרו מהרישום ConnectorSource.metadata (מצורפים לפי מקור נתונים). מוצג בדף הפרטים של המחבר.
isFirstParty

boolean

פלט בלבד. האם מדובר במחבר של צד ראשון (בבעלות Google), בניגוד למחבר של צד שלישי. משמש את חזית האתר כדי לקבץ מחברים של אינטראקציה ישירה לעומת מחברים של צד שלישי.
tag

string

פלט בלבד. התווית של המחבר שתומך באוסף הזה, ללא תלות בגרסה, זהה לתווית DataConnector.tag. בשונה ממזהה מאגר הנתונים שמוצמד לגרסה, הוא שורד שדרוג של גרסת המחבר, כך שמחבר משודרג שומר על אותה תגית.

המפתח לא ייחודי. במסמכי DataConnector.tag, יכול להיות שכמה מחברים ישתפו תג באותו (פרויקט, מיקום, אוסף, מקור נתונים), והחיפוש לפי תג יפתור את הבעיה עם התג עם הערך הגדול ביותר של createTime. הלקוחות לא יכולים להתייחס לזה כמזהה של מחבר.

הערך ריק אם המחבר נוצר לפני ההשקה של כתיבת התגים, ועבור ערכים של placeholder סינתטיים, שאין להם DataConnector בסיסי. השדה הזה מאוכלס רק אם ConnectorsFeature.enable_connector_tag מופעל.

DataStoreComponent

רכיב של מאגר נתונים לקריאה בלבד, שמכיל שדות של מאגרי נתונים שאפשר להשתמש בהם לסינון. זהו רכיב צאצא של CollectionComponent.

ייצוג ב-JSON 
{
  "name": string,
  "id": string,
  "displayName": string,
  "entityName": string,
  "dataStoreConfigType": enum (DataStoreConfigType)
}
שדות
name

string

השם של מאגר הנתונים. הפורמט של שם המשאב של מאגר הנתונים צריך להיות: projects/{project}/locations/{location}/collections/{collectionId}/dataStores/{dataStoreId}. בממשקי API ב-WidgetService, כמו WidgetService.LookupWidgetConfig, השדה הזה לא יכלול את מספר הפרויקט ואת המיקום.
id

string

פלט בלבד. המזהה של מאגר הנתונים, שמשמש לשירות הווידג'טים. בשלב הזה, השדה מתייחס ל-dataStoreId, אבל בעתיד נעביר את השדה ל-UUID של שם מאגר הנתונים המוצפן.
displayName

string

השם המוצג של מאגר הנתונים.
entityName

string

שם הישות, שאוחזר מ-Collection.data_connector.entities.entityName.
dataStoreConfigType

enum (DataStoreConfigType)

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

DataStoreConfigType

סוג ההגדרה של מאגר הנתונים.

טיפוסים בני מנייה (enum)
DATA_STORE_CONFIG_TYPE_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
ALLOW_DB_CONFIG מאגר הנתונים מחובר ל-AlloyDB
THIRD_PARTY_OAUTH_CONFIG מאגר הנתונים מחובר למקור נתונים של צד שלישי.
NOTEBOOKLM_CONFIG מאגר הנתונים מקושר ל-NotebookLM Enterprise.

ConnectorAuthState

מחבר לקריאה בלבד במצב אימות של CollectionComponent.

ייצוג ב-JSON 
{
  "authState": enum (AuthState),
  "authorizationUri": string,
  "updateTime": string
}
שדות
authState

enum (AuthState)

פלט בלבד. מצב ההרשאה של מחבר הנתונים.
authorizationUri

string

פלט בלבד. כתובת ה-URI של ההרשאה למחבר הנתונים.

עבור ערכי placeholder סינתטיים CollectionComponent (שמוחזרים על ידי LookupWidgetConfig עם view = WITH_AVAILABLE_CONNECTORS במנועי SaaS / Business), השדה הזה נשאר ריק. הווידג'ט צריך לקרוא ל-WidgetService.WidgetBuildAuthorizationUrl כשמשתמש לוחץ על 'חיבור', כדי לקבל כתובת URL חדשה של הרשאה.
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".

AuthState

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

טיפוסים בני מנייה (enum)
AUTH_STATE_UNSPECIFIED ערך ברירת המחדל. הערך הזה מוחזר גם עבור רשומות של placeholder סינתטי CollectionComponent שמוצגות על ידי LookupWidgetConfig עם view = WITH_AVAILABLE_CONNECTORS (רק ב-SaaS או ב-Business) – הרשומות האלה מייצגות מחברים שהמתקשר יכול לצרף אבל עדיין לא צירף.
AUTHORIZED המשתמש נתן הרשאה למחבר הנתונים.
EXPIRED ההרשאה של המשתמש למחבר הנתונים פגה.
ACTIONS_DISABLED המשתמש עדיין יכול לשלוח בקשות חיפוש, אבל צריך להפעיל את הפעולות.
NO_AUTH מחבר הנתונים לא דורש הרשאה. משמש גם לרשומות של placeholder שהמחבר הבסיסי שלהן לא דורש OAuth של משתמש.

ConnectorMetadata

מטא-נתונים שמוצגים למשתמשים לגבי המחבר, בדף הפרטים של המחבר (שם, תיאור, תיאור קצר, מחבר, הערה).

ייצוג ב-JSON 
{
  "title": string,
  "description": string,
  "shortDescription": string,
  "author": string,
  "note": string
}
שדות
title

string

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

string

זה שינוי אופציונלי. תיאור קריא (לבני אדם) של המחבר, שמוצג בדף הפרטים של המחבר. לכל מחבר יש תיאור אחד.
shortDescription

string

זה שינוי אופציונלי. תיאור קצר של המחבר (למשל, מוצג מתחת לשם המחבר בתצוגות רשימה ופרטים).
author

string

זה שינוי אופציונלי. הגורם שיצר את המחבר, למשל Google או שם של ספק צד שלישי. מאפשר למשתמשי קצה לראות מי יצר את המחבר (בעתיד: מחברים שנוצרו על ידי צד שלישי).
note

string

זה שינוי אופציונלי. הערה חופשית עם כמה שורות על היכולות של המחבר, או הערה מותאמת אישית שאפשר להגדיר למחבר.

UiSettings

מאמר שמסביר על הגדרות כלליות של ממשק משתמש של ווידג'ט (או אפליקציית אינטרנט), כפי שמופיעות בדף ההגדרות של ממשק המשתמש במסוף Cloud.

ייצוג ב-JSON 
{
  "interactionType": enum (InteractionType),
  "generativeAnswerConfig": {
    object (GenerativeAnswerConfig)
  },
  "resultDescriptionType": enum (ResultDisplayType),
  "enableAutocomplete": boolean,
  "enableSafeSearch": boolean,
  "enableQualityFeedback": boolean,
  "enableSearchAsYouType": boolean,
  "defaultSearchRequestOrderBy": string,
  "dataStoreUiConfigs": [
    {
      object (DataStoreUiConfig)
    }
  ],
  "disableUserEventsCollection": boolean,
  "enableVisualContentSummary": boolean,
  "enablePeopleSearch": boolean,
  "enableCreateAgentButton": boolean,
  "features": {
    string: enum (FeatureState),
    ...
  },
  "modelConfigs": {
    string: enum (ModelState),
    ...
  },
  "searchAddonSpec": {
    object (SearchAddonSpec)
  },
  "modelConfigInfo": {
    object (ModelConfigInfo)
  },
  "sourceAdminDisplayNameEnabled": boolean,
  "onedrivePickerEnabled": boolean,
  "googleDrivePickerEnabled": boolean
}
שדות
interactionType

enum (InteractionType)

תיאור סוג האינטראקציה עם הווידג'ט (או אפליקציית האינטרנט)
generativeAnswerConfig

object (GenerativeAnswerConfig)

מתאר את ההגדרה של תשובה גנרטיבית.
resultDescriptionType

enum (ResultDisplayType)

קובעת אם יוצג קטע מתוצאת החיפוש ואיך הוא יוצג (תקציר או תשובה שמבוססת על קטע). אם לא מציינים ערך, ברירת המחדל היא no result.
enableAutocomplete

boolean

האם להפעיל או לא להפעיל את ההשלמה האוטומטית.
enableQualityFeedback

boolean

להפעיל או להשבית את איסוף המשוב על איכות תוצאות החיפוש ממשתמשי הקצה.
enableSearchAsYouType

boolean

האם להפעיל את ההתנהגות של חיפוש בזמן ההקלדה בווידג'ט חיפוש Google.
defaultSearchRequestOrderBy

string

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

משמש להגדרת SearchRequest#orderBy בבקשות רלוונטיות. https://cloud.google.com/generative-ai-app-builder/docs/reference/rest/v1alpha/projects.locations.dataStores.servingConfigs/search#request-body
dataStoreUiConfigs[]

object (DataStoreUiConfig)

לכל הגדרה של מאגר נתונים.
disableUserEventsCollection

boolean

אם המדיניות מוגדרת כ-True, הווידג'ט לא יאסוף אירועי משתמשים.
enableVisualContentSummary

boolean

אם ההגדרה היא true, הווידג'ט יאפשר סיכום חזותי של תוכן בבקשות חיפוש רלוונטיות. התכונה הזו משמשת רק בחיפוש בתחום הבריאות.
enableCreateAgentButton

boolean

זה שינוי אופציונלי. אם ההגדרה היא True, בווידג'ט יופיע לחצן ליצירת סוכן.
features

map (key: string, value: enum (FeatureState))

פלט בלבד. הגדרת תכונות למנוע כדי להצטרף לתכונות או לבטל את ההצטרפות אליהן. מקשים נתמכים:

  • agent-gallery
  • no-code-agent-builder
  • prompt-gallery
  • model-selector
  • notebook-lm
  • people-search
  • people-search-org-chart
  • bi-directional-audio
  • speech-to-text
  • feedback
  • session-sharing
  • personalization-memory
  • personalization-suggested-highlights
  • mobile-app-access
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
  • disable-welcome-emails
  • disable-canvas
  • canvas-workspace
  • canvas-app-builder
  • skills
  • skill-sharing
  • skill-sharing-without-admin-approval
  • disable-projects
  • sobi
  • enable-end-user-sharing-with-groups
  • single-agent-orchestration
  • multi-agent-orchestration
  • cross-product-intelligence
  • workflow-agents
  • in-app-notifications
modelConfigs

map (key: string, value: enum (ModelState))

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

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

object (SearchAddonSpec)

זה שינוי אופציונלי. ההגדרה SearchAddonSpec משמשת להשבתת תוספים לחיפוש. השדה הזה נתמך רק בבקשות חיפוש.
modelConfigInfo

object (ModelConfigInfo)

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

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

boolean

זה שינוי אופציונלי. האם להציג את השם לתצוגה שהוגדר על ידי האדמין למחברי נתונים בממשק המשתמש של מקורות הווידג'טים (במקום סוג המחבר). הגדרה אופציונלית; ברירת המחדל היא false.
onedrivePickerEnabled

boolean

פלט בלבד. האם כלי לבחירת הקבצים של OneDrive זמין למשתמשי הקצה. הערך מחושב על ידי ה-Backend מתוך הפעלת מחבר אדמין (מהדורת Business) או מחברי OneDrive מצורפים (מהדורת Enterprise), בשילוב עם תכונת האדמין הקיימת disable-onedrive-upload.

השדה optional הוגדר כך שערך מחושב מפורש של false יסודר בסדר מסוים עם נוכחות השדה. פרוטו 3 רגיל bool משמיט ברירת מחדל false בנתונים, מה שמונע מהלקוחות להבחין בין 'כלי הבחירה מושבת' (false) לבין 'השדה לא מאוכלס' (לא מוגדר).
googleDrivePickerEnabled

boolean

פלט בלבד. האם כלי לבחירת קבצים של Google Drive זמין למשתמשי הקצה. הוצהר על optional מאותה סיבה של נוכחות שדה כמו onedrivePickerEnabled למעלה.

InteractionType

תיאור של סוג האינטראקציה.

טיפוסים בני מנייה (enum)
INTERACTION_TYPE_UNSPECIFIED לא צוין. ברירת המחדל היא SEARCH_ONLY.
SEARCH_ONLY חיפוש ללא תשובה גנרטיבית.
SEARCH_WITH_ANSWER חיפוש באמצעות התשובה שנוצרה.
SEARCH_WITH_FOLLOW_UPS חיפוש עם תשובה גנרטיבית שמאפשרת לשאול שאלות המשך. נקרא גם חיפוש רב-שלבי.

GenerativeAnswerConfig

מתאר את ההגדרה של תשובה גנרטיבית.

ייצוג ב-JSON 
{
  "resultCount": integer,
  "modelVersion": string,
  "modelPromptPreamble": string,
  "maxRephraseSteps": integer,
  "languageCode": string,
  "disableRelatedQuestions": boolean,
  "ignoreNonAnswerSeekingQuery": boolean,
  "ignoreAdversarialQuery": boolean,
  "ignoreLowRelevantContent": boolean,
  "imageSource": enum (ImageSource)
}
שדות
resultCount

integer

מספר התוצאות המובילות שמהן תיווצר התשובה. עד 10.
modelVersion

string

גרסת המודל ששימשה ליצירת התשובה.
modelPromptPreamble

string

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

integer

מספר השלבים המקסימלי לניסוח מחדש. המספר המקסימלי הוא 5 שלבים. אם לא מגדירים את הערך או מגדירים ערך נמוך מ-1, ברירת המחדל היא 1.
languageCode

string

קוד השפה של הסיכום. צריך להשתמש בתגי שפה שמוגדרים על ידי BCP47. הערה: זוהי תכונה ניסיונית.
ignoreNonAnswerSeekingQuery

boolean

זה שינוי אופציונלי. מציין אם לסנן שאילתות שלא מחפשות תשובה. ערך ברירת המחדל הוא false.

אם שאילתת החיפוש מסווגת כשאילתה שלא נועדה לקבל תשובה, לא מוחזרת תשובה. אם השדה הזה מוגדר ל-true, אנחנו מדלגים על יצירת תשובות לשאילתות שלא מחפשות תשובות, ומחזירים במקום זאת הודעות חלופיות.
ignoreAdversarialQuery

boolean

זה שינוי אופציונלי. קובעת אם לסנן שאילתות שהן עוינות.
ignoreLowRelevantContent

boolean

זה שינוי אופציונלי. מציין אם לסנן שאילתות שלא רלוונטיות לתוכן.
imageSource

enum (ImageSource)

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

ImageSource

המקור של התמונה שמוחזרת בתשובה.

טיפוסים בני מנייה (enum)
IMAGE_SOURCE_UNSPECIFIED מקור תמונה לא מוגדר (התכונה מרובת-האופנים מושבתת כברירת מחדל)
ALL_AVAILABLE_SOURCES התנהגות כששירות קובע את הבחירה מכל המקורות הזמינים.
CORPUS_IMAGE_ONLY הוספת תמונה מהמאגר לתשובה.
FIGURE_GENERATION_ONLY מפעיל יצירת נתונים בתשובה.

FeatureState

המצב של התכונה במנוע.

טיפוסים בני מנייה (enum)
FEATURE_STATE_UNSPECIFIED לא צוין מצב התכונה.
FEATURE_STATE_ON התכונה מופעלת כדי שתהיה נגישה.
FEATURE_STATE_OFF התכונה מושבתת כדי שלא תהיה אליה גישה.

ModelState

המצב של המודל עבור המנוע.

טיפוסים בני מנייה (enum)
MODEL_STATE_UNSPECIFIED מצב המודל לא צוין.
MODEL_ENABLED האדמין הפעיל את המודל.
MODEL_DISABLED האדמין השבית את המודל.

SearchAddonSpec

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

ייצוג ב-JSON 
{
  "semanticAddOnDisabled": boolean,
  "kpiPersonalizationAddOnDisabled": boolean,
  "generativeAnswerAddOnDisabled": boolean
}
שדות
semanticAddOnDisabled

boolean

זה שינוי אופציונלי. אם הערך הוא true, התוסף הסמנטי מושבת. התוסף הסמנטי כולל הטמעות ו-Jetstream.
kpiPersonalizationAddOnDisabled

boolean

זה שינוי אופציונלי. אם הערך הוא true, המערכת משביתה את הדירוג מחדש של האירועים ואת ההתאמה האישית כדי לבצע אופטימיזציה של מדדי ה-KPI ולהתאים אישית את התוצאות האישיות.
generativeAnswerAddOnDisabled

boolean

זה שינוי אופציונלי. אם הערך הוא True, התוסף ליצירת תשובות מושבת. התוסף 'תשובה גנרטיבית' כולל שפה טבעית לסינון ותשובות פשוטות.

ModelConfigInfo

התצוגה של הגדרות בחירת המודל בצד השרת שמשתמשי הקצה רואים. הבק-אנד מחשב את זה לכל בקשה על ידי החלה, לפי הסדר: הערכת דגל Mendel, כללי זמינות אזוריים על סמך מיקום המנוע, ושינויים מברירת המחדל מחלונית הניהול מ-modelConfigs.

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

ייצוג ב-JSON 
{
  "resolvedModels": [
    {
      object (ResolvedModel)
    }
  ],
  "defaultModelId": string,
  "autoModelId": string
}
שדות
resolvedModels[]

object (ResolvedModel)

פלט בלבד. רשימת המודלים שזמינים למשתמש הקצה בכלי לבחירת מודלים, בסדר שבו הם צריכים להופיע.
defaultModelId

string

פלט בלבד. modelId של המודל שצריך להיבחר כברירת מחדל בבורר המודלים, אם משתמש הקצה לא בחר מודל באופן מפורש. הערך הוא תמיד אחד מהערכים modelId שמופיעים ב-resolvedModels.
autoModelId

string

פלט בלבד. ‫modelId שצריך לשלוח לקוח כשמשתמש הקצה בוחר באפשרות 'אוטומטי' (ה-modelId הריק).

השדה הזה מאוכלס רק בממשקים שלא ידוע שיש בהם מצב 'בחירה אוטומטית' אמיתי, שבו אם לא מגדירים את המודל, המערכת חוזרת לברירת מחדל של הפלטפורמה במקום למודל שנבחר בבק-אנד. הערך ריק בכל פלטפורמה אחרת, כש'אוטומטי' נפתר בצד השרת, וכשאף אחד מהמודלים המדורגים של הפלטפורמה לא זמין. אם הוא מוגדר, הוא תמיד אחד מהערכים הלא ריקים של modelId שמופיעים ב-resolvedModels.

ResolvedModel

מודל יחיד שזמין למשתמש הקצה בבורר המודלים, עם כל המטא-נתונים המקומיים שלו.

ייצוג ב-JSON 
{
  "modelId": string,
  "displayName": string,
  "icon": string,
  "description": string,
  "isPreview": boolean,
  "label": string,
  "adminView": {
    object (AdminView)
  },
  "promoted": boolean,
  "iconUrl": string,
  "family": string
}
שדות
modelId

string

פלט בלבד. מזהה ייחודי של המודל (למשל, gemini-2.5-flash,‏ gemini-3.1-pro-preview).

זהו אותו מזהה שהלקוחות מעבירים בחזרה לשירות העוזר הדיגיטלי כדי לבחור את המודל הזה. גם מודלים וירטואליים או 'פסאודו' (למשל gemini-fast) הם ערכים תקינים כאן. הם נפתרים למודל הקונקרטי הבסיסי בבק-אנד.
displayName

string

פלט בלבד. השם המוצג של המודל בשפה המקומית (למשל, Gemini 3.1 Pro). השם המוצג מותאם לשפה המקומית בצד השרת על סמך LookupWidgetConfigRequest.language_code ו-LookupWidgetConfigRequest.region_code של הבקשה.
icon

string

פלט בלבד. טוקן של סמל שתואם ל-GM3 שמשויך למודל (למשל rocket_launch, ‏ bolt, ‏ graph_5).
description

string

פלט בלבד. טקסט תיאור שמותאם לשוק המקומי (למשל, state-of-the-art reasoning). מותאם לשוק המקומי באמצעות אותו לוקאל כמו displayName.
isPreview

boolean

פלט בלבד. אם המודל נמצא כרגע בתצוגה מקדימה. הלקוחות צריכים להציג את התג הזה בממשק המשתמש של הכלי לבחירת תמונות.
label

string

פלט בלבד. תווית קצרה שמוצגת בצ'יפ של סרגל הבחירה הקומפקטי (למשל, 3.x Flash) לעומת התווית המלאה displayName (Gemini 3.x Flash). אם מאגר הנתונים של הרשם לא מציין תווית קצרה נפרדת, המערכת חוזרת לתווית displayName.
adminView

object (AdminView)

פלט בלבד. מטא-נתונים שמוצגים לאדמין; מאוכלסים רק בדף 'שליטה בתכונות' במסוף (ראו AdminView). לא מוגדרים בממשקים של משתמשי קצה.
promoted

boolean

פלט בלבד. האם כדאי לקדם את המודל הזה בבאנר בדף הבית של הצ'אט של Gemini.
iconUrl

string

פלט בלבד. כתובת URL אבסולוטית של סימן מסחרי שיוצג במקום icon, בדגמים שבהם הלוגו של הספק הוא לא גליף GM3.

icon נשאר מאוכלס כגיבוי, כך שלקוח שלא מעבד תמונות, או שלא מצליח לאחזר את התמונה הזו, יציג את הגליף במקום כלום.
family

string

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

הערך הזה משמש רק להשוואה לשוויון – הוא אף פעם לא מנותח ולא מוצג למשתמש, ולכן הוא לא עובר לוקליזציה.

AdminView

מטא-נתונים של פלטפורמת האדמין. השדה הזה מאוכלס רק כשהבקשה מגיעה מדף האדמין 'שליטה בתכונות' במסוף Cloud. הוא לא מוגדר בממשקי משתמש קצה (אינטרנט, נייד). מאפשרת לדף ניהול חשבון ארגוני לעבד את טבלת המתגים שלו ישירות מהבק-אנד במקום מרישום מקודד בצד הלקוח.

ייצוג ב-JSON 
{
  "adminOverridable": boolean,
  "enabledByDefault": boolean,
  "regions": [
    string
  ]
}
שדות
adminOverridable

boolean

פלט בלבד. האם האדמין יכול להפעיל או להשבית את המודל הזה דרך UiSettings.model_configs. מבוסס על MODEL_TAG_ADMIN_OVERRIDABLE. אם המדיניות מוגדרת כ-False, המודל הוא 'מאולץ' והמצב שלו כפוף ל-enabledByDefault.
enabledByDefault

boolean

פלט בלבד. ההגדרה קובעת אם המודל מופעל כשהאדמין לא הגדיר ביטול מפורש ב-UiSettings.model_configs. מבוסס על MODEL_TAG_ENABLED_BY_DEFAULT.
regions[]

string

פלט בלבד. האזורים שבהם המודל הזה הושק.

AccessSettings

תיאור של הגדרות הגישה לווידג'ט.

ייצוג ב-JSON 
{
  "allowPublicAccess": boolean,
  "allowlistedDomains": [
    string
  ],
  "enableWebApp": boolean,
  "workforceIdentityPoolProvider": string,
  "languageCode": string
}
שדות
allowPublicAccess

boolean

האם מותרת גישה ציבורית ללא אימות.
allowlistedDomains[]

string

רשימה של דומיינים שמותר להם לשלב את ווידג'ט חיפוש Google.
enableWebApp

boolean

האם הגישה לאפליקציית האינטרנט מופעלת.
workforceIdentityPoolProvider

string

זה שינוי אופציונלי. הספק של מאגר הזהויות של כוח העבודה שמשמש לגישה לווידג'ט.
languageCode

string

זה שינוי אופציונלי. קוד השפה של ממשק המשתמש. צריך להשתמש בתגי שפה שמוגדרים על ידי BCP47. אם לא מגדירים את קוד השפה, ברירת המחדל היא en-US.

UiBrandingSettings

תיאור של הגדרות המיתוג של ממשק המשתמש של הווידג'ט.

ייצוג ב-JSON 
{
  "logo": {
    object (Image)
  }
}
שדות

תמונה

אפשרויות לאחסון תמונה.

ייצוג ב-JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "url": string
  // End of mutually exclusive fields.
}
שדות
דרכים שונות לאחסון תמונה, למשל ככתובת URL או כמחרוזת בקידוד base64. הרשימה הבאה כוללת שדות שאי אפשר להשתמש בהם בו-זמנית. בכל תשובה יוגדר לכל היותר אחד מהשדות:
url

string

כתובת ה-URL של התמונה.
סוף השדות הבלעדיים.

HomepageSetting

תיאור של הגדרת דף הבית של הווידג'ט. היא כוללת את כל ההגדרות וההגדרות האישיות שקשורות לדף הבית, כמו קיצורי דרך.

ייצוג ב-JSON 
{
  "shortcuts": [
    {
      object (Shortcut)
    }
  ]
}
שדות
shortcuts[]

object (Shortcut)

זה שינוי אופציונלי. קיצורי הדרך שיוצגו בדף הבית.

קיצור דרך

מתארת ישות של קיצור דרך (כלומר תוכן מוצמד) בדף הבית. דף הבית יציג את קיצורי הדרך האלה באותו סדר שמוחזר על ידי ה-API. אם לקוח רוצה לשנות את הסדר של קיצור דרך או להסיר אותו, ממשק המשתמש צריך תמיד לספק את הרשימה המלאה החדשה של קיצורי הדרך.

ייצוג ב-JSON 
{
  "title": string,
  "icon": {
    object (Image)
  },
  "destinationUri": string
}
שדות
title

string

זה שינוי אופציונלי. השם של קיצור הדרך.
icon

object (Image)

זה שינוי אופציונלי. כתובת ה-URL של הסמל של קיצור הדרך.
destinationUri

string

זה שינוי אופציונלי. כתובת היעד של קיצור הדרך.

AssistantSettings

תיאור של הגדרות העזרה של הווידג'ט.

ייצוג ב-JSON 
{
  "googleSearchGroundingEnabled": boolean,
  "webGroundingType": enum (WebGroundingType),
  "defaultWebGroundingToggleOff": boolean,
  "disableLocationContext": boolean
}
שדות
googleSearchGroundingEnabled
(deprecated)

boolean

אם מתג ההארקה של חיפוש Google מוצג או לא. הוצאה משימוש, במקום זאת, אתם צריכים להשתמש ב-webGroundingType.
webGroundingType

enum (WebGroundingType)

זה שינוי אופציונלי. סוג ההצמדה לאינטרנט שבה רוצים להשתמש.
defaultWebGroundingToggleOff

boolean

פלט בלבד. השדה הזה קובע את מצב ברירת המחדל של המתג 'הארקה של האינטרנט' למשתמשי קצה אם הערך של webGroundingType הוא WEB_GROUNDING_TYPE_GOOGLE_SEARCH או WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. כברירת מחדל, הערך שמוגדר בשדה הזה הוא false. אם webGroundingType הוא WEB_GROUNDING_TYPE_GOOGLE_SEARCH או WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH, ההצמדה לאינטרנט תהיה מופעלת כברירת מחדל בממשק המשתמש של משתמשי הקצה. אם הערך הוא True, המתג להארקה מושבת כברירת מחדל בממשק המשתמש. משתמשי קצה עדיין יכולים להפעיל עיגון בנתונים מהאינטרנט בממשק המשתמש אם העיגון בנתונים מהאינטרנט מופעל.
disableLocationContext

boolean

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

WebGroundingType

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

טיפוסים בני מנייה (enum)
WEB_GROUNDING_TYPE_UNSPECIFIED הגדרת ברירת מחדל שלא צוינה. המשמעות של ההגדרה הזו זהה להגדרה 'מושבת'.
WEB_GROUNDING_TYPE_DISABLED העיגון בנתונים מהאינטרנט מושבת.

CustomerProvidedConfig

הגדרות שהלקוח סיפק.

ייצוג ב-JSON 
{
  "customerType": enum (CustomerType),
  "complianceLevel": enum (ComplianceLevel)
}
שדות
customerType

enum (CustomerType)

סוג הלקוח.
complianceLevel

enum (ComplianceLevel)

פלט בלבד. רמת התאימות של הלקוח ל-Assured Workloads.

‫customerType מצמצם כל רמת תאימות לערך GOVERNMENT_CUSTOMER יחיד, ולכן לקוח שחוסם תכונה ברמה ספציפית אחת ולא בסטטוס ממשלתי באופן כללי, צריך לקרוא את השדה הזה במקום זאת.

CustomerType

סוג הלקוח.

טיפוסים בני מנייה (enum)
DEFAULT_CUSTOMER סוג הלקוח שמוגדר כברירת מחדל.
GOVERNMENT_CUSTOMER סוג הלקוח הממשלתי. חלק מהתכונות מושבתות ללקוחות ממשלתיים בגלל דרישות משפטיות.

ComplianceLevel

רמת התאימות של Assured Workloads בפרויקט של הלקוח.

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

טיפוסים בני מנייה (enum)
COMPLIANCE_LEVEL_UNSPECIFIED לפרויקט אין רמת תאימות של Assured Workloads, או שהוא מדווח על רמה שלא מופיעה בגרסה הזו של ה-API.
COMPLIANCE_LEVEL_FEDRAMP_HIGH רמת התאימות FedRAMP High.
COMPLIANCE_LEVEL_IL4 רמת התאימות Impact Level 4‏ (IL4).
COMPLIANCE_LEVEL_IL5 רמת התאימות Impact Level 5‏ (IL5).

BatchAuthStatus

תיאור של סטטוס ההרשאה של קבוצת הרשאות.

ייצוג ב-JSON 
{
  "placeholder": string,
  "batchAuthorizationGroup": string,
  "connectorAuthState": {
    object (ConnectorAuthState)
  }
}
שדות
placeholder

string

פלט בלבד. זהו השם המלא של המשאב של ה-placeholder של קבוצת ההרשאות של האצווה. זה לא מחבר נתונים אמיתי (לא קיים בטבלת DataConnector ב-Spanner). זהו שם משאב שקיים רק ב-connector_authorization בטבלת המשתמשים. לדוגמה: projects/{project}/locations/{location}/collections/oauth_placeholder_google_workspace/dataStores/dataConnector.
batchAuthorizationGroup

string

פלט בלבד. קבוצת ההרשאות של הבקשה, שאליה שייך ה-placeholder.
connectorAuthState

object (ConnectorAuthState)

פלט בלבד. מצב ההרשאה הנוכחי של המחבר הזה.

צומת

מייצג יחידה חישובית או לוגית אחת שאפשר לעשות בה שימוש חוזר.

ייצוג ב-JSON 
{
  "displayName": string,
  "iconUrl": string,
  "description": string,
  "parameterSchema": {
    object
  },
  "outputSchema": {
    object
  },
  "type": enum (Type)
}
שדות
displayName

string

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

string

פלט בלבד. מזהה או כתובת URL שמפנים לסמל שמייצג את סוג הצומת הזה.
description

string

פלט בלבד. תיאור מפורט של מה שהצומת עושה.
parameterSchema

object (Struct format)

פלט בלבד. סכימת הפרמטרים של הכלי.

הסכימה הזו צריכה להיות תואמת לתקן של סכימת OpenAPI (ראו https://spec.openapis.org/oas/v3.0.3.html ו-AIP-146). הוא מתאר את המבנה הצפוי של הפרמטרים שהצומת הזה מקבל.
outputSchema

object (Struct format)

פלט בלבד. סכימת הפלט של הכלי.

הסכימה הזו צריכה להיות תואמת לתקן של סכימת OpenAPI (ראו https://spec.openapis.org/oas/v3.0.3.html/ ו-AIP-146). הוא מתאר את מבנה הפלט שנוצר על ידי הצומת הזה.
type

enum (Type)

פלט בלבד. סוג הצומת.

סוג

מזהה את סוג הצומת בתהליך העבודה של הסוכן.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED סוג לא מוגדר.
TRIGGER סוג הטריגר.
FLOW סוג הזרימה.
CONNECTOR סוג המחבר.

Methods

get

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

patch

 עדכון של WidgetConfig.