📈

【Shopify.dev和訳】Admin API/GraphQL reference/Translations

2021/10/02に公開約34,700字

この記事について

この記事は、Admin API/Graph QL reference/Translationの記事を和訳したものです。

記事内で使用する画像は、公式ドキュメント内の画像を引用して使用させていただいております。

Shopify アプリのご紹介

Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。

https://apps.shopify.com/shopify-application-314?locale=ja&from=daniel

Shopify アプリである、「らくらく日本語フォント設定|リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。

https://apps.shopify.com/font-picker-1?locale=ja&from=daniel

Translation APIs

翻訳可能なリソースの翻訳を作成・管理します。

このセクションでは

  • HasLocalizationExtensions
    指定されたリソースに関連付けられたローカリゼーションエクステンションです。例えば、政府の請求書のタックス ID などです。

  • HasLocalizationExtensionsForDraftOrders
    指定されたリソースに関連付けられたローカリゼーションエクステンションです。例えば、政府の請求書のタックス ID などです。

  • HasPublishedTranslations
    リソースに関連付けられた公開された翻訳です。

  • Locale
    ロケールです。

  • LocalizationExtension
    ローカライズエクステンションによってキャプチャされた値を表します。ローカライズエクステンションとは、国際注文の際に特定の国が要求する追加フィールドです。たとえば、一部の国では、税関情報や納税者番号の追加フィールドが必要です。

  • LocalizationExtensionInput
    LocalizationExtensionInput の入力フィールドを指定します。

  • LocalizationExtensionKey
    ローカリゼーション拡張機能のキーです。

  • LocalizationExtensionPurpose
    ローカリゼーション拡張機能の目的です。

  • PublishedTranslation
    リソースのフィールドの公開された翻訳です。

  • ShopLocale
    ショップの利用可能なロケールです。

  • ShopLocaleInput
    ショップ ロケールの入力フィールドを指定します。

  • TranslatableContent
    リソースのフィールドの翻訳可能なコンテンツです。

  • TranslatableResource
    翻訳可能なフィールドを持つリソースです。

  • TranslatableResourceType
    翻訳可能なリソースのタイプを指定します。

  • Translation
    リソースのフィールドの翻訳。

  • TranslationInput
    翻訳の作成または更新時に使用するフィールドと値を提供します。

  • shopLocaleDisable
    あるショップのロケールを無効にします。

  • shopLocaleEnable
    ショップのロケールを有効にします。

  • shopLocaleUpdate
    お店のロケールを更新します。

  • translationsRegister
    翻訳を作成または更新します。

  • translationsRemove
    翻訳を削除します。

OBJECTS

Locale (object)


ロケールです。

フィールド値

フィールド値 説明
isoCode (String!) ロケールの ISO コード。
name (String!) ロケールの名称。

Locale を返す型

LocalizationExtension (object)


フィールド値

フィールド値 説明
countryCode (CountryCode!) 国の ISO 3166-1 alpha-2 コード。
key (LocalizationExtensionKey!) 許可されているローカライズ拡張キー。
purpose (LocalizationExtensionPurpose!) このローカリゼーション拡張の目的。
title (String!) ローカライズ拡張のタイトルです。
value (String!) フィールドの値です。

LocalizationExtension を返す型

PublishedTranslation (object)


ローカライズエクステンションで取得した値を表します。ローカライズエクステンションとは、海外からの注文で特定の国が要求する追加フィールドのことです。例えば、一部の国では、税関情報や納税者番号などの追加フィールドが必要となります。

フィールド値

フィールド値 説明
key (String!) 翻訳キーです。
locale (String!) 翻訳のロケールを指定します。
value (String) 翻訳の値です

PublishedTranslation を返す型

ShopLocale (object)


ショップの利用可能なロケール。

フィールド値

フィールド値 説明
locale (String!) ロケールの識別子です。
name (String!) ロケールの名前。
primary (Boolean!) このロケールがショップのデフォルトロケールであるかどうか。
published (Boolean!) このロケールが公開されているかどうか。

ShopLocale を返す型

ShopLocale に対するミューテーション

TranslatableContent (object)


リソースのフィールドの翻訳可能なコンテンツです。

フィールド値

フィールド値 説明
digest (String) コンテンツのダイジェスト(ハッシュ)。
key (String!) コンテンツのキー。
locale (String!) コンテンツのロケールを指定します。
value (String コンテンツの値

TranslatableContent を返すタイプ

TranslatableResource (object)


翻訳可能なフィールドを持つリソースです。

フィールド値

フィールド値 説明
resourceId (ID!) リソースの GID。
ranslatableContent ([TranslatableContent!]!) 翻訳可能なコンテンツ。
translations ([Translation!]!) 翻訳可能なコンテンツの翻訳。
引数 説明
locale ( String! ) 必須 ロケールによって翻訳をフィルタリングします。
outdated ( Boolean ) 期限切れの翻訳でフィルタリングします。

TranslatableResource を返す型

Translation (object)


リソースのあるフィールドの翻訳。

フィールド値

フィールド値 説明
key (String!) 翻訳キー。
locale (String!) 翻訳のロケール。
outdated (Boolean!) 時代遅れのマークがついています。
value (String) 翻訳の値。

Translation を返す型

Translation のミューテーション

MUTATIONS

shopLocaleDisable (mutation)


あるショップのロケールを無効にします。

インタラクティブな例

これは、mutation クエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使用します。

ヒント:フィールドを自動補完するには Ctrl + Space を使います。

mutation shopLocaleDisable($locale: String!) {
  shopLocaleDisable(locale: $locale) {
    locale
    userErrors {
      field
      message
    }
  }
}
Variables
{
  "locale": "placeholder"
}

引数

引数 説明
locale ( String! ) 必須 無効化するロケールを指定します。

戻り値のフィールド

  • locale (String)
    無効にしたロケール識別子。
  • userErrors ([UserError!]!)
    ミューテーションを実行した際に発生したエラーのリスト。

shopLocaleEnable (mutation)


あるショップのロケールを有効にします。

インタラクティブな例

これは、mutation クエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使用します。

ヒント:フィールドを自動補完するには Ctrl + Space を使います。

mutation shopLocaleEnable($locale: String!) {
  shopLocaleEnable(locale: $locale) {
    shopLocale {
      locale
      name
      primary
      published
    }
    userErrors {
      field
      message
    }
  }
}
Variables
{
  "locale": "placeholder"
}

引数

引数 説明
locale ( String! ) 必須 無効化するロケールを指定します。

戻り値のフィールド

  • shopLocale (ShopLocale)
    有効化されたロケールを指定します。
  • userErrors ([UserError!]!)
    変異を実行した際に発生したエラーのリスト。

shopLocaleUpdate (mutation)


あるショップのロケールを更新します。

インタラクティブな例

これは、Mutation クエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使用します。

ヒント:フィールドを自動補完するには、Ctrl + Space を使います。

mutation shopLocaleUpdate($locale: String!, $shopLocale: ShopLocaleInput!) {
  shopLocaleUpdate(locale: $locale, shopLocale: $shopLocale) {
    shopLocale {
      locale
      name
      primary
      published
    }
    userErrors {
      field
      message
    }
  }
}
Variables
{
  "locale": "placeholder",
  "shopLocale": {}
}

引数

引数 説明
locale ( String! ) 必須 無効化するロケールを指定します。
shopLocale ( ShopLocaleInput! ) 必須 ショップロケールの入力フィールドを指定します。

ショップロケール入力フィールド

フィールド値 説明
published (Boolean) ロケールの公開状態を指定します。

戻り値のフィールド

  • shopLocale (ShopLocale)
    更新されたロケール。
  • userErrors ([UserError!]!)
    mutation を実行した際に発生したエラーのリスト。

translationsRegister (mutation)


翻訳の作成や更新を行います。

インタラクティブな例

これはミューテーションクエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使用してください。

ヒント: フィールドを自動補完するには Ctrl + Space を使用してください。

mutation translationsRegister($resourceId: ID!, $translations: [TranslationInput!]!) {
  translationsRegister(resourceId: $resourceId, translations: $translations) {
    translations {
      key
      locale
      outdated
      value
    }
    userErrors {
      code
      field
      message
    }
  }
}
Variables
{
  "resourceId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "translations": [
    {
      "locale": "placeholder",
      "key": "placeholder",
      "value": "placeholder",
      "translatableContentDigest": "placeholder"
    }
  ]
}

引数

引数 説明
resourceId ( ID! ) 必須 翻訳可能なリソースの ID。
translations ( [TranslationInput!]! ) 必須 翻訳の入力フィールドを指定する。

TranslationInput フィールド

フィールド値 説明
key (String!) 必須 翻訳のキーを指定します。
locale (String!) 必須 翻訳のロケールです。
translatableContentDigest (String!) 必須 翻訳されるコンテンツのダイジェスト(ハッシュ)です。
value (String!) 必須 翻訳された内容の値です。

戻り値のフィールド

translationsRemove (mutation)


翻訳を削除します。

インタラクティブな例

これは、mutation クエリの例です。このクエリを編集するには、下に埋め込まれたインタラクティブツールを使用します。

ヒント:フィールドを自動補完するには Ctrl + Space を使います。

mutation translationsRemove($resourceId: ID!, $translationKeys: [String!]!, $locales: [String!]!) {
  translationsRemove(
    resourceId: $resourceId
    translationKeys: $translationKeys
    locales: $locales
  ) {
    translations {
      key
      locale
      outdated
      value
    }
    userErrors {
      code
      field
      message
    }
  }
}
Variables
{
  "resourceId": "Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=",
  "translationKeys": [
    "placeholder"
  ],
  "locales": [
    "placeholder"
  ]
}

引数

引数 説明
locales ( [String!]! ) 必須 翻訳ロケールのリストです。
resourceId ( ID! ) 必須 翻訳可能なリソースの ID です。
translationKeys ( [String!]! ) 必須 翻訳キーのリスト。

戻り値のフィールド

INTERFACES

HasLocalizationExtensions (interface)


指定されたリソースに関連付けられたローカリゼーション拡張。例えば、政府の請求書のタックス ID などです。

フィールド値

フィールド値 説明
localizationExtensions (LocalizationExtensionConnection!) リソースに関連するローカリゼーションエクステンションのリスト
引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返す。
countryCodes ( [CountryCode!] ) 拡張子の国コードです。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
purposes ( [LocalizationExtensionPurpose!] ) 拡張機能の目的です。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。デフォルト値:false

HasLocalizationExtensions を実装する型

HasLocalizationExtensionsForDraftOrders (interface)


指定されたリソースに関連するローカリゼーションエクステンション。例えば、政府の請求書のタックス ID などです。

フィールド値

フィールド値 説明
localizationExtensions (LocalizationExtensionConnection!) リソースに関連するローカリゼーションエクステンションのリスト
引数 説明
after ( String ) 指定されたカーソルの後に来る要素を返します。
before ( String ) 指定されたカーソルの前にある要素を返す。
countryCodes ( [CountryCode!] ) 拡張子の国コードです。
first ( Int ) リストから最初の n 個の要素までを返します。
last ( Int ) リストから最後の n 個の要素までを返します。
purposes ( [LocalizationExtensionPurpose!] ) 拡張機能の目的です。
reverse ( Boolean ) 基礎となるリストの順序を逆にします。デフォルト値:false

HasLocalizationExtensionsForDraftOrders を実装する型

HasPublishedTranslations (interface)


リソースに関連する公開された翻訳。

フィールド値

フィールド値 説明
translations ([PublishedTranslation!]!) リソースに関連付けられた翻訳。
引数 説明
locale ( String! ) 必須 翻訳のロケールをフィルタリングします。

HasPublishedTranslations を実装する型

INPUTS

LocalizationExtensionInput (input) (object)


LocalizationExtensionInput の入力フィールドを指定します。

フィールド値

フィールド値 説明
key (LocalizationExtensionKey!) 必須 ローカリゼーション拡張機能のキーです。
value (String!) 必須 ローカリゼーション拡張の値です。

ShopLocaleInput (input) (object)


ショップロケールの入力フィールドを指定します。

フィールド値

フィールド値 説明
published (Boolean) ロケールの公開状態を指定します。

TranslationInput (input) (object)


翻訳の作成または更新時に使用するフィールドと値を提供します。

フィールド値

フィールド値 説明
key (String!) 必須 翻訳のキーを指定します。
locale (String!) 必須 翻訳のロケールです。
translatableContentDigest (String!) 必須 翻訳されるコンテンツのダイジェスト(ハッシュ)です。
value (String!) 必須 翻訳された内容の値です。

ENUMS

LocalizationExtensionKey (enum)


ローカライズエクステンションのキーです。

values

  • SHIPPING_CREDENTIAL_BR
    BR 国の拡張キー'ship_credential_br'。

  • SHIPPING_CREDENTIAL_CN
    CN の国のための拡張キー 'shipping_credential_cn'。

  • SHIPPING_CREDENTIAL_KR
    KR 国用の拡張キー'shipping_credential_kr'です。

  • TAX_CREDENTIAL_BR
    国 BR 用の拡張キー 'tax_credential_br' です。

  • TAX_CREDENTIAL_IT
    IT の国のエクステンションキー「tax_credential_it」です。

  • TAX_EMAIL_IT
    IT 国の拡張キー 'tax_email_it' です。

LocalizationExtensionKey を返す型

LocalizationExtensionPurpose (enum)


ローカライズエクステンションの目的。

values

  • SHIPPING
    通関など、出荷の目的で使用されるエクステンション。
  • TAX
    請求書の発行など、税金を目的として使用される拡張機能です。

LocalizationExtensionPurpose を返す型

TranslatableResourceType (enum)


values

  • COLLECTION
    製品のコレクションです。翻訳可能なフィールド: title, body_html, meta_title, meta_description.

  • DELIVERY_METHOD_DEFINITION
    配送方法の定義です。たとえば、 For example, "Standard", または"Expedited"などです。翻訳可能なフィールド: name.

  • EMAIL_TEMPLATE
    電子メール・テンプレートです。翻訳可能なフィールド: title, body_html.

  • LINK
    ユーザーを誘導するためのリンクです。翻訳可能なフィールド: title.

  • METAFIELD

    メタフィールドです。翻訳可能なフィールド: value.

  • ONLINE_STORE_ARTICLE

    オンラインストアの記事です。翻訳可能なフィールド:title, body_html, summary_html, meta_title, meta_description.

  • ONLINE_STORE_BLOG
    オンラインストアのブログです。翻訳可能なフィールド: title, meta_title, meta_description.

  • ONLINE_STORE_PAGE
    オンラインストアのページです。翻訳可能なフィールド: title, body_html, meta_title, meta_description.

  • ONLINE_STORE_THEME
    オンラインストアのテーマです。翻訳可能なフィールド: dynamic keys based on theme data.

  • PAYMENT_GATEWAY
    支払いゲートウェイです。翻訳可能なフィールド: name.

  • PRODUCT
    オンラインストアの商品です。翻訳可能なフィールド: title, body_html, meta_title, meta_description.

  • PRODUCT_OPTION
    オンラインストアのカスタム製品のプロパティ名です。たとえば、「Size」、「Color」、「Material」などがあります。翻訳可能なフィールド: name.

  • PRODUCT_VARIANT
    オンラインストアの製品バリアントです。翻訳可能なフィールド: title, option1, option2, option3.

  • SHOP
    ショップです。翻訳可能なフィールド: meta_title, meta_description.

  • SHOP_POLICY
    ショップのポリシーです。翻訳可能なフィールド: body.

  • SMS_TEMPLATE
    SMS テンプレートです。翻訳可能なフィールド: body.

Shopify アプリのご紹介

Shopify アプリである、「商品ページ発売予告アプリ | リテリア Coming Soon」は、商品ページを買えない状態のまま、発売日時の予告をすることができるアプリです。Shopify で Coming Soon 機能を実現することができます。

https://apps.shopify.com/shopify-application-314?locale=ja&from=daniel

Shopify アプリである、「らくらく日本語フォント設定|リテリア Font Picker」は、ノーコードで日本語フォントを使用できるアプリです。日本語フォントを導入することでブランドを演出することができます。

https://apps.shopify.com/font-picker-1?locale=ja&from=daniel

Discussion

ログインするとコメントできます