# General Translation Integrations: Configuración del plugin de Payload
URL: https://generaltranslation.com/es/docs/integrations/payload/reference/plugin-configuration.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: Configura el plugin gt-payload de General Translation para Payload CMS. Referencia de la API de gtPlugin.

Agrega `gtPlugin` al array `plugins` de Payload. El plugin lee la configuración de localización de Payload para determinar la configuración regional de origen, las configuraciones regionales de destino y los campos traducibles.

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

export default buildConfig({
  // ... tu configuración existente
  localization: {
    locales: ['en', 'es', 'fr'],
    defaultLocale: 'en',
  },
  plugins: [gtPlugin()],
});
```

## Opciones [#options]

| Opción                             | Descripción                                                                 | Tipo                                                                  | Opcional | Predeterminado                              |
| ---------------------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------- | -------- | ------------------------------------------- |
| [`projectId`](#project-id)         | ID de proyecto de General Translation.                                      | `string`                                                              | Sí       | `GT_PROJECT_ID`                             |
| [`apiKey`](#api-key)               | Clave de API de Project de General Translation.                             | `string`                                                              | Sí       | `GT_API_KEY`                                |
| [`customMapping`](#custom-mapping) | Alias de configuración regional y sobrescrituras de propiedades de Payload. | [`CustomMapping`](/docs/platform/core/reference/types/custom-mapping) | Sí       | —                                           |
| [`client`](#client)                | Cliente preconfigurado que se usa para las solicitudes de traducción.       | [`GtClient`](/docs/integrations/payload/reference/api#gtclient)       | Sí       | Se construye a partir de las demás opciones |

## `projectId` [#project-id]

**Tipo** `string` · **Opcional** · **Predeterminado** `GT_PROJECT_ID`

El proyecto que se usa para las cargas de archivos, las tareas de traducción y las descargas. Pásalo directamente solo si el servidor no puede leer `GT_PROJECT_ID`.

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

## `apiKey` [#api-key]

**Tipo** `string` · **Opcional** · **Predeterminado** `GT_API_KEY`

La clave de API de Project que utiliza el servidor de Payload. Guárdala en una variable de entorno server-only; nunca la incluyas en el paquete del cliente ni la subas al control de versiones en un commit.

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

## `customMapping` [#custom-mapping]

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

Asigna un código de configuración regional de Payload a un código compatible con General Translation y permite sobrescribir propiedades de la configuración regional. Usa la misma estructura que la clave `customMapping` de [`gt.config.json`](/docs/cli/reference/config#custom-mapping).

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

El panel de administración sigue mostrando las configuraciones regionales sin asignar y no compatibles, pero las deshabilita como destinos de traducción.

## `client` [#client]

**Tipo** [`GtClient`](/docs/integrations/payload/reference/api#gtclient) · **Opcional** · **Predeterminado** se construye a partir de `projectId`, `apiKey`, la configuración regional predeterminada de Payload y `customMapping`

Cliente del lado del servidor que implementa los métodos de General Translation que utiliza el plugin. Pasa esta opción para proporcionar un doble de prueba o un cliente existente con un comportamiento de transporte personalizado.

Si se establece `client`, el plugin no construye su propia instancia de `GT`. El cliente debe implementar todos los métodos del tipo [`GtClient`](/docs/integrations/payload/reference/api#gtclient) documentado.

## Cómo funciona [#how-it-works]

Cuando la localización de Payload está configurada, el plugin añade:

* Un control **Translate** en las colecciones y globales que tienen campos localizados traducibles
* Una vista de administración **Translations** para todo el sitio en `/translations`
* Las colecciones `gt-translation-runs` y `gt-translation-locks`
* Un trabajo de Payload `gtTranslationRun`
* Endpoints autenticados bajo la ruta de API de Payload para ejecuciones y cobertura

Si no existe `localization`, el plugin devuelve la configuración sin cambios.

Ejecuta `npx payload generate:importmap` después de añadir o actualizar el plugin. Antes de usar la traducción en producción, aplica la migración de base de datos correspondiente a las colecciones añadidas.

Los endpoints de administración requieren un usuario de Payload con sesión iniciada y respetan las reglas de acceso a documentos de dicho usuario. Las credenciales de General Translation se mantienen en el servidor.

## Sitemap

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