Method assetlinks.check
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Détermine si la relation (directive) spécifiée existe entre les éléments source et cible spécifiés.
La relation décrit l'objectif du lien entre les deux éléments tels qu'ils sont revendiqués par l'élément source. La délégation de privilèges ou d'autorisations est un exemple de ce type de relations.
Cette commande est le plus souvent utilisée par les systèmes d’infrastructure pour vérifier les conditions préalables d’une action. Par exemple, un client peut vouloir savoir s'il peut envoyer une URL Web à une application mobile donnée à la place. Le client peut vérifier si le lien vers l'asset est pertinent entre le site Web et l'application mobile afin de décider si l'opération doit être autorisée.
Remarque concernant la sécurité: Si vous spécifiez un élément sécurisé comme source, comme un site Web HTTPS ou une application Android, l'API s'assure que toutes les instructions utilisées pour générer la réponse ont été effectuées de manière sécurisée par le propriétaire de cet élément. À l'inverse, si l'élément source est un site Web HTTP non sécurisé (c'est-à-dire que l'URL commence par http://
au lieu de https://
), l'API ne peut pas vérifier ses instructions de manière sécurisée, et il est impossible de vérifier qu'elles n'ont pas été modifiées par un tiers. Pour en savoir plus, consultez les spécifications de conception technique de Digital Asset Links.
Requête HTTP
GET https://digitalassetlinks.googleapis.com/v1/assetlinks:check
Paramètres de requête
Nom du paramètre |
Type |
Description |
source |
object(Asset ) |
Source hébergeant la liste des instructions. Cela permet d'acheminer l'appel Check() vers la source appropriée. |
relation |
string |
Chaîne de requête pour la relation. Nous identifions les relations avec des chaînes au format <kind>/<detail> , où <kind> doit faire partie d'un ensemble de catégories de finalité prédéfinies, et <detail> est une chaîne alphanumérique minuscule de forme libre qui décrit le cas d'utilisation spécifique de l'instruction. Reportez-vous à la documentation de l'API pour obtenir la liste actuelle des relations acceptées. Pour qu'une requête corresponde à un lien d'élément, les chaînes de relation de la requête et du lien de l'élément doivent correspondre exactement. Exemple: une requête avec la relation delegate_permission/common.handle_all_urls correspond à un lien d'élément avec la relation delegate_permission/common.handle_all_urls . |
target |
object(Asset ) |
Composant cible de l'instruction. |
Corps de la requête
Le corps de la requête doit être vide.
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Message de réponse à l'appel CheckAssetLinks.
Représentation JSON |
{
"linked": boolean,
"maxAge": string,
"debugString": string,
} |
fieldName |
Type |
Description |
linked |
boolean |
Défini sur "true" si les éléments spécifiés dans la demande sont associés par la relation spécifiée dans celle-ci. REQUIRED |
maxAge |
string |
À partir de la date de diffusion, délai pendant lequel la réponse doit être considérée comme valide, sauf si d'autres mises à jour sont disponibles. REQUIRED Durée en secondes avec neuf chiffres au maximum après la virgule. Se termine par "s ". Example : "3.5s" . |
debugString |
string |
Message lisible par l'humain contenant des informations destinées à aider les utilisateurs finaux à comprendre, à reproduire et à déboguer le résultat. Le message sera en anglais et nous ne prévoyons pas de proposer de traduction pour le moment. Notez qu'aucune garantie n'est faite quant au contenu ou au format de cette chaîne. Tout aspect du contenu est susceptible d'être modifié sans préavis. N'essayez pas d'analyser ces données de manière programmatique. Si vous pensez avoir besoin de le faire parce que les informations dont vous avez besoin ne sont pas divulguées par l'API, veuillez d'abord nous contacter. |
Essayer
Utilisez l'explorateur d'API pour appeler cette méthode sur des données actives et obtenir la réponse.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2024/06/26 (UTC).
[null,null,["Dernière mise à jour le 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."]]