文档 Audience Manager Audience Manager 用户指南

组管理API方法 group-management-api-methods

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：
API

剩余API种管理群组的方法，包括创建、更新、列出和删除群组。

创建群组 create-group

用于创建新用户组的POST方法。

请求

POST /api/v1/groups/

示例请求正文

 {
    "name" : <string>,
    "description" : <string_may_be_null>,
 }

响应

  {
    "groupId" : <integer>,
    "pid" : <integer>,
    "name" : <string>,
    "description" : <string_may_be_null>,
    "membershipCount" : <integer>,
    "wildcards" : <list of strings>,
    "users" : <list of user IDs>
  }

更新组 update-group

用于更新用户组的PUT方法。

请求

PUT /api/v1/groups/<groupId>

示例请求正文

 {
    "name" : <string>,
    "description" : <string_may_be_null>,
 }

响应

  {
    "groupId" : <integer>,
    "pid" : <integer>,
    "name" : <string>,
    "description" : <string_may_be_null>,
    "membershipCount" : <integer>,
    "wildcards" : <list of strings>,
    "users" : <list of user IDs>
  }

列出组 list-groups

用于列出用户组的GET方法。

请求

GET /api/v1/groups/

响应

[
  {
    "groupId" : <integer>,
    "pid" : <integer>,
    "name" : <string>,
    "description" : <string_may_be_null>,
    "membershipCount" : <integer>,
    "wildcards" : <list of strings>,
    "users" : <list of user IDs>
  }, ...
]

删除群组 delete-groups

用于删除用户组并从该组中删除所有成员的DELETE方法。

请求

DELETE /api/v1/groups/<groupId>

如果成功，则返回204 No Content。如果发生冲突，返回409 Conflict。

批量删除组 delete-groups-bulk

用于批量删除多个组并从该组中删除所有成员的DELETE方法。

请求

DELETE /api/v1/groups/bulk-delete

如果成功，则返回204 No Content。如果发生冲突，返回409 Conflict。

列出组的所有权限 list-permissions-group

用于列出组上权限对象的GET方法。

请求

GET /api/v1/groups/{groupId}/permissions

响应

[{
 "objectId" : 34,
 "objectType": "SEGMENT",
 "permissions": ["READ", "WRITE", "DELETE", "MAP_TO_MODELS"]
 },

{
 "objectId" : "234",
 "objectType": "TRAIT",
 "permissions": ["READ", "WRITE", "DELETE", "MAP_TO_MODELS"]
 },
 {
 "objectId" : 277,
 "objectType": "SEGMENT",
 "permissions": ["READ", "WRITE", "MAP_TO_MODELS"]
 }
]

如果该组不可访问，则返回400 Bad Request。

设置组的权限 set-permissions-group

用于更新组权限的PUT方法。此方法会使用新权限覆盖旧权限。

请求

PUT /api/v1/groups/{groupId}/permissions/

响应

[
  { "objectType" : "SEGMENT",
    "objectId" : 563,
    "permissions" : [ "READ", "WRITE"]
  },
  { "objectType" : "SEGMENT",
    "objectId" : 2363,
    "permissions" : [ "CREATE", "WRITE"]
  },
  { "objectType" : "TRAIT",
    "objectId" : 83498,
    "permissions" : [ "READ", "MAP_TO_SEGMENTS"]
  },
  { "objectType" : "DESTINATION",
    "objectId" : 304,
    "permissions" : [ "READ", "WRITE", "CREATE"]
  }
]

示例响应表示权限对象的更新列表。

如果成功，则返回200 OK。如果任何给定权限无效，则返回400。如果登录的用户无法访问对象，也可以返回403。

recommendation-more-help

de293fbf-b489-49b0-8daa-51ed303af695