Method: hashLists.batchGet

一度に複数のハッシュリストを取得します。

クライアントが複数のハッシュリストを取得しなければならないことは珍しくありません。通常の Get メソッドを複数回使用するよりも、このメソッドの使用をおすすめします。

これは https://google.aip.dev/231 で定義されている標準のバッチ Get メソッドで、HTTP メソッドも GET です。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

クエリ パラメータ

パラメータ
names[]

string

必須。特定のハッシュリストの名前。リストは、脅威リストであっても構いません。また、グローバル キャッシュでも構いません。名前に重複を含めることはできません。追加すると、クライアントでエラーが発生します。
version[]

string (bytes format)

クライアントがすでに持っているハッシュリストのバージョン。クライアントがハッシュリストを初めて取得する場合は、フィールドを空のままにしておく必要があります。それ以外の場合は、以前にサーバーから受信したバージョンを指定する必要があります。クライアントはそれらのバイトを操作してはなりません。

クライアントは、対応するリスト名と同じ順序でバージョンを送信する必要はありません。クライアントが 1 つのリクエストで送信するバージョンが、名前の数よりも少ない、または多い場合がある。ただし、クライアントは、同じ名前に対応する複数のバージョンを送信してはなりません。存在する場合、クライアントでエラーが発生します。

過去の注意事項: V4 の API では states と呼ばれていました。わかりやすくするため、名前を version に変更しました。

Base64 でエンコードされた文字列。
desiredHashLength

enum (HashLength)

返されたハッシュの望ましいハッシュ接頭辞長（バイト単位）。サーバーは、指定された長さのすべてのハッシュ接頭辞を返します。

ハッシュリストによって、desiredHashLength フィールドに指定できる値の要件は異なります。これは HashListMetadata の supportedHashLengths フィールドにあります。desiredHashLength で supportedHashLengths 内の値が指定されていない場合、クライアントにエラーが返されます。

特に BatchGetHashListsRequest については、クライアントがリストごとに異なる desiredHashLength を指定することはできません。必要がある場合は、クライアントは複数の BatchGetHashListsRequest に分割する必要があります。
sizeConstraints

object (SizeConstraints)

各リストのサイズ制約。省略した場合、制約はありません。ここに表示されるサイズはリストごとのものであり、すべてのリストで集計されたものではありません。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

複数のハッシュリストを含むレスポンス。

成功した場合、レスポンスの本文には次の構造のデータが含まれます。

JSON 表現 
{
  "hashLists": [
    {
      object (HashList)
    }
  ]
}
フィールド
hashLists[]

object (HashList)

ハッシュは、リクエストで指定されたのと同じ順序でリストされます。