Method statements.list

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

ה-API מבטיח שכל הבעלים של הנכסים האלה יבטיחו באופן מאובטח את כל ההצהרות עם נכסי מקור מאובטחים, כמו אתרים מסוג HTTPS או אפליקציות ל-Android, כפי שמתואר במפרט העיצוב הטכני של קישורים לנכסים דיגיטליים. חשוב במיוחד לשים לב שעבור אתרים לא מאובטחים (כלומר, כאשר כתובת האתר מתחילה ב-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 נדרש
target object(Asset) לכל דוח יש נכס יעד. חובה

רוצה לנסות?

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