> ## 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.

# Services C API overview - PFGroupsTypes.h

> Services C API overview - PFGroupsTypes.h

## 構造体

| 構造体 | 説明 |
| - | - |
| [PFGroupsAcceptGroupApplicationRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsacceptgroupapplicationrequest.md) | PFGroupsAcceptGroupApplicationRequest データ モデル。招待されたエンティティがグループによってブロックされていない場合、グループへの参加の未処理の招待を承諾します。成功した場合、何も返されません。 |
| [PFGroupsAcceptGroupInvitationRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsacceptgroupinvitationrequest.md) | PFGroupsAcceptGroupInvitationRequest データ モデル。招待されたエンティティがグループによってブロックされていない場合、グループへの参加の未処理の招待を承諾します。招待されたエンティティに代わって招待を承諾できるのは、招待されたエンティティ本人またはそのチェーン内の親 (タイトルなど) のみです。成功した場合、何も返されません。 |
| [PFGroupsAddMembersRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsaddmembersrequest.md) | PFGroupsAddMembersRequest データ モデル。グループまたはロールにメンバーを追加します。グループの既存メンバーはグループ内のロールに追加できますが、ユーザーがまだグループのメンバーでない場合は、タイトル クレーム所有者のみがグループに追加でき、それ以外の場合はグループ申請または招待システムを使用して新しいメンバーをグループに追加する必要があります。成功した場合、何も返されません。 |
| [PFGroupsApplyToGroupRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsapplytogrouprequest.md) | PFGroupsApplyToGroupRequest データ モデル。グループへの参加申請を作成します。既にグループ申請が存在している状態でこれを呼び出すと、エラーではなく同じ申請が返され、申請の有効期限までの時間は更新されません。既定では、エンティティにグループへの参加の未処理の招待がある場合、これは代わりにグループへの参加の招待を承諾し、後でクリーンアップが必要になる重複した参加申請を作成する代わりに、その旨を示すエラーを返します。申請に関する情報、または代わりに招待が承諾されたことを示すエラーを返します。 |
| [PFGroupsApplyToGroupResponse](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsapplytogroupresponse.md) | PFGroupsApplyToGroupResponse データ モデル。グループへの参加申請を記述します。 |
| [PFGroupsBlockEntityRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsblockentityrequest.md) | PFGroupsBlockEntityRequest データ モデル。エンティティの一覧がグループに参加できないようにブロックします。ブロックされたエンティティは、新しい参加申請の作成、参加への招待、招待の承諾、または申請の承諾を受けることができません。ブロックによる失敗では、グループへの既存の申請や招待はクリーンアップされません。成功した場合、データは返されません。 |
| [PFGroupsChangeMemberRoleRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupschangememberrolerequest.md) | PFGroupsChangeMemberRoleRequest データ モデル。エンティティの一覧のロール メンバーシップを、単一の操作であるロールから別のロールに変更します。移動先のロールは既に存在している必要があります。これは、エンティティを移動先のロールに追加し、移動元のロールから削除することと同等です。成功した場合、何も返されません。 |
| [PFGroupsCreateGroupRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupscreategrouprequest.md) | PFGroupsCreateGroupRequest データ モデル。タイトルのグループ テンプレートに基づいて、新しいグループと、管理者およびメンバーのロールを作成します。作成されたグループに関する情報を返します。 |
| [PFGroupsCreateGroupResponse](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupscreategroupresponse.md) | PFGroupsCreateGroupResponse データ モデル。 |
| [PFGroupsCreateGroupRoleRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupscreategrouprolerequest.md) | PFGroupsCreateGroupRoleRequest データ モデル。既存のグループ内にメンバーがいない新しいロールを作成します。ロール ID とロール名の両方がグループ内で一意である必要がありますが、名前は ID と同じにすることもできます。ロール ID は作成時に設定され、変更できません。作成されたロールに関する情報を返します。 |
| [PFGroupsCreateGroupRoleResponse](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupscreategrouproleresponse.md) | PFGroupsCreateGroupRoleResponse データ モデル。 |
| [PFGroupsDeleteGroupRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsdeletegrouprequest.md) | PFGroupsDeleteGroupRequest データ モデル。グループと、それに関連付けられているすべてのロール、招待、参加申請、ブロックを削除します。このアクションを実行するには、グループ自体に対する削除権限のみが必要です。削除されたグループとデータは復元できませんが、そのグループに関する不正利用の報告は残ります。成功した場合、データは返されません。 |
| [PFGroupsDeleteRoleRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsdeleterolerequest.md) | PFGroupsDeleteRoleRequest データ モデル。ロールに関する情報を返します。 |
| [PFGroupsEntityMemberRole](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsentitymemberrole.md) | PFGroupsEntityMemberRole データ モデル。 |
| [PFGroupsEntityWithLineage](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsentitywithlineage.md) | PFGroupsEntityWithLineage データ モデル。エンティティ キーと、そのエンティティの系列を構成するエンティティを含むエンティティ ラッパー クラスです。 |
| [PFGroupsGetGroupRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsgetgrouprequest.md) | PFGroupsGetGroupRequest データ モデル。グループに関する ID、名前、ロールの一覧、およびメンバーシップに関連しないその他の情報を返します。 |
| [PFGroupsGetGroupResponse](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsgetgroupresponse.md) | PFGroupsGetGroupResponse データ モデル。 |
| [PFGroupsGroupApplication](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsgroupapplication.md) | PFGroupsGroupApplication データ モデル。グループへの参加申請を記述します。 |
| [PFGroupsGroupBlock](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsgroupblock.md) | PFGroupsGroupBlock データ モデル。グループへの参加をブロックされているエンティティを記述します。 |
| [PFGroupsGroupInvitation](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsgroupinvitation.md) | PFGroupsGroupInvitation データ モデル。グループへの招待を記述します。 |
| [PFGroupsGroupRole](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsgrouprole.md) | PFGroupsGroupRole データ モデル。グループ ロールを記述します。 |
| [PFGroupsGroupWithRoles](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsgroupwithroles.md) | PFGroupsGroupWithRoles データ モデル。グループとそれに含まれるロールを記述します。 |
| [PFGroupsInviteToGroupRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsinvitetogrouprequest.md) | PFGroupsInviteToGroupRequest データ モデル。グループによってブロックされていない場合、プレイヤーをグループに参加するよう招待します。省略可能なロールを指定して、プレイヤーが招待を承諾した際に自動的にそのロールに割り当てることもできます。既定では、エンティティにグループへの未処理の申請がある場合、これは代わりに申請を承諾し、後でクリーンアップが必要になる重複した参加招待を作成する代わりに、その旨を示すエラーを返します。新しい招待に関する情報、または既存の参加申請が承諾されたことを示すエラーを返します。 |
| [PFGroupsInviteToGroupResponse](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsinvitetogroupresponse.md) | PFGroupsInviteToGroupResponse データ モデル。グループへの招待を記述します。 |
| [PFGroupsIsMemberRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsismemberrequest.md) | PFGroupsIsMemberRequest データ モデル。エンティティがグループのメンバーまたはグループ内のロールのメンバーであるかを確認します。エンティティがグループのメンバーであるかどうかを示す結果、または呼び出し元がグループのメンバー一覧を読み取る権限を持っていない場合はアクセス許可エラーが返されます。 |
| [PFGroupsIsMemberResponse](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsismemberresponse.md) | PFGroupsIsMemberResponse データ モデル。 |
| [PFGroupsListGroupApplicationsRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistgroupapplicationsrequest.md) | PFGroupsListGroupApplicationsRequest データ モデル。グループへの参加を求める未処理の要求をすべて一覧表示します。すべての参加要求と、要求の有効期限を返します。特定のエンティティに対するグループ申請を取得するには、ListMembershipOpportunities を使用します。 |
| [PFGroupsListGroupApplicationsResponse](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistgroupapplicationsresponse.md) | PFGroupsListGroupApplicationsResponse データ モデル。 |
| [PFGroupsListGroupBlocksRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistgroupblocksrequest.md) | PFGroupsListGroupBlocksRequest データ モデル。グループへの参加をブロックされているすべてのエンティティを一覧表示します。ブロックされたエンティティの一覧が返されます。 |
| [PFGroupsListGroupBlocksResponse](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistgroupblocksresponse.md) | PFGroupsListGroupBlocksResponse データ モデル。 |
| [PFGroupsListGroupInvitationsRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistgroupinvitationsrequest.md) | PFGroupsListGroupInvitationsRequest データ モデル。グループに対する未処理の招待をすべて一覧表示します。招待されたエンティティの一覧と、招待の有効期限を返します。特定のエンティティに対するグループの招待を取得するには、ListMembershipOpportunities を使用します。 |
| [PFGroupsListGroupInvitationsResponse](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistgroupinvitationsresponse.md) | PFGroupsListGroupInvitationsResponse データ モデル。 |
| [PFGroupsListGroupMembersRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistgroupmembersrequest.md) | PFGroupsListGroupMembersRequest データ モデル。グループ内で所属するロールとメンバーの一覧を取得します。呼び出し元がロールを表示する権限を持っておらず、かつメンバーが他のロールにも属していない場合、そのメンバーは表示されません。グループのメンバーであるエンティティの一覧を返します。 |
| [PFGroupsListGroupMembersResponse](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistgroupmembersresponse.md) | PFGroupsListGroupMembersResponse データ モデル。 |
| [PFGroupsListMembershipOpportunitiesRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistmembershipopportunitiesrequest.md) | PFGroupsListMembershipOpportunitiesRequest データ モデル。エンティティに関する未処理のグループ申請と招待をすべて一覧表示します。この API は任意のエンティティに対して誰でも呼び出せますが、データが返されるのは対象エンティティまたはその親エンティティに対してのみです。プレイヤーが参加しようとしているかどうかを確認するためにグループの招待や申請を一覧表示するには、ListGroupInvitations および ListGroupApplications を使用します。 |
| [PFGroupsListMembershipOpportunitiesResponse](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistmembershipopportunitiesresponse.md) | PFGroupsListMembershipOpportunitiesResponse データ モデル。 |
| [PFGroupsListMembershipRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistmembershiprequest.md) | PFGroupsListMembershipRequest データ モデル。エンティティが所属するグループとロールを一覧表示し、グループとロールのメタデータおよびメンバーシップが呼び出し元に対して可視かどうかを確認します。呼び出し元に表示できるロールにエンティティが属していない場合、呼び出し元がそのエンティティが当該グループのメンバーであることを認識できる権限を持っていたとしても、そのグループは結果に含まれません。 |
| [PFGroupsListMembershipResponse](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupslistmembershipresponse.md) | PFGroupsListMembershipResponse データ モデル。 |
| [PFGroupsRemoveGroupApplicationRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsremovegroupapplicationrequest.md) | PFGroupsRemoveGroupApplicationRequest データ モデル。グループへの既存の参加申請を削除します。これは申請の却下と申請の取り下げの両方で使用されます。申請を行ったエンティティまたはそのチェーン内の親 (タイトルなど) は申請を取り下げることができ、グループ内で適切なアクセス権を持つ呼び出し元は申請を却下できます。成功した場合、データは返されません。 |
| [PFGroupsRemoveGroupInvitationRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsremovegroupinvitationrequest.md) | PFGroupsRemoveGroupInvitationRequest データ モデル。グループへの既存の招待を削除します。これは招待の拒否と招待の取り消しの両方で使用されます。招待されたエンティティまたはそのチェーン内の親 (タイトルなど) は、このメソッドを呼び出して招待を拒否でき、グループ内で適切なアクセス権を持つ呼び出し元は招待を取り消せます。成功した場合、データは返されません。 |
| [PFGroupsRemoveMembersRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsremovemembersrequest.md) | PFGroupsRemoveMembersRequest データ モデル。グループからメンバーを削除します。メンバーは権限に関係なく、常にグループから自分自身を削除できます。成功した場合は何も返されません。 |
| [PFGroupsUnblockEntityRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsunblockentityrequest.md) | PFGroupsUnblockEntityRequest データ モデル。エンティティの一覧に対するグループ参加のブロックを解除します。成功した場合、データは返されません。 |
| [PFGroupsUpdateGroupRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsupdategrouprequest.md) | PFGroupsUpdateGroupRequest データ モデル。名前や既定のメンバー ロールなど、グループに関するデータを更新します。更新が成功したかどうかに関する情報を返します。グループの管理者ロールを変更できるのはタイトル クレーム所有者のみです。 |
| [PFGroupsUpdateGroupResponse](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsupdategroupresponse.md) | PFGroupsUpdateGroupResponse データ モデル。 |
| [PFGroupsUpdateGroupRoleRequest](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsupdategrouprolerequest.md) | PFGroupsUpdateGroupRoleRequest データ モデル。ロール名を更新します。更新が成功したかどうかに関する情報を返します。 |
| [PFGroupsUpdateGroupRoleResponse](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsupdategrouproleresponse.md) | PFGroupsUpdateGroupRoleResponse データ モデル。 |


## Related topics

- [PFGroupsGroupBlock](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsgroupblock.md)
- [PFGroupsGroupInvitation](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsgroupinvitation.md)
- [PFGroupsGroupRole](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsgrouprole.md)
- [PFGroupsGroupWithRoles](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsgroupwithroles.md)
- [PFGroupsGroupApplication](https://docs.xbox.com/ja-jp/services/playfab/api-references/c/pfgroupstypes/structs/pfgroupsgroupapplication.md)