Requests

Żądanie

pojedyncza aktualizacja dokumentu,

Zapis 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.
}
Pola
Pole uniirequest. konkretne żądanie, którego dotyczy zmiana; Wymagane jest dokładnie 1 pole. requestmoże być tylko jedną z tych wartości:
replaceAllText

object (ReplaceAllTextRequest)

Zastępuje wszystkie wystąpienia określonego tekstu.

insertText

object (InsertTextRequest)

Wstawia tekst w określonym miejscu.

updateTextStyle

object (UpdateTextStyleRequest)

Zmienia styl tekstu w określonym zakresie.

createParagraphBullets

object (CreateParagraphBulletsRequest)

Tworzy punkty dla akapitów.

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

usuwa punkty z akapitów.

createNamedRange

object (CreateNamedRangeRequest)

Tworzy zakres nazwany.

deleteNamedRange

object (DeleteNamedRangeRequest)

Usuwa zakres nazwany.

updateParagraphStyle

object (UpdateParagraphStyleRequest)

Aktualizuje styl akapitu w określonym zakresie.

deleteContentRange

object (DeleteContentRangeRequest)

usuwa treści z dokumentu.

insertInlineImage

object (InsertInlineImageRequest)

Wstawia obraz w treści w określonym miejscu.

insertTable

object (InsertTableRequest)

Wstawia tabelę w określonym miejscu.

insertTableRow

object (InsertTableRowRequest)

Wstawia pusty wiersz do tabeli.

insertTableColumn

object (InsertTableColumnRequest)

Wstawia pustą kolumnę do tabeli.

deleteTableRow

object (DeleteTableRowRequest)

Usuwa wiersz z tabeli.

deleteTableColumn

object (DeleteTableColumnRequest)

Usuwa kolumnę z tabeli.

insertPageBreak

object (InsertPageBreakRequest)

Wstawia podział strony w określonym miejscu.

deletePositionedObject

object (DeletePositionedObjectRequest)

Usuwa z dokumentu umieszczony obiekt.

updateTableColumnProperties

object (UpdateTableColumnPropertiesRequest)

Aktualizuje właściwości kolumn w tabeli.

updateTableCellStyle

object (UpdateTableCellStyleRequest)

Zmienia styl komórek tabeli.

updateTableRowStyle

object (UpdateTableRowStyleRequest)

Zmienia styl wiersza w tabeli.

replaceImage

object (ReplaceImageRequest)

Zastępuje obraz w dokumencie.

updateDocumentStyle

object (UpdateDocumentStyleRequest)

Zaktualizuje styl dokumentu.

mergeTableCells

object (MergeTableCellsRequest)

Scalenie komórek w tabeli.

unmergeTableCells

object (UnmergeTableCellsRequest)

odłącza komórki w tabeli.

createHeader

object (CreateHeaderRequest)

Tworzy nagłówek.

createFootnote

object (CreateFootnoteRequest)

tworzy przypis.

replaceNamedRangeContent

object (ReplaceNamedRangeContentRequest)

Zastępuje zawartość w zakresie nazwanym.

updateSectionStyle

object (UpdateSectionStyleRequest)

Aktualizuje styl sekcji w określonym zakresie.

insertSectionBreak

object (InsertSectionBreakRequest)

Wstawia podział sekcji w określonym miejscu.

deleteHeader

object (DeleteHeaderRequest)

Usuwa nagłówek z dokumentu.

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

Zmienia liczbę przypiętych wierszy nagłówka w tabeli.

ReplaceAllTextRequest

Zastępuje wszystkie wystąpienia tekstu zgodnego z kryterium wartością replace text.

Zapis 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.
}
Pola
replaceText

string

Tekst, który zastąpi dopasowany tekst.

tabsCriteria

object (TabsCriteria)

Opcjonalnie: Kryteria używane do określania, na których kartach ma nastąpić wymiana.

Jeśli nie zostanie podany, zastąpienie zostanie zastosowane do wszystkich kart.

W dokumencie zawierającym jedną kartę:

  • Jeśli podano, musi być zgodny z identyfikatorem pojedynczej karty.

  • Jeśli ten argument nie zostanie podany, zastąpienie zostanie zastosowane do pojedynczej karty.

W dokumencie zawierającym wiele kart:

  • Jeśli podano, zastąpienie dotyczy określonych kart.

  • Jeśli nie zostanie podany, zastąpienie zostanie zastosowane do wszystkich kart.

Pole uniicriteria. Kryteria dopasowywania tekstu do zastąpienia. criteriamoże być tylko jedną z tych wartości:
containsText

object (SubstringMatchCriteria)

Znajduje w dokumencie tekst pasujący do tego podciągu.

SubstringMatchCriteria

Kryterium, które pasuje do określonego ciągu tekstowego w dokumencie.

Zapis JSON
{
  "text": string,
  "matchCase": boolean
}
Pola
text

string

Tekst, którego szukać w dokumencie.

matchCase

boolean

Wskazuje, czy wyszukiwanie powinno uwzględniać wielkość liter:

  • True: w wyszukiwaniu wielkość liter ma znaczenie.
  • False: wielkość liter w wyszukiwaniu nie jest rozróżniana.

TabsCriteria

Kryterium określające, na których kartach ma być wykonywane żądanie.

Zapis JSON
{
  "tabIds": [
    string
  ]
}
Pola
tabIds[]

string

Lista identyfikatorów kart, na których wykonywane jest żądanie.

InsertTextRequest

Wstawia tekst w określonym miejscu.

Zapis 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.
}
Pola
text

string

Tekst, który ma zostać wstawiony.

Wstawienie znaku końca wiersza powoduje dodanie nowego elementu Paragraph w danym indeksie. Styl akapitu nowego akapitu zostanie skopiowany z akapitu w bieżącym indeksie wstawienia, w tym list i wypunktowań.

Styl tekstu w wstawionym tekście zostanie określony automatycznie, zachowując ogólnie styl sąsiadującego tekstu. W większości przypadków styl tekstu wstawionego tekstu będzie taki sam jak styl tekstu bezpośrednio przed indeksem wstawiania.

Z wstawionego tekstu zostaną usunięte niektóre znaki kontrolne (U+0000-U+0008, U+000C-U+001F) oraz znaki z obszaru prywatnego Unicode Basic Multilingual Plane (U+E000-U+F8FF).

Pole uniiinsertion_location. Miejsce, w którym tekst zostanie wstawiony. insertion_locationmoże być tylko jedną z tych wartości:
location

object (Location)

Wstawia tekst w określonym indeksie w dokumencie.

Tekst musi być wstawiany w ramach istniejącego elementu Paragraph. Nie można na przykład wstawiać tekstu na początku indeksu tabeli (czyli między tabelą a poprzednim akapitem). Tekst musi zostać wstawiony w poprzednim akapicie.

endOfSegmentLocation

object (EndOfSegmentLocation)

Wstawia tekst na końcu nagłówka, stopki, przypisu lub treści dokumentu.

Lokalizacja

określone miejsce w dokumencie,

Zapis JSON
{
  "segmentId": string,
  "index": integer,
  "tabId": string
}
Pola
segmentId

string

Identyfikator nagłówka, stopki lub przypisu, w którym znajduje się lokalizacja. Pusty identyfikator segmentu oznacza treść dokumentu.

index

integer

Indeks oparty na 0 w jednostkach kodu UTF-16.

Indeks jest podany względem początku segmentu określonego przez parametr segmentId.

tabId

string

Karta, na której znajduje się lokalizacja. Jeśli nie zostanie podany, żądanie zostanie zastosowane do pierwszej karty.

W dokumencie zawierającym jedną kartę:

  • Jeśli podano, musi być zgodny z identyfikatorem pojedynczej karty.

  • Jeśli nie zostanie podany, prośba dotyczy pojedynczej karty.

W dokumencie zawierającym wiele kart:

  • Jeśli podano, prośba dotyczy wskazanej karty.

  • Jeśli nie zostanie podany, prośba dotyczy pierwszej karty w dokumencie.

EndOfSegmentLocation

Lokalizacja na końcu treści, nagłówka, stopki lub przypisu. Miejsce to znajduje się bezpośrednio przed ostatnim znakiem końca linii w danym segmencie dokumentu.

Zapis JSON
{
  "segmentId": string,
  "tabId": string
}
Pola
segmentId

string

Identyfikator nagłówka, stopki lub przypisu, w którym znajduje się lokalizacja. Pusty identyfikator segmentu oznacza treść dokumentu.

tabId

string

Karta, na której znajduje się lokalizacja. Jeśli nie zostanie podany, żądanie zostanie zastosowane do pierwszej karty.

W dokumencie zawierającym jedną kartę:

  • Jeśli podano, musi być zgodny z identyfikatorem pojedynczej karty.

  • Jeśli nie zostanie podany, prośba dotyczy pojedynczej karty.

W dokumencie zawierającym wiele kart:

  • Jeśli podano, prośba dotyczy wskazanej karty.

  • Jeśli nie zostanie podany, prośba zostanie zastosowana do pierwszej karty w dokumencie.

UpdateTextStyleRequest

Zmień styl tekstu.

Zapis 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.
}
Pola
textStyle

object (TextStyle)

Style, które mają być ustawione w tekście.

Jeśli wartość danego stylu jest taka sama jak wartość stylu nadrzędnego, ten styl zostanie ustawiony jako dziedziczony.

Niektóre zmiany stylu tekstu mogą powodować inne zmiany, aby odzwierciedlić działanie edytora Dokumentów. Więcej informacji znajdziesz w dokumentacji TextStyle.

fields

string (FieldMask format)

Pola, które należy zaktualizować.

Musisz określić co najmniej 1 pole. Identyfikator textStyle jest domyślny i nie musi być podany. Jako skrót do wylistowania wszystkich pól można użyć pojedynczego znaku "*".

Aby na przykład zmienić styl tekstu na pogrubiony, ustaw wartość fields na "bold".

Aby zresetować usługę do wartości domyślnej, dodaj jej nazwę w polu maski, ale nie wypełniaj tego pola.

Pole uniiinsertion_location. Typ zakresu, w którym ma zostać zaktualizowany styl tekstu. insertion_locationmoże być tylko jedną z tych wartości:
range

object (Range)

Zakres tekstu do sformatowania.

Zakres może zostać rozszerzony, aby obejmował sąsiednie znaki końca wiersza.

Jeśli zakres zawiera cały akapit należący do listy, punkt na liście jest również aktualizowany o pasujący styl tekstu.

Nie można wstawiać zakresów w względnym żądaniu UpdateTextStyleRequest.

CreateParagraphBulletsRequest

Tworzy punkty dla wszystkich akapitów, które pokrywają się z danym zakresem.

Poziom zagnieżdżania każdego akapitu zostanie określony na podstawie liczby tabulacji przed każdym akapitem. Aby uniknąć nadmiernej ilości miejsca między wcięciem a odpowiadającym akapitem, ta prośba powoduje usunięcie tych wcięć. Może to zmienić indeksy części tekstu.

Jeśli akapit bezpośrednio przed aktualizowanymi akapitami znajduje się na liście z odpowiednimi ustawieniami wstępnymi, aktualizowane akapity są dodawane do tej listy.

Zapis JSON
{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
Pola
range

object (Range)

Zakres, do którego ma zostać zastosowany gotowy punktor.

bulletPreset

enum (BulletGlyphPreset)

Rodzaje użytych symboli punktowanych.

BulletGlyphPreset

Wstępnie ustawione wzorce symboli listowych.

Te wzorce używają tych rodzajów znaczników:

  • ARROW: strzałka odpowiadająca punktowi kodowemu Unicode U+2794
  • ARROW3D : strzałka z cieniowaniem 3D odpowiadająca punktowi kodowemu Unicode U+27a2
  • CHECKBOX : pusty kwadrat odpowiadający punktowi kodowemu Unicode U+274f
  • CIRCLE: pusty okrąg odpowiadający punktowi kodowemu Unicode U+25cb
  • DIAMOND: wypełniony diament odpowiadający punktowi kodowemu Unicode U+25c6.
  • DIAMONDX : diament z literą „x”, odpowiadający punktowi kodowemu Unicode U+2756
  • HOLLOWDIAMOND: pusty romb odpowiadający punktowi kodowemu Unicode U+25c7.
  • DISC: pełne kółko odpowiadające punktowi kodowemu Unicode U+25cf.
  • SQUARE: pełny kwadrat odpowiadający punktowi kodowemu Unicode U+25a0
  • STAR : gwiazda odpowiadająca punktowi kodowemu Unicode U+2605
  • ALPHA : mała litera, np. „a”, „b” lub „c”.
  • UPPERALPHA : duża litera, np. „A”, „B” lub „C”.
  • DECIMAL: liczba, np. „1”, „2” lub „3”.
  • ZERODECIMAL: liczba, w której pojedyncze cyfry mają przedrostek 0, np. „01”, „02” lub „03”. Liczby składające się z więcej niż 1 cyfry nie mają przedrostka 0.
  • ROMAN : mała rzymska cyfra, np. „i”, „ii” lub „iii”.
  • UPPERROMAN : Wielka litera rzymska, np. „I”, „II” lub „III”.
  • LEFTTRIANGLE : trójkąt skierowany w lewo, odpowiadający punktowi kodowemu Unicode U+25c4
Wartości w polu enum
BULLET_GLYPH_PRESET_UNSPECIFIED Nie określono wstępnie ustawionego symbolu kuleczki.
BULLET_DISC_CIRCLE_SQUARE Lista punktowana z glyphem punktowanym DISC, CIRCLESQUARE dla pierwszych 3 poziomów zagnieżdżenia listy.
BULLET_DIAMONDX_ARROW3D_SQUARE Lista punktowana z glyphem punktowanym DIAMONDX, ARROW3DSQUARE dla pierwszych 3 poziomów zagnieżdżenia listy.
BULLET_CHECKBOX Lista punktowana z CHECKBOXznakami punktowanymi na wszystkich poziomach zagnieżdżenia listy.
BULLET_ARROW_DIAMOND_DISC Lista punktowana z glyphem punktowanym ARROW, DIAMONDDISC dla pierwszych 3 poziomów zagnieżdżenia listy.
BULLET_STAR_CIRCLE_SQUARE Lista punktowana z glyphem punktowanym STAR, CIRCLESQUARE dla pierwszych 3 poziomów zagnieżdżenia listy.
BULLET_ARROW3D_CIRCLE_SQUARE Lista punktowana z glyphem punktowanym ARROW3D, CIRCLESQUARE dla pierwszych 3 poziomów zagnieżdżenia listy.
BULLET_LEFTTRIANGLE_DIAMOND_DISC Lista punktowana z glyphem punktowanym LEFTTRIANGLE, DIAMONDDISC dla pierwszych 3 poziomów zagnieżdżenia listy.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE Lista punktowana z glyphem punktowanym DIAMONDX, HOLLOWDIAMONDSQUARE dla pierwszych 3 poziomów zagnieżdżenia listy.
BULLET_DIAMOND_CIRCLE_SQUARE Lista punktowana z glyphem punktowanym DIAMOND, CIRCLESQUARE dla pierwszych 3 poziomów zagnieżdżenia listy.
NUMBERED_DECIMAL_ALPHA_ROMAN Listę numerowaną z glyphami liczbowymi DECIMAL, ALPHAROMAN dla pierwszych 3 poziomów zagnieżdżenia listy, po których następują kropki.
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS Listę numerowaną z glyphami liczbowymi DECIMAL, ALPHAROMAN dla pierwszych 3 poziomów zagnieżdżenia listy, po których następują nawiasy.
NUMBERED_DECIMAL_NESTED Ponumerowana lista z DECIMALliczbowymi znakami graficznymi rozdzielonymi kropkami, przy czym każdy poziom zagnieżdżania używa znaku graficznego poprzedniego poziomu jako prefiksu. Na przykład: „1.”, '1.1.', '2.', „2.2”.
NUMBERED_UPPERALPHA_ALPHA_ROMAN Listę numerowaną z glyphami liczbowymi UPPERALPHA, ALPHAROMAN dla pierwszych 3 poziomów zagnieżdżenia listy, po których następują kropki.
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL Listę numerowaną z glyphami liczbowymi UPPERROMAN, UPPERALPHADECIMAL dla pierwszych 3 poziomów zagnieżdżenia listy, po których następują kropki.
NUMBERED_ZERODECIMAL_ALPHA_ROMAN Listę numerowaną z glyphami liczbowymi ZERODECIMAL, ALPHAROMAN dla pierwszych 3 poziomów zagnieżdżenia listy, po których następują kropki.

DeleteParagraphBulletsRequest

Usuwa wypunktowania ze wszystkich akapitów, które pokrywają się z danym zakresem.

Poziom zagnieżdżenia każdego akapitu zostanie zachowany wizualnie przez dodanie wcięcia na początku odpowiedniego akapitu.

Zapis JSON
{
  "range": {
    object (Range)
  }
}
Pola
range

object (Range)

Zakres, z którego mają zostać usunięte punkty.

CreateNamedRangeRequest

Tworzy wyrażenie NamedRangeodwołujące się do podanego zakresu.

Zapis JSON
{
  "name": string,
  "range": {
    object (Range)
  }
}
Pola
name

string

Nazwa zakresu nazwa. Nazwy nie muszą być unikalne.

Nazwa musi mieć co najmniej 1 znak i nie więcej niż 256 znaków (w jednostkach kodu UTF-16).

range

object (Range)

Zakres, do którego ma zostać zastosowana nazwa.

DeleteNamedRangeRequest

Usuwa NamedRange.

Zapis 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.
}
Pola
tabsCriteria

object (TabsCriteria)

Opcjonalnie: Kryteria używane do określania, na których kartach ma nastąpić usunięcie zakresu. Jeśli nie zostanie pominięty, usunięcie zakresu zostanie zastosowane do wszystkich kart.

W dokumencie zawierającym jedną kartę:

  • Jeśli podano, musi być zgodny z identyfikatorem pojedynczej karty.

  • Jeśli ten argument zostanie pominięty, usunięcie zakresu zostanie zastosowane do pojedynczej karty.

W dokumencie zawierającym wiele kart:

  • Jeśli jest podany, usunięcie zakresu dotyczy określonych kart.

  • Jeśli nie podasz zakresu, usunięcie zakresu będzie dotyczyć wszystkich kart.

Pole uniinamed_range_reference. Wartość, która określa, które zakresy mają zostać usunięte. Musisz ustawić dokładnie 1 z nich. named_range_referencemoże być tylko jedną z tych wartości:
namedRangeId

string

Identyfikator zakresu nazwanego, który chcesz usunąć.

name

string

Nazwa zakresów do usunięcia. Wszystkie nazwane zakresy o danej nazwie zostaną usunięte.

UpdateParagraphStyleRequest

Zaktualizuj styl wszystkich akapitów, które pokrywają się z danym zakresem.

Zapis 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.
}
Pola
paragraphStyle

object (ParagraphStyle)

Style, które mają być ustawione w akapitach.

Niektóre zmiany stylu akapitu mogą powodować inne zmiany, aby odzwierciedlić działanie edytora Dokumentów. Aby dowiedzieć się więcej, zapoznaj się z dokumentacją ParagraphStyle.

fields

string (FieldMask format)

Pola, które należy zaktualizować.

Musisz określić co najmniej 1 pole. Identyfikator paragraphStyle jest domyślny i nie musi być podany. Jako skrót do wylistowania wszystkich pól można użyć pojedynczego znaku "*".

Aby na przykład zaktualizować właściwość wyrównania stylu akapitu, ustaw wartośćfieldsna"alignment".

Aby zresetować usługę do wartości domyślnej, dodaj jej nazwę w masce pola, ale nie wypełniaj tego pola.

Pole uniiinsertion_location. Typ zakresu, w którym ma zostać zaktualizowany styl akapitu. insertion_locationmoże być tylko jedną z tych wartości:
range

object (Range)

Zakres obejmujący akapity, które mają być sformatowane.

DeleteContentRangeRequest

usuwa treści z dokumentu.

Zapis JSON
{
  "range": {
    object (Range)
  }
}
Pola
range

object (Range)

Zakres treści do usunięcia.

Usunięcie tekstu, który przekracza granicę akapitu, może spowodować zmiany stylów akapitów, list, obiektów z pozycjonowaniem i zakładek, ponieważ akapity zostaną połączone.

Próba usunięcia niektórych zakresów może spowodować nieprawidłową strukturę dokumentu, co spowoduje wyświetlenie błędu 400 „Zła prośba”.

Oto przykłady nieprawidłowych żądań usunięcia:

InsertInlineImageRequest

Wstawia obiekt InlineObject zawierający obraz w danej lokalizacji.

Zapis 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.
}
Pola
uri

string

Identyfikator URI obrazu.

Obraz jest pobierany raz w momencie wstawiania i kopia jest przechowywana na potrzeby wyświetlania w dokumencie. Obrazy muszą mieć rozmiar mniejszy niż 50 MB, nie mogą przekraczać 25 megapikseli i muszą być w formacie PNG, JPEG lub GIF.

Podany identyfikator URI musi być dostępny publicznie i mieć maksymalnie 2 kB długości. Identyfikator URI jest zapisywany razem z obrazem i wyświetlany w poluImageProperties.content_uri.

objectSize

object (Size)

Rozmiar, w jakim obraz ma się wyświetlać w dokumencie. Ta właściwość jest opcjonalna, a ostateczny rozmiar obrazu w dokumencie jest określany według tych reguł: * Jeśli nie określono ani szerokości, ani wysokości, domyślny rozmiar obrazu jest obliczany na podstawie jego rozdzielczości. * Jeśli podany jest jeden wymiar, drugi zostanie obliczony w taki sposób, aby zachować współczynnik proporcji obrazu. * Jeśli podano zarówno szerokość, jak i wysokość, obraz zostanie przeskalowany, aby mieścił się w podanych wymiarach przy zachowaniu współczynnika proporcji.

Pole uniiinsertion_location. Miejsce, w którym zostanie wstawiony obraz. insertion_locationmoże być tylko jedną z tych wartości:
location

object (Location)

Wstawia obraz w określonym miejscu w dokumencie.

Obraz musi zostać wstawiony w ramach istniejącego Paragraph. Nie można go na przykład wstawić na początku indeksu tabeli (czyli między tabelą a poprzedzającym ją akapitem).

Obrazów wstawianych w tekście nie można umieszczać w przypisie ani w równaniu.

endOfSegmentLocation

object (EndOfSegmentLocation)

Wstawia tekst na końcu nagłówka, stopki lub treści dokumentu.

Obrazów wstawianych w tekście nie można umieszczać w przypisie.

InsertTableRequest

Wstawia tabelę w określonym miejscu.

Przed wstawioną tabelą zostanie wstawiony znak nowej linii.

Zapis 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.
}
Pola
rows

integer

Liczba wierszy w tabeli.

columns

integer

Liczba kolumn w tabeli.

Pole uniiinsertion_location. Miejsce, w którym zostanie wstawiona tabela. insertion_locationmoże być tylko jedną z tych wartości:
location

object (Location)

Wstawia tabelę w określonym indeksie modelu.

Przed wstawianą tabelą zostanie wstawiony znak nowej linii, dlatego indeks początku tabeli będzie wynosił podany indeks lokalizacji + 1.

Tabela musi zostać wstawiona w ograniczeniach istniejącej Paragraph. Nie można go na przykład wstawić na początku indeksu tabeli (czyli między istniejącą tabelą a poprzednim akapitem).

Tabel nie można wstawiać w przypisie ani równaniu.

endOfSegmentLocation

object (EndOfSegmentLocation)

Wstawia tabelę na końcu danego nagłówka, stopki lub treści dokumentu. Przed wstawioną tabelą zostanie wstawiony znak nowej linii.

Nie można wstawiać tabel w stopce.

InsertTableRowRequest

Wstawia pusty wiersz do tabeli.

Zapis JSON
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}
Pola
tableCellLocation

object (TableCellLocation)

Lokalizacja komórki tabeli odniesienia, z której zostaną wstawione wiersze.

Nowy wiersz zostanie wstawiony nad (lub pod) wierszem, w którym znajduje się komórka odniesienia. Jeśli komórka odniesienia jest komórką scaloną, nowy wiersz zostanie wstawiony nad (lub pod) tą komórką.

insertBelow

boolean

Określa, czy nowy wiersz ma zostać wstawiony pod komórką odniesienia.

  • True: wstawianie poniżej komórki.
  • False: wstawianie nad komórką.

TableCellLocation

Lokalizacja pojedynczej komórki w tabeli.

Zapis JSON
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}
Pola
tableStartLocation

object (Location)

Miejsce w dokumencie, w którym zaczyna się tabela.

rowIndex

integer

Indeks wiersza liczony od 0. Na przykład drugi wiersz w tabeli ma indeks 1.

columnIndex

integer

Indeks kolumny liczony od 0. Na przykład druga kolumna w tabeli ma indeks 1.

InsertTableColumnRequest

Wstawia pustą kolumnę do tabeli.

Zapis JSON
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}
Pola
tableCellLocation

object (TableCellLocation)

Lokalizacja komórki tabeli odniesienia, z której zostaną wstawione kolumny.

Nowa kolumna zostanie wstawiona po lewej (lub prawej) stronie kolumny, w której znajduje się komórka odniesienia. Jeśli komórka odniesienia jest komórką scaloną, nowa kolumna zostanie wstawiona po lewej (lub prawej) stronie komórki scalonej.

insertRight

boolean

Określa, czy nowa kolumna ma zostać wstawiona po prawej stronie komórki referencyjnej.

  • True: wstawianie po prawej stronie.
  • False: wstawianie po lewej stronie.

DeleteTableRowRequest

Usuwa wiersz z tabeli.

Zapis JSON
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
Pola
tableCellLocation

object (TableCellLocation)

Lokalizacja komórki tabeli odniesienia, z której zostanie usunięty wiersz.

Wiersz, na który sięga komórka, zostanie usunięty. Jeśli jest to komórka scalona, która obejmuje kilka wierszy, wszystkie komórki zostaną usunięte. Jeśli po usunięciu wierszy w tabeli nie pozostanie w niej żaden wiersz, zostanie usunięta cała tabela.

DeleteTableColumnRequest

Usuwa kolumnę z tabeli.

Zapis JSON
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
Pola
tableCellLocation

object (TableCellLocation)

Lokalizacja komórki tabeli odniesienia, z której kolumna zostanie usunięta.

Kolumna, na którą się rozciąga ta komórka, zostanie usunięta. Jeśli jest to scalona komórka obejmująca wiele kolumn, zostaną usunięte wszystkie kolumny, które obejmuje. Jeśli po usunięciu kolumn nie pozostanie w niej żadna kolumna, zostanie usunięta cała tabela.

InsertPageBreakRequest

Wstawia w określonym miejscu podział strony, a za nim znak nowej linii.

Zapis 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.
}
Pola
Pole uniiinsertion_location. Miejsce, w którym zostanie wstawiony podział strony. insertion_locationmoże być tylko jedną z tych wartości:
location

object (Location)

Wstawia podział strony w określonym miejscu w dokumencie.

Przerwę strony należy wstawić w obrębie istniejącego Paragraph. Nie można go na przykład wstawić na początku indeksu tabeli (czyli między tabelą a poprzedzającym ją akapitem).

Nie można wstawiać podziałów stron w tabeli, równaniu, przypisie, nagłówku ani stopce. Przerwy strony można wstawiać tylko w treści, więc pole segment ID musi być puste.

endOfSegmentLocation

object (EndOfSegmentLocation)

Wstawia podział strony na końcu głównej części dokumentu.

Przerwy stron nie można wstawiać w przypisie, nagłówku ani stopce. Przerwy strony można wstawiać tylko w treści, więc pole segment ID musi być puste.

DeletePositionedObjectRequest

Usuwa z dokumentu element PositionedObject.

Zapis JSON
{
  "objectId": string,
  "tabId": string
}
Pola
objectId

string

Identyfikator umieszczonego obiektu do usunięcia.

tabId

string

Karta, na której znajduje się obiekt do usunięcia. Jeśli nie zostanie podany, żądanie zostanie zastosowane do pierwszej karty.

W dokumencie zawierającym jedną kartę:

  • Jeśli podano, musi być zgodny z identyfikatorem pojedynczej karty.

  • Jeśli nie zostanie podany, prośba dotyczy pojedynczej karty.

W dokumencie zawierającym wiele kart:

  • Jeśli podano, prośba dotyczy wskazanej karty.

  • Jeśli nie zostanie podany, prośba dotyczy pierwszej karty w dokumencie.

UpdateTableColumnPropertiesRequest

Zaktualizuj TableColumnProperties kolumn w tabeli.

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

object (Location)

Miejsce w dokumencie, w którym zaczyna się tabela.

columnIndices[]

integer

Lista indeksów kolumn z numeracją od 0, których właściwości należy zaktualizować. Jeśli nie podasz żadnych indeksów, zostaną zaktualizowane wszystkie kolumny.

tableColumnProperties

object (TableColumnProperties)

Właściwości kolumny tabeli, które chcesz zaktualizować.

Jeśli wartość tableColumnProperties#width jest mniejsza niż 5 punktów (5/72 cala), zwracany jest błąd 400 zły wniosek.

fields

string (FieldMask format)

Pola, które należy zaktualizować.

Musisz określić co najmniej 1 pole. Identyfikator tableColumnProperties jest domyślny i nie musi być podany. Jako skrót do wylistowania wszystkich pól można użyć pojedynczego znaku "*".

Aby na przykład zmienić szerokość kolumny, ustaw wartość fields na "width".

UpdateTableCellStyleRequest

Zmienia styl zakresu komórek tabeli.

Zapis 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.
}
Pola
tableCellStyle

object (TableCellStyle)

Styl do zastosowania w komórkach tabeli.

Jeśli podczas aktualizowania obramowania komórka ma wspólne obramowanie z sąsiednią komórką, odpowiednia właściwość obramowania sąsiedniej komórki zostanie również zaktualizowana. Nie są aktualizowane obramowania, które są scalone i niewidoczne.

Zmiana obramowania wspólnego dla sąsiednich komórek w tym samym żądaniu może spowodować konfliktowe zmiany obramowania, dlatego zmiany te są stosowane w tej kolejności:

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

Pola, które należy zaktualizować.

Musisz określić co najmniej 1 pole. Identyfikator tableCellStyle jest domyślny i nie musi być podany. Jako skrót do wylistowania wszystkich pól można użyć pojedynczego znaku "*".

Aby na przykład zaktualizować kolor tła komórki tabeli, ustaw wartość fields na "backgroundColor".

Aby zresetować usługę do wartości domyślnej, dodaj jej nazwę w polu maski, ale nie wypełniaj tego pola.

Pole uniicells. Komórki, które zostaną zaktualizowane. cellsmoże być tylko jedną z tych wartości:
tableRange

object (TableRange)

Zakres tabeli reprezentujący podzbiór tabeli, do którego mają być stosowane zmiany.

tableStartLocation

object (Location)

Miejsce w dokumencie, w którym zaczyna się tabela. Jeśli to konieczne, aktualizacje zostaną zastosowane do wszystkich komórek w tabeli.

TableRange

Zakres tabeli to odwołanie do podzbioru tabeli.

Pamiętaj, że komórki określone przez zakres tabeli nie muszą tworzyć prostokąta. Załóżmy na przykład, że mamy tabelę 3 x 3, w której wszystkie komórki ostatniego wiersza są połączone. Tabela wygląda tak:

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

Zakres tabeli z lokalizacją komórki tabeli = (tableStartLocation, wiersz = 0, kolumna = 0), zakres wierszy = 3 i zakres kolumn = 2 określa te komórki:

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

object (TableCellLocation)

Lokalizacja komórki, od której zaczyna się zakres tabeli.

rowSpan

integer

Zakres wierszy zakresu tabeli.

columnSpan

integer

Zakres kolumny w zakresie tabeli.

UpdateTableRowStyleRequest

ZmieniaTableRowStylewiersze w tabeli.

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

object (Location)

Miejsce w dokumencie, w którym zaczyna się tabela.

rowIndices[]

integer

Lista indeksów wierszy o numerze 0, których styl ma zostać zaktualizowany. Jeśli nie podasz żadnych indeksów, zaktualizowane zostaną wszystkie wiersze.

tableRowStyle

object (TableRowStyle)

Style, które mają być ustawione w wierszach.

fields

string (FieldMask format)

Pola, które należy zaktualizować.

Musisz określić co najmniej 1 pole. Identyfikator tableRowStyle jest domyślny i nie musi być podany. Jako skrót do wylistowania wszystkich pól można użyć pojedynczego znaku "*".

Aby na przykład zmienić minimalną wysokość wiersza, ustaw wartość fields na "minRowHeight".

ReplaceImageRequest

Zastępuje istniejący obraz nowym.

Zastępowanie obrazu powoduje usunięcie niektórych elementówimage effectsz dotychczasowego obrazu, aby odzwierciedlić działanie edytora Dokumentów.

Zapis JSON
{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}
Pola
imageObjectId

string

Identyfikator istniejącego obrazu, który zostanie zastąpiony. Identyfikator można pobrać z odpowiedzi na żądanie GET.

uri

string

Identyfikator URI nowego obrazu.

Obraz jest pobierany raz w momencie wstawiania i kopia jest przechowywana na potrzeby wyświetlania w dokumencie. Obrazy muszą mieć rozmiar mniejszy niż 50 MB, nie mogą przekraczać 25 megapikseli i muszą być w formacie PNG, JPEG lub GIF.

Podany identyfikator URI nie może mieć długości przekraczającej 2 KB. Identyfikator URI jest zapisywany razem z obrazem i wyświetlany w polu ImageProperties.source_uri.

imageReplaceMethod

enum (ImageReplaceMethod)

Metoda wymiany.

tabId

string

Karta, na której znajduje się obraz, który chcesz zastąpić. Jeśli nie zostanie podany, żądanie zostanie zastosowane do pierwszej karty.

W dokumencie zawierającym jedną kartę:

  • Jeśli podano, musi być zgodny z identyfikatorem pojedynczej karty.

  • Jeśli nie zostanie podany, prośba dotyczy pojedynczej karty.

W dokumencie zawierającym wiele kart:

  • Jeśli podano, prośba dotyczy wskazanej karty.

  • Jeśli nie zostanie podany, prośba zostanie zastosowana do pierwszej karty w dokumencie.

ImageReplaceMethod

Metoda zastępowania obrazu.

Wartości w polu enum
IMAGE_REPLACE_METHOD_UNSPECIFIED Nieokreślona metoda zastępowania obrazu. Nie należy używać tej wartości.
CENTER_CROP Skaluje i wyśrodkowuje obraz, aby wypełnić granice oryginalnego obrazu. Obraz może zostać przycięty, aby wypełnić granice oryginalnego obrazu. Wyrenderowany rozmiar obrazu będzie taki sam jak rozmiar obrazu oryginalnego.

UpdateDocumentStyleRequest

Zaktualizowano DocumentStyle.

Zapis JSON
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string,
  "tabId": string
}
Pola
documentStyle

object (DocumentStyle)

Style, które mają być ustawione w dokumencie.

Niektóre zmiany stylu dokumentu mogą powodować inne zmiany, aby odzwierciedlić działanie edytora Dokumentów. Aby dowiedzieć się więcej, zapoznaj się z dokumentacją DocumentStyle.

fields

string (FieldMask format)

Pola, które należy zaktualizować.

Musisz określić co najmniej 1 pole. Identyfikator documentStyle jest domyślny i nie musi być podany. Jako skrót do wylistowania wszystkich pól można użyć pojedynczego znaku "*".

Aby na przykład zaktualizować tło, ustaw fields na "background".

tabId

string

Karta zawierająca styl, który chcesz zaktualizować. Jeśli nie zostanie podany, żądanie zostanie zastosowane do pierwszej karty.

W dokumencie zawierającym jedną kartę:

  • Jeśli podano, musi być zgodny z identyfikatorem pojedynczej karty.

  • Jeśli nie zostanie podany, prośba dotyczy pojedynczej karty.

W dokumencie zawierającym wiele kart:

  • Jeśli podano, prośba dotyczy wskazanej karty.

  • Jeśli nie zostanie podany, prośba dotyczy pierwszej karty w dokumencie.

MergeTableCellsRequest

Scalenie komórek w Table.

Zapis JSON
{
  "tableRange": {
    object (TableRange)
  }
}
Pola
tableRange

object (TableRange)

Zakres tabeli określający, które komórki tabeli mają zostać scalone.

Tekst w komórkach, które są scalane, zostanie złączony i zapisany w komórce „head” zakresu. Jest to komórka w lewym górnym rogu zakresu, jeśli kierunek treści jest od lewej do prawej, a w przeciwnym razie jest to komórka w prawym górnym rogu zakresu.

Jeśli zakres nie jest prostokątny (co może się zdarzyć w niektórych przypadkach, gdy obejmuje komórki, które są już scalone lub gdy tabela nie jest prostokątna), zwracany jest błąd 400 „Nieprawidłowy żądanie”.

UnmergeTableCellsRequest

Rozdziela komórki w Table.

Zapis JSON
{
  "tableRange": {
    object (TableRange)
  }
}
Pola
tableRange

object (TableRange)

Zakres tabeli określający, które komórki tabeli mają zostać odscalowane.

Wszystkie scalone komórki w tym zakresie zostaną rozdzielone, a komórki, które są już rozdzielone, nie zostaną zmienione. Jeśli zakres nie zawiera scalonych komórek, żądanie nie będzie miało żadnego efektu.

Jeśli w jakiejś scalonej komórce znajduje się tekst, pozostanie on w komórce „głównej” w bloku utworzonych komórek. Komórka „head” to komórka w lewym górnym rogu, jeśli kierunek treści jest od lewej do prawej, a w przeciwnym razie w prawym górnym rogu.

CreateHeaderRequest

Tworzy Header. Nowy nagłówek jest stosowany do elementu SectionStyle w miejscu elementu SectionBreak, jeśli ten ostatni został określony. W przeciwnym razie jest on stosowany do elementu DocumentStyle.

Jeśli nagłówek o podanym typie już istnieje, zwracany jest błąd 400 „Błędne żądanie”.

Zapis JSON
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Pola
type

enum (HeaderFooterType)

Typ nagłówka do utworzenia.

sectionBreakLocation

object (Location)

Lokalizacja SectionBreak, która rozpoczyna sekcję, do której powinien należeć ten nagłówek. Jeśli parametr „sectionBreakLocation” nie jest ustawiony lub odnosi się do pierwszego podziału sekcji w treści dokumentu, nagłówek jest stosowany do:DocumentStyle

HeaderFooterType

Typy nagłówków i stopek, które można utworzyć.

Wartości w polu enum
DEFAULT Domyślny nagłówek lub stopka.

CreateFooterRequest

Tworzy Footer. Nowy nagłówek jest stosowany w dokumentach SectionStyle w miejscu, w którym występuje element SectionBreak, jeśli został podany. W przeciwnym razie jest on stosowany w miejscu elementu DocumentStyle.

Jeśli stopka określonego typu już istnieje, zwracany jest błąd 400 „Nieprawidłowy żądanie”.

Zapis JSON
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Pola
type

enum (HeaderFooterType)

Typ stopki do utworzenia.

sectionBreakLocation

object (Location)

Lokalizacja SectionBreak bezpośrednio przed sekcją, do której ma należeć ten stopka.SectionStyle Jeśli to pole jest puste lub odnosi się do pierwszego podziału sekcji w dokumencie, stopka jest stosowana do stylu dokumentu.

CreateFootnoteRequest

Tworzy segment Footnote i wstawia do niego nowy element FootnoteReference w określonym miejscu.

Nowy segmentFootnote będzie zawierać spację, a za nią znak nowego wiersza.

Zapis 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.
}
Pola
Pole uniifootnote_reference_location. Miejsce, w którym chcesz wstawić odwołanie do przypisu. footnote_reference_locationmoże być tylko jedną z tych wartości:
location

object (Location)

Wstawia odwołanie do przypisu w określonym indeksie w dokumencie.

Odwołanie do przypisu musi być wstawione w ramach istniejącego elementu Paragraph. Nie można go na przykład wstawić na początku indeksu tabeli (czyli między tabelą a poprzedzającym ją akapitem).

Odniesień do przypisów nie można wstawiać w równaniu, nagłówku, stopce ani przypisie. Odniesienia do przypisów można wstawiać tylko w treści, więc pole segment ID musi być puste.

endOfSegmentLocation

object (EndOfSegmentLocation)

Wstawia odwołanie do przypisu na końcu treści dokumentu.

Odniesień do przypisów nie można umieszczać w nagłówku, stopce ani przypisie. Odniesienia do przypisów można wstawiać tylko w treści, więc pole segment ID musi być puste.

ReplaceNamedRangeContentRequest

Zastępuje zawartość określonego pliku NamedRange lub NamedRanges podanymi treściami.

Pamiętaj, że pojedynczy plikNamedRangemoże składać się z wielu nieciągłychranges. W tym przypadku zostanie zastąpiona tylko treść w pierwszym zakresie. Pozostałe zakresy i ich zawartość zostaną usunięte.

W przypadkach, gdy zastąpienie lub usunięcie dowolnego zakresu spowodowałoby nieprawidłową strukturę dokumentu, zwracany jest błąd 400 „Nieprawidłowy żądanie”.

Zapis 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.
}
Pola
tabsCriteria

object (TabsCriteria)

Opcjonalnie: Kryteria używane do określania, na których kartach ma nastąpić wymiana. Jeśli nie zostanie podany, zastąpienie zostanie zastosowane do wszystkich kart.

W dokumencie zawierającym jedną kartę:

  • Jeśli podano, musi być zgodny z identyfikatorem pojedynczej karty.

  • Jeśli ten argument nie zostanie podany, zastąpienie zostanie zastosowane do pojedynczej karty.

W dokumencie zawierającym wiele kart:

  • Jeśli podano, zastąpienie dotyczy określonych kart.

  • Jeśli nie zostanie podany, zastąpienie zostanie zastosowane do wszystkich kart.

Pole uniireplacement_content. Treść, która ma zastąpić dotychczasową zawartość zakresu nazwanego. replacement_contentmoże być tylko jedną z tych wartości:
text

string

Zastępuje zawartość określonych zakresów nazwanych podanym tekstem.

Pole uniinamed_range_reference. Odwołania do nazwanych zakresów, których zawartość zostanie zastąpiona. named_range_referencemoże być tylko jedną z tych wartości:
namedRangeId

string

Identyfikator zakresu nazwanego, którego zawartość zostanie zastąpiona.

Jeśli nie ma zakresu o podanym identyfikatorze, zwracany jest błąd 400 „Zła prośba”.

namedRangeName

string

Nazwa NamedRanges, którego treść zostanie zastąpiona.

Jeśli istnieje wiele elementównamed rangeso tej samej nazwie, ich zawartość zostanie zastąpiona. Jeśli nie ma żadnych nazwanych zakresów o podanej nazwie, żądanie nie zostanie wykonane.

UpdateSectionStyleRequest

Zaktualizowano SectionStyle.

Zapis JSON
{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}
Pola
range

object (Range)

Zakres nakładania się sekcji do stylizacji.

Przerwy między sekcjami można wstawiać tylko w treści, więc pole segment ID musi być puste.

sectionStyle

object (SectionStyle)

Style, które mają być ustawione w sekcji.

Niektóre zmiany stylu sekcji mogą powodować inne zmiany, aby odzwierciedlić działanie edytora Dokumentów. Aby dowiedzieć się więcej, zapoznaj się z dokumentacją SectionStyle.

fields

string (FieldMask format)

Pola, które należy zaktualizować.

Musisz określić co najmniej 1 pole. Element sectionStyle jest elementem nadrzędnym, którego nie trzeba deklarować. Jako skrót do wylistowania wszystkich pól można użyć pojedynczego znaku "*".

Aby na przykład zmienić lewy margines, ustaw wartość parametru fields na "marginLeft".

InsertSectionBreakRequest

Wstawia w określonym miejscu podział sekcji.

Przed podziałem sekcji zostanie wstawiony znak nowego wiersza.

Zapis 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.
}
Pola
sectionType

enum (SectionType)

Typ sekcji do wstawienia.

Pole uniiinsertion_location. Lokalizacja, w której zostanie wstawiona przerwa. insertion_locationmoże być tylko jedną z tych wartości:
location

object (Location)

Wstawia znak nowej linii i przerwę sekcyjną w określonym miejscu w dokumencie.

Przerwę między sekcjami należy wstawić w ramach istniejącego Paragraph. Nie można go na przykład wstawić na początku indeksu tabeli (czyli między tabelą a poprzednim akapitem).

Przerwy między sekcjami nie można wstawiać w tabeli, równaniu, przypisie, nagłówku ani stopce. Przerwy między sekcjami można wstawiać tylko w treści, więc pole segment ID musi być puste.

endOfSegmentLocation

object (EndOfSegmentLocation)

Wstawia znak nowego wiersza i przerwę sekcji na końcu głównej części dokumentu.

Przerwy między sekcjami nie można wstawiać w przypisie, nagłówku ani stopce. Przerwy między sekcjami można wstawiać tylko w treści, więc pole segment ID musi być puste.

DeleteHeaderRequest

Usuwa z dokumentu element Header.

Zapis JSON
{
  "headerId": string,
  "tabId": string
}
Pola
headerId

string

Identyfikator nagłówka do usunięcia. Jeśli nagłówek jest zdefiniowany w DocumentStyle, odniesienie do niego zostaje usunięte, co powoduje, że w pierwszej sekcji dokumentu nie ma nagłówka tego typu. Jeśli ten nagłówek jest zdefiniowany w sekcji SectionStyle, odniesienie do tego nagłówka zostanie usunięte, a nagłówek tego typu będzie kontynuowany z poprzedniej sekcji.

tabId

string

Karta zawierająca nagłówek, który chcesz usunąć. Jeśli nie zostanie podany, żądanie zostanie zastosowane do pierwszej karty.

W dokumencie zawierającym jedną kartę:

  • Jeśli podano, musi być zgodny z identyfikatorem pojedynczej karty.

  • Jeśli nie zostanie podany, prośba dotyczy pojedynczej karty.

W dokumencie zawierającym wiele kart:

  • Jeśli podano, prośba dotyczy wskazanej karty.

  • Jeśli nie zostanie podany, prośba zostanie zastosowana do pierwszej karty w dokumencie.

DeleteFooterRequest

Usuwa z dokumentu element Footer.

Zapis JSON
{
  "footerId": string,
  "tabId": string
}
Pola
footerId

string

Identyfikator stopki do usunięcia. Jeśli stopka jest zdefiniowana w poziomie DocumentStyle, odwołanie do niej zostaje usunięte, co powoduje, że w pierwszej sekcji dokumentu nie ma stopki tego typu. Jeśli stopka jest zdefiniowana w poziomie SectionStyle, odniesienie do niej zostaje usunięte, a stopka tego typu jest kontynuowana z poprzedniej sekcji.

tabId

string

Karta zawierająca stopkę, którą chcesz usunąć. Jeśli nie zostanie podany, żądanie zostanie zastosowane do pierwszej karty.

W dokumencie zawierającym jedną kartę:

  • Jeśli podano, musi być zgodny z identyfikatorem pojedynczej karty.

  • Jeśli nie zostanie podany, prośba dotyczy pojedynczej karty.

W dokumencie zawierającym wiele kart:

  • Jeśli podano, prośba dotyczy wskazanej karty.

  • Jeśli nie zostanie podany, prośba zostanie zastosowana do pierwszej karty w dokumencie.

PinTableHeaderRowsRequest

Zmienia liczbę przypiętych wierszy nagłówka tabeli.

Zapis JSON
{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}
Pola
tableStartLocation

object (Location)

Miejsce w dokumencie, w którym zaczyna się tabela.

pinnedHeaderRowsCount

integer

Liczba wierszy tabeli do przypięcia. Wartość 0 oznacza, że wszystkie wiersze są odpięte.