文件 Audience Manager Audience Manager 使用手冊

群組管理API方法 group-management-api-methods

Last update: Sat Jul 20 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