Method: hashLists.batchGet

一次取得多份雜湊清單。

用戶端需要取得多個雜湊清單是很常見的情況。最好使用此方法,而非多次使用一般的 Get 方法。

這是由 https://google.aip.dev/231 定義的標準批次 Get 方法,而 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)

雜湊清單的順序與要求中提供的順序相同。