グループ

パス/{group-id}

Workplaceグループを表します。/{group-id}ノードは単一のグループを返します。

会社間グループ

会社間グループにアクセスする場合に考慮しなければならない特定の注意事項があります:

• グループコンテンツは、会社間グループに属する会社にインストールされている統合の任意のアプリによって読み取り可能です
• コミュニティまたはグループの中で、会社間グループは正規のグループと共に表示されます

  • 会社間グループは、purposeフィールドを使用して識別できます。その値はWORK_MULTI_COMPANYに設定されています
• また、グループメンバーについてもクエリを実行できますが、アプリがユーザーとは異なる会社のものの場合に表示されるのは、id、name、pictureだけです
• グループの管理のアクセス許可を付与された統合では、会社間グループのメンバーを追加したり削除したりできます

  • 統合で追加や削除ができるのは、その統合のインストール先のコミュニティのメンバーであるユーザーだけです
  • 統合でユーザーの追加や削除ができるのは、そのグループの管理者の1人がその統合のインストール先のコミュニティのメンバーである場合だけです
• グループコンテンツの管理のアクセス許可を付与された統合では、以下のいずれかの場合に、会社間グループ内に含まれるコンテンツを削除できます:

  • コンテンツがアプリコミュニティのメンバーに属している、または
  • アプリコミュニティのメンバーの1人がグループ管理者である
• 現在のところ会社間グループへの公開機能は利用可能ではありません
• 統合のグループ範囲設定において、会社間グループを選択できます
• 会社間グループの中でボットへのメンションはできません

読み取り

グループについての情報は、/{group-id}に対してグラフAPIのGETリクエストを発行することによって読み取ることができます。

アクセス許可

グループノードを読み取るには、グループコンテンツの読み取りのアクセス許可が必要です。

フィールド

公開

このエッジを使用して公開することはできません。グループを作成するには、/community/groupsエッジに公開します。

削除

このノードを使用してグループを削除することはできません。グループに残っている最後のメンバーを削除すると、自動的にそのグループが削除されます。

更新

グループは、/{group-id}に対するグラフAPIのPOSTリクエストを発行し、更新するフィールドの値をリクエスト本体の中で渡すことによって更新できます。

アクセス許可

グループノードに更新を加えるには、グループの管理のアクセス許可が必要です。

エッジ

例

グループのID、名前、アーカイブステータス、プライバシー設定を取得する:

GET graph.facebook.com
  /{group-id}?fields=id,name,archived,privacy

グループをアーカイブする:

POST graph.facebook.com
  /{group-id}?archive=true

グループメンバーとその名前、ID、参加日付を取得する:

GET graph.facebook.com
  /{group-id}/members?fields=name,id,joined

1回の呼び出しでグループの管理者およびモデレーターを取得する:

GET graph.facebook.com
  /{group-id}?fields=admins,moderators

グループのドキュメントを取得する:

GET graph.facebook.com
  /{group-id}/docs

グループの投稿を取得する:

GET graph.facebook.com
  /{group-id}/feed

最終更新時刻の順にグループの投稿を取得する:

GET graph.facebook.com
  /{group-id}/feed?sorting_setting=RECENT_ACTIVITY

パラメーター

sorting_setting

RECENT_ACTIVITYに設定されている場合、投稿は、作成時刻ではなく最終更新時刻の順になります。デフォルトの動作は、CHRONOLOGICALを値として使用することにより明示的に設定できます。更新には、投稿に加えられた編集内容と共に、追加されたコメントまたはリアクションが含まれることがあります。

グループの投稿を取得する(動画、画像、ファイル、またはアンケートなどの付加的な添付物を含む):

GET graph.facebook.com
  /{group-id}/feed?fields=attachments

グループメンバー、およびその参加日付のリストを取得する:

GET graph.facebook.com
  /{group-id}/members?fields=name,joined

メンバーをIDによりグループに追加する:

POST graph.facebook.com
  /{group-id}/members/{member-id}

メンバーをメールによりグループに追加する:

POST graph.facebook.com
  /{group-id}/members?email=michael%40example.com

IDによりグループからメンバーを削除する:

DELETE graph.facebook.com
  /{group-id}/members/{member-id}

メールによりグループからメンバーを削除する:

DELETE graph.facebook.com
  /{group-id}/members?email=michael%40example.com

メンバーをグループ管理者に昇格させる:

POST graph.facebook.com
  /{group-id}/admins/{user-id}

グループ管理者をメンバーに降格させる:

DELETE graph.facebook.com
  /{group-id}/admins/{user-id}

グループの中に新しいイベントを作成する:

POST graph.facebook.com
  /{group-id}/events
  ?name=New+Event
  &start_time=2017-03-02T14:00:04+00:00
  &end_time=2017-03-02T15:00:04+00:00
  &description=Test+Description
  &location=Boardroom

新しい写真をグループにアップロードする(バイナリによる):

POST graph.facebook.com
  /{group-id}/photos?source={image-data}

新しい写真を(URL経由で)グループにアップロードする:

POST graph.facebook.com
  /{group-id}/photos?url={image-data}

画像&動画の添付ファイルを伴うグループ投稿を作成する:

POST graph.facebook.com
  /{group-id}/feed?attached_media=[{"media_fbid":"{photo-id}"},{"media_fbid":"{photo-id}"}]

パラメーター

attached_media

写真&動画で使用する場合は、大括弧で囲んだmedia_fbidsの配列。画像の形式としては、.jpeg、.bmp、.png、.gif、.tiffがサポートされています。画像の形式について詳しくは、こちらをご覧ください。サポートされる動画ファイルについては、こちらをご覧ください。画像のmedia_fbidsを取得するには、未公開の写真をまずhttps://graph.facebook.com/me/photosに公開します。こちらにあるドキュメントをご覧ください。動画(アニメーションGIFを含む)のmedia_fbidsを取得するには、動画をまずhttps://graph.facebook.com/me/videos?no_story=trueに公開してください。

添付ファイルを伴うグループ投稿を作成する:

POST graph.facebook.com
  /{group-id}/feed?files=[{file-id},{file-id}]

パラメーター

files

ファイルに対して使用する場合、file_idsの配列(大括弧で囲まないことに注意)。現在のところ、ファイルのバージョン管理はサポートされていません。ファイルを更新するには、投稿の元の添付ファイルを削除してから、新しい添付ファイルを再アップロードしてください。以下のファイル形式がサポートされています:

• ドキュメント: .pdf、.csv、.tsv、.docx、.pptx、.xlsx
• 画像: .jpeg、.png
• 動画: .mp4
• アーカイブ: .rar、.zip

file_idsを取得するには、ファイルをまずhttps://graph.facebook.com/group_file_revisionsに公開してください。自分のコンピューターからソースファイルをローカルに公開するかもしれません。

投稿のアクセス許可、参加の設定、目的、投稿承認の設定を更新する

POST graph.facebook.com
  /{group-id}/?post_permissions=NONE&join_setting=ADMIN_ONLY&purpose=WORK_SOCIAL&post_requires_admin_approval=false

固定された投稿へのリアクションとコメントを取得する

GET graph.facebook.com
  /{group-id}/pinned_posts?fields=reactions,comments

グループがコミュニティでもあるかどうかを調べる

GET graph.facebook.com
  /{group-id}?fields=is_community

グループのメンバー承認ルールを取得する

GET graph.facebook.com
  /{group-id}/auto_membership_rules

応答の例(JSON):

{
  "data": [
    {
      "conditions": [
        {
          "field": "TITLE",
          "operator": "CONTAINS",
          "values": [
            "sales"
          ]
        }
      ],
      "id": RULE_ID
    }
  ],
  ...
}

グループの自動メンバー承認ルールを削除する

DELETE graph.facebook.com
  /RULE_ID

メンバー承認ルールをグループに適用する

POST graph.facebook.com
  /{group-id}/auto_membership_rules

ペイロードの例:

{
    "conditions": [
        {
            "field": "LOCATION",
            "operator": "CONTAINS",
            "values": ["London", "San Francisco"]
        }
    ]
  }

グループIDと公式グループのステータスを取得する:

GET graph.facebook.com
  /{group-id}?fields=id,is_official_group

公式グループのステータスを更新する:

POST graph.facebook.com
  /{group-id?is_official_group={FALSE | TRUE}