# General Translation Integrations: Configuration du plugin Payload
URL: https://generaltranslation.com/fr/docs/integrations/payload/reference/plugin-configuration.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: Configurez le plugin gt-payload de General Translation pour Payload CMS. Référence de l’API pour gtPlugin.

Ajoutez `gtPlugin` au tableau `plugins` de Payload. Le plugin s’appuie sur la configuration de localisation de Payload pour déterminer les paramètres régionaux sources, les paramètres régionaux cibles et les champs traduisibles.

```ts title="src/payload.config.ts"
import { buildConfig } from 'payload';
import { gtPlugin } from 'gt-payload';

export default buildConfig({
  // ... votre configuration existante
  localization: {
    locales: ['en', 'es', 'fr'],
    defaultLocale: 'en',
  },
  plugins: [gtPlugin()],
});
```

## Options [#options]

| Option                             | Description                                                                | Type                                                                  | Facultatif | Valeur par défaut                     |
| ---------------------------------- | -------------------------------------------------------------------------- | --------------------------------------------------------------------- | ---------- | ------------------------------------- |
| [`projectId`](#project-id)         | Identifiant de projet General Translation.                                 | `string`                                                              | Oui        | `GT_PROJECT_ID`                       |
| [`apiKey`](#api-key)               | Clé API de projet General Translation.                                     | `string`                                                              | Oui        | `GT_API_KEY`                          |
| [`customMapping`](#custom-mapping) | Alias de paramètres régionaux et remplacements de propriétés pour Payload. | [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) | Oui        | —                                     |
| [`client`](#client)                | Client préconfiguré utilisé pour les requêtes de traduction.               | [`GtClient`](/docs/integrations/payload/reference/api#gtclient)       | Oui        | Construit à partir des autres options |

## `projectId` [#project-id]

**Type** `string` · **Facultatif** · **Valeur par défaut** `GT_PROJECT_ID`

Le projet utilisé pour l'import de fichiers, les tâches de traduction et les téléchargements. Ne le transmettez directement que si le serveur ne peut pas lire `GT_PROJECT_ID`.

```ts title="src/payload.config.ts"
gtPlugin({
  projectId: process.env.GT_PROJECT_ID,
});
```

## `apiKey` [#api-key]

**Type** `string` · **Facultatif** · **Valeur par défaut** `GT_API_KEY`

La clé API de projet utilisée par le serveur Payload. Stockez-la dans une variable d'environnement server-only ; ne l'incluez jamais dans le bundle client et ne la committez jamais dans le système de gestion de versions.

```ts title="src/payload.config.ts"
gtPlugin({
  apiKey: process.env.GT_API_KEY,
});
```

## `customMapping` [#custom-mapping]

**Type** [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) · **Facultatif**

Associe un code de langue Payload à un code General Translation pris en charge et permet de remplacer certaines propriétés du paramètre régional. Utilisez la même structure que la clé `customMapping` dans [`gt.config.json`](/docs/cli/reference/config#custom-mapping).

```ts title="src/payload.config.ts"
gtPlugin({
  customMapping: {
    cn: {
      code: 'zh',
      name: 'Mandarin',
    },
  },
});
```

Le panneau d'administration continue d'afficher les paramètres régionaux non mappés et non pris en charge, mais ne permet pas de les sélectionner comme cibles de traduction.

## `client` [#client]

**Type** [`GtClient`](/docs/integrations/payload/reference/api#gtclient) · **Facultatif** · **Valeur par défaut** construit à partir de `projectId`, `apiKey`, des paramètres régionaux par défaut de Payload et de `customMapping`

Client server-side qui implémente les méthodes General Translation utilisées par le plugin. Utilisez cette option pour fournir une doublure de test ou un client existant doté d'un comportement de transport personnalisé.

Lorsque `client` est défini, le plugin ne crée pas sa propre instance `GT`. Le client doit implémenter toutes les méthodes du type [`GtClient`](/docs/integrations/payload/reference/api#gtclient) documenté.

## Comment ça fonctionne [#how-it-works]

Lorsque la localisation de Payload est configurée, le plugin ajoute :

* Un contrôle **Translate** aux collections et aux globals comportant des champs localisés traduisibles
* Une vue d’administration **Translations** site-wide, accessible à l’adresse `/translations`
* Les collections `gt-translation-runs` et `gt-translation-locks`
* Une tâche Payload `gtTranslationRun`
* Des points de terminaison authentifiés, sous la route d’API de Payload, pour les exécutions et la couverture

Le plugin renvoie la configuration telle quelle lorsque `localization` est absent.

Exécutez `npx payload generate:importmap` après avoir ajouté ou mis à jour le plugin. Appliquez la migration de base de données correspondant aux collections ajoutées avant d’utiliser la traduction en production.

Les points de terminaison d’administration exigent qu’un utilisateur Payload soit connecté et respectent les règles d’accès aux documents propres à cet utilisateur. Les identifiants General Translation restent sur le serveur.

## Sitemap

See the full [sitemap](https://generaltranslation.com/sitemap.md) for all pages.