Cells

CellData

Datos sobre una celda específica.

Representación JSON
{
  "userEnteredValue": {
    object (ExtendedValue)
  },
  "effectiveValue": {
    object (ExtendedValue)
  },
  "formattedValue": string,
  "userEnteredFormat": {
    object (CellFormat)
  },
  "effectiveFormat": {
    object (CellFormat)
  },
  "hyperlink": string,
  "note": string,
  "textFormatRuns": [
    {
      object (TextFormatRun)
    }
  ],
  "dataValidation": {
    object (DataValidationRule)
  },
  "pivotTable": {
    object (PivotTable)
  },
  "dataSourceTable": {
    object (DataSourceTable)
  },
  "dataSourceFormula": {
    object (DataSourceFormula)
  }
}
Campos
userEnteredValue

object (ExtendedValue)

Es el valor que el usuario ingresó en la celda. p.ej., 1234, 'Hello' o =NOW() Nota: Los valores de Date, Times y DateTimes se representan como dobles en serial number de un conjunto de datos tengan un formato común.

effectiveValue

object (ExtendedValue)

Valor efectivo de la celda. Para las celdas con fórmulas, este es el valor calculado. En el caso de las celdas con literales, es lo mismo que userEnteredValue. Este campo es de solo lectura.

formattedValue

string

Es el valor con formato de la celda. Este es el valor tal como se le muestra al usuario. Este campo es de solo lectura.

userEnteredFormat

object (CellFormat)

Indica el formato que el usuario ingresó para la celda.

Cuando escribas, el nuevo formato se combinará con el existente.

effectiveFormat

object (CellFormat)

Formato efectivo que utiliza la celda. Esto incluye los resultados de aplicar cualquier formato condicional y, si la celda contiene una fórmula, el formato de número calculado. Si el formato efectivo es el predeterminado, no se escribirá. Este campo es de solo lectura.

note

string

Cualquier nota en la celda

textFormatRuns[]

object (TextFormatRun)

Ejecuciones de texto enriquecido aplicadas a subsecciones de la celda Las ejecuciones solo son válidas en las cadenas ingresadas por el usuario, no en fórmulas, booleanos ni números. Las propiedades de una ejecución se inician en un índice específico del texto y continúan hasta la próxima ejecución. Las ejecuciones heredarán las propiedades de la celda, a menos que se modifiquen de forma explícita.

Cuando escribas, las ejecuciones nuevas reemplazarán a las anteriores. Cuando escribas un nuevo userEnteredValue, se borran las ejecuciones anteriores.

dataValidation

object (DataValidationRule)

Una regla de validación de datos en la celda, si existe.

Cuando escribas, la nueva regla de validación de datos reemplazará cualquier regla anterior.

pivotTable

object (PivotTable)

Una tabla dinámica anclada en esta celda. El tamaño de la tabla dinámica se calcula dinámicamente en función de sus datos, agrupación, filtros, valores, etc. Solo la celda superior izquierda de la tabla dinámica contiene su definición. Las otras celdas contendrán los valores calculados de los resultados de la tabla dinámica en su effectiveValue .

dataSourceTable

object (DataSourceTable)

Una tabla de fuente de datos anclada en esta celda. El tamaño de la tabla de la fuente de datos se calcula dinámicamente en función de su configuración. Solo la primera celda de la tabla de la fuente de datos contiene la definición de la tabla de la fuente de datos. Las otras celdas contendrán los valores de visualización del resultado de la tabla de fuente de datos en su effectiveValue .

dataSourceFormula

object (DataSourceFormula)

Solo salida. Información sobre la fórmula de una fuente de datos en la celda. El campo se establece si userEnteredValue es una fórmula que hace referencia a algunos DATA_SOURCE hoja, p.ej., =SUM(DataSheet!Column)

CellFormat

Indica el formato de una celda.

Representación JSON
{
  "numberFormat": {
    object (NumberFormat)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "borders": {
    object (Borders)
  },
  "padding": {
    object (Padding)
  },
  "horizontalAlignment": enum (HorizontalAlign),
  "verticalAlignment": enum (VerticalAlign),
  "wrapStrategy": enum (WrapStrategy),
  "textDirection": enum (TextDirection),
  "textFormat": {
    object (TextFormat)
  },
  "hyperlinkDisplayType": enum (HyperlinkDisplayType),
  "textRotation": {
    object (TextRotation)
  }
}
Campos
numberFormat

object (NumberFormat)

Un formato que describe cómo se deben representar los valores numéricos al usuario.

backgroundColor
(deprecated)

object (Color)

El color de fondo de la celda. Obsoleto: usar backgroundColorStyle

backgroundColorStyle

object (ColorStyle)

El color de fondo de la celda. Si backgroundColor si también se establece, este campo tiene prioridad.

borders

object (Borders)

Los bordes de la celda.

padding

object (Padding)

El relleno de la celda.

horizontalAlignment

enum (HorizontalAlign)

Es la alineación horizontal del valor de la celda.

verticalAlignment

enum (VerticalAlign)

Es la alineación vertical del valor de la celda.

wrapStrategy

enum (WrapStrategy)

Es la estrategia de unión del valor de la celda.

textDirection

enum (TextDirection)

Indica la dirección del texto de la celda.

textFormat

object (TextFormat)

El formato del texto de la celda (a menos que un formato que se ejecute lo anule). Si estableces un vínculo a nivel de la celda aquí, se borrarán los vínculos existentes de la celda. Configurar el campo de vínculo en una TextFormatRun tiene prioridad sobre el vínculo a nivel de la celda.

textRotation

object (TextRotation)

Es la rotación que se aplica al texto de la celda.

NumberFormat

Es el formato de número de una celda.

Representación JSON
{
  "type": enum (NumberFormatType),
  "pattern": string
}
Campos
type

enum (NumberFormatType)

Es el tipo de formato de número. Al escribir, se debe establecer este campo.

pattern

string

Cadena de patrón usada para dar formato. Si no se establece, se usará un patrón predeterminado basado en la configuración regional del usuario en caso de ser necesario para el tipo determinado. Consulta la Guía sobre formatos de fecha y número para obtener más información sobre los patrones admitidos.

NumberFormatType

Es el formato de número de la celda. En esta documentación, se supone que la configuración regional es en_US, pero el formato real depende de la configuración regional de la hoja de cálculo.

Enumeraciones
NUMBER_FORMAT_TYPE_UNSPECIFIED El formato de número no se especifica y se basa en el contenido de la celda. No lo uses explícitamente.
TEXT Formato de texto, p. ej., 1000.12
NUMBER Formato de números, p. ej., 1,000.12
PERCENT Formato de porcentaje, p. ej., 10.12%
CURRENCY Formato de moneda, p. ej., $1,000.12
DATE Formato de fecha, p. ej., 9/26/2008
TIME Formato de hora, p. ej., 3:59:00 PM
DATE_TIME Formato de fecha + hora, p. ej., 9/26/08 15:59:00
SCIENTIFIC Formato de números científicos, p. ej., 1.01E+03

Bordes

Los bordes de la celda.

Representación JSON
{
  "top": {
    object (Border)
  },
  "bottom": {
    object (Border)
  },
  "left": {
    object (Border)
  },
  "right": {
    object (Border)
  }
}
Campos
top

object (Border)

Borde superior de la celda.

bottom

object (Border)

Borde inferior de la celda.

left

object (Border)

Borde izquierdo de la celda.

right

object (Border)

Borde derecho de la celda.

Borde

Un borde a lo largo de una celda

Representación JSON
{
  "style": enum (Style),
  "width": integer,
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  }
}
Campos
style

enum (Style)

El estilo del borde.

width
(deprecated)

integer

Indica el ancho del borde en píxeles. Obsoleto; el ancho se determina por el valor de "estilo" .

color
(deprecated)

object (Color)

El color del borde. Obsoleto: usar colorStyle

colorStyle

object (ColorStyle)

El color del borde. Si color si también se establece, este campo tiene prioridad.

Estilo

Es el estilo de un borde.

Enumeraciones
STYLE_UNSPECIFIED No se especificó el estilo. No la uses.
DOTTED El borde está punteado.
DASHED El borde es discontinuo.
SOLID El borde es una línea continua delgada.
SOLID_MEDIUM El borde es una línea continua mediana.
SOLID_THICK El borde es una línea continua gruesa.
NONE Sin borde. Se utiliza solo cuando se actualiza un borde para borrarlo.
DOUBLE El borde tiene dos líneas continuas.

Relleno

Es la cantidad de padding alrededor de la celda, en píxeles. Cuando se actualiza el padding, se deben especificar todos los campos.

Representación JSON
{
  "top": integer,
  "right": integer,
  "bottom": integer,
  "left": integer
}
Campos
top

integer

Padding superior de la celda.

right

integer

El padding derecho de la celda.

bottom

integer

Padding inferior de la celda

left

integer

Relleno izquierdo de la celda.

VerticalAlign

Es la alineación vertical del texto de una celda.

Enumeraciones
VERTICAL_ALIGN_UNSPECIFIED No se especificó la alineación vertical. No la uses.
TOP El texto se alinea explícitamente con la parte superior de la celda.
MIDDLE El texto está alineado de manera explícita con el centro de la celda.
BOTTOM El texto se alinea explícitamente con la parte inferior de la celda.

WrapStrategy

Cómo ajustar texto en una celda

Enumeraciones
WRAP_STRATEGY_UNSPECIFIED El valor predeterminado, no usar.
OVERFLOW_CELL

Las líneas que sean más largas que el ancho de la celda se escribirán en la siguiente celda, siempre que la celda esté vacía. Si la siguiente celda no está vacía, se comporta igual que CLIP El texto nunca se ajustará a la siguiente línea, a menos que el usuario inserte manualmente una nueva línea. Ejemplo:

| First sentence. |
| Manual newline that is very long. <- Text continues into next cell
| Next newline.   |
LEGACY_WRAP

Esta estrategia de ajuste representa la estrategia de ajuste anterior de Hojas de cálculo de Google, en la que las palabras que son más largas que una línea se recortan en lugar de romperse. Esta estrategia no es compatible con todas las plataformas y se eliminará gradualmente. Ejemplo:

| Cell has a |
| loooooooooo| <- Word is clipped.
| word.      |
CLIP

Las líneas que sean más largas que el ancho de la celda se recortarán. El texto nunca se ajustará a la siguiente línea, a menos que el usuario inserte manualmente una nueva línea. Ejemplo:

| First sentence. |
| Manual newline t| <- Text is clipped
| Next newline.   |
WRAP

Las palabras que son más largas que una línea se unen a nivel de carácter en lugar de recortarse. Ejemplo:

| Cell has a |
| loooooooooo| <- Word is broken.
| ong word.  |

TextDirection

Indica la dirección del texto de una celda.

Enumeraciones
TEXT_DIRECTION_UNSPECIFIED No se especificó la dirección del texto. No la uses.
LEFT_TO_RIGHT El usuario estableció la dirección del texto de izquierda a derecha.
RIGHT_TO_LEFT El usuario estableció la dirección del texto de derecha a izquierda.

HyperlinkDisplayType

Indica si se debe renderizar de forma explícita un hipervínculo. Si no se especifica, se vincula el hipervínculo.

Enumeraciones
LINKED Un hipervínculo debe representarse de manera explícita.
PLAIN_TEXT No se debe renderizar un hipervínculo.

TextRotation

Es la rotación que se aplica al texto de una celda.

Representación JSON
{

  // Union field type can be only one of the following:
  "angle": integer,
  "vertical": boolean
  // End of list of possible types for union field type.
}
Campos
Campo de unión type Indica el tipo de rotación, ya sea vertical o angular. type solo puede ser una de las siguientes opciones:
angle

integer

El ángulo entre la orientación estándar y la orientación deseada. Se mide en grados. Los valores válidos deben estar entre -90 y 90. Los ángulos positivos son hacia arriba y los negativos, hacia abajo.

Nota: Para la dirección de texto LTR, los ángulos positivos son en sentido antihorario, mientras que para RTL, en el sentido de las manecillas del reloj, en el sentido de las manecillas del reloj.

vertical

boolean

Si es verdadero, el texto se lee de arriba abajo, pero la orientación de los caracteres individuales no cambia. Por ejemplo:

| V |
| e |
| r |
| t |
| i |
| c |
| a |
| l |

TextFormatRun

Ejecución en formato de texto El formato de esta ejecución continúa hasta el índice de inicio de la siguiente ejecución. Durante la actualización, se deben configurar todos los campos.

Representación JSON
{
  "startIndex": integer,
  "format": {
    object (TextFormat)
  }
}
Campos
startIndex

integer

El índice de caracteres basado en cero donde comienza esta ejecución, en unidades de código UTF-16.

format

object (TextFormat)

Es el formato de esta ejecución. Los valores faltantes heredan el formato de la celda.

DataValidationRule

Una regla de validación de datos.

Representación JSON
{
  "condition": {
    object (BooleanCondition)
  },
  "inputMessage": string,
  "strict": boolean,
  "showCustomUi": boolean
}
Campos
condition

object (BooleanCondition)

Es la condición con la que deben coincidir los datos de la celda.

inputMessage

string

Es un mensaje que se muestra al usuario cuando se agregan datos a la celda.

strict

boolean

Es verdadero si se deben rechazar los datos no válidos.

showCustomUi

boolean

Es verdadero si la IU debe personalizarse según el tipo de condición. Si es "true", "Lista" condiciones mostrará un menú desplegable.

DataSourceTable

Una tabla de fuente de datos, que permite al usuario importar una tabla estática de datos desde el DataSource a Hojas de cálculo. Esto también se conoce como "Extraer" en el editor de Hojas de cálculo.

Representación JSON
{
  "dataSourceId": string,
  "columnSelectionType": enum (DataSourceTableColumnSelectionType),
  "columns": [
    {
      object (DataSourceColumnReference)
    }
  ],
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ],
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "rowLimit": integer,
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
Campos
dataSourceId

string

Es el ID de la fuente de datos con la que está asociada la tabla de fuente de datos.

columnSelectionType

enum (DataSourceTableColumnSelectionType)

El tipo con el que se seleccionarán columnas para la tabla de fuente de datos. La configuración predeterminada es SELECTED

columns[]

object (DataSourceColumnReference)

Columnas seleccionadas para la tabla de fuente de datos. El columnSelectionType debe tener SELECTED

filterSpecs[]

object (FilterSpec)

Filtra las especificaciones en la tabla de fuente de datos.

sortSpecs[]

object (SortSpec)

Ordenar las especificaciones en la tabla de fuente de datos El resultado de la tabla de fuente de datos se ordena según las especificaciones de orden.

rowLimit

integer

El límite de filas para mostrar. Si no la estableces, se aplicará un límite predeterminado. Consulta el editor de Hojas de cálculo para conocer los límites máximo y predeterminado.

dataExecutionStatus

object (DataExecutionStatus)

Solo salida. Es el estado de ejecución de los datos.

DataSourceTableColumnSelectionType

Los tipos de selección de columnas de la tabla de fuente de datos.

Enumeraciones
DATA_SOURCE_TABLE_COLUMN_SELECTION_TYPE_UNSPECIFIED El tipo de selección de columnas predeterminado; no usar.
SELECTED Seleccionar columnas especificadas por columns .
SYNC_ALL

Sincroniza todas las columnas actuales y futuras de la fuente de datos.

Si se configura, la tabla de fuente de datos recupera todas las columnas de la fuente de datos en el momento de la actualización.

DataSourceFormula

Fórmula de la fuente de datos.

Representación JSON
{
  "dataSourceId": string,
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}
Campos
dataSourceId

string

El ID de la fuente de datos con la que está asociada la fórmula.

dataExecutionStatus

object (DataExecutionStatus)

Solo salida. Es el estado de ejecución de los datos.