Żądanie
Pojedyncza aktualizacja do zastosowania w dokumencie.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole zbiorczerequest . Konkretne żądanie, które chcesz zastosować. Wymagane jest dokładnie jedno pole.
request
może mieć tylko jedną z tych wartości:
|
|
replaceAllText
|
Zastępuje wszystkie wystąpienia określonego tekstu. |
insertText
|
Wstawia tekst w określonym miejscu. |
updateTextStyle
|
Aktualizuje styl tekstu w określonym zakresie. |
createParagraphBullets
|
Tworzy wypunktowania akapitów. |
deleteParagraphBullets
|
Usuwa wypunktowania z akapitów. |
createNamedRange
|
Tworzy zakres z nazwą. |
deleteNamedRange
|
Usuwa zakres nazwany. |
updateParagraphStyle
|
Aktualizuje styl akapitu w określonym zakresie. |
deleteContentRange
|
Usuwa zawartość z dokumentu. |
insertInlineImage
|
Wstawia obraz w tekście w określonym miejscu. |
insertTable
|
Wstawia tabelę w określonym miejscu. |
insertTableRow
|
Wstawia pusty wiersz do tabeli. |
insertTableColumn
|
Wstawia pustą kolumnę do tabeli. |
deleteTableRow
|
Usuwa wiersz z tabeli. |
deleteTableColumn
|
Usuwa kolumnę z tabeli. |
insertPageBreak
|
Wstawia podział strony w określonym miejscu. |
deletePositionedObject
|
Usuwa z dokumentu umieszczony obiekt. |
updateTableColumnProperties
|
Aktualizuje właściwości kolumn w tabeli. |
updateTableCellStyle
|
Aktualizuje styl komórek tabeli. |
updateTableRowStyle
|
Aktualizuje styl wiersza w tabeli. |
replaceImage
|
Zastępuje obraz w dokumencie. |
updateDocumentStyle
|
Aktualizuje styl dokumentu. |
mergeTableCells
|
Scala komórki w tabeli. |
unmergeTableCells
|
Cofa scalenie komórek w tabeli. |
createHeader
|
Tworzy nagłówek. |
createFooter
|
Tworzy stopkę. |
createFootnote
|
Tworzy przypis. |
replaceNamedRangeContent
|
Zastępuje zawartość w nazwanym zakresie. |
updateSectionStyle
|
Aktualizuje styl sekcji w określonym zakresie. |
insertSectionBreak
|
Wstawia podział sekcji w określonym miejscu. |
deleteHeader
|
Usuwa nagłówek z dokumentu. |
deleteFooter
|
Usuwa stopkę z dokumentu. |
pinTableHeaderRows
|
Aktualizuje liczbę przypiętych wierszy nagłówka w tabeli. |
insertPerson
|
Wstawia wzmiankę o osobie. |
ReplaceAllTextRequest
Zastępuje wszystkie wystąpienia tekstu spełniającego kryteria ciągiem replace text
.
Zapis JSON |
---|
{ "replaceText": string, "tabsCriteria": { object ( |
Pola | |
---|---|
replaceText
|
Tekst, który zastąpi dopasowany tekst. |
tabsCriteria
|
Opcjonalnie: Kryteria określające, na których kartach ma nastąpić zastąpienie. Jeśli ten parametr zostanie pominięty, zamiana zostanie zastosowana do wszystkich kart. W dokumencie zawierającym jedną kartę:
W dokumencie zawierającym wiele kart:
|
Pole zbiorczecriteria . Kryteria używane do dopasowania tekstu do zastąpienia.
criteria
może mieć tylko jedną z tych wartości:
|
|
containsText
|
Znajduje w dokumencie tekst pasujący do tego podciągu. |
SubstringMatchCriteria
Kryterium, które pasuje do określonego ciągu tekstu w dokumencie.
Zapis JSON |
---|
{ "text": string, "matchCase": boolean, "searchByRegex": boolean } |
Pola | |
---|---|
text
|
Tekst, który ma zostać wyszukany w dokumencie. |
matchCase
|
Wskazuje, czy w wyszukiwaniu ma być uwzględniana wielkość liter:
|
searchByRegex
|
Opcjonalnie: Wartość Prawda, jeśli wartość do znalezienia ma być traktowana jako wyrażenie regularne. Wzorzec nie może zawierać ukośników odwrotnych.
|
TabsCriteria
Kryterium określające, na których kartach ma być wykonywane żądanie.
Zapis JSON |
---|
{ "tabIds": [ string ] } |
Pola | |
---|---|
tabIds[]
|
Lista identyfikatorów kart, na których jest wykonywane żądanie. |
InsertTextRequest
Wstawia tekst w określonym miejscu.
Zapis JSON |
---|
{ "text": string, // Union field |
Pola | |
---|---|
text
|
Tekst do wstawienia.
Wstawienie znaku nowego wiersza spowoduje niejawne utworzenie nowego znaku Style tekstu wstawionego tekstu zostaną określone automatycznie, zwykle z zachowaniem stylu sąsiedniego tekstu. W większości przypadków styl tekstu wstawionego będzie zgodny ze stylem tekstu bezpośrednio przed indeksem wstawienia. Niektóre znaki kontrolne (U+0000–U+0008, U+000C–U+001F) i znaki z obszaru prywatnego użytku w podstawowej wielojęzycznej płaszczyźnie Unicode (U+E000–U+F8FF) zostaną usunięte z wstawionego tekstu. |
Pole zbiorczeinsertion_location . Miejsce, w którym zostanie wstawiony tekst.
insertion_location
może mieć tylko jedną z tych wartości:
|
|
location
|
Wstawia tekst w określonym indeksie w dokumencie.
Tekst musi być wstawiony w obrębie istniejącego elementu |
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
|
Identyfikator nagłówka, stopki lub przypisu, w którym znajduje się lokalizacja. Pusty identyfikator segmentu oznacza treść dokumentu. |
index
|
Indeks liczony od zera w jednostkach kodu UTF-16.
Indeks jest liczony od początku segmentu określonego przez |
tabId
|
Karta, na której znajduje się lokalizacja. Jeśli ten parametr zostanie pominięty, żądanie zostanie zastosowane do pierwszej karty. W dokumencie zawierającym jedną kartę:
W dokumencie zawierającym wiele kart:
|
EndOfSegmentLocation
Miejsce na końcu treści, nagłówka, stopki lub przypisu. Znajduje się on bezpośrednio przed ostatnim znakiem nowego wiersza w segmencie dokumentu.
Zapis JSON |
---|
{ "segmentId": string, "tabId": string } |
Pola | |
---|---|
segmentId
|
Identyfikator nagłówka, stopki lub przypisu, w którym znajduje się lokalizacja. Pusty identyfikator segmentu oznacza treść dokumentu. |
tabId
|
Karta, na której znajduje się lokalizacja. Jeśli ten parametr zostanie pominięty, żądanie zostanie zastosowane do pierwszej karty. W dokumencie zawierającym jedną kartę:
W dokumencie zawierającym wiele kart:
|
UpdateTextStyleRequest
Zaktualizuj styl tekstu.
Zapis JSON |
---|
{ "textStyle": { object ( |
Pola | |
---|---|
textStyle
|
Style, które mają zostać zastosowane do tekstu. Jeśli wartość danego stylu jest taka sama jak wartość stylu nadrzędnego, styl ten zostanie ustawiony jako dziedziczony.
Niektóre zmiany stylu tekstu mogą powodować inne zmiany, aby odzwierciedlać działanie edytora Dokumentów. Więcej informacji znajdziesz w dokumentacji |
fields
|
Pola, które należy zaktualizować.
Musisz określić co najmniej 1 pole. Katalog główny
Aby na przykład zmienić styl tekstu na pogrubiony, ustaw
Aby zresetować usługę do wartości domyślnej, uwzględnij nazwę pola w masce pola, ale pozostaw samo pole nieustawione. |
Pole zbiorczeinsertion_location . Typ zakresu, w którym zostanie zaktualizowany styl tekstu.
insertion_location
może mieć tylko jedną z tych wartości:
|
|
range
|
Zakres tekstu, do którego ma zostać zastosowany styl. Zakres można rozszerzyć, aby uwzględnić sąsiednie znaki nowego wiersza. Jeśli zakres w pełni zawiera akapit należący do listy, punktor akapitu jest również aktualizowany o pasujący styl tekstu. Nie można wstawiać zakresów w ramach względnego żądania UpdateTextStyleRequest. |
CreateParagraphBulletsRequest
Tworzy punktor dla wszystkich akapitów, które pokrywają się z podanym zakresem.
Poziom zagnieżdżenia każdego akapitu zostanie określony przez zliczenie początkowych tabulatorów przed każdym akapitem. Aby uniknąć nadmiaru miejsca między punktorem a odpowiednim akapitem, te karty wiodące są usuwane przez tę prośbę. Może to zmienić indeksy części tekstu.
Jeśli akapit bezpośrednio poprzedzający aktualizowane akapity znajduje się na liście z pasującymi gotowymi ustawieniami, aktualizowane akapity są dodawane do tej listy.
Zapis JSON |
---|
{ "range": { object ( |
Pola | |
---|---|
range
|
Zakres, do którego chcesz zastosować gotowe ustawienia punktorów. |
bulletPreset
|
Rodzaje glifów punktorów, które mają być używane. |
BulletGlyphPreset
Gotowe wzory glifów punktora dla list.
W tych wzorach używane są te rodzaje punktoró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
: pełny romb, 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
: gwiazdka odpowiadająca punktowi kodowemu Unicode U+2605 -
ALPHA
: mała litera, np. „a”, „b” lub „c”. -
UPPERALPHA
: wielka litera, np. „A”, „B” lub „C”. -
DECIMAL
: liczba, np. „1”, „2” lub „3”. -
ZERODECIMAL
: liczba, w której jednocyfrowe liczby są poprzedzone zerem, np. „01”, „02” lub „03”. Liczby składające się z więcej niż jednej cyfry nie mają zera na początku. -
ROMAN
: mała cyfra rzymska, np. „i”, „ii” lub „iii”. -
UPPERROMAN
: wielka cyfra 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
|
Gotowe ustawienia glifu punktorowego są nieokreślone. |
BULLET_DISC_CIRCLE_SQUARE
|
Lista punktowana z symbolami punktów DISC , CIRCLE i SQUARE dla pierwszych 3 poziomów zagnieżdżenia listy.
|
BULLET_DIAMONDX_ARROW3D_SQUARE
|
Lista punktowana z symbolami punktów DIAMONDX , ARROW3D i SQUARE dla pierwszych 3 poziomów zagnieżdżenia listy.
|
BULLET_CHECKBOX
|
Lista punktowana z CHECKBOX
symbolami punktów na wszystkich poziomach zagnieżdżenia.
|
BULLET_ARROW_DIAMOND_DISC
|
Lista punktowana z symbolami punktów ARROW , DIAMOND i DISC dla pierwszych 3 poziomów zagnieżdżenia listy.
|
BULLET_STAR_CIRCLE_SQUARE
|
Lista punktowana z symbolami punktów STAR , CIRCLE i SQUARE dla pierwszych 3 poziomów zagnieżdżenia listy.
|
BULLET_ARROW3D_CIRCLE_SQUARE
|
Lista punktowana z symbolami punktów ARROW3D , CIRCLE i SQUARE dla pierwszych 3 poziomów zagnieżdżenia listy.
|
BULLET_LEFTTRIANGLE_DIAMOND_DISC
|
Lista punktowana z symbolami punktów LEFTTRIANGLE , DIAMOND i DISC dla pierwszych 3 poziomów zagnieżdżenia listy.
|
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE
|
Lista punktowana z symbolami punktów DIAMONDX , HOLLOWDIAMOND i SQUARE dla pierwszych 3 poziomów zagnieżdżenia listy.
|
BULLET_DIAMOND_CIRCLE_SQUARE
|
Lista punktowana z symbolami punktów DIAMOND , CIRCLE i SQUARE dla pierwszych 3 poziomów zagnieżdżenia listy.
|
NUMBERED_DECIMAL_ALPHA_ROMAN
|
Lista numerowana z glifami numerycznymi DECIMAL , ALPHA i ROMAN dla pierwszych 3 poziomów zagnieżdżenia listy, po których następują kropki.
|
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS
|
Lista numerowana z glifami numerycznymi DECIMAL , ALPHA i ROMAN dla pierwszych 3 poziomów zagnieżdżenia listy, po których następuje nawias.
|
NUMBERED_DECIMAL_NESTED
|
Lista numerowana z
DECIMAL
glifami numerycznymi rozdzielonymi kropkami, w której każdy poziom zagnieżdżenia używa glifu z poprzedniego poziomu zagnieżdżenia jako prefiksu. Na przykład: „1.”, '1.1.', '2.', '2.2'.
|
NUMBERED_UPPERALPHA_ALPHA_ROMAN
|
Lista numerowana z glifami numerycznymi UPPERALPHA , ALPHA i ROMAN dla pierwszych 3 poziomów zagnieżdżenia listy, po których następują kropki.
|
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL
|
Lista numerowana z glifami numerycznymi UPPERROMAN , UPPERALPHA i DECIMAL dla pierwszych 3 poziomów zagnieżdżenia listy, po których następują kropki.
|
NUMBERED_ZERODECIMAL_ALPHA_ROMAN
|
Lista numerowana z glifami numerycznymi ZERODECIMAL , ALPHA i ROMAN dla pierwszych 3 poziomów zagnieżdżenia listy, po których następują kropki.
|
DeleteParagraphBulletsRequest
Usuwa punktor z wszystkich akapitów, które pokrywają się z podanym zakresem.
Poziom zagnieżdżenia każdego akapitu zostanie wizualnie zachowany przez dodanie wcięcia na początku odpowiedniego akapitu.
Zapis JSON |
---|
{
"range": {
object ( |
Pola | |
---|---|
range
|
Zakres, z którego chcesz usunąć punktor. |
CreateNamedRangeRequest
Tworzy NamedRange
odwołujący się do podanego zakresu.
Zapis JSON |
---|
{
"name": string,
"range": {
object ( |
Pola | |
---|---|
name
|
Nazwa zakresu nazwanego. Nazwy nie muszą być unikalne. Nazwy muszą mieć co najmniej 1 znak i nie więcej niż 256 znaków (mierzonych w jednostkach kodu UTF-16). |
range
|
Zakres, do którego ma być zastosowana nazwa. |
DeleteNamedRangeRequest
Usuwa NamedRange
.
Zapis JSON |
---|
{ "tabsCriteria": { object ( |
Pola | |
---|---|
tabsCriteria
|
Opcjonalnie: Kryteria używane do określania, na których kartach ma nastąpić usunięcie zakresu. Jeśli ten parametr zostanie pominięty, usunięcie zakresu zostanie zastosowane do wszystkich kart. W dokumencie zawierającym jedną kartę:
W dokumencie zawierającym wiele kart:
|
Pole zbiorczenamed_range_reference . Wartość, która określa zakresy do usunięcia. Musi być ustawiona dokładnie jedna z tych wartości.
named_range_reference
może mieć tylko jedną z tych wartości:
|
|
namedRangeId
|
Identyfikator zakresu nazwanego do usunięcia. |
name
|
Nazwa zakresów do usunięcia. Wszystkie nazwane zakresy o podanej nazwie zostaną usunięte. |
UpdateParagraphStyleRequest
Aktualizuje styl wszystkich akapitów, które pokrywają się z podanym zakresem.
Zapis JSON |
---|
{ "paragraphStyle": { object ( |
Pola | |
---|---|
paragraphStyle
|
Style, które mają być zastosowane do akapitów.
Niektóre zmiany stylu akapitu mogą powodować inne zmiany, aby odzwierciedlać działanie edytora Dokumentów. Więcej informacji znajdziesz w dokumentacji |
fields
|
Pola, które należy zaktualizować.
Musisz określić co najmniej 1 pole. Katalog główny
Aby na przykład zaktualizować właściwość wyrównania stylu akapitu, ustaw
Aby zresetować usługę do wartości domyślnej, uwzględnij nazwę pola w masce pola, ale pozostaw samo pole nieustawione. |
Pole zbiorczeinsertion_location . Typ zakresu, w którym styl akapitu zostanie zaktualizowany.
insertion_location
może mieć tylko jedną z tych wartości:
|
|
range
|
Zakres nakładający się na akapity, które mają zostać sformatowane. |
DeleteContentRangeRequest
Usuwa zawartość z dokumentu.
Zapis JSON |
---|
{
"range": {
object ( |
Pola | |
---|---|
range
|
Zakres treści do usunięcia. Usunięcie tekstu, który przekracza granicę akapitu, może spowodować zmiany w stylach akapitów, listach, obiektach umieszczonych i zakładkach, ponieważ 2 akapity zostaną połączone. Próba usunięcia niektórych zakresów może spowodować nieprawidłową strukturę dokumentu, w którym to przypadku zwracany jest błąd 400 (Nieprawidłowe żądanie). Przykłady nieprawidłowych żądań usunięcia:
|
InsertInlineImageRequest
Wstawia element InlineObject
zawierający obraz w podanej lokalizacji.
Zapis JSON |
---|
{ "uri": string, "objectSize": { object ( |
Pola | |
---|---|
uri
|
Identyfikator URI obrazu. Obraz jest pobierany raz w momencie wstawienia, a jego kopia jest przechowywana do wyświetlania w dokumencie. Obrazy muszą mieć rozmiar mniejszy niż 50 MB, nie mogą przekraczać 25 megapikseli i muszą być w jednym z tych formatów: PNG, JPEG lub GIF.
Podany identyfikator URI musi być dostępny publicznie i mieć długość maksymalnie 2 KB. Sam identyfikator URI jest zapisywany z obrazem i udostępniany w polu
|
objectSize
|
Rozmiar, w jakim obraz powinien być wyświetlany w dokumencie. Ta właściwość jest opcjonalna, a ostateczny rozmiar obrazu w dokumencie jest określany na podstawie tych reguł: * Jeśli nie określono szerokości ani wysokości, domyślny rozmiar obrazu jest obliczany na podstawie jego rozdzielczości. * Jeśli podasz jeden wymiar, drugi zostanie obliczony tak, aby zachować współczynnik proporcji obrazu. * Jeśli podano zarówno szerokość, jak i wysokość, obraz jest skalowany tak, aby mieścił się w podanych wymiarach przy zachowaniu współczynnika proporcji. |
Pole zbiorczeinsertion_location . Miejsce, w którym zostanie wstawiony obraz.
insertion_location
może mieć tylko jedną z tych wartości:
|
|
location
|
Wstawia obraz w określonym indeksie w dokumencie.
Obraz musi być wstawiony w granicach istniejącego elementu Obrazów w tekście nie można wstawiać w przypisach ani równaniach. |
endOfSegmentLocation
|
Wstawia tekst na końcu nagłówka, stopki lub treści dokumentu. Obrazów w tekście nie można wstawiać w przypisach. |
InsertTableRequest
Wstawia tabelę w określonym miejscu.
Przed wstawioną tabelą zostanie wstawiony znak nowego wiersza.
Zapis JSON |
---|
{ "rows": integer, "columns": integer, // Union field |
Pola | |
---|---|
rows
|
Liczba wierszy w tabeli. |
columns
|
Liczba kolumn w tabeli. |
Pole zbiorczeinsertion_location . Miejsce, w którym zostanie wstawiona tabela.
insertion_location
może mieć tylko jedną z tych wartości:
|
|
location
|
Wstawia tabelę w określonym indeksie modelu. Przed wstawioną tabelą zostanie wstawiony znak nowego wiersza, więc indeks początku tabeli będzie równy indeksowi określonej lokalizacji + 1.
Tabela musi być wstawiona w obrębie istniejącego elementu Tabel nie można wstawiać w przypisach ani równaniach. |
endOfSegmentLocation
|
Wstawia tabelę na końcu danego nagłówka, stopki lub treści dokumentu. Przed wstawioną tabelą zostanie wstawiony znak nowego wiersza. Nie można wstawiać tabel w przypisach. |
InsertTableRowRequest
Wstawia pusty wiersz do tabeli.
Zapis JSON |
---|
{
"tableCellLocation": {
object ( |
Pola | |
---|---|
tableCellLocation
|
Lokalizacja komórki tabeli odniesienia, z której zostaną wstawione wiersze. Nowy wiersz zostanie wstawiony powyżej (lub poniżej) wiersza, w którym znajduje się komórka odniesienia. Jeśli komórka odniesienia jest scaloną komórką, nowy wiersz zostanie wstawiony powyżej (lub poniżej) scalonej komórki. |
insertBelow
|
Określa, czy nowy wiersz ma zostać wstawiony poniżej komórki odniesienia.
|
TableCellLocation
Lokalizacja pojedynczej komórki w tabeli.
Zapis JSON |
---|
{
"tableStartLocation": {
object ( |
Pola | |
---|---|
tableStartLocation
|
Miejsce, w którym tabela zaczyna się w dokumencie. |
rowIndex
|
Indeks wiersza liczony od zera. Na przykład drugi wiersz w tabeli ma indeks 1. |
columnIndex
|
Indeks kolumny liczony od zera. Na przykład druga kolumna w tabeli ma indeks kolumny 1. |
InsertTableColumnRequest
Wstawia pustą kolumnę do tabeli.
Zapis JSON |
---|
{
"tableCellLocation": {
object ( |
Pola | |
---|---|
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 scaloną komórką, nowa kolumna zostanie wstawiona po lewej (lub prawej) stronie scalonej komórki. |
insertRight
|
Określa, czy nowa kolumna ma zostać wstawiona po prawej stronie komórki odniesienia.
|
DeleteTableRowRequest
Usuwa wiersz z tabeli.
Zapis JSON |
---|
{
"tableCellLocation": {
object ( |
Pola | |
---|---|
tableCellLocation
|
Lokalizacja komórki tabeli odniesienia, z której zostanie usunięty wiersz. Wiersz, w którym znajduje się ta komórka, zostanie usunięty. Jeśli jest to scalona komórka obejmująca kilka wierszy, zostaną usunięte wszystkie wiersze, które obejmuje ta komórka. Jeśli po usunięciu w tabeli nie pozostaną żadne wiersze, cała tabela zostanie usunięta. |
DeleteTableColumnRequest
Usuwa kolumnę z tabeli.
Zapis JSON |
---|
{
"tableCellLocation": {
object ( |
Pola | |
---|---|
tableCellLocation
|
Lokalizacja komórki tabeli odniesienia, z której zostanie usunięta kolumna. Kolumna, w której znajduje się ta komórka, zostanie usunięta. Jeśli jest to scalona komórka obejmująca kilka kolumn, zostaną usunięte wszystkie kolumny, które obejmuje ta komórka. Jeśli po usunięciu kolumn w tabeli nie pozostaną żadne kolumny, cała tabela zostanie usunięta. |
InsertPageBreakRequest
Wstawia w określonym miejscu podział strony, a po nim znak nowego wiersza.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole zbiorczeinsertion_location . Miejsce, w którym zostanie wstawiony podział strony.
insertion_location
może mieć tylko jedną z tych wartości:
|
|
location
|
Wstawia podział strony w określonym indeksie w dokumencie.
Podział strony musi być wstawiony w obrębie istniejącego elementu
Podziałów stron nie można wstawiać w tabeli, równaniu, przypisie, nagłówku ani stopce. Podziały stron można wstawiać tylko w treści, więc pole |
endOfSegmentLocation
|
Wstawia podział strony na końcu treści dokumentu.
Podziałów stron nie można wstawiać w przypisach, nagłówkach ani stopkach. Podziały stron można wstawiać tylko w treści, więc pole |
DeletePositionedObjectRequest
Usuwa z dokumentu element PositionedObject
.
Zapis JSON |
---|
{ "objectId": string, "tabId": string } |
Pola | |
---|---|
objectId
|
Identyfikator obiektu umieszczonego w określonym miejscu, który ma zostać usunięty. |
tabId
|
Karta, na której znajduje się obiekt do usunięcia. Jeśli ten parametr zostanie pominięty, żądanie zostanie zastosowane do pierwszej karty. W dokumencie zawierającym jedną kartę:
W dokumencie zawierającym wiele kart:
|
UpdateTableColumnPropertiesRequest
Aktualizuje TableColumnProperties
kolumn w tabeli.
Zapis JSON |
---|
{ "tableStartLocation": { object ( |
Pola | |
---|---|
tableStartLocation
|
Miejsce, w którym tabela zaczyna się w dokumencie. |
columnIndices[]
|
Lista indeksów kolumn (liczonych od zera), których właściwości mają zostać zaktualizowane. Jeśli nie podasz żadnych indeksów, wszystkie kolumny zostaną zaktualizowane. |
tableColumnProperties
|
Właściwości kolumny tabeli do zaktualizowania.
Jeśli wartość |
fields
|
Pola, które należy zaktualizować.
Musisz określić co najmniej 1 pole. Katalog główny
Aby na przykład zaktualizować szerokość kolumny, ustaw wartość
|
UpdateTableCellStyleRequest
Aktualizuje styl zakresu komórek tabeli.
Zapis JSON |
---|
{ "tableCellStyle": { object ( |
Pola | |
---|---|
tableCellStyle
|
Styl, który ma zostać zastosowany do komórek 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 również zostanie zaktualizowana. Scalone i niewidoczne obramowania nie są aktualizowane. Aktualizowanie obramowania współdzielonego przez sąsiednie komórki w tym samym żądaniu może powodować sprzeczne aktualizacje obramowania, dlatego aktualizacje obramowania są stosowane w tej kolejności:
|
fields
|
Pola, które należy zaktualizować.
Musisz określić co najmniej 1 pole. Katalog główny
Aby na przykład zaktualizować kolor tła komórki tabeli, ustaw
Aby zresetować usługę do wartości domyślnej, uwzględnij nazwę pola w masce pola, ale pozostaw samo pole nieustawione. |
Pole zbiorczecells . Komórki, które zostaną zaktualizowane.
cells
może mieć tylko jedną z tych wartości:
|
|
tableRange
|
Zakres tabeli reprezentujący podzbiór tabeli, do którego stosowane są aktualizacje. |
tableStartLocation
|
Miejsce, w którym tabela zaczyna się w dokumencie. Jeśli zostanie określony, zmiany 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, row = 0, column = 0), rozpiętość wierszy = 3 i rozpiętość kolumn = 2 określa te komórki:
[ x ][ x ][ ]
[ x ][ x ][ ]
[ x x x ]
Zapis JSON |
---|
{
"tableCellLocation": {
object ( |
Pola | |
---|---|
tableCellLocation
|
Lokalizacja komórki, w której zaczyna się zakres tabeli. |
rowSpan
|
Zakres wierszy zakresu tabeli. |
columnSpan
|
Zakres kolumn zakresu tabeli. |
UpdateTableRowStyleRequest
Aktualizuje TableRowStyle
wierszy w tabeli.
Zapis JSON |
---|
{ "tableStartLocation": { object ( |
Pola | |
---|---|
tableStartLocation
|
Miejsce, w którym tabela zaczyna się w dokumencie. |
rowIndices[]
|
Lista indeksów wierszy (liczonych od zera), których styl ma zostać zaktualizowany. Jeśli nie podasz żadnych indeksów, wszystkie wiersze zostaną zaktualizowane. |
tableRowStyle
|
Style, które mają być zastosowane do wierszy. |
fields
|
Pola, które należy zaktualizować.
Musisz określić co najmniej 1 pole. Katalog główny
Aby na przykład zaktualizować minimalną wysokość wiersza, ustaw
|
ReplaceImageRequest
Zastępuje istniejący obraz nowym.
Zastąpienie obrazu powoduje usunięcie niektórych elementówimage effects
z dotychczasowego obrazu, aby odzwierciedlić działanie edytora Dokumentów.
Zapis JSON |
---|
{
"imageObjectId": string,
"uri": string,
"imageReplaceMethod": enum ( |
Pola | |
---|---|
imageObjectId
|
Identyfikator istniejącego obrazu, który zostanie zastąpiony. Identyfikator można pobrać z odpowiedzi na żądanie GET. |
uri
|
Identyfikator URI nowego obrazu. Obraz jest pobierany raz w momencie wstawienia, a jego kopia jest przechowywana do wyświetlania w dokumencie. Obrazy muszą mieć rozmiar mniejszy niż 50 MB, nie mogą mieć więcej niż 25 megapikseli i muszą być w formacie PNG, JPEG lub GIF.
Podany identyfikator URI nie może przekraczać 2 KB. Identyfikator URI jest zapisywany z obrazem i udostępniany w polu |
imageReplaceMethod
|
Metoda zastępowania. |
tabId
|
Karta, na której znajduje się obraz do zastąpienia. Jeśli ten parametr zostanie pominięty, żądanie zostanie zastosowane do pierwszej karty. W dokumencie zawierającym jedną kartę:
W dokumencie zawierającym wiele kart:
|
ImageReplaceMethod
Metoda zastępowania obrazu.
Wartości w polu enum | |
---|---|
IMAGE_REPLACE_METHOD_UNSPECIFIED
|
Nieokreślona metoda zastępowania obrazu. Nie można użyć 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 oryginalnego obrazu. |
UpdateDocumentStyleRequest
Aktualizuje DocumentStyle
.
Zapis JSON |
---|
{
"documentStyle": {
object ( |
Pola | |
---|---|
documentStyle
|
Style, które mają zostać zastosowane w dokumencie.
Niektóre zmiany stylu dokumentu mogą powodować inne zmiany, aby odzwierciedlać działanie edytora Dokumentów. Więcej informacji znajdziesz w dokumentacji |
fields
|
Pola, które należy zaktualizować.
Musisz określić co najmniej 1 pole. Katalog główny
Aby na przykład zaktualizować tło, ustaw
|
tabId
|
Karta zawierająca styl do zaktualizowania. Jeśli ten parametr zostanie pominięty, żądanie będzie dotyczyć pierwszej karty. W dokumencie zawierającym jedną kartę:
W dokumencie zawierającym wiele kart:
|
MergeTableCellsRequest
Scala komórki w zakresie Table
.
Zapis JSON |
---|
{
"tableRange": {
object ( |
Pola | |
---|---|
tableRange
|
Zakres tabeli określający, które komórki tabeli mają zostać scalone. Tekst w scalanych komórkach zostanie połączony i zapisany w komórce „głównej” zakresu. Jest to lewa górna komórka zakresu, gdy kierunek treści jest od lewej do prawej, a w przeciwnym razie jest to prawa górna komórka zakresu. Jeśli zakres nie jest prostokątny (co może się zdarzyć w niektórych przypadkach, gdy zakres obejmuje komórki, które są już scalone, lub gdy tabela nie jest prostokątna), zwracany jest błąd 400. |
UnmergeTableCellsRequest
Rozdziela komórki w Table
.
Zapis JSON |
---|
{
"tableRange": {
object ( |
Pola | |
---|---|
tableRange
|
Zakres tabeli określający, które komórki tabeli mają zostać rozdzielone. Wszystkie scalone komórki w tym zakresie zostaną rozdzielone, a komórki, które są już rozdzielone, pozostaną bez zmian. Jeśli zakres nie zawiera scalonych komórek, żądanie nie zostanie zrealizowane. Jeśli w którejkolwiek ze scalonych komórek znajduje się tekst, pozostanie on w komórce „głównej” w powstałym bloku niescalonych komórek. Komórka „nagłówka” to lewa górna komórka, gdy kierunek treści jest od lewej do prawej, a w przeciwnym razie prawa górna. |
CreateHeaderRequest
Tworzy Header
. Nowy nagłówek jest stosowany do elementu SectionStyle
w lokalizacji elementu SectionBreak
, jeśli jest określony. W przeciwnym razie jest stosowany do elementu DocumentStyle
.
Jeśli nagłówek określonego typu już istnieje, zwracany jest błąd 400 (nieprawidłowe żądanie).
Zapis JSON |
---|
{ "type": enum ( |
Pola | |
---|---|
type
|
Typ nagłówka do utworzenia. |
sectionBreakLocation
|
Lokalizacja elementu |
CreateFootnoteRequest
Tworzy segment i wstawia do niego nowy element w podanej lokalizacji.Footnote
FootnoteReference
Nowy segment Footnote
będzie zawierać spację, a po niej znak nowego wiersza.
Zapis JSON |
---|
{ // Union field |
Pola | |
---|---|
Pole zbiorczefootnote_reference_location . Miejsce wstawienia odwołania do przypisu.
footnote_reference_location
może mieć tylko jedną z tych wartości:
|
|
location
|
Wstawia odwołanie do przypisu w określonym indeksie w dokumencie.
Odwołanie do przypisu musi zostać wstawione w obrębie istniejącego elementu
Odwołań do przypisów nie można wstawiać w równaniach, nagłówkach, stopkach ani przypisach. Ponieważ odwołania do przypisów można wstawiać tylko w treści, pole |
endOfSegmentLocation
|
Wstawia odwołanie do przypisu na końcu treści dokumentu.
Odwołań do przypisów nie można wstawiać w nagłówku, stopce ani przypisie. Ponieważ odwołania do przypisów można wstawiać tylko w treści, pole |
ReplaceNamedRangeContentRequest
Zastępuje zawartość określonego elementu NamedRange
lub NamedRanges
podaną treścią zastępczą.
Pamiętaj, że pojedynczy
NamedRange
może składać się z wielu nieciągłych
ranges
. W tym przypadku zastąpiona zostanie tylko treść w pierwszym zakresie. Pozostałe zakresy i ich zawartość zostaną usunięte.
Jeśli zastąpienie lub usunięcie jakichkolwiek zakresów spowodowałoby nieprawidłową strukturę dokumentu, zwracany jest błąd 400 (Nieprawidłowe żądanie).
Zapis JSON |
---|
{ "tabsCriteria": { object ( |
Pola | |
---|---|
tabsCriteria
|
Opcjonalnie: Kryteria określające, na których kartach ma nastąpić zastąpienie. Jeśli ten parametr zostanie pominięty, zamiana zostanie zastosowana do wszystkich kart. W dokumencie zawierającym jedną kartę:
W dokumencie zawierającym wiele kart:
|
Pole zbiorczereplacement_content . Treść, którą chcesz zastąpić istniejącą treść w nazwanym zakresie.
replacement_content
może mieć tylko jedną z tych wartości:
|
|
text
|
Zastępuje zawartość określonych nazwanych zakresów podanym tekstem. |
Pole zbiorczenamed_range_reference . Odwołanie do nazwanych zakresów, których zawartość zostanie zastąpiona.
named_range_reference
może mieć tylko jedną z tych wartości:
|
|
namedRangeId
|
Identyfikator nazwanego zakresu, którego zawartość zostanie zastąpiona. Jeśli nie ma nazwanego zakresu o podanym identyfikatorze, zwracany jest błąd 400 (nieprawidłowe żądanie). |
namedRangeName
|
Nazwa
Jeśli istnieje kilka plików |
UpdateSectionStyleRequest
Aktualizuje SectionStyle
.
Zapis JSON |
---|
{ "range": { object ( |
Pola | |
---|---|
range
|
Zakres nakładający się na sekcje, które mają zostać ostylowane.
Podziały sekcji można wstawiać tylko w treści, więc pole |
sectionStyle
|
Style, które mają być ustawione w sekcji.
Niektóre zmiany stylu sekcji mogą powodować inne zmiany, aby odzwierciedlać działanie edytora Dokumentów. Więcej informacji znajdziesz w dokumentacji |
fields
|
Pola, które należy zaktualizować.
Musisz określić co najmniej 1 pole. Element główny
Aby na przykład zaktualizować lewy margines, ustaw wartość |
InsertSectionBreakRequest
Wstawia podział sekcji w danym miejscu.
Przed podziałem sekcji zostanie wstawiony znak nowego wiersza.
Zapis JSON |
---|
{ "sectionType": enum ( |
Pola | |
---|---|
sectionType
|
Typ sekcji do wstawienia. |
Pole zbiorczeinsertion_location . Miejsce, w którym zostanie wstawiona przerwa.
insertion_location
może mieć tylko jedną z tych wartości:
|
|
location
|
Wstawia znak nowego wiersza i podział sekcji w określonym indeksie w dokumencie.
Podział sekcji musi zostać wstawiony w obrębie istniejącego elementu
Podziałów sekcji nie można wstawiać w tabeli, równaniu, przypisie, nagłówku ani stopce. Podziały sekcji można wstawiać tylko w treści, więc pole |
endOfSegmentLocation
|
Wstawia znak nowego wiersza i podział sekcji na końcu treści dokumentu.
Podziałów sekcji nie można wstawiać w przypisach, nagłówkach ani stopkach. Podziały sekcji można wstawiać tylko w treści, więc pole |
DeleteHeaderRequest
Usuwa z dokumentu element Header
.
Zapis JSON |
---|
{ "headerId": string, "tabId": string } |
Pola | |
---|---|
headerId
|
Identyfikator nagłówka do usunięcia. Jeśli ten nagłówek jest zdefiniowany w |
tabId
|
Karta zawierająca nagłówek do usunięcia. Jeśli ten parametr zostanie pominięty, żądanie zostanie zastosowane do pierwszej karty. W dokumencie zawierającym jedną kartę:
W dokumencie zawierającym wiele kart:
|
PinTableHeaderRowsRequest
Aktualizuje liczbę przypiętych wierszy nagłówka tabeli.
Zapis JSON |
---|
{
"tableStartLocation": {
object ( |
Pola | |
---|---|
tableStartLocation
|
Miejsce, w którym tabela zaczyna się w dokumencie. |
pinnedHeaderRowsCount
|
Liczba wierszy tabeli do przypięcia, gdzie 0 oznacza, że wszystkie wiersze są odpięte. |
InsertPersonRequest
Wstawia wzmiankę o osobie.
Zapis JSON |
---|
{ "personProperties": { object ( |
Pola | |
---|---|
personProperties
|
Właściwości wzmianki o osobie do wstawienia. |
Pole zbiorczeinsertion_location . Lokalizacja, w której zostanie wstawiona wzmianka o osobie.
insertion_location
może mieć tylko jedną z tych wartości:
|
|
location
|
Wstawia wzmiankę o osobie w określonym indeksie w dokumencie.
Wzmianka o osobie musi być umieszczona w obrębie istniejącego elementu Wzmianek o osobach nie można wstawiać w równaniach. |
endOfSegmentLocation
|
Wstawia wzmiankę o osobie na końcu nagłówka, stopki, przypisu lub treści dokumentu. |