本地化 LookML 模型

借助模型本地化,您可以根据用户的语言区域自定义模型的标签和说明的显示方式。

本地化不一定基于地理位置或语言。您可以使用语言区域来表示其他区分因素,例如内部用户与外部用户,或经理与个人贡献者,并相应地自定义标签和说明。

本页介绍了本地化项目的步骤:

  1. 通过向模型添加标签、组标签和说明,确定要本地化的元素。
  2. 通过创建语言区域字符串文件,为项目提供本地化定义。
  3. 通过向项目的清单文件添加本地化设置,为项目启用本地化。
  4. 通过将用户分配给语言区域,确定不同用户的显示方式。

模型本地化通常与指定数字格式本地化界面语言设置的管理员一起进行。

本地化模型中的标签和说明

您可以本地化模型中的标签、组标签和说明,包括以下内容:

您还可以在项目中创建本地化的 LookML 信息中心。以下 LookML 信息中心参数可以本地化:

如需查看项目中可以本地化的所有字段,您可以将项目的 本地化级别 设置为 strict。使用此设置后,对于任何可以本地化但没有标签的 LookML 元素,以及 LookML 模型中任何可以本地化但未在语言区域字符串文件中定义的字符串,Looker IDE 都会返回 LookML 验证错误。

在以下示例 LookML 中,为 flights 视图以及 idcountrynumber_of_engines 字段提供了标签。此外,还为 country 字段提供了说明。

view: flights {
  label: "flight_info"
  sql_table_name: flightstats.accidents ;;

  dimension: id {
    label: "id"
    primary_key: yes
    type: number
    sql: ${TABLE}.id ;;
  }

  dimension: country {
    label: "country"
    description: "country_of_departure"
    type: string
    map_layer_name: countries
    sql: ${TABLE}.country ;;
  }

  dimension: number_of_engines {
    label: "number_of_engines"
    type: string
    sql: ${TABLE}.number_of_engines ;;
  }

  dimension: location {
    type: string
    sql: ${TABLE}.location ;;
  }
}

在本页的后续示例中,我们将使用 permissive 本地化级别在字符串文件中本地化这些值。请注意,location 维度没有标签,因此我们可以演示如何显示没有本地化的维度。

创建语言区域字符串文件

语言区域字符串文件使用键值对来定义模型中的标签和说明在每个语言区域中的显示方式。每个键值对的左侧是 本地化键,它是模型中的标签或说明字符串。键值对的右侧用于定义您希望该字符串在 Looker 界面中的显示方式。

对于要用于项目的每个语言区域,您都需要创建一个专用的字符串文件。为每个语言区域仅创建一个字符串文件。您必须有一个字符串文件,其名称与默认语言区域匹配。例如,如果您在项目的清单文件中指定了 default_locale: en,则必须在模型中有一个名为 en.strings.json 的文件。每个字符串都必须在 默认语言区域字符串文件中定义,否则不会本地化。

en.strings.json 文件示例将用于所有 Locale 值为 en 的用户。在以下示例 LookML 中,en 也被指定为默认语言区域,因此必须在此文件中定义所有字符串才能进行本地化。

{
  "flight_info": "Flights",
  "id": "Identifier",
  "country_of_departure": "Country of Departure",
  "number_engines": "Number of Engines"
}

下表显示了语言区域设置为 en 的用户在 Looker 探索的数据表中看到的内容:

Flights Identifier Flights country Flights Location Flights Number of Engines
493 Congo Kisangani, Congo 3
2167 Saudi Arabia Riyadh, Saudi Arabia 3
2657 Austria Vienna, Austria 2
17992 United States Kansas City, MO 2
18893 United States Anchorage, AK 4

请注意以下几点:

  • 在本页前面显示的 flights 视图示例 LookML 中,未为 location 维度提供标签,因此 Looker 会将该维度的名称大写并显示为“Location”。
  • 未在 en.strings.json 文件中定义“country”标签的本地化,因此 Looker 会按视图文件中的定义显示该标签,而不将其大写:“country”。

再举一个例子,我们可以创建一个 es_ES.strings.json 文件,该文件将用于所有 Locale 值为 es_ES 的用户:

{
  "flight_info": "Vuelos",
  "id": "Identificador",
  "country": "País",
  "country_of_departure": "País de Partida",
  "number_engines": "Número de Motores"
}

下表显示了语言区域设置为 es_ES 的用户在 Looker 中看到的内容:

Vuelos Identificador Vuelos country Vuelos Location Vuelos Número de Motores
493 Congo Kisangani, Congo 3
2167 Saudi Arabia Riyadh, Saudi Arabia 3
2657 Austria Vienna, Austria 2
17992 United States Kansas City, MO 2
18893 United States Anchorage, AK 4

请注意以下几点:

  • 与上一个示例一样,在添加了标签和说明的旧版视图中,未为位置维度提供标签,因此 Looker 会将该维度的名称大写并显示为“Location”。
  • 未在 en.strings.json 文件(默认语言区域字符串文件)中定义“country”标签的本地化。这意味着,即使在 es_ES.strings.json 文件中定义了“country”,Looker 也不会本地化此字符串,而是按视图文件中的定义显示该标签:“country”。

向项目的清单文件添加本地化设置

如需为项目启用本地化,请将 localization_settings 参数添加到项目的清单文件中。

在清单文件中,添加本地化设置。示例如下:

localization_settings: {
  default_locale: en
  localization_level: permissive
}

default_locale

default_locale 参数用于指定项目中默认语言区域字符串文件的名称。

默认语言区域字符串文件决定了模型中的哪些字符串会被本地化。即使在另一个语言区域字符串文件中定义了标签或说明字符串,如果未在 默认语言区域字符串文件中定义,Looker 界面也会显示未本地化的字符串。

不要将项目的默认语言区域与 Looker 用户的默认语言区域混淆。您的 Looker 管理员可以设置默认语言区域为您的实例。如果未设置默认语言区域,Looker 会默认使用 en如果管理员没有为用户或用户所属的用户组专门输入 Locale 值,Looker 会将用户分配给默认实例语言区域。并且,如果管理员没有设置默认实例语言区域,Looker 会将用户分配给 en 语言区域。

因此,除非您确定 Looker 管理员会为所有 Looker 用户设置 Locale 值,否则您应将项目的 default_locale 参数设置为实例的默认语言区域(如果未设置默认语言区域,则设置为 en),并在该语言区域的 .strings.json 文件中定义所有标签和说明的本地化。

localization_level

项目的本地化级别用于指定是否允许模型中存在未本地化的元素:

  • 将本地化级别设置为 strict,以要求项目中的所有模型、探索、视图和字段都使用本地化的标签。对于任何没有标签的此类元素,以及任何未在默认语言区域字符串文件中定义的标签和说明,Looker IDE 都会返回 LookML 验证错误。
  • 将本地化级别设置为 permissive,以允许元素没有标签,并允许标签和说明未在默认本地化字符串文件中定义。

即使您确实需要 strict 本地化级别,在开发项目时将项目的本地化级别设置为 permissive 也有助于防止验证错误。完成所有标签和说明的本地化后,您可以将本地化级别设置为 strict 以查看任何错误。

将用户分配给语言区域

设置好语言区域字符串文件后,您可以将用户分配给与其中一个语言区域字符串文件对应的语言区域。您可以在 实例用户组单个用户级别执行此操作,方法是使用 Locale 字段或 locale 用户属性。

例如,如果您希望用户看到在 es_ES.strings.json 文件中定义的标签和说明,Looker 管理员应将用户的 Locale 设置为 es_ES

您可以使用字符串文件创建自定义语言区域,方法是点击 Locale 字段并输入字符串文件名,而不是从下拉菜单中选择内置语言区域。如需了解详情,请参阅用户文档页面。

为已签名的嵌入用户设置语言区域

您可以像添加任何其他用户属性一样,在已签名的嵌入网址中添加用户的语言区域值。已签名的嵌入所需的具体格式取决于用于构建已签名的嵌入网址脚本的编程语言,但用户属性的名称为 locale。如需详细了解已签名的嵌入网址以及用于构建已签名的嵌入网址的工具,请参阅已签名的嵌入文档页面。

在 Liquid 变量中使用语言区域

如前所述,借助模型本地化,您可以针对不同的语言区域自定义模型标签和说明的显示方式。但您也可以在 Liquid 变量中添加本地化键,这样您也可以本地化数据值。

例如,在名为 en.strings.json 的默认语言区域字符串文件中,我们可以使用以下条目创建本地化键 domesticinternational

{
  "domestic": "Domestic",
  "international": "International"
}

然后在 es_ES.strings.json 文件中,我们可以提供这些本地化键的西班牙语版本:

{
  "domestic": "Nacional",
  "international": "Internacional"
}

接下来,我们可以在 Liquid 变量中使用 domesticinternational 本地化键来本地化维度的输出:

dimension: from_US {
    label: "from_us"
    type: string
    sql: CASE
         WHEN ${TABLE}.country = 'United States' THEN '{{ _localization['domestic'] }}'
         ELSE '{{ _localization['international'] }}'
         END;;
  }

语言区域为 en 的用户将看到以下结果:

Flights Identifier Flights country Flights From the US?
289 United States Domestic
400 Canada International
493 Congo International
936 United States Domestic

语言区域为 es_ES 的用户将看到以下结果:

Vuelos Identificador Vuelos País Vuelos ¿De Los Estados Unidos?
289 United States Nacional
400 Canada Internacional
493 Congo Internacional
936 United States Nacional

语言区域为 es_ES 的用户会看到本地化为“Nacional”和“Internacional”的“Domestic”和“International”数据。

您还可以在 LookML 信息中心过滤条件LookML 信息中心元素过滤条件中使用 Liquid,以本地化过滤条件中的默认值。例如,如果 LookML 信息中心有一个图块使用此本地化模型中的数据,并且该图块上有一个过滤条件在 LookML 中定义如下:

filters:
  flights.from_US: "{{ _localization['domestic'] }}"

当语言区域为 en 的用户从信息中心内的该图块进行探索时,探索将根据 Flights From the US? 字段的值 Domestic 进行过滤,并且探索中的数据表将包含以下结果:

Flights Identifier Flights country Flights From the US?
289 United States Domestic
936 United States Domestic

当语言区域为 es_ES 的用户从信息中心内的该图块进行探索时,探索将根据 Vuelos ¿De Los Estados Unidos? 字段的值 Nacional 进行过滤,并且探索中的数据表将包含以下结果:

Vuelos Identificador Vuelos País Vuelos ¿De Los Estados Unidos?
289 United States Nacional
936 United States Nacional

了解本地化规则如何应用于扩展和优化后的对象

请注意,当您扩展视图、探索或 LookML 信息中心,以及当您优化视图或探索时,本地化规则适用。

如果您扩展或优化了某个对象,然后添加了新的标签或说明,则应在语言区域字符串文件中提供本地化定义。

例如,如果我们有一个 flights 视图:


view: flights {
  label: "flight_info"
  sql_table_name: flightstats.accidents ;;
  ...
}

然后,我们创建一个新视图,该视图扩展了 flights 视图:

include: "/views/flights.view"

view: flights_enhanced {
  extends: [flights]
  label: "enhanced_flight_info"
}

在语言区域字符串文件中,我们需要定义两个视图标签字符串("flight_info""enhanced_flight_info")。如果项目的本地化级别设置为 strict,则在我们定义新标签或说明之前,我们将无法提交任何更新。