Operações com elementos

Com a API Google Slides, você pode criar e editar um recurso PageElement, incluindo caixas de texto, imagens, tabelas, formas básicas, linhas e vídeos incorporados. Os exemplos nesta página mostram algumas operações comuns dos elementos de página usando o método presentations.batchUpdate.

Esses exemplos usam as seguintes variáveis:

  • PRESENTATION_ID: indica onde você fornece o ID da apresentação. Você pode recuperar o valor desse ID no URL da apresentação.
  • PAGE_ID: indica onde você fornece o ID do objeto da página. Recupere o valor disso no URL ou com uma solicitação de leitura da API.
  • PAGE_ELEMENT_ID: indica onde você fornece o ID de objeto do elemento de página. É possível especificar esse ID para elementos criados (com algumas restrições) ou permitir que a API Slides crie um automaticamente. Os IDs de elementos podem ser recuperados com uma solicitação de leitura da API.

Esses exemplos são apresentados como solicitações HTTP para serem neutros em relação à linguagem. Para saber como implementar uma atualização em lote em linguagens diferentes usando as bibliotecas de cliente das APIs do Google, consulte os seguintes guias:

Adicionar uma lista com marcadores a uma caixa de texto

O exemplo de código presentations.batchUpdate a seguir mostra como usar o método InsertTextRequest para inserir texto em uma caixa de texto vazia especificada pelo PAGE_ELEMENT_ID. Em seguida, o exemplo usa o método CreateParagraphBulletsRequest para converter todo o texto da caixa de texto em uma lista com marcadores. Os itens da lista são separados por caracteres \n, enquanto o recuo é controlado com caracteres \t.

Veja a seguir o protocolo de solicitação para criar uma apresentação:

POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate
{
  "requests": [
    {
      "insertText": {
        "objectId": PAGE_ELEMENT_ID,
        "text": "My List\n\tItem 1\n\t\tItem 2\n\t\t\tItem 3",
        "insertionIndex": 0
      },
      "createParagraphBullets": {
        "objectId": PAGE_ELEMENT_ID,
        "bulletPreset": "BULLET_ARROW_DIAMOND_DISC",
        "textRange": {
          "type": "ALL"
        }
      }
    }
  ]
}

Essa solicitação pode criar uma lista com marcadores como esta:

Resultado de receita de lista com marcadores.

Adicionar uma forma a um slide

O exemplo de código presentations.batchUpdate a seguir mostra como usar o método CreateShapeRequest para adicionar uma forma de onda a um slide especificado pelo PAGE_ID. Essa solicitação especifica o tipo de forma e, em seguida, dimensiona e posiciona a forma no slide. Em seguida, ele usa o método InsertTextRequest para adicionar texto a essa forma. A solicitação define o ID da linha como PAGE_ELEMENT_ID.

Este é o protocolo de solicitação para adicionar uma forma a um slide:

POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate
{
  "requests": [
    {
      "createShape": {
        "objectId": PAGE_ELEMENT_ID,
        "elementProperties": {
          "pageObjectId": PAGE_ID,
          "size": {
            "width": {
              "magnitude": 3000000,
              "unit": "EMU"
            },
            "height": {
              "magnitude": 3000000,
              "unit": "EMU"
            }
          },
          "transform": {
            "scaleX": 0.6807,
            "scaleY": 0.4585,
            "translateX": 6583050,
            "translateY": 1673950,
            "unit": "EMU"
          }
        },
        "shapeType": "WAVE"
      }
    },
    {
      "insertText": {
        "objectId": PAGE_ELEMENT_ID,
        "text": "My Wave Shape",
        "insertionIndex": 0
      }
    }
  ]
}

Adicionar um vídeo a um slide

O exemplo de código presentations.batchUpdate a seguir mostra como usar o método CreateVideoRequest para incorporar um vídeo a um slide especificado por PAGE_ID. Essa solicitação dimensiona e posiciona o vídeo no slide e define o ID do vídeo como PAGE_ELEMENT_ID. O identificador exclusivo do vídeo de origem está definido como VIDEO_ID. Por exemplo, o vídeo do YouTube em https://www.youtube.com/watch?v=7U3axjORYZ0 tem o ID 7U3axjORYZ0.

Veja a seguir o protocolo de solicitação para adicionar um vídeo a um slide:

POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate
{
  "requests": [
    {
      "createVideo": {
        "objectId": PAGE_ELEMENT_ID,
        "elementProperties": {
          "pageObjectId": PAGE_ID,
          "size": {
            "width": {
              "magnitude": 12000,
              "unit": "EMU"
            },
            "height": {
              "magnitude": 9000,
              "unit": "EMU"
            }
          },
          "transform": {
            "scaleX": 381,
            "scaleY": 381,
            "translateX": 152400,
            "translateY": 152400,
            "unit": "EMU"
          }
        },
        "source": "YOUTUBE",
        "id": VIDEO_ID
      }
    }
  ]
}

Copiar e editar um elemento

O exemplo de código presentations.batchUpdate a seguir mostra como usar o método DuplicateObjectRequest para usar uma forma existente (especificada por PAGE_ELEMENT_ID) e fazer uma cópia (especificada por COPY_ELEMENT_ID).

As solicitações subsequentes fazem as seguintes alterações no objeto duplicado:

  • Define a cor do plano de fundo como o tema LIGHT2.
  • Move a cópia para baixo na página (em relação à posição da forma original).
  • Define a fonte do texto como Georgia 18 pt.
  • Edita o texto para ler "Minha cópia de forma".

Essas solicitações usam máscaras de campo para preservar as propriedades da forma que não são alteradas (como o estilo do contorno). O uso de máscaras de campo também melhora o desempenho.

Para mais informações sobre como copiar um slide, consulte o exemplo Copiar um slide.

Veja a seguir o protocolo de solicitação para copiar e editar um elemento:

POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate
{
  "requests": [
    {
      "duplicateObject": {
        "objectId": PAGE_ELEMENT_ID,
        "objectIds": {
          PAGE_ELEMENT_ID: COPY_ELEMENT_ID
        }
      }
    },
    {
      "updateShapeProperties": {
        "objectId": COPY_ELEMENT_ID,
        "fields": "shapeBackgroundFill.solidFill.color",
        "shapeProperties": {
          "shapeBackgroundFill": {
            "solidFill": {
              "color": {
                "themeColor": "LIGHT2"
              }
            }
          }
        }
      }
    },
    {
      "updatePageElementTransform": {
        "objectId": COPY_ELEMENT_ID,
        "applyMode": "RELATIVE",
        "transform": {
          "scaleX": 1,
          "scaleY": 1,
          "translateX": 0,
          "translateY": 1250000,
          "unit": "EMU"
        }
      }
    },
    {
      "updateTextStyle": {
        "objectId": COPY_ELEMENT_ID,
        "fields": "fontFamily,fontSize",
        "textRange": {
          "type": "ALL"
        },
        "style": {
          "fontFamily": "Georgia",
          "fontSize": {
            "magnitude": 18,
            "unit": "PT"
          }
        }
      }
    },
    {
      "deleteText": {
        "objectId": COPY_ELEMENT_ID,
        "textRange": {
          "type": "ALL"
        }
      }
    },
    {
      "insertText": {
        "objectId": COPY_ELEMENT_ID,
        "text": "My Shape Copy",
        "insertionIndex": 0
      }
    }
  ]
}

Veja como uma forma e a cópia dela podem ficar depois dessas atualizações:

Copiar e editar o resultado de uma receita de elemento.

Editar o contorno de uma imagem ou vídeo

O exemplo de código presentations.batchUpdate a seguir mostra como usar o método UpdateImagePropertiesRequest para atualizar a aparência do contorno de uma imagem especificada pelo IMAGE_ELEMENT_ID. Ela também usa o método UpdateVideoPropertiesRequest para atualizar a aparência do contorno de um vídeo incorporado especificado pelo VIDEO_ELEMENT_ID.

As solicitações fazem as seguintes alterações no objeto:

  • Define a cor do contorno da imagem como a cor do tema ACCENT5 com transparência parcial.
  • Define a cor do contorno do vídeo como a cor do tema ACCENT1 sem transparência.
  • Define as ponderações do contorno como 3 pt para ambos.
  • Define o estilo do contorno da imagem como SOLID.
  • Define o estilo do contorno do vídeo como DASH_DOT.

Os métodos UpdateImagePropertiesRequest e UpdateVideoPropertiesRequest só podem mudar a aparência dos contornos de imagens e vídeos. Todas as outras propriedades são somente leitura. Essas solicitações usam máscaras de campo para especificar que apenas o contorno precisa ser alterado para proteger o código contra futuras mudanças na API. O uso de máscaras de campo também melhora o desempenho.

Veja a seguir o protocolo de solicitação para editar uma imagem ou um contorno de vídeo:

POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate
{
  "requests": [
    {
      "updateImageProperties": {
        "objectId": IMAGE_ELEMENT_ID,
        "fields": "outline",
        "imageProperties": {
          "outline": {
            "dashStyle": "SOLID",
            "outlineFill": {
              "solidFill": {
                "alpha": 0.8,
                "color": {
                  "themeColor": "ACCENT5"
                }
              }
            },
            "weight": {
              "magnitude": 3,
              "unit": "PT"
            }
          }
        }
      }
    },
    {
      "updateVideoProperties": {
        "objectId": VIDEO_ELEMENT_ID,
        "fields": "outline",
        "videoProperties": {
          "outline": {
            "dashStyle": "DASH_DOT",
            "outlineFill": {
              "solidFill": {
                "alpha": 0.8,
                "color": {
                  "themeColor": "ACCENT1"
                }
              }
            },
            "weight": {
              "magnitude": 3,
              "unit": "PT"
            }
          }
        }
      }
    }
  ]
}

Veja como uma imagem e um vídeo incorporado podem ficar depois dessas atualizações:

Resultado de receitas com esboços de imagens
e vídeos.

Editar o contorno de uma forma

O exemplo de código presentations.batchUpdate a seguir mostra como usar o método UpdateShapePropertiesRequest para usar uma forma já existente (especificada por PAGE_ELEMENT_ID) e atualizar a aparência do contorno.

As solicitações fazem as seguintes alterações no objeto:

  • Define a cor do contorno como a cor do tema ACCENT5 com transparência parcial.
  • Define a espessura do contorno como 3 pts.
  • Define o estilo do contorno como LONG_DASH.

Essas solicitações usam máscaras de campo para preservar as propriedades da forma que não são alteradas (como a cor de preenchimento da forma). O uso de máscaras de campo também melhora o desempenho.

Veja a seguir o protocolo de solicitação para editar o contorno de uma forma:

POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate
{
  "requests": [
    {
      "updateShapeProperties": {
        "objectId": PAGE_ELEMENT_ID,
        "fields": "outline",
        "shapeProperties": {
          "outline": {
            "dashStyle": "LONG_DASH",
            "outlineFill": {
              "solidFill": {
                "alpha": 0.6,
                "color": {
                  "themeColor": "ACCENT5"
                }
              }
            },
            "weight": {
              "magnitude": 3,
              "unit": "PT"
            }
          }
        }
      }
    }
  ]
}

Veja como uma forma pode ficar depois dessas atualizações:

Editar resultado da receita de contorno.

Formatar o texto em uma forma ou caixa de texto

O exemplo de código presentations.batchUpdate abaixo mostra como usar o método UpdateTextStyleRequest para usar uma forma já existente (especificada por PAGE_ELEMENT_ID) e atualizar a aparência do texto.

As solicitações fazem as seguintes alterações no objeto:

  • Define a cor do texto como o tema ACCENT5.
  • Define a fonte como Corsiva 18 pt em negrito, itálico.
  • Sublinha o texto.

Essas solicitações usam máscaras de campo para preservar as propriedades de estilo de texto que não são alteradas, como a cor do plano de fundo, os links ou os deslocamentos de valor de referência. O uso de máscaras de campo também melhora o desempenho.

Este é o protocolo de solicitação para formatar texto em uma forma ou caixa de texto:

POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate
{
  "requests": [
    {
      "updateTextStyle": {
        "objectId": PAGE_ELEMENT_ID,
        "fields": "foregroundColor,bold,italic,fontFamily,fontSize,underline",
        "style": {
          "foregroundColor": {
            "opaqueColor": {
              "themeColor": "ACCENT5"
            }
          },
          "bold": true,
          "italic": true,
          "underline": true,
          "fontFamily": "Corsiva",
          "fontSize": {
            "magnitude": 18,
            "unit": "PT"
          }
        },
        "textRange": {
          "type": "ALL"
        }
      }
    }
  ]
}

Veja como o texto da forma vai ficar depois dessas atualizações:

Editar resultado da receita de
formato de texto.

Importar um gráfico do Planilhas Google

O exemplo de código presentations.batchUpdate a seguir mostra como usar o método CreateSheetsChartRequest para importar um gráfico de uma página e colocá-lo em um slide especificado por PAGE_ID.

A solicitação exige o ID da planilha (especificado por SPREADSHEET_ID) e o ID do gráfico da planilha (especificado por SPREADSHEET_CHART_ID). O ID do gráfico na apresentação do Apresentações é especificado pelo PRESENTATION_CHART_ID.

A solicitação também define o LinkingMode do gráfico das Apresentações como LINKED para que você possa atualizar o gráfico incorporado se ele for atualizado na planilha de origem.

Veja a seguir o protocolo de solicitação para importar um gráfico do Planilhas:

POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate
{
  "requests": [
    {
      "createSheetsChart": {
        "objectId": PRESENTATION_CHART_ID,
        "spreadsheetId": SPREADSHEET_ID,
        "chartId": SPREADSHEET_CHART_ID,
        "linkingMode": "LINKED",
        "elementProperties": {
          "pageObjectId": PAGE_ID,
          "size": {
            "width": {
              "magnitude": 4000000,
              "unit": "EMU"
            },
            "height": {
              "magnitude": 4000000,
              "unit": "EMU"
            }
          },
          "transform": {
            "scaleX": 1,
            "scaleY": 1,
            "translateX": 100000,
            "translateY": 100000,
            "unit": "EMU"
          }
      }
    }
  ]
}

Atualizar um gráfico do Planilhas

O exemplo de código presentations.batchUpdate a seguir mostra como usar o método RefreshSheetsChartRequest para atualizar um gráfico vinculado em uma apresentação, substituindo-o pela versão mais recente desse gráfico da planilha de origem do Planilhas. A solicitação exige o ID do gráfico dentro da apresentação de slides (especificado pelo PRESENTATION_CHART_ID).

Veja a seguir o protocolo de solicitação para atualizar um gráfico do Planilhas:

POST https://slides.googleapis.com/v1/presentations/PRESENTATION_ID:batchUpdate
{
  "requests": [
    {
      "refreshSheetsChart": {
        "objectId": PRESENTATION_CHART_ID
      }
    }
  ]
}