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 的 4 版中,這個值稱為 states;現在已重新命名為 version,以便清楚表示。

Base64 編碼字串。

desiredHashLength
(deprecated)

enum (HashLength)

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

不同的雜湊清單對 desiredHashLength 欄位可接受的值有不同的規定。您可以在 HashListMetadatasupportedHashLengths 欄位中找到這項資訊。如果 desiredHashLength 未在 supportedHashLengths 中指定值,系統會向用戶端傳回錯誤。

具體來說,對於 BatchGetHashListsRequest,用戶端無法為不同的清單指定不同的 desiredHashLength。如果需要這樣做,用戶端應分割成多個 BatchGetHashListsRequest

sizeConstraints

object (SizeConstraints)

每個清單的大小限制。如果省略,則沒有任何限制。請注意,這裡的大小是每個清單的大小,並未匯總所有清單的大小。

要求主體

要求主體必須為空白。

回應主體

回應包含多個雜湊清單。

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

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

object (HashList)

請按照要求中提供的順序列出雜湊清單。