Method assetlinks.check
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Determina si existe la relación especificada (direccional) entre los recursos de origen y de destino especificados.
La relación describe la intención del vínculo entre los dos activos según lo reclamado por el activo de origen. Un ejemplo de estas relaciones es la delegación de privilegios o permisos.
Los sistemas de infraestructura usan este comando con mayor frecuencia para verificar las condiciones previas de una acción. Por ejemplo, es posible que un cliente quiera saber si puede enviar una URL web a una determinada aplicación para dispositivos móviles en su lugar. El cliente puede buscar el vínculo del recurso relevante desde el sitio web hasta la aplicación para dispositivos móviles para decidir si se debe permitir la operación.
Nota sobre la seguridad: Si especificas un recurso seguro como la fuente, por ejemplo, un sitio web HTTPS o una app para Android, la API se asegurará de que el propietario de ese recurso haya realizado de manera segura las declaraciones que se usen para generar la respuesta. Por el contrario, si el recurso de origen es un sitio web HTTP no seguro (es decir, si la URL comienza con http:// en lugar de https://), la API no puede verificar sus sentencias de forma segura y no es posible garantizar que ningún tercero haya alterado las declaraciones del sitio web. Para obtener más información, consulta la especificación de diseño técnico de Vínculos de recursos digitales.
Solicitud HTTP
GET https://digitalassetlinks.googleapis.com/v1/assetlinks:check
Parámetros de consulta
| Nombre del parámetro |
Tipo |
Descripción |
source |
object(Asset) |
La fuente que aloja la lista de declaraciones. Se usa para enrutar la llamada a Check() a la fuente correcta. |
relation |
string |
Cadena de consulta para la relación. Identificamos relaciones con cadenas del formato <kind>/<detail>, en las que <kind> debe ser una de un conjunto de categorías de propósito predefinidas, y <detail> es una cadena alfanumérica en minúscula de formato libre que describe el caso de uso específico de la instrucción. Consulta nuestra documentación de la API para ver la lista actual de relaciones admitidas. Para que una consulta coincida con el vínculo de un elemento, las cadenas de relación de la consulta y del vínculo del elemento deben coincidir exactamente. Ejemplo: Una consulta con la relación delegate_permission/common.handle_all_urls coincide con un vínculo de elementos con la relación delegate_permission/common.handle_all_urls. |
target |
object(Asset) |
Es el recurso objetivo del estado. |
Cuerpo de la solicitud
El cuerpo de la solicitud debe estar vacío.
Cuerpo de la respuesta
Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:
Mensaje de respuesta para la llamada a CheckAssetLinks.
| Representación JSON |
{
"linked": boolean,
"maxAge": string,
"debugString": string,
} |
| Nombre del campo |
Tipo |
Descripción |
linked |
boolean |
Se establece como verdadero si los activos especificados en la solicitud están vinculados mediante la relación especificada en la solicitud. REQUIRED |
maxAge |
string |
A partir del tiempo de publicación, indica durante cuánto tiempo la respuesta debe considerarse válida, excepto las actualizaciones adicionales. REQUIRED Es una duración en segundos con hasta nueve dígitos fraccionarios que termina en "s". Ejemplo: "3.5s". |
debugString |
string |
Mensaje legible por humanos que contiene información destinada a ayudar a los usuarios finales a comprender, reproducir y depurar el resultado. El mensaje se mostrará en inglés y, por el momento, no planeamos ofrecer ninguna traducción. Ten en cuenta que no se garantiza el contenido ni el formato de esta cadena. Cualquier aspecto del documento puede estar sujeto a cambios sin previo aviso. No debes intentar analizar estos datos de forma programática. Si consideras que debes hacerlo porque la API no expone de otra manera la información que necesitas, primero comunícate con nosotros. |
Pruébalo
Utiliza el Explorador de APIs para llamar a este método con datos en tiempo real y ver la respuesta.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2024-06-26 (UTC)
[null,null,["Última actualización: 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."]]
