Groupe

Chemin /{group-id}

Représente un groupe Workplace. Le nœud /{group-id} renvoie un groupe unique.

Groupes inter-entreprises

Certains points doivent être pris en compte en cas d’accès à des groupes interentreprises :

  • Toute application d’intégration installée dans une entreprise appartenant à un groupe interentreprise peut lire le contenu du groupe
  • Les groupes interentreprises sont répertoriés dans des communautés ou des groupes en même temps que les groupes standards
    • Le champ purpose peut servir à identifier les groupes inter-entreprises et doit alors être défini sur la valeur WORK_MULTI_COMPANY
  • Les membres du groupe peuvent également faire l’objet d’une requête, mais seuls les champs id, name et picture seront visibles si une application provient d’une entreprise différente de celle de l’utilisateur
  • Les intégrations dotées de l’autorisation Gérer le groupe peuvent ajouter et supprimer des membres de groupes inter-entreprises
    • Une intégration peut uniquement ajouter et supprimer les utilisateurs qui sont des membres de la communauté sur laquelle elle est installée.
    • Une intégration ne peut ajouter et supprimer des utilisateurs que si l’un·e des admins de groupe est un membre de la communauté sur laquelle l’intégration est installée
  • Une intégration dotée de l’autorisation Gérer le contenu du groupe peut supprimer le contenu d’un groupe interentreprise dans l’un des cas suivants :
    • Le contenu appartient à un membre de la communauté de l’application, ou
    • Un membre de la communauté de l’application est admin de groupe
  • La publication dans des groupes interentreprises n’est pas disponible pour l’instant
  • Les groupes interentreprises peuvent être sélectionnés dans le paramètre de définition de groupe pour les intégrations
  • Les bots ne peuvent pas être mentionnés dans des groupes interentreprises

Lecture

Vous pouvez lire des informations sur un groupe en envoyant une requête GET d’API Graph au nœud /{group-id}.

Autorisations

La lecture du nœud Groupe nécessite l’autorisation Lire le contenu du groupe.

Champs

Nom du champDescriptionType de données

id

ID de groupe.

string

cover

Informations sur la photo de couverture du groupe.

CoverPhoto

cover_url

URL contenant une image pour la photo de couverture du groupe.

string

description

Brève description du groupe.

string

icon

URL de l’icône du groupe.

url

is_workplace_default

Indique s’il s’agit d’un groupe Workplace par défaut (lecture seule).

boolean

is_community

Indique si le groupe est aussi une communauté pouvant contenir d’autres groupes (lecture seule).

boolean

name

Nom du groupe.

string

owner

Membre ayant créé ce groupe.

User

privacy

Paramètre de confidentialité du groupe. Valeurs possibles :

  • CLOSED
  • OPEN
  • SECRET

string

updated_time

Dernière fois où le groupe a été mis à jour. Cela inclut les modifications des propriétés du groupe, ainsi que les modifications des publications et des commentaires.

datetime

archived

Indique si le groupe a été archivé.

boolean

post_requires_admin_approval

Indique si les publications dans le groupe nécessiteront l’approbation de l’admin.

boolean

purpose

Indique l’objectif du groupe.

enum {WORK_ANNOUNCEMENT, WORK_FEEDBACK, WORK_TEAMWORK, WORK_SOCIAL, WORK_MULTI_COMPANY}


Obsolète : WORK_FOR_SALE, WORK_TEAM

post_permissions

Indique si une publication nécessite l’approbation de l’admin.

enum {NONE, ADMIN_ONLY}

join_setting

Indique la manière dont de nouveaux membres peuvent rejoindre le groupe.

enum {NONE, ANYONE, ADMIN_ONLY}

sorting_setting

Indique l’ordre des publications renvoyées pour les arêtes /feed, défini par défaut sur CHRONOLOGICAL.

enum {RECENT_ACTIVITY, CHRONOLOGICAL}

is_official_group

Indique si le groupe est un groupe Workplace officiel. Une icône indiquant qu’il s’agit d’un groupe officiel apparaîtra à coté du nom du groupe dans le produit.

boolean

Publication

Vous ne pouvez pas effectuer de publication à l’aide de cette arête. Pour créer un groupe, effectuez une publication dans l’arête /community/groups.

Suppression

Vous ne pouvez pas supprimer de groupe à l’aide de ce nœud. La suppression du dernier membre d’un groupe supprime automatiquement ce groupe.

Mise à jour

Vous pouvez mettre à jour un groupe en envoyant une requête POST d’API Graph au nœud /{group-id} et en transmettant les valeurs des champs à mettre à jour dans le corps de la requête.

Autorisations

Les mises à jour d’un nœud de groupe nécessitent l’autorisation Gérer les groupes.

Arêtes

Nom de l’arêteDescription

/admins

Admins d’un groupe Workplace. L’ajout et la suppression d’admins sont pris en charge sur Workplace. Reportez-vous aux exemples fournis ci-dessous.

/albums

Albums photo d’un groupe Workplace.

/auto_membership_rules

Règles concernant l’ajout automatique de membres à un groupe.

/docs

Documents d’un groupe Workplace.

/events

Évènements d’un groupe Workplace.

/feed

Publications d’un groupe Workplace, organisées en fil.

/files

Fichiers partagés dans un groupe Workplace.

/member_requests

Requêtes d'adhésion en attente pour les groupes dont les approbations d'adhésion sont activées.

/members

Membres d’un groupe Workplace. Cette arête expose les valeurs suivantes :

  • administrator : s’affiche si cette personne est admin du groupe
  • joined : s’affiche si cet utilisateur a rejoint le groupe
  • moderator : s’affiche si cette personne est un modérateur du groupe
  • ajouté_par : s’affiche pour indiquer la personne ayant ajouté cet utilisateur au groupe

/moderators

Modérateurs d’un groupe Workplace.

/pinned_posts

Publication épinglée au groupe.

/groups

Liste de tous les groupes enfants (uniquement applicable aux groupes qui sont aussi des communautés)

Exemples

Obtenir l’ID, le nom, le statut d’archivage et la confidentialité d’un groupe :

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

Archiver un groupe :

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

Obtenir les membres d’un groupe contenant leur nom, leur ID et la date à laquelle ils ont rejoint le groupe :

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

Obtenir les admins et les modérateurs d’un groupe dans un même appel :

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

Obtenir les documents d’un groupe :

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

Obtenir les publications d’un groupe :

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

Obtenir les publications d’un groupe classées par date de dernière mise à jour :

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

Paramètres

sorting_setting

Autorise le classement des publications par date de dernière mise à jour plutôt que par date de création lorsque ce paramètre est défini sur RECENT_ACTIVITY. Le comportement par défaut peut être explicitement défini à l’aide de la valeur CHRONOLOGICAL. Les mises à jour peuvent inclure les modifications de la publication, ainsi qu’un commentaire ou qu’une réaction ayant été ajoutés.

Obtenir les publications d’un groupe, y compris les pièces jointes supplémentaires comme des vidéos, des images, des fichiers ou des sondages :

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

Les options de sondage sont répertoriées dans l’ordre décroissant en fonction du nombre de votes pour chaque option.

Obtenir la liste des membres d’un groupe, avec la date à laquelle ils ont rejoint le groupe :

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

Ajouter un membre à un groupe par son ID :

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

Ajouter un membre à un groupe par son adresse e-mail :

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

Lorsque vous incluez des adresses e-mail dans l’URL pour une requête, assurez-vous que ces adresses sont encodées au format URL. Exemple : michael@example.com devient michael%40example.com.

La suppression du dernier membre d’un groupe planifie la suppression de ce groupe.

Supprimer un membre d’un groupe par son ID :

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

Supprimer un membre d’un groupe par son adresse e-mail :

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

Lorsque vous incluez des adresses e-mail dans l’URL pour une requête, assurez-vous que ces adresses sont encodées au format URL. Exemple : michael@example.com devient michael%40example.com.

Promouvoir un membre en tant qu’admin d’un groupe :

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

Rétrograder un admin en tant que membre d’un groupe :

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

Créer un événement dans un groupe :

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

Importer une nouvelle photo (via un binaire) dans un groupe :

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

Importer une nouvelle photo (via une URL) dans un groupe :

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

Créer des publications de groupe avec des pièces jointes de type image et vidéo :

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

Paramètres

attached_media

Utilisé pour les photos et vidéos, avec un ensemble d’éléments media_fbids indiqués entre accolades. Prend en charge les formats d’image suivants : .jpeg, .bmp, .png, .gif, .tiff. Pour plus d’informations sur les formats d’image, consultez cette page. Les fichiers vidéo pris en charge sont décrits sur cette page. Pour obtenir les éléments media_fbids correspondant aux images, commencez par publier les photos non publiées dans https://graph.facebook.com/me/photos, comme décrit sur cette page. Pour obtenir les éléments media_fbids relatifs aux vidéos (y compris les fichiers GIF animés), commencez par publier ces vidéos dans https://graph.facebook.com/me/videos?no_story=true.

La définition du paramètre no_story sur true supprime l’actualité du fil qui est générée automatiquement sur le profil d’une personne lorsqu’elle importe une vidéo via votre application.

Créer des publications de groupe avec des pièces jointes de type fichier :

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

Paramètres

files

Utilisé pour les fichiers, avec un ensemble d’éléments file_ids (notez qu’ils ne sont pas indiqués entre accolades). La gestion des versions de fichier n’est pas prise en charge pour l’instant. Pour mettre à jour des fichiers, supprimez le fichier original des pièces jointes de la publication, puis réimportez une nouvelle pièce jointe de type fichier. Prend en charge les formats de fichier suivants :

  • Documents : .pdf, .csv, .tsv, .docx, .pptx, .xlsx
  • Images : .jpeg, .png
  • Vidéos : .mp4
  • Archives : .rar, .zip

Pour obtenir les éléments file_ids, commencez par publier les fichiers dans https://graph.facebook.com/group_file_revisions. Vous pouvez publier des fichiers sources en local depuis votre ordinateur.

Vous ne pouvez pas combiner les paramètres attached_media et files dans un même appel d’API. Cette règle reflète le comportement de l’éditeur de groupe, qui offre des options distinctes pour l’importation d’une photo/vidéo et pour celle d’un fichier.

Mettre à jour les autorisations de publication, les paramètres pour rejoindre un groupe, la finalité et les paramètres d’approbation de publication

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

Obtenir les réactions et les commentaires concernant la publication épinglée

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

Identifier si un groupe est également une communauté

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

Obtenir les règles d’adhésion à un groupe

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

Exemple de réponse (JSON) :

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

Supprimer une règle d’adhésion automatique pour un groupe

DELETE graph.facebook.com
  /RULE_ID

Appliquer une règle d’adhésion à un groupe

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

Exemple de charge utile :

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

Une mauvaise manipulation de cette API peut entraîner l’ajout de milliers d’utilisateur·ices à un groupe. Par conséquent, utilisez-la avec une extrême prudence et vérifiez soigneusement l’appel d’API avant de l’exécuter.

Obtenir l’ID de groupe et le statut de groupe officiel :

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

Mettre à jour le statut de groupe officiel :

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