getProjectData
Riferimento API per il metodo getProjectData per recuperare informazioni e la configurazione del progetto
Panoramica
Il metodo getProjectData recupera informazioni complete su un progetto di traduzione, tra cui nome, organizzazione, locale predefinita e locali di destinazione attualmente configurate.
Questo metodo è utile per comprendere la configurazione del progetto e verificare le impostazioni del progetto.
const gt = new GT({ projectId: 'your-project-id', apiKey: 'your-api-key' });
const projectData = await gt.getProjectData('project-123');
console.log(`Progetto: ${projectData.name}`);
console.log(`Locale predefinita: ${projectData.defaultLocale}`);
console.log(`Lingue di destinazione: ${projectData.currentLocales.join(', ')}`);Riferimenti
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
projectId | string | Identificatore univoco del progetto da recuperare |
options? | { timeout?: number } | Configurazione opzionale della richiesta |
Opzioni
| Nome | Tipo | Descrizione |
|---|---|---|
timeout? | number | Timeout della richiesta in millisecondi |
Valore restituito
Promise<ProjectData> - Contiene le informazioni e la configurazione del progetto.
type ProjectData = {
id: string;
name: string;
orgId: string;
defaultLocale: string;
currentLocales: string[];
}| Proprietà | Tipo | Descrizione |
|---|---|---|
id | string | Identificatore univoco del progetto |
name | string | Nome del progetto in formato leggibile |
orgId | string | Identificatore dell’organizzazione proprietaria del progetto |
defaultLocale | string | Locale sorgente predefinito del progetto |
currentLocales | string[] | Elenco dei locali di destinazione attualmente configurati |
Esempi
Utilizzo di base
import { GT } from 'generaltranslation';
const gt = new GT({
projectId: 'ID-progetto',
apiKey: 'chiave-API'
});
async function getProjectInfo(projectId: string) {
try {
const project = await gt.getProjectData(projectId);
console.log('=== Informazioni sul progetto ===');
console.log(`ID: ${project.id}`);
console.log(`Nome: ${project.name}`);
console.log(`Organizzazione: ${project.orgId}`);
console.log(`Locale predefinito: ${project.defaultLocale}`);
console.log(`Locali di destinazione: ${project.currentLocales.join(', ')}`);
return project;
} catch (error) {
console.error(`Impossibile recuperare il progetto ${projectId}:`, error);
throw error;
}
}
const projectInfo = await getProjectInfo('my-project-123');Note
- Il metodo fornisce accesso in sola lettura alle informazioni del progetto: usa la dashboard per modificare le impostazioni del progetto
- Questo metodo richiede un ID progetto valido: il progetto deve essere accessibile con la chiave API fornita
- I dati del progetto includono le configurazioni sia della lingua sorgente sia delle lingue di destinazione
- L’array
currentLocalesrappresenta tutte le lingue di destinazione configurate per il progetto - Usa questo metodo per validare la configurazione del progetto prima di avviare i flussi di traduzione
Prossimi passaggi
- Vedi
shouldSetupProjectper verificare se è necessaria la configurazione del progetto - Vedi
setupProjectper iniziare la configurazione del progetto - Vedi
enqueueFilesper avviare i job di traduzione - Vedi
querySourceFileper informazioni specifiche sul file
Come valuti questa guida?