Method statements.list

从给定来源检索与指定目标和语句字符串匹配的所有语句的列表。

该 API 可保证包含安全源资产(例如 HTTPS 网站或 Android 应用)的所有声明都是由这些资产的所有者以安全的方式做出,如 Digital Asset Links 技术设计规范中所述。具体来说,对于不安全网站(即网址以 http:// 而非 https:// 开头),Google 无法做出此保证。

当 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 的资产链接匹配。

请求正文

请求正文必须为空。

响应正文

如果成功,响应正文将包含结构如下的数据:

List 调用的响应消息。

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) 每条语句都有一个目标素材资源。必填

试试看!

使用 API Explorer 针对实际数据调用此方法并查看响应。