checkFileTranslations
API Reference für die Methode checkFileTranslations zur Prüfung des Übersetzungsstatus, ohne files herunterzuladen
Übersicht
Die Methode checkFileTranslations prüft den Übersetzungsstatus von files, ohne deren Inhalt herunterzuladen.
Das ist nützlich, um den Übersetzungsfortschritt zu überwachen, den Fertigstellungsstatus zu prüfen und festzustellen, welche Übersetzungen verfügbar sind.
const gt = new GT({ projectId: 'your-project-id', apiKey: 'your-api-key' });
const status = await gt.checkFileTranslations([
{
versionId: 'version-123',
fileName: 'app.json',
locale: 'es'
}
]);Referenzen
Parameter
| Name | Typ | Beschreibung |
|---|---|---|
data | FileTranslationQuery[] | Array von Dateiübersetzungsabfragen zur Überprüfung |
options? | CheckFileTranslationsOptions | Optionale Konfiguration für die Anforderung |
FileTranslationQuery
| Name | Type | Description |
|---|---|---|
versionId | string | Versions-ID der zu prüfenden Datei |
fileName? | string | Dateiname (erforderlich, wenn fileId nicht angegeben ist) |
fileId? | string | Datei-ID (erforderlich, wenn fileName nicht angegeben ist) |
locale | string | Ziel-Locale, für die der Übersetzungsstatus geprüft werden soll |
CheckFileTranslationsOptions
| Name | Typ | Beschreibung |
|---|---|---|
timeout? | number | Zeitüberschreitung der Anfrage in Millisekunden |
Rückgabewert
Promise<CheckFileTranslationsResult> – Enthält Informationen zum Übersetzungsstatus.
type CheckFileTranslationsResult = {
translations: CompletedFileTranslationData[];
}| Eigenschaft | Typ | Beschreibung |
|---|---|---|
translations | CompletedFileTranslationData[] | Array mit Statusdaten zu Übersetzungen |
Struktur von CompletedFileTranslationData
type CompletedFileTranslationData = {
id: string;
fileId: string;
versionId: string;
fileName: string;
locale: string;
status: 'completed' | 'pending' | 'failed';
completedAt: string | null;
approvedAt: string | null;
publishedAt: string | null;
createdAt: string;
updatedAt: string;
}Beispiele
Grundlegende Nutzung
Prüfen Sie den Übersetzungsstatus für bestimmte files und locales:
// (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) Übersetzungsauftrag in Warteschlange 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));
}Hinweise
- Der Übersetzungsstatus umfasst die Zustände
pending,completedundfailed - Abgeschlossene Übersetzungen müssen möglicherweise noch freigegeben werden, bevor sie veröffentlicht werden
- Verwenden Sie diese Methode für eine effiziente Statusabfrage beim Überwachen mehrerer Übersetzungsjobs
Nächste Schritte
- Lies den Quickstart für ein vollständiges Beispiel zur Nutzung dieser Methode
- Siehe
downloadTranslatedFile, um fertige Übersetzungen herunterzuladen - Siehe
enqueueFiles, um Übersetzungsjobs zu erstellen - Siehe
querySourceFile, um Informationen zur Quelldatei und zu Übersetzungen abzurufen
Wie ist diese Anleitung?