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))

המפתח הוא רכיב ה-UI. הדמיה. כרגע נתמכים 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, גישה ציבורית לחיפוש או לפתרונות אחרים מהווידג'ט מותרת ללא אסימון אימות המסופק על ידי שרת backend המתארח על ידי הלקוח.
allowlistedDomains[]
(deprecated)

string

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

boolean

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

boolean

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

enum (ResultDisplayType)

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

  • ‫RESULT_DISPLAY_TYPE_UNSPECIFIED למשתמשים קיימים.
  • SNIPPET עבור משתמשי חיפוש חדשים שאינם ארגוניים.
  • 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

האם להפעיל את ההתנהגות של חיפוש בזמן ההקלדה בווידג'ט החיפוש
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)

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

object (AccessSettings)

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

object (UiBrandingSettings)

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

object (HomepageSetting)

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

object (AssistantSettings)

זה שינוי אופציונלי. פלט בלבד. תיאור של הגדרות ה-Assistant של הווידג'ט.
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))

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

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

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

CollectionComponent

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

עבור מנועי SaaS / עסקיים, כאשר LookupWidgetConfig נקרא עם view = WITH_AVAILABLE_CONNECTORS, מופעים של הודעה זו משמשים גם לייצוג ערכי placeholder סינתטיים עבור מחברים שהקורא עשוי לחבר אך עדיין לא חיבר. לרשומות של placeholder יש connectorAuthState.auth_state == AUTH_STATE_UNSPECIFIED (או NO_AUTH), שדה connectorAuthState.authorization_uri ריק (הווידג'ט קורא ל-WidgetBuildAuthorizationUrl כשהמשתמש לוחץ על 'התחברות') וערכי placeholder סינתטיים ב-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
}
שדות
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)

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

object (ConnectorMetadata)

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

boolean

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

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

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

ייצוג 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

האם להפעיל את ההתנהגות של חיפוש בזמן ההקלדה בווידג'ט החיפוש.
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.

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

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

object (ResolvedModel)

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

string

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

ResolvedModel

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

ייצוג JSON 
{
  "modelId": string,
  "displayName": string,
  "icon": string,
  "description": string,
  "isPreview": boolean,
  "label": string,
  "adminView": {
    object (AdminView)
  },
  "promoted": boolean
}
שדות
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.

AdminView

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

ייצוג 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

רשימת דומיינים המורשים לשלב את ווידג'ט החיפוש.
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

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

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

boolean

האם כפתור ההפעלה של חיפוש גוגל מוצג או לא. הוצאה משימוש, במקום זאת, אתם צריכים להשתמש ב-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.
COMPLIANCE_LEVEL_IL4 רמת התאימות Impact Level 4‏ (IL4).
COMPLIANCE_LEVEL_IL5 רמת התאימות Impact Level 5‏ (IL5).

BatchAuthStatus

מתאר את סטטוס הרשאת הקבוצה עבור batchAuthorizationGroup.

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

string

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

string

פלט בלבד. קבוצת הרשאות האצווה שאליה שייך מציין המיקום.
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 Schema (ראה 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.