Method assetlinks.check
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Damit wird festgelegt, ob die angegebene (direktionale) Beziehung zwischen den angegebenen Quell- und Ziel-Assets besteht.
Die Beziehung beschreibt die Absicht der Verknüpfung zwischen den beiden Assets, die vom Quell-Asset beansprucht werden. Ein Beispiel für solche Beziehungen ist das Delegieren von Berechtigungen.
Dieser Befehl wird am häufigsten von Infrastruktursystemen verwendet, um die Vorbedingungen für eine Aktion zu prüfen. Beispielsweise möchte ein Kunde möglicherweise wissen, ob es in Ordnung ist, stattdessen eine Web-URL an eine bestimmte mobile App zu senden. Der Kunde kann nach dem relevanten Asset-Link von der Website zur mobilen App suchen und dann entscheiden, ob der Vorgang zulässig ist.
Hinweis zur Sicherheit: Wenn du ein sicheres Asset als Quelle angibst, z. B. eine HTTPS-Website oder eine Android-App, sorgt die API dafür, dass alle Anweisungen, die zum Generieren der Antwort verwendet werden, auf sichere Weise vom Inhaber des Assets vorgenommen wurden. Wenn das Quell-Asset hingegen eine unsichere HTTP-Website ist (d. h. die URL beginnt mit http://
statt mit https://
), kann die API die Anweisungen nicht sicher überprüfen und es kann nicht sichergestellt werden, dass die Angaben der Website nicht von Dritten geändert wurden. Weitere Informationen finden Sie in der technischen Designspezifikation zu Digital Asset Links.
HTTP-Anfrage
GET https://digitalassetlinks.googleapis.com/v1/assetlinks:check
Abfrageparameter
Parametername |
Typ |
Beschreibung |
source |
object(Asset ) |
Die Quelle, die die Anweisungsliste hostet. Hiermit wird der Check() -Aufruf an die richtige Quelle weitergeleitet. |
relation |
string |
Abfragestring für die Beziehung. Wir identifizieren Beziehungen mit Strings im Format <kind>/<detail> , wobei <kind> eine aus einer Reihe vordefinierter Zweckkategorien sein muss und <detail> ein kleingeschriebener alphanumerischer String im freien Format ist, der den spezifischen Anwendungsfall der Anweisung beschreibt. Eine aktuelle Liste der unterstützten Beziehungen finden Sie in unserer API-Dokumentation. Damit eine Abfrage mit einem Asset-Link übereinstimmt, müssen die Beziehungsstrings der Abfrage und des Asset-Links genau übereinstimmen. Beispiel: Eine Abfrage mit der Beziehung delegate_permission/common.handle_all_urls stimmt mit einem Asset-Link mit der Beziehung delegate_permission/common.handle_all_urls überein. |
target |
object(Asset ) |
Das Ziel-Asset des Kontoauszugs. |
Anfragetext
Der Anfragetext muss leer sein.
Antworttext
Wenn der Vorgang erfolgreich ist, enthält der Antworttext Daten mit folgender Struktur:
Antwortnachricht für den CheckAssetLinks-Aufruf.
JSON-Darstellung |
{
"linked": boolean,
"maxAge": string,
"debugString": string,
} |
Feldname |
Typ |
Beschreibung |
linked |
boolean |
Wird auf „true“ gesetzt, wenn die in der Anfrage angegebenen Assets über die in der Anfrage angegebene Beziehung verknüpft sind. ERFORDERLICH |
maxAge |
string |
Ab dem Zeitpunkt der Auslieferung, wie lange die Antwort gültig sein soll, solange keine weiteren Aktualisierungen erfolgen. ERFORDERLICH Dauer in Sekunden mit bis zu neun Nachkommastellen und einem 's ' an letzter Stelle. Beispiel: "3.5s" . |
debugString |
string |
Eine visuell lesbare Nachricht mit Informationen, die Endnutzern helfen sollen, das Ergebnis zu verstehen, zu reproduzieren und zu debuggen. Die Mitteilung wird auf Englisch verfasst und derzeit ist nicht geplant, sie zu übersetzen. Beachten Sie, dass hinsichtlich des Inhalts oder Formats dieses Strings keine Garantien gegeben werden. Alle Teile davon können ohne vorherige Ankündigung geändert werden. Sie sollten nicht versuchen, diese Daten programmatisch zu parsen. Wenn Sie dies Ihrer Meinung nach tun müssen, weil die von Ihnen benötigten Informationen über die API nicht anderweitig offengelegt werden, setzen Sie sich bitte zuerst mit uns in Verbindung. |
Jetzt testen
Rufen Sie diese Methode mit dem APIs Explorer für Live-Daten auf und sehen Sie sich die Antwort an.
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2024-06-26 (UTC).
[null,null,["Zuletzt aktualisiert: 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."]]