Překlad JSON
Odešlete objekt JSON s kontextem, nápovědami a chráněnými cestami a pak si stáhněte jeho překlady.
Pokud už má vaše aplikace zdrojová data v paměti, odešlete objekt JSON přímo v lokalizační úloze. Lingo.dev jej uloží jako dokument JSON a pro každý cílový jazyk vytvoří jeden výstup.
Průvodce rychlým startem obsahuje kompletní program. Tato reference popisuje pole požadavku specifická pro JSON.
Odeslání vloženého dokumentu #
Vytvořte úlohu na POST /v2/organizations/:orgId/localization/jobs s klíčem API v X-API-Key a stabilní hodnotou Idempotency-Key pro toto odeslání:
{
"engineId": "YOUR_ENGINE_ID",
"sourceLocale": "en",
"targetLocales": ["de", "fr"],
"documents": [
{
"key": "settings.json",
"format": {
"type": "json",
"options": {
"context": "Settings dialog in a team collaboration application",
"hints": { "$.save": ["Button that saves the edited settings"] },
"lockedKeys": ["$.productName"]
}
},
"source": {
"content": {
"save": "Save changes",
"cancel": "Cancel",
"productName": "Acme"
}
}
}
]
}Zdrojem musí být objekt JSON. Může obsahovat vnořené objekty a pole. Koncové hodnoty typu řetězec jsou určeny k překladu; čísla, booleovské hodnoty a hodnoty null si zachovávají své datové typy JSON. Pokud mají identifikátory, názvy produktů nebo adresy URL uložené jako řetězce zůstat beze změny, nastavte pro ně ochranu.
Vložené zdroje používají format.type: "json". Pro JSONC nebo jiný formát souboru nahrajte bajty souboru.
Přidání kontextu a výběr obsahu #
Nastavení pro JSON vložte do format.options dokumentu:
| Možnost | Účinek |
|---|---|
context | Neprázdný text popisující účel obsahu nebo jeho cílovou skupinu. |
hints | Dotazy JSONPath přiřazené k neprázdným polím neprázdných nápověd. U vybraných řetězců se všechny odpovídající nápovědy kombinují. Výchozí hodnotou je prázdný objekt. |
lockedKeys | Zkopíruje vybrané zdrojové hodnoty bez překladu. Výchozí hodnota je []. |
preservedKeys | Znovu použije vybrané hodnoty z předchozího cílového dokumentu, pokud jsou k dispozici; jinak zkopíruje zdrojové hodnoty. Výchozí hodnota je []. |
ignoredKeys | Odebere vybrané hodnoty z výstupu. Výchozí hodnota je []. |
keyScope | Znovu vygeneruje řetězce vybrané neprázdným seznamem dotazů JSONPath. Vyžaduje předchozí překlad pro každý cílový jazyk. |
termScope | Znovu vygeneruje řetězce odpovídající neprázdnému seznamu zdrojových výrazů. Vyžaduje předchozí překlad pro každý cílový jazyk. |
injectLocale | Zapíše cílový jazyk na jediné místo určené cestou JSONPath, například $.meta.locale. Tento podstrom je chráněn před překladem. |
V požadavcích API používejte JSONPath. $.title vybírá vlastnost na kořenové úrovni; $.nav.home vybírá vnořenou vlastnost; $['nav.home'] vybírá klíč, jehož doslovný název obsahuje tečku; $..productName vybírá danou vlastnost v libovolné hloubce. Výběr objektu nebo pole zahrnuje i všechny řetězce v něm vnořené. Samotné názvy klíčů nejsou platnými dotazy API.
Pravidla pro klíče se vyhodnocují před překladem. Ignorované hodnoty se odeberou; uzamčené zdrojové hodnoty mají přednost před zachovanými cílovými hodnotami. Výběr rozsahu tato pravidla nemění. Podrobnosti o sestavení výstupu a zprávách ICU najdete v referenci formátu JSON.
termScope hledá podřetězce ve zdrojových řetězcích a rozlišuje velká a malá písmena. K výběru řetězce stačí kterýkoli z uvedených výrazů: "cat" odpovídá i "catalog", zatímco "login" neodpovídá "Login". Znovu se vygeneruje celý vybraný řetězec, nejen odpovídající výraz. Pokud jsou zadány keyScope i termScope, musí řetězec splňovat obě podmínky. Pokud by hledání podřetězce zahrnulo i nesouvisející zprávy, vyberte konkrétní klíč pomocí JSONPath.
Spuštění a načtení výsledku #
Uložte si id z odpovědi na vytvoření úlohy. Pokud úloha odkazuje také na předchozí soubory nebo jiné dokumenty, nahrajte všechny položky z uploads a poté zavolejte POST /v2/localization/jobs/:id/start.
Načtěte GET /v2/localization/jobs/:id a u každého dokumentu zkontrolujte targets. Cíl s status._tag: "Completed" má status.downloadUrl. Objekt JSON získáte stažením obsahu z této adresy URL se stejnými ověřovacími údaji. Samotná odpověď úlohy obsahuje informace o průběhu a adresy artefaktů, nikoli přeložený objekt.
Při aktualizacích odešlete předchozí zdrojové a cílové artefakty podle postupu v části Aktualizace existujícího dokumentu. Novou revizi zdroje uchovávejte společně s ID úlohy, aby opožděný výsledek nemohl nahradit novější obsah.