Requests

Richiesta

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 unione request. La richiesta specifica da applicare. È richiesto esattamente un campo. request può essere solo uno dei seguenti:
replaceAllText

object (ReplaceAllTextRequest)

Sostituisce tutte le istanze del testo specificato.

insertText

object (InsertTextRequest)

Consente di inserire del testo nella posizione specificata.

updateTextStyle

object (UpdateTextStyleRequest)

Aggiorna lo stile di testo nell'intervallo specificato.

createParagraphBullets

object (CreateParagraphBulletsRequest)

Crea elenchi puntati per i paragrafi.

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

Consente di eliminare i numeri dall'elenco puntato nei paragrafi.

createNamedRange

object (CreateNamedRangeRequest)

Crea un intervallo denominato.

deleteNamedRange

object (DeleteNamedRangeRequest)

Consente di eliminare un intervallo denominato.

updateParagraphStyle

object (UpdateParagraphStyleRequest)

Aggiorna lo stile di paragrafo nell'intervallo specificato.

deleteContentRange

object (DeleteContentRangeRequest)

Consente di eliminare 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)

Consente di eliminare una riga da una tabella.

deleteTableColumn

object (DeleteTableColumnRequest)

Consente di eliminare una colonna da una tabella.

insertPageBreak

object (InsertPageBreakRequest)

Inserisce un a capo nella posizione specificata.

deletePositionedObject

object (DeletePositionedObjectRequest)

Consente di eliminare 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)

Separa le celle di 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)

Inserisce un'interruzione di sezione nella posizione specificata.

deleteHeader

object (DeleteHeaderRequest)

Consente di eliminare un'intestazione dal documento.

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

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

ReplaceAllTextRequest

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

Rappresentazione JSON
{
  "replaceText": string,
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // 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.

tabsCriteria

object (TabsCriteria)

Facoltativo. I criteri utilizzati per specificare in quali schede avviene la sostituzione.

Se omesso, la sostituzione si applica a tutte le schede.

In un documento contenente una singola scheda:

  • Se specificato, deve corrispondere all'ID della scheda singola.

  • Se omesso, la sostituzione si applica alla scheda singola.

In un documento contenente più schede:

  • Se specificato, la sostituzione si applica alle schede specificate.

  • Se omesso, la sostituzione si applica a tutte le schede.

Campo unione criteria. I criteri utilizzati per trovare una corrispondenza con il testo da sostituire. criteria può essere solo uno dei seguenti:
containsText

object (SubstringMatchCriteria)

Trova nel documento il testo 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 la maiuscola:

  • True : la ricerca è sensibile alle maiuscole.
  • False : la ricerca non è sensibile alle maiuscole.

TabsCriteria

Un criterio che specifica in quali schede viene eseguita una richiesta.

Rappresentazione JSON
{
  "tabIds": [
    string
  ]
}
Campi
tabIds[]

string

L'elenco degli ID scheda in cui viene eseguita la richiesta.

InsertTextRequest

Consente di inserire del 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.

L'inserimento di un carattere di nuova riga creerà implicitamente un nuovo Paragraph in quell'indice. Lo stile del paragrafo del nuovo paragrafo verrà copiato dal paragrafo nell'indice di inserimento corrente, inclusi elenchi e elenchi puntati.

Gli stili di testo per il testo inserito verranno determinati automaticamente, generalmente mantenendo gli stili del testo adiacente. Nella maggior parte dei casi, lo stile del testo inserito corrisponderà al testo immediatamente precedente all'indice di inserimento.

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 unione 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 Paragraph esistente. Ad esempio, non è possibile inserire del testo nell'indice di inizio di una tabella (ovvero 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, di un piè di pagina, di una nota a piè di pagina o del corpo del documento.

Località

Una determinata posizione nel documento.

Rappresentazione JSON
{
  "segmentId": string,
  "index": integer,
  "tabId": 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.

index

integer

L'indice a partire da zero, in unità di codice UTF-16.

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

tabId

string

La scheda in cui si trova la stazione di ricarica. Se omessa, la richiesta viene applicata alla prima scheda.

In un documento contenente una singola scheda:

  • Se specificato, deve corrispondere all'ID della scheda singola.

  • Se omesso, la richiesta si applica alla scheda singola.

In un documento contenente più schede:

  • Se specificato, la richiesta si applica alla scheda specificata.

  • Se omesso, la richiesta si applica alla prima scheda del documento.

EndOfSegmentLocation

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

Rappresentazione JSON
{
  "segmentId": string,
  "tabId": 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.

tabId

string

La scheda in cui si trova la stazione di ricarica. Se omessa, la richiesta viene applicata alla prima scheda.

In un documento contenente una singola scheda:

  • Se specificato, deve corrispondere all'ID della scheda singola.

  • Se omesso, la richiesta si applica alla scheda singola.

In un documento contenente più schede:

  • Se specificato, la richiesta si applica alla scheda specificata.

  • Se omesso, la richiesta si applica alla prima scheda del documento.

UpdateTextStyleRequest

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 uno stile specifico corrisponde a quello del relativo stile principale, lo stile verrà impostato come ereditato.

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

fields

string (FieldMask format)

I campi che devono essere aggiornati.

È necessario specificare almeno un campo. La radice textStyle è implicita e non deve essere specificata. Un singolo "*" può essere utilizzato come scorciatoia per elencare tutti i campi.

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

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

Campo unione insertion_location. Il tipo di intervallo utilizzato in cui verrà aggiornato lo stile di testo. insertion_location può essere solo uno dei seguenti:
range

object (Range)

L'intervallo di testo a cui applicare lo stile.

L'intervallo può essere esteso in modo da includere le 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 di testo corrispondente.

Gli intervalli non possono essere inseriti in un UpdateTextStyleRequest relativo.

CreateParagraphBulletsRequest

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

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

Se il paragrafo immediatamente precedente a quelli in fase di aggiornamento è in un elenco con una preimpostazione 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 valore preimpostato per i punti elenco.

bulletPreset

enum (BulletGlyphPreset)

I tipi di glifi di elenchi puntati da utilizzare.

BulletGlyphPreset

Pattern preimpostati di glifi di elenchi puntati.

Questi pattern utilizzano i seguenti tipi di elenchi puntati:

  • ARROW : una freccia, corrispondente 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 rombo pieno, corrispondente a un punto di codice Unicode U+25c6
  • DIAMONDX : un diamante con una "x", corrispondente a un punto di codice Unicode U+2756
  • HOLLOWDIAMOND : un rombo vuoto, 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, ad esempio "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, ad esempio "01", "02" o "03". I numeri con più di una cifra non hanno un prefisso zero.
  • ROMAN : un numero romano minuscolo, ad esempio "i", "ii" o "iii".
  • UPPERROMAN : un numero romano maiuscolo, ad esempio "I", "II" o "III".
  • LEFTTRIANGLE : un triangolo rivolto verso sinistra, corrispondente a un punto di codice Unicode U+25c4
Enum
BULLET_GLYPH_PRESET_UNSPECIFIED L'impostazione predefinita del glifo di elenco non è specificata.
BULLET_DISC_CIRCLE_SQUARE Un elenco puntato con gli indicatori di elenco DISC, CIRCLE e SQUARE per i primi 3 livelli di annidamento dell'elenco.
BULLET_DIAMONDX_ARROW3D_SQUARE Un elenco puntato con gli indicatori di elenco DIAMONDX, ARROW3D e SQUARE per i primi 3 livelli di annidamento dell'elenco.
BULLET_CHECKBOX Un elenco puntato con glifos di punti elenco CHECKBOX per tutti i livelli di nidificazione dell'elenco.
BULLET_ARROW_DIAMOND_DISC Un elenco puntato con gli indicatori di elenco ARROW, DIAMOND e DISC per i primi 3 livelli di annidamento dell'elenco.
BULLET_STAR_CIRCLE_SQUARE Un elenco puntato con gli indicatori di elenco STAR, CIRCLE e SQUARE per i primi 3 livelli di annidamento dell'elenco.
BULLET_ARROW3D_CIRCLE_SQUARE Un elenco puntato con gli indicatori di elenco ARROW3D, CIRCLE e SQUARE per i primi 3 livelli di annidamento dell'elenco.
BULLET_LEFTTRIANGLE_DIAMOND_DISC Un elenco puntato con gli indicatori di elenco LEFTTRIANGLE, DIAMOND e DISC per i primi 3 livelli di annidamento dell'elenco.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE Un elenco puntato con gli indicatori di elenco DIAMONDX, HOLLOWDIAMOND e SQUARE per i primi 3 livelli di annidamento dell'elenco.
BULLET_DIAMOND_CIRCLE_SQUARE Un elenco puntato con gli indicatori di elenco DIAMOND, CIRCLE e SQUARE per i primi 3 livelli di annidamento dell'elenco.
NUMBERED_DECIMAL_ALPHA_ROMAN Un elenco numerato con gli glifi numerici DECIMAL, ALPHA e ROMAN per i primi 3 livelli di nidificazione dell'elenco, seguiti da punti.
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS Un elenco numerato con gli glifi numerici DECIMAL, ALPHA e ROMAN per i primi 3 livelli di annidamento dell'elenco, seguiti da parentesi.
NUMBERED_DECIMAL_NESTED Un elenco numerato con glifos numerici DECIMAL separati da punti, in cui ogni livello di nidificazione utilizza il glifo del livello di nidificazione precedente come prefisso. Ad esempio: "1.", '1.1.', '2.', '2.2.'.
NUMBERED_UPPERALPHA_ALPHA_ROMAN Un elenco numerato con gli glifi numerici UPPERALPHA, ALPHA e ROMAN per i primi 3 livelli di nidificazione dell'elenco, seguiti da punti.
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL Un elenco numerato con gli glifi numerici UPPERROMAN, UPPERALPHA e DECIMAL per i primi 3 livelli di nidificazione dell'elenco, seguiti da punti.
NUMBERED_ZERODECIMAL_ALPHA_ROMAN Un elenco numerato con gli glifi numerici ZERODECIMAL, ALPHA e ROMAN per i primi 3 livelli di nidificazione dell'elenco, seguiti da punti.

DeleteParagraphBulletsRequest

Consente di eliminare i numeri da tutti i paragrafi che si sovrappongono all'intervallo specificato.

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

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

object (Range)

L'intervallo da cui eliminare i numeri.

CreateNamedRangeRequest

Crea un NamedRange che fa riferimento all'intervallo specificato.

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

string

Il nome dell'intervallo denominato. I nomi non devono essere univoci.

I nomi devono contenere almeno 1 carattere e non più di 256 caratteri, misurati in unità di codice UTF-16.

range

object (Range)

L'intervallo a cui applicare il nome.

DeleteNamedRangeRequest

Consente di eliminare un NamedRange.

Rappresentazione JSON
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // 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
tabsCriteria

object (TabsCriteria)

Facoltativo. I criteri utilizzati per specificare in quali schede deve avvenire l'eliminazione dell'intervallo. Se omesso, l'eliminazione dell'intervallo viene applicata a tutte le schede.

In un documento contenente una singola scheda:

  • Se specificato, deve corrispondere all'ID della scheda singola.

  • Se omesso, l'eliminazione dell'intervallo si applica alla scheda singola.

In un documento contenente più schede:

  • Se specificato, l'eliminazione dell'intervallo si applica alle schede specificate.

  • Se non viene fornito, l'eliminazione dell'intervallo si applica a tutte le schede.

Campo unione named_range_reference. Il valore che determina gli intervalli da eliminare. È necessario impostarne esattamente uno. named_range_reference può essere solo uno dei seguenti:
namedRangeId

string

L'ID dell'intervallo denominato da eliminare.

name

string

Il nome degli intervalli da eliminare. Tutti gli intervalli denominati con il nome specificato verranno eliminati.

UpdateParagraphStyleRequest

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 sui paragrafi.

Alcune modifiche allo stile di paragrafo potrebbero causare altre modifiche per rispecchiare il comportamento dell'editor di Documenti. Per ulteriori informazioni, consulta la documentazione di ParagraphStyle.

fields

string (FieldMask format)

I campi che devono essere aggiornati.

È necessario specificare almeno un campo. La radice paragraphStyle è implicita e non deve essere specificata. Un singolo "*" può essere utilizzato come scorciatoia per elencare tutti i campi.

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

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

Campo unione insertion_location. Il tipo di intervallo utilizzato in cui verrà aggiornato lo stile di paragrafo. insertion_location può essere solo uno dei seguenti:
range

object (Range)

L'intervallo che si sovrappone ai paragrafi da stilare.

DeleteContentRangeRequest

Consente di eliminare 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 il confine di un paragrafo può comportare modifiche agli stili di paragrafo, agli elenchi, agli oggetti posizionati e ai segnalibri durante l'unione dei due paragrafi.

Il tentativo di eliminare determinati intervalli può comportare una struttura del documento non valida, nel qual caso viene restituito un errore di richiesta non valida (400).

Ecco alcuni esempi di richieste di eliminazione non valide:

  • Eliminazione di un'unità di codice di una coppia sostitutiva.
  • Eliminazione dell'ultimo carattere di a capo di un Body, Header, Footer, Footnote, TableCell o TableOfContents.
  • Eliminazione dell'inizio o della fine di un Table, TableOfContents o Equation senza eliminare l'intero elemento.
  • Eliminare il carattere di a capo prima di un carattere Table, TableOfContents o SectionBreak senza eliminare l'elemento.
  • Eliminazione di singole righe o celle di una tabella. L'eliminazione dei contenuti all'interno di una cella di tabella è consentita.

InsertInlineImageRequest

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 la visualizzazione all'interno del documento. Le immagini devono avere dimensioni inferiori a 50 MB, non possono superare i 25 megapixel e devono essere in uno dei formati 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 ImageProperties.content_uri campo.

objectSize

object (Size)

Le dimensioni in cui l'immagine deve essere visualizzata nel documento. Questa proprietà è facoltativa e le dimensioni finali dell'immagine nel documento sono determinate dalle seguenti regole: * Se non vengono specificate né larghezza né altezza, viene calcolata una dimensione predefinita dell'immagine in base alla sua risoluzione. * Se viene specificata una dimensione, l'altra viene calcolata per preservare le proporzioni dell'immagine. * Se vengono specificate sia la larghezza che l'altezza, l'immagine viene ridimensionata in base alle dimensioni fornite mantenendo le proporzioni.

Campo unione 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 Paragraph esistente. Ad esempio, non può essere inserito nell'indice di inizio di una tabella (ovvero tra la tabella e il paragrafo precedente).

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

InsertTableRequest

Inserisce una tabella nella posizione specificata.

Prima della tabella inserita verrà inserito un carattere di nuova riga.

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 unione 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 modello specifico.

Prima della tabella inserita verrà inserito un carattere di a capo, pertanto l'indice di inizio della tabella sarà pari all'indice di posizione specificato + 1.

La tabella deve essere inserita nei limiti di un Paragraph esistente. Ad esempio, non può essere inserito nell'indice di inizio di una tabella (ovvero 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. Prima della tabella inserita verrà inserito un carattere di nuova riga.

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

InsertTableRowRequest

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.

Viene 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, viene 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.

TableCellLocation

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 inizia la tabella nel documento.

rowIndex

integer

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

columnIndex

integer

L'indice della colonna a partire da zero. Ad esempio, la seconda colonna della tabella ha un indice colonna pari a 1.

InsertTableColumnRequest

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.

Una nuova colonna verrà inserita 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 a destra) della cella unita.

insertRight

boolean

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

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

DeleteTableRowRequest

Consente di eliminare 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 interessata da questa cella verrà eliminata. Se si tratta di una cella unita che si estende su più righe, tutte le righe interessate dalla cella verranno eliminate. Se dopo questa eliminazione non rimangono righe nella tabella, l'intera tabella viene eliminata.

DeleteTableColumnRequest

Consente di eliminare 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 che occupa questa cella verrà eliminata. Se si tratta di una cella unita che si estende su più colonne, verranno eliminate tutte le colonne interessate. Se dopo questa eliminazione non rimangono colonne nella tabella, l'intera tabella viene eliminata.

InsertPageBreakRequest

Inserisce un'interruzione di pagina seguita da un a capo 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 unione 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 Paragraph esistente. Ad esempio, non può essere inserito nell'indice di inizio di una tabella (ovvero tra la tabella e il paragrafo precedente).

Le interruzioni di pagina non possono essere inserite all'interno di una tabella, di un'equazione, di una nota a piè di pagina, di un'intestazione o di un piè di pagina. Poiché le interruzioni di pagina possono essere inserite 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 all'interno di una nota a piè di pagina, di un'intestazione o di un piè di pagina. Poiché le interruzioni di pagina possono essere inserite solo all'interno del corpo, il segment ID campo deve essere vuoto.

DeletePositionedObjectRequest

Elimina un PositionedObject dal documento.

Rappresentazione JSON
{
  "objectId": string,
  "tabId": string
}
Campi
objectId

string

L'ID dell'oggetto posizionato da eliminare.

tabId

string

La scheda in cui si trova l'oggetto posizionato da eliminare. Se omessa, la richiesta viene applicata alla prima scheda.

In un documento contenente una singola scheda:

  • Se specificato, deve corrispondere all'ID della scheda singola.

  • Se omesso, la richiesta si applica alla scheda singola.

In un documento contenente più schede:

  • Se specificato, la richiesta si applica alla scheda specificata.

  • Se omesso, la richiesta si applica alla prima scheda del documento.

UpdateTableColumnPropertiesRequest

Aggiorna il valore TableColumnProperties delle colonne di una tabella.

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

object (Location)

La posizione in cui inizia la tabella nel documento.

columnIndices[]

integer

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

tableColumnProperties

object (TableColumnProperties)

Le proprietà delle colonne della tabella da aggiornare.

Se il valore di tableColumnProperties#width è inferiore a 5 punti, viene restituito un errore 400 di richiesta non valida.

fields

string (FieldMask format)

I campi che devono essere aggiornati.

È necessario specificare almeno un campo. La radice tableColumnProperties è implicita e non deve essere specificata. Un singolo "*" può essere utilizzato come scorciatoia per elencare tutti i campi.

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

UpdateTableCellStyleRequest

Aggiorna lo stile di un intervallo di celle di una 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 in conflitto, gli aggiornamenti dei bordi vengono applicati nel seguente ordine:

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

I campi che devono essere aggiornati.

È necessario specificare almeno un campo. La radice tableCellStyle è implicita e non deve essere specificata. Un singolo "*" può essere utilizzato come scorciatoia per elencare tutti i campi.

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

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

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

object (TableRange)

L'intervallo di tabelle che rappresenta il sottoinsieme di tabelle a cui vengono applicati gli aggiornamenti.

tableStartLocation

object (Location)

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

TableRange

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

È importante notare che le celle specificate da un intervallo di tabelle 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 righe = 3 e intervallo di colonne = 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.

UpdateTableRowStyleRequest

Aggiorna il valore 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 inizia la tabella nel documento.

rowIndices[]

integer

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

tableRowStyle

object (TableRowStyle)

Gli stili da impostare sulle righe.

fields

string (FieldMask format)

I campi che devono essere aggiornati.

È necessario specificare almeno un campo. La radice tableRowStyle è implicita e non deve essere specificata. Un singolo "*" può essere utilizzato come scorciatoia per elencare tutti i campi.

Ad esempio, per aggiornare l'altezza minima delle righe, imposta fields su "minRowHeight".

ReplaceImageRequest

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),
  "tabId": string
}
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 la visualizzazione 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 non può superare i 2 KB di lunghezza. L'URI viene salvato con l'immagine ed esposto tramite il campo ImageProperties.source_uri.

imageReplaceMethod

enum (ImageReplaceMethod)

Il metodo di sostituzione.

tabId

string

La scheda in cui si trova l'immagine da sostituire. Se omessa, la richiesta viene applicata alla prima scheda.

In un documento contenente una singola scheda:

  • Se specificato, deve corrispondere all'ID della scheda singola.

  • Se omesso, la richiesta si applica alla scheda singola.

In un documento contenente più schede:

  • Se specificato, la richiesta si applica alla scheda specificata.

  • Se omesso, la richiesta si applica alla prima scheda del documento.

ImageReplaceMethod

Il metodo di sostituzione dell'immagine.

Enum
IMAGE_REPLACE_METHOD_UNSPECIFIED Metodo di sostituzione delle immagini non specificato. Questo valore non deve essere utilizzato.
CENTER_CROP Scala e centra l'immagine in modo che riempia i limiti dell'immagine originale. L'immagine potrebbe essere ritagliata per riempire i limiti dell'immagine originale. Le dimensioni dell'immagine visualizzata saranno le stesse dell'immagine originale.

UpdateDocumentStyleRequest

Aggiorna DocumentStyle.

Rappresentazione JSON
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string,
  "tabId": 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 ulteriori informazioni, consulta la documentazione di DocumentStyle.

fields

string (FieldMask format)

I campi che devono essere aggiornati.

È necessario specificare almeno un campo. La radice documentStyle è implicita e non deve essere specificata. Un singolo "*" può essere utilizzato come scorciatoia per elencare tutti i campi.

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

tabId

string

La scheda contenente lo stile da aggiornare. Se omesso, la richiesta si applica alla prima scheda.

In un documento contenente una singola scheda:

  • Se specificato, deve corrispondere all'ID della scheda singola.

  • Se omesso, la richiesta si applica alla scheda singola.

In un documento contenente più schede:

  • Se specificato, la richiesta si applica alla scheda specificata.

  • Se non viene fornito, la richiesta si applica alla prima scheda del documento.

MergeTableCellsRequest

Unisce le celle di un Table.

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

object (TableRange)

L'intervallo di tabelle che specifica le celle della tabella da unire.

Qualsiasi testo nelle celle unite verrà concatenato e archiviato nella cella "testa" dell'intervallo. Si tratta della cella in alto a sinistra dell'intervallo quando la direzione dei contenuti è da sinistra a destra e della cella in alto a destra dell'intervallo in caso contrario.

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

UnmergeTableCellsRequest

Divide le celle in un Table.

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

object (TableRange)

L'intervallo di tabelle che specifica le celle della tabella da annullare l'unione.

Tutte le celle unite in questo intervallo verranno separate e le celle già separate non saranno interessate. Se l'intervallo non contiene celle unite, la richiesta non avrà alcun effetto.

Se è presente del testo in una delle celle unite, il testo rimarrà nella cella "testa" 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 alto a destra in caso contrario.

CreateHeaderRequest

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 valida (400).

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

enum (HeaderFooterType)

Il tipo di intestazione da creare.

sectionBreakLocation

object (Location)

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

HeaderFooterType

I tipi di intestazioni e piè di pagina che è possibile creare.

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

CreateFooterRequest

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 non valida (400).

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 del SectionBreak immediatamente precedente la sezione a cui appartiene SectionStyle questo piè di pagina. Se non è impostato o si riferisce alla prima interruzione di sezione del documento, il piè di pagina si applica allo stile del documento.

CreateFootnoteRequest

Crea un segmento Footnote e inserisce 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 unione footnote_reference_location. La posizione in cui inserire il riferimento alla nota 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 nota a piè di pagina deve essere inserito all'interno dei limiti di un Paragraph esistente. Ad esempio, non può essere inserito nell'indice di inizio di una tabella (ovvero tra la tabella e il paragrafo precedente).

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

endOfSegmentLocation

object (EndOfSegmentLocation)

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

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

ReplaceNamedRangeContentRequest

Sostituisce i contenuti del NamedRange o NamedRanges specificato con i contenuti di sostituzione specificati.

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

Se la sostituzione o l'eliminazione di intervalli determina una struttura del documento non valida, viene restituito un errore di richiesta non valida (400).

Rappresentazione JSON
{
  "tabsCriteria": {
    object (TabsCriteria)
  },

  // 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
tabsCriteria

object (TabsCriteria)

Facoltativo. I criteri utilizzati per specificare in quali schede avviene la sostituzione. Se omesso, la sostituzione si applica a tutte le schede.

In un documento contenente una singola scheda:

  • Se specificato, deve corrispondere all'ID della scheda singola.

  • Se omesso, la sostituzione si applica alla scheda singola.

In un documento contenente più schede:

  • Se specificato, la sostituzione si applica alle schede specificate.

  • Se omesso, la sostituzione si applica a tutte le schede.

Campo unione replacement_content. I contenuti con cui sostituire i contenuti esistenti 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 unione 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 di cui verranno sostituiti i contenuti.

Se non esiste un intervallo denominato con l'ID specificato, viene restituito un errore di richiesta non valida (400).

namedRangeName

string

Il nome del NamedRanges di cui verranno sostituiti i contenuti.

Se sono presenti più named ranges con il nome specificato, i contenuti di ciascuno verranno sostituiti. Se non esistono intervalli denominati con il nome specificato, la richiesta non avrà alcun effetto.

UpdateSectionStyleRequest

Aggiorna SectionStyle.

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

object (Range)

L'intervallo che si sovrappone alle sezioni da stilare.

Poiché le interruzioni di sezione possono essere inserite 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 ulteriori informazioni, consulta la documentazione di SectionStyle.

fields

string (FieldMask format)

I campi che devono essere aggiornati.

È necessario specificare almeno un campo. La radice sectionStyle è implicita e non deve essere specificata. Un singolo "*" può essere utilizzato come scorciatoia per elencare tutti i campi.

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

InsertSectionBreakRequest

Inserisce un'interruzione di sezione nella posizione specificata.

Prima dell'interruzione di sezione verrà inserito un carattere di a capo.

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 unione insertion_location. La posizione in cui verrà inserita l'interruzione. insertion_location può essere solo uno dei seguenti:
location

object (Location)

Inserisce un a capo e un'interruzione di sezione in un indice specifico del documento.

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

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

endOfSegmentLocation

object (EndOfSegmentLocation)

Inserisce una nuova riga e un a capo di sezione alla fine del corpo del documento.

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

DeleteHeaderRequest

Elimina un Header dal documento.

Rappresentazione JSON
{
  "headerId": string,
  "tabId": string
}
Campi
headerId

string

L'ID dell'intestazione da eliminare. Se questa intestazione è definita su DocumentStyle, il riferimento a questa intestazione viene rimosso, pertanto non viene visualizzata alcuna intestazione di questo tipo per la prima sezione del documento. Se questa intestazione è definita in un SectionStyle, il riferimento a questa intestazione viene rimosso e l'intestazione di questo tipo viene ora continuata dalla sezione precedente.

tabId

string

La scheda contenente l'intestazione da eliminare. Se omessa, la richiesta viene applicata alla prima scheda.

In un documento contenente una singola scheda:

  • Se specificato, deve corrispondere all'ID della scheda singola.

  • Se omesso, la richiesta si applica alla scheda singola.

In un documento contenente più schede:

  • Se specificato, la richiesta si applica alla scheda specificata.

  • Se omesso, la richiesta si applica alla prima scheda del documento.

DeleteFooterRequest

Elimina un Footer dal documento.

Rappresentazione JSON
{
  "footerId": string,
  "tabId": 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 non verrà visualizzato alcun piè di pagina di questo tipo 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 questo tipo viene continuato dalla sezione precedente.

tabId

string

La scheda che contiene il piè di pagina da eliminare. Se omessa, la richiesta viene applicata alla prima scheda.

In un documento contenente una singola scheda:

  • Se specificato, deve corrispondere all'ID della scheda singola.

  • Se omesso, la richiesta si applica alla scheda singola.

In un documento contenente più schede:

  • Se specificato, la richiesta si applica alla scheda specificata.

  • Se omesso, la richiesta si applica alla prima scheda del documento.

PinTableHeaderRowsRequest

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 inizia la tabella nel documento.

pinnedHeaderRowsCount

integer

Il numero di righe di tabella da bloccare, dove 0 implica che tutte le righe non sono bloccate.