- בקשת HTTP
- פרמטרים של נתיבים
- גוף הבקשה
- גוף התשובה
- היקפי הרשאות
- OrganicCrawlRateTimeSeries
- CrawlRateTimeSeries
- DedicatedCrawlRateTimeSeries
- מדינה
משיג את נתוני סדרת הזמן של קצב סריקה אורגני או ייעודי לצורך ניטור. כאשר קצב סריקה ייעודי אינו מוגדר, הוא יחזיר את סדרת הזמן של קצב הסריקה האורגנית של קודקוד הבינה המלאכותית. סריקה אורגנית פירושה שגוגל סורקת את האינטרנט באופן אוטומטי כרצונה. כאשר מוגדר קצב סריקה ייעודי, הוא יחזיר את סדרת הזמן של קצב הסריקה הייעודי של קודקוד הבינה המלאכותית.
בקשת HTTP
POST https://discoveryengine.googleapis.com/v1beta/{location=projects/*/locations/*}:obtainCrawlRate
כתובת ה-URL כתובה בתחביר של gRPC Transcoding.
פרמטרים של נתיב
| פרמטרים | |
|---|---|
location |
חובה. משאב המיקום שבו יתבצע ניהול קצב הסריקה. פורמט: |
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
| ייצוג JSON |
|---|
{ "crawlRateScope": string } |
| שדות | |
|---|---|
crawlRateScope |
חובה. היקף קצב הסריקה שהמשתמש רוצה לנטר. נכון לעכשיו, רק שם דומיין ושם מארח נתמכים. דוגמה לשם דומיין: |
גוף התשובה
הודעת תגובה לשיטה CrawlRateManagementService.ObtainCrawlRate. התשובה מכילה נתונים של סדרת זמנים של קצב סריקה אורגני או ייעודי לצורך מעקב, בהתאם להגדרה של קצב סריקה ייעודי.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
| ייצוג JSON |
|---|
{ "state": enum ( |
| שדות | |
|---|---|
state |
פלט בלבד. מצב התגובה. |
error |
שגיאות מהשירות במהלך הטיפול בבקשה. |
| אחרי שהמשתמש מגדיר את קצב הסריקה הייעודי, הפונקציה מחזירה את סדרת הזמן של קצב הסריקה הייעודי. אחרת, היא מחזירה את סדרת הזמן של קצב הסריקה האורגני. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. רק אחד מהשדות הבאים יוגדר בתשובה: | |
organicCrawlRateTimeSeries |
נתוני סדרות הזמן של קצב הסריקה האורגנית ההיסטורי, שמשמשים למעקב. |
dedicatedCrawlRateTimeSeries |
נתוני סדרת הזמן של קצב הסריקה ההיסטורי הייעודי, שמשמשים למעקב. |
| סוף השדות הבלעדיים. | |
היקפי הרשאות
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/discoveryengine.readwritehttps://www.googleapis.com/auth/discoveryengine.serving.readwrite
ניתן למצוא מידע נוסף כאן: Authentication Overview.
OrganicCrawlRateTimeSeries
נתוני סדרות הזמן של קצב הסריקה האורגנית ההיסטורי, שמשמשים למעקב. סריקה אורגנית נקבעת באופן אוטומטי על ידי Google כדי לסרוק את אתר המשתמש כשלא מוגדרת סריקה ייעודית. קצב הסריקה הוא מספר הבקשות בשנייה של בקשת הסריקה ש-Google שולחת לאתר של המשתמש.
| ייצוג JSON |
|---|
{ "googleOrganicCrawlRate": { object ( |
| שדות | |
|---|---|
googleOrganicCrawlRate |
סדרת הזמן של קצב הסריקה האורגנית של גוגל, שהיא סכום קצב הסריקה של כל googlebots. פרטים נוספים על Googlebot זמינים בכתובת https://developers.google.com/search/docs/crawling-indexing/overview-google-crawlers. |
vertexAiOrganicCrawlRate |
סדרת הזמן של קצב הסריקה האורגני של Vertex AI, שהוא קצב הסריקה של Google-CloudVertexBot כשלא מוגדרת סריקה ייעודית. פרטים נוספים על Google-CloudVertexBot זמינים בכתובת https://developers.google.com/search/docs/crawling-indexing/google-common-crawlers#google-cloudvertexbot. |
CrawlRateTimeSeries
נתוני סדרות הזמן של קצב הסריקה ההיסטורי, שמשמשים למעקב.
| ייצוג JSON |
|---|
{
"qpsTimeSeries": {
object ( |
| שדות | |
|---|---|
qpsTimeSeries |
ה-QPS של קצב הסריקה. |
DedicatedCrawlRateTimeSeries
נתוני סדרת הזמן של קצב הסריקה ההיסטורי הייעודי, שמשמשים למעקב. סריקה ייעודית משמשת את Vertex AI לסריקת האתר של המשתמש כשהיא מוגדרת.
| ייצוג JSON |
|---|
{ "userTriggeredCrawlRate": { object ( |
| שדות | |
|---|---|
userTriggeredCrawlRate |
סדרת הזמנים של קצב הסריקה הייעודי של Vertex AI של סריקה שהופעלה על ידי משתמש, שהוא קצב הסריקה של Google-CloudVertexBot כשמוגדרת סריקה ייעודית, וקצב הסריקה שהופעלה על ידי משתמש מיועד לתרחישי שימוש דטרמיניסטיים כמו סריקת כתובות URL או מפות אתרים שצוינו על ידי משתמשים. |
autoRefreshCrawlRate |
סדרת הזמן של קצב הסריקה הייעודי של Vertex AI לרענון אוטומטי, שהיא קצב הסריקה של Google-CloudVertexBot כאשר מוגדרת סריקה ייעודית, וקצב הסריקה מיועד למקרי שימוש במאמץ מיטבי כמו רענון כתובות URL מעת לעת. |
userTriggeredCrawlErrorRate |
סדרת הזמן של שיעור השגיאות ב-Vertex AI של סריקה ייעודית שהופעלה על ידי משתמש. |
autoRefreshCrawlErrorRate |
סדרת זמן של שיעור שגיאות של Vertex AI של סריקה ייעודית לרענון אוטומטי. |
מדינה
מצבים שונים של התשובה.
| טיפוסים בני מנייה (enum) | |
|---|---|
STATE_UNSPECIFIED |
המצב לא צוין. |
SUCCEEDED |
המדינה מצליחה. |
FAILED |
המדינה נכשלה. |