Method statements.list

מאחזרת רשימה של כל ההצהרות ממקור נתון שתואמות למחרוזת היעד וההצהרה שצוינו.

ה-API מבטיח שכל ההצהרות עם נכסי מקור מאובטחים, כמו אתרי HTTPS או אפליקציות ל-Android, בוצעו באופן מאובטח על ידי הבעלים של הנכסים האלה, כפי שמתואר במפרט העיצוב הטכני של Digital Asset Links. באופן ספציפי, כדאי לזכור שעבור אתרים לא מאובטחים (כלומר, שבהם כתובת ה-URL מתחילה ב-http:// במקום ב-https://), לא ניתן לבצע התחייבות זו.

הפקודה List שימושית במיוחד במקרים שבהם לקוח ה-API רוצה לדעת את כל הדרכים שבהן שני נכסים קשורים זה לזה, או למנות את כל קשרי הגומלין מנכס מקור מסוים. דוגמה: תכונה שעוזרת למשתמשים לנווט לפריטים קשורים. כשאפליקציה לנייד פועלת במכשיר, התכונה הזו מאפשרת לנווט בקלות לאתר האינטרנט או לפרופיל Google+ המקביל.

בקשת HTTP

GET https://digitalassetlinks.googleapis.com/v1/statements:list

פרמטרים של שאילתה

שם הפרמטר סוג תיאור
source object(Asset) המקור שמארח את רשימת ההצהרות. הוא משמש להפניית הבקשה List() למקור הנכון. חובה
relation string

השתמשו רק בשיוכים שתואמים ליחס שצוין.

עיינו בהודעה Statement כדי לקבל הגדרה מפורטת של מחרוזות קשר.

כדי ששאילתה תתאים להצהרה, צריך להתקיים אחד מהתנאים הבאים:

  • גם מחרוזות הקשר של השאילתה וגם מחרוזות היחסים של ההצהרה תואמות בדיוק, או
  • מחרוזת הקשר של השאילתה ריקה או חסרה.

דוגמה: שאילתה עם קשר delegate_permission/common.handle_all_urls תואמת לקישור נכס עם קשר delegate_permission/common.handle_all_urls.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

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

ייצוג JSON 
{
  "statements": [
    {
      object(Statement)
    }
  ],
  "maxAge": string,
  "debugString": string,
}
שם השדה סוג תיאור
statements[] object(Statement) רשימה של כל ההצהרות התואמות שנמצאו.
maxAge string

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

משך זמן בשניות עם עד תשע ספרות עשרוניות, שמסתיים ב-'s'. דוגמה: "3.5s".
debugString string

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

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

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

ההתבטאות

מיועד לתיאור הצהרה אמינה שנוצרה בנוגע לקשר בין נכס מקור לנכס יעד.

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

הגדרות מפורטות יותר של דפי חשבון ונכסים זמינות בדף הנחיתה של תיעוד ה-API.

ייצוג JSON 
{
  "source": {
    object(Asset)
  },
  "relation": string,
  "target": {
    object(Asset)
  },
}
שם השדה סוג תיאור
source object(Asset) לכל הצהרה יש נכס מקור. חובה
relation string

הקשר מזהה את השימוש בהצהרה כפי שהתכוונתם על ידי הבעלים של נכס המקור (כלומר, האדם או הישות שפרסמו את ההצהרה). לכל הצהרה מלאה יש קשר.

אנחנו מזהים קשרים עם מחרוזות בפורמט <kind>/<detail>, כאשר <kind> חייב להיות אחת מקבוצה של קטגוריות מטרות מוגדרות מראש, ו-<detail> היא מחרוזת אלפאנומרית קטנה שמתארת את התרחיש הספציפי של ההצהרה.

ברשימה הנוכחית של הקשרים הנתמכים אפשר לעיין במסמכי התיעוד של ה-API.

דוגמה: delegate_permission/common.handle_all_urls REQUIRED
target object(Asset) לכל הצהרה יש נכס יעד. חובה

רוצה לנסות?

משתמשים ב-APIs Explorer כדי להפעיל את השיטה הזו בנתונים פעילים ולראות את התגובה.