Traduzir JSON

Envie um objeto JSON com contexto, indicações e caminhos protegidos e transfira as respetivas traduções.

Envie um objeto JSON diretamente numa tarefa de localização quando a sua aplicação já tiver o conteúdo de origem em memória. O Lingo.dev guarda-o como documento JSON e gera um resultado para cada idioma de destino.

O guia de início rápido apresenta um programa completo. Esta referência descreve os campos do pedido específicos de JSON.

Enviar um documento incorporado #

Crie a tarefa em POST /v2/organizations/:orgId/localization/jobs com uma chave de API em X-API-Key e um Idempotency-Key estável para este envio:

json
{
  "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"
        }
      }
    }
  ]
}

O conteúdo de origem tem de ser um objeto JSON. Pode conter objetos e matrizes aninhados. Os valores de texto nos nós folha são candidatos à tradução; os números, os valores booleanos e os valores nulos mantêm os respetivos tipos JSON. Proteja os identificadores, nomes de produtos ou URLs guardados como texto que devam permanecer inalterados.

Os conteúdos de origem incorporados utilizam format.type: "json". Para JSONC ou outro formato de ficheiro, carregue os bytes do ficheiro.

Adicionar contexto e selecionar conteúdo #

Defina as opções de JSON no format.options do documento:

OpçãoEfeito
contextTexto não vazio que descreve a finalidade ou o público do conteúdo.
hintsConsultas JSONPath associadas a matrizes não vazias de indicações também não vazias. As indicações correspondentes acumulam-se para os textos selecionados. Por predefinição, é um objeto vazio.
lockedKeysCopia os valores de origem selecionados sem os traduzir. O valor predefinido é [].
preservedKeysReutiliza os valores selecionados da versão de destino anterior, quando disponíveis; caso contrário, copia os valores de origem. O valor predefinido é [].
ignoredKeysRemove os valores selecionados do resultado. O valor predefinido é [].
keyScopeGera novamente os textos selecionados por uma lista não vazia de consultas JSONPath. Requer uma tradução anterior para cada idioma de destino.
termScopeGera novamente os textos que correspondem a uma lista não vazia de termos de origem. Requer uma tradução anterior para cada idioma de destino.
injectLocaleEscreve o idioma de destino numa única localização JSONPath, como $.meta.locale. Essa subárvore fica protegida contra tradução.

Utilize JSONPath nos pedidos à API. $.title seleciona uma propriedade da raiz; $.nav.home seleciona uma propriedade aninhada; $['nav.home'] seleciona uma chave literal que contém um ponto; $..productName seleciona essa propriedade a qualquer profundidade. Ao selecionar um objeto ou uma matriz, inclui também os textos dos respetivos descendentes. Os nomes de chaves isolados não são consultas válidas à API.

Os controlos ao nível das chaves são aplicados antes da tradução. Os valores ignorados são removidos; os valores de origem bloqueados têm prioridade sobre os valores de destino preservados. A seleção do âmbito não se sobrepõe a estes controlos. Consulte a referência do formato JSON para saber mais sobre a composição do resultado e as mensagens ICU.

termScope procura subcadeias nos textos de origem, distinguindo maiúsculas de minúsculas. Qualquer termo da lista pode selecionar um texto: "cat" também corresponde a "catalog", enquanto "login" não corresponde a "Login". O texto selecionado é gerado novamente na íntegra, não apenas o termo correspondente. Quando keyScope e termScope estão ambos presentes, o texto tem de cumprir os dois critérios. Utilize uma seleção precisa de chaves JSONPath quando a pesquisa por subcadeia puder incluir mensagens não relacionadas.

Iniciar e consultar o resultado #

Guarde o id devolvido na resposta de criação. Se esta tarefa também fizer referência a ficheiros anteriores ou a outros documentos, carregue cada entrada de uploads e, em seguida, invoque POST /v2/localization/jobs/:id/start.

Leia GET /v2/localization/jobs/:id e verifique o targets de cada documento. Um destino com status._tag: "Completed" tem um status.downloadUrl. Transfira o conteúdo desse URL com a mesma autenticação para obter o objeto JSON. A resposta da tarefa contém informações sobre o progresso e os endereços dos artefactos, não o objeto traduzido.

Para fazer atualizações, envie os artefactos de origem e de destino anteriores, conforme descrito em atualizar um documento existente. Guarde a nova revisão do conteúdo de origem juntamente com o ID da tarefa para impedir que um resultado atrasado substitua conteúdo mais recente.