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)

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

クライアントは、対応するリスト名と同じ順序でバージョンを送信する必要はありません。クライアントは、リクエストで名前の数よりも少ないバージョンまたは多いバージョンを送信できます。ただし、同じ名前に対応する複数のバージョンをクライアントが送信することはできません。送信すると、クライアントにエラーが返されます。

歴史的な注記: API の 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)

リクエストされた順序と同じ順序のハッシュリスト。