Method: projects.locations.setUpDataConnector

יוצרת Collection ומגדירה את DataConnector בשבילו. כדי להפסיק את השימוש ב-DataConnector אחרי ההגדרה, משתמשים בשיטה CollectionService.DeleteCollection.

בקשת HTTP

POST https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*}:setUpDataConnector

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

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

פרמטרים
parent

string

חובה. ההורה של Collection, בפורמט projects/{project}/locations/{location}.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "collectionId": string,
  "collectionDisplayName": string,
  "dataConnector": {
    object (DataConnector)
  }
}
שדות
collectionId

string

חובה. המזהה לשימוש ב-Collection, שיהפוך לרכיב הסופי של שם המשאב של Collection. מערכת Collection חדשה נוצרת כחלק מההגדרה של DataConnector. ‫DataConnector הוא משאב יחידני (singleton) ב-Collection, שמנהל את כל DataStore של Collection.

השדה הזה צריך להיות בהתאם לתקן RFC-1034, עם מגבלת אורך של 63 תווים. אחרת, מוחזרת שגיאת INVALID_ARGUMENT.
collectionDisplayName

string

חובה. השם המוצג של Collection.

השם צריך להיות קריא לאנשים, והוא משמש להצגת הקולקציות בלוח הבקרה של המסוף. מחרוזת בקידוד UTF-8 עם מגבלה של 1,024 תווים.
dataConnector

object (DataConnector)

חובה. הפקודה DataConnector לאתחול ב-Collection החדש שנוצר.

גוף התשובה

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

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.locations.setUpDataConnector

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