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

GroupMembership

グループへのメンバーシップ。ユーザーID は、メンバーシップID の代わりに使用できます。

属性

pathstring

グループメンバーのリソースパス。

形式: groups/{group_id}/memberships/{group_membership_id}.

createTimestring
出力のみ

グループメンバーシップが作成された時刻。. この文字列は Timestamp としてフォーマットされています。

updateTimestring
出力のみ

グループメンバーシップが最後に更新されたタイムスタンプ。. この文字列は Timestamp としてフォーマットされています。

userstring
不変

グループのメンバーのリソースパス。.

rolestring

グループメンバーの役割のリソースパス。.

ベース URL
https://apis.roblox.com
GroupMembership リソース
{

  "path": "groups/123/memberships/123",

  "createTime": "2023-07-05T12:34:56Z",

  "updateTime": "2023-07-05T12:34:56Z",

  "user": "users/21557",

  "role": "groups/7/roles/99513316"

}

GroupMembership

グループメンバーシップをリスト
ベータ版

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

グループ内のグループメンバーをリストします。

リクエストパスのパラメータ
group_idstring
必須

グループ ID。.

クエリのパラメータ
maxPageSizenumber

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

pageTokenstring

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

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

filterstring

このフィールドは、返された資源をフィルタするために設定できます。

詳しくは、フィルタリング ドキュメントを参照してください。.

レスポンス

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

groupMembershipsarray<GroupMembership>

指定されたグループのグループメンバーシップ。.

nextPageTokenstring

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

GET /cloud/v2/groups/{group_id}/memberships
curl -L -X GET 'https://apis.roblox.com/cloud/v2/groups/{group_id}/memberships?maxPageSize=10&pageToken={string}&filter={string}' \

  -H 'x-api-key: {your-api-key}'
レスポンス
{

  "groupMemberships": [

    {

      "path": "groups/123/memberships/123",

      "createTime": "2023-07-05T12:34:56Z",

      "updateTime": "2023-07-05T12:34:56Z",

      "user": "users/21557",

      "role": "groups/7/roles/99513316"

    }

  ],

  "nextPageToken": "string"

}

GroupMembership

グループメンバーを更新する
ベータ版

PATCH /cloud/v2/groups/{group_id}/memberships/{membership_id}

特定のグループメンバーのグループメンバー資格を更新します。このアクションには、リクエスターが低ランクのメンバーを管理できる必要があります。ゲストまたはオーナーランクは割り当てられず、リクエスターは自分のランクを変更できません。

範囲
group:write
リクエストパスのパラメータ
group_idstring
必須

グループ ID。.

membership_idstring
必須

メンバー ID。.

リクエスト本文GroupMembership
レスポンスGroupMembership
PATCH /cloud/v2/groups/{group_id}/memberships/{membership_id}
curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/groups/{group_id}/memberships/{membership_id}' \

  -H 'x-api-key: {your-api-key}' \

  -H 'Content-Type: application/json' \

  --data '{

  "role": "groups/7/roles/99513316"

}'
レスポンス
{

  "path": "groups/123/memberships/123",

  "createTime": "2023-07-05T12:34:56Z",

  "updateTime": "2023-07-05T12:34:56Z",

  "user": "users/21557",

  "role": "groups/7/roles/99513316"

}