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 つのリクエストで送信するバージョンの名前の数より少ない、または多い場合があります。ただし、クライアントは、同じ名前に対応する複数のバージョンを送信してはなりません。送信した場合、クライアントはエラーを受け取ります。

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

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

desiredHashLength

enum (HashLength)

返されたハッシュの望ましいハッシュ プレフィックス長(バイト単位)。サーバーは、指定された長さのすべてのハッシュ接頭辞を返します。

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

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

sizeConstraints

object (SizeConstraints)

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

リクエスト本文

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

レスポンスの本文

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

成功すると、レスポンスの本文に次の構造のデータが含まれます。

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

object (HashList)

ハッシュは、リクエストで指定された順序で表示されます。