Method: projects.locations.obtainCrawlRate

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

בקשת HTTP

POST https://discoveryengine.googleapis.com/v1beta/{location=projects/*/locations/*}:obtainCrawlRate

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

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

פרמטרים
location

string

חובה. משאב המיקום שבו יתבצע ניהול קצב הסריקה. פורמט: projects/{project}/locations/{location}

גוף הבקשה

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

ייצוג ב-JSON 
{
  "crawlRateScope": string
}
שדות
crawlRateScope

string

חובה. ההיקף של קצב הסריקה שהמשתמש רוצה לעקוב אחריו. בשלב הזה יש תמיכה רק בדומיין ובשם המארח. דוגמה לשם דומיין: example.com. דוגמה לשם מארח: www.example.com. אל תכללו את / בשם הדומיין או בשם המארח.

גוף התשובה

הודעת תגובה לשיטה CrawlRateManagementService.ObtainCrawlRate. התשובה מכילה נתונים של סדרת זמנים של קצב סריקה אורגני או ייעודי לצורך מעקב, בהתאם להגדרה של קצב סריקה ייעודי.

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

ייצוג ב-JSON 
{
  "state": enum (State),
  "error": {
    object (Status)
  },

  // Union field crawl_rate_time_series can be only one of the following:
  "organicCrawlRateTimeSeries": {
    object (OrganicCrawlRateTimeSeries)
  },
  "dedicatedCrawlRateTimeSeries": {
    object (DedicatedCrawlRateTimeSeries)
  }
  // End of list of possible types for union field crawl_rate_time_series.
}
שדות
state

enum (State)

פלט בלבד. המצב של התגובה.
error

object (Status)

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

object (OrganicCrawlRateTimeSeries)

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

object (DedicatedCrawlRateTimeSeries)

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

היקפי הרשאות

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

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

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

OrganicCrawlRateTimeSeries

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

ייצוג ב-JSON 
{
  "googleOrganicCrawlRate": {
    object (CrawlRateTimeSeries)
  },
  "vertexAiOrganicCrawlRate": {
    object (CrawlRateTimeSeries)
  }
}
שדות
googleOrganicCrawlRate

object (CrawlRateTimeSeries)

סדרת הזמן של קצב הסריקה האורגני של Google, שהיא סכום קצב הסריקה של כל ה-Googlebot. למידע נוסף על Googlebot, אפשר לעיין במאמר https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers.
vertexAiOrganicCrawlRate

object (CrawlRateTimeSeries)

סדרת הזמן של קצב הסריקה האורגני של Vertex AI, שהוא קצב הסריקה של Google-CloudVertexBot כשלא מוגדרת סריקה ייעודית. פרטים נוספים על Google-CloudVertexBot זמינים בכתובת https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot.

CrawlRateTimeSeries

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

ייצוג ב-JSON 
{
  "qpsTimeSeries": {
    object (TimeSeries)
  }
}
שדות
qpsTimeSeries

object (TimeSeries)

ה-QPS של קצב הסריקה.

DedicatedCrawlRateTimeSeries

נתוני סדרות הזמן של קצב הסריקה ההיסטורי הייעודי, שמשמשים למעקב. הסריקה הייעודית משמשת את Vertex AI לסריקת האתר של המשתמש כשהיא מוגדרת.

ייצוג ב-JSON 
{
  "userTriggeredCrawlRate": {
    object (CrawlRateTimeSeries)
  },
  "autoRefreshCrawlRate": {
    object (CrawlRateTimeSeries)
  },
  "userTriggeredCrawlErrorRate": {
    object (CrawlRateTimeSeries)
  },
  "autoRefreshCrawlErrorRate": {
    object (CrawlRateTimeSeries)
  }
}
שדות
userTriggeredCrawlRate

object (CrawlRateTimeSeries)

סדרת הזמן של קצב הסריקה הייעודי של Vertex AI של סריקה שהופעלה על ידי משתמש, שהוא קצב הסריקה של Google-CloudVertexBot כשמוגדרת סריקה ייעודית, וקצב הסריקה שהופעלה על ידי משתמש מיועד לתרחישי שימוש דטרמיניסטיים כמו סריקת כתובות URL או מפות אתרים שצוינו על ידי משתמשים.
autoRefreshCrawlRate

object (CrawlRateTimeSeries)

סדרת הזמן של קצב הסריקה הייעודי של Vertex AI של רענון אוטומטי, שהוא קצב הסריקה של Google-CloudVertexBot כשמוגדרת סריקה ייעודית, וקצב הסריקה מיועד לתרחישי שימוש של מאמץ מקסימלי כמו רענון כתובות URL מעת לעת.
userTriggeredCrawlErrorRate

object (CrawlRateTimeSeries)

סדרת הזמן של שיעור השגיאות ב-Vertex AI של סריקה ייעודית שהופעלה על ידי משתמש.
autoRefreshCrawlErrorRate

object (CrawlRateTimeSeries)

סדרת הזמן של שיעור השגיאות ב-Vertex AI של סריקה ייעודית עם רענון אוטומטי.

מדינה

מצבים שונים של התשובה.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED המצב לא צוין.
SUCCEEDED הסטטוס הוא 'הושלם בהצלחה'.
FAILED המצב הוא 'נכשל'.