Importer des données dans Google Chat

L'API Google Chat vous permet d'importer les données de vos autres plates-formes de messagerie dans Google Chat. Vous pouvez importer les messages, pièces jointes, réactions, abonnements et entités d'espaces existants de 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.

Voici un aperçu des étapes à suivre pour importer des données à l'aide d'un espace du mode d'importation:

1. Examinez les limites d'utilisation des API et planifiez leur utilisation.
2. Configurez l'autorisation pour l'application Chat.
3. Créez un espace en mode importation.
4. Importer des ressources
5. Validez les ressources importées.
6. Rapprochez les différences entre les ressources importées et les données sources.
7. Mode d'importation complet :
8. Créez des ressources réservées aux membres.

Prérequis

Examiner les limites d'utilisation de l'API et s'y préparer

Le temps nécessaire à l'importation des données dans Chat peut varier considérablement en fonction de la quantité de ressources Chat à importer. Pour obtenir une estimation du calendrier, consultez 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.

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 conserver l'heure de création de l'entité d'espace équivalente à partir de la plate-forme de messagerie source, vous pouvez définir la createTime de l'espace. Cet élément 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 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 Chat peuvent toujours créer des abonnements au bout de 30 jours avec les niveaux 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 sera inaccessible et irrécupérable par l'application Chat. Prévoyez-vous de consulter les limites d'utilisation de votre application Chat pour vous assurer que toutes les ressources planifiées peuvent être importées dans Chat pendant ce laps de temps.

L'exemple suivant montre comment créer un espace en mode importation:

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);
}

"""Create a space in import mode."""

import datetime

from google.oauth2 import service_account
from googleapiclient.discovery import build

# Specify required scopes.
SCOPES = [
    'https://www.googleapis.com/auth/chat.import',
]

CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
    .with_subject('EMAIL')
)

# Build a service endpoint for Chat API.
service = build('chat', 'v1', credentials=CREDENTIALS)

result = (
    service.spaces()
    .create(
        body={
            'spaceType': 'SPACE',
            'displayName': 'Import Mode Space',
            'importMode': True,
            'createTime': f'{datetime.datetime(2000, 1, 1).isoformat()}Z',
        }
    )
    .execute()
)

print(result)

Remplacez les éléments suivants :

• EMAIL: adresse e-mail du compte utilisateur dont vous usurpez l'identité et qui dispose de l'autorité au niveau du domaine.

Importer des ressources

Pour importer des ressources à partir d'autres plates-formes de messagerie, créez 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 provenant de la plate-forme de messagerie à partir de laquelle vous effectuez la migration.

Messages

Vos applications Chat peuvent importer des messages en utilisant leur propre autorité ou au nom d'un utilisateur par le biais d'une usurpation d'identité. (L'auteur du message est défini sur le compte utilisateur dont l'identité est empruntée.) Pour en savoir plus, consultez Autoriser les applications Chat. Pour importer un message dans un espace du mode importation, appelez la méthode create sur la ressource Message. Afin de conserver l'heure de création du message d'origine sur la plate-forme de messagerie source, vous pouvez définir le createTime du message. Ce 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 du même espace ne peuvent pas contenir le même createTime, même si les messages précédents pour cette heure sont supprimés.

Les messages contenant des URL tierces dans les espaces en mode importation ne peuvent pas afficher d'aperçus des liens dans Google Chat.

Lorsque vous créez les messages en mode importation, les espaces n'envoient aucune notification aux utilisateurs et n'en envoient aucun e-mail, y compris les messages qui contiennent des mentions utilisateur.

L'exemple suivant montre comment créer un message dans un espace du mode d'importation:

"""Create a message in import mode space."""

import datetime

from google.oauth2 import service_account
from googleapiclient.discovery import build

# Specify required scopes.
SCOPES = [
    'https://www.googleapis.com/auth/chat.import',
]

CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
    .with_subject('EMAIL')
)

# Build a service endpoint for Chat API.
service = build('chat', 'v1', credentials=CREDENTIALS)

NAME = 'spaces/SPACE_NAME'
result = (
    service.spaces()
    .messages()
    .create(
        parent=NAME,
        body={
            'text': 'Hello, world!',
            'createTime': f'{datetime.datetime(2000, 1, 2).isoformat()}Z',
        },
    )
    .execute()
)

print(result)

Remplacez les éléments suivants :

• EMAIL: adresse e-mail du compte utilisateur dont vous usurpez l'autorité au niveau du domaine.
• SPACE_NAME: nom de l'espace créé en mode importation.

Réactions

Votre application Chat peut importer des réactions pour les messages à l'aide de l'API Chat. Pour en savoir plus sur les méthodes de ressources et les types d'authentification pris en charge 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 pris en charge dans les espaces en mode importation, consultez Autoriser les applications Chat.

Historique des adhésions

Les adhésions historiques sont des adhésions créées pour les utilisateurs qui ont 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 lorsque l'espace ne sera plus en mode importation, consultez Créer une ressource d'abonnement.

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 importer ces membres historiques dans l'espace à l'aide de la méthode create sur la ressource Membership. Afin de conserver le temps de congé de l'historique de l'abonnement, vous devez définir sa deleteTime. Ce délai de congé doit être précis, car il a une incidence 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 l'heure de jointure d'origine de l'historique des souscriptions. Contrairement à deleteTime, createTime est facultatif. Si cette valeur n'est pas définie, createTime est automatiquement calculé en soustrayant 1 microseconde de deleteTime. S'il est défini, createTime doit être antérieur à 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 façons sur la plate-forme de messagerie source (via des invitations, par lui-même ou par un autre utilisateur), ces actions sont toutes représentées par l'historique des membres createTime et deleteTime comme étant ajoutés ou supprimés.

L'exemple suivant montre comment créer une appartenance historique dans un espace du mode d'importation:

"""Create a historical membership in import mode space."""

import datetime

from google.oauth2 import service_account
from googleapiclient.discovery import build

# Specify required scopes.
SCOPES = [
    'https://www.googleapis.com/auth/chat.import',
]

CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
    .with_subject('EMAIL')
)

# Build a service endpoint for Chat API.
service = build('chat', 'v1', credentials=CREDENTIALS)

NAME = 'spaces/SPACE_NAME'
USER = 'users/USER_ID'
result = (
    service.spaces()
    .members()
    .create(
        parent=NAME,
        body={
            'createTime': f'{datetime.datetime(2000, 1, 3).isoformat()}Z',
            'deleteTime': f'{datetime.datetime(2000, 1, 4).isoformat()}Z',
            'member': {'name': USER, 'type': 'HUMAN'},
        },
    )
    .execute()
)

print(result)

Remplacez les éléments suivants :

• EMAIL: adresse e-mail du compte utilisateur dont vous usurpez l'autorité au niveau du domaine.
• SPACE_NAME: nom de l'espace créé en mode importation.
• USER_ID: identifiant unique de l'utilisateur.

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 tout message renvoyé. Les applications de chat ne peuvent appeler cette méthode qu'au nom d'un utilisateur par le biais d'une usurpation 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, et ce de leur propre autorité. Pour en savoir plus, consultez Autoriser les applications Chat.

Les applications 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'affiche plus l'historique des abonnements. Les applications de chat ne peuvent appeler cette méthode qu'au nom d'un utilisateur par le biais d'une usurpation d'identité. Pour en savoir plus, consultez Autoriser les applications Chat.

Vous pouvez lire les propriétés d'un espace en mode importation en appelant 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 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 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 d'un message dans un espace du 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 initiale du message. 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 pour mettre à jour ce message.

Pour supprimer un message dans un espace du 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 du 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 pris en charge 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 pris en charge 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 les abonnements historiques.

Vous ne pouvez pas mettre à jour un historique d'appartenance dans un espace en mode importation. Si vous souhaitez corriger un abonnement historique qui a été 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 du mode importation, utilisez la méthode patch sur la ressource spaces.

Pour supprimer un espace du 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 pris en charge dans les espaces en mode importation, consultez la section Autoriser les applications Chat.

Mode importation terminé

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. Quitter un espace du mode importation est un processus irréversible qui convertit l'espace du mode d'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 par le biais d'une usurpation 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 initial de la méthode create.space. 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é a été empruntée dans la méthode completeImport n'a pas besoin d'être le créateur de l'espace.

L'exemple suivant montre comment effectuer le mode d'importation:

"""Complete import."""

from google.oauth2 import service_account
from googleapiclient.discovery import build

# Specify required scopes.
SCOPES = [
    'https://www.googleapis.com/auth/chat.import',
]

CREDENTIALS = (
    service_account.Credentials.from_service_account_file('credentials.json')
    .with_scopes(SCOPES)
    .with_subject('EMAIL')
)

# Build a service endpoint for Chat API.
service = build('chat', 'v1', credentials=CREDENTIALS)

NAME = 'spaces/SPACE_NAME'
result = service.spaces().completeImport(name=NAME).execute()

print(result)

Remplacez les éléments suivants :

• EMAIL: adresse e-mail du compte utilisateur dont vous usurpez l'autorité au niveau du domaine.
• SPACE_NAME: nom de l'espace créé en mode importation.

Créer des ressources réservées aux membres

Pour ajouter des membres à un espace dont le mode d'importation est terminé, 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 Chat nécessitent des niveaux d'adhésion supplémentaires pour appeler cette méthode.

Nous recommandons aux applications Chat de créer des ressources d'abonnement immédiatement après la fin de l'importation, afin qu'elles puissent continuer à utiliser le champ d'application chat.import pour la création des membres et pour permettre à tous les membres d'accéder à l'espace importé.