Sheets

{
  "properties": {
    object (SheetProperties)
  },
  "data": [
    {
      object (GridData)
    }
  ],
  "merges": [
    {
      object (GridRange)
    }
  ],
  "conditionalFormats": [
    {
      object (ConditionalFormatRule)
    }
  ],
  "filterViews": [
    {
      object (FilterView)
    }
  ],
  "protectedRanges": [
    {
      object (ProtectedRange)
    }
  ],
  "basicFilter": {
    object (BasicFilter)
  },
  "charts": [
    {
      object (EmbeddedChart)
    }
  ],
  "bandedRanges": [
    {
      object (BandedRange)
    }
  ],
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "rowGroups": [
    {
      object (DimensionGroup)
    }
  ],
  "columnGroups": [
    {
      object (DimensionGroup)
    }
  ],
  "slicers": [
    {
      object (Slicer)
    }
  ]
}

object (SheetProperties)

As propriedades da página.

object (GridData)

Dados na grade, se esta for uma folha de grade.

O número de objetos GridData retornados depende do número de intervalos solicitados nessa folha. Por exemplo, se ele representa Sheet1, e a planilha foi solicitada com intervalos Sheet1!A1:C10 e Sheet1!D15:E20, o primeiro GridData terá startRow / startColumn de 0, e o segundo terá startRow 14 (linha 15 com base em zero) e startColumn 3 (coluna D baseada em zero).

Para um DATA_SOURCE planilha, não é possível solicitar um intervalo específico, o GridData contém todos os valores.

object (GridRange)

Os intervalos mesclados.

object (ConditionalFormatRule)

As regras de formatação condicional desta página.

object (FilterView)

As visualizações com filtro da página.

object (ProtectedRange)

Os intervalos protegidos nesta página.

object (BasicFilter)

O filtro na página, se houver.

object (EmbeddedChart)

As especificações de cada gráfico nesta planilha.

object (BandedRange)

As faixas (cores alternadas) variam nesta página.

object (DeveloperMetadata)

Os metadados do desenvolvedor associados a uma página.

object (DimensionGroup)

Todos os grupos de linhas nesta página, ordenados aumentando o índice inicial do intervalo e, depois, por profundidade do grupo.

object (DimensionGroup)

Todos os grupos de colunas nesta página, ordenados aumentando o índice inicial do intervalo e, em seguida, por profundidade do grupo.

object (Slicer)

Os controles de filtros nesta página.

{
  "sheetId": integer,
  "title": string,
  "index": integer,
  "sheetType": enum (SheetType),
  "gridProperties": {
    object (GridProperties)
  },
  "hidden": boolean,
  "tabColor": {
    object (Color)
  },
  "tabColorStyle": {
    object (ColorStyle)
  },
  "rightToLeft": boolean,
  "dataSourceSheetProperties": {
    object (DataSourceSheetProperties)
  }
}

integer

O ID da planilha. Não podem ser negativas. Este campo não pode ser alterado depois de definido.

string

O nome da planilha.

integer

O índice da página na planilha. Ao adicionar ou atualizar as propriedades da página, se este campo for excluído, a planilha será adicionada ou movida para o fim da lista de páginas. Ao atualizar índices de páginas ou inserir páginas, o movimento é considerado "antes da movimentação" índices. Por exemplo, se houvesse três páginas (S1, S2, S3) para mover S1 à frente de S2, o índice teria que ser definido como 2. Uma solicitação de atualização do índice de páginas será ignorada se o índice solicitado for idêntico ao índice atual das páginas ou se o novo índice solicitado for igual ao índice de páginas atual + 1.

enum (SheetType)

O tipo de planilha. O padrão é GRID: Este campo não pode ser alterado depois de definido.

object (GridProperties)

Propriedades adicionais da página se ela for uma grade. Se a planilha for de objetos e tiver um gráfico ou imagem, esse campo estará ausente. Ao gravar, é um erro definir quaisquer propriedades de grade em folhas que não sejam de grade.

Se esta planilha for um DATA_SOURCE planilha, esse campo é apenas de saída, mas contém as propriedades que refletem como uma página de fonte de dados é renderizada na interface, por exemplo, rowCount.

boolean

Verdadeiro se a página estiver oculta na interface, falso se estiver visível.

object (Color)

A cor da guia na interface. Descontinuado: uso tabColorStyle:

object (ColorStyle)

A cor da guia na interface. Se tabColor também for definido, esse campo terá precedência.

boolean

Verdadeiro se a página for RTL em vez de uma página LTR.

object (DataSourceSheetProperties)

Apenas saída. Se estiver presente, o campo contém DATA_SOURCE propriedades específicas da planilha.

{
  "rowCount": integer,
  "columnCount": integer,
  "frozenRowCount": integer,
  "frozenColumnCount": integer,
  "hideGridlines": boolean,
  "rowGroupControlAfter": boolean,
  "columnGroupControlAfter": boolean
}

integer

O número de linhas na grade.

integer

O número de colunas na grade.

integer

O número de linhas que são congeladas na grade.

integer

O número de colunas que são congeladas na grade.

boolean

Verdadeiro se a grade não estiver mostrando linhas de grade na interface.

boolean

Verdadeiro se o botão de alternância do controle de agrupamento de linhas for exibido após o grupo.

boolean

Verdadeiro se o botão de alternância do controle de agrupamento de colunas for exibido após o grupo.

{
  "dataSourceId": string,
  "columns": [
    {
      object (DataSourceColumn)
    }
  ],
  "dataExecutionStatus": {
    object (DataExecutionStatus)
  }
}

string

ID do DataSource a que a planilha está conectada.

object (DataSourceColumn)

As colunas exibidas na planilha, que correspondem aos valores em RowData:

object (DataExecutionStatus)

O status de execução dos dados.

{
  "startRow": integer,
  "startColumn": integer,
  "rowData": [
    {
      object (RowData)
    }
  ],
  "rowMetadata": [
    {
      object (DimensionProperties)
    }
  ],
  "columnMetadata": [
    {
      object (DimensionProperties)
    }
  ]
}

integer

A primeira linha a que este GridData se refere, com base em zero.

integer

A primeira coluna a que este GridData se refere, baseada em zero.

object (RowData)

Os dados na grade, uma entrada por linha, começando com a linha na startRow. Os valores em RowData corresponderão às colunas começando em startColumn:

object (DimensionProperties)

Metadados sobre as linhas solicitadas na grade, começando com a linha em startRow:

object (DimensionProperties)

Metadados sobre as colunas solicitadas na grade, começando com a coluna em startColumn:

{
  "values": [
    {
      object (CellData)
    }
  ]
}

object (CellData)

Os valores na linha, um por coluna.

{
  "hiddenByFilter": boolean,
  "hiddenByUser": boolean,
  "pixelSize": integer,
  "developerMetadata": [
    {
      object (DeveloperMetadata)
    }
  ],
  "dataSourceColumnReference": {
    object (DataSourceColumnReference)
  }
}

boolean

Verdadeiro se esta dimensão estiver sendo filtrada. Este campo é somente leitura.

boolean

Verdadeiro se a dimensão estiver explicitamente oculta.

integer

A altura (se for uma linha) ou a largura (se for uma coluna) da dimensão em pixels.

object (DeveloperMetadata)

Os metadados do desenvolvedor associados a uma única linha ou coluna.

object (DataSourceColumnReference)

Apenas saída. Se definido, será uma coluna em uma página de fonte de dados.

{
  "ranges": [
    {
      object (GridRange)
    }
  ],

  // Union field rule can be only one of the following:
  "booleanRule": {
    object (BooleanRule)
  },
  "gradientRule": {
    object (GradientRule)
  }
  // End of list of possible types for union field rule.
}

object (GridRange)

Os intervalos formatados se a condição for verdadeira. Todos os intervalos precisam estar na mesma grade.

object (BooleanRule)

A formatação está "ativada" ou "desativado" de acordo com a regra.

object (GradientRule)

A formatação varia de acordo com os gradientes da regra.

{
  "condition": {
    object (BooleanCondition)
  },
  "format": {
    object (CellFormat)
  }
}

object (BooleanCondition)

A condição da regra. Se a condição for avaliada como verdadeira, o formato será aplicado.

object (CellFormat)

O formato a ser aplicado. A formatação condicional só pode aplicar um subconjunto de formatação: bold, italic, strikethrough, foreground color e background color.

{
  "minpoint": {
    object (InterpolationPoint)
  },
  "midpoint": {
    object (InterpolationPoint)
  },
  "maxpoint": {
    object (InterpolationPoint)
  }
}

object (InterpolationPoint)

O ponto de interpolação inicial.

object (InterpolationPoint)

Um ponto de interpolação intermediário opcional.

object (InterpolationPoint)

O último ponto de interpolação.

{
  "color": {
    object (Color)
  },
  "colorStyle": {
    object (ColorStyle)
  },
  "type": enum (InterpolationPointType),
  "value": string
}

object (Color)

A cor que este ponto de interpolação deve usar. Descontinuado: uso colorStyle:

object (ColorStyle)

A cor que este ponto de interpolação deve usar. Se color também for definido, esse campo terá precedência.

enum (InterpolationPointType)

Como o valor deve ser interpretado.

string

O valor usado por esse ponto de interpolação. Pode ser uma fórmula. Não utilizado se type é MIN ou MAX

{
  "filterViewId": integer,
  "title": string,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}

integer

O ID da visualização com filtro.

string

O nome da visualização com filtro.

object (GridRange)

O intervalo que essa visualização com filtro abrange.

Ao escrever, apenas um range ou namedRangeId podem ser definidos.

string

O intervalo nomeado que serviu de base para a visualização de filtro, se houver.

Ao escrever, apenas um range ou namedRangeId podem ser definidos.

object (SortSpec)

A ordem de classificação por coluna. Especificações posteriores são usadas quando os valores são iguais nas especificações anteriores.

map (key: integer, value: object ( FilterCriteria))

Os critérios para mostrar/ocultar valores por coluna. A chave do mapa é o índice da coluna, e o valor é os critérios dessa coluna.

Este campo está obsoleto e foi substituído por filterSpecs:

object (FilterSpec)

Os critérios de filtro para mostrar/ocultar valores por coluna.

Ambos criteria e filterSpecs são preenchidos nas respostas. Se ambos os campos forem especificados em uma solicitação de atualização, este campo terá precedência.

{
  "protectedRangeId": integer,
  "range": {
    object (GridRange)
  },
  "namedRangeId": string,
  "description": string,
  "warningOnly": boolean,
  "requestingUserCanEdit": boolean,
  "unprotectedRanges": [
    {
      object (GridRange)
    }
  ],
  "editors": {
    object (Editors)
  }
}

integer

O ID do intervalo protegido. Este campo é somente leitura.

object (GridRange)

O intervalo que está sendo protegido. O intervalo pode ser totalmente ilimitado. Nesse caso, a página é considerada protegida.

Ao escrever, apenas um range ou namedRangeId podem ser definidos.

string

O intervalo nomeado que é o suporte do intervalo protegido, se houver.

Ao escrever, apenas um range ou namedRangeId podem ser definidos.

string

A descrição deste intervalo protegido.

boolean

Verdadeiro se esse intervalo protegido mostrar um aviso durante a edição. A proteção baseada em avisos significa que todos os usuários podem editar os dados do intervalo protegido, exceto a edição, que exibirá um aviso solicitando que o usuário confirme a edição.

Ao escrever: se este campo for verdadeiro, então editors são ignorados. Além disso, se este campo for alterado de verdadeiro para falso e o editors campo não estiver definido (nem incluído na máscara de campo), os editores serão definidos como todos os editores no documento.

boolean

Verdadeiro se o usuário que solicitou este intervalo protegido puder editar a área protegida. Este campo é somente leitura.

object (GridRange)

A lista de intervalos desprotegidos em uma página protegida. Intervalos desprotegidos só são aceitos em páginas protegidas.

object (Editors)

Os usuários e grupos com acesso para editar o intervalo protegido. Este campo só fica visível para usuários com acesso para editar o intervalo protegido e o documento. Os editores não são compatíveis com warningOnly proteção de dados.

{
  "users": [
    string
  ],
  "groups": [
    string
  ],
  "domainUsersCanEdit": boolean
}

string

Os endereços de e-mail dos usuários com acesso para editar o intervalo protegido.

string

Os endereços de e-mail dos grupos com acesso para editar o intervalo protegido.

boolean

Verdadeiro se alguém no domínio do documento tiver acesso para editar o intervalo protegido. A proteção de domínio só é compatível com documentos dentro de um domínio.

{
  "range": {
    object (GridRange)
  },
  "sortSpecs": [
    {
      object (SortSpec)
    }
  ],
  "criteria": {
    integer: {
      object (FilterCriteria)
    },
    ...
  },
  "filterSpecs": [
    {
      object (FilterSpec)
    }
  ]
}

object (GridRange)

O intervalo que o filtro abrange.

object (SortSpec)

A ordem de classificação por coluna. Especificações posteriores são usadas quando os valores são iguais nas especificações anteriores.

map (key: integer, value: object ( FilterCriteria))

Os critérios para mostrar/ocultar valores por coluna. A chave do mapa é o índice da coluna, e o valor é o critério dessa coluna.

Este campo está obsoleto e foi substituído por filterSpecs:

object (FilterSpec)

Os critérios de filtro por coluna.

Ambos criteria e filterSpecs são preenchidos nas respostas. Se ambos os campos forem especificados em uma solicitação de atualização, este campo terá precedência.

{
  "bandedRangeId": integer,
  "range": {
    object (GridRange)
  },
  "rowProperties": {
    object (BandingProperties)
  },
  "columnProperties": {
    object (BandingProperties)
  }
}

integer

O ID do intervalo em intervalos.

object (GridRange)

O intervalo em que essas propriedades são aplicadas.

object (BandingProperties)

Propriedades para faixas de linha. Essas propriedades são aplicadas linha por linha em todas as linhas do intervalo. Pelo menos um de rowProperties ou columnProperties deve ser especificado.

object (BandingProperties)

Propriedades para bandas de coluna. Essas propriedades são aplicadas coluna por coluna em todas as colunas do intervalo. Pelo menos um de rowProperties ou columnProperties deve ser especificado.

{
  "headerColor": {
    object (Color)
  },
  "headerColorStyle": {
    object (ColorStyle)
  },
  "firstBandColor": {
    object (Color)
  },
  "firstBandColorStyle": {
    object (ColorStyle)
  },
  "secondBandColor": {
    object (Color)
  },
  "secondBandColorStyle": {
    object (ColorStyle)
  },
  "footerColor": {
    object (Color)
  },
  "footerColorStyle": {
    object (ColorStyle)
  }
}

object (Color)

A cor da primeira linha ou coluna. Se este campo for definido, a primeira linha ou coluna será preenchida com essa cor e as cores serão alternadas entre firstBandColor e secondBandColor começando pela segunda linha ou coluna. Caso contrário, a primeira linha ou coluna será preenchida com firstBandColor e as cores continuam a alternar como fariam normalmente. Descontinuado: uso headerColorStyle:

object (ColorStyle)

A cor da primeira linha ou coluna. Se este campo for definido, a primeira linha ou coluna será preenchida com essa cor e as cores serão alternadas entre firstBandColor e secondBandColor começando pela segunda linha ou coluna. Caso contrário, a primeira linha ou coluna será preenchida com firstBandColor e as cores continuam a alternar como fariam normalmente. Se headerColor também for definido, esse campo terá precedência.

object (Color)

A primeira cor que é alternada. (Obrigatório) Obsoleto: uso firstBandColorStyle:

object (ColorStyle)

A primeira cor que é alternada. (Obrigatório) Se firstBandColor também for definido, esse campo terá precedência.

object (Color)

É a segunda cor que é alternada. (Obrigatório) Obsoleto: uso secondBandColorStyle:

object (ColorStyle)

É a segunda cor que é alternada. (Obrigatório) Se secondBandColor também for definido, esse campo terá precedência.

object (Color)

A cor da última linha ou coluna. Se este campo não for definido, a última linha ou coluna será preenchida com firstBandColor ou secondBandColor, dependendo da cor da linha ou coluna anterior. Descontinuado: uso footerColorStyle:

object (ColorStyle)

A cor da última linha ou coluna. Se este campo não for definido, a última linha ou coluna será preenchida com firstBandColor ou secondBandColor, dependendo da cor da linha ou coluna anterior. Se footerColor também for definido, esse campo terá precedência.

{
  "range": {
    object (DimensionRange)
  },
  "depth": integer,
  "collapsed": boolean
}

object (DimensionRange)

O intervalo em que este grupo existe.

integer

A profundidade do grupo, representando quantos grupos têm um intervalo que contém totalmente o intervalo desse grupo.

boolean

Este campo será verdadeiro se o grupo estiver recolhido. Um grupo recolhido permanecerá recolhido se um grupo sobreposto em uma profundidade menor for expandido.

Um valor verdadeiro não implica que todas as dimensões no grupo estejam ocultas, já que a visibilidade de uma dimensão pode mudar independentemente dessa propriedade de grupo. No entanto, quando essa propriedade for atualizada, todas as dimensões dentro dela serão definidas como ocultas se o campo for verdadeiro ou definidas como visíveis se o campo for falso.

{
  "slicerId": integer,
  "spec": {
    object (SlicerSpec)
  },
  "position": {
    object (EmbeddedObjectPosition)
  }
}

integer

O ID do controle de filtros.

object (SlicerSpec)

A especificação do controle de filtros.

object (EmbeddedObjectPosition)

A posição do controle de filtros. O controle de filtros só pode ser posicionado na página atual. Além disso, a largura e a altura do controle de filtros podem ser ajustadas automaticamente para mantê-las dentro dos limites permitidos.

{
  "dataRange": {
    object (GridRange)
  },
  "filterCriteria": {
    object (FilterCriteria)
  },
  "columnIndex": integer,
  "applyToPivotTables": boolean,
  "title": string,
  "textFormat": {
    object (TextFormat)
  },
  "backgroundColor": {
    object (Color)
  },
  "backgroundColorStyle": {
    object (ColorStyle)
  },
  "horizontalAlignment": enum (HorizontalAlign)
}

object (GridRange)

O intervalo de dados do controle de filtros.

object (FilterCriteria)

Os critérios de filtragem do controle de filtros.

integer

O índice de coluna baseado em zero na tabela de dados em que o filtro é aplicado.

boolean

Verdadeiro se o filtro precisar ser aplicado a tabelas dinâmicas. Se não for definido, o padrão será True:

string

O título do controle de filtros.

object (TextFormat)

O formato de texto do título no controle de filtros. O campo de link não é compatível.

object (Color)

A cor de fundo do controle de filtros. Descontinuado: uso backgroundColorStyle:

object (ColorStyle)

A cor de fundo do controle de filtros. Se backgroundColor também for definido, esse campo terá precedência.

enum (HorizontalAlign)

O alinhamento horizontal do título no controle de filtros. Se não for especificado, o padrão será LEFT