Alternate Language Profiles | Yext Hitchhikers Platform
Overview
When ingesting data in Yext via a connector, each row of data represents a single profile of an entity. By default, every row is assumed to represent the primary language profile as defined for that entity.
It is possible to create and/or update alternate language profiles using a connector. To do this, there are two additional fields to map:
- Locale Code
- Is Alternate Profile
Locale Code
Locale Code must be specified per row to signify the intended language profile for that row of data. For example, to ingest data for a Spanish language profile, include a column with the value es to map as the locale code.
Refer to the Language and Locales reference for a list of the available languages and corresponding locale codes.
Is Alternate Profile
This field designates whether a row is a primary or alternate language profile for the corresponding entity ID. This is a boolean field value of either true or false.
If the row should create or update an alternate profile, the value needs to be true. If the row represents the primary profile, the value should be false or the column can be left blank.
Alternate Language Behavior on Fields
If a field on an entity is designated as “primary-only,” this means that data cannot be populated for that field in an alternate language profile.
When ingesting data via a connector, any data rows representing an alternate language profile should clear any columns that map to primary-only fields. This can be done using a transform that executes on the condition of the column mapping to isAlternateProfile.
Alternate language behavior can be viewed on fields in Yext in the “Alternate Language Behavior” column under Content > Configuration > Fields.
Creating Entities with Alternate Language Profiles
Because all entities must have a primary language profile, when creating new entities via a connector, one row must map isAlternateProfile to false (or blank/null) and map the proper locale code. To create an entity with alternate language profiles, additional rows corresponding to the same entity ID should map isAlternateProfile to true and map the proper locale codes.
Updating Entities with Alternate Language Profiles
If an entity already exists and is being updated by a connector, mapping to isAlternateProfile is not required.
If isAlternateProfile is equal to false or is blank/null, existing profiles will be updated and new profiles will be created. This means that a connector cannot be used to switch an entity’s primary profile to a different language.
Additionally, when an existing entity is being updated by a connector, it is not required that the primary profile is present in the connector run.