*このコンテンツは、ベータ版のAI（人工知能）を使用して翻訳されており、エラーが含まれている可能性があります。このページを英語で表示するには、こちらをクリックしてください。

GroupRole

グループ内のメンバーに特定の権限を付与する設定可能なプロパティ。

属性

pathstring

グループロールのリソースパス。

形式: groups/{group_id}/roles/{group_role_id}.

createTimestring

出力のみ

グループロールが最後に更新された時刻のタイムスタンプ。

グループの所有者にのみ表示可能。. この文字列は Timestamp としてフォーマットされています。

updateTimestring

出力のみ

グループロールが最後に更新された時刻。

グループの所有者にのみ表示可能。. この文字列は Timestamp としてフォーマットされています。

idstring

出力のみ

役割を識別するユニークなID。

グループ内で唯一のランクであるロールとは異なります。.

displayNamestring

役割の名前。

最大制限は 100 文字です。制限を超える名前は拒否されます。.

descriptionstring

役割の説明。

最大制限は 1000 文字です。制限を超える文字列は拒否されます。グループの所有者にのみ表示されます。.

ranknumber

役割のランク。

最小値は 0です。最大値は 255です。.

memberCountnumber

出力のみ

ロール内のメンバーの合計数。

このフィールドは、ゲスト役割には返されません。.

permissionsobject

この役割に付与された権限。

この値は、認可ユーザーまたは API キー作成クリエーターの読み取り範囲と役割に基づいて満たされます。ユーザーまたはクリエイターが親グループの所有者である場合、グループ内のすべての役割権限を表示できます。ユーザーまたはクリエイターが親グループのメンバーである場合、グループで自分の役割の権限を表示できます。誰でもゲストの権限を表示できます。誰かが権限を表示できない場合、このフィールドは返されません。.

ベース URL

https://apis.roblox.com

GroupRole リソース

{
  "path": "groups/123/roles/123",
  "createTime": "2023-07-05T12:34:56Z",
  "updateTime": "2023-07-05T12:34:56Z",
  "id": "200",
  "displayName": "Member",
  "description": "This is a description for the role",
  "rank": 1,
  "memberCount": 10223136,
  "permissions": {
    "viewWallPosts": true,
    "createWallPosts": true,
    "deleteWallPosts": true,
    "viewGroupShout": true,
    "createGroupShout": true,
    "changeRank": true,
    "acceptRequests": true,
    "exileMembers": true,
    "manageRelationships": true,
    "viewAuditLog": true,
    "spendGroupFunds": true,
    "advertiseGroup": true,
    "createAvatarItems": true,
    "manageAvatarItems": true,
    "manageGroupUniverses": true,
    "viewUniverseAnalytics": true,
    "createApiKeys": true,
    "manageApiKeys": true,
    "banMembers": true,
    "viewForums": true,
    "manageCategories": true,
    "createPosts": true,
    "lockPosts": true,
    "pinPosts": true,
    "removePosts": true,
    "createComments": true,
    "removeComments": true
  }
}

GroupRole

List Group Roles
ベータ版

GET /cloud/v2/groups/{group_id}/roles

グループ内の役割をリストします。

役割の権限フィールドは、リクエスターのアクセスとスコープに基づいて表示できます。

ゲストロールの権限は常に表示されます - スコープは必要ありません。

リクエスターがグループのメンバーであり、group:readスコープを持っている場合、彼らの役割の権限が表示されます。

リクエスターがグループの所有者で group:read スコープを持っている場合、すべての役割の権限が表示されます。

リクエストパスのパラメータ

group_idstring

必須

グループ ID。.

クエリのパラメータ

maxPageSizenumber

返すグループロールの最大数。サービスはこの値より少なく返す可能性があります。指定されない場合、最大 10のグループロールが返されます。最大値は 20 で、高い値は 20 に設定されます。.

pageTokenstring

前の呼び出しから受信したページトークンで、後のページを取得します。

ページをページングするとき、次の呼び出しに提供された他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。.

レスポンス

親コレクションのグループロールのリスト。

groupRolesarray<GroupRole>

指定されたグループからのグループロール。.

nextPageTokenstring

次のページを取得するための pageToken パラメータとして送信できるトークン。このフィールドが省略されると、後続のページはありません。.

GET /cloud/v2/groups/{group_id}/roles

curl -L -X GET 'https://apis.roblox.com/cloud/v2/groups/{group_id}/roles?maxPageSize=10&pageToken={string}' \
  -H 'x-api-key: {your-api-key}'

レスポンス

{
  "groupRoles": [
    {
      "path": "groups/123/roles/123",
      "createTime": "2023-07-05T12:34:56Z",
      "updateTime": "2023-07-05T12:34:56Z",
      "id": "200",
      "displayName": "Member",
      "description": "This is a description for the role",
      "rank": 1,
      "memberCount": 10223136,
      "permissions": {
        "viewWallPosts": true,
        "createWallPosts": true,
        "deleteWallPosts": true,
        "viewGroupShout": true,
        "createGroupShout": true,
        "changeRank": true,
        "acceptRequests": true,
        "exileMembers": true,
        "manageRelationships": true,
        "viewAuditLog": true,
        "spendGroupFunds": true,
        "advertiseGroup": true,
        "createAvatarItems": true,
        "manageAvatarItems": true,
        "manageGroupUniverses": true,
        "viewUniverseAnalytics": true,
        "createApiKeys": true,
        "manageApiKeys": true,
        "banMembers": true,
        "viewForums": true,
        "manageCategories": true,
        "createPosts": true,
        "lockPosts": true,
        "pinPosts": true,
        "removePosts": true,
        "createComments": true,
        "removeComments": true
      }
    }
  ],
  "nextPageToken": "string"
}

GroupRole

Get Group Role
ベータ版

GET /cloud/v2/groups/{group_id}/roles/{role_id}

グループロールを取得する

リクエストパスのパラメータ

group_idstring

必須

グループ ID。.

role_idstring

必須

役割 ID。.

レスポンスGroupRole

GET /cloud/v2/groups/{group_id}/roles/{role_id}

curl -L -X GET 'https://apis.roblox.com/cloud/v2/groups/{group_id}/roles/{role_id}' \
  -H 'x-api-key: {your-api-key}'

レスポンス

{
  "path": "groups/123/roles/123",
  "createTime": "2023-07-05T12:34:56Z",
  "updateTime": "2023-07-05T12:34:56Z",
  "id": "200",
  "displayName": "Member",
  "description": "This is a description for the role",
  "rank": 1,
  "memberCount": 10223136,
  "permissions": {
    "viewWallPosts": true,
    "createWallPosts": true,
    "deleteWallPosts": true,
    "viewGroupShout": true,
    "createGroupShout": true,
    "changeRank": true,
    "acceptRequests": true,
    "exileMembers": true,
    "manageRelationships": true,
    "viewAuditLog": true,
    "spendGroupFunds": true,
    "advertiseGroup": true,
    "createAvatarItems": true,
    "manageAvatarItems": true,
    "manageGroupUniverses": true,
    "viewUniverseAnalytics": true,
    "createApiKeys": true,
    "manageApiKeys": true,
    "banMembers": true,
    "viewForums": true,
    "manageCategories": true,
    "createPosts": true,
    "lockPosts": true,
    "pinPosts": true,
    "removePosts": true,
    "createComments": true,
    "removeComments": true
  }
}

GroupRole

属性

GroupRole

List Group Rolesベータ版

GroupRole

Get Group Roleベータ版

List Group Roles
ベータ版

Get Group Role
ベータ版