统一标记端点
https://experience.adobe.io
。标记是一项功能,可让您管理元数据分类,以分类业务对象以便于发现和分类。 随后,您可以通过将这些标记添加到标记类别来将这些标记组织到其他组中。
本指南提供的信息可帮助您更好地了解标记和标记类别,包括用于使用API执行基本操作的示例API调用。
快速入门
本指南中使用的端点是Adobe Experience Platform API的一部分。 在继续之前,请查看快速入门指南以了解成功调用API所需了解的重要信息,包括所需的标头以及如何读取示例API调用
术语表
以下术语表突出显示 标记 和 标记类别 之间的区别。
- 标记:标记允许您管理业务对象的元数据分类,从而允许您对这些对象进行分类,以便于发现和分类。
- 未分类的标记:未分类的标记是不属于标记类别的标记。 默认情况下,创建的标记将取消分类。
- 标记类别:标记类别允许您将标记分组为有意义的集,从而提供更多有关标记目的的上下文。
检索标记类别的列表 get-tag-categories
您可以通过向/tagCategory
端点发出GET请求来检索属于您组织的标记类别的列表。
API格式
GET /tagCategory
GET /tagCategory?{QUERY_PARAMETERS}
检索标记类别时,可以使用以下可选查询参数。
start
start=a
limit
limit=20
property
检索标记类别时要过滤的属性。 支持的值包括: <ul≥
name
:标记类别的名称。
property=name==category
sortBy
name
、createdAt
和modifiedAt
。sortBy=name
sortOrder
asc
和desc
。sortOrder=asc
请求
code language-shell |
---|
|
响应
成功的响应会返回HTTP状态200,其中包含贵组织所有标记类别的列表。
code language-json |
---|
|
创建新标记类别 create-tag-category
您可以通过向/tagCategory
端点发出POST请求来创建新的标记类别。
API格式
POST /tagCategory
请求
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 | |
---|---|
属性 | 描述 |
name |
要创建的标记类别的名称。 |
description |
要创建的标记类别的描述。 |
响应
示例响应返回HTTP状态200以及新创建的标记类别的详细信息。
code language-json |
---|
|
检索特定标记类别 get-tag-category
您可以通过向/tagCategory
端点发出GET请求并指定标记类别的ID来检索属于您组织的特定标记类别。
API格式
GET /tagCategory/{TAG_CATEGORY_ID}
{TAG_CATEGORY_ID}
请求
code language-shell |
---|
|
响应
成功的响应返回HTTP状态200以及指定标记类别的详细信息。
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 | |
---|---|
属性 | 描述 |
id |
请求的标记类别的ID。 |
name |
请求的标记类别的名称。 |
description |
请求的标记类别的描述。 |
createdBy |
创建标记类别的用户的ID。 |
createdAt |
创建标记类别的时间戳。 |
modifiedBy |
上次更新标记类别的用户的ID。 |
modifiedAt |
标记类别上次更新的时间戳。 |
tagCount |
属于标记类别的标记数。 |
更新特定标记类别 update-tag-category
您可以通过向/tagCategory
端点发出PATCH请求并指定标记类别的ID来更新属于您组织的特定标记类别的详细信息。
API格式
PATCH /tagCategory/{TAG_CATEGORY_ID}
{TAG_CATEGORY_ID}
请求
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
---|---|
参数 | 描述 |
op |
已完成的操作。 要更新特定标记类别,请将此值设置为replace 。 |
path |
将更新的字段的路径。 支持的值包括name 和description 。 |
value |
要更新的字段的更新值。 |
from |
要更新的字段的原始值。 |
响应
成功响应HTTP状态200,其中包含有关新更新的标记类别的信息。
code language-json |
---|
|
删除特定标记类别 delete-tag-category
通过向/tagCategory
端点发出DELETE请求并指定标记类别的ID,可以删除属于您组织的特定标记类别。
API格式
DELETE /tagCategory/{TAG_CATEGORY_ID}
{TAG_CATEGORY_ID}
请求
code language-shell |
---|
|
响应
成功的响应返回HTTP状态200以及空响应。
检索标记列表 get-tags
您可以通过向/tags
端点以及标记类别的ID发出GET请求来检索属于您组织的标记列表。
API格式
GET /tags
GET /tags?{QUERY_PARAMETERS}
检索标记时,可以使用以下可选查询参数。
start
start=a
limit
limit=20
property
检索标记时要过滤的属性。 支持的值包括:
name
:标记的名称。archived
:标记是否已存档或取消存档。 您可以将此值设置为true
或false
。tagCategoryId
:标记所属的标记类别的ID。
property=name==TestTag
property=archived==false
property=tagCategoryId==e2b7c656-067b-4413-a366-adde0401df50
sortBy
name
、createdAt
和modifiedAt
。sortBy=name
sortOrder
asc
和desc
。sortOrder=asc
请求
code language-shell |
---|
|
响应
成功的响应会返回HTTP状态200,其中包含属于该标记类别的标记的详细信息。
code language-json |
---|
|
创建新标记 create-tag
您可以通过向/tags
端点发出POST请求来创建新标记。
API格式
POST /tags
请求
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 | |
---|---|
属性 | 描述 |
name |
必需。 要创建的标记的名称。 |
tagCategoryId |
可选。 您希望标记所属的标记类别的ID。 如果未指定,则标记将作为“未分类”类别的一部分创建。 |
响应
成功的响应会返回HTTP状态201以及新创建标记的详细信息。
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 | |
---|---|
参数 | 描述 |
name |
新创建的标记的名称。 |
id |
新创建的标记的ID。 |
org |
标记所属的组织的ID。 |
createdAt |
创建标记时的时间戳。 |
createdBy |
创建标记的用户的ID。 |
modifiedAt |
标记上次更新的时间戳。 |
modifiedBy |
上次更新标记的用户的ID。 |
tagCategoryId |
标记所属的标记类别的ID。 |
tagCategoryName |
标记所属的标记类别的名称。 |
检索特定标记 get-tag
您可以通过向/tags
端点发出GET请求并指定要检索的标记的ID,来检索属于您组织的特定标记。
API格式
GET /tags/{TAG_ID}
{TAG_ID}
请求
code language-shell |
---|
|
响应
成功的响应返回HTTP状态200以及指定标记的详细信息。
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 | |
---|---|
参数 | 描述 |
name |
检索到的标记的名称。 |
id |
您检索到的标记的ID。 |
org |
标记所属的组织的ID。 |
createdAt |
创建标记时的时间戳。 |
createdBy |
创建标记的用户的ID。 |
modifiedAt |
标记上次更新的时间戳。 |
modifiedBy |
上次更新标记的用户的ID。 |
tagCategoryId |
标记所属的标记类别的ID。 |
tagCategoryName |
标记所属的标记类别的名称。 |
archived |
标记的存档状态。 如果设置为true ,则表示标记已存档。 |
验证标记 validate-tags
您可以通过向/tags/validate
端点发出POST请求来验证标记是否存在。
API格式
POST /tags/validate
请求
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 | |
---|---|
属性 | 描述 |
ids |
包含要验证的标记ID列表的数组。 |
entity |
请求验证的实体。 您可以对此参数使用{API_KEY} 值。 |
响应
成功的响应返回HTTP状态200,其中包含有关哪些标记有效及无效的信息。
code language-json |
---|
|
table 0-row-2 1-row-2 2-row-2 | |
---|---|
属性 | 描述 |
invalidTags |
包含无效标记ID列表的数组。 |
validTags |
包含有效标记ID列表的数组。 |
更新特定标记 update-tag
您可以通过向/tags
端点发出PATCH请求并提供要更新的标记的ID来更新指定的标记。
API格式
PATCH /tags/{TAG_ID}
{TAG_ID}
请求
code language-shell |
---|
|
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 | |
---|---|
属性 | 描述 |
op |
需要执行的操作。 在此使用案例中,它将始终设置为replace 。 |
path |
将更新的字段的路径。 支持的值包括name 、archived 和tagCategoryId 。 |
value |
要更新的字段的更新值。 |
from |
要更新的字段的原始值。 |
响应
成功的响应返回HTTP状态200以及新更新标记的详细信息。
code language-json |
---|
|
删除特定标记 delete-tag
您可以通过为/tags
端点创建DELETE标记并指定要删除的标记的ID来删除特定标记。
API格式
DELETE /tags/{TAG_ID}
{TAG_ID}
请求
code language-shell |
---|
|
响应
成功的响应返回HTTP状态200以及空响应。
后续步骤
阅读本指南后,您将会更好地了解如何使用Adobe Experience Platform API创建、管理和删除标记和标记类别。 有关使用UI管理标记的更多信息,请参阅管理标记指南。 有关使用UI管理标记类别的更多信息,请参阅标记类别指南。