Method: hashLists.batchGet

קבלת מספר רשימות גיבוב (hash) בבת אחת.

לעיתים קרובות לקוח צריך לקבל מספר רשימות גיבוב (hash). שימוש בשיטה הזו עדיפה על פני שימוש בשיטת Get הרגילה כמה פעמים.

זוהי שיטת אחזור רגילה באצווה לפי ההגדרה של https://google.aip.dev/231. גם שיטת ה-HTTP היא GET.

בקשת HTTP

GET https://safebrowsing.googleapis.com/v5alpha1/hashLists:batchGet

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

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

פרמטרים
names[]

string

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

version[]

string (bytes format)

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

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

הערה היסטורית: ב-V4 של ה-API השם נקרא states; השם שלו השתנה ל-version לצורך הבהרה.

מחרוזת בקידוד base64.

desiredHashLength

enum (HashLength)

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

לרשימות גיבוב שונות יש דרישות שונות לגבי הערכים הקבילים של השדה desiredHashLength. ניתן למצוא את הערך הזה בשדה supportedHashLengths ב-HashListMetadata. אם desiredHashLength לא מציין ערך בתוך supportedHashLengths, תוחזר שגיאה ללקוחות.

באופן ספציפי, ללקוחות BatchGetHashListsRequest אין אפשרות לציין desiredHashLength שונה לרשימות שונות. אם צריך לעשות זאת, הלקוח צריך לפצל את זה לכמה BatchGetHashListsRequest.

sizeConstraints

object (SizeConstraints)

מגבלות הגודל בכל רשימה. אם לא מזינים, אין מגבלות. לתשומת ליבכם: הגדלים האלה הם לפי רשימה ולא נצברים מכל הרשימות.

גוף הבקשה

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

גוף התשובה

התשובה שמכילה כמה רשימות גיבוב (hash).

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

ייצוג JSON
{
  "hashLists": [
    {
      object (HashList)
    }
  ]
}
שדות
hashLists[]

object (HashList)

רשימת ה-hash תופיע לפי אותו סדר שניתן בבקשה.