Requests

Risorse richieste:

Un singolo aggiornamento da applicare a un documento.

Rappresentazione JSON
{

  // Union field request can be only one of the following:
  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "createNamedRange": {
    object (CreateNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "deleteContentRange": {
    object (DeleteContentRangeRequest)
  },
  "insertInlineImage": {
    object (InsertInlineImageRequest)
  },
  "insertTable": {
    object (InsertTableRequest)
  },
  "insertTableRow": {
    object (InsertTableRowRequest)
  },
  "insertTableColumn": {
    object (InsertTableColumnRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "insertPageBreak": {
    object (InsertPageBreakRequest)
  },
  "deletePositionedObject": {
    object (DeletePositionedObjectRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableCellStyle": {
    object (UpdateTableCellStyleRequest)
  },
  "updateTableRowStyle": {
    object (UpdateTableRowStyleRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateDocumentStyle": {
    object (UpdateDocumentStyleRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "createHeader": {
    object (CreateHeaderRequest)
  },
  "createFooter": {
    object (CreateFooterRequest)
  },
  "createFootnote": {
    object (CreateFootnoteRequest)
  },
  "replaceNamedRangeContent": {
    object (ReplaceNamedRangeContentRequest)
  },
  "updateSectionStyle": {
    object (UpdateSectionStyleRequest)
  },
  "insertSectionBreak": {
    object (InsertSectionBreakRequest)
  },
  "deleteHeader": {
    object (DeleteHeaderRequest)
  },
  "deleteFooter": {
    object (DeleteFooterRequest)
  },
  "pinTableHeaderRows": {
    object (PinTableHeaderRowsRequest)
  }
  // End of list of possible types for union field request.
}
Campi
Campo Union request. La richiesta specifica da applicare. È necessario specificare esattamente un campo. request può essere solo uno dei seguenti:
replaceAllText

object (ReplaceAllTextRequest)

Sostituisce tutte le istanze del testo specificato.

insertText

object (InsertTextRequest)

Inserisce il testo nella posizione specificata.

updateTextStyle

object (UpdateTextStyleRequest)

Aggiorna lo stile del testo nell'intervallo specificato.

createParagraphBullets

object (CreateParagraphBulletsRequest)

Crea elenchi puntati per i paragrafi.

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

Elimina i punti elenco dei paragrafi.

createNamedRange

object (CreateNamedRangeRequest)

Crea un intervallo denominato.

deleteNamedRange

object (DeleteNamedRangeRequest)

Elimina un intervallo denominato.

updateParagraphStyle

object (UpdateParagraphStyleRequest)

Aggiorna lo stile del paragrafo nell'intervallo specificato.

deleteContentRange

object (DeleteContentRangeRequest)

Elimina i contenuti dal documento.

insertInlineImage

object (InsertInlineImageRequest)

Inserisce un'immagine in linea nella posizione specificata.

insertTable

object (InsertTableRequest)

Inserisce una tabella nella posizione specificata.

insertTableRow

object (InsertTableRowRequest)

Inserisce una riga vuota in una tabella.

insertTableColumn

object (InsertTableColumnRequest)

Inserisce una colonna vuota in una tabella.

deleteTableRow

object (DeleteTableRowRequest)

Elimina una riga da una tabella.

deleteTableColumn

object (DeleteTableColumnRequest)

Elimina una colonna da una tabella.

insertPageBreak

object (InsertPageBreakRequest)

Consente di inserire un'interruzione di pagina nella posizione specificata.

deletePositionedObject

object (DeletePositionedObjectRequest)

Elimina un oggetto posizionato dal documento.

updateTableColumnProperties

object (UpdateTableColumnPropertiesRequest)

Aggiorna le proprietà delle colonne di una tabella.

updateTableCellStyle

object (UpdateTableCellStyleRequest)

Aggiorna lo stile delle celle della tabella.

updateTableRowStyle

object (UpdateTableRowStyleRequest)

Aggiorna lo stile di riga in una tabella.

replaceImage

object (ReplaceImageRequest)

Sostituisce un'immagine nel documento.

updateDocumentStyle

object (UpdateDocumentStyleRequest)

Aggiorna lo stile del documento.

mergeTableCells

object (MergeTableCellsRequest)

Unisce le celle di una tabella.

unmergeTableCells

object (UnmergeTableCellsRequest)

Divide le celle in una tabella.

createHeader

object (CreateHeaderRequest)

Crea un'intestazione.

createFootnote

object (CreateFootnoteRequest)

Crea una nota a piè di pagina.

replaceNamedRangeContent

object (ReplaceNamedRangeContentRequest)

Sostituisce i contenuti in un intervallo denominato.

updateSectionStyle

object (UpdateSectionStyleRequest)

Aggiorna lo stile della sezione dell'intervallo specificato.

insertSectionBreak

object (InsertSectionBreakRequest)

Consente di inserire un'interruzione di sezione nella posizione specificata.

deleteHeader

object (DeleteHeaderRequest)

Elimina un'intestazione dal documento.

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

Aggiorna il numero di righe di intestazione bloccate in una tabella.

SostituisciAllTextRequest

Sostituisce tutte le istanze di testo corrispondenti a un criterio con replace text.

Rappresentazione JSON
{
  "replaceText": string,

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

string

Il testo che sostituirà il testo corrispondente.

Campo Union criteria. I criteri utilizzati per abbinare il testo da sostituire. criteria può essere solo uno dei seguenti:
containsText

object (SubstringMatchCriteria)

Trova il testo nel documento corrispondente a questa sottostringa.

SubstringMatchCriteria

Un criterio che corrisponde a una stringa di testo specifica nel documento.

Rappresentazione JSON
{
  "text": string,
  "matchCase": boolean
}
Campi
text

string

Il testo da cercare nel documento.

matchCase

boolean

Indica se la ricerca deve rispettare il caso:

  • True : la ricerca è sensibile alle maiuscole.
  • False : la ricerca non distingue tra maiuscole e minuscole.

Inserisci testo richiesta

Inserisce il testo nella posizione specificata.

Rappresentazione JSON
{
  "text": string,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Campi
text

string

Il testo da inserire.

Se inserisci un carattere di nuova riga verrà creato implicitamente un nuovo Paragraph all'indice. Lo stile del nuovo paragrafo verrà copiato dal paragrafo all'indice di inserzione corrente, inclusi elenchi e punti elenco.

Gli stili di testo per il testo inserito verranno determinati automaticamente, mantenendo generalmente lo stile del testo adiacente. Nella maggior parte dei casi, lo stile del testo inserito corrisponde a quello indicato prima dell'indice di inserzione.

Alcuni caratteri di controllo (U+0000-U+0008, U+000C-U+001F) e i caratteri dell'area di uso privato del piano multilingue di base Unicode (U+E000-U+F8FF) verranno rimossi dal testo inserito.

Campo Union insertion_location. La posizione in cui verrà inserito il testo. insertion_location può essere solo uno dei seguenti:
location

object (Location)

Inserisce il testo in un indice specifico del documento.

Il testo deve essere inserito all'interno dei limiti di un elemento Paragraph esistente. Ad esempio, il testo non può essere inserito nell'indice iniziale di una tabella (ad es. tra la tabella e il paragrafo precedente). Il testo deve essere inserito nel paragrafo precedente.

endOfSegmentLocation

object (EndOfSegmentLocation)

Inserisce il testo alla fine di un'intestazione, un piè di pagina, una nota a piè di pagina o il corpo del documento.

Località

Una posizione specifica nel documento.

Rappresentazione JSON
{
  "segmentId": string,
  "index": integer
}
Campi
segmentId

string

L'ID dell'intestazione, del piè di pagina o della nota a piè di pagina in cui si trova la posizione. Un ID segmento vuoto indica il corpo del documento.

index

integer

L'indice in base zero, nelle unità di codice UTF-16.

L'indice è relativo all'inizio del segmento specificato da segmentId.

Località del segmento finale

Posizione alla fine di un corpo, intestazione, piè di pagina o nota a piè di pagina. La posizione è subito prima dell'ultima riga nel segmento del documento.

Rappresentazione JSON
{
  "segmentId": string
}
Campi
segmentId

string

L'ID dell'intestazione, del piè di pagina o della nota a piè di pagina in cui si trova la posizione. Un ID segmento vuoto indica il corpo del documento.

Richiesta aggiornamento stile testo

Aggiorna lo stile del testo.

Rappresentazione JSON
{
  "textStyle": {
    object (TextStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
Campi
textStyle

object (TextStyle)

Gli stili da impostare sul testo.

Se il valore di un determinato stile corrisponde a quello dell'elemento principale, questo stile verrà impostato per ereditare.

Alcune modifiche allo stile del testo potrebbero causare altre modifiche per rispecchiare il comportamento dell'editor di Documenti. Per saperne di più, consulta la documentazione di TextStyle.

fields

string (FieldMask format)

I campi che devono essere aggiornati.

Devi specificare almeno un campo. La radice textStyle è implicita e non deve essere specificata. Puoi utilizzare un singolo "*" per creare un elenco di tutti i campi.

Ad esempio, per aggiornare lo stile del testo in grassetto, imposta fields su "bold".

Per ripristinare il valore predefinito di una proprietà, includi il nome del campo nella maschera del campo, ma lascia il campo non impostato.

Campo Union insertion_location. Il tipo di intervallo utilizzato per l'aggiornamento dello stile del testo. insertion_location può essere solo uno dei seguenti:
range

object (Range)

La gamma di testo da applicare allo stile.

L'intervallo potrebbe essere esteso in modo da includere nuove righe adiacenti.

Se l'intervallo contiene completamente un paragrafo appartenente a un elenco, anche il punto elenco del paragrafo viene aggiornato con lo stile del testo corrispondente.

Non è possibile inserire intervalli all'interno di una richiesta UpdateTextStyleRequest.

CreazioneRichiesta di elenchi puntati

Crea elenchi puntati per tutti i paragrafi che si sovrappongono all'intervallo specificato.

Il livello di nidificazione di ogni paragrafo sarà determinato conteggiando le linguette iniziali davanti a ogni paragrafo. Per evitare spazi in eccesso tra il punto elenco e il paragrafo corrispondente, queste schede iniziali vengono rimosse da questa richiesta. Ciò potrebbe modificare gli indici di parti del testo.

Se il paragrafo subito prima dell'aggiornamento dei paragrafi si trova in un elenco con un valore preimpostato corrispondente, i paragrafi in fase di aggiornamento vengono aggiunti all'elenco precedente.

Rappresentazione JSON
{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
Campi
range

object (Range)

L'intervallo a cui applicare il punto elenco preimpostato.

bulletPreset

enum (BulletGlyphPreset)

I tipi di glifi del proiettile da utilizzare.

Preset BulletGlyph

Pattern preimpostati di glifi per gli elenchi.

Questi pattern utilizzano i seguenti tipi di punti elenco:

  • ARROW : una freccia, che corrisponde a un punto di codice Unicode U+2794
  • ARROW3D : una freccia con ombreggiatura 3D, corrispondente a un punto di codice Unicode U+27a2
  • CHECKBOX : un quadrato vuoto, corrispondente a un punto di codice Unicode U+274f
  • CIRCLE : Un cerchio vuoto, corrispondente a un punto di codice Unicode U+25cb
  • DIAMOND : Un diamante massiccio, corrispondente a un punto di codice Unicode U+25c6
  • DIAMONDX : Un rombo con una "x", che corrisponde a un punto di codice Unicode U+2756
  • HOLLOWDIAMOND : Un diamante cavo, corrispondente a un punto di codice Unicode U+25c7
  • DISC : un cerchio pieno, corrispondente a un punto di codice Unicode U+25cf
  • SQUARE : un quadrato pieno, corrispondente a un punto di codice Unicode U+25a0
  • STAR : una stella, corrispondente a un punto di codice Unicode U+2605
  • ALPHA : una lettera minuscola, ad esempio "a", "b" o "c".
  • UPPERALPHA : una lettera maiuscola, come "A", "B" o "C".
  • DECIMAL : un numero, ad esempio "1", "2" o "3".
  • ZERODECIMAL : un numero in cui i numeri a una cifra sono preceduti da uno zero, come '01', '02' o '03'. I numeri con più di una cifra non devono essere preceduti da zero.
  • ROMAN : un numero romano minuscolo, come "i", "ii" o "iii".
  • UPPERROMAN : un numero romano maiuscolo, come "I", "II" o "III".
  • LEFTTRIANGLE : un triangolo rivolto verso sinistra, corrispondente a un punto di codice Unicode U+25c4
Enum
BULLET_GLYPH_PRESET_UNSPECIFIED Il valore predefinito del glifo puntato non è specificato.
BULLET_DISC_CIRCLE_SQUARE Un elenco puntato con DISC, CIRCLE e SQUARE glifo con elenco puntato per i primi 3 livelli di annidamento dell'elenco.
BULLET_DIAMONDX_ARROW3D_SQUARE Un elenco puntato con DIAMONDX, ARROW3D e SQUARE glifo con elenco puntato per i primi 3 livelli di annidamento dell'elenco.
BULLET_CHECKBOX Un elenco puntato con CHECKBOX glifi del punto elenco per tutti i livelli di nidificazione.
BULLET_ARROW_DIAMOND_DISC Un elenco puntato con ARROW, DIAMOND e DISC glifo con elenco puntato per i primi 3 livelli di annidamento dell'elenco.
BULLET_STAR_CIRCLE_SQUARE Un elenco puntato con STAR, CIRCLE e SQUARE glifo con elenco puntato per i primi 3 livelli di annidamento dell'elenco.
BULLET_ARROW3D_CIRCLE_SQUARE Un elenco puntato con ARROW3D, CIRCLE e SQUARE glifo con elenco puntato per i primi 3 livelli di annidamento dell'elenco.
BULLET_LEFTTRIANGLE_DIAMOND_DISC Un elenco puntato con LEFTTRIANGLE, DIAMOND e DISC glifo con elenco puntato per i primi 3 livelli di annidamento dell'elenco.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE Un elenco puntato con DIAMONDX, HOLLOWDIAMOND e SQUARE glifo con elenco puntato per i primi 3 livelli di annidamento dell'elenco.
BULLET_DIAMOND_CIRCLE_SQUARE Un elenco puntato con DIAMOND, CIRCLE e SQUARE glifo con elenco puntato per i primi 3 livelli di annidamento dell'elenco.
NUMBERED_DECIMAL_ALPHA_ROMAN Un elenco numerato con DECIMAL, ALPHA e ROMAN glifi numerici per i primi 3 livelli di annidamento dell'elenco, seguiti da punti.
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS Un elenco numerato con DECIMAL, ALPHA e ROMAN glifi numerici per i primi 3 livelli di annidamento dell'elenco, seguiti da parentesi.
NUMBERED_DECIMAL_NESTED Un elenco numerato con DECIMAL glifi numerici separati da punti, in cui ogni livello di annidamento utilizza il prefisso del livello di nidificazione precedente. Ad esempio: "1.", "1.1.", "2.", "2.2."
NUMBERED_UPPERALPHA_ALPHA_ROMAN Un elenco numerato con UPPERALPHA, ALPHA e ROMAN glifi numerici per i primi 3 livelli di annidamento dell'elenco, seguiti da punti.
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL Un elenco numerato con UPPERROMAN, UPPERALPHA e DECIMAL glifi numerici per i primi 3 livelli di annidamento dell'elenco, seguiti da punti.
NUMBERED_ZERODECIMAL_ALPHA_ROMAN Un elenco numerato con ZERODECIMAL, ALPHA e ROMAN glifi numerici per i primi 3 livelli di annidamento dell'elenco, seguiti da punti.

EliminaParagraphBulletsRequest

Elimina i punti elenco di tutti i paragrafi che si sovrappongono all'intervallo specificato.

Il livello di nidificazione di ogni paragrafo verrà preservato visivamente aggiungendo un rientro all'inizio del paragrafo corrispondente.

Rappresentazione JSON
{
  "range": {
    object (Range)
  }
}
Campi
range

object (Range)

L'intervallo da cui eliminare i punti.

Crea richiesta con intervallo di nomi

Crea un NamedRange che fa riferimento all'intervallo specificato.

Rappresentazione JSON
{
  "name": string,
  "range": {
    object (Range)
  }
}
Campi
name

string

Il nome dell'oggetto NamedRange. Non è necessario che i nomi siano univoci.

I nomi devono contenere da 1 carattere a 256 caratteri in unità di codice UTF-16.

range

object (Range)

L'intervallo a cui applicare il nome.

EliminazioneRichiesta con nome gamma

Elimina un NamedRange.

Rappresentazione JSON
{

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "name": string
  // End of list of possible types for union field named_range_reference.
}
Campi
Campo Union named_range_reference. Il valore che determina quale intervallo o quali intervalli eliminare. Devi specificare un'unica opzione. named_range_reference può essere solo uno dei seguenti:
namedRangeId

string

L'ID dell'intervallo denominato da eliminare.

name

string

Il nome dell'intervallo o degli intervalli da eliminare. Tutti gli intervalli denominati con il nome specificato verranno eliminati.

Aggiornamento Paragrafo

Aggiorna lo stile di tutti i paragrafi che si sovrappongono all'intervallo specificato.

Rappresentazione JSON
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "fields": string,

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
Campi
paragraphStyle

object (ParagraphStyle)

Gli stili da impostare nei paragrafi.

Alcune modifiche allo stile del paragrafo possono causare altre modifiche per rispecchiare il comportamento dell'editor di Documenti. Per saperne di più, consulta la documentazione di ParagraphStyle.

fields

string (FieldMask format)

I campi che devono essere aggiornati.

Devi specificare almeno un campo. La radice paragraphStyle è implicita e non deve essere specificata. Puoi utilizzare un singolo "*" per creare un elenco di tutti i campi.

Ad esempio, per aggiornare la proprietà di allineamento dello stile del paragrafo, imposta fields su "alignment".

Per ripristinare il valore predefinito di una proprietà, includi il nome del campo nella maschera del campo, ma lascia il campo non impostato.

Campo Union insertion_location. Il tipo di intervallo utilizzato per l'aggiornamento dello stile del paragrafo. insertion_location può essere solo uno dei seguenti:
range

object (Range)

L'intervallo che sovrappone i paragrafi a uno stile.

Richiesta di eliminazione contenuti

Elimina i contenuti dal documento.

Rappresentazione JSON
{
  "range": {
    object (Range)
  }
}
Campi
range

object (Range)

L'intervallo di contenuti da eliminare.

L'eliminazione di testo che attraversa un confine di paragrafo può comportare modifiche agli stili, agli elenchi, agli oggetti posizionati e ai preferiti del paragrafo man mano che i due paragrafi vengono uniti.

Il tentativo di eliminare determinati intervalli può generare una struttura di documenti non valida, nel qual caso viene restituito un errore di richiesta 400 non valido.

Ecco alcuni esempi di richieste di eliminazione non valide:

Inserisci immagine in linea richiesta

Inserisce un InlineObject contenente un'immagine nella posizione specificata.

Rappresentazione JSON
{
  "uri": string,
  "objectSize": {
    object (Size)
  },

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Campi
uri

string

L'URI dell'immagine.

L'immagine viene recuperata una volta al momento dell'inserimento e una copia viene archiviata per essere visualizzata all'interno del documento. Le immagini devono avere dimensioni inferiori a 50 MB, non possono superare i 25 megapixel e devono essere in formato PNG, JPEG o GIF.

L'URI fornito deve essere accessibile pubblicamente e avere una lunghezza massima di 2 kB. L'URI stesso viene salvato con l'immagine ed esposto tramite il campo ImageProperties.content_uri.

objectSize

object (Size)

La dimensione con cui l'immagine dovrebbe apparire come nel documento. Questa proprietà è facoltativa e la dimensione finale dell'immagine nel documento è determinata dalle seguenti regole: * Se non viene specificata né larghezza né altezza, le dimensioni predefinite dell'immagine vengono calcolate in base alla sua risoluzione. * Se si specifica una dimensione, l'altra viene calcolata per mantenere le proporzioni dell'immagine. * Se sono specificati sia la larghezza che l'altezza, l'immagine viene adattata alle dimensioni fornite mantenendo le proporzioni.

Campo Union insertion_location. La posizione in cui verrà inserita l'immagine. insertion_location può essere solo uno dei seguenti:
location

object (Location)

Inserisce l'immagine in un indice specifico del documento.

L'immagine deve essere inserita all'interno dei limiti di un elemento Paragraph esistente. Ad esempio, non può essere inserito nell'indice iniziale di una tabella (ad es. tra la tabella e il paragrafo precedente).

Le immagini in linea non possono essere inserite in una nota a piè di pagina o in un'equazione.

endOfSegmentLocation

object (EndOfSegmentLocation)

Inserisce il testo alla fine di un'intestazione, un piè di pagina o il corpo del documento.

Le immagini in linea non possono essere inserite in una nota a piè di pagina.

Inserisci tabella

Inserisce una tabella nella posizione specificata.

Verrà inserito un carattere di nuova riga prima della tabella inserita.

Rappresentazione JSON
{
  "rows": integer,
  "columns": integer,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Campi
rows

integer

Il numero di righe nella tabella.

columns

integer

Il numero di colonne nella tabella.

Campo Union insertion_location. La posizione in cui verrà inserita la tabella. insertion_location può essere solo uno dei seguenti:
location

object (Location)

Inserisce la tabella in un indice del modello specifico.

Verrà inserito un carattere di nuova riga prima della tabella inserita, pertanto l'indice iniziale della tabella sarà all'indice di località specificato + 1.

La tabella deve essere inserita all'interno dei limiti di un elemento Paragraph esistente. Ad esempio, non può essere inserito nell'indice iniziale di una tabella (ad es. tra una tabella esistente e il paragrafo precedente).

Le tabelle non possono essere inserite in una nota a piè di pagina o in un'equazione.

endOfSegmentLocation

object (EndOfSegmentLocation)

Inserisce la tabella alla fine dell'intestazione, del piè di pagina o del corpo del documento specificato. Verrà inserito un carattere di nuova riga prima della tabella inserita.

Le tabelle non possono essere inserite in una nota a piè di pagina.

InserisciRigaTabella

Inserisce una riga vuota in una tabella.

Rappresentazione JSON
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}
Campi
tableCellLocation

object (TableCellLocation)

La posizione della cella della tabella di riferimento da cui verranno inserite le righe.

Verrà inserita una nuova riga sopra (o sotto) la riga in cui si trova la cella di riferimento. Se la cella di riferimento è una cella unita, verrà inserita una nuova riga sopra (o sotto) la cella unita.

insertBelow

boolean

Indica se inserire una nuova riga sotto la posizione della cella di riferimento.

  • True : inserisci sotto la cella.
  • False : inserisci sopra la cella.

Posizione tabella

Posizione di una singola cella all'interno di una tabella.

Rappresentazione JSON
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}
Campi
tableStartLocation

object (Location)

La posizione in cui la tabella inizia nel documento.

rowIndex

integer

L'indice della riga in base zero. Ad esempio, la seconda riga della tabella ha un indice di riga pari a 1.

columnIndex

integer

L'indice della colonna in base zero. Ad esempio, la seconda colonna nella tabella ha un indice di colonna pari a 1.

Inserisci tabella colonna richiesta

Inserisce una colonna vuota in una tabella.

Rappresentazione JSON
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}
Campi
tableCellLocation

object (TableCellLocation)

La posizione della cella della tabella di riferimento da cui verranno inserite le colonne.

Verrà inserita una nuova colonna a sinistra (o a destra) della colonna in cui si trova la cella di riferimento. Se la cella di riferimento è una cella unita, verrà inserita una nuova colonna a sinistra (o destra) della cella unita.

insertRight

boolean

Indica se inserire una nuova colonna a destra della posizione della cella di riferimento.

  • True : inserisci a destra.
  • False : inserisci a sinistra.

Elimina richiesta TableRow

Elimina una riga da una tabella.

Rappresentazione JSON
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
Campi
tableCellLocation

object (TableCellLocation)

La posizione della cella della tabella di riferimento da cui verrà eliminata la riga.

La riga attraversata da questa cella verrà eliminata. Se si tratta di una cella unita che si estende su più righe, tutte le righe inserite nella cella verranno eliminate. Se dopo questa eliminazione non rimangono righe nella tabella, viene eliminata l'intera tabella.

Elimina tabella colonna richiesta

Elimina una colonna da una tabella.

Rappresentazione JSON
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
Campi
tableCellLocation

object (TableCellLocation)

La posizione della cella della tabella di riferimento da cui verrà eliminata la colonna.

La colonna in cui si estende questa cella verrà eliminata. Se si tratta di una cella unita che si estende su più colonne, tutte le colonne presenti nella cella verranno eliminate. Se dopo questa eliminazione non rimangono colonne nella tabella, viene eliminata l'intera tabella.

Inserisci pagina interruzione richiesta

Consente di inserire un'interruzione di pagina seguita da una nuova riga nella posizione specificata.

Rappresentazione JSON
{

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Campi
Campo Union insertion_location. La posizione in cui verrà inserita l'interruzione di pagina. insertion_location può essere solo uno dei seguenti:
location

object (Location)

Inserisce l'interruzione di pagina in un indice specifico del documento.

L'interruzione di pagina deve essere inserita all'interno dei limiti di un elemento Paragraph esistente. Ad esempio, non può essere inserito nell'indice iniziale di una tabella (ad es. tra la tabella e il paragrafo precedente).

Le interruzioni di pagina non possono essere inserite in una tabella, un'equazione, una nota a piè di pagina, un'intestazione o un piè di pagina. Poiché è possibile inserire interruzioni di pagina solo all'interno del corpo, il campo segment ID deve essere vuoto.

endOfSegmentLocation

object (EndOfSegmentLocation)

Inserisce l'interruzione di pagina alla fine del corpo del documento.

Le interruzioni di pagina non possono essere inserite in una nota a piè di pagina, in un'intestazione o in un piè di pagina. Poiché è possibile inserire interruzioni di pagina solo all'interno del corpo, il campo segment ID deve essere vuoto.

EliminazioneRichiesta di posizione in oggetto

Elimina un elemento PositionedObject dal documento.

Rappresentazione JSON
{
  "objectId": string
}
Campi
objectId

string

L'ID dell'oggetto posizionato da eliminare.

Aggiornamento tabella colonna proprietà

Aggiorna il TableColumnProperties delle colonne in una tabella.

Rappresentazione JSON
{
  "tableStartLocation": {
    object (Location)
  },
  "columnIndices": [
    integer
  ],
  "tableColumnProperties": {
    object (TableColumnProperties)
  },
  "fields": string
}
Campi
tableStartLocation

object (Location)

La posizione in cui la tabella inizia nel documento.

columnIndices[]

integer

L'elenco degli indici di colonna in base zero la cui proprietà deve essere aggiornata. Se non vengono specificati indici, tutte le colonne verranno aggiornate.

tableColumnProperties

object (TableColumnProperties)

Le proprietà della colonna della tabella da aggiornare.

Se il valore di tableColumnProperties#width è inferiore a 5 punti (5/72 pollici), viene restituito un errore di richiesta 400 non valido.

fields

string (FieldMask format)

I campi che devono essere aggiornati.

Devi specificare almeno un campo. La radice tableColumnProperties è implicita e non deve essere specificata. Puoi utilizzare un singolo "*" per creare un elenco di tutti i campi.

Ad esempio, per aggiornare la larghezza della colonna, imposta il valore fields su "width".

Aggiornamento Richiesta di Stile CSS

Aggiorna lo stile di un intervallo di celle della tabella.

Rappresentazione JSON
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "fields": string,

  // Union field cells can be only one of the following:
  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
  // End of list of possible types for union field cells.
}
Campi
tableCellStyle

object (TableCellStyle)

Lo stile da impostare sulle celle della tabella.

Quando aggiorni i bordi, se una cella condivide un bordo con una cella adiacente, viene aggiornata anche la proprietà del bordo corrispondente della cella adiacente. I bordi uniti e invisibili non vengono aggiornati.

Poiché l'aggiornamento di un bordo condiviso da celle adiacenti nella stessa richiesta può causare aggiornamenti del confine in conflitto, gli aggiornamenti del confine vengono applicati nel seguente ordine:

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

I campi che devono essere aggiornati.

Devi specificare almeno un campo. La radice tableCellStyle è implicita e non deve essere specificata. Puoi utilizzare un singolo "*" per creare un elenco di tutti i campi.

Ad esempio, per aggiornare il colore di sfondo della cella della tabella, imposta fields su "backgroundColor".

Per ripristinare il valore predefinito di una proprietà, includi il nome del campo nella maschera del campo, ma lascia il campo non impostato.

Campo Union cells. Le celle che verranno aggiornate. cells può essere solo uno dei seguenti:
tableRange

object (TableRange)

L'intervallo della tabella che rappresenta il sottoinsieme della tabella a cui vengono applicati gli aggiornamenti.

tableStartLocation

object (Location)

La posizione in cui la tabella inizia nel documento. Se specificato, gli aggiornamenti vengono applicati a tutte le celle della tabella.

IntervalloTabella

Un intervallo di tabelle rappresenta un riferimento a un sottoinsieme di una tabella.

È importante notare che le celle specificate da un intervallo di tabella non formano necessariamente un rettangolo. Ad esempio, supponiamo di avere una tabella 3 x 3 in cui tutte le celle dell'ultima riga sono unite. La tabella ha il seguente aspetto:

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

Un intervallo di tabelle con posizione della cella della tabella = (tableStartLocation, riga = 0, colonna = 0), intervallo di riga = 3 e intervallo di colonna = 2 specifica le seguenti celle:

 [ x ][ x ][   ]
 [ x ][ x ][   ]
 [ x    x    x ]
Rappresentazione JSON
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
Campi
tableCellLocation

object (TableCellLocation)

La posizione della cella in cui inizia l'intervallo della tabella.

rowSpan

integer

L'intervallo di righe dell'intervallo della tabella.

columnSpan

integer

L'intervallo di colonne dell'intervallo della tabella.

Aggiornamento TableStyleStyleRequest

Aggiorna il TableRowStyle delle righe in una tabella.

Rappresentazione JSON
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndices": [
    integer
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "fields": string
}
Campi
tableStartLocation

object (Location)

La posizione in cui la tabella inizia nel documento.

rowIndices[]

integer

L'elenco degli indici di riga pari a zero il cui stile deve essere aggiornato. Se non vengono specificati indici, tutte le righe verranno aggiornate.

tableRowStyle

object (TableRowStyle)

Gli stili da impostare sulle righe.

fields

string (FieldMask format)

I campi che devono essere aggiornati.

Devi specificare almeno un campo. La radice tableRowStyle è implicita e non deve essere specificata. Puoi utilizzare un singolo "*" per creare un elenco di tutti i campi.

Ad esempio, per aggiornare l'altezza minima della riga, imposta fields su "minRowHeight".

SostituisciRichiesta immagine

Sostituisce un'immagine esistente con una nuova.

La sostituzione di un'immagine rimuove alcuni image effects dall'immagine esistente per rispecchiare il comportamento dell'editor di documenti.

Rappresentazione JSON
{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod)
}
Campi
imageObjectId

string

L'ID dell'immagine esistente che verrà sostituita. L'ID può essere recuperato dalla risposta di una richiesta get.

uri

string

L'URI della nuova immagine.

L'immagine viene recuperata una volta al momento dell'inserimento e una copia viene archiviata per essere visualizzata all'interno del documento. Le immagini devono essere inferiori a 50 MB, non possono superare i 25 megapixel e devono essere in formato PNG, JPEG o GIF.

L'URI fornito non può superare i 2 kB. L'URI viene salvato con l'immagine ed esposto tramite il campo ImageProperties.source_uri.

imageReplaceMethod

enum (ImageReplaceMethod)

Il metodo di sostituzione.

Metodo di sostituzione immagine

Il metodo di sostituzione dell'immagine.

Enum
IMAGE_REPLACE_METHOD_UNSPECIFIED Metodo di sostituzione dell'immagine non specificato. Questo valore non deve essere utilizzato.
CENTER_CROP Ridimensiona e centra l'immagine per riempire i bordi dell'immagine originale. L'immagine potrebbe essere ritagliata per riempire i bordi dell'immagine originale. Le dimensioni visualizzate dell'immagine saranno le stesse dell'immagine originale.

Aggiornamento stile documento richiesta

Aggiorna DocumentStyle.

Rappresentazione JSON
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string
}
Campi
documentStyle

object (DocumentStyle)

Gli stili da impostare sul documento.

Alcune modifiche allo stile del documento potrebbero causare altre modifiche per rispecchiare il comportamento dell'editor di Documenti. Per saperne di più, consulta la documentazione di DocumentStyle.

fields

string (FieldMask format)

I campi che devono essere aggiornati.

Devi specificare almeno un campo. La radice documentStyle è implicita e non deve essere specificata. Puoi utilizzare un singolo "*" per creare un elenco di tutti i campi.

Ad esempio, per aggiornare lo sfondo, imposta fields su "background".

Richiesta unione tabellaCells

Unisce le celle in una Table.

Rappresentazione JSON
{
  "tableRange": {
    object (TableRange)
  }
}
Campi
tableRange

object (TableRange)

L'intervallo della tabella che specifica quali celle della tabella unire.

Il testo delle celle che vengono unite verrà concatenato e archiviato nella cella "head" dell'intervallo. La cella in alto a sinistra dell'intervallo quando la direzione dei contenuti viene lasciata a destra e, in caso contrario, la cella in alto a destra dell'intervallo.

Se l'intervallo non è rettangolare (può verificarsi in alcuni casi in cui l'intervallo copre celle già unite o in cui la tabella non è rettangolare), viene restituito un errore di richiesta non valido 400.

Richiesta di unione di tabelle e celle

Divide le celle in una Table.

Rappresentazione JSON
{
  "tableRange": {
    object (TableRange)
  }
}
Campi
tableRange

object (TableRange)

L'intervallo della tabella che specifica le celle della tabella da dividere.

Tutte le celle unite in questo intervallo verranno unite e le celle già divise non saranno interessate. Se l'intervallo non ha celle unite, la richiesta non interviene.

Se è presente testo in una qualsiasi delle celle unite, il testo rimarrà nella cella "head" del blocco risultante di celle non unite. La cella "head" è la cella in alto a sinistra quando la direzione dei contenuti è da sinistra a destra e, in caso contrario, la cella in alto a destra.

Crea richiesta di intestazione

Crea un Header. La nuova intestazione viene applicata al SectionStyle nella posizione del SectionBreak se specificato, altrimenti viene applicata al DocumentStyle.

Se esiste già un'intestazione del tipo specificato, viene restituito un errore di richiesta non valido 400.

Rappresentazione JSON
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Campi
type

enum (HeaderFooterType)

Il tipo di intestazione da creare.

sectionBreakLocation

object (Location)

La posizione di SectionBreak che inizia con la sezione a cui deve appartenere questa intestazione. Se 'sectionBreakLocation' non è impostato o se fa riferimento alla prima interruzione di sezione del corpo del documento, l'intestazione si applica al DocumentStyle

TipoIntestazione piè di pagina

I tipi di intestazioni e piè di pagina che possono essere creati.

Enum
DEFAULT Un'intestazione/piè di pagina predefinito.

Crea richiesta di piè di pagina

Crea un Footer. Il nuovo piè di pagina viene applicato al SectionStyle nella posizione del SectionBreak se specificato, altrimenti viene applicato al DocumentStyle.

Se esiste già un piè di pagina del tipo specificato, viene restituito un errore di richiesta 400 non valido.

Rappresentazione JSON
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Campi
type

enum (HeaderFooterType)

Il tipo di piè di pagina da creare.

sectionBreakLocation

object (Location)

La posizione della SectionBreak immediatamente precedente alla sezione a cui deve appartenere questo SectionStyle piè di pagina. Se il documento non è impostato o si riferisce alla prima interruzione di sezione del documento, il piè di pagina si applica allo stile del documento.

Crea richiesta di nota a piè di pagina

Crea un segmento Footnote e vi aggiunge un nuovo FootnoteReference nella posizione specificata.

Il nuovo segmento Footnote conterrà uno spazio seguito da un carattere di nuova riga.

Rappresentazione JSON
{

  // Union field footnote_reference_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field footnote_reference_location.
}
Campi
Campo Union footnote_reference_location. La posizione in cui inserire il riferimento a piè di pagina. footnote_reference_location può essere solo uno dei seguenti:
location

object (Location)

Inserisce il riferimento della nota a piè di pagina in un indice specifico del documento.

Il riferimento a piè di pagina deve essere inserito all'interno dei limiti di un elemento Paragraph esistente. Ad esempio, non può essere inserito nell'indice iniziale di una tabella (ad es. tra la tabella e il paragrafo precedente).

I riferimenti a piè di pagina non possono essere inseriti in un'equazione, un'intestazione, un piè di pagina o una nota a piè di pagina. Poiché i riferimenti a piè di pagina possono essere inseriti solo nel corpo, il campo segment ID deve essere vuoto.

endOfSegmentLocation

object (EndOfSegmentLocation)

Inserisce il riferimento della nota a piè di pagina alla fine del corpo del documento.

I riferimenti a piè di pagina non possono essere inseriti in un'intestazione, un piè di pagina o una nota a piè di pagina. Poiché i riferimenti a piè di pagina possono essere inseriti solo nel corpo, il campo segment ID deve essere vuoto.

SostituzioneNameNameRangeContentRequest

Sostituisce i contenuti di NamedRange o di NamedRanges specificati con i contenuti sostitutivi specificati.

Tieni presente che un singolo NamedRange può essere costituito da più ranges discontinui. In questo caso, verranno sostituiti solo i contenuti nel primo intervallo. Gli altri intervalli e i relativi contenuti verranno eliminati.

Se la sostituzione o l'eliminazione di un intervallo causa una struttura del documento non valida, viene restituito un errore di richiesta 400 non valido.

Rappresentazione JSON
{

  // Union field replacement_content can be only one of the following:
  "text": string
  // End of list of possible types for union field replacement_content.

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "namedRangeName": string
  // End of list of possible types for union field named_range_reference.
}
Campi
Campo Union replacement_content. Il contenuto con cui sostituire il contenuto esistente dell'intervallo denominato. replacement_content può essere solo uno dei seguenti:
text

string

Sostituisce i contenuti degli intervalli denominati specificati con il testo specificato.

Campo Union named_range_reference. Un riferimento agli intervalli denominati di cui verranno sostituiti i contenuti. named_range_reference può essere solo uno dei seguenti:
namedRangeId

string

L'ID dell'intervallo denominato i cui contenuti verranno sostituiti.

Se non è presente alcun intervallo denominato con l'ID indicato, viene restituito un errore di richiesta non valido 400.

namedRangeName

string

Il nome del NamedRanges il cui contenuto verrà sostituito.

Se ci sono più named ranges con il nome specificato, i contenuti di ognuno verranno sostituiti. Se non ci sono intervalli denominati con il nome specificato, la richiesta sarà una soluzione indipendente.

Aggiornamento stile sezione richiesta

Aggiorna SectionStyle.

Rappresentazione JSON
{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}
Campi
range

object (Range)

L'intervallo che sovrappone le sezioni allo stile.

Poiché è possibile inserire interruzioni di sezione solo all'interno del corpo, il campo segment ID deve essere vuoto.

sectionStyle

object (SectionStyle)

Gli stili da impostare nella sezione.

Alcune modifiche allo stile della sezione potrebbero causare altre modifiche per rispecchiare il comportamento dell'editor di Documenti. Per saperne di più, consulta la documentazione di SectionStyle.

fields

string (FieldMask format)

I campi che devono essere aggiornati.

Devi specificare almeno un campo. La radice sectionStyle è implicita e non deve essere specificata. Puoi utilizzare un singolo "*" per creare un elenco di tutti i campi.

Ad esempio, per aggiornare il margine sinistro, imposta fields su "marginLeft".

Inserisci sezione interruzione richiesta

Consente di inserire un'interruzione di sezione nella posizione specificata.

Verrà inserito un carattere di nuova riga prima dell'interruzione di sezione.

Rappresentazione JSON
{
  "sectionType": enum (SectionType),

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Campi
sectionType

enum (SectionType)

Il tipo di sezione da inserire.

Campo Union insertion_location. La posizione in cui verrà inserita l'interruzione. insertion_location può essere solo uno dei seguenti:
location

object (Location)

Inserisce una nuova riga e un'interruzione di sezione a un indice specifico del documento.

L'interruzione di sezione deve essere inserita all'interno dei limiti di un elemento Paragraph esistente. Ad esempio, non può essere inserito nell'indice iniziale di una tabella (ad es. tra la tabella e il paragrafo precedente).

Le interruzioni di sezione non possono essere inserite in una tabella, un'equazione, una nota a piè di pagina, un'intestazione o un piè di pagina. Poiché è possibile inserire interruzioni di sezione solo all'interno del corpo, il campo segment ID deve essere vuoto.

endOfSegmentLocation

object (EndOfSegmentLocation)

Inserisce una nuova riga e un'interruzione di sezione alla fine del corpo del documento.

Le interruzioni di sezione non possono essere inserite in una nota a piè di pagina, in un'intestazione o in un piè di pagina. Poiché è possibile inserire interruzioni di sezione solo all'interno del corpo, il campo segment ID deve essere vuoto.

EliminazioneRichiesta di intestazione

Elimina un elemento Header dal documento.

Rappresentazione JSON
{
  "headerId": string
}
Campi
headerId

string

L'ID dell'intestazione da eliminare. Se l'intestazione è definita in data DocumentStyle, il riferimento a questa intestazione viene rimosso e non viene effettuata alcuna intestazione di quel tipo per la prima sezione del documento. Se è stata definita in un SectionStyle, il riferimento a questa intestazione viene rimosso e l'intestazione di quel tipo è continua nella sezione precedente.

Elimina piè di pagina

Elimina un elemento Footer dal documento.

Rappresentazione JSON
{
  "footerId": string
}
Campi
footerId

string

L'ID del piè di pagina da eliminare. Se questo piè di pagina è definito su DocumentStyle, il riferimento a questo piè di pagina viene rimosso, pertanto il piè di pagina non è del tipo indicato per la prima sezione del documento. Se questo piè di pagina è definito in un SectionStyle, il riferimento a questo piè di pagina viene rimosso e il piè di pagina di quel tipo viene continuato dalla sezione precedente.

Richiesta (intestazione tabella)

Aggiorna il numero di righe di intestazione della tabella bloccate in una tabella.

Rappresentazione JSON
{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}
Campi
tableStartLocation

object (Location)

La posizione in cui la tabella inizia nel documento.

pinnedHeaderRowsCount

integer

Il numero di righe della tabella da fissare, dove 0 implica che tutte le righe siano sbloccate.