# generaltranslation: General Translation Core SDK: getProjectData
URL: https://generaltranslation.com/ru/docs/core/class/methods/translation/get-project-data.mdx
---
title: getProjectData
description: Справка по API метода getProjectData для получения информации о проекте и его конфигурации
---

## Обзор

Метод `getProjectData` возвращает полную информацию о проекте перевода, включая его название, организацию, локаль по умолчанию и настроенные целевые локали.
Этот метод полезен для понимания конфигурации проекта и проверки его настроек.

```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(', ')}`);
```


## Справочник

### Параметры

| Имя         | Тип                    | Описание                                                 |
| ----------- | ---------------------- | -------------------------------------------------------- |
| `projectId` | `string`               | Уникальный идентификатор проекта, который нужно получить |
| `options?`  | `{ timeout?: number }` | Необязательные параметры запроса                         |

#### Параметры

| Имя        | Тип      | Описание                         |
| ---------- | -------- | -------------------------------- |
| `timeout?` | `number` | Тайм-аут запроса в миллисекундах |

### Возвращаемое значение

`Promise<ProjectData>` — содержит информацию о проекте и его конфигурации.

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

| Свойство         | Тип        | Описание                                              |
| ---------------- | ---------- | ----------------------------------------------------- |
| `id`             | `string`   | Уникальный идентификатор проекта                      |
| `name`           | `string`   | Понятное название проекта                             |
| `orgId`          | `string`   | Идентификатор организации, которой принадлежит проект |
| `defaultLocale`  | `string`   | Локаль исходного языка проекта по умолчанию           |
| `currentLocales` | `string[]` | Массив целевых локалей, настроенных в данный момент   |

***


## Примеры

### Основы использования

```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('=== 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');
```

***


## Примечания

* Метод предоставляет доступ к информации о проекте только для чтения — для изменения настроек проекта используйте панель управления
* Для этого метода требуется действительный ID проекта — проект должен быть доступен с указанным API-ключом
* Данные проекта включают конфигурации как исходной, так и целевой локали
* Массив `currentLocales` содержит все целевые локали, настроенные для проекта
* Используйте этот метод, чтобы проверить конфигурацию проекта перед запуском процессов перевода

## Следующие шаги

* См. [`setupProject`](/docs/core/class/methods/translation/setup-project), чтобы выполнить начальную настройку проекта
* См. [`enqueueFiles`](/docs/core/class/methods/translation/enqueue-files), чтобы запустить задачи перевода
* См. [`querySourceFile`](/docs/core/class/methods/translation/query-source-file), чтобы получить информацию о конкретном файле