Cells

CellData

Son 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)
  },
  "chipRuns": [
    {
      object (ChipRun)
    }
  ]
}
Campos
userEnteredValue

object (ExtendedValue)

Es el valor que ingresó el usuario en la celda, p. ej., 1234, 'Hello' o =NOW() Nota: Las fechas, las horas y las fechas y horas se representan como números de doble precisión en formato serial number.

effectiveValue

object (ExtendedValue)

Es el valor efectivo de la celda. En el caso de 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 muestra al usuario. Este campo es de solo lectura.

userEnteredFormat

object (CellFormat)

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

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

effectiveFormat

object (CellFormat)

Es el formato efectivo que usa 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 formato predeterminado, no se escribirá el formato efectivo. Este campo es de solo lectura.

note

string

Cualquier nota sobre la celda.

textFormatRuns[]

object (TextFormatRun)

Son tramos de texto enriquecido que se aplican a subsecciones de la celda. Las ejecuciones solo son válidas en cadenas ingresadas por el usuario, no en fórmulas, valores booleanos o números. Las propiedades de una ejecución comienzan en un índice específico del texto y continúan hasta la siguiente ejecución. Las ejecuciones heredarán las propiedades de la celda, a menos que se cambien de forma explícita.

Cuando se escriban, las ejecuciones nuevas reemplazarán las anteriores. Cuando se escribe un nuevo userEnteredValue, se borran las ejecuciones anteriores.

dataValidation

object (DataValidationRule)

Es una regla de validación de datos en la celda, si la hay.

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

pivotTable

object (PivotTable)

Es una tabla dinámica anclada en esta celda. El tamaño de la tabla dinámica se calcula de forma dinámica en función de sus datos, agrupaciones, filtros, valores, etcétera. Solo la celda superior izquierda de la tabla dinámica contiene la definición de la tabla dinámica. Las otras celdas contendrán los valores calculados de los resultados de la tabla dinámica en sus campos effectiveValue.

dataSourceTable

object (DataSourceTable)

Es una tabla de fuente de datos anclada en esta celda. El tamaño de la tabla de la fuente de datos se calcula de forma dinámica según su configuración. Solo la primera celda de la tabla de fuente de datos contiene la definición de la tabla de fuente de datos. Las otras celdas contendrán los valores de visualización del resultado de la tabla de la fuente de datos en sus campos effectiveValue.

dataSourceFormula

object (DataSourceFormula)

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

chipRuns[]

object (ChipRun)

Opcional. Son las ejecuciones de los chips aplicados a las subsecciones de la celda. Las propiedades de una ejecución comienzan en un índice específico del texto y continúan hasta la siguiente ejecución.

Cuando se leen, se incluyen todos los tramos con chip y sin chip. Los tramos sin chip tendrán un campo Chip vacío.

Cuando escribes, solo se incluyen las carreras con chips. Las ejecuciones que contienen fichas tienen una longitud de 1 y se representan en el texto ingresado por el usuario con un símbolo de marcador de posición “@”. Las ejecuciones nuevas reemplazarán las anteriores. Si escribes un nuevo userEnteredValue, se borrarán las ejecuciones anteriores.

CellFormat

Es 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)

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

backgroundColor
(deprecated)

object (Color)

Es el color de fondo de la celda. Obsoleto: Usa backgroundColorStyle.

backgroundColorStyle

object (ColorStyle)

Es el color de fondo de la celda. Si también se establece backgroundColor, este campo tendrá prioridad.

borders

object (Borders)

Son los bordes de la celda.

padding

object (Padding)

Es el relleno de la celda.

horizontalAlignment

enum (HorizontalAlign)

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

verticalAlignment

enum (VerticalAlign)

Alineación vertical del valor en la celda.

wrapStrategy

enum (WrapStrategy)

Es la estrategia de ajuste para el valor de la celda.

textDirection

enum (TextDirection)

Es la dirección del texto en la celda.

textFormat

object (TextFormat)

Es el formato del texto en la celda (a menos que se anule con una ejecución de formato). Si configuras un vínculo a nivel de la celda aquí, se borrarán los vínculos existentes de la celda. Establecer el campo de vínculo en un objeto 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. Este campo debe establecerse cuando se escribe.

pattern

string

Es la cadena de patrón que se usa para el formato. Si no se configura, se usará un patrón predeterminado basado en la configuración regional de la hoja de cálculo si es necesario para el tipo determinado. Consulta la guía de 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.

Enums
NUMBER_FORMAT_TYPE_UNSPECIFIED El formato de número no se especifica y se basa en el contenido de la celda. No lo uses de forma explícita.
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 y hora, p. ej., 9/26/08 15:59:00
SCIENTIFIC Formato de número científico, p. ej., 1.01E+03

Bordes

Son los bordes de la celda.

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

object (Border)

Es el borde superior de la celda.

bottom

object (Border)

Es el borde inferior de la celda.

left

object (Border)

Es el borde izquierdo de la celda.

right

object (Border)

Es el borde derecho de la celda.

Borde

Es 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)

Es el estilo del borde.

width
(deprecated)

integer

Ancho del borde en píxeles. Obsoleto. El ancho se determina según el campo "style".

color
(deprecated)

object (Color)

Es el color del borde. Obsoleto: Usa colorStyle.

colorStyle

object (ColorStyle)

Es el color del borde. Si también se establece color, este campo tendrá prioridad.

Estilo

Es el estilo de un borde.

Enums
STYLE_UNSPECIFIED No se especificó el estilo. No uses esta opción.
DOTTED El borde es 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. Solo se usa cuando se actualiza un borde para borrarlo.
DOUBLE El borde está formado por dos líneas continuas.

Padding

Es la cantidad de padding alrededor de la celda, en píxeles. Cuando se actualiza el padding, se debe especificar cada campo.

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

integer

Es el relleno superior de la celda.

right

integer

Es el relleno a la derecha de la celda.

bottom

integer

Es el padding inferior de la celda.

left

integer

Es el padding izquierdo de la celda.

VerticalAlign

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

Enums
VERTICAL_ALIGN_UNSPECIFIED No se especificó la alineación vertical. No uses esta opción.
TOP El texto se alinea explícitamente en la parte superior de la celda.
MIDDLE El texto se alinea explícitamente al centro de la celda.
BOTTOM El texto se alinea explícitamente a la parte inferior de la celda.

WrapStrategy

Cómo ajustar el texto en una celda

Enums
WRAP_STRATEGY_UNSPECIFIED Es el valor predeterminado y no se debe usar.
OVERFLOW_CELL

Las líneas más largas que el ancho de la celda se escribirán en la siguiente celda, siempre y cuando 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 una línea nueva de forma manual. Ejemplo:

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

Esta estrategia de ajuste representa la antigua estrategia de ajuste de Hojas de cálculo de Google, en la que las palabras más largas que una línea se recortan en lugar de dividirse. Esta estrategia no se admite en todas las plataformas y se está descontinuando. 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 una línea nueva de forma manual. Ejemplo:

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

Las palabras que son más largas que una línea se ajustan a nivel de los caracteres en lugar de recortarse. Ejemplo:

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

TextDirection

Es la dirección del texto en una celda.

Enums
TEXT_DIRECTION_UNSPECIFIED No se especificó la dirección del texto. No uses esta opción.
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 un hipervínculo de forma explícita. Si no se especifica, el hipervínculo se vincula.

Enums
LINKED Se debe renderizar un hipervínculo de forma 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. Es el tipo de rotación, vertical o en ángulo. type puede ser solo uno de los siguientes valores:
angle

integer

Es el ángulo entre la orientación estándar y la orientación deseada. Se mide en grados. Los valores válidos están entre -90 y 90. Los ángulos positivos se inclinan hacia arriba, y los negativos, hacia abajo.

Nota: Para la dirección del texto de izquierda a derecha, los ángulos positivos se encuentran en el sentido contrario a las manecillas del reloj, mientras que, para la dirección de derecha a izquierda, se encuentran en el sentido de las manecillas del reloj.

vertical

boolean

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

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

TextFormatRun

Es una ejecución de un formato de texto. El formato de esta ejecución continúa hasta el índice de inicio de la siguiente ejecución. Cuando se actualiza, se deben configurar todos los campos.

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

integer

Índice de caracteres basado en cero en el que comienza esta ejecución, en unidades de código UTF-16.

format

object (TextFormat)

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

DataValidationRule

Es 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 que deben cumplir los datos de la celda.

inputMessage

string

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

strict

boolean

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

showCustomUi

boolean

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

DataSourceTable

Una tabla de fuente de datos que permite al usuario importar una tabla estática de datos desde DataSource a Hojas de cálculo 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 la fuente de datos.

columnSelectionType

enum (DataSourceTableColumnSelectionType)

Es el tipo para seleccionar columnas de la tabla de la fuente de datos. El valor predeterminado es SELECTED.

columns[]

object (DataSourceColumnReference)

Son las columnas seleccionadas para la tabla de la fuente de datos. El columnSelectionType debe ser SELECTED.

filterSpecs[]

object (FilterSpec)

Especificaciones de filtro en la tabla de la fuente de datos

sortSpecs[]

object (SortSpec)

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

rowLimit

integer

Es el límite de filas que se devolverán. Si no se establece, se aplicará un límite predeterminado. Consulta el editor de Hojas de cálculo para conocer el límite predeterminado y el máximo.

dataExecutionStatus

object (DataExecutionStatus)

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

DataSourceTableColumnSelectionType

Son los tipos de selección de columnas de la tabla de la fuente de datos.

Enums
DATA_SOURCE_TABLE_COLUMN_SELECTION_TYPE_UNSPECIFIED Es el tipo de selección de columnas predeterminado. No se debe usar.
SELECTED Selecciona las columnas especificadas por el campo columns.
SYNC_ALL

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

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

DataSourceFormula

Es una fórmula de fuente de datos.

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

string

Es el ID de la fuente de datos con la que se asocia la fórmula.

dataExecutionStatus

object (DataExecutionStatus)

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

ChipRun

Es la ejecución de un chip. El chip continúa hasta el índice de inicio de la siguiente ejecución.

Representación JSON
{
  "startIndex": integer,
  "chip": {
    object (Chip)
  }
}
Campos
startIndex

integer

Obligatorio. Índice de caracteres basado en cero en el que comienza esta ejecución, en unidades de código UTF-16.

chip

object (Chip)

Opcional. Es el chip de esta ejecución.

Chip

El chip inteligente

Representación JSON
{

  // Union field properties can be only one of the following:
  "personProperties": {
    object (PersonProperties)
  },
  "richLinkProperties": {
    object (RichLinkProperties)
  }
  // End of list of possible types for union field properties.
}
Campos
Campo de unión properties. Son las propiedades del chip. properties puede ser solo uno de los siguientes valores:
personProperties

object (PersonProperties)

Son las propiedades de una persona vinculada.

PersonProperties

Son las propiedades específicas de una persona vinculada.

Representación JSON
{
  "email": string,
  "displayFormat": enum (DisplayFormat)
}
Campos
email

string

Obligatorio. Es la dirección de correo electrónico vinculada a esta persona. Este campo siempre está presente.

displayFormat

enum (DisplayFormat)

Opcional. Es el formato de visualización del chip de persona. Si no se establece, se usa el formato de visualización predeterminado.

DisplayFormat

Es el formato de pantalla preferido cuando está disponible.

Enums
DISPLAY_FORMAT_UNSPECIFIED Es un valor predeterminado que no se debe usar.
DEFAULT Es el formato de visualización predeterminado.
LAST_NAME_COMMA_FIRST_NAME Formato de visualización del apellido y el nombre.
EMAIL Es el formato de visualización del correo electrónico.

RichLinkProperties

Son las propiedades de un vínculo a un recurso de Google (como un archivo en Drive, un video de YouTube, una dirección de Maps o un evento de Calendario). Solo se pueden escribir como chips los archivos de Drive. Todos los demás tipos de vínculos enriquecidos son de solo lectura.

Los URI no pueden superar los 2,000 bytes cuando se escriben.

NOTA: Para escribir chips de archivos de Drive, se requiere al menos uno de los permisos de OAuth drive.file, drive.readonly o drive.

Representación JSON
{
  "uri": string,
  "mimeType": string
}
Campos
uri

string

Obligatorio. Es el URI del vínculo. Siempre está presente.

mimeType

string

Solo salida. El tipo de MIME del vínculo, si hay uno (por ejemplo, cuando es un archivo en Drive).