Method: projects.locations.dataStores.siteSearchEngine.targetSites.list

מקבל רשימה של TargetSite.

בקשת HTTP


GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/dataStores/*/siteSearchEngine}/targetSites

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

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

פרמטרים
parent

string

חובה. שם המשאב של מנוע החיפוש באתר הראשי, כמו projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine.

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

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

פרמטרים
pageSize

integer

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

אם הערך בשדה הזה שלילי, תוחזר שגיאה מסוג INVALID_ARGUMENT.
pageToken

string

טוקן של דף שהתקבל מקריאה קודמת של targetSites.list. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

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

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.targetSites.list

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