Method: hashLists.batchGet

एक बार में कई हैश सूचियां पाएं.

आम तौर पर, किसी क्लाइंट को एक से ज़्यादा हैश सूचियां चाहिए होती हैं. एक से ज़्यादा बार सामान्य Get तरीके का इस्तेमाल करने के बजाय, इस तरीके का इस्तेमाल करना बेहतर होता है.

यह बैच में एक साथ कई आइटम पाने का स्टैंडर्ड तरीका है. इस बारे में https://google.aip.dev/231 में बताया गया है. साथ ही, एचटीटीपी का तरीका भी GET है.

एचटीटीपी अनुरोध

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

यूआरएल में gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल किया गया है.

क्वेरी पैरामीटर

पैरामीटर
names[]

string

ज़रूरी है. खास हैश सूचियों के नाम. यह सूची, खतरे वाली सूची या ग्लोबल कैश मेमोरी हो सकती है. नामों में डुप्लीकेट नहीं होने चाहिए. अगर ऐसा होता है, तो क्लाइंट को गड़बड़ी का मैसेज मिलेगा.

version[]

string (bytes format)

हैश सूची के वे वर्शन जो क्लाइंट के पास पहले से मौजूद हैं. अगर क्लाइंट पहली बार हैश सूचियां फ़ेच कर रहा है, तो फ़ील्ड को खाली छोड़ दिया जाना चाहिए. अगर ऐसा नहीं है, तो क्लाइंट को सर्वर से पहले मिले वर्शन देने चाहिए. क्लाइंट को उन बाइट में बदलाव नहीं करना चाहिए.

क्लाइंट को वर्शन को उसी क्रम में भेजने की ज़रूरत नहीं है जिस क्रम में सूची के नाम हैं. क्लाइंट, नामों की संख्या से कम या ज़्यादा वर्शन भेज सकता है. हालांकि, क्लाइंट को एक ही नाम वाले कई वर्शन नहीं भेजने चाहिए. ऐसा करने पर, क्लाइंट को गड़बड़ी का मैसेज मिलेगा.

पुरानी जानकारी: एपीआई के V4 में, इसे states कहा जाता था. इसे साफ़ तौर पर समझाने के लिए, अब इसका नाम बदलकर version कर दिया गया है.

base64 कोड में बदली गई स्ट्रिंग.

desiredHashLength
(deprecated)

enum (HashLength)

हैश के प्रीफ़िक्स की लंबाई, बाइट में. इसके बाद, सर्वर इस तय लंबाई में सभी हैश प्रीफ़िक्स दिखाएगा.

अलग-अलग हैश सूचियों के लिए, desiredHashLength फ़ील्ड की स्वीकार की जा सकने वाली वैल्यू से जुड़ी ज़रूरी शर्तें अलग-अलग होती हैं. यह HashListMetadata में supportedHashLengths फ़ील्ड में देखा जा सकता है. अगर desiredHashLength, supportedHashLengths के अंदर कोई वैल्यू नहीं बताता है, तो क्लाइंट को गड़बड़ी का मैसेज दिखेगा.

खास तौर पर, BatchGetHashListsRequest के लिए क्लाइंट, अलग-अलग सूचियों के लिए अलग-अलग desiredHashLength तय नहीं कर सकते. अगर ऐसा करना ज़रूरी है, तो क्लाइंट को कई BatchGetHashListsRequest में बांट दिया जाना चाहिए.

sizeConstraints

object (SizeConstraints)

हर सूची के साइज़ की सीमाएं. अगर इस एट्रिब्यूट को शामिल नहीं किया जाता है, तो कोई पाबंदी नहीं होती. ध्यान दें कि यहां हर सूची के लिए साइज़ दिखाया गया है, न कि सभी सूचियों के लिए एग्रीगेट किया गया साइज़.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

जवाब में एक से ज़्यादा हैश सूचियां शामिल हैं.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON के काेड में दिखाना
{
  "hashLists": [
    {
      object (HashList)
    }
  ]
}
फ़ील्ड
hashLists[]

object (HashList)

हैश की सूचियां, अनुरोध में दिए गए क्रम में होती हैं.