Načtení překladové úlohy

Zkontrolujte cíle dokumentů, počkejte na dokončení a stáhněte dostupné výstupy.

Načtěte úlohu pomocí id, které získáte při jejím vytvoření:

http
GET /v2/localization/jobs/:id
X-API-Key: YOUR_API_KEY

Odpověď popisuje všechny dokumenty a jejich cílové jazyky. Může obsahovat dokončené cíle, zatímco jiné se ještě zpracovávají nebo jejich zpracování selhalo.

Pole úlohy #

PoleVýznam
id, organizationId, engineIdIdentifikace úlohy, organizace, které úloha patří, a engine.
sourceLocaleZdrojový jazyk.
triggerPůvod, například api, cli, ci nebo integrace.
statusStav úlohy s typovou značkou, popsaný níže.
createdAt, updatedAtŘetězce s časovými razítky ve formátu ISO.
createdByInformace o tvůrci, případně null, pokud nejsou dostupné. Osobní klíč se přiřazuje uživateli, kterému patří.
documentsDokumenty, jejich formáty, zdrojové adresy a průběh zpracování cílů.
uploadsAdresy chybějících artefaktů a URL pro nahrání, dokud úloha čeká na spuštění; po spuštění úlohy je pole prázdné.

Stavy úlohy #

status._tagJak postupovat
PendingNahrajte chybějící artefakty a zavolejte /start.
RunningDotaz zopakujte později. Zkontrolujte fáze zpracování cílů a zjistěte, zda zpracování probíhá, nebo se čeká na kontrolu.
CompletedStáhněte a zkontrolujte výstupy. Před jejich přijetím zkontrolujte také varování jednotlivých fází.
FailedProjděte status.message a chyby jednotlivých cílů. Dokončené cíle zůstávají dostupné.
CancelledZpracování se zastavilo. Zkontrolujte cíle a zjistěte, které výstupy už byly dokončeny.

Completed, Failed a Cancelled jsou koncové stavy úlohy. Částečné selhání označuje neúspěšnou úlohu, u níž byly některé cíle dokončeny a jiné selhaly.

Pole dokumentů a cílů #

Každý dokument obsahuje id, key, format, source, previousSource a targets. source je adresa artefaktu i v případě, že požadavek obsahoval přímo vložený JSON. Není-li údaj previousSource k dispozici, má hodnotu null.

Každý cíl obsahuje:

PoleVýznam
localeCílový jazyk.
previousTranslationAdresa předchozího cílového artefaktu, případně null.
statusPending, Completed nebo Failed v poli _tag.
stagesPrůběh jednotlivých fází, včetně stavu a počtů jednotek.

Stav dokončeného cíle obsahuje artifact a downloadUrl; stav cíle, jehož zpracování selhalo, obsahuje message. Následující výňatek z odpovědi ukazuje stav dokončeného cíle:

json
{
  "_tag": "Completed",
  "artifact": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "downloadUrl": "/v2/localization/jobs/lfr_example/artifacts/aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}

Použijte adresu a URL skutečně vrácené v odpovědi. URL je relativní vůči https://api.lingo.dev a vyžaduje ověření; nejde o veřejný podepsaný odkaz ke stažení. Při stažení obdržíte bajty souboru ve formátu dokumentu.

Více cílů může sdílet jeden artefakt. Apple String Catalog slučuje požadované jazyky do jednoho souboru .xcstrings. Tento sloučený výstup uložte pouze jednou a zkontrolujte v něm položky jednotlivých jazyků. Nepovažujte každé stažení za samostatný jednojazyčný katalog.

Pravidelné dotazování a shromažďování výstupů #

Dotazujte se na úlohu v pevně stanoveném intervalu, například každé dvě sekundy, a v aplikaci nastavte celkový časový limit čekání. Pokud načtení dočasně selže, uchovejte ID a pokus opakujte s postupně se prodlužujícími prodlevami. Ukončení čekání nezruší zpracování na serveru. Lidská kontrola může trvat podstatně déle než krátký časový limit požadavku aplikace.

Stáhněte cíl, jakmile má stav Completed. Pokud vaše aplikace potřebuje publikovat všechny jazyky společně, počkejte na všechny požadované cíle a toto pravidlo publikování uplatněte ve vlastním úložišti. Jeden dokončený soubor neznamená, že zpracování všech jazyků proběhlo úspěšně.

Kompletní program pro pravidelné dotazování a stahování najdete ve stručném úvodu. Informace o práci s revizemi zdroje a rozhodování o opakovaných pokusech najdete v části Vytvoření překladového workflow.