Method: projects.locations.collections.dataStores.siteSearchEngine.fetchDomainVerificationStatus

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

בקשת HTTP

GET https://discoveryengine.googleapis.com/v1/{siteSearchEngine=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}:fetchDomainVerificationStatus

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

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

פרמטרים
siteSearchEngine

string

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

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

פרמטרים
pageSize

integer

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

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

string

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

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

גוף הבקשה

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

גוף התשובה

הודעת תגובה לשיטה SiteSearchEngineService.FetchDomainVerificationStatus.

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

ייצוג ב-JSON 
{
  "targetSites": [
    {
      object (TargetSite)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
שדות
targetSites[]

object (TargetSite)

רשימה של TargetSites שמכילה את סטטוס האימות של האתר.
nextPageToken

string

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

integer

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

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.siteSearchEngines.fetchDomainVerificationStatus

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