Method assetlinks.check
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
המדיניות הזו קובעת אם קיים קשר (הכיווני) שצוין בין נכסי המקור ונכסי היעד שצוינו.
הקשר מתאר את כוונת הקישור בין שני הנכסים כפי שנכס המקור טען לגביהם. דוגמה ליחסים כאלה היא הענקת הרשאות או הרשאות.
בדרך כלל משתמשים בפקודה הזו במערכות תשתית כדי לבדוק את התנאים המוקדמים של פעולה. לדוגמה, ייתכן שלקוח ירצה לדעת אם אפשר לשלוח כתובת URL של אתר לאפליקציה מסוימת לנייד במקום זאת. הלקוח יכול לחפש את הקישור של הנכס הרלוונטי מהאתר לאפליקציה לנייד כדי להחליט אם לאפשר את הפעולה.
הערה בנושא אבטחה: אם מציינים נכס מאובטח כמקור, כמו אתר HTTPS או אפליקציה ל-Android, ה-API יבטיח שכל ההצהרות ששימשו ליצירת התשובה נכתבו באופן מאובטח על ידי הבעלים של הנכס. לעומת זאת, אם נכס המקור הוא אתר HTTP לא מאובטח (כלומר, כתובת ה-URL מתחילה ב-http:// במקום ב-https://), ה-API לא יכול לאמת את ההצהרות שלו באופן מאובטח, ואי אפשר לוודא שהצהרות האתר לא שונו על ידי צד שלישי. מידע נוסף זמין במפרט העיצוב הטכני של קישורים לנכסים דיגיטליים.
בקשת HTTP
GET https://digitalassetlinks.googleapis.com/v1/assetlinks:check
פרמטרים של שאילתה
| שם הפרמטר |
סוג |
תיאור |
source |
object(Asset) |
המקור שמארח את רשימת ההצהרות. הפעולה הזו משמשת לניתוב של הקריאה Check() למקור הנכון. |
relation |
string |
מחרוזת שאילתה של הקשר. אנחנו מזהים קשרים עם מחרוזות בפורמט <kind>/<detail>, כאשר <kind> חייב להיות אחת מקבוצה של קטגוריות מטרות מוגדרות מראש, ו-<detail> היא מחרוזת אלפאנומרית קטנה שמתארת את התרחיש הספציפי של ההצהרה. ברשימה הנוכחית של הקשרים הנתמכים אפשר לעיין במסמכי התיעוד של ה-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 אם הנכסים שצוינו בבקשה מקושרים באמצעות הקשר שצוין בבקשה. חובה |
maxAge |
string |
מרגע הצגת הבקשה, משך הזמן שבו התגובה צריכה להיחשב כחוקית, ולכן אי אפשר לבצע עדכונים נוספים. חובה משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-'s'. דוגמה: "3.5s". |
debugString |
string |
הודעה קריא לאנשים, שמכילה מידע שנועד לעזור למשתמשי הקצה להבין את התוצאה, לשחזר אותה ולנפות באגים. ההודעה תהיה באנגלית ובשלב הזה אנחנו לא מתכננים להציע תרגומים. לתשומת ליבכם, אין כל ערובה לגבי התוכן או הפורמט של המחרוזת הזו. כל היבט עשוי להשתנות ללא הודעה מוקדמת. מומלץ לא לנסות לנתח את הנתונים האלה באופן פרוגרמטי. אם לדעתך עליך לעשות זאת מפני שהמידע הדרוש לך לא נחשף בדרך אחרת על ידי ה-API, ראשית צור אתנו קשר. |
רוצה לנסות?
משתמשים ב-APIs Explorer כדי להפעיל את השיטה הזו בנתונים פעילים ולראות את התגובה.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 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."]]
