Gruppe

Pfad `/{group-id}`

Repräsentiert eine Workplace-Gruppe. Der /{group-id}-Node gibt eine einzelne Gruppe zurück.

Unternehmensübergreifende Gruppen

Beim Zugriff auf unternehmensübergreifende Gruppen solltest du Folgendes berücksichtigen:

Gruppeninhalte können von jeder integrierten App gelesen werden, die in einem Unternehmen installiert ist, das Teil einer unternehmensübergreifenden Gruppe ist.
Unternehmensübergreifende Gruppen werden in Communitys oder Gruppen zusammen mit regulären Gruppen aufgeführt.
- Über das Feld „Zweck“ lassen sich unternehmensübergreifende Gruppen identifizieren. Für diesen Wert muss WORK_MULTI_COMPANY festgelegt werden.
Gruppenmitglieder sind ebenfalls abfragbar, aber nur id, name und picture sind sichtbar, wenn eine App aus einem anderen Unternehmen als der Benutzer stammt.
Integrationen mit der Berechtigung Gruppe verwalten können unternehmensübergreifende Gruppenmitglieder hinzufügen und entfernen.
- Integrationen können nur Benutzer hinzufügen und entfernen, die Mitglieder der Community sind, in der die Integration installiert ist.
- Integrationen können nur dann Benutzer hinzufügen und entfernen, wenn einer der Administratoren der Gruppe ein Mitglied der Community ist, in der die Integration installiert ist.
Eine Integration mit der Berechtigung Gruppeninhalte verwalten kann Inhalte innerhalb einer unternehmensübergreifenden Gruppe löschen, wenn entweder:
- der Inhalt einem Mitglied der App-Community gehört, oder
- ein Mitglied der App-Community ein Administrator der Gruppe ist.
Die Veröffentlichung in unternehmensübergreifenden Gruppen ist derzeit nicht möglich.
Unternehmensübergreifende Gruppen können in der Gruppenumfangseinstellung für Integrationen festgelegt werden.
Bots können nicht in unternehmensübergreifenden Gruppen erwähnt werden.

Lesen

Du kannst Informationen über eine Gruppe lesen, indem du über die Graph API eine GET-Anfrage an /{group-id} stellst.

Berechtigungen

Für das Lesen eines Gruppen-Knotens ist die Berechtigung Gruppeninhalte lesen erforderlich.

Felder

Name des Feldes	Beschreibung	Datentyp
`id`	Die Gruppen-ID.	`string`
`cover`	Informationen zum Titelbild der Gruppe.	`CoverPhoto`
`cover_url`	Eine URL, die eine Bilddatei für das Titelbild der Gruppe enthält.	`string`
`description`	Eine kurze Beschreibung der Gruppe.	`string`
`icon`	Die URL für das Symbol der Gruppe.	`url`
`is_workplace_default`	Gibt an, ob es sich bei der Gruppe um eine Standard-Workplace-Gruppe handelt (nur lesen).	`boolean`
`is_community`	Gibt an, ob die Gruppe auch eine Community ist und andere Gruppen enthalten kann (nur lesen).	`boolean`
`name`	Der Name der Gruppe.	`string`
`owner`	Das Mitglied, das diese Gruppe erstellt hat.	`User`
`privacy`	Die Privatsphäre-Einstellungen der Gruppe. Mögliche Werte: `CLOSED` `OPEN` `SECRET`	`string`
`updated_time`	Das letzte Mal, als die Gruppe aktualisiert wurde. Dazu gehören Änderungen an den Gruppeneigenschaften sowie Änderungen an Beiträgen und Kommentaren.	`datetime`
`archived`	Gibt an, ob die Gruppe archiviert wurde.	`boolean`
`post_requires_admin_approval`	Gibt an, ob Beiträge für die Gruppe von einem Administrator genehmigt werden müssen.	`boolean`
`purpose`	Gibt den Zweck der Gruppe an.	`enum {WORK_ANNOUNCEMENT, WORK_FEEDBACK, WORK_TEAMWORK, WORK_SOCIAL, WORK_MULTI_COMPANY}` Veraltet: `WORK_FOR_SALE, WORK_TEAM`
`post_permissions`	Gibt an, ob ein Beitrag vom Administrator genehmigt werden muss.	`enum {NONE, ADMIN_ONLY}`
`join_setting`	Gibt an, wie neue Mitglieder der Gruppe beitreten können.	`enum {NONE, ANYONE, ADMIN_ONLY}`
`sorting_setting`	Gibt die Reihenfolge der Beiträge an, die für `/feed`-Edges zurückgegeben werden. Standardmäßig ist `CHRONOLOGICAL` eingestellt.	`enum {RECENT_ACTIVITY, CHRONOLOGICAL}`
`is_official_group`	Gibt an, ob es sich bei der Gruppe um eine offizielle Workplace-Gruppe handelt. Ein offizielles Gruppensymbol wird neben dem Namen der offiziellen Gruppe im Produkt angezeigt.	`boolean`

Veröffentlichung

Mit dieser Edge ist das Veröffentlichen nicht möglich. Um eine Gruppe zu erstellen, veröffentliche mit der /community/groups-Edge.

Löschen

Mit diesem Node kannst du keine Gruppen löschen. Wenn du das letzte Mitglied aus einer Gruppe entfernst, wird die Gruppe automatisch gelöscht.

Aktualisieren

Du kannst eine Gruppe aktualisieren, indem du über die Graph API eine POST-Anfrage an /{group-id} stellst und Werte für die zu aktualisierenden Felder im Anfragetext übergibst.

Berechtigungen

Für das Aktualisieren von Gruppenknoten ist die Berechtigung Gruppen verwalten erforderlich.

Edges

Edge-Name	Beschreibung
`/admins`	Die Administratoren einer Workplace-Gruppe. Workspace unterstützt das Hinzufügen und Löschen von Administratoren. Siehe Beispiele weiter unten.
`/albums`	Die Fotoalben in einer Workplace-Gruppe.
`/auto_membership_rules`	Die Regeln für das automatische Hinzufügen von Mitgliedern zu einer Gruppe.
`/docs`	Die Dokumente in einer Workplace-Gruppe.
`/events`	Die Events in einer Workplace-Gruppe.
`/feed`	Die Beiträge in einer Workplace-Gruppe, die in einem Feed angeordnet sind.
`/files`	Die in einer Workplace-Gruppe freigegebenen Dateien.
`/member_requests`	Die offenen Mitgliedschaftsanfragen für Gruppen, bei denen die Mitgliedschaftsgenehmigung aktiviert wurde.
`/members`	Die Mitglieder einer Workplace-Gruppe. Diese Edge stellt folgende Informationen zu Mitgliedern zur Verfügung: administrator: Wird angezeigt, wenn diese Person ein Administrator der Gruppe ist. joined: Wird angezeigt, wenn dieser Benutzer der Gruppe beigetreten ist. moderator: Wird angezeigt, wenn diese Person ein Moderator der Gruppe ist. added_by: Zeigt an, wer diesen Benutzer zur Gruppe hinzugefügt hat.
`/moderators`	Die Moderatoren einer Workplace-Gruppe.
`/pinned_posts`	Der Beitrag, der in der Gruppe fixiert wurde.
`/groups`	Liste der untergeordneten Gruppen (gilt nur für Gruppen, die auch Communitys sind).

Beispiele

Abrufen von Gruppen-ID, Name, Archivstatus und Privatsphäre:

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

Archivieren einer Gruppe:

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

Abrufen von Gruppenmitgliedern mit Name, ID und Beitrittsdatum:

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

Abrufen der Administratoren und Moderatoren einer Gruppe mit einem einzigen Aufruf:

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

Abrufen von Gruppendokumenten:

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

Abrufen von Gruppenbeiträgen:

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

Abrufen von Gruppenbeiträgen in der Reihenfolge der letzten Aktualisierung:

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

Parameter

sorting_setting

Durch die Festlegung auf RECENT_ACTIVITY können Beiträge nach dem Zeitpunkt der letzten Aktualisierung statt nach dem Zeitpunkt des Erstellens sortiert werden. Das Standardverhalten kann explizit festgelegt werden, indem CHRONOLOGICAL als Wert verwendet wird. Aktualisierungen können sowohl Bearbeitungen des Beitrags als auch ein neuer Kommentar oder eine neue Reaktion sein.

Abrufen von Gruppenbeiträgen mit zusätzlichen Anhängen wie Videos, Bildern, Dateien oder Umfragen:

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

Die Umfrageoptionen werden in absteigender Reihenfolge nach der Anzahl der Stimmen für jede Option aufgelistet.

Abrufen einer Liste von Gruppenmitgliedern zusammen mit ihrem Beitrittsdatum:

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

Hinzufügen eines Mitglieds zu einer Gruppe mithilfe der ID:

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

Hinzufügen eines Mitglieds zu einer Gruppe mithilfe der E-Mail-Adresse:

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

Wenn du E-Mail-Adressen in die URL für eine Anfrage einfügst, dann vergewissere dich, dass die E-Mail-Adressen URL-kodiert sind. Beispiel: michael@example.com wird zu michael%40example.com.

Wenn du das letzte Mitglied aus einer Gruppe entfernst, wird diese Gruppe zum Löschen eingeplant.

Entfernen eines Mitglieds aus einer Gruppe mithilfe der ID:

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

Entfernen eines Mitglieds aus einer Gruppe mithilfe der E-Mail-Adresse:

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

Wenn du E-Mail-Adressen in die URL für eine Anfrage einfügst, dann vergewissere dich, dass die E-Mail-Adressen URL-kodiert sind. Beispiel: michael@example.com wird zu michael%40example.com.

Heraufstufen eines Mitglieds zum Administrator einer Gruppe:

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

Herabstufen eines Administrators zum Mitglied einer Gruppe:

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

Erstellen eines neuen Events in einer Gruppe:

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

Hochladen eines neuen Fotos (via Binärdatei) in eine Gruppe:

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

Hochladen eines neuen Fotos (via URL) in eine Gruppe:

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

Erstellen von Gruppenbeiträgen mit Bild- und Videoanhängen:

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

Parameter

attached_media

Wird für Fotos und Videos verwendet. Ein Array von media_fbids, das in geschweiften Klammern gefasst wird. Unterstützt die folgenden Bildformate: .jpeg, .bmp, .png, .gif, .tiff. Weitere Informationen zu Bildformaten findest du hier. Die unterstützten Videodateien findest du hier. Um media_fbids für Bilder zu erhalten, veröffentliche bitte zunächst unveröffentlichte Fotos auf https://graph.facebook.com/me/photos, wie hier in der Dokumentation beschrieben. Um media_fbids für Videos (auch animierte GIFs) zu erhalten, veröffentliche die Videos bitte zuerst auf https://graph.facebook.com/me/videos?no_story=true.

Wenn du den Parameter no_story auf „true“ setzt, wird die Feed-Story unterdrückt, die automatisch im Profil einer Person generiert wird, wenn diese mit deiner App ein Video hochlädt.

Erstellen von Gruppenbeiträgen mit Dateianhängen:

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

Parameter

files

Wird für Dateien verwendet. Ein Array aus file_ids (diese werden nicht in geschweifte Klammern gefasst). Die Versionskontrolle für Dateien wird derzeit nicht unterstützt. Um Dateien zu aktualisieren, entferne bitte die ursprüngliche Datei aus den Beitragsanhängen und lade einen neuen Dateianhang hoch. Unterstützt die folgenden Dateiformate:

Dokumente: .pdf, .csv, .tsv, .docx, .pptx, .xlsx
Bilder: .jpeg, .png
Videos: .mp4
Archive: .rar, .zip

Um file_ids zu erhalten, veröffentliche die Dateien bitte zuerst auf https://graph.facebook.com/group_file_revisions. Du kannst Quelldateien lokal von deinem Computer aus veröffentlichen.

Du kannst die Parameter attached_media und files nicht in einem API-Aufruf kombinieren. Diese Funktion ahmt das Verhalten des Group Composers nach, der separate Optionen für das Hochladen von Fotos/Videos und von Dateien besitzt.

Aktualisieren von Beitragsberechtigungen, Beitrittseinstellungen, Zweck und Einstellungen für die Beitragsfreigabe

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

Abrufen von Reaktionen und Kommentaren zum fixierten Beitrag

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

Bestimmen, ob eine Gruppe auch eine Community ist

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

Abrufen der Mitgliedschaftsregeln für eine Gruppe

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

Beispielantwort (JSON):

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

Löschen einer automatischen Beitrittsregel für eine Gruppe

DELETE graph.facebook.com
  /RULE_ID

Anwenden einer Beitrittsregel auf eine Gruppe

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

Beispiel-Payload:

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

Mit dieser API können potentiell Tausende von Nutzer*innen zu einer Gruppe hinzugefügt werden. Daher ist es extrem wichtig, beim Verfassen des Codes sorgfältig vorzugehen und ihn genau zu prüfen, bevor der API-Aufruf ausgeführt wird.

Gruppen-ID und offiziellen Gruppenstatus erhalten:

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

Offiziellen Gruppenstatus aktualisieren:

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

Gruppe

Pfad /{group-id}

Unternehmensübergreifende Gruppen

Lesen

Berechtigungen

Felder

Veröffentlichung

Löschen

Aktualisieren

Berechtigungen

Edges

Beispiele

Abrufen von Gruppen-ID, Name, Archivstatus und Privatsphäre:

Archivieren einer Gruppe:

Abrufen von Gruppenmitgliedern mit Name, ID und Beitrittsdatum:

Abrufen der Administratoren und Moderatoren einer Gruppe mit einem einzigen Aufruf:

Abrufen von Gruppendokumenten:

Abrufen von Gruppenbeiträgen:

Abrufen von Gruppenbeiträgen in der Reihenfolge der letzten Aktualisierung:

Abrufen von Gruppenbeiträgen mit zusätzlichen Anhängen wie Videos, Bildern, Dateien oder Umfragen:

Abrufen einer Liste von Gruppenmitgliedern zusammen mit ihrem Beitrittsdatum:

Hinzufügen eines Mitglieds zu einer Gruppe mithilfe der ID:

Hinzufügen eines Mitglieds zu einer Gruppe mithilfe der E-Mail-Adresse:

Entfernen eines Mitglieds aus einer Gruppe mithilfe der ID:

Entfernen eines Mitglieds aus einer Gruppe mithilfe der E-Mail-Adresse:

Heraufstufen eines Mitglieds zum Administrator einer Gruppe:

Herabstufen eines Administrators zum Mitglied einer Gruppe:

Erstellen eines neuen Events in einer Gruppe:

Hochladen eines neuen Fotos (via Binärdatei) in eine Gruppe:

Hochladen eines neuen Fotos (via URL) in eine Gruppe:

Erstellen von Gruppenbeiträgen mit Bild- und Videoanhängen:

Erstellen von Gruppenbeiträgen mit Dateianhängen:

Aktualisieren von Beitragsberechtigungen, Beitrittseinstellungen, Zweck und Einstellungen für die Beitragsfreigabe

Abrufen von Reaktionen und Kommentaren zum fixierten Beitrag

Bestimmen, ob eine Gruppe auch eine Community ist

Abrufen der Mitgliedschaftsregeln für eine Gruppe

Löschen einer automatischen Beitrittsregel für eine Gruppe

Anwenden einer Beitrittsregel auf eine Gruppe

Gruppen-ID und offiziellen Gruppenstatus erhalten:

Offiziellen Gruppenstatus aktualisieren:

Pfad `/{group-id}`