使用资产标签

注意:YouTube Content ID API 专供 YouTube 内容合作伙伴使用,并非所有开发者或所有 YouTube 用户都可以使用。如果您在 Google API 控制台中没有看到 YouTube Content ID API 作为一项服务,请访问 YouTube 帮助中心,详细了解 YouTube 合作伙伴计划。

资产标签可帮助您按自定义类别整理资产,让您能更方便地整理资产库。您可以根据标签搜索资产,这还可以简化要求您更新特定资产组的用例。

本指南介绍了如何使用 YouTube Content ID API 执行一些与标签相关的常见功能。本指南中的几个部分包含一些示例,这些示例链接到并填充了 Google API Explorer,使您能够测试每个查询。

创建资产标签

该 API 支持两种创建资产标签的方法:

  • 调用 assetLabels.insert 方法。请求的正文是 assetLabel 资源,其中 labelName 属性指定了新标签的唯一名称。如果已存在具有相同名称的标签,API 会返回 409 (Conflict) HTTP 响应代码。

    以下查询会调用 assetLabels.insert 方法来创建名为 Explorer Test 的新标签。示例请求的正文为:

    {
      "labelName": "Explorer Test"
    }

    请求未设置任何查询参数。但是,如果您的 Google 账号与多个内容所有者账号关联,那么您还必须为 onBehalfOfContentOwner 参数设置一个值。

    [no parameters set]
  • 调用 assets.update 方法以更新资产的标签。在请求中,将 asset 资源的 label[] 属性设置为与该资产关联的标签列表。API 会自动为列表中之前未明确创建为 assetLabel 资源的所有标签创建新的资产标签。

列出内容所有者的资产标签

如需检索内容所有者的资产标签列表,请调用 assetLabels.list 方法。

  • 默认情况下,该 API 会返回内容所有者的所有资产标签。
  • 如果您为 labelPrefix 查询参数设置了值,则 API 仅返回以指定字符串开头的内容所有者资产标签。

以下查询会调用 assetLabels.list 方法来检索内容所有者的所有标签。但请注意,如果您的 Google 账号与多个内容所有者账号相关联,您必须为 onBehalfOfContentOwner 参数设置一个值,否则请求会返回 400 (Bad Request) 错误。

[no parameters set]

以下查询会调用相同的方法,但将 labelPrefix 参数的值设置为 news。因此,API 只会返回以该字符串开头的标签。

labelPrefix=news

更新资产的标签

您可以在调用 assets.update 方法时设置 label[] 属性的值,更新资产的标签。更新资产时,系统会移除之前的标签列表,取而代之的是 API 请求中发送的列表。因此,如果您想保留之前的标签列表,则应使用 assets.list 方法检索原始标签列表,然后修改 label[] 属性的值。如果属性值为空,API 将移除之前与资产相关联的标签。

您可以将同一标签与多项资产相关联,也可以为同一资产分配多个标签。标签可以包含空格,也就是说,单个标签可以包含多个字词。禁止使用尖括号、逗号、冒号和竖线字符 (|) 等字符。每个标签的长度必须至少为 2 个字节,且不得超过 30 个字节。每位内容所有者可以为每项资产添加最多30个标签;特定资产所用全部标签的总长度最大为500字节。

按标签搜索资产

如需检索与一个或一组标签相关联的资产列表,请调用 assetSearch.list 方法,并使用 labels 查询参数指定以逗号分隔的资产标签列表。

  • 默认情况下,API 将返回具有所有指定资产标签的资产列表。
  • 如果您的 API 请求将 includeAnyProvidedLabel 参数设置为 true,该 API 将返回与至少一个指定标签相匹配的任何资产。