Method assetlinks.check
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Determina se a relação (direcional) especificada existe entre os recursos de origem e destino especificados.
A relação descreve a intenção do vínculo entre os dois recursos, conforme reivindicado pelo recurso de origem. Um exemplo dessas relações é a delegação de privilégios ou permissões.
Esse comando é mais usado por sistemas de infraestrutura para verificar as condições prévias de uma ação. Por exemplo, um cliente pode querer saber se é possível enviar um URL da Web para um determinado aplicativo para dispositivos móveis. O cliente pode verificar o link de recurso relevante do site para o app para dispositivos móveis e decidir se a operação é permitida.
Observação sobre segurança: se você especificar um recurso seguro como a origem, como um site HTTPS ou um app Android, a API vai garantir que as instruções usadas para gerar a resposta tenham sido feitas de maneira segura pelo proprietário desse recurso. Por outro lado, se o recurso de origem for um site HTTP não seguro (ou seja, o URL começar com http:// em vez de https://), a API não poderá verificar as instruções com segurança e não será possível garantir que as instruções do site não tenham sido alteradas por terceiros. Para mais informações, consulte a especificação do design técnico do Digital Asset Links.
Solicitação HTTP
GET https://digitalassetlinks.googleapis.com/v1/assetlinks:check
Parâmetros de consulta
| Nome do parâmetro |
Tipo |
Descrição |
source |
object(Asset) |
Fonte que hospeda a lista de instruções. Isso é usado para rotear a chamada Check() para a origem adequada. |
relation |
string |
String de consulta da relação. Identificamos relações com strings do formato <kind>/<detail>, em que <kind> precisa ser um de um conjunto de categorias de finalidade predefinidas, e <detail> é uma string alfanumérica em letras minúsculas de formato livre que descreve o caso de uso específico da instrução. Consulte a documentação da API para a lista atual de relações compatíveis. Para que uma consulta corresponda a um link de recurso, as strings de relação da consulta e do link do recurso devem corresponder exatamente. Exemplo: uma consulta com relação delegate_permission/common.handle_all_urls corresponde a um link de recurso com a relação delegate_permission/common.handle_all_urls. |
target |
object(Asset) |
O recurso de destino da instrução. |
Corpo da solicitação
O corpo da solicitação precisa estar vazio.
Corpo da resposta
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Mensagem de resposta para a chamada de CheckAssetLinks.
| Representação JSON |
{
"linked": boolean,
"maxAge": string,
"debugString": string,
} |
| Nome do campo |
Tipo |
Descrição |
linked |
boolean |
Defina como verdadeiro se os recursos especificados na solicitação estiverem vinculados pela relação definida nela. REQUIRED |
maxAge |
string |
A partir do momento da veiculação, o tempo de espera da resposta deve ser considerada válida, exceto no caso de futuras atualizações. REQUIRED Uma duração em segundos com até nove dígitos fracionários, encerrada por "s". Exemplo: "3.5s". |
debugString |
string |
Mensagem legível por humanos contendo informações destinadas a ajudar os usuários finais a entender, reproduzir e depurar o resultado. A mensagem será em inglês e não planejamos oferecer traduções no momento. Nenhuma garantia é feita em relação ao conteúdo ou formato dessa string. Qualquer aspecto dele pode estar sujeito a alterações sem aviso prévio. Não tente analisar esses dados de forma programática. Se você acha que precisa fazer isso porque as informações necessárias não estão sendo expostas pela API, entre em contato primeiro. |
Confira!
Use o APIs Explorer para chamar esse método em dados em tempo real e ver a resposta.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2024-06-26 UTC.
[null,null,["Última atualização 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."]]
