> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# グループ

> PlayFab のエンティティ グループと、そのロール、メンバー、招待、申請、ブロックを管理します。

`playfab group` コマンド ファミリーは試験段階 (Experimental) です。CLI インターフェイスは、フィードバックに基づいて
変更または削除される可能性があります。

PlayFab のエンティティ グループと、そのロール、メンバー、招待、申請、
ブロックを管理し、エンティティが所属するグループを一覧表示します。

ほとんどのコマンドは `--group-id` でグループを指定します。`group get` では、代わりに `--group-name` を
使用できます。`--entity-id` と `--entity-type` は、`--entity-type
title_player_account` のように一緒に渡します。プレイヤーの場合は、マスター プレイヤー アカウント ID ではなく、
タイトル プレイヤー アカウント ID を渡します。この ID は、[`playfab player account get`](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands/playfab/player) から
`UserInfo.TitleInfo.TitlePlayerAccount.Id` として返されます。

`group delete` と `group role delete` は、ターミナルでは事前に確認を求め、それ以外の環境では `--confirm` が
必要です。`group member remove` を含め、グループを変更するその他のコマンドは確認なしで
実行されます。[安全性と破壊的な操作](https://docs.xbox.com/ja-jp/tools/xbox-cli/safety.md)を参照してください。

## グループのライフサイクル

| コマンド | PlayFab API パス | オプション |
| - | - | - |
| `playfab group create` | `/Group/CreateGroup` | `--group-name` は必須。省略可能な所有者の `--entity-id`、`--entity-type`。 |
| `playfab group get` | `/Group/GetGroup` | `--group-id` または `--group-name`。 |
| `playfab group update` | `/Group/UpdateGroup` | `--group-id` は必須。省略可能な `--group-name`、`--admin-role-id`、`--member-role-id`、`--expected-profile-version`。 |
| `playfab group delete` | `/Group/DeleteGroup` | `--group-id` は必須。 |

## グループのメンバー

| コマンド | PlayFab API パス | オプション |
| - | - | - |
| `playfab group member add` | `/Group/AddMembers` | `--group-id`、`--member-ids`、`--member-type` は必須。省略可能な `--role-id`。 |
| `playfab group member remove` | `/Group/RemoveMembers` | `--group-id`、`--member-ids`、`--member-type` は必須。省略可能な `--role-id`。 |
| `playfab group member change-role` | `/Group/ChangeMemberRole` | `--group-id`、`--member-ids`、`--member-type`、`--origin-role-id`、`--destination-role-id` は必須。 |
| `playfab group member list` | `/Group/ListGroupMembers` | `--group-id` は必須。 |
| `playfab group member is-member` | `/Group/IsMember` | `--group-id`、`--entity-id`、`--entity-type` は必須。省略可能な `--role-id`。読み取りのみを行います。 |

## グループのロール

| コマンド | PlayFab API パス | オプション |
| - | - | - |
| `playfab group role create` | `/Group/CreateRole` | `--group-id`、`--role-id`、`--role-name` は必須。 |
| `playfab group role update` | `/Group/UpdateRole` | `--group-id`、`--role-id`、`--role-name` は必須。省略可能な `--expected-profile-version`。 |
| `playfab group role delete` | `/Group/DeleteRole` | `--group-id` と `--role-id` は必須。 |

## グループへの招待

| コマンド | PlayFab API パス | オプション |
| - | - | - |
| `playfab group invite send` | `/Group/InviteToGroup` | `--group-id`、`--entity-id`、`--entity-type` は必須。省略可能な `--role-id`、`--auto-accept`。 |
| `playfab group invite accept` | `/Group/AcceptGroupInvitation` | `--group-id` は必須。省略可能な承諾する側の `--entity-id`、`--entity-type`。 |
| `playfab group invite remove` | `/Group/RemoveGroupInvitation` | `--group-id`、`--entity-id`、`--entity-type` は必須。 |
| `playfab group invite list` | `/Group/ListGroupInvitations` | `--group-id` は必須。 |

`invite send` では、`--auto-accept` の既定値は `true` です。エンティティが既にグループに申請している場合、
PlayFab は招待を送信する代わりに申請を承諾します。

## グループへの申請

| コマンド | PlayFab API パス | オプション |
| - | - | - |
| `playfab group application apply` | `/Group/ApplyToGroup` | `--group-id` は必須。省略可能な申請者の `--entity-id`、`--entity-type`、`--auto-accept`。 |
| `playfab group application accept` | `/Group/AcceptGroupApplication` | `--group-id` は必須。省略可能な申請者の `--entity-id`、`--entity-type`。 |
| `playfab group application remove` | `/Group/RemoveGroupApplication` | `--group-id`、`--entity-id`、`--entity-type` は必須。 |
| `playfab group application list` | `/Group/ListGroupApplications` | `--group-id` は必須。 |

`application apply` では、`--auto-accept` の既定値は `true` です。グループが既にエンティティを招待している場合、
PlayFab は申請を作成する代わりに招待を承諾します。

## グループのブロック

| コマンド | PlayFab API パス | オプション |
| - | - | - |
| `playfab group block add` | `/Group/BlockEntity` | `--group-id`、`--entity-id`、`--entity-type` は必須。 |
| `playfab group block remove` | `/Group/UnblockEntity` | `--group-id`、`--entity-id`、`--entity-type` は必須。 |
| `playfab group block list` | `/Group/ListGroupBlocks` | `--group-id` は必須。 |

## エンティティのメンバーシップ

| コマンド | PlayFab API パス | オプション |
| - | - | - |
| `playfab group membership list` | `/Group/ListMembership` | 省略可能な `--entity-id`、`--entity-type`。呼び出し元のエンティティを対象にするには、両方を省略します。 |
| `playfab group membership opportunity list` | `/Group/ListMembershipOpportunities` | 省略可能な `--entity-id`、`--entity-type`。呼び出し元のエンティティを対象にするには、両方を省略します。 |

## 表形式の出力

次のコマンドは `--output table` を受け付けます。その他のコマンドは受け付けません。
[テーブル出力](https://docs.xbox.com/ja-jp/tools/xbox-cli/commands.md#table-output)を参照してください。

| コマンド | 列 |
| - | - |
| `playfab group member list` | `MEMBER ID`、`MEMBER TYPE`、`ROLE ID` |
| `playfab group invite list` | `INVITED ENTITY`、`ROLE ID`、`EXPIRES` |
| `playfab group application list` | `ENTITY`、`EXPIRES` |
| `playfab group block list` | `BLOCKED ENTITY`、`ENTITY TYPE` |
| `playfab group membership list` | `GROUP ID`、`GROUP NAME` |
| `playfab group membership opportunity list` | `TYPE`、`GROUP ID`、`ROLE ID`、`EXPIRES` |

`member list` には各ロールの各メンバーにつき 1 行が表示されるため、2 つのロールに属するメンバーには 2 行が
表示され、メンバーがいないロールには、メンバーが `-` の行が 1 行表示されます。
`membership opportunity list` は、招待と申請を 1 つの表に表示します。`TYPE` は
`invitation` または `application` で、申請の場合 `ROLE ID` は `-` です。

## 例

グループを読み取り、そのメンバーを一覧表示し、プレイヤーがグループに所属しているかどうかを確認して、
未処理の招待を一覧表示します。

```bash theme={null}
xbox --playfab-title-id ABC123 playfab group get --group-id GROUP123
xbox --playfab-title-id ABC123 playfab group member list --group-id GROUP123 --data-only --output json-compact
xbox --playfab-title-id ABC123 playfab group member is-member --group-id GROUP123 --entity-id TITLEPLAYER123 --entity-type title_player_account
xbox --playfab-title-id ABC123 playfab group invite list --group-id GROUP123 --output table
```

プレイヤーをグループに招待します。

```bash theme={null}
xbox --playfab-title-id ABC123 playfab group invite send --group-id GROUP123 --entity-id TITLEPLAYER123 --entity-type title_player_account
```

グループを削除します。

```bash theme={null}
xbox --playfab-title-id ABC123 playfab group delete --group-id GROUP123 --confirm
```


## Related topics

- [製品グループ](https://docs.xbox.com/ja-jp/publishing/game-publishing/concepts/product-groups.md)
- [グループ、ギルド、クラン](https://docs.xbox.com/ja-jp/services/playfab/community/associations/groups/index.md)
- [グループの取得](https://docs.xbox.com/ja-jp/services/playfab/api-references/rest/groups/groups/get-group.md)
- [グループの削除](https://docs.xbox.com/ja-jp/services/playfab/api-references/rest/groups/groups/delete-group.md)
- [グループ ランキング](https://docs.xbox.com/ja-jp/services/playfab/community/leaderboards/group-leaderboards.md)
