Method statements.list

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

该 API 可保证所有具有安全来源素材资源(例如 HTTPS 网站或 Android 应用)的声明都由这些素材资源的所有者以安全的方式完成,如 Digital Asset Links 技术设计规范中所述。具体来说,您应该考虑到,对于不安全的网站(即,网址以 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 的素材资源链接匹配。

请求正文

请求正文必须为空。

响应正文

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

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 针对实际数据调用此方法,然后查看响应。