REST Resource: projects.locations.collections.dataStores.siteSearchEngine.targetSites

משאב: TargetSite

אתר יעד עבור SiteSearchEngine.

ייצוג JSON 
{
  "name": string,
  "providedUriPattern": string,
  "type": enum (Type),
  "exactMatch": boolean,
  "generatedUriPattern": string,
  "rootDomainUri": string,
  "siteVerificationInfo": {
    object (SiteVerificationInfo)
  },
  "indexingStatus": enum (IndexingStatus),
  "updateTime": string,
  "failureReason": {
    object (FailureReason)
  }
}
שדות
name

string

פלט בלבד. שם המשאב המלא של אתר היעד. projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/siteSearchEngine/targetSites/{targetSite} ה-target_site_id נוצר על ידי המערכת.
providedUriPattern

string

חובה. קלט בלבד. תבנית כתובת ה-URI שסופקה על ידי המשתמש, שממנה נוצרת כתובת ה-URI generatedUriPattern.
type

enum (Type)

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

boolean

אי אפשר לשנות. אם הערך הוא false, נוצר uri_pattern שכולל את כל הדפים שכתובתם מכילה את הערך של providedUriPattern. אם הערך מוגדר כ-true, נוצר uri_pattern כדי לנסות להתאים בדיוק ל-providedUriPattern או רק לדף הספציפי אם providedUriPattern הוא ספציפי. תמיד מתבצעת נורמליזציה של providedUriPattern כדי ליצור את תבנית ה-URI שתשמש את מנוע החיפוש.
generatedUriPattern

string

פלט בלבד. הערך הזה נוצר על ידי המערכת על סמך ה-providedUriPattern.
rootDomainUri

string

פלט בלבד. הדומיין הבסיסי (root) של ה-UriPattern שצוין.
siteVerificationInfo

object (SiteVerificationInfo)

פלט בלבד. סטטוס האימות של הבעלות על האתר והתוקף שלו.
indexingStatus

enum (IndexingStatus)

פלט בלבד. סטטוס ההוספה לאינדקס.
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".
failureReason

object (FailureReason)

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

סוג

סוגי אתרים אפשריים לטירגוט.

טיפוסים בני מנייה (enum)
TYPE_UNSPECIFIED הערך הזה לא בשימוש. במקרה כזה, התנהגות השרת תהיה Type.INCLUDE כברירת מחדל.
INCLUDE כוללים את האתר המטרה.
EXCLUDE להחריג את אתר היעד.

SiteVerificationInfo

מידע על אימות אתרים לטירגוט בחיפוש מתקדם באתרים.

ייצוג JSON 
{
  "siteVerificationState": enum (SiteVerificationState),
  "verifyTime": string
}
שדות
siteVerificationState

enum (SiteVerificationState)

מצב האימות של האתר שמציין את הבעלות והתוקף.
verifyTime

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".

SiteVerificationState

מצב אימות האתר.

טיפוסים בני מנייה (enum)
SITE_VERIFICATION_STATE_UNSPECIFIED ברירת המחדל היא VERIFIED.
VERIFIED הבעלות על האתר אומתה.
UNVERIFIED הבעלות על האתר ממתינה לאימות או שהאימות נכשל.
EXEMPTED אתר שפטור מאימות, למשל אתר ציבורי שפתוח לכולם.

IndexingStatus

ספירה של סטטוס ההוספה לאינדקס של אתר היעד.

טיפוסים בני מנייה (enum)
INDEXING_STATUS_UNSPECIFIED ברירת המחדל היא SUCCEEDED.
PENDING אתר היעד נמצא בתור לעדכון, והוא ייבחר על ידי צינור האינדוקס.
FAILED האתר המטורגט לא נוסף לאינדקס.
SUCCEEDED האתר המטורגט נוסף לאינדקס.
DELETING אתר היעד שבוצע בו אינדוקס בעבר סומן למחיקה. זהו מצב מעבר שיוביל לאחד מהמצבים הבאים: 1. מחיקת אתר היעד אם ביטול הוספת האתר לאינדקס יצליח. 2. חזרה למצב SUCCEEDED אם ביטול הוספת האתר לאינדקס ייכשל.
CANCELLABLE השינוי באתר היעד נמצא בהמתנה אבל אפשר לבטל אותו.
CANCELLED השינוי באתר היעד בוטל.

FailureReason

הסיבות לכשל בהוספה לאינדקס של חיפוש באתר.

ייצוג JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "quotaFailure": {
    object (QuotaFailure)
  }
  // End of mutually exclusive fields.
}
שדות
הסיבה לכשל. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. רק אחד מהשדות הבאים יוגדר בתשובה:
quotaFailure

object (QuotaFailure)

הפעולה נכשלה כי מיצית את המכסה.
סוף השדות הבלעדיים.

QuotaFailure

הפעולה נכשלה כי מיצית את המכסה.

ייצוג JSON 
{
  "totalRequiredQuota": string
}
שדות
totalRequiredQuota

string (int64 format)

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

Methods

batchCreate

 יוצרת TargetSite קודים בקבוצה.

create

 יצירת TargetSite.

delete

 מחיקת TargetSite.

get

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

list

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

patch

 עדכון של TargetSite.