Group Information

グループに関する情報。

リソース

1/chatter/groups/groupId

1/connect/communities/communityId/chatter/groups/groupId

使用可能なバージョン

23.0

Chatter が必要かどうか

はい

HTTP のメソッド

GET、DELETE、HEAD、PATCH

PATCH はバージョン 28.0 以降でサポートされます。

DELETE はバージョン 29.0 以降でサポートされます。

PATCH のリクエストボディ

Group Input

ルート XML タグ

1<group>

JSON

1{
2   "announcement" : "0D5D0000000K4XT",
3   "canHaveChatterGuests" : "true",
4   "description" : "This group is building a powerful API.",
5   "information" : {
6      "text" : "Read this section before you post to the group.",
7      "title" : "Information"
8   },
9   "isArchived" : "false",
10   "isAutoArchiveDisabled" : "false",
11   "name" : "Chatter API",
12   "owner" : "00590000000DmPw",
13   "visibility" : "PublicAccess"
14}

プロパティ

名前	型	説明	使用可能なバージョン
announcement	String	お知らせ ID。 お知らせは、削除されるか、別のお知らせで置き換えられない限り、その表示期限の 11:59 p.m. まで Salesforce UI の指定の場所に表示されます。	31.0
canHaveChatterGuests	Boolean	このグループで Chatter 顧客を許可している場合は true、それ以外の場合は false。このプロパティを true に設定した後で、false に設定することはできません。	29.0
description	String	グループの [説明] セクション	29.0
information	Group Information Input	グループの [情報] セクショングループが非公開の場合は、[情報] セクションはメンバーにのみ表示されます。[説明] セクションは全員に表示されます。	28.0
isArchived	Boolean	グループがアーカイブ済みの場合は true、それ以外の場合は false。デフォルトは false です。	29.0
isAutoArchiveDisabled	Boolean	グループの自動アーカイブが無効の場合は true、それ以外の場合は false。デフォルトは false です。	29.0
isBroadcast	Boolean	グループ所有者およびグループマネージャのみがグループで投稿を作成できる場合は true、それ以外の場合は false。デフォルトは false です。	36.0
name	String	グループの名前	29.0
owner	String	グループ所有者の ID。このプロパティは、PATCH 要求でのみ使用できます。	29.0
visibility	String	グループの表示種別。次のいずれかの値になります。 PrivateAccess — グループのメンバーのみが、このグループへの投稿を参照できます。 PublicAccess — Experience Cloud サイトのすべてのユーザが、このグループへの投稿を参照できます。 Unlisted — 今後の使用のために予約されています。	29.0

Group Information Input

JSON

1{
2   "text" : "Post questions about the API.",
3   "title" : "API Questions"
4}

プロパティ

名前	型	説明	使用可能なバージョン
text	String	グループの [情報] セクション内のテキスト。HTML はサポートされていません。最大文字数は 4000 文字 (バイト) です。	28.0
title	String	グループの [情報] セクションのタイトル。最大文字数は 240 文字 (バイト) です。	28.0

PATCH の要求パラメータ

プロパティ	型	説明	必須か省略可能	使用可能なバージョン
announcement	String	お知らせとして使用するフィード項目の ID。 お知らせは、削除されるか、別のお知らせで置き換えられない限り、その表示期限の 11:59 p.m. まで Salesforce UI の指定の場所に表示されます。	省略可能	31.0
canHave​ChatterGuests	Boolean	このグループで Chatter 顧客を許可している場合は true、それ以外の場合は false。このプロパティを true に設定した後で、false に設定することはできません。	省略可能	29.0
description	String	グループの [説明] セクション。	省略可能	29.0
information​Text	String	グループの [情報] セクション。グループが非公開の場合は、[情報] セクションはメンバーにのみ表示されます。[説明] セクションは全員に表示されます。	省略可能	28.0
information​Title	String	グループの「情報」セクションのタイトル。	省略可能	28.0
isArchived	String	グループがアーカイブ済みの場合は true、それ以外の場合は false。デフォルトは false です。	省略可能	29.0
isAutoArchive​Disabled	Boolean	グループの自動アーカイブが無効の場合は true、それ以外の場合は false。デフォルトは false です。	省略可能	29.0
isBroadcast	Boolean	グループ所有者およびグループマネージャのみがグループで投稿を作成できる場合は true、それ以外の場合は false。デフォルトは false です。	省略可能	36.0
name	String	グループの名前。	省略可能	29.0
owner	String	グループ所有者の ID。このプロパティは、PATCH 要求でのみ使用できます。	省略可能	29.0
visibility	String	グループの表示種別。次のいずれかの値になります。 PrivateAccess — グループのメンバーのみが、このグループへの投稿を参照できます。 PublicAccess — Experience Cloud サイトのすべてのユーザが、このグループへの投稿を参照できます。 Unlisted — 今後の使用のために予約されています。	省略可能	29.0

GET および PATCH のレスポンスボディ

Group Detail

PATCH の例

このリクエストボディは、グループの [情報] セクションのテキストとタイトルを更新します。

1{
2   "information" : {
3      "text" : "Post questions about the API to this group. If you have the answer to a question, please post it. This is a private R&D group.",
4      "title" : "API Questions Group"
5   }
6}

次は、同じ例に要求パラメータを使用しています。

1https://instance_name/services/data/56.0/chatter/groups/groupId
2?informationText=Post+questions+about+the+API+to+this+group.+If+you+have+the+answer+to+a+question%2C%20
3+please+post+it.+This+is+a+private+R%26amp%3Bamp%3BD+group.&informationTitle=API+Questions+Group

応答は Group Detail レスポンスボディです。