התחביר של רשימת הדוחות

רשימת דוחות היא קובץ או קטע מקודדים בפורמט JSON במיקום ידוע.

המיקום של רשימת הדוחות

מידע נוסף על שמירת הרשימה הזו זמין במאמר יצירת רשימת דוחות.

תחביר

רשימת ההצהרות או קטע הקוד מורכבים ממערך JSON של הצהרה אחת או יותר של אתר או אפליקציה, כאובייקטים של JSON. ההצהרות האלה יכולות להופיע בכל סדר. התחביר הכללי:

[
  {
    "relation": ["relation_string"],
    "target": {target_object}
  } , ...
]

קשר

מערך של מחרוזת אחת או יותר שמתארות את הקשר המוצהר לגבי היעד. מומלץ לעיין ברשימה של מחרוזות קשר שהוגדרו. לדוגמה: delegate_permission/common.handle_all_urls

יעד

נכס היעד שעליו תחול ההצהרה הזו. סוגי היעדים הזמינים:

• יעד אתר

  "target": {
    "namespace": "web",
    "site": "site_root_url"
  }

  מרחב שמות

  חייב להיות web עבור אתרים.

  אתר

  URI של האתר שהוא היעד של ההצהרה, בפורמט http[s]://<hostname>[:<port>], כאשר <hostname> מלא. יש להשמיט <port> בעת שימוש ביציאה 80 עבור HTTP, או ביציאה 443 עבור HTTPS. יעד של אתר יכול להיות דומיין בסיסי בלבד. לא ניתן להגביל לספריית משנה מסוימת. כל הספריות שמתחת לרמה הזו יהיו זהות. אין להתייחס אל תת-דומיינים בתור תואמים: כלומר, אם קובץ ההצהרה מתארח ב-www.example.com, אין להתייחס אל www.puppies.example.com כאל התאמה. לקבלת דוגמאות וכללים בנושא התאמה של יעדי אתרים, ניתן לעיין במסמכי התיעוד בנושא יעדים. דוגמה: http://www.example.com

• יעד אפליקציה ל-Android

  "target": {
    "namespace": "android_app",
    "package_name": "fully_qualified_package_name",
    "sha256_cert_fingerprints": ["cert_fingerprint"]
  }

  מרחב שמות

  חייבת להיות android_app באפליקציות ל-Android.

  שם_חבילה

  שם החבילה המלא של האפליקציה שעליה חל ההצהרה הזו. לדוגמה: com.google.android.apps.maps

  sha256_cert_fingerprints

  טביעת האצבע SHA265 העליונה של האישור עבור האפליקציה שההצהרה הזו חלה עליה. ניתן לחשב זאת באמצעות openssl או Java keytool כפי שמוצג כאן:

  • openssl x509 -in $CERTFILE -noout -fingerprint -sha256
  • keytool -printcert -file $CERTFILE | grep SHA256

  דוגמה: ["14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5"].

  אם הפעלת את התכונה חתימת אפליקציות ב-Google Play באפליקציה שלך, טביעת האצבע של האישור שנוצרת על ידי הרצת keytool או openssl באופן מקומי לא תואמת בדרך כלל לזו שבמכשירים של המשתמשים. ניתן לבדוק אם השימוש בחתימת אפליקציות ב-Play עבור האפליקציה שלך מתבצע בחשבון המפתח ב-Play Console במסגרת Release > Setup > App Integrity. במקרה כזה, יוצג גם קטע קוד ה-JSON הנכון של קישורים לנכסים דיגיטליים באותו דף.

רשימת הצהרות לדוגמה

לפניכם דוגמה לרשימת הצהרות של אתר שמכילה הצהרות על אתרים וגם על אפליקציות: http://example.digitalassetlinks.org/.well-known/assetlinks.json

הצגת עשרות הצהרות או יותר

במקרים מסוימים, ייתכן שהמנהל ירצה לכתוב הצהרות שונות רבות על יעדים שונים, או שיהיה צורך להנפיק הצהרות מחשבונות משתמשים שונים לאותה קבוצת יעדים. לדוגמה, אתר יכול להיות זמין בדומיינים רבים ושונים בכל מדינה, וכולם ירצו להצהיר על אותה אפליקציה לנייד.

במצבים כאלה, כדאי לכלול הצהרות שיכולות לעזור. באמצעות המנגנון הזה אפשר להגדיר מצביעים מחשבון חשבונות שונים רבים למיקום מרכזי אחד, שמגדיר הצהרות לכל חשבונות המשתמשים.

הערה: מותר לכלול עד 10 הצהרות על עץ ברשימת עץ מלאה. כלומר, המספר המקסימלי של קבצים בעץ הוא: (10 קבצים נכללים בדוח) + (קובץ ההצהרה הבסיסי) = 11 סה"כ.

לדוגמה, אפשר להחליט שהמיקום המרכזי צריך להיות https://example.com/includedstatements.json. אפשר להגדיר בקובץ הזה תוכן זהה לזה שבדוגמאות שלמעלה.

כדי להגדיר מצביע מאתר אינטרנט לקובץ ה-include, צריך לשנות את 'https://example.com/.well-known/assetlinks.json' ל:

[{
  "include": "https://example.com/includedstatements.json"
}]

כדי להגדיר מצביע מאפליקציה ל-Android לקובץ ה-include, צריך לשנות את 'res/values/strings.xml' ל:

<resources>
  ...
  <string name="asset_statements">
    [{
      \"include\": \"https://example.com/includedstatements.json\"
    }]
  </string>
</resources>

מידע נוסף

במסמך המפרט אפשר לקבל הסבר מפורט יותר על הפורמט של רשימת ההצהרות והקונספטים שלהן.