Requests

Solicitação

Um único tipo de atualização a ser aplicado a uma apresentação.

Representação JSON
{

  // Union field kind can be only one of the following:
  "createSlide": {
    object (CreateSlideRequest)
  },
  "createShape": {
    object (CreateShapeRequest)
  },
  "createTable": {
    object (CreateTableRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "insertTableRows": {
    object (InsertTableRowsRequest)
  },
  "insertTableColumns": {
    object (InsertTableColumnsRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "deleteObject": {
    object (DeleteObjectRequest)
  },
  "updatePageElementTransform": {
    object (UpdatePageElementTransformRequest)
  },
  "updateSlidesPosition": {
    object (UpdateSlidesPositionRequest)
  },
  "deleteText": {
    object (DeleteTextRequest)
  },
  "createImage": {
    object (CreateImageRequest)
  },
  "createVideo": {
    object (CreateVideoRequest)
  },
  "createSheetsChart": {
    object (CreateSheetsChartRequest)
  },
  "createLine": {
    object (CreateLineRequest)
  },
  "refreshSheetsChart": {
    object (RefreshSheetsChartRequest)
  },
  "updateShapeProperties": {
    object (UpdateShapePropertiesRequest)
  },
  "updateImageProperties": {
    object (UpdateImagePropertiesRequest)
  },
  "updateVideoProperties": {
    object (UpdateVideoPropertiesRequest)
  },
  "updatePageProperties": {
    object (UpdatePagePropertiesRequest)
  },
  "updateTableCellProperties": {
    object (UpdateTableCellPropertiesRequest)
  },
  "updateLineProperties": {
    object (UpdateLinePropertiesRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "replaceAllShapesWithImage": {
    object (ReplaceAllShapesWithImageRequest)
  },
  "duplicateObject": {
    object (DuplicateObjectRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "replaceAllShapesWithSheetsChart": {
    object (ReplaceAllShapesWithSheetsChartRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "updateTableBorderProperties": {
    object (UpdateTableBorderPropertiesRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableRowProperties": {
    object (UpdateTableRowPropertiesRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "groupObjects": {
    object (GroupObjectsRequest)
  },
  "ungroupObjects": {
    object (UngroupObjectsRequest)
  },
  "updatePageElementAltText": {
    object (UpdatePageElementAltTextRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateSlideProperties": {
    object (UpdateSlidePropertiesRequest)
  },
  "updatePageElementsZOrder": {
    object (UpdatePageElementsZOrderRequest)
  },
  "updateLineCategory": {
    object (UpdateLineCategoryRequest)
  },
  "rerouteLine": {
    object (RerouteLineRequest)
  }
  // End of list of possible types for union field kind.
}
Campos
Campo de união kind. O tipo de atualização. Exatamente um campo é obrigatório. kind pode ser apenas uma das seguintes opções:
createSlide

object (CreateSlideRequest)

Cria um novo slide.

createShape

object (CreateShapeRequest)

Cria uma nova forma.

createTable

object (CreateTableRequest)

Cria uma nova tabela.

insertText

object (InsertTextRequest)

Insere texto em uma forma ou célula de tabela.

insertTableRows

object (InsertTableRowsRequest)

Insere linhas em uma tabela.

insertTableColumns

object (InsertTableColumnsRequest)

Insere colunas em uma tabela.

deleteTableRow

object (DeleteTableRowRequest)

Exclui uma linha de uma tabela.

deleteTableColumn

object (DeleteTableColumnRequest)

Exclui uma coluna de uma tabela.

replaceAllText

object (ReplaceAllTextRequest)

Substitui todas as instâncias do texto especificado.

deleteObject

object (DeleteObjectRequest)

Exclui uma página ou um elemento de página da apresentação.

updatePageElementTransform

object (UpdatePageElementTransformRequest)

Atualiza a transformação de um elemento de página.

updateSlidesPosition

object (UpdateSlidesPositionRequest)

Atualiza a posição de um conjunto de slides na apresentação.

deleteText

object (DeleteTextRequest)

Exclui texto de uma forma ou célula de tabela.

createImage

object (CreateImageRequest)

Cria uma imagem.

createVideo

object (CreateVideoRequest)

Cria um vídeo.

createSheetsChart

object (CreateSheetsChartRequest)

Cria um gráfico incorporado do Planilhas Google.

createLine

object (CreateLineRequest)

Cria uma linha.

refreshSheetsChart

object (RefreshSheetsChartRequest)

Atualiza um gráfico do Planilhas Google.

updateShapeProperties

object (UpdateShapePropertiesRequest)

Atualiza as propriedades de um Shape.

updateImageProperties

object (UpdateImagePropertiesRequest)

Atualiza as propriedades de um Image.

updateVideoProperties

object (UpdateVideoPropertiesRequest)

Atualiza as propriedades de um Video.

updatePageProperties

object (UpdatePagePropertiesRequest)

Atualiza as propriedades de um Page.

updateTableCellProperties

object (UpdateTableCellPropertiesRequest)

Atualiza as propriedades de um TableCell.

updateLineProperties

object (UpdateLinePropertiesRequest)

Atualiza as propriedades de um Line.

createParagraphBullets

object (CreateParagraphBulletsRequest)

Cria marcadores para parágrafos.

replaceAllShapesWithImage

object (ReplaceAllShapesWithImageRequest)

Substitui todas as formas que correspondem a alguns critérios por uma imagem.

duplicateObject

object (DuplicateObjectRequest)

Duplica um slide ou elemento de página.

updateTextStyle

object (UpdateTextStyleRequest)

Atualiza o estilo do texto em uma Shape ou Table.

replaceAllShapesWithSheetsChart

object (ReplaceAllShapesWithSheetsChartRequest)

Substitui todas as formas que correspondem a alguns critérios por um gráfico do Planilhas Google.

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

Exclui marcadores de parágrafos.

updateParagraphStyle

object (UpdateParagraphStyleRequest)

Atualiza o estilo de parágrafos em Shape ou Table.

updateTableBorderProperties

object (UpdateTableBorderPropertiesRequest)

Atualiza as propriedades das bordas da tabela em um Table.

updateTableColumnProperties

object (UpdateTableColumnPropertiesRequest)

Atualiza as propriedades de uma coluna Table.

updateTableRowProperties

object (UpdateTableRowPropertiesRequest)

Atualiza as propriedades de uma linha Table.

mergeTableCells

object (MergeTableCellsRequest)

Mescla as células em um Table.

unmergeTableCells

object (UnmergeTableCellsRequest)

Cancela a mesclagem de células em uma Table.

groupObjects

object (GroupObjectsRequest)

Agrupa objetos, como elementos de página.

ungroupObjects

object (UngroupObjectsRequest)

Desagrupa objetos, como groups.

updatePageElementAltText

object (UpdatePageElementAltTextRequest)

Atualiza o título do texto alternativo e/ou a descrição de um page element.

replaceImage

object (ReplaceImageRequest)

Substitui uma imagem existente por uma nova.

updateSlideProperties

object (UpdateSlidePropertiesRequest)

Atualiza as propriedades de um slide

updatePageElementsZOrder

object (UpdatePageElementsZOrderRequest)

Atualiza a ordem Z de page elements.

updateLineCategory

object (UpdateLineCategoryRequest)

Atualiza a categoria de um line.

rerouteLine

object (RerouteLineRequest)

redireciona um line de modo que esteja conectado nos dois sites de conexão mais próximos dos elementos de página conectados;

CreateSlideRequest

Cria um slide.

Representação JSON
{
  "objectId": string,
  "insertionIndex": integer,
  "slideLayoutReference": {
    object (LayoutReference)
  },
  "placeholderIdMappings": [
    {
      object (LayoutPlaceholderIdMapping)
    }
  ]
}
Campos
objectId

string

Um ID de objeto fornecido pelo usuário.

Se você especificar um ID, ele deverá ser exclusivo entre todas as páginas e elementos de página na apresentação. O ID precisa começar com um caractere alfanumérico ou um sublinhado (corresponde ao regex [a-zA-Z0-9_]). Os caracteres restantes podem incluir um hífen ou dois-pontos (corresponde ao regex [a-zA-Z0-9_-:]). O tamanho do ID precisa ter entre 5 e 50 caracteres.

Se você não especificar um ID, um ID exclusivo será gerado.

insertionIndex

integer

O índice opcional baseado em zero que indica onde inserir os slides.

Se você não especificar um índice, o slide será criado no final.

slideLayoutReference

object (LayoutReference)

Referência de layout do slide a ser inserido, com base no mestre atual, que é um dos seguintes:

  • Mestre do índice de slides anterior.
  • Mestre do primeiro slide, se o insertIndex for zero.
  • O primeiro mestre da apresentação, se não houver slides.

Se LayoutReference não for encontrado no mestre atual, um erro 400 de solicitação inválida será retornado.

Se você não especificar uma referência de layout, o slide usará o layout predefinido BLANK.

placeholderIdMappings[]

object (LayoutPlaceholderIdMapping)

Uma lista opcional de mapeamentos de IDs de objetos de placeholder (s) no layout para os marcadores criados no slide a partir do layout especificado. Só pode ser usado quando slideLayoutReference é especificado.

LayoutReference

Referência do layout do slide. Pode fazer referência a:

  • Um layout predefinido
  • Um dos layouts na apresentação.
Representação JSON
{

  // Union field kind can be only one of the following:
  "predefinedLayout": enum (PredefinedLayout),
  "layoutId": string
  // End of list of possible types for union field kind.
}
Campos
Campo de união kind. O tipo de LayoutReference. kind pode ser apenas uma das seguintes opções:
predefinedLayout

enum (PredefinedLayout)

Layout predefinido.

layoutId

string

ID do layout: o ID do objeto de um dos layouts da apresentação.

Layout predefinido

Tipos de layout predefinidos. Estes são layouts comumente encontrados em apresentações. No entanto, não há garantia de que esses layouts estejam presentes no mestre atual, já que eles poderiam ter sido excluídos ou não fazer parte do tema usado. Além disso, os marcadores de espaço em cada layout podem ter sido alterados.

Enums
PREDEFINED_LAYOUT_UNSPECIFIED Layout não especificado.
BLANK Layout em branco, sem marcadores de posição.
CAPTION_ONLY Layout com legenda na parte inferior.
TITLE Layout com um título e um subtítulo.
TITLE_AND_BODY Layout com título e corpo.
TITLE_AND_TWO_COLUMNS Layout com um título e duas colunas.
TITLE_ONLY Layout com apenas um título.
SECTION_HEADER Layout com um título de seção.
SECTION_TITLE_AND_DESCRIPTION Layout com título e subtítulo em um lado e descrição no outro.
ONE_COLUMN_TEXT Layout com um título e um corpo, organizados em uma única coluna.
MAIN_POINT Layout com um ponto principal.
BIG_NUMBER Layout com um título de número grande.

LayoutPlaceholderIdMapping

O mapeamento de ID especificado pelo usuário para um marcador de espaço que será criado em um slide a partir de um layout especificado.

Representação JSON
{
  "objectId": string,

  // Union field kind can be only one of the following:
  "layoutPlaceholder": {
    object (Placeholder)
  },
  "layoutPlaceholderObjectId": string
  // End of list of possible types for union field kind.
}
Campos
objectId

string

Um ID de objeto fornecido pelo usuário para o marcador identificado acima que deve ser criado em um slide.

Se você especificar um ID, ele deverá ser exclusivo entre todas as páginas e elementos de página na apresentação. O ID precisa começar com um caractere alfanumérico ou um sublinhado (corresponde ao regex [a-zA-Z0-9_]). Os caracteres restantes podem incluir um hífen ou dois pontos (corresponde ao regex [a-zA-Z0-9_-:]). O comprimento do código não pode ser menor que 5 ou maior que 50.

Se você não especificar um ID, um ID exclusivo será gerado.

Campo de união kind. O tipo para identificar um marcador de posição em um layout. kind pode ser apenas uma das seguintes opções:
layoutPlaceholder

object (Placeholder)

O marcador de posição em um layout que será aplicado a um slide. Somente type e index são necessários. Por exemplo, um layout predefinido TITLE_AND_BODY pode ter um marcador TITLE com índice 0 e um marcador BODY com índice 0.

layoutPlaceholderObjectId

string

O ID do objeto do marcador em um layout que será aplicado a um slide.

CreateShapeRequest

Cria uma nova forma.

Representação JSON
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "shapeType": enum (Type)
}
Campos
objectId

string

Um ID de objeto fornecido pelo usuário.

Se você especificar um ID, ele deverá ser exclusivo entre todas as páginas e elementos de página na apresentação. O ID precisa começar com um caractere alfanumérico ou um sublinhado (corresponde ao regex [a-zA-Z0-9_]). Os caracteres restantes podem incluir um hífen ou dois pontos (corresponde ao regex [a-zA-Z0-9_-:]). O comprimento do código não pode ser menor que 5 ou maior que 50. Se estiver vazio, um identificador exclusivo será gerado.

elementProperties

object (PageElementProperties)

As propriedades do elemento para a forma.

shapeType

enum (Type)

O tipo de forma.

Propriedades de elemento de página

Propriedades comuns de um elemento de página.

Observação: quando você cria um PageElement inicialmente, a API pode modificar os valores de size e transform, mas o tamanho visual não é alterado.

Representação JSON
{
  "pageObjectId": string,
  "size": {
    object (Size)
  },
  "transform": {
    object (AffineTransform)
  }
}
Campos
pageObjectId

string

O ID do objeto da página em que o elemento está localizado.

size

object (Size)

O tamanho do elemento.

transform

object (AffineTransform)

A transformação do elemento.

CreateTableRequest

Cria uma nova tabela.

Representação JSON
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "rows": integer,
  "columns": integer
}
Campos
objectId

string

Um ID de objeto fornecido pelo usuário.

Se você especificar um ID, ele deverá ser exclusivo entre todas as páginas e elementos de página na apresentação. O ID precisa começar com um caractere alfanumérico ou um sublinhado (corresponde ao regex [a-zA-Z0-9_]). Os caracteres restantes podem incluir um hífen ou dois pontos (corresponde ao regex [a-zA-Z0-9_-:]). O comprimento do código não pode ser menor que 5 ou maior que 50.

Se você não especificar um ID, um ID exclusivo será gerado.

elementProperties

object (PageElementProperties)

As propriedades do elemento da tabela.

A tabela será criada no tamanho fornecido, sujeito a um tamanho mínimo. Se nenhum tamanho for fornecido, a tabela será dimensionada automaticamente.

As transformações de tabela precisam ter uma escala de 1 e nenhum componente de distorção. Se nenhuma transformação for fornecida, a tabela será centralizada na página.

rows

integer

Número de linhas na tabela.

columns

integer

Número de colunas na tabela.

InsertTextRequest

Insere texto em uma forma ou célula de tabela.

Representação JSON
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "text": string,
  "insertionIndex": integer
}
Campos
objectId

string

O ID do objeto da forma ou tabela em que o texto será inserido.

cellLocation

object (TableCellLocation)

O local opcional da célula da tabela se o texto for inserido em uma célula da tabela. Se presente, o objectId precisa se referir a uma tabela.

text

string

O texto a ser inserido.

A inserção de um caractere de nova linha cria implicitamente um novo ParagraphMarker nesse índice. O estilo do novo parágrafo será copiado do parágrafo no índice de inserção atual, incluindo listas e marcadores.

Os estilos de texto para texto inserido serão determinados automaticamente, preservando o estilo do texto ao lado. Na maioria dos casos, o texto será adicionado ao TextRun que existe no índice de inserção.

Alguns caracteres de controle (U+0000-U+0008, U+000C-U+001F) e caracteres da Área de uso privado do plano multilíngue Unicode Basic (U+E000-U+F8FF) serão retirados do texto inserido.

insertionIndex

integer

O índice em que o texto será inserido, em unidades de código Unicode, com base em índices TextElement.

O índice é baseado em zero e calculado a partir do início da string. O índice pode ser ajustado para evitar inserções em clusters de grafemas Unicode. Nesses casos, o texto será inserido imediatamente depois do cluster do grafemo.

InsertTableRowsRequest

Insere linhas em uma tabela.

Representação JSON
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean,
  "number": integer
}
Campos
tableObjectId

string

A tabela na qual inserir as linhas.

cellLocation

object (TableCellLocation)

O local da célula da tabela de referência a partir do qual as linhas serão inseridas.

Uma nova linha será inserida acima (ou abaixo) da linha em que a célula de referência está. Se a célula de referência for uma célula mesclada, uma nova linha será inserida acima (ou abaixo) da célula mesclada.

insertBelow

boolean

Indica se novas linhas devem ser inseridas abaixo do local da célula de referência.

  • True: insira abaixo da célula.
  • False: insira acima da célula.
number

integer

O número de linhas a serem inseridas. Máximo de 20 por solicitação.

InsertTableColumnsRequest

Insere colunas em uma tabela.

Outras colunas na tabela serão redimensionadas para se ajustarem à nova coluna.

Representação JSON
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean,
  "number": integer
}
Campos
tableObjectId

string

A tabela na qual inserir as colunas.

cellLocation

object (TableCellLocation)

O local da célula da tabela de referência a partir do qual as colunas serão inseridas.

Uma nova coluna será inserida à esquerda (ou à direita) da coluna em que a célula de referência está. Se a célula de referência for uma célula mesclada, uma nova coluna será inserida à esquerda (ou à direita) da célula mesclada.

insertRight

boolean

Define se novas colunas devem ser inseridas à direita do local da célula de referência.

  • True: insira para a direita.
  • False: insira para a esquerda.
number

integer

O número de colunas a serem inseridas. Máximo de 20 por solicitação.

DeleteTableRowRequest

Exclui uma linha de uma tabela.

Representação JSON
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  }
}
Campos
tableObjectId

string

A tabela da qual as linhas serão excluídas.

cellLocation

object (TableCellLocation)

O local da célula da tabela de referência a partir do qual uma linha será excluída.

A linha que esta célula abrange será excluída. Se esta for uma célula mesclada, várias linhas serão excluídas. Se nenhuma linha permanecer na tabela após a exclusão, a tabela inteira será excluída.

DeleteTableColumnRequest

Exclui uma coluna de uma tabela.

Representação JSON
{
  "tableObjectId": string,
  "cellLocation": {
    object (TableCellLocation)
  }
}
Campos
tableObjectId

string

A tabela da qual as colunas serão excluídas.

cellLocation

object (TableCellLocation)

O local da célula da tabela de referência a partir do qual uma coluna será excluída.

A coluna desta célula será excluída. Se esta for uma célula mesclada, várias colunas serão excluídas. Se nenhuma coluna permanecer na tabela após a exclusão, a tabela inteira será excluída.

Substituir AllTextRequest

Substitui todas as instâncias de texto que correspondem a um critério por replace text.

Representação JSON
{
  "replaceText": string,
  "pageObjectIds": [
    string
  ],

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.
}
Campos
replaceText

string

O texto que substituirá o texto correspondente.

pageObjectIds[]

string

Se não estiver vazio, limita as correspondências a elementos de página somente nas páginas especificadas.

Retornará um erro de solicitação 400 com falha se o ID do objeto de uma notes master for fornecido ou se uma página com esse ID não existir na apresentação.

Campo de união criteria. Os critérios usados para corresponder o texto a ser substituído. criteria pode ser apenas uma das seguintes opções:
containsText

object (SubstringMatchCriteria)

Encontra texto em uma forma correspondente a esta substring.

SubstringMatchCriteria

Um critério que corresponde a uma string de texto específica em uma forma ou tabela.

Representação JSON
{
  "text": string,
  "matchCase": boolean
}
Campos
text

string

O texto a ser pesquisado na forma ou na tabela.

matchCase

boolean

Indica se a pesquisa deve respeitar o caso:

  • True: a pesquisa diferencia maiúsculas de minúsculas.
  • False: a pesquisa não diferencia maiúsculas de minúsculas.

DeleteObjectRequest

Exclui um objeto, pages ou page elements, da apresentação.

Representação JSON
{
  "objectId": string
}
Campos
objectId

string

O ID do objeto da página ou do elemento de página a ser excluído.

Se após uma operação de exclusão um group contiver apenas um ou nenhum elemento de página, o grupo também será excluído.

Se um marcador de espaço for excluído de um layout, todos os espaços reservados reservados também serão excluídos.

UpdatePageElementTransformRequest

Atualiza a transformação de um elemento de página.

Atualizar a transformação de um grupo mudará a transformação absoluta dos elementos da página nesse grupo, o que pode alterar a aparência visual. Consulte a documentação de PageElement.transform para mais detalhes.

Representação JSON
{
  "objectId": string,
  "transform": {
    object (AffineTransform)
  },
  "applyMode": enum (ApplyMode)
}
Campos
objectId

string

O ID do objeto do elemento de página a ser atualizado.

transform

object (AffineTransform)

A matriz de transformação de entrada usada para atualizar o elemento de página.

applyMode

enum (ApplyMode)

O modo de aplicação da atualização de transformação.

Aplicarmodo

Os modos de aplicação da atualização de transformação.

Enums
APPLY_MODE_UNSPECIFIED Modo não especificado.
RELATIVE Aplica a nova matriz AffineTransform à atual e a substitui pela concatenação resultante.
ABSOLUTE Substitui a matriz AffineTransform existente pela nova.

Atualizar SlidesPositionRequest

Atualiza a posição dos slides na apresentação.

Representação JSON
{
  "slideObjectIds": [
    string
  ],
  "insertionIndex": integer
}
Campos
slideObjectIds[]

string

Os IDs dos slides da apresentação que devem ser movidos. Os slides desta lista devem estar na ordem existente da apresentação, sem duplicatas.

insertionIndex

integer

O índice em que os slides devem ser inseridos, com base na organização do slide antes da movimentação. Precisa estar entre zero e o número de slides na apresentação.

DeleteTextRequest

Exclui texto de uma forma ou célula de tabela.

Representação JSON
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "textRange": {
    object (Range)
  }
}
Campos
objectId

string

O ID do objeto da forma ou tabela da qual o texto será excluído.

cellLocation

object (TableCellLocation)

O local opcional da célula da tabela se o texto for excluído de uma célula da tabela. Se presente, o objectId precisa se referir a uma tabela.

textRange

object (Range)

O intervalo de texto a ser excluído, com base em índices TextElement.

Sempre há um caractere de nova linha implícito no final do texto de uma forma ou de uma célula de tabela que não pode ser excluído. Range.Type.ALL usará os limites corretos, mas é necessário ter cuidado ao especificar limites explícitos para os tipos de intervalo FROM_START_INDEX e FIXED_RANGE. Por exemplo, se o texto for "ABC", seguido por uma nova linha implícita, o valor máximo será 2 para textRange.start_index e 3 para textRange.end_index.

A exclusão de texto que ultrapassa o limite do parágrafo pode resultar em alterações nos estilos e listas de parágrafos, à medida que os dois parágrafos são mesclados.

Os intervalos que incluem apenas uma unidade de código de um par alternativo são expandidos para incluir as duas unidades de código.

Intervalo

Especifica um intervalo contíguo de uma coleção indexada, como caracteres de texto.

Representação JSON
{
  "startIndex": integer,
  "endIndex": integer,
  "type": enum (Type)
}
Campos
startIndex

integer

O índice opcional baseado em zero do início da coleção. Obrigatório para intervalos FIXED_RANGE e FROM_START_INDEX.

endIndex

integer

O índice opcional baseado em zero do fim da coleção. Obrigatório para FIXED_RANGE intervalos.

type

enum (Type)

O tipo de intervalo.

Tipo

Os tipos de intervalos.

Enums
RANGE_TYPE_UNSPECIFIED Tipo de intervalo não especificado. Este valor não pode ser usado.
FIXED_RANGE Um intervalo fixo. É necessário especificar startIndex e endIndex.
FROM_START_INDEX Começa o intervalo em startIndex e continua até o final da coleção. O endIndex não pode ser especificado.
ALL Define o intervalo como o comprimento inteiro da coleção. Não é necessário especificar startIndex e endIndex.

CreateImageRequest

Cria uma imagem.

Representação JSON
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },

  // Union field image_source can be only one of the following:
  "url": string
  // End of list of possible types for union field image_source.
}
Campos
objectId

string

Um ID de objeto fornecido pelo usuário.

Se você especificar um ID, ele deverá ser exclusivo entre todas as páginas e elementos de página na apresentação. O ID precisa começar com um caractere alfanumérico ou um sublinhado (corresponde ao regex [a-zA-Z0-9_]). Os caracteres restantes podem incluir um hífen ou dois pontos (corresponde ao regex [a-zA-Z0-9_-:]). O comprimento do código não pode ser menor que 5 ou maior que 50.

Se você não especificar um ID, um ID exclusivo será gerado.

elementProperties

object (PageElementProperties)

As propriedades do elemento para a imagem.

Quando a proporção do tamanho fornecido não corresponde à proporção da imagem, a imagem é dimensionada e centralizada em relação ao tamanho para manter a proporção. A transformação fornecida é aplicada após essa operação.

A propriedade PageElementProperties.size é opcional. Se você não especificar o tamanho, o tamanho padrão da imagem será usado.

A propriedade PageElementProperties.transform é opcional. Se você não especificar uma transformação, a imagem será colocada no canto superior esquerdo da página.

Campo de união image_source. O tipo de origem da imagem. image_source pode ser apenas uma das seguintes opções:
url

string

O URL da imagem.

A imagem é buscada uma vez no momento da inserção, e uma cópia é armazenada para exibição dentro da apresentação. As imagens precisam ter menos de 50 MB, não pode exceder 25 megapixels e estar nos formatos PNG, JPEG ou GIF.

O URL fornecido precisa ser acessível publicamente e ter até 2 KB de tamanho. O URL é salvo com a imagem e exposto por meio do campo Image.source_url.

CreateVideoRequest

Cria um vídeo.

OBSERVAÇÃO: para criar um vídeo no Google Drive, o aplicativo solicitante precisa ter pelo menos um dos escopos "drive", "drive.readonly" ou "drive.file" do OAuth.

Representação JSON
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "source": enum (Source),
  "id": string
}
Campos
objectId

string

Um ID de objeto fornecido pelo usuário.

Se você especificar um ID, ele deverá ser exclusivo entre todas as páginas e elementos de página na apresentação. O ID precisa começar com um caractere alfanumérico ou um sublinhado (corresponde ao regex [a-zA-Z0-9_]). Os caracteres restantes podem incluir um hífen ou dois pontos (corresponde ao regex [a-zA-Z0-9_-:]). O comprimento do código não pode ser menor que 5 ou maior que 50.

Se você não especificar um ID, um ID exclusivo será gerado.

elementProperties

object (PageElementProperties)

As propriedades do elemento para o vídeo.

A propriedade PageElementProperties.size é opcional. Se você não especificar um tamanho, um tamanho padrão será escolhido pelo servidor.

A propriedade PageElementProperties.transform é opcional. A transformação não pode ter componentes de distorção. Se você não especificar uma transformação, o vídeo será colocado no canto superior esquerdo da página.

source

enum (Source)

A origem do vídeo.

id

string

O identificador exclusivo da fonte de vídeo para este vídeo.

Por exemplo, para o vídeo do YouTube https://www.youtube.com/watch?v=7U3axjORYZ0, o código é 7U3axjORYZ0. Para um vídeo do Google Drive https://drive.google.com/file/d/1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q, o código é 1xCgQLFTJi5_Xl8DgW_lcUYq5e-q6Hi5Q.

Para acessar um arquivo de vídeo do Google Drive, talvez seja necessário adicionar uma chave de recurso ao cabeçalho HTTP para um subconjunto de arquivos antigos. Para mais informações, consulte Acessar arquivos compartilhados por link usando chaves de recursos.

CreateRequest

Cria um gráfico incorporado do Planilhas Google.

OBSERVAÇÃO: a criação do gráfico requer pelo menos um dos escopos do arquivo spreadsheets.readonly, spreadsheets, drive.readonly, drive.file ou OAuth.

Representação JSON
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "spreadsheetId": string,
  "chartId": integer,
  "linkingMode": enum (LinkingMode)
}
Campos
objectId

string

Um ID de objeto fornecido pelo usuário.

Se especificado, o ID deve ser exclusivo entre todas as páginas e elementos de página na apresentação. O código precisa começar com um caractere de palavra [a-zA-Z0-9_] e ser seguido por um número de caracteres a seguir [a-zA-Z0-9_-:]. O código não pode ter menos de cinco caracteres nem ser maior que 50. Se estiver vazio, um identificador exclusivo será gerado.

elementProperties

object (PageElementProperties)

As propriedades do elemento para o gráfico.

Quando a proporção do tamanho fornecido não corresponde à do gráfico, o gráfico é dimensionado e centralizado em relação ao tamanho para manter a proporção. A transformação fornecida é aplicada após essa operação.

spreadsheetId

string

O código da planilha do Planilhas Google que contém o gráfico.

Talvez seja necessário adicionar uma chave de recurso ao cabeçalho HTTP para um subconjunto de arquivos antigos. Para mais informações, consulte Acessar arquivos compartilhados por link usando chaves de recursos.

chartId

integer

O código do gráfico específico na planilha do Planilhas Google.

linkingMode

enum (LinkingMode)

O modo com o qual o gráfico é vinculado à planilha de origem. Quando não for especificado, o gráfico será uma imagem não vinculada.

Modo de vinculação

O modo com o qual o gráfico é vinculado à planilha de origem.

Enums
NOT_LINKED_IMAGE O gráfico não está associado à planilha de origem e não pode ser atualizado. Um gráfico não vinculado será inserido como uma imagem.
LINKED A vinculação do gráfico permite que ele seja atualizado, e outros colaboradores visualizarão um link para a planilha.

CreateLineRequest

Cria uma linha.

Representação JSON
{
  "objectId": string,
  "elementProperties": {
    object (PageElementProperties)
  },
  "lineCategory": enum (Category),
  "category": enum (LineCategory)
}
Campos
objectId

string

Um ID de objeto fornecido pelo usuário.

Se você especificar um ID, ele deverá ser exclusivo entre todas as páginas e elementos de página na apresentação. O ID precisa começar com um caractere alfanumérico ou um sublinhado (corresponde ao regex [a-zA-Z0-9_]). Os caracteres restantes podem incluir um hífen ou dois pontos (corresponde ao regex [a-zA-Z0-9_-:]). O comprimento do código não pode ser menor que 5 ou maior que 50.

Se você não especificar um ID, um ID exclusivo será gerado.

elementProperties

object (PageElementProperties)

As propriedades do elemento para a linha.

lineCategory
(deprecated)

enum (Category)

A categoria da linha a ser criada.

Obsoleto : use category.

O line type exato criado é determinado com base na categoria e como é roteado para se conectar a outros elementos da página.

Se você especificar um category e um lineCategory, o category terá precedência.

category

enum (LineCategory)

A categoria da linha a ser criada.

O line type exato criado é determinado com base na categoria e como é roteado para se conectar a outros elementos da página.

Se você especificar um category e um lineCategory, o category terá precedência.

Se você não especificar um valor para category, mas especificar um para lineCategory, o valor especificado de lineCategory será usado.

Se você não especificar nenhum deles, STRAIGHT será usado.

Categoria

As categorias de linha.

Enums
STRAIGHT Conectores retos, incluindo o conector reto 1. A é a categoria padrão quando não há especificação.
BENT Conectores dobrados, incluindo o conector dobrado 2 a 5.
CURVED Conectores curvos, incluindo o conector curvo de 2 a 5.

RefreshSheetChartRequest

Atualiza um gráfico do Planilhas Google incorporado, substituindo-o pela versão mais recente do gráfico do Planilhas Google.

OBSERVAÇÃO: a atualização de gráficos requer pelo menos um dos escopos do arquivo spreadsheets.readonly, spreadsheets, drive.readonly ou Drive.

Representação JSON
{
  "objectId": string
}
Campos
objectId

string

O ID do objeto do gráfico a ser atualizado.

UpdateShapePropertiesRequest.

Atualize as propriedades de um Shape.

Representação JSON
{
  "objectId": string,
  "shapeProperties": {
    object (ShapeProperties)
  },
  "fields": string
}
Campos
objectId

string

O ID do objeto do formato ao qual as atualizações são aplicadas.

shapeProperties

object (ShapeProperties)

As propriedades da forma a serem atualizadas.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

Pelo menos um campo precisa ser especificado. A raiz shapeProperties está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Por exemplo, para atualizar a cor sólida de preenchimento do plano de fundo, defina fields como "shapeBackgroundFill.solidFill.color".

Para redefinir uma propriedade para o valor padrão, inclua o nome do campo na máscara, mas não altere o campo.

UpdateImagePropertiesRequest

Atualize as propriedades de um Image.

Representação JSON
{
  "objectId": string,
  "imageProperties": {
    object (ImageProperties)
  },
  "fields": string
}
Campos
objectId

string

O ID do objeto da imagem à qual as atualizações são aplicadas.

imageProperties

object (ImageProperties)

As propriedades da imagem a serem atualizadas.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

Pelo menos um campo precisa ser especificado. A raiz imageProperties está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Por exemplo, para atualizar a cor do contorno da imagem, defina fields como "outline.outlineFill.solidFill.color".

Para redefinir uma propriedade para o valor padrão, inclua o nome do campo na máscara, mas não altere o campo.

AtualizarVideoPropertiesRequest

Atualize as propriedades de um Video.

Representação JSON
{
  "objectId": string,
  "videoProperties": {
    object (VideoProperties)
  },
  "fields": string
}
Campos
objectId

string

O ID do objeto do vídeo ao qual as atualizações são aplicadas.

videoProperties

object (VideoProperties)

As propriedades do vídeo a serem atualizadas.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

Pelo menos um campo precisa ser especificado. A raiz videoProperties está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Por exemplo, para atualizar a cor do contorno do vídeo, defina fields como "outline.outlineFill.solidFill.color".

Para redefinir uma propriedade para o valor padrão, inclua o nome do campo na máscara, mas não altere o campo.

Atualização de propriedades de página

Atualiza as propriedades de um Page.

Representação JSON
{
  "objectId": string,
  "pageProperties": {
    object (PageProperties)
  },
  "fields": string
}
Campos
objectId

string

O ID do objeto da página à qual a atualização é aplicada.

pageProperties

object (PageProperties)

As propriedades da página a serem atualizadas.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

Pelo menos um campo precisa ser especificado. A raiz pageProperties está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Por exemplo, para atualizar a cor de preenchimento sólida do plano de fundo da página, defina fields como "pageBackgroundFill.solidFill.color".

Para redefinir uma propriedade para o valor padrão, inclua o nome do campo na máscara, mas não altere o campo.

Atualizar TableCellPropertiesRequest

Atualize as propriedades de um TableCell.

Representação JSON
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  },
  "tableCellProperties": {
    object (TableCellProperties)
  },
  "fields": string
}
Campos
objectId

string

O ID do objeto da tabela.

tableRange

object (TableRange)

O intervalo da tabela que representa o subconjunto da tabela à qual as atualizações são aplicadas. Se um intervalo de tabela não for especificado, as atualizações serão aplicadas à tabela inteira.

tableCellProperties

object (TableCellProperties)

As propriedades das células da tabela a serem atualizadas.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

Pelo menos um campo precisa ser especificado. A raiz tableCellProperties está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Por exemplo, para atualizar a cor de preenchimento sólida do plano de fundo da célula da tabela, defina fields como "tableCellBackgroundFill.solidFill.color".

Para redefinir uma propriedade para o valor padrão, inclua o nome do campo na máscara, mas não altere o campo.

Intervalo da tabela

Um intervalo de tabela representa uma referência a um subconjunto de uma tabela.

É importante observar que as células especificadas por um intervalo de tabela não formam necessariamente um retângulo. Por exemplo, digamos que temos uma tabela 3 x 3 na qual todas as células da última linha estão mescladas. A tabela terá esta aparência:

 [   ][   ][   ]
 [   ][   ][   ]
 [             ]

Um intervalo de tabela com local = (0, 0), período de linha = 3 e período de coluna = 2 especifica as seguintes células:

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
Representação JSON
{
  "location": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
Campos
location

object (TableCellLocation)

O local de início do intervalo da tabela.

rowSpan

integer

O período da linha do intervalo da tabela.

columnSpan

integer

O período da coluna do intervalo da tabela.

UpdateLinePropertiesRequest

Atualiza as propriedades de um Line.

Representação JSON
{
  "objectId": string,
  "lineProperties": {
    object (LineProperties)
  },
  "fields": string
}
Campos
objectId

string

O ID do objeto da linha à qual a atualização é aplicada.

lineProperties

object (LineProperties)

As propriedades da linha a serem atualizadas.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

Pelo menos um campo precisa ser especificado. A raiz lineProperties está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Por exemplo, para atualizar a cor de preenchimento sólida da linha, defina fields como "lineFill.solidFill.color".

Para redefinir uma propriedade para o valor padrão, inclua o nome do campo na máscara, mas não altere o campo.

CreateParagraphBulletsRequest

Cria marcadores para todos os parágrafos que se sobrepõem ao intervalo de índice de texto fornecido.

O nível de aninhamento de cada parágrafo será determinado contando as guias à frente de cada parágrafo. Para evitar espaço excessivo entre o marcador e o parágrafo correspondente, essas guias à esquerda são removidas por essa solicitação. Isso pode alterar os índices de partes do texto.

Se o parágrafo imediatamente anterior aos parágrafos atualizados estiver em uma lista com uma predefinição correspondente, os parágrafos atualizados serão adicionados a essa lista.

Representação JSON
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "textRange": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
Campos
objectId

string

O ID do objeto da forma ou tabela que contém o texto ao qual os marcadores serão adicionados.

cellLocation

object (TableCellLocation)

O local opcional da célula da tabela se o texto a ser modificado estiver em uma célula da tabela. Se presente, o objectId precisa se referir a uma tabela.

textRange

object (Range)

O intervalo de texto ao qual serão aplicadas as predefinições de marcador, com base em índices TextElement.

bulletPreset

enum (BulletGlyphPreset)

Os tipos de glifos de marcador a serem usados. O padrão é a predefinição BULLET_DISC_CIRCLE_SQUARE.

Conjunto de BulletGlyphph

Padrões de glifos de marcador para listas no texto.

Esses padrões usam estes tipos de marcadores:

  • ARROW: uma seta, correspondente a um ponto de código Unicode U+2794
  • ARROW3D: uma seta com sombreamento 3D correspondente a um ponto de código Unicode U+27a2.
  • CHECKBOX: um quadrado oco, correspondente a um ponto de código Unicode U+274f
  • CIRCLE: um círculo vazio, que corresponde a um ponto de código Unicode U+25cb
  • DIAMOND: um diamante sólido, correspondente a um ponto de código Unicode U+25c6
  • DIAMONDX: um diamante com um "x", que corresponde a um ponto de código Unicode U+2756
  • HOLLOWDIAMOND: um losango vazado, correspondente a um ponto de código Unicode U+25c7
  • DISC: um círculo sólido, correspondente a um ponto de código Unicode U+25cf
  • SQUARE: um quadrado sólido, correspondente a um ponto de código Unicode U+25a0.
  • STAR: uma estrela, correspondente a um ponto de código Unicode U+2605
  • ALPHA: uma letra minúscula, como "a", "b" ou "c".
  • UPPERALPHA: uma letra maiúscula, como "A", "B" ou "C".
  • DIGIT : um número, como "1", "2" ou "3".
  • ZERODIGIT: um número em que números de um único dígito são prefixados com um zero, como "01", "02" ou "03". Números com mais de um dígito não são prefixados em zero.
  • ROMAN : um algarismo romano minúsculo, como "i", "ii" ou "iii".
  • UPPERROMAN: um algarismo romano romano, como "I", "II" ou "III".
  • LEFTTRIANGLE: um triângulo apontando para a esquerda, correspondente a um ponto de código Unicode U+25c4
Enums
BULLET_DISC_CIRCLE_SQUARE Uma lista com marcadores com um glifo DISC, CIRCLE e SQUARE para os três primeiros níveis de aninhamento de lista.
BULLET_DIAMONDX_ARROW3D_SQUARE Uma lista com marcadores com um glifo DIAMONDX, ARROW3D e SQUARE para os três primeiros níveis de aninhamento de lista.
BULLET_CHECKBOX Uma lista com marcadores com glifos de CHECKBOX para todos os níveis de aninhamento.
BULLET_ARROW_DIAMOND_DISC Uma lista com marcadores com um glifo ARROW, DIAMOND e DISC para os três primeiros níveis de aninhamento de lista.
BULLET_STAR_CIRCLE_SQUARE Uma lista com marcadores com um glifo STAR, CIRCLE e SQUARE para os três primeiros níveis de aninhamento de lista.
BULLET_ARROW3D_CIRCLE_SQUARE Uma lista com marcadores com um glifo ARROW3D, CIRCLE e SQUARE para os três primeiros níveis de aninhamento de lista.
BULLET_LEFTTRIANGLE_DIAMOND_DISC Uma lista com marcadores com um glifo LEFTTRIANGLE, DIAMOND e DISC para os três primeiros níveis de aninhamento de lista.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE Uma lista com marcadores com um glifo DIAMONDX, HOLLOWDIAMOND e SQUARE para os três primeiros níveis de aninhamento de lista.
BULLET_DIAMOND_CIRCLE_SQUARE Uma lista com marcadores com um glifo DIAMOND, CIRCLE e SQUARE para os três primeiros níveis de aninhamento de lista.
NUMBERED_DIGIT_ALPHA_ROMAN Uma lista numerada com glifos numéricos DIGIT, ALPHA e ROMAN para os três primeiros níveis de aninhamento da lista, seguidos por pontos.
NUMBERED_DIGIT_ALPHA_ROMAN_PARENS Uma lista numerada com glifos numéricos DIGIT, ALPHA e ROMAN para os três primeiros níveis de aninhamento da lista, seguidos por parênteses.
NUMBERED_DIGIT_NESTED Uma lista numerada com glifos numéricos DIGIT separados por pontos, em que cada nível de aninhamento usa o glifo do nível anterior como prefixo. Por exemplo: "1.", "1.1", "2.", "2.2".
NUMBERED_UPPERALPHA_ALPHA_ROMAN Uma lista numerada com glifos numéricos UPPERALPHA, ALPHA e ROMAN para os três primeiros níveis de aninhamento da lista, seguidos por pontos.
NUMBERED_UPPERROMAN_UPPERALPHA_DIGIT Uma lista numerada com glifos numéricos UPPERROMAN, UPPERALPHA e DIGIT para os três primeiros níveis de aninhamento da lista, seguidos por pontos.
NUMBERED_ZERODIGIT_ALPHA_ROMAN Uma lista numerada com glifos numéricos ZERODIGIT, ALPHA e ROMAN para os três primeiros níveis de aninhamento da lista, seguidos por pontos.

ReplaceAllShapesWithImageRequest

Substitui todas as formas que correspondem aos critérios fornecidos pela imagem fornecida.

As imagens que substituem as formas são retangulares após serem inseridas na apresentação e não assumem as formas das formas.

Representação JSON
{
  "replaceMethod": enum (ReplaceMethod),
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "pageObjectIds": [
    string
  ],

  // Union field criteria can be only one of the following:
  "containsText": {
    object (SubstringMatchCriteria)
  }
  // End of list of possible types for union field criteria.

  // Union field image_source can be only one of the following:
  "imageUrl": string
  // End of list of possible types for union field image_source.
}
Campos
replaceMethod
(deprecated)

enum (ReplaceMethod)

O método de substituição.

Obsoleto : use imageReplaceMethod.

Se você especificar um replaceMethod e um imageReplaceMethod, o imageReplaceMethod terá precedência.

imageReplaceMethod

enum (ImageReplaceMethod)

O método de substituição de imagem.

Se você especificar um replaceMethod e um imageReplaceMethod, o imageReplaceMethod terá precedência.

Se você não especificar um valor para imageReplaceMethod, mas especificar um para replaceMethod, o valor especificado de replaceMethod será usado.

Se você não especificar nada, CENTER_INSIDE será usado.

pageObjectIds[]

string

Se não estiver vazio, limita as correspondências a elementos de página somente nas páginas especificadas.

Retornará um erro de solicitação com erro 400 se o ID do objeto de uma página for notes page ou notes master, ou se não existir uma página com esse ID de objeto na apresentação.

Campo de união criteria. Os critérios aos quais as formas devem corresponder para serem substituídos. criteria pode ser apenas uma das seguintes opções:
containsText

object (SubstringMatchCriteria)

Se definido, esta solicitação substituirá todas as formas que contêm o texto fornecido.

Campo de união image_source. O tipo de origem da imagem. image_source pode ser apenas uma das seguintes opções:
imageUrl

string

O URL da imagem.

A imagem é buscada uma vez no momento da inserção, e uma cópia é armazenada para exibição dentro da apresentação. As imagens devem ter menos de 50 MB, não pode exceder 25 megapixels e estar no formato PNG, JPEG ou GIF.

O URL fornecido pode ter no máximo 2 KB. O URL é salvo com a imagem e exposto por meio do campo Image.source_url.

Substituir método

O método de substituição.

Enums
CENTER_INSIDE Redimensiona e centraliza a imagem para caber dentro dos limites da forma original e mantém a proporção da imagem. O tamanho renderizado da imagem pode ser menor que o tamanho da forma. Este é o método padrão quando não há especificação.
CENTER_CROP Dimensiona e centraliza a imagem para preencher os limites da forma original. A imagem pode ser cortada para preencher a forma. O tamanho renderizado da imagem será igual ao da forma original.

ImageReplaceMethod

O método de substituição de imagem.

Enums
IMAGE_REPLACE_METHOD_UNSPECIFIED Método de substituição de imagem não especificado. Este valor não pode ser usado.
CENTER_INSIDE Redimensiona e centraliza a imagem para caber dentro dos limites da forma original e mantém a proporção da imagem. O tamanho renderizado da imagem pode ser menor que o tamanho da forma. Este é o método padrão quando não há especificação.
CENTER_CROP Dimensiona e centraliza a imagem para preencher os limites da forma original. A imagem pode ser cortada para preencher a forma. O tamanho renderizado da imagem será igual ao formato original.

Solicitação de objeto duplicado

Duplica um slide ou elemento de página.

Ao duplicar um slide, ele será criado imediatamente após o slide especificado. Ao duplicar um elemento de página, a cópia será colocada na mesma página e na mesma posição que o original.

Representação JSON
{
  "objectId": string,
  "objectIds": {
    string: string,
    ...
  }
}
Campos
objectId

string

O ID do objeto a ser duplicado.

objectIds

map (key: string, value: string)

O objeto que está sendo duplicado pode conter outros objetos, por exemplo, ao duplicar um slide ou um elemento de página de grupo. Este mapa define como os IDs de objetos duplicados são gerados: as chaves são os IDs dos objetos originais e seus valores são os IDs que serão atribuídos ao objeto duplicado correspondente. O ID da cópia do objeto de origem também pode ser especificado nesse mapa, usando o mesmo valor do campo objectId como uma chave e o ID recém-desejado do valor.

Todas as chaves precisam corresponder aos IDs existentes na apresentação. Todos os valores precisam ser únicos na apresentação e precisam começar com um caractere alfanumérico ou um sublinhado (corresponde ao regex [a-zA-Z0-9_]). Os caracteres restantes podem incluir, assim como um hífen ou dois pontos (corresponde ao regex [a-zA-Z0-9_-:]). O comprimento do novo código não pode ser menor que 5 ou maior que 50.

Se algum ID de objetos de origem for omitido do mapa, um novo ID aleatório será atribuído. Se o mapa estiver vazio ou não definido, todos os objetos duplicados receberão um novo ID aleatório.

Atualização de TextTextStyleRequest

Atualize o estilo do texto em uma Shape ou Table.

Representação JSON
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "style": {
    object (TextStyle)
  },
  "textRange": {
    object (Range)
  },
  "fields": string
}
Campos
objectId

string

O ID do objeto da forma ou tabela com o texto a ser estilizado.

cellLocation

object (TableCellLocation)

O local da célula na tabela que contém o texto a ser estilizado. Se objectId se referir a uma tabela, cellLocation precisará ter um valor. Caso contrário, não deve ser.

style

object (TextStyle)

Os estilos a serem definidos no texto.

Se o valor de um estilo específico corresponder ao valor do pai, esse estilo será definido como herdado.

Algumas alterações de estilo de texto podem fazer com que outras alterações reflitam o comportamento do editor do Apresentações. Consulte a documentação de TextStyle para mais informações.

textRange

object (Range)

O intervalo de texto a ser estilizado.

O intervalo pode ser estendido para incluir novas linhas adjacentes.

Se o intervalo contiver um parágrafo que pertença a uma lista, o marcador dele também será atualizado com o estilo de texto correspondente.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

Pelo menos um campo precisa ser especificado. A raiz style está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Por exemplo, para atualizar o estilo do texto para negrito, defina fields como "bold".

Para redefinir uma propriedade para o valor padrão, inclua o nome do campo na máscara, mas não altere o campo.

SubstituirAllShapesWithSheetsChartRequest

Substitui todas as formas que correspondem aos critérios fornecidos pelo gráfico do Planilhas Google fornecido. O gráfico será dimensionado e centralizado para caber nos limites da forma original.

OBSERVAÇÃO: para substituir formas por um gráfico, é necessário pelo menos um dos escopos do arquivo spreadsheets.readonly, spreadsheets, drive.readonly ou Drive.

Representação JSON
{
  "containsText": {
    object (SubstringMatchCriteria)
  },
  "spreadsheetId": string,
  "chartId": integer,
  "linkingMode": enum (LinkingMode),
  "pageObjectIds": [
    string
  ]
}
Campos
containsText

object (SubstringMatchCriteria)

Os critérios aos quais as formas devem corresponder para serem substituídos. A solicitação substituirá todas as formas que contêm o texto fornecido.

spreadsheetId

string

O código da planilha do Planilhas Google que contém o gráfico.

chartId

integer

O código do gráfico específico na planilha do Planilhas Google.

linkingMode

enum (LinkingMode)

O modo com o qual o gráfico é vinculado à planilha de origem. Quando não for especificado, o gráfico será uma imagem não vinculada.

pageObjectIds[]

string

Se não estiver vazio, limita as correspondências a elementos de página somente nas páginas especificadas.

Retornará um erro de solicitação com erro 400 se o ID do objeto de uma página for notes page ou notes master, ou se não existir uma página com esse ID de objeto na apresentação.

Modo de vinculação

O modo com o qual o gráfico é vinculado à planilha de origem.

Enums
NOT_LINKED_IMAGE O gráfico não está associado à planilha de origem e não pode ser atualizado. Um gráfico não vinculado será inserido como uma imagem.
LINKED A vinculação do gráfico permite que ele seja atualizado, e outros colaboradores visualizarão um link para a planilha.

ExcluirParagraphBulletBullets

Exclui os marcadores de todos os parágrafos que se sobrepõem ao índice de texto range fornecido.

O nível de aninhamento de cada parágrafo será preservado visualmente com a adição do recuo ao início do parágrafo correspondente.

Representação JSON
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "textRange": {
    object (Range)
  }
}
Campos
objectId

string

O ID do objeto da forma ou tabela que contém o texto do qual os marcadores serão excluídos.

cellLocation

object (TableCellLocation)

O local opcional da célula da tabela se o texto a ser modificado estiver em uma célula da tabela. Se presente, o objectId precisa se referir a uma tabela.

textRange

object (Range)

O intervalo de texto do qual os marcadores serão excluídos, com base em índices TextElement.

AtualizarParagraphParagraphRequest

Atualiza o estilo de todos os parágrafos em um Shape ou Table que se sobrepõem ao intervalo do índice de texto fornecido.

Representação JSON
{
  "objectId": string,
  "cellLocation": {
    object (TableCellLocation)
  },
  "style": {
    object (ParagraphStyle)
  },
  "textRange": {
    object (Range)
  },
  "fields": string
}
Campos
objectId

string

O ID do objeto da forma ou tabela com o texto a ser estilizado.

cellLocation

object (TableCellLocation)

A localização da célula na tabela que contém os parágrafos a serem estilizados. Se objectId se referir a uma tabela, cellLocation precisará ter um valor. Caso contrário, não deve ser.

style

object (ParagraphStyle)

O estilo do parágrafo.

textRange

object (Range)

O intervalo de texto que contém os parágrafos a serem estilizados.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

Pelo menos um campo precisa ser especificado. A raiz style está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Por exemplo, para atualizar o alinhamento de parágrafo, defina fields como "alignment".

Para redefinir uma propriedade para o valor padrão, inclua o nome do campo na máscara, mas não altere o campo.

UpdateTableBorderPropertiesRequest

Atualiza as propriedades das bordas da tabela em um Table.

Representação JSON
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  },
  "borderPosition": enum (BorderPosition),
  "tableBorderProperties": {
    object (TableBorderProperties)
  },
  "fields": string
}
Campos
objectId

string

O ID do objeto da tabela.

tableRange

object (TableRange)

O intervalo da tabela que representa o subconjunto da tabela à qual as atualizações são aplicadas. Se um intervalo de tabela não for especificado, as atualizações serão aplicadas à tabela inteira.

borderPosition

enum (BorderPosition)

A posição da borda no intervalo da tabela em que as atualizações serão aplicadas. Se uma posição de borda não for especificada, as atualizações serão aplicadas a todas as bordas no intervalo da tabela.

tableBorderProperties

object (TableBorderProperties)

As propriedades da borda da tabela a serem atualizadas.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

Pelo menos um campo precisa ser especificado. A raiz tableBorderProperties está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Por exemplo, para atualizar a cor de preenchimento da borda da tabela, defina fields como "tableBorderFill.solidFill.color".

Para redefinir uma propriedade para o valor padrão, inclua o nome do campo na máscara, mas não altere o campo.

BorderPosition

A posição da borda da tabela.

Enums
ALL Todas as bordas no intervalo.
BOTTOM Bordas na parte inferior do intervalo.
INNER Bordas no interior do intervalo.
INNER_HORIZONTAL Bordas horizontais no interior do intervalo.
INNER_VERTICAL Bordas verticais no interior do intervalo.
LEFT Bordas à esquerda do intervalo.
OUTER Bordas ao longo da parte externa do intervalo.
RIGHT Bordas à direita do intervalo.
TOP Bordas na parte superior do intervalo.

Atualizar TableColumnPropertiesRequest

Atualiza as propriedades de uma coluna Table.

Representação JSON
{
  "objectId": string,
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
Campos
objectId

string

O ID do objeto da tabela.

columnIndices[]

integer

A lista de índices baseados em zero que especifica quais colunas atualizar. Se nenhum índice for fornecido, todas as colunas na tabela serão atualizadas.

tableColumnProperties

object (TableColumnProperties)

As propriedades da coluna da tabela a serem atualizadas.

Se o valor de tableColumnProperties#columnWidth na solicitação for menor que 406.400 EMU (32 pontos), um erro 400 de solicitação inválida será retornado.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

Pelo menos um campo precisa ser especificado. A raiz tableColumnProperties está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Por exemplo, para atualizar a largura da coluna, defina fields como "columnWidth".

Se ""columnWidth"" for incluído na máscara de campo, mas a propriedade não for definida,a largura da coluna será padronizada para 406.400 EMU (32 pontos).

UpdateTableRowPropertiesRequest

Atualiza as propriedades de uma linha Table.

Representação JSON
{
  "objectId": string,
  "rowIndices": [
    integer
  ],
  "tableRowProperties": {
    object (TableRowProperties)
  },
  "fields": string
}
Campos
objectId

string

O ID do objeto da tabela.

rowIndices[]

integer

A lista de índices baseados em zero que especifica quais linhas devem ser atualizadas. Se nenhum índice for fornecido, todas as linhas da tabela serão atualizadas.

tableRowProperties

object (TableRowProperties)

As propriedades da linha da tabela a serem atualizadas.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

Pelo menos um campo precisa ser especificado. A raiz tableRowProperties está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Por exemplo, para atualizar a altura mínima da linha, defina fields como "minRowHeight".

Se "minRowHeight" for incluído na máscara de campo, mas a propriedade não for definida, a altura mínima da linha será padronizada como 0.

MesclarTableCellsRequest

Mescla as células em um Table.

Representação JSON
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  }
}
Campos
objectId

string

O ID do objeto da tabela.

tableRange

object (TableRange)

O intervalo da tabela que especifica as células a serem mescladas.

Qualquer texto nas células que estiverem sendo mescladas será concatenado e armazenado na célula do canto superior esquerdo ("head") do intervalo. Se o intervalo não for retangular (o que pode ocorrer em alguns casos em que o intervalo cobre células que já foram mescladas), será retornado um erro 400 de solicitação inválida.

UnmergeTableCellsRequest

Cancela a mesclagem de células em uma Table.

Representação JSON
{
  "objectId": string,
  "tableRange": {
    object (TableRange)
  }
}
Campos
objectId

string

O ID do objeto da tabela.

tableRange

object (TableRange)

O intervalo da tabela que especifica as células a serem desfeitas.

Todas as células mescladas nesse intervalo não serão mescladas, e as células que já foram mescladas não serão afetadas. Se o intervalo não tiver células mescladas, a solicitação não terá efeito. Se houver texto em qualquer uma das células mescladas, o texto permanecerá na célula superior esquerda ("head") do bloco resultante de células não mescladas.

Solicitação de objeto de grupo

Agrupa objetos para criar um grupo de objetos. Por exemplo, agrupa PageElements para criar um Group na mesma página que todos os filhos.

Representação JSON
{
  "groupObjectId": string,
  "childrenObjectIds": [
    string
  ]
}
Campos
groupObjectId

string

Um ID de objeto fornecido pelo usuário para o grupo a ser criado.

Se você especificar um ID, ele deverá ser exclusivo entre todas as páginas e elementos de página na apresentação. O ID precisa começar com um caractere alfanumérico ou um sublinhado (corresponde ao regex [a-zA-Z0-9_]). Os caracteres restantes podem incluir um hífen ou dois pontos (corresponde ao regex [a-zA-Z0-9_-:]). O comprimento do código não pode ser menor que 5 ou maior que 50.

Se você não especificar um ID, um ID exclusivo será gerado.

childrenObjectIds[]

string

Os IDs dos objetos a serem agrupados.

Somente elementos da página podem ser agrupados. Deve haver pelo menos dois elementos de página na mesma página que ainda não estejam em outro grupo. Alguns elementos da página, como videos, tables e placeholders, não podem ser agrupados.

UngroupObjectsRequest

Desagrupa objetos, como groups.

Representação JSON
{
  "objectIds": [
    string
  ]
}
Campos
objectIds[]

string

Os códigos de objetos dos objetos para desagrupar.

Somente groups que não estejam dentro de outros groups podem ser desagrupados. Todos os grupos devem estar na mesma página. O próprio grupo será excluído. Os tamanhos e as posições visuais de todos os filhos são preservados.

UpdatePageElementAltTextRequest

Atualiza o título do texto alternativo e/ou a descrição de um page element.

Representação JSON
{
  "objectId": string,
  "title": string,
  "description": string
}
Campos
objectId

string

O ID do objeto do elemento de página ao qual as atualizações são aplicadas.

title

string

O título do texto alternativo atualizado do elemento de página. Se não for definido, o valor existente será mantido. O título é exposto a leitores de tela e outras interfaces de acessibilidade. Use apenas valores legíveis relacionados ao conteúdo do elemento de página.

description

string

A descrição do texto alternativo do elemento da página. Se não for definido, o valor existente será mantido. A descrição é exposta a leitores de tela e outras interfaces de acessibilidade. Use apenas valores legíveis relacionados ao conteúdo do elemento de página.

Solicitação de substituição de imagem

Substitui uma imagem existente por uma nova.

A substituição de uma imagem remove parte da image effects da imagem atual.

Representação JSON
{
  "imageObjectId": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),

  // Union field image_source can be only one of the following:
  "url": string
  // End of list of possible types for union field image_source.
}
Campos
imageObjectId

string

O ID da imagem existente que será substituída. O ID pode ser recuperado a partir da resposta de uma solicitação get.

imageReplaceMethod

enum (ImageReplaceMethod)

O método de substituição.

Campo de união image_source. O tipo de origem da imagem. image_source pode ser apenas uma das seguintes opções:
url

string

O URL da imagem.

A imagem é buscada uma vez no momento da inserção, e uma cópia é armazenada para exibição dentro da apresentação. As imagens precisam ter menos de 50 MB, não podem exceder 25 megapixels e precisam estar no formato PNG, JPEG ou GIF.

O URL fornecido não pode ultrapassar 2 KB. O URL é salvo com a imagem e exposto por meio do campo Image.source_url.

UpdateSlidePropertiesRequest

Atualiza as propriedades de um slide.

Representação JSON
{
  "objectId": string,
  "slideProperties": {
    object (SlideProperties)
  },
  "fields": string
}
Campos
objectId

string

O ID do objeto do slide ao qual a atualização é aplicada.

slideProperties

object (SlideProperties)

As propriedades do slide a serem atualizadas.

fields

string (FieldMask format)

Os campos que precisam ser atualizados.

Pelo menos um campo precisa ser especificado. A raiz "slideProperties" está implícita e não deve ser especificada. Um único "*" pode ser usado como uma forma abreviada de listar todos os campos.

Por exemplo, para atualizar se um slide é ignorado, defina fields como "isSkipped".

Para redefinir uma propriedade para o valor padrão, inclua o nome do campo na máscara, mas não altere o campo.

UpdatePageElementsZOrderRequest

Atualiza a ordem Z dos elementos da página. A ordem Z é uma ordem dos elementos na página de trás para frente. O elemento da página na frente pode cobrir os elementos atrás dele.

Representação JSON
{
  "pageElementObjectIds": [
    string
  ],
  "operation": enum (ZOrderOperation)
}
Campos
pageElementObjectIds[]

string

Os IDs de objeto dos elementos de página a serem atualizados.

Todos os elementos da página precisam estar na mesma página e não podem ser agrupados.

operation

enum (ZOrderOperation)

A operação de ordem Z para aplicar aos elementos da página.

Ao aplicar a operação a vários elementos de página, as encomendas Z relativas nesses elementos de página antes da operação serão mantidas.

Operação ZOrder

A operação para atualizar a ordem Z de um elemento da página.

Enums
Z_ORDER_OPERATION_UNSPECIFIED Operação não especificada.
BRING_TO_FRONT Traz os elementos da página para a frente da página.
BRING_FORWARD Traz os elementos da página para frente na página em relação a um elemento em relação ao mais para frente nos elementos de página especificados.
SEND_BACKWARD Envia os elementos da página para trás na página, por um elemento relativo ao mais distante atrás de um nos elementos da página especificados.
SEND_TO_BACK Envia os elementos da página para o verso.

AtualizarLineCategoryRequest

Atualiza a categoria de um line.

Representação JSON
{
  "objectId": string,
  "lineCategory": enum (LineCategory)
}
Campos
objectId

string

O ID do objeto da linha à qual a atualização é aplicada.

Somente uma linha com um category indicando que é um "conector" pode ser atualizada.

A linha pode ser redirecionada após a atualização da categoria.

lineCategory

enum (LineCategory)

A categoria da linha a ser atualizada.

O line type exato é determinado com base na categoria a ser atualizada e como é roteado para se conectar a outros elementos da página.

RerouteLineRequest

redireciona um line de modo que esteja conectado nos dois sites de conexão mais próximos dos elementos de página conectados;

Representação JSON
{
  "objectId": string
}
Campos
objectId

string

O ID do objeto da linha a ser redirecionada.

Somente uma linha com um category indicando que é um "conector" pode ser redirecionada. As conexões inicial e final da linha devem estar em diferentes elementos da página.