이 페이지에서

현지화 API

가이드 및 설문조사 현지화 API는 가이드 및 설문조사에 사용할 번역 파일을 XLIFF 1.2 형식으로 가져오고 내보냅니다. 이 API는 외부 번역 관리 시스템 및 워크플로우와 통합됩니다.

이름설명
번역 가져오기XLIFF 파일을 가져와서 하나 이상의 너지에 대한 번역을 추가하거나 업데이트합니다.
번역 내보내기지정된 너지(flag_key 기준)의 번역을 XLIFF 1.2 파일로 내보냅니다.

지역

여기에 설명된 모든 API 엔드포인트는 다음 기본 URL과 관련이 있습니다.

데이터 상주기본 URL
기본값https://app.amplitude.com/a/
EUhttps://app.eu.amplitude.com/a/

인증

API는 기본 인증을 사용합니다. API 키(앱 키가 아님)와 프로젝트 비밀 키를 제공해야 합니다.

YOUR_API_KEY:YOUR_PROJECT_SECRET_KEY 문자열을 Base64로 인코딩하여 기본 인증 헤더를 구성합니다.

예제 헤더: Authorization: Basic <base64_encoded_api_key:project_secret_key>

<base64_encoded_api_key:project_secret_key>을(를) 실제 Base64 인코딩된 자격 증명으로 대체하십시오.

XLIFF 파일 구조

이 API는 XLIFF 버전 1.2를 사용합니다. XLIFF 구조는 다음 요소를 포함합니다.

  • <file> 요소: 안내서 또는 설문조사의 번역을 나타냅니다.

    • original: 안내서 또는 설문조사를 식별하며, 선택적으로 특정 변형을 식별합니다.
      • 형식: <key> 또는 <key>_<variant>
      • <key>: 사용자의 가이드 또는 설문조사의 고유 키입니다.
      • <variant>(선택 사항): 가이드 또는 설문조사 첫 사용 후 특정 변형의 식별자입니다.
        • 가져오기의 경우 <variant>가 생략된 경우 API는 가이드 또는 설문조사의 첫 번째 변형을 업데이트합니다.
        • 내보내기의 경우 가이드나 설문조사에 활성 변형이 여러 개 있는 경우, 각 변형은 XLIFF 문서 내 별도의 <file> 요소에 나타납니다.original 속성은 <key>_<variant> 형식을 사용하여 두 속성을 구별합니다.
    • datatype="plaintext"
    • source-language: 소스 언어 코드입니다(예: "en").
    • target-language: 이 파일의 번역에 대한 대상 언어 코드입니다(예: "de", "fr").

  • <body> 요소: 하나 이상의 <trans-unit>요소를 포함합니다.

  • <trans-unit> 요소: 번역할 텍스트 세그먼트를 나타냅니다.

    • id: 안내서 또는 설문조사 첫 사용 후 텍스트 세그먼트에 대한 고유 식별자입니다(예: snooze_label, step_1_title, step_6_content.markdown). 이러한 ID는 사용자의 가이드 또는 설문조사 콘텐츠의 번역 가능한 필드에 해당합니다.
    • <source>: source-language의 원본 텍스트입니다.
    • <target>: target-language에 있는 번역된 텍스트입니다. 가져오기를 위해서는 여기에 번역을 제공하십시오. 내보내기 시 요소에는 기존 번역이 포함됩니다. 빈 <target> 요소는 텍스트가 아직 해당 대상 언어로 번역되지 않았음을 의미합니다.

엔드포인트

번역 가져오기

XLIFF 파일을 가져와서 하나 이상의 가이드나 설문조사에 대한 번역을 추가하거나 업데이트합니다. 가져오기가 성공적으로 완료되면 Amplitude는 애플리케이션의 관련 캐시를 삭제하여 새 번역을 사용할 수 있도록 합니다.

  • HTTP 메소드: POST
  • URL: /import/
  • 헤더:
    • Authorization: Basic <base64_encoded_api_key:project_secret_key>
    • Content-Type: application/xml; charset=utf-8
  • 요청 본문: 원시 XLIFF 1.2 XML 콘텐츠입니다.
    xml
    <?xml version="1.0" encoding="UTF-8"?>
<xliff version="1.2" xmlns="urn:oasis:names:tc:xliff:document:1.2">
    <file original="your-nudge-flag-key" datatype="plaintext" source-language="en" target-language="de">
        <body>
            <trans-unit id="step_1_title">
                <source>Welcome!</source>
                <target>Willkommen!</target>
            </trans-unit>
            <trans-unit id="step_1_content.markdown">
                <source>This is an important announcement.</source>
                <target>Dies ist eine wichtige Ankündigung.</target>
            </trans-unit>
            <!-- Add more trans-unit elements as needed -->
        </body>
    </file>
    <!-- Add more file elements for other Nudges or languages -->
</xliff>
  • 요청 예제(curl):
    bash
    curl -X POST \\
  -H "Authorization: Basic YOUR_BASE64_ENCODED_CREDENTIALS" \\
  -H "Content-Type: application/xml; charset=utf-8" \\
  --data \'\'\'<?xml version="1.0" encoding="UTF-8"?>
<xliff version="1.2" xmlns="urn:oasis:names:tc:xliff:document:1.2"><file original="nudge-translated-announcement-1" datatype="plaintext" source-language="en" target-language="de">
        <body>
            <trans-unit id="step_1_title">
                <source>Announcement</source>
                <target>Ankündigung</target>
            </trans-unit>
        </body>
    </file>
</xliff>\'\'\' \\
  "https://app.amplitude.com/a/guides-surveys/api/v1/localization/import/"
    (<base64_encoding(api_key:project_secret_key)>을(를) 실제 Base64 인코딩 API 키 및 프로젝트 비밀 키로 대체하십시오.)
  • 응답:
    • 200 OK: XLIFF 파일의 모든 번역 단위가 성공적으로 처리되었습니다. 응답 본문은 처리된 각 파일의 상태를 자세히 설명하는 JSON 객체입니다. 예제:
    json
      {
    "nudge-translated-announcement-1": {
      "de": {
        "state": "COMPLETE",
        "message": "Updated 5 translation units."
      }
    }
  }

번역 내보내기

지정된 가이드 또는 설문조사(기준key)에 대한 번역을 XLIFF 1.2 파일로 내보냅니다.

  • HTTP 메소드: GET
  • URL: /export/
  • 헤더:
    • Authorization: Basic <base64_encoded_api_key:project_secret_key>
  • 쿼리 매개 변수:
    • key (문자열, 필수): 번역을 내보낼 수 있는 가이드 또는 설문조사의 키입니다. 여러 가이드나 설문조사를 요청하려면 이 매개 변수를 여러 회 제공하거나 쉼표로 구분된 목록을 제공하십시오(예: ?key=key1&key=key2또는 ?key=key1,key2). 최소 한 개 이상의 key은(는) 필수입니다.
    • locale (문자열, 선택 사항): 내보낼 특정 대상 언어 코드입니다(예: "de", "fr"). 여러 로케일에 대해 이 매개변수를 여러 회 제공하십시오. 이 옵션을 생략하면 API는 소스 언어를 제외한 앱에 대해 구성된 모든 대상 로케일의 번역을 내보냅니다.
  • 요청 예제(curl): 단일 안내서나 설문조사와 특정 로케일의 번역물을 내보내려면 다음과 같이 하십시오.
    bash
    curl -X GET \\
  -H "Authorization: Basic YOUR_BASE64_ENCODED_CREDENTIALS" \\
  "https://app.amplitude.com/a/guides-surveys/api/v1/localization/export/?key=nudge-translated-announcement-1&locale=de"
    여러 가이드 또는 설문조사 키 및 로케일을 내보내려면 다음을 수행하십시오.
    bash
    curl -X GET \\
  -H "Authorization: Basic YOUR_BASE64_ENCODED_CREDENTIALS" \\
  "https://app.amplitude.com/a/guides-surveys/api/v1/localization/export/?key=key-one&key=key-two&locale=de&locale=fr"
    (YOUR_BASE64_ENCODED_CREDENTIALS을(를) 실제 Base64 인코딩 API 키 및 프로젝트 비밀 키로 대체하십시오.)
  • 대응:
    • 200 OK: 응답 본문에는 XLIFF 1.2 XML 콘텐츠가 포함되어 있습니다.

이 내용이 도움이 되었나요?