Method statements.list

從指定來源,擷取符合指定目標和陳述式字串的所有陳述式清單。

根據《Digital Asset Links 技術設計規格》的規定,API 可確保所有含有安全來源資產 (例如 HTTPS 網站或 Android 應用程式) 的聲明都以安全的方式產生,請特別注意,如果是不安全的網站 (也就是網址開頭是 http:// 而非 https://),就無法保證這些資訊。

如果 API 用戶端想要瞭解兩個資產間的關係,或列舉特定來源資產的所有關係,List 指令就能派上用場。範例:可協助使用者前往相關項目的功能。在裝置上執行行動應用程式時,您可透過這項功能輕鬆前往相對應的網站或 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

從放送時間算起,回應需要多長的時間才能視為有效處理後,將繼續維持有效的更新時間。必填

時間長度以秒為單位,最多可有 9 個小數位數,並應以「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 針對即時資料呼叫這個方法,並查看回應。