downloadTranslatedFile
API Reference für die Methode downloadTranslatedFile zum Herunterladen fertiggestellter Übersetzungs-files
Überblick
Die Methode downloadTranslatedFile lädt den Inhalt einer einzelnen, bereits übersetzten Datei als UTF‑8‑String herunter.
Sie 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 fertiggestellten Übersetzungen.
Verwenden Sie zunächst checkFileTranslations, um zu prüfen, ob die Übersetzungen abgeschlossen sind, bevor Sie versuchen, sie herunterzuladen.
Referenzen
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
file | FileInfo | Dateiobjekt mit Informationen, welche Datei heruntergeladen werden soll |
options? | DownloadFileOptions | Optionale Konfiguration für die Downloadanfrage |
FileInfo-Struktur
| Name | Typ | Beschreibung |
|---|---|---|
fileId | string | Eindeutiger Bezeichner der Datei, die heruntergeladen werden soll |
locale | string | Ziel-locale der zu ladenden Übersetzung |
versionId? | string | Optionale Versions-ID für die Datei |
DownloadFileOptions
| Name | Type | Beschreibung |
|---|---|---|
timeout? | number | Zeitüberschreitung der Anfrage in Millisekunden |
Rückgabewert
Promise<string> – Der übersetzte Dateiinhalt als UTF‑8‑Zeichenfolge.
Die zurückgegebene Zeichenfolge enthält den übersetzten Dateiinhalt im gleichen Format wie die ursprüngliche Quelldatei; dabei wurde sämtlicher übersetzbarer Text in die Ziel-Locale übertragen.
Beispiel
// (1) Eine 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) Übersetzungsauftrag für die Datei einreihen
const enqueueResult = await gt.enqueueFiles(
uploadedFiles,
{
sourceLocale: 'en',
targetLocales: targetLocales,
});
// (4) Auf Abschluss aller Übersetzungen warten
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-String ab
- Die Datei muss für die angegebene locale eine vollständige Übersetzung enthalten
- Schlägt fehl, wenn die Datei nicht gefunden wird
Nächste Schritte
- Siehe
checkFileTranslations, um den Übersetzungsstatus vor dem Herunterladen zu prüfen - Siehe
downloadFileBatch, um mehrere files effizient herunterzuladen - Siehe
uploadSourceFilesfür den Upload-Prozess - Siehe
enqueueFiles, um Übersetzungsaufträge zu starten
Wie ist diese Anleitung?