Method: hashLists.batchGet

一次取得多份雜湊清單。

客戶經常需要取得多份雜湊清單,相較於使用一般的 Get 方法,我們較建議採用此方法多次。

這是標準批次 Get 方法 (由 https://google.aip.dev/231 定義),且 HTTP 方法也是 GET。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

查詢參數

參數
names[]

string

必要欄位。特定雜湊清單的名稱。該清單「可能」為威脅清單,或可能是「全域快取」。名稱「不得」包含重複項目;如果名稱重複,用戶端就會收到錯誤訊息。

version[]

string (bytes format)

用戶端現有的雜湊清單版本。如果這是用戶端首次擷取雜湊清單,該欄位應留空。否則,用戶端應提供先前從伺服器接收的版本。用戶端「不得」操控這些位元組。

用戶端不需要依照對應清單名稱的順序傳送版本。用戶端所傳送的要求中可能少於或更多的版本。然而,用戶端「不得」傳送多個名稱相同的版本;如果包含相同名稱,用戶端就會收到錯誤訊息。

記錄附註:在 API 的 V4 中,這個項目稱為 states,為清楚起見,現在改名為 version

Base64 編碼的字串。

desiredHashLength

enum (HashLength)

傳回雜湊的所需雜湊前置字元長度 (以位元組為單位)。伺服器就會傳回符合指定長度的所有雜湊前置字串。

各種雜湊清單對 desiredHashLength 欄位可接受的值設有不同的規定。您可以在 HashListMetadatasupportedHashLengths 欄位找到這項資訊。如果 desiredHashLength 沒有在 supportedHashLengths 內指定值,用戶端就會傳回錯誤。

特別是 BatchGetHashListsRequest,用戶端無法為不同清單指定不同的 desiredHashLength。如果需要執行這項操作,用戶端應分割成多個 BatchGetHashListsRequest

sizeConstraints

object (SizeConstraints)

每份清單的大小限制。如果省略,就不會有限制。請注意,這裡顯示的尺寸是單一清單,並未匯總所有清單的資料。

要求主體

要求主體必須為空白。

回應主體

包含多份雜湊清單的回應。

如果成功,回應主體即會包含具有以下結構的資料:

JSON 表示法
{
  "hashLists": [
    {
      object (HashList)
    }
  ]
}
欄位
hashLists[]

object (HashList)

雜湊清單的順序與要求中的指定順序相同。