# General Translation Platform: getProjectData
URL: https://generaltranslation.com/es/docs/platform/core/reference/gt-class-methods/translation/get-project-data.mdx
Docs index: https://generaltranslation.com/llms.txt
Description: Lee los metadatos a nivel de proyecto y la configuración de traducción. Referencia de la API para getProjectData.

Recupera información sobre un proyecto de traducción en General Translation, incluido su nombre, Organization, la configuración regional predeterminada y la configuración regional de destino configurados actualmente. Úsalo para inspeccionar o validar la configuración del proyecto.

## Resumen general [#overview]

Llama a `getProjectData` con un ID de proyecto. Devuelve metadatos del proyecto de solo lectura y la configuración regional.

```typescript
const gt = new GT({ projectId: 'your-project-id', apiKey: 'your-api-key' });

const projectData = await gt.getProjectData('project-123');
console.log(`Project: ${projectData.name}`);
console.log(`Default locale: ${projectData.defaultLocale}`);
console.log(`Target locales: ${projectData.currentLocales.join(', ')}`);
```

Firma:

```typescript
getProjectData(
  projectId: string,
  options?: { timeout?: number }
): Promise<ProjectData>
```

*Nota: `getProjectData` requiere una `apiKey` (o `devApiKey`) y `projectId` en la instancia de GT, y el proyecto debe ser accesible con esa clave de API.*

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

* **Solo lectura.** El método proporciona acceso de solo lectura a la información del proyecto; usa el panel de control para modificar la configuración del proyecto.
* **Configuración regional.** La respuesta incluye la configuración regional tanto de origen (`defaultLocale`) como de destino (`currentLocales`).
* **Validación.** Úsalo para validar la configuración del proyecto antes de iniciar los flujos de trabajo de traducción.

## Parámetros [#parameters]

| Parámetro                  | Descripción                                                | Tipo                   | Opcional | Predeterminado |
| -------------------------- | ---------------------------------------------------------- | ---------------------- | -------- | -------------- |
| [`projectId`](#project-id) | El identificador único del proyecto que se va a recuperar. | `string`               | No       | —              |
| [`options`](#options)      | Configuración de la solicitud.                             | `{ timeout?: number }` | Sí       | —              |

### `projectId` [#project-id]

**Tipo** `string` · **Obligatorio**

El identificador único del proyecto que se quiere recuperar. Se debe poder acceder al proyecto con la clave de API proporcionada.

### `options` [#options]

**Tipo** `{ timeout?: number }` · **Opcional**

| Campo     | Descripción                                        | Tipo     | Opcional |
| --------- | -------------------------------------------------- | -------- | -------- |
| `timeout` | Tiempo de espera de la solicitud, en milisegundos. | `number` | Sí       |

## Devuelve [#returns]

**Tipo** `Promise<ProjectData>`

Se resuelve en un objeto `ProjectData` que describe el proyecto:

```typescript
type ProjectData = {
  id: string;
  name: string;
  orgId: string;
  defaultLocale: string;
  currentLocales: string[];
};
```

| Propiedad        | Descripción                                                     | Tipo       |
| ---------------- | --------------------------------------------------------------- | ---------- |
| `id`             | Identificador único del proyecto.                               | `string`   |
| `name`           | Nombre del proyecto en formato legible.                         | `string`   |
| `orgId`          | Identificador de la Organization propietaria del proyecto.      | `string`   |
| `defaultLocale`  | Configuración regional de origen predeterminada del proyecto.   | `string`   |
| `currentLocales` | Configuraciones regionales de destino configuradas actualmente. | `string[]` |

## Ejemplos [#examples]

```typescript title="index.ts"
import { GT } from 'generaltranslation';

const gt = new GT({
  projectId: 'your-project-id',
  apiKey: 'your-api-key',
});

async function getProjectInfo(projectId: string) {
  try {
    const project = await gt.getProjectData(projectId);

    console.log('=== Project Information ===');
    console.log(`ID: ${project.id}`);
    console.log(`Name: ${project.name}`);
    console.log(`Organization: ${project.orgId}`);
    console.log(`Default Locale: ${project.defaultLocale}`);
    console.log(`Target Locales: ${project.currentLocales.join(', ')}`);

    return project;
  } catch (error) {
    console.error(`Failed to retrieve project ${projectId}:`, error);
    throw error;
  }
}

const projectInfo = await getProjectInfo('my-project-123');
```

## Notas [#notes]

* El método proporciona acceso de solo lectura a la información del proyecto; usa el panel de control para modificar la configuración del proyecto.
* Este método requiere un ID de proyecto válido; el proyecto debe ser accesible con la clave de API proporcionada.
* Los datos del proyecto incluyen configuraciones regionales de origen y de destino.
* La lista `currentLocales` representa todas las configuraciones regionales de destino configuradas para el proyecto.
* Usa este método para validar la configuración del proyecto antes de iniciar los flujos de trabajo de traducción.

## Sitemap

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