Method assetlinks.check
コレクションでコンテンツを整理
必要に応じて、コンテンツの保存と分類を行います。
指定したソース アセットとターゲット アセットの間に、指定された(方向の)関係が存在するかどうかを判別します。
関係は、ソースアセットによって申し立てられている 2 つのアセット間のリンクの意図を表します。このような関係の例として、権限や権限の委任があります。
このコマンドは、インフラストラクチャ システムがアクションの前提条件を確認する際によく使用されます。たとえば、クライアントは、ウェブ URL を特定のモバイルアプリに送信しても問題ないかどうかを知りたい場合があります。クライアントはウェブサイトからモバイルアプリへの関連アセットリンクを確認して、この処理を許可するかどうかを判断できます。
セキュリティに関する注意: HTTPS ウェブサイトや Android アプリなど、安全なアセットをソースとして指定すると、API により、レスポンスの生成に使用されるステートメントが、そのアセットの所有者によって安全な方法で行われたことが確認されます。逆に、ソースアセットが安全でない HTTP ウェブサイト(URL が https://
ではなく http://
で始まる場合)の場合、API はそのステートメントを安全に検証できず、ウェブサイトのステートメントが第三者によって変更されていないことを保証できません。詳しくは、デジタル アセット リンクの技術設計仕様をご覧ください。
HTTP リクエスト
GET https://digitalassetlinks.googleapis.com/v1/assetlinks:check
クエリ パラメータ
パラメータ名 |
タイプ |
説明 |
source |
object(Asset ) |
ステートメント リストをホストするソース。これは、Check() 呼び出しを適切なソースにルーティングするために使用されます。 |
relation |
string |
リレーションのクエリ文字列。 リレーションは <kind>/<detail> という形式の文字列で識別されます。ここで、<kind> は定義済みの目的カテゴリのセットのいずれかである必要があります。<detail> は、ステートメントの特定のユースケースを表す自由形式の小文字の英数字の文字列です。 サポートされているリレーションの最新リストについては、Google の API ドキュメントをご覧ください。 クエリがアセットリンクと一致するには、クエリとアセットリンクのリレーション文字列の両方が正確に一致する必要があります。 例: リレーションが delegate_permission/common.handle_all_urls のクエリは、リレーションが delegate_permission/common.handle_all_urls のアセットリンクと一致します。 |
target |
object(Asset ) |
ステートメントのターゲット アセット。 |
リクエスト本文
リクエストの本文は空にする必要があります。
レスポンスの本文
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
CheckAssetLinks 呼び出しに対するレスポンス メッセージ。
JSON 表現 |
{
"linked": boolean,
"maxAge": string,
"debugString": string,
} |
フィールド名 |
タイプ |
説明 |
linked |
boolean |
リクエストで指定されたアセットが、リクエストで指定されたリレーションによってリンクされている場合は true に設定します。REQUIRED |
maxAge |
string |
サービング時刻から、更新を行わない限り、レスポンスが有効とみなされるまでの時間。REQUIRED 小数点以下 9 桁まで、「s 」で終わる秒単位の期間(例: "3.5s" )。 |
debugString |
string |
エンドユーザーが結果を理解、再現、デバッグするのに役立つ情報を含む、人が読める形式のメッセージ。 メッセージは英語で表示され、現時点では翻訳の提供は予定しておりません。 この文字列の内容や形式が保証されるわけではありません。本コンテンツのあらゆる側面は、予告なく変更される場合があります。このデータをプログラムで解析しないでください。必要な情報が API によって公開されないために、この操作が必要だと思われる場合は、まず Google までご連絡ください。 |
試してみよう:
API Explorer を使用して、ライブデータに対してこのメソッドを呼び出し、レスポンスを確認してください。
特に記載のない限り、このページのコンテンツはクリエイティブ・コモンズの表示 4.0 ライセンスにより使用許諾されます。コードサンプルは Apache 2.0 ライセンスにより使用許諾されます。詳しくは、Google Developers サイトのポリシーをご覧ください。Java は Oracle および関連会社の登録商標です。
最終更新日 2024-06-26 UTC。
[null,null,["最終更新日 2024-06-26 UTC。"],[[["\u003cp\u003eVerifies the existence of a relationship between two digital assets, like websites and apps.\u003c/p\u003e\n"],["\u003cp\u003eUses the \u003ccode\u003eGET\u003c/code\u003e method with query parameters specifying the source, relation, and target assets.\u003c/p\u003e\n"],["\u003cp\u003eReturns a JSON response indicating if the assets are linked and provides additional debugging information.\u003c/p\u003e\n"],["\u003cp\u003ePrimarily used for security checks and ensuring the integrity of relationships between assets.\u003c/p\u003e\n"],["\u003cp\u003eOffers enhanced security when the source asset is secure (HTTPS or Android app).\u003c/p\u003e\n"]]],[],null,["# Method assetlinks.check\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.CheckResponse.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\nDetermines whether the specified (directional) relationship exists between the specified source and target assets.\n\nThe relation describes the intent of the link between the two assets as claimed by the source asset. An example for such relationships is the delegation of privileges or permissions.\n\nThis command is most often used by infrastructure systems to check preconditions for an action. For example, a client may want to know if it is OK to send a web URL to a particular mobile app instead. The client can check for the relevant asset link from the website to the mobile app to decide if the operation should be allowed.\n\nA note about security: if you specify a secure asset as the source, such as an HTTPS website or an Android app, the API will ensure that any statements used to generate the response have been made in a secure way by the owner of that asset. Conversely, if the source asset is an insecure HTTP website (that is, the URL starts with `http://` instead of `https://`), the API cannot verify its statements securely, and it is not possible to ensure that the website's statements have not been altered by a third party. For more information, see the [Digital Asset Links technical design specification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md).\n\n### HTTP request\n\n`GET https://digitalassetlinks.googleapis.com/v1/assetlinks:check`\n\n### Query parameters\n\n| Parameter name | Type | Description |\n|----------------|-------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `source` | `object(`[Asset](/digital-asset-links/reference/rest/v1/Asset)`)` | The source hosting the statement list. This is used to route the `Check()` call to the proper source. |\n| `relation` | `string` | Query string for the relation. We identify relations with strings of the format `\u003ckind\u003e/\u003cdetail\u003e`, where `\u003ckind\u003e` must be one of a set of pre-defined purpose categories, and `\u003cdetail\u003e` is a free-form lowercase alphanumeric string that describes the specific use case of the statement. Refer to [our API documentation](/digital-asset-links/v1/relation-strings) for the current list of supported relations. For a query to match an asset link, both the query's and the asset link's relation strings must match exactly. Example: A query with relation `delegate_permission/common.handle_all_urls` matches an asset link with relation `delegate_permission/common.handle_all_urls`. |\n| `target` | `object(`[Asset](/digital-asset-links/reference/rest/v1/Asset)`)` | The target asset of the statement. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse message for the CheckAssetLinks call.\n\n| JSON representation |\n|-------------------------------------------------------------------------|\n| ``` { \"linked\": boolean, \"maxAge\": string, \"debugString\": string, } ``` |\n\n| Field name | Type | Description |\n|---------------|-----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `linked` | `boolean` | Set to true if the assets specified in the request are linked by the relation specified in the request. REQUIRED |\n| `maxAge` | `string` | From serving time, how much longer the response should be considered valid barring further updates. REQUIRED A duration in seconds with up to nine fractional digits, terminated by '`s`'. Example: `\"3.5s\"`. |\n| `debugString` | `string` | Human-readable message containing information intended to help end users understand, reproduce and debug the result. The message will be in English and we are currently not planning to offer any translations. Please note that no guarantees are made about the contents or format of this string. Any aspect of it may be subject to change without notice. You should not attempt to programmatically parse this data. If you feel that you need to do this because the information you need is not otherwise exposed by the API, please contact us first. |\n\nTry it!\n-------\n\nUse the [APIs Explorer](https://developers.google.com/apis-explorer/?discovery_url=/digital-asset-links/v1/discoverydocument.json#p/digitalassetlinks/v1/digitalassetlinks.assetlinks.check?relation=delegate_permission%252Fcommon.handle_all_urls&source.web.site=https%253A%252F%252Fexample.digitalassetlinks.org&target.androidApp.certificate.sha256Fingerprint=10%253A39%253A38%253AEE%253A45%253A37%253AE5%253A9E%253A8E%253AE7%253A92%253AF6%253A54%253A50%253A4F%253AB8%253A34%253A6F%253AC6%253AB3%253A46%253AD0%253ABB%253AC4%253A41%253A5F%253AC3%253A39%253AFC%253AFC%253A8E%253AC1&target.androidApp.packageName=org.digitalassetlinks.sampleapp) to call this method on live data and see the response."]]