# generaltranslation: General Translation Core SDK: getProjectData
URL: https://generaltranslation.com/es/docs/core/class/methods/translation/get-project-data.mdx
---
title: getProjectData
description: Referencia de la API del método getProjectData para obtener información y la configuración del proyecto
---

## Resumen

El método `getProjectData` obtiene información completa sobre un proyecto de traducción, como su nombre, organización, configuración regional predeterminada y los locale de destino configurados actualmente.
Este método es útil para comprender la configuración del proyecto y validar su configuración.

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

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


## Referencia

### Parámetros

| Nombre      | Tipo                   | Descripción                                             |
| ----------- | ---------------------- | ------------------------------------------------------- |
| `projectId` | `string`               | El identificador único del proyecto que se va a obtener |
| `options?`  | `{ timeout?: number }` | Configuración opcional para la solicitud                |

#### Opciones

| Nombre     | Tipo     | Descripción                                      |
| ---------- | -------- | ------------------------------------------------ |
| `timeout?` | `number` | Tiempo de espera de la solicitud en milisegundos |

### Devuelve

`Promise<ProjectData>`: contiene la información y la configuración del proyecto.

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

| Propiedad        | Tipo       | Descripción                                                     |
| ---------------- | ---------- | --------------------------------------------------------------- |
| `id`             | `string`   | Identificador único del proyecto                                |
| `name`           | `string`   | Nombre legible del proyecto                                     |
| `orgId`          | `string`   | Identificador de la organización a la que pertenece el proyecto |
| `defaultLocale`  | `string`   | Configuración regional de origen predeterminada del proyecto    |
| `currentLocales` | `string[]` | Array de locale de destino configurados actualmente             |

***


## Ejemplos

### Uso básico

```typescript title="index.ts" copy
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('=== Información del proyecto ===');
    console.log(`ID: ${project.id}`);
    console.log(`nombre: ${project.name}`);
    console.log(`organización: ${project.orgId}`);
    console.log(`Configuración regional predeterminada: ${project.defaultLocale}`);
    console.log(`Locale de destino: ${project.currentLocales.join(', ')}`);

    return project;
  } catch (error) {
    console.error(`Error al obtener el proyecto ${projectId}:`, error);
    throw error;
  }
}

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

***


## Notas

* 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 del proyecto válido; el proyecto debe ser accesible con la clave API proporcionada
* Los datos del proyecto incluyen tanto la configuración regional de origen como la de destino
* El array `currentLocales` representa todos los locale de destino configurados para el proyecto
* Usa este método para validar la configuración del proyecto antes de iniciar flujos de trabajo de traducción

## Siguientes pasos

* Consulta [`setupProject`](/docs/core/class/methods/translation/setup-project) para inicializar la configuración del proyecto
* Consulta [`enqueueFiles`](/docs/core/class/methods/translation/enqueue-files) para iniciar los trabajos de traducción
* Consulta [`querySourceFile`](/docs/core/class/methods/translation/query-source-file) para obtener información específica del archivo