docs.unity3d.com
  • Manual
  • Scripting API
  • Changelog
  • License
    Show / Hide Table of Contents
    • Unity​Editor.​Localization
      • Addressable​Entry​Not​Found​Exception
      • Asset​Not​Persistent​Exception
      • Asset​Table​Collection
      • Asset​Table​Collection​Extension​Attribute
      • Collection​Extension
      • Localization​Editor​Events
      • Localization​Editor​Settings
      • Localization​Project​Settings
      • Localization​Table​Collection
      • Localization​Table​Collection.​Row<TEntry>
      • String​Table​Collection
      • String​Table​Collection​Extension​Attribute
    • Unity​Editor.​Localization.​Addressables
      • Addressable​Group​Rules
      • Group​Resolver
    • Unity​Editor.​Localization.​Platform.​Android
      • Player
    • Unity​Editor.​Localization.​Plugins.​CSV
      • Csv
      • Csv​Extension
    • Unity​Editor.​Localization.​Plugins.​CSV.​Columns
      • Column​Mapping
      • Csv​Columns
      • IKey​Column
      • Key​Id​Columns
      • Locale​Columns
    • Unity​Editor.​Localization.​Plugins.​Google
      • Authentication​Type
      • Google​Sheets
      • Google​Sheets​Extension
      • IGoogle​Sheets​Service
      • New​Sheet​Properties
      • Sheets​Service​Provider
    • Unity​Editor.​Localization.​Plugins.​Google.​Columns
      • Column​Mapping
      • IPull​Key​Column
      • Key​Column
      • Key​Comment​Column
      • Key​Metadata​Column<TMetadata>
      • Locale​Column
      • Locale​Comment​Column
      • Locale​Metadata​Column<TMetadata>
      • Push​Fields
      • Sheet​Column
    • Unity​Editor.​Localization.​Plugins.​XLIFF
      • Xliff
      • Xliff.​Import​Notes​Behavior
      • Xliff.​Import​Options
      • Xliff​Document
      • Xliff​Version
    • Unity​Editor.​Localization.​Plugins.​XLIFF.​Common
      • IFile
      • IGroup
      • IGroup​Collection
      • INote
      • INote​Collection
      • ITranslation​Unit
      • ITranslation​Unit​Collection
      • IXliff​Document
      • Note​Type
    • Unity​Editor.​Localization.​Reporting
      • ITask​Reporter
      • Progress​Bar​Reporter
      • Progress​Reporter
      • Task​Timer​Reporter
    • Unity​Editor.​Localization.​Search
      • Table​Entry​Search​Data
    • Unity​Editor.​Localization.​UI
      • Localization​Tables​Window
      • Project​Locale​Popup​Field
      • Xliff​Version​Popup
    • Unity​Engine.​Localization
      • Display​Name​Attribute
      • Editor​Property​Driver
      • IPreload​Required
      • Locale
      • Locale​Identifier
      • Localized​Asset<TObject>
      • Localized​Asset<TObject>.​Change​Handler
      • Localized​Asset​Base
      • Localized​Asset​Table
      • Localized​Audio​Clip
      • Localized​Font
      • Localized​Game​Object
      • Localized​Material
      • Localized​Mesh
      • Localized​Object
      • Localized​Reference
      • Localized​Sprite
      • Localized​String
      • Localized​String.​Change​Handler
      • Localized​String​Table
      • Localized​Table<TTable, TEntry>
      • Localized​Table<TTable, TEntry>.​Change​Handler
      • Localized​Texture
      • Localized​Tmp​Font
    • Unity​Engine.​Localization.​Components
      • Localize​Audio​Clip​Event
      • Localized​Asset​Behaviour<TObject, TReference>
      • Localized​Asset​Event<TObject, TReference, TEvent>
      • Localized​Game​Object​Event
      • Localized​Mono​Behaviour
      • Localize​Sprite​Event
      • Localize​String​Event
      • Localize​Texture​Event
    • Unity​Engine.​Localization.​Events
      • Unity​Event​Audio​Clip
      • Unity​Event​Game​Object
      • Unity​Event​Sprite
      • Unity​Event​String
      • Unity​Event​Texture
    • Unity​Engine.​Localization.​Metadata
      • Comment
      • Entry​Override​Type
      • Exclude​Entry​From​Export
      • Fallback​Locale
      • IEntry​Override
      • IMetadata
      • IMetadata​Collection
      • IShared​Metadata
      • Metadata​Attribute
      • Metadata​Collection
      • Metadata​Type
      • Platform​Override
      • Preload​Asset​Table​Metadata
      • Preload​Asset​Table​Metadata.​Preload​Behaviour
      • Shared​Table​Collection​Metadata
      • Shared​Table​Entry​Metadata
      • Smart​Format​Tag
    • Unity​Engine.​Localization.​Platform.​Android
      • Adaptive​Icon
      • Adaptive​Icons​Info
      • App​Info
      • Legacy​Icons​Info
      • Round​Icons​Info
    • Unity​Engine.​Localization.​Platform.​iOS
      • App​Info
    • Unity​Engine.​Localization.​Property​Variants
      • Custom​Tracked​Object​Attribute
      • Game​Object​Localizer
    • Unity​Engine.​Localization.​Property​Variants.​Tracked​Objects
      • Json​Serializer​Tracked​Object
      • Json​Serializer​Tracked​Object.​Apply​Changes​Method
      • Tracked​Mesh​Filter
      • Tracked​Mono​Behaviour​Object
      • Tracked​Object
      • Tracked​Rect​Transform
      • Tracked​Transform
    • Unity​Engine.​Localization.​Property​Variants.​Tracked​Properties
      • Array​Size​Tracked​Property
      • Bool​Tracked​Property
      • Byte​Tracked​Property
      • Char​Tracked​Property
      • Double​Tracked​Property
      • Enum​Tracked​Property
      • Float​Tracked​Property
      • Int​Tracked​Property
      • IString​Property
      • ITracked​Property
      • ITracked​Property​Value<T>
      • Localized​Asset​Property
      • Localized​String​Property
      • Long​Tracked​Property
      • SByte​Tracked​Property
      • Short​Tracked​Property
      • String​Tracked​Property
      • Tracked​Property<TPrimitive>
      • UInt​Tracked​Property
      • ULong​Tracked​Property
      • Unity​Object​Property
      • UShort​Tracked​Property
    • Unity​Engine.​Localization.​Pseudo
      • Accenter
      • Character​Substitutor
      • Character​Substitutor.​List​Selection​Method
      • Character​Substitutor.​Substitution​Method
      • Encapsulator
      • Expander
      • Expander.​Expansion​Rule
      • Expander.​Insert​Location
      • IPseudo​Localization​Method
      • Message
      • Message​Fragment
      • Mirror
      • Preserve​Tags
      • Pseudo​Locale
      • Read​Only​Message​Fragment
      • Typical​Character​Sets
      • Writable​Message​Fragment
    • Unity​Engine.​Localization.​Settings
      • Command​Line​Locale​Selector
      • Fallback​Behavior
      • IInitialize
      • ILocales​Provider
      • IReset
      • IStartup​Locale​Selector
      • ITable​Postprocessor
      • ITable​Provider
      • Locales​Provider
      • Localization​Settings
      • Localized​Asset​Database
      • Localized​Database<TTable, TEntry>
      • Localized​Database<TTable, TEntry>.​Table​Entry​Result
      • Localized​String​Database
      • Localized​String​Database.​Missing​Translation
      • Missing​Translation​Behavior
      • Player​Pref​Locale​Selector
      • Preload​Behavior
      • Specific​Locale​Selector
      • System​Locale​Selector
    • Unity​Engine.​Localization.​Smart​Format
      • Formatting​Error​Event​Args
      • Smart
      • Smart​Extensions
      • Smart​Formatter
    • Unity​Engine.​Localization.​Smart​Format.​Core.​Extensions
      • Formatter​Base
      • IFormatter
      • IFormatter​Literal​Extractor
      • IFormatting​Info
      • ISelector​Info
      • ISource
    • Unity​Engine.​Localization.​Smart​Format.​Core.​Settings
      • Case​Sensitivity​Type
      • Error​Action
      • Smart​Settings
    • Unity​Engine.​Localization.​Smart​Format.​Extensions
      • Choose​Formatter
      • Conditional​Formatter
      • Custom​Plural​Rule​Provider
      • Default​Formatter
      • Default​Source
      • Dictionary​Source
      • Global​Variables​Source
      • Is​Match​Formatter
      • List​Formatter
      • Persistent​Variables​Source
      • Persistent​Variables​Source.​Scoped​Update
      • Plural​Localization​Formatter
      • Reflection​Source
      • Sub​String​Formatter
      • Sub​String​Formatter.​Sub​String​Out​Of​Range​Behavior
      • Template​Formatter
      • Time​Formatter
      • Value​Tuple​Source
      • XElement​Formatter
      • Xml​Source
    • Unity​Engine.​Localization.​Smart​Format.​Global​Variables
      • Bool​Global​Variable
      • Float​Global​Variable
      • Global​Variable<T>
      • Global​Variables​Group
      • IGlobal​Variable
      • IGlobal​Variable​Value​Changed
      • Int​Global​Variable
      • IVariable​Group
      • Nested​Global​Variables​Group
      • String​Global​Variable
    • Unity​Engine.​Localization.​Smart​Format.​Persistent​Variables
      • Bool​Variable
      • Byte​Variable
      • Double​Variable
      • Float​Variable
      • IMetadata​Variable
      • Int​Variable
      • IVariable
      • IVariable​Group
      • IVariable​Value​Changed
      • Long​Variable
      • Nested​Variables​Group
      • Object​Variable
      • SByte​Variable
      • Short​Variable
      • String​Variable
      • UInt​Variable
      • ULong​Variable
      • UShort​Variable
      • Variable<T>
      • Variables​Group​Asset
    • Unity​Engine.​Localization.​Tables
      • Asset​Table
      • Asset​Table​Entry
      • Detailed​Localization​Table<TEntry>
      • Distributed​UIDGenerator
      • IKey​Generator
      • Localization​Table
      • Missing​Entry​Action
      • Sequential​IDGenerator
      • Shared​Table​Data
      • Shared​Table​Data.​Shared​Table​Entry
      • String​Table
      • String​Table​Entry
      • Table​Entry
      • Table​Entry​Reference
      • Table​Entry​Reference.​Type
      • Table​Reference
      • Table​Reference.​Type
    • Scripting API
    • Unity​Editor.​Localization.​Plugins.​Google.​Columns
    • Key​Column

    Class KeyColumn

    Represents a column in a Google Sheets that can be used to map the row to a StringTableEntry.

    Inheritance
    Object
    SheetColumn
    KeyColumn
    Inherited Members
    SheetColumn.Column
    SheetColumn.ColumnIndex
    SheetColumn.PushEnd()
    SheetColumn.PullEnd()
    SheetColumn.IndexToColumnName(Int32)
    SheetColumn.ColumnNameToIndex(String)
    Namespace: UnityEditor.Localization.Plugins.Google.Columns
    Syntax
    [Serializable]
    public class KeyColumn : SheetColumn, IPullKeyColumn

    Fields

    ColumnHeader

    The default name to use for the column is "Key".

    Declaration
    public const string ColumnHeader = "Key"
    Field Value
    Type Description
    String

    Properties

    PushFields

    Controls which cell fields to synchronize.

    Declaration
    public override PushFields PushFields { get; }
    Property Value
    Type Description
    PushFields
    Overrides
    SheetColumn.PushFields

    Methods

    PullBegin(StringTableCollection)

    Called when starting a pull to allow a column to initialize itself.

    Declaration
    public override void PullBegin(StringTableCollection collection)
    Parameters
    Type Name Description
    StringTableCollection collection

    The collection to update from the Google Sheet.

    Overrides
    SheetColumn.PullBegin(StringTableCollection)

    PullCellData(SharedTableData.SharedTableEntry, String, String)

    Called to update the StringTableCollection using the provided cell data.

    Declaration
    public override void PullCellData(SharedTableData.SharedTableEntry keyEntry, string cellValue, string cellNote)
    Parameters
    Type Name Description
    SharedTableData.SharedTableEntry keyEntry

    The entry being updated for this cell.

    String cellValue

    The cell value or null if PushFields does not contain the flag Value.

    String cellNote

    The cell note or null if PushFields does not contain the flag Note.

    Overrides
    SheetColumn.PullCellData(SharedTableData.SharedTableEntry, String, String)

    PullKey(String, String)

    Provides the entry that the current row represents.

    Declaration
    public SharedTableData.SharedTableEntry PullKey(string cellValue, string cellNote)
    Parameters
    Type Name Description
    String cellValue

    The value in the cell for the column.

    String cellNote

    The value in the notes field for the column.

    Returns
    Type Description
    SharedTableData.SharedTableEntry

    The entry for the current row or null if one could not be found.

    Implements
    IPullKeyColumn.PullKey(String, String)
    Remarks

    The SharedTableData.SharedTableEntry is resolved in the following way:

    PushBegin(StringTableCollection)

    Called when starting a push to allow a column to initialize itself.

    Declaration
    public override void PushBegin(StringTableCollection collection)
    Parameters
    Type Name Description
    StringTableCollection collection

    The collection to push to a Google Sheet.

    Overrides
    SheetColumn.PushBegin(StringTableCollection)

    PushCellData(SharedTableData.SharedTableEntry, IList<StringTableEntry>, out String, out String)

    Extracts the data that should populate the columns cell for the row associated with the Key.

    Declaration
    public override void PushCellData(SharedTableData.SharedTableEntry keyEntry, IList<StringTableEntry> tableEntries, out string value, out string note)
    Parameters
    Type Name Description
    SharedTableData.SharedTableEntry keyEntry

    The Key that represents the row in the spreadsheet.

    IList<StringTableEntry> tableEntries

    The StringTableEntry for the current SharedTableData.SharedTableEntry. The order of the tables will match the source StringTableCollection, If a table does not contain data for the current key then a null entry will be used.

    String value

    The value to be used for the cell. This can be null if PushFields is Note or the cell should be empty.

    String note

    The value to be used for the cell note. This can be null if PushFields is Value or if there should not be a note for this cell.

    Overrides
    SheetColumn.PushCellData(SharedTableData.SharedTableEntry, IList<StringTableEntry>, out String, out String)

    PushHeader(StringTableCollection, out String, out String)

    Sets the column title and optional note. These values are always set regardless of the value of PushFields.

    Declaration
    public override void PushHeader(StringTableCollection collection, out string header, out string headerNote)
    Parameters
    Type Name Description
    StringTableCollection collection
    String header

    The title to use for the column header.

    String headerNote

    Optional note that can be added to the header.

    Overrides
    SheetColumn.PushHeader(StringTableCollection, out String, out String)

    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    In This Article
    • Fields
      • ColumnHeader
    • Properties
      • PushFields
    • Methods
      • PullBegin(StringTableCollection)
      • PullCellData(SharedTableData.SharedTableEntry, String, String)
      • PullKey(String, String)
      • PushBegin(StringTableCollection)
      • PushCellData(SharedTableData.SharedTableEntry, IList<StringTableEntry>, out String, out String)
      • PushHeader(StringTableCollection, out String, out String)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023