GT ClassMethodsTranslation

downloadTranslatedFile

API-Referenz zur Methode downloadTranslatedFile zum Herunterladen abgeschlossener Übersetzungsdateien

Überblick

Die Methode downloadTranslatedFile lädt den Inhalt einer einzelnen übersetzten Datei als UTF-8-Zeichenfolge herunter. Diese Methode dient dazu, fertiggestellte Übersetzungen abzurufen, nachdem sie von der General Translation-Plattform verarbeitet wurden.

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

const content = await gt.downloadTranslatedFile({
  fileId: 'file-123',
  locale: 'es',
  versionId: 'version-456'
});

Übersetzungsstatus: Diese Methode funktioniert nur mit abgeschlossenen Übersetzungen. Verwenden Sie zuerst checkFileTranslations, um zu verifizieren, dass die Übersetzungen abgeschlossen sind, bevor Sie sie herunterladen.

Referenzen

Parameter

NameTypBeschreibung
fileFileInfoDateiinfo-Objekt, das angibt, welche Datei heruntergeladen werden soll
options?DownloadFileOptionsOptionale Konfiguration für die Downloadanfrage

FileInfo-Struktur

NameTypBeschreibung
fileIdstringEindeutiger Bezeichner der herunterzuladenden Datei
localestringZiel-Locale der herunterzuladenden Übersetzung
versionId?stringOptionale Versions-ID der Datei

DownloadFileOptions

NameTypeBeschreibung
timeout?numberZeitüberschreitung der Anfrage in Millisekunden

Rückgabewert

Promise<string> - Der übersetzte Dateiinhalt als UTF-8-String.

Die zurückgegebene Zeichenkette enthält den übersetzten Dateiinhalt im selben Format wie die ursprüngliche Quelldatei, wobei sämtlicher übersetzbarer Text in die Ziel-locale konvertiert wurde.


Beispiel

index.ts
// (1) GT-Instanz erstellen
const targetLocales = ['es', 'fr', 'de'];
const gt = new GT({
  projectId: 'your-project-id',
  apiKey: 'your-api-key',
});

// (2) Datei hochladen
const fileUpload = {
  content: fileContents,
  fileName: filePath,
  fileFormat: 'JSON',
  locale: 'en',
};
const files = [ { source: fileUpload } ];
const { uploadedFiles } = await gt.uploadSourceFiles(
  files,
  { sourceLocale: 'en' }
);

// (3) Dateiübersetzungsauftrag in die Warteschlange einreihen
const enqueueResult = await gt.enqueueFiles(
  uploadedFiles,
  {
  sourceLocale: 'en',
  targetLocales: targetLocales,
});

// (4) Warten bis alle Übersetzungen abgeschlossen sind
let translationIds = [];
const statusQuery = Object.values(enqueueResult.data).flatMap(({fileName, versionId}) => {
  return targetLocales.map((locale) => ({locale, fileName, versionId}));
});
while (true) {
  const status = await gt.checkFileTranslations(statusQuery);
  if (status.translations.length === statusQuery.length) {
    translationIds = status.translations.map(translation => translation.id);
    break;
  }
  await new Promise(resolve => setTimeout(resolve, 1000));
}

// (5) Datei herunterladen
const result = await Promise.all(
  translationIds.map(id => gt.downloadTranslatedFile(id))
);

Hinweise

  • Ruft die heruntergeladene Datei als UTF-8-Zeichenfolge ab
  • Die Datei muss eine abgeschlossene Übersetzung für die angegebene locale enthalten
  • Fehl schlägt, wenn die Datei nicht gefunden wird

Nächste Schritte

Wie ist dieser Leitfaden?

downloadTranslatedFile