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 כדי להפעיל את השיטה הזו בנתונים פעילים ולראות את התגובה.