GT ClassMethodsTranslation

getProjectData

Référence de l’API pour la méthode getProjectData permettant de récupérer les informations et la configuration du projet

Présentation

La méthode getProjectData récupère des informations détaillées sur un projet de traduction, notamment son nom, son organisation, sa locale par défaut et les locales cibles actuellement configurées. Cette méthode est utile pour comprendre la configuration du projet et vérifier ses paramètres.

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

const projectData = await gt.getProjectData('project-123');
console.log(`Projet : ${projectData.name}`);
console.log(`Locale par défaut : ${projectData.defaultLocale}`);
console.log(`Locales cibles : ${projectData.currentLocales.join(', ')}`);

Références

Paramètres

NomTypeDescription
projectIdstringL’identifiant unique du projet à récupérer
options?{ timeout?: number }Configuration facultative de la requête

Options

NomTypeDescription
timeout?numberDélai d’attente de la requête en millisecondes

Renvoie

Promise<ProjectData> - Contient les informations et la configuration du projet.

type ProjectData = {
  id: string;
  name: string;
  orgId: string;
  defaultLocale: string;
  currentLocales: string[];
}
PropriétéTypeDescription
idstringIdentifiant unique du projet
namestringNom du projet (lisible par un humain)
orgIdstringIdentifiant de l’organisation propriétaire du projet
defaultLocalestringlocale source par défaut du projet
currentLocalesstring[]Tableau des locales cibles actuellement configurées

Exemples

Utilisation de base

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('=== Informations du projet ===');
    console.log(`ID : ${project.id}`);
    console.log(`Nom : ${project.name}`);
    console.log(`Organisation : ${project.orgId}`);
    console.log(`Locale par défaut : ${project.defaultLocale}`);
    console.log(`Locales cibles : ${project.currentLocales.join(', ')}`);
    
    return project;
  } catch (error) {
    console.error(`Échec de la récupération du projet ${projectId} :`, error);
    throw error;
  }
}

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

Remarques

  • Cette méthode offre un accès en lecture seule aux informations du projet — utilisez le tableau de bord pour modifier les paramètres du projet
  • Cette méthode nécessite un id de projet valide — le projet doit être accessible avec la clé d’API fournie
  • Les données du projet incluent les configurations de locale pour la source et la cible
  • Le tableau currentLocales répertorie toutes les locales cibles configurées pour le projet
  • Utilisez cette méthode pour valider la configuration du projet avant de lancer les workflows de traduction

Prochaines étapes

  • Consultez shouldSetupProject pour vérifier si la configuration du projet est nécessaire
  • Consultez setupProject pour initialiser la configuration du projet
  • Consultez enqueueFiles pour lancer les tâches de traduction
  • Consultez querySourceFile pour des informations propres au fichier

Que pensez-vous de ce guide ?

getProjectData