L'API Google Chat vous permet d'importer les données de vos autres plates-formes de messagerie dans Google Chat. Vous pouvez importer des messages, pièces jointes, réactions, abonnements et entités d'espaces existants depuis vos autres plates-formes de messagerie vers les ressources de l'API Chat correspondantes. Vous pouvez importer ces données en créant des espaces Chat en mode importation, puis en important des données dans ces espaces.
Vous trouverez ci-dessous un aperçu des étapes à suivre pour importer des données à l'aide d'un espace en mode importation:
- Passez en revue les limites d'utilisation de l'API et planifiez une stratégie.
- Configurez l'autorisation pour l'application Chat.
- Créer un espace en mode importation
- Importez des ressources.
- Validez les ressources importées.
- Rapprochez les différences entre les ressources importées et les données sources.
- Mode d'importation complet.
- Créez des ressources d'adhésion.
Conditions préalables
- Une application Chat. Pour en créer une, consultez la section Créer des applications Chat.
- Autorisation configurée pour l'application Chat. Celle-ci doit disposer d'une autorité déléguée au niveau du domaine dans tous les domaines dans lesquels l'application importe du contenu. Consultez la section Autoriser les applications Chat.
Examiner les limites d'utilisation de l'API et planifier l'opération
Le temps nécessaire à l'importation des données dans Chat peut varier considérablement en fonction de la quantité de ressources Chat à importer. Planifiez à l'avance en examinant les limites d'utilisation de votre application Chat et la quantité de données dont l'importation est programmée depuis la plate-forme de messagerie source, afin de déterminer une chronologie estimée.
Créer un espace en mode importation
Pour créer un espace en mode importation, appelez la méthode create sur la ressource Space et définissez importMode sur true. Afin de préserver l'heure de création de l'entité d'espace équivalente à partir de la plate-forme de messagerie source, vous pouvez définir le createTime de l'espace. Ce createTime doit être défini sur une valeur comprise entre le 1er janvier 2000 et aujourd'hui.
Notez le name de l'espace que vous créez afin de pouvoir le référencer ultérieurement lors de l'importation de contenu dans l'espace.
À partir du moment où la méthode create est appelée, les applications Chat disposent de 30 jours pour importer des ressources à l'exception des membres dans l'espace, terminer le mode d'importation et créer des ressources d'appartenance à l'aide du champ d'application chat.import. Les applications de chat peuvent toujours créer des abonnements après 30 jours avec les champs d'application d'adhésion standards de l'API Chat.
Au bout de 30 jours, si l'espace est toujours en mode importation, il est automatiquement supprimé et deviendra inaccessible et irrécupérable par l'application Chat. Prévoyez-le en consultant les limites d'utilisation de votre application Chat pour vous assurer que toutes les ressources planifiées pourront être importées dans Chat dans ce délai.
L'exemple suivant montre comment créer un espace en mode importation:
Apps Script ;
function createSpaceInImportMode() {
const space = Chat.Spaces.create({
spaceType: 'SPACE',
displayName: 'Import Mode Space',
importMode: true,
createTime: (new Date('January 1, 2000')).toJSON()
});
console.log(space.name);
}
Importer des ressources
Pour importer des ressources à partir d'autres plates-formes de messagerie, vous devez créer des ressources Google Chat (telles que des messages, des réactions et des pièces jointes) dans l'espace du mode importation. Lorsque vous créez une ressource dans l'espace, vous spécifiez les données de la ressource associée depuis la plate-forme de messagerie à partir de laquelle vous effectuez la migration.
Messages
Vos applications de chat peuvent importer des messages de leur propre autorité ou pour le compte d'un utilisateur via l'emprunt d'identité. (L'auteur du message est défini sur le compte de l'utilisateur dont l'identité a été empruntée.) Pour en savoir plus, consultez Autoriser les applications Chat.
Pour importer un message dans un espace en mode importation, appelez la méthode create sur la ressource Message.
Afin de conserver l'heure de création du message d'origine à partir de la plate-forme de messagerie source, vous pouvez définir le createTime du message. Cet élément createTime doit être défini sur une valeur comprise entre l'heure de création de l'espace que vous avez définie précédemment et l'heure actuelle.
Les messages d'un même espace ne peuvent pas contenir le même createTime, même si les messages précédents envoyés à l'heure indiquée sont supprimés.
Les messages contenant des URL tierces dans des espaces en mode importation ne peuvent pas afficher d'aperçus de liens dans Google Chat.
Lorsque vous créez les messages en mode importation, les espaces n'envoient aucune notification aux utilisateurs et n'envoient aucun e-mail, y compris les messages contenant des mentions utilisateur.
Réactions
Votre application Chat peut importer les réactions associées aux messages à l'aide de l'API Chat. Pour en savoir plus sur les méthodes de ressources et les types d'authentification acceptés dans les espaces en mode importation, consultez Autoriser les applications Chat.
Pièces jointes
Votre application Chat peut importer des pièces jointes à l'aide de l'API Chat. Pour en savoir plus sur les méthodes de ressources et les types d'authentification acceptés dans les espaces en mode importation, consultez Autoriser les applications Chat.
Historique des adhésions
Les abonnements historiques sont créés pour les utilisateurs qui avaient déjà quitté l'entité d'espace d'origine depuis la plate-forme de messagerie source, mais que vous souhaitez conserver leurs données dans Chat. Pour en savoir plus sur l'ajout de membres une fois que l'espace ne sera plus en mode importation, consultez la section Créer une ressource d'appartenance.
Dans de nombreux cas, lorsque ces membres historiques sont soumis à une règle de conservation des données dans Google, vous souhaitez conserver les données (telles que les messages et les réactions) créées par les membres historiques d'un espace avant de les importer dans Chat.
Lorsque l'espace est en mode importation, vous pouvez y importer ces anciens membres en utilisant la méthode create sur la ressource Membership.
Afin de conserver le temps de départ de l'historique de l'adhésion, vous devez définir son deleteTime. Ce délai de congé doit être précis, car il a un impact sur les données à conserver pour ces adhésions. De plus, ce deleteTime doit être postérieur à l'horodatage de création de l'espace et ne doit pas être un horodatage futur.
En plus de deleteTime, vous pouvez également définir createTime pour conserver la date d'adhésion d'origine de l'historique de membres. Contrairement à deleteTime, createTime est facultatif. Si cette valeur n'est pas définie, la valeur createTime est automatiquement calculée en soustrayant 1 microseconde de deleteTime. S'il est défini, createTime doit être avant deleteTime et doit être identique ou postérieure à l'heure de création de l'espace. Ces informations createTime ne sont pas utilisées pour déterminer la conservation des données et ne sont pas visibles dans les outils d'administration tels que la console d'administration Google et Google Vault.
Bien qu'un utilisateur puisse rejoindre et quitter un espace de plusieurs manières sur la plate-forme de messagerie source (par le biais d'invitations, de la participation seule ou d'un autre utilisateur), dans Chat, ces actions sont toutes représentées par les champs d'adhésion createTime et deleteTime comme ajoutés ou supprimés.
Valider les ressources importées
Votre application Chat peut lire et valider le contenu d'un espace en mode importation en appelant la méthode list sur la ressource Message.
Vous pouvez lire les ressources Reaction et Attachment à partir des champs emojiReactionSummaries et attachment de tous les messages renvoyés. Les applications de chat ne peuvent appeler cette méthode qu'au nom d'un utilisateur via l'emprunt d'identité. Pour en savoir plus, consultez Autoriser les applications Chat.
Votre application Chat peut également lire des messages individuels pour validation en appelant la méthode get sur la ressource Message.
Les applications de chat ne peuvent appeler cette méthode que pour lire leurs propres messages, de leur propre autorité. Pour en savoir plus, consultez Autoriser les applications Chat.
Les applications de chat peuvent également répertorier l'historique des adhésions en appelant la méthode list sur la ressource Membership.
Une fois que l'espace a quitté le mode d'importation, la méthode list n'expose plus les anciens membres. Les applications de chat ne peuvent appeler cette méthode que pour le compte d'un utilisateur via une usurpation d'identité. Pour en savoir plus, consultez Autoriser les applications Chat.
Pour lire les propriétés d'un espace en mode importation, appelez la méthode get sur la ressource Space.
Les applications de chat ne peuvent appeler cette méthode que si elles ont leur propre autorité.
Pour en savoir plus, consultez Autoriser les applications Chat.
Rapprocher les différences entre les ressources importées et les données sources
Si une ressource importée ne correspond plus à l'entité d'origine de la plate-forme de messagerie source en raison de modifications apportées à l'entité d'origine lors de l'importation, les applications de chat peuvent appeler l'API Chat pour modifier la ressource de chat importée. Par exemple, si un utilisateur modifie un message sur la plate-forme de messagerie source après sa création dans Chat, les applications de Chat peuvent mettre à jour le message importé afin qu'il reflète le contenu actuel du message d'origine.
Messages
Pour mettre à jour les champs compatibles dans un message dans un espace en mode importation, appelez la méthode update sur la ressource Message.
Les applications de chat ne peuvent appeler cette méthode qu'avec la même autorité que celle utilisée lors de la création du message initial. Si vous avez emprunté l'identité d'un utilisateur lors de la création initiale du message, vous devez vous servir du même utilisateur dont l'identité a été empruntée pour mettre à jour ce message.
Pour supprimer un message dans un espace en mode importation, appelez la méthode delete sur la ressource Message.
Les messages d'un espace en mode importation n'ont pas besoin d'être supprimés par leur créateur. Ils peuvent être supprimés en usurpant l'identité de n'importe quel utilisateur du domaine.
Les applications de chat ne peuvent supprimer leurs propres messages que si elles ont leur propre autorité. Pour en savoir plus, consultez Autoriser les applications Chat.
Réactions
Pour supprimer une réaction à un message dans un espace en mode importation, utilisez la méthode delete sur la ressource reactions. Pour en savoir plus sur les méthodes de ressources et les types d'authentification acceptés dans les espaces en mode importation, consultez Autoriser les applications Chat.
Pièces jointes
Pour mettre à jour les pièces jointes d'un message dans un espace en mode importation, utilisez la méthode upload sur la ressource media. Pour en savoir plus sur les méthodes de ressources et les types d'authentification acceptés dans les espaces en mode importation, consultez Autoriser les applications Chat.
Historique des adhésions
Pour supprimer une appartenance historique dans un espace en mode importation, utilisez la méthode delete sur la ressource Membership. Lorsqu'un espace quitte le mode d'importation, la méthode delete ne vous permet plus de supprimer l'historique des membres.
Vous ne pouvez pas mettre à jour un historique des adhésions dans un espace en mode importation. Si vous souhaitez corriger un abonnement historique importé de manière incorrecte, vous devez d'abord le supprimer, puis le recréer pendant que l'espace est toujours en mode importation.
Spaces
Pour mettre à jour les champs compatibles dans un espace en mode importation, utilisez la méthode patch sur la ressource spaces.
Pour supprimer un espace en mode importation, utilisez la méthode delete sur la ressource spaces.
Pour en savoir plus sur les méthodes de ressources et les types d'authentification acceptés dans les espaces en mode importation, consultez la section Autoriser les applications Chat.
Terminer le mode d'importation
Avant d'appeler la méthode completeImport, vous devez vous assurer que la validation et le rapprochement des différences de ressources sont terminés. La sortie d'un espace du mode importation est un processus irréversible qui convertit l'espace du mode importation en un espace standard. Aucun indicateur dans Chat n'attribue ces espaces à une importation de données.
Pour terminer le mode importation et rendre l'espace accessible aux utilisateurs, l'application Chat peut appeler la méthode completeImport sur la ressource Space.
Les applications de chat ne peuvent appeler cette méthode qu'au nom d'un utilisateur via l'emprunt d'identité. Pour en savoir plus, consultez Autoriser les applications Chat.
L'utilisateur dont l'identité a été empruntée est ajouté à l'espace en tant que gestionnaire de l'espace une fois cette méthode terminée. Cette méthode doit être appelée dans les 30 jours suivant l'appel de méthode create.space initial. Si vous tentez d'appeler cette méthode une fois le délai de 30 jours écoulé, l'appel échoue, car l'espace du mode importation est supprimé et n'est plus accessible à l'application Chat.
L'utilisateur dont l'identité est empruntée dans la méthode completeImport n'a pas besoin d'être le créateur de l'espace.
Créer des ressources destinées aux membres
Pour ajouter des membres d'utilisateurs à un espace qui a terminé le mode d'importation, appelez la méthode create sur la ressource Membership.
Les applications de chat peuvent continuer à utiliser le champ d'application chat.import et l'emprunt d'identité de l'utilisateur pour appeler cette méthode dans les 30 jours suivant l'appel initial de la méthode create.space. L'utilisateur dont l'identité a été empruntée doit être gestionnaire de l'espace.
Une fois le délai de 30 jours écoulé, les applications de chat nécessitent des champs d'application d'abonnement supplémentaires pour appeler cette méthode.
Nous vous recommandons de créer des ressources de membres immédiatement après l'importation. Ainsi, les applications Chat peuvent continuer à utiliser le champ d'application chat.import pour la création des membres et permettre à tous les membres d'accéder à l'espace importé.