Method statements.list

指定したターゲットとステートメントの文字列に一致する、指定したソースからすべてのステートメントのリストを取得します。

この API は、デジタル アセット リンクの技術仕様に記載されているように、安全なソースアセット(HTTPS ウェブサイトやアプリなど)に関するすべてのステートメントが、それらのアセットの所有者によって安全な方法で作成されていることが保証されます。特に、安全でないウェブサイト(URL が https:// ではなく http:// で始まるウェブサイト)では、このような保証はできないことにご注意ください。

List コマンドは、API クライアントが 2 つのアセットの関係性をすべて把握する場合や、特定のソースアセットからすべての関係を列挙する場合に特に便利です。例: ユーザーが関連アイテムに移動できるようにする機能。この機能により、デバイス上でモバイルアプリを実行しているときに、対応するウェブサイトまたは Google+ プロフィールに簡単にアクセスできるようになります。

HTTP リクエスト

GET https://digitalassetlinks.googleapis.com/v1/statements:list

クエリ パラメータ

パラメータ名 タイプ 説明
source object(Asset) ステートメント リストをホストするソース。これは、List() リクエストを適切なソースに転送するために使用されます。REQUIRED
relation string

指定した関係に一致する関連付けのみを使用します。

リレーション文字列の詳細な定義については、Statement メッセージをご覧ください。

クエリがステートメントと一致するには、次のいずれかに該当する必要があります。

  • クエリとステートメントのリレーション文字列の両方が完全一致する。または
  • クエリの関係文字列が空であるか、存在しません。

例: リレーションが delegate_permission/common.handle_all_urls のクエリは、リレーションが delegate_permission/common.handle_all_urls のアセットリンクと一致します。

リクエスト本文

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

レスポンスの本文

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

List 呼び出しに対するレスポンス メッセージ。

JSON 表現
{
  "statements": [
    {
      object(Statement)
    }
  ],
  "maxAge": string,
  "debugString": string,
}
フィールド名 タイプ 説明
statements[] object(Statement) 見つかったすべての一致するステートメントのリスト。
maxAge string

サービング時刻から、更新を行わない限り、レスポンスが有効とみなされるまでの時間。REQUIRED

小数点以下 9 桁まで、「s」で終わる秒単位の期間(例: "3.5s")。

debugString string

エンドユーザーが結果を理解、再現、デバッグするのに役立つ情報を含む、人が読める形式のメッセージ。

メッセージは英語で表示され、現時点では翻訳の提供は予定しておりません。

この文字列の内容や形式が保証されるわけではありません。本コンテンツのあらゆる側面は、予告なく変更される場合があります。このデータをプログラムで解析しないでください。必要な情報が API によって公開されないために、この操作が必要だと思われる場合は、まず Google までご連絡ください。

説明

ソースアセットとターゲット アセットの関係について、信頼できる記述を記述する。

ステートメントは常にソースアセットによって、直接、または他の場所に保存されているステートメント リストに委任することによって作成されます。

ステートメントとアセットの定義について詳しくは、API ドキュメントのランディング ページをご覧ください。

JSON 表現
{
  "source": {
    object(Asset)
  },
  "relation": string,
  "target": {
    object(Asset)
  },
}
フィールド名 タイプ 説明
source object(Asset) すべてのステートメントにはソースアセットがあります。REQUIRED
relation string

この関係により、ソースアセットの所有者(つまり、ステートメントを発行した個人またはエンティティ)の意図したステートメントの使用が識別されます。完全なステートメントには、それぞれ関係があります。

リレーションは <kind>/<detail> という形式の文字列で識別されます。ここで、<kind> は定義済みの目的カテゴリのセットのいずれかである必要があります。<detail> は、ステートメントの特定のユースケースを表す自由形式の小文字の英数字の文字列です。

サポートされているリレーションの最新リストについては、Google の API ドキュメントをご覧ください。

例: delegate_permission/common.handle_all_urls 必須

target object(Asset) すべてのステートメントにはターゲット アセットがあります。REQUIRED

試してみよう:

API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。