getProjectData
Справочник API по методу getProjectData для получения сведений о проекте и его конфигурации
Обзор
Метод getProjectData возвращает подробную информацию о проекте перевода, включая его название, организацию, локаль по умолчанию и настроенные целевые локали.
Этот метод полезен для понимания конфигурации проекта и проверки его настроек.
const gt = new GT({ projectId: 'your-project-id', apiKey: 'your-api-key' });
const projectData = await gt.getProjectData('project-123');
console.log(`Проект: ${projectData.name}`);
console.log(`Локаль по умолчанию: ${projectData.defaultLocale}`);
console.log(`Целевые локали: ${projectData.currentLocales.join(', ')}`);Справочные материалы
Параметры
| Имя | Тип | Описание |
|---|---|---|
projectId | string | Уникальный идентификатор проекта для получения данных |
options? | { timeout?: number } | Необязательные параметры запроса |
Параметры
| Имя | Тип | Описание |
|---|---|---|
timeout? | number | Время ожидания запроса в миллисекундах |
Возвращает
Promise<ProjectData> — содержит сведения о проекте и его конфигурацию.
type ProjectData = {
id: string;
name: string;
orgId: string;
defaultLocale: string;
currentLocales: string[];
}| Свойство | Тип | Описание |
|---|---|---|
id | string | Уникальный идентификатор проекта |
name | string | Человеко‑читаемое имя проекта |
orgId | string | Идентификатор организации — владельца проекта |
defaultLocale | string | Исходная локаль по умолчанию для проекта |
currentLocales | string[] | Массив целевых локалей, сейчас сконфигурированных |
Примеры
Базовое использование
import { GT } from 'generaltranslation';
const gt = new GT({
projectId: 'ID-вашего-проекта',
apiKey: 'ваш API-ключ'
});
async function getProjectInfo(projectId: string) {
try {
const project = await gt.getProjectData(projectId);
console.log('=== Сведения о проекте ===');
console.log(`ID: ${project.id}`);
console.log(`Название: ${project.name}`);
console.log(`Организация: ${project.orgId}`);
console.log(`Локаль по умолчанию: ${project.defaultLocale}`);
console.log(`Целевые локали: ${project.currentLocales.join(', ')}`);
return project;
} catch (error) {
console.error(`Не удалось получить данные проекта ${projectId}:`, error);
throw error;
}
}
const projectInfo = await getProjectInfo('my-project-123');Примечания
- Метод предоставляет доступ к информации о проекте только для чтения — для изменения настроек используйте панель управления
- Для вызова метода требуется действительный идентификатор проекта — проект должен быть доступен с указанным API‑ключом
- Данные проекта включают конфигурации локалей как исходных, так и целевых
- Массив
currentLocalesсодержит все целевые локали, настроенные для проекта - Используйте этот метод для проверки конфигурации проекта перед запуском процессов перевода
Дальнейшие действия
- См.
shouldSetupProject, чтобы проверить, требуется ли настройка проекта - См.
setupProject, чтобы выполнить первоначальную настройку проекта - См.
enqueueFiles, чтобы запустить задания на перевод - См.
querySourceFileдля получения информации о конкретном файле
Насколько полезно это руководство?