# General Translation Platform: getProjectData
URL: https://generaltranslation.com/ru/docs/platform/core/reference/gt-class-methods/translation/get-project-data.mdx
---

title: getProjectData
description: Чтение метаданных уровня проекта и конфигурации перевода. Справочник по API для getProjectData.

---

Получает информацию о проекте перевода в General Translation, включая его имя, организацию, локаль по умолчанию и настроенные в данный момент целевые локали. Используйте этот метод, чтобы просмотреть или проверить конфигурацию проекта.

## Обзор [#overview]

Вызовите `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(', ')}`);
```

Сигнатура:

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

*Примечание: для `getProjectData` в экземпляре GT должны быть указаны `apiKey` (или `devApiKey`) и `projectId`, а сам проект должен быть доступен по этому API-ключу.*

## Как это работает [#how-it-works]

* **Только для чтения.** Метод предоставляет доступ к информации о проекте только для чтения — изменять настройки проекта следует в Dashboard.
* **Конфигурация локалей.** Ответ включает конфигурацию как исходной (`defaultLocale`), так и целевых (`currentLocales`) локалей.
* **Проверка.** Используйте этот метод, чтобы проверить конфигурацию проекта перед запуском процессов перевода.

## Параметры [#parameters]

| Параметр                   | Описание                                                      | Тип                    | Необязательно | По умолчанию |
| -------------------------- | ------------------------------------------------------------- | ---------------------- | ------------- | ------------ |
| [`projectId`](#project-id) | Уникальный идентификатор проекта, который требуется получить. | `string`               | Нет           | —            |
| [`options`](#options)      | Конфигурация запроса.                                         | `{ timeout?: number }` | Да            | —            |

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

**Тип** `string` · **Обязательно**

Уникальный идентификатор проекта, который нужно получить. Проект должен быть доступен с указанным API key.

### `options` [#options]

**Тип** `{ timeout?: number }` · **Необязательно**

| Поле      | Описание                          | Тип      | Необязательно |
| --------- | --------------------------------- | -------- | ------------- |
| `timeout` | Тайм-аут запроса в миллисекундах. | `number` | Да            |

## Возвращает [#returns]

**Тип** `Promise<ProjectData>`

Результатом будет объект `ProjectData`, описывающий Project:

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

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

## Примеры [#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');
```

## Заметки [#notes]

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