Requests

Żądanie

Pojedyncza aktualizacja, która zostanie zastosowana w dokumencie.

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 sumy: request. Konkretna prośba. Wymagane jest dokładnie jedno pole. request moż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)

Aktualizuje styl tekstu w określonym zakresie.

createParagraphBullets

object (CreateParagraphBulletsRequest)

Tworzenie punktorów dla akapitów.

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

Usunięcie punktorów 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)

Usunięcie treści z dokumentu.

insertInlineImage

object (InsertInlineImageRequest)

Wstawia obraz w treści w określonej lokalizacji.

insertTable

object (InsertTableRequest)

Wstawia tabelę w określonej lokalizacji.

insertTableRow

object (InsertTableRowRequest)

Wstawia pusty wiersz do tabeli.

insertTableColumn

object (InsertTableColumnRequest)

Wstawia do tabeli pustą kolumnę.

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 pozycjonowany obiekt z dokumentu.

updateTableColumnProperties

object (UpdateTableColumnPropertiesRequest)

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

updateTableCellStyle

object (UpdateTableCellStyleRequest)

Aktualizuje styl komórek tabeli.

updateTableRowStyle

object (UpdateTableRowStyleRequest)

Aktualizuje styl wiersza w tabeli.

replaceImage

object (ReplaceImageRequest)

Zastępuje obraz w dokumencie.

updateDocumentStyle

object (UpdateDocumentStyleRequest)

Aktualizuje styl dokumentu.

mergeTableCells

object (MergeTableCellsRequest)

Scala komórki w tabeli.

unmergeTableCells

object (UnmergeTableCellsRequest)

Rozdziela 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 określonego zakresu.

insertSectionBreak

object (InsertSectionBreakRequest)

Wstawia podział sekcji w określonej lokalizacji.

deleteHeader

object (DeleteHeaderRequest)

Usuwa nagłówek z dokumentu.

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

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

Zastąp cały tekst

Zastępuje wszystkie wystąpienia tekstu pasującego do replace text.

Zapis JSON 
{
  "replaceText": string,

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

string

Tekst, który zastąpi dopasowany tekst.

Pole sumy: criteria. Kryteria dopasowania tekstu do zastąpienia. criteria może być tylko jedną z tych wartości:
containsText

object (SubstringMatchCriteria)

Znajduje w dokumencie tekst pasujący do tego podłańcucha.

Kryteria dopasowania podrzędnego

Kryteria pasujące do konkretnego ciągu tekstowego w dokumencie

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

string

Tekst do wyszukania w dokumencie.

matchCase

boolean

Wskazuje, czy wyszukiwanie powinno brać pod uwagę wielkość liter:

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

Żądanie TextText

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 do wstawienia.

Wstawianie nowego wiersza spowoduje automatyczne utworzenie w tym indeksie nowego obiektu Paragraph. Akapit nowego akapitu zostanie skopiowany z akapitu do bieżącego indeksu wstawiania, włącznie z listami i punktami.

Style tekstu wstawionego tekstu będą określane automatycznie z zachowaniem stylu sąsiadującego tekstu. W większości przypadków styl wstawionego tekstu będzie pasował do tekstu tuż przed indeksem.

Niektóre znaki kontrolne (U+0000-U+0008, U+000C-U+001F) i znaki z prywatnego obszaru wielojęzycznego Unicode (U+E000-U+F8FF) zostaną usunięte z wstawionego tekstu.

Pole sumy: insertion_location. Lokalizacja, w której zostanie wstawiony tekst. insertion_location może być tylko jedną z tych wartości:
location

object (Location)

Wstawia tekst o określonym indeksie w dokumencie.

Tekst musi być umieszczony w granicach istniejącego zasobu Paragraph. Na przykład tekstu nie można wstawić do indeksu początkowego tabeli (tj. między tabelą a poprzednim akapitem). Tekst należy wstawić w poprzednim akapicie.

endOfSegmentLocation

object (EndOfSegmentLocation)

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

Lokalizacja

Określona lokalizacja w dokumencie.

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

string

Identyfikator nagłówka, stopki lub przypisu, do którego należy lokalizacja. Pusty identyfikator segmentu oznacza treść dokumentu.

index

integer

Indeks oparty na wartości zero w jednostkach kodu UTF-16.

Indeks jest zależny od początku segmentu określonego przez segmentId.

LokalizacjaKoniec Segmentu

Lokalizacja na końcu treści, nagłówka, stopki lub przypisu Lokalizacja znajduje się tuż przed ostatnim wierszem w segmencie dokumentów.

Zapis JSON 
{
  "segmentId": string
}
Pola
segmentId

string

Identyfikator nagłówka, stopki lub przypisu, do którego należy lokalizacja. Pusty identyfikator segmentu oznacza treść dokumentu.

Żądanie TextTextStyle

Zaktualizuj 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 służące do ustawiania tekstu.

Jeśli wartość danego stylu odpowiada wartości stylu nadrzędnego, zostanie on ustawiony jako dziedziczony.

Niektóre zmiany stylu tekstu mogą powodować inne zmiany w celu powielania działania 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 jedno pole. Pierwiastek textStyle jest domniemany i nie powinien być określony. Pojedyncza właściwość "*" może służyć jako krótka lista usług.

Aby na przykład zaktualizować pogrubienie tekstu, ustaw fields na "bold".

Aby zresetować właściwość do wartości domyślnej, wpisz nazwę pola maski, ale pozostaw to pole puste.

Pole sumy: insertion_location. Typ zakresu, w którym zostanie zaktualizowany styl tekstu. insertion_location może być tylko jedną z tych wartości:
range

object (Range)

Zakres tekstu do dostosowania.

Zakres można rozszerzyć na sąsiednie wiersze.

Jeśli zakres zawiera pełny akapit znajdujący się na liście, do informacji o punkcie akapitu zostanie dodany pasujący styl.

Nie można wstawiać zakresów do względnego obiektu TextTextStyleRequest.

Utwórz żądanie listy akapitów

tworzy punktory dla wszystkich akapitów, które nakładają się na dany zakres.

Poziom zagnieżdżania każdego akapitu jest określany na podstawie liczby wiodących kart na początku każdego akapitu. Aby uniknąć nadmiernego odstępu między akapitem a odpowiednim akapitem, żądanie spowoduje usunięcie tych wiodących kart. Może to zmienić indeksy fragmentów tekstu.

Jeśli akapit bezpośrednio przed aktualizowanymi akapitami znajduje się na liście z pasującymi gotowymi akapitami, aktualizowane są akapity do tej listy.

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

object (Range)

Zakres, w którym chcesz zastosować gotowe ustawienia punktora.

bulletPreset

enum (BulletGlyphPreset)

Rodzaje glifów punktorowych do użycia.

Punktor Glif

Gotowe wzorce glifów punktorowych na listach.

Wzorce używają tego rodzaju punktorów:

  • ARROW : strzałka odpowiadająca kodowi Unicode U+2794.
  • ARROW3D : strzałka z cieniowaniem 3D odpowiadający punktowi kodu Unicode U+27a2.
  • CHECKBOX: pusty punkt oznaczający punkt kodowy Unicode U+274f.
  • CIRCLE: puste kółko odpowiadające punktowi kodowemu Unicode U+25cb.
  • DIAMOND: : stały romb odpowiadający punktowi kodu Unicode U+25c6
  • DIAMONDX: romb z literą „x” odpowiadającą kodowi Unicode U+2756
  • HOLLOWDIAMOND: pusty romb, odpowiadający kodowi Unicode U+25c7
  • DISC: stałe kółko odpowiadające punktowi kodu Unicode U+25cf
  • SQUARE: stały kwadrat odpowiadający punktowi kodu Unicode U+25a0
  • STAR : gwiazdka odpowiadająca kodowi 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 liczby pojedyncze są poprzedzone zerem, np. „01”, „02” lub „03”. Numery z więcej niż jedną cyfrą nie są poprzedzone zerem.
  • ROMAN : mała rzymska cyfra, np. „i”, „ii” lub „iii”.
  • UPPERROMAN : cyfra rzymska zapisana wielkimi literami, np. „I”, „II” lub „III”.
  • LEFTTRIANGLE: trójkąt skierowany w lewo odpowiadający punktowi kodu Unicode U+25c4
Wartości w polu enum
BULLET_GLYPH_PRESET_UNSPECIFIED Gotowe ustawienia glifu punktora nie zostały określone.
BULLET_DISC_CIRCLE_SQUARE Lista z kropkami DISC, CIRCLE i SQUARE w przypadku 3 pierwszych poziomów zagnieżdżania listy.
BULLET_DIAMONDX_ARROW3D_SQUARE Lista z kropkami DIAMONDX, ARROW3D i SQUARE w przypadku 3 pierwszych poziomów zagnieżdżania listy.
BULLET_CHECKBOX Lista punktowana z glifami CHECKBOX na wszystkich poziomach zagnieżdżania listy.
BULLET_ARROW_DIAMOND_DISC Lista z kropkami ARROW, DIAMOND i DISC w przypadku 3 pierwszych poziomów zagnieżdżania listy.
BULLET_STAR_CIRCLE_SQUARE Lista z kropkami STAR, CIRCLE i SQUARE w przypadku 3 pierwszych poziomów zagnieżdżania listy.
BULLET_ARROW3D_CIRCLE_SQUARE Lista z kropkami ARROW3D, CIRCLE i SQUARE w przypadku 3 pierwszych poziomów zagnieżdżania listy.
BULLET_LEFTTRIANGLE_DIAMOND_DISC Lista z kropkami LEFTTRIANGLE, DIAMOND i DISC w przypadku 3 pierwszych poziomów zagnieżdżania listy.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE Lista z kropkami DIAMONDX, HOLLOWDIAMOND i SQUARE w przypadku 3 pierwszych poziomów zagnieżdżania listy.
BULLET_DIAMOND_CIRCLE_SQUARE Lista z kropkami DIAMOND, CIRCLE i SQUARE w przypadku 3 pierwszych poziomów zagnieżdżania listy.
NUMBERED_DECIMAL_ALPHA_ROMAN Lista numerowana z DECIMAL, ALPHA i ROMAN glifami liczbowymi dla pierwszych 3 poziomów zagnieżdżania listy, po których następuje kropki.
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS Lista numerowana z DECIMAL, ALPHA i ROMAN glifami liczbowymi dla pierwszych 3 poziomów zagnieżdżania listy, po których następuje nawias.
NUMBERED_DECIMAL_NESTED Lista numerowana z DECIMAL glifami liczbowymi rozdzielonymi kropkami, gdzie każdy poziom zagnieżdżania używa prefiksu glifu poziomu etapu jako jego prefiksu. Na przykład: '1., '1,1.', '2.', „2.2”.
NUMBERED_UPPERALPHA_ALPHA_ROMAN Lista numerowana z UPPERALPHA, ALPHA i ROMAN glifami liczbowymi dla pierwszych 3 poziomów zagnieżdżania listy, po których następuje kropki.
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL Lista numerowana z UPPERROMAN, UPPERALPHA i DECIMAL glifami liczbowymi dla pierwszych 3 poziomów zagnieżdżania listy, po których następuje kropki.
NUMBERED_ZERODECIMAL_ALPHA_ROMAN Lista numerowana z ZERODECIMAL, ALPHA i ROMAN glifami liczbowymi dla pierwszych 3 poziomów zagnieżdżania listy, po których następuje kropki.

Prośba o usunięcie akapitu

Usunięcie punktorów ze wszystkich akapitów, które nakładają się na dany zakres.

Poziom zagnieżdżenia każdego akapitu zostanie zachowany wizualnie, dodając wcięcie na początku odpowiedniego akapitu.

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

object (Range)

Zakres, z którego chcesz usunąć punktory.

Żądanie CreateNamedRange

Tworzy NamedRange, który odwołuje się do podanego zakresu.

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

string

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

Nazwy muszą składać się z co najmniej 1 znaku i nie mogą mieć więcej niż 256 znaków mierzone w jednostkach kodu UTF-16.

range

object (Range)

Zakres, w którym chcesz zastosować nazwę.

Żądanie deleteNamedRange

Usuwa NamedRange.

Zapis JSON 
{

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "name": string
  // End of list of possible types for union field named_range_reference.
}
Pola
Pole sumy: named_range_reference. Wartość określająca zakres lub zakresy do usunięcia. Należy ustawić dokładnie jedną wartość. named_range_reference może być tylko jedną z tych wartości:
namedRangeId

string

Identyfikator zakresu nazwanego do usunięcia.

name

string

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

Żądanie UpdateParagraphStyle

Zaktualizuj styl wszystkich akapitów, które nakładają się na dany zakres.

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 do akapitów.

Niektóre zmiany stylu akapitu mogą powodować inne zmiany odzwierciedlające zachowanie edytora Dokumentów. Więcej informacji znajdziesz w dokumentacji ParagraphStyle.

fields

string (FieldMask format)

Pola, które należy zaktualizować.

Musisz określić co najmniej jedno pole. Pierwiastek paragraphStyle jest domniemany i nie powinien być określony. Pojedyncza właściwość "*" może służyć jako krótka lista usług.

Aby na przykład zaktualizować właściwość dopasowania stylu akapitu, ustaw fields na "alignment".

Aby zresetować właściwość do wartości domyślnej, wpisz nazwę pola maski, ale pozostaw to pole puste.

Pole sumy: insertion_location. Typ zakresu, w którym zostanie zaktualizowany styl akapitu. insertion_location może być tylko jedną z tych wartości:
range

object (Range)

Zakres nakładający się na akapity.

Prośba o usunięcie treści

Usunięcie treści z dokumentu.

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

object (Range)

Zakres treści do usunięcia.

Usunięcie tekstu przekraczającego granicę akapitu może spowodować zmianę stylów akapitu, list, rozmieszczonych obiektów i zakładek podczas łączenia obu akapitów.

Próba usunięcia niektórych zakresów może spowodować nieprawidłową strukturę dokumentu. W takim przypadku zwracany jest błąd 400 – nieprawidłowe żądanie.

Oto kilka przykładów nieprawidłowych żądań usunięcia:

Wstaw obraz w tekście

Wstawia InlineObject zawierający obraz w określonej 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 podczas wstawiania i jest kopiowana do wyświetlania w dokumencie. Obrazy muszą być mniejsze niż 50 MB, nie mogą przekraczać 25 megapikseli i mieć format PNG, JPEG lub GIF.

Podany identyfikator URI musi być dostępny publicznie i mieć maksymalnie 2 kB. Identyfikator URI jest zapisywany z obrazem i dostępny za pomocą pola ImageProperties.content_uri.

objectSize

object (Size)

Rozmiar, jaki powinien mieć obraz. Ta właściwość jest opcjonalna, a końcowy rozmiar obrazu w dokumencie jest określany zgodnie z tymi regułami: * Jeśli nie określono szerokości i wysokości, domyślny rozmiar obrazu jest obliczany na podstawie jego rozdzielczości. * Jeśli określisz jeden rozmiar, drugi zostanie obliczony w celu zachowania współczynnika proporcji obrazu. * Jeśli określono zarówno szerokość, jak i wysokość, obraz jest skalowany tak, aby pasował do podanych wymiarów, zachowując jego współczynnik proporcji.

Pole sumy: insertion_location. Lokalizacja, w której zostanie wstawiony obraz. insertion_location może być tylko jedną z tych wartości:
location

object (Location)

Wstawia obraz w określonym indeksie w dokumencie.

Obraz należy wstawić do istniejącego zasobu Paragraph. Na przykład nie można go wstawić do indeksu początkowego tabeli (tj. między tabelą a poprzednim akapitem).

Obrazów w treści nie można wstawić do przypisu lub równania.

endOfSegmentLocation

object (EndOfSegmentLocation)

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

Obrazów w treści nie można wstawiać do przypisu.

Wstawienie żądania tabeli

Wstawia tabelę w określonej lokalizacji.

Przed tabelą będzie wstawiony znak nowego wiersza.

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 sumy: insertion_location. Lokalizacja, w której zostanie wstawiony tabela. insertion_location może być tylko jedną z tych wartości:
location

object (Location)

Wstawia tabelę z indeksem określonego modelu.

Przed wstawianą tabelą zostanie wstawiony znak nowego wiersza, więc indeks rozpoczęcia będzie znajdować się we wskazanym indeksie lokalizacji + 1.

Tabela musi być wpisana w granicach istniejącego Paragraph. Na przykład nie można go wstawić do indeksu początkowego tabeli (tj. między istniejącą tabelą a poprzednim akapitem).

Tabela nie może być umieszczona w przypisie lub równaniu.

endOfSegmentLocation

object (EndOfSegmentLocation)

Wstawia tabelę na końcu danego nagłówka, stopki lub treści dokumentu. Przed tabelą będzie wstawiony znak nowego wiersza.

Nie można wstawić tabel do przypisu.

Wstaw żądanie wiersza tabeli

Wstawia pusty wiersz do tabeli.

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

object (TableCellLocation)

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

Nowy wiersz zostanie wstawiony powyżej (lub poniżej) wiersza, w którym znajduje się komórka referencyjna. Jeśli komórka referencyjna jest scaloną komórką, nowy wiersz zostanie wstawiony powyżej (lub poniżej) scalonej komórki.

insertBelow

boolean

Określa, czy wstawić nowy wiersz poniżej referencyjnej lokalizacji komórki.

  • True: wstaw poniżej komórki.
  • False: wstaw powyżej komórki.

Lokalizacja komórki tabeli

Lokalizacja pojedynczej komórki w tabeli.

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

object (Location)

Lokalizacja, w której dokument zaczyna się w tabeli.

rowIndex

integer

Indeks wiersza z zerem. Na przykład drugi wiersz w tabeli ma indeks równy 1.

columnIndex

integer

Indeks kolumny opartej na zerach. Na przykład druga kolumna w tabeli ma indeks równy 1.

Żądanie RequestTableColumn

Wstawia do tabeli pustą kolumnę.

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

object (TableCellLocation)

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

Nowa kolumna zostanie wstawiona po lewej stronie (lub prawej) kolumnie, w której znajduje się komórka referencyjna. Jeśli komórka referencyjna jest scaloną komórką, w jej lewej (lub prawej) komórce pojawi się nowa kolumna.

insertRight

boolean

Określa, czy po prawej stronie lokalizacji referencyjnej komórki chcesz wstawić nową kolumnę.

  • True: wstaw po prawej stronie
  • False: wstaw po lewej stronie

Prośba o usunięcie tabeli

Usuwa wiersz z tabeli.

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

object (TableCellLocation)

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

Wiersz, który obejmuje ta komórka, zostanie usunięty. Jeśli jest to scalona komórka, która obejmuje wiele wierszy, wszystkie wiersze, które obejmuje ta komórka, zostaną usunięte. Jeśli po usunięciu tej tabeli nie pozostanie w niej żaden wiersz, zostanie ona usunięta w całości.

Żądanie deleteTableColumn

Usuwa kolumnę z tabeli.

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

object (TableCellLocation)

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

Kolumna, którą obejmuje ta komórka w zakresie, zostanie usunięta. Jeśli jest to scalona komórka, która obejmuje wiele kolumn, wszystkie kolumny zawierające ją, zostaną usunięte. Jeśli po usunięciu tej tabeli nie pozostaną w niej żadne kolumny, cała tabela zostanie usunięta.

ŻądanieŻądanie podziału strony

Wstawia podział strony wraz ze znakiem nowego wiersza w określonym miejscu.

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 sumy: insertion_location. Lokalizacja, w której zostanie wstawiony podział strony. insertion_location może być tylko jedną z tych wartości:
location

object (Location)

Wstawia podział strony przy określonym indeksie w dokumencie.

Podział strony należy wstawić w obrębie istniejącego tagu Paragraph. Na przykład nie można go wstawić do indeksu początkowego tabeli (tj. między tabelą a poprzednim akapitem).

Podziałów stron nie można wstawiać w tabeli, równaniu, przypisie, nagłówku ani stopce. Podziały stron można wstawić tylko w treści, dlatego pole segment ID musi być puste.

endOfSegmentLocation

object (EndOfSegmentLocation)

Wstawia podział strony na końcu treści dokumentu.

Podziałów stron nie można umieszczać w przypisach, nagłówkach ani stopkach. Podziały stron można wstawić tylko w treści, dlatego pole segment ID musi być puste.

Element RequestPositionedObject

Usuwa PositionedObject z dokumentu.

Zapis JSON 
{
  "objectId": string
}
Pola
objectId

string

Identyfikator pozycjonowanego obiektu do usunięcia.

Żądanie Poproś o zaktualizowanie właściwości kolumny tabeli

Aktualizuje TableColumnProperties kolumn w tabeli.

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

object (Location)

Lokalizacja, w której dokument zaczyna się w tabeli.

columnIndices[]

integer

Lista indeksów kolumn opartych na zera, których właściwości należy zaktualizować. Jeśli nie określono indeksów, wszystkie kolumny zostaną zaktualizowane.

tableColumnProperties

object (TableColumnProperties)

Właściwości kolumny tabeli do zaktualizowania.

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

fields

string (FieldMask format)

Pola, które należy zaktualizować.

Musisz określić co najmniej jedno pole. Pierwiastek tableColumnProperties jest domniemany i nie powinien być określony. Pojedyncza właściwość "*" może służyć jako krótka lista usług.

Aby np. zaktualizować szerokość kolumny, ustaw fields na "width".

Żądanie UpdateTableCellStyleRequest

Aktualizuje 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, który należy ustawić w komórkach tabeli.

Podczas aktualizowania obramowania komórka współdzielona jest także dla sąsiedniej komórki. Właściwa właściwość obramowania jest też przylegająca. Obramowania scalone i niewidoczne nie są aktualizowane.

Ponieważ aktualizacja ramki udostępnianej przez sąsiednie komórki w tym samym żądaniu może spowodować sprzeczne aktualizacje obramowania, zmiany w tym zakresie 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 jedno pole. Pierwiastek tableCellStyle jest domniemany i nie powinien być określony. Pojedyncza właściwość "*" może służyć jako krótka lista usług.

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

Aby zresetować właściwość do wartości domyślnej, wpisz nazwę pola maski, ale pozostaw to pole puste.

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

object (TableRange)

Zakres tabel reprezentujący podzbiór tabeli, do której zostały zastosowane aktualizacje.

tableStartLocation

object (Location)

Lokalizacja, w której dokument zaczyna się w tabeli. Jeśli jest określona, aktualizacje są stosowane do wszystkich komórek w tabeli.

Zakres tabel

Zakres tabel reprezentuje odniesienie 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ą scalone. Tabela wygląda tak: 

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

Zakres tabeli z lokalizacją komórki tabeli = (tableStartLocation, wiersz = 0, kolumna = 0), zakres wierszy = 3 i zakres kolumny = 2 określa następujące 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 w miejscu, w którym zaczyna się zakres tabeli.

rowSpan

integer

Zakres wierszy zakresu tabeli.

columnSpan

integer

Zakres kolumn zakresu tabeli.

Żądanie UpdateTableRowStyleRequest

Aktualizuje TableRowStyle wierszy w tabeli.

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

object (Location)

Lokalizacja, w której dokument zaczyna się w tabeli.

rowIndices[]

integer

Lista indeksów wierszy o wartości 0, której styl należy zaktualizować. Jeśli nie określono indeksów, wszystkie wiersze zostaną zaktualizowane.

tableRowStyle

object (TableRowStyle)

Style do ustawienia w wierszach.

fields

string (FieldMask format)

Pola, które należy zaktualizować.

Musisz określić co najmniej jedno pole. Pierwiastek tableRowStyle jest domniemany i nie powinien być określony. Pojedyncza właściwość "*" może służyć jako krótka lista usług.

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

Żądanie żądania grafiki

Zastępuje istniejący obraz nowym.

Zastąpienie obrazu powoduje usunięcie niektórych image effects z istniejącego obrazu, aby odzwierciedlić zachowanie edytora Dokumentów.

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

string

Identyfikator dotychczasowego obrazu, który zostanie zastąpiony. Identyfikator można pobrać z odpowiedzi żądania get.

uri

string

Identyfikator URI nowego obrazu.

Obraz jest pobierany raz podczas wstawiania i jest kopiowana do wyświetlania w dokumencie. Obrazy nie mogą być większe niż 50 MB, nie mogą być większe niż 25 megapikseli i muszą być w formacie PNG, JPEG lub GIF.

Długość identyfikatora URI nie może przekraczać 2 KB. Identyfikator URI zapisuje się z obrazem i ujawnia się w polu ImageProperties.source_uri.

imageReplaceMethod

enum (ImageReplaceMethod)

Metoda zastępowania.

ImageReplaceMethod

Metoda zastępowania obrazu.

Wartości w polu enum
IMAGE_REPLACE_METHOD_UNSPECIFIED Nieokreślona metoda zastępowania obrazów. Tej wartości nie można używać.
CENTER_CROP Skaluje obraz i wyśrodkowuje go tak, by wypełnił granice oryginalnego obrazu. Obraz może zostać przycięty, aby wypełnił granice oryginalnego obrazu. Wyrenderowany rozmiar będzie taki sam jak obraz oryginalny.

Żądanie UpdateDocumentStyle

Aktualizuje DocumentStyle.

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

object (DocumentStyle)

Style do ustawienia w dokumencie.

Niektóre zmiany stylu dokumentu mogą powodować inne zmiany odzwierciedlające zachowanie edytora Dokumentów. Więcej informacji znajdziesz w dokumentacji DocumentStyle.

fields

string (FieldMask format)

Pola, które należy zaktualizować.

Musisz określić co najmniej jedno pole. Pierwiastek documentStyle jest domniemany i nie powinien być określony. Pojedyncza właściwość "*" może służyć jako krótka lista usług.

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

Żądanie MergeTableCells

Scala komórki w komórce Table.

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

object (TableRange)

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

Każdy tekst w scalanych komórkach zostanie scalony i zapisany w komórce „head” zakresu. Jest to komórka w lewym górnym rogu zakresu, gdy kierunek treści jest ustawiony na lewo lub prawo, a w prawym górnym rogu zakresu.

Jeśli zakres nie jest prostokątny (może tak się zdarzyć w przypadku, gdy zakres obejmuje już scalone komórki lub gdy tabela nie jest prostokątna), zwracany jest błąd 400 nieprawidłowego żądania.

Żądanie scalenia komórek tabel

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ć rozdzielone.

Scalone komórki z tego zakresu nie zostaną scalone. Jeśli zakres nie obejmuje scalonych komórek, żądanie nie zrobi nic.

Jeśli w dowolnej scalonej komórce jest tekst, to on pozostanie w komórce „head” wynikowego bloku niescalonych komórek. Komórka „head” to komórka w lewym górnym rogu, gdy kierunek treści znajduje się od lewej do prawej – w prawym górnym rogu.

Utwórz żądanie nagłówka

Tworzy Header. Nowy nagłówek jest stosowany do SectionStyle w lokalizacji elementu SectionBreak (jeśli został określony), w przeciwnym razie do DocumentStyle.

Jeśli istnieje już nagłówek określonego typu, zwracany jest błąd 400 „złe żądanie”.

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

enum (HeaderFooterType)

Typ nagłówka do utworzenia.

sectionBreakLocation

object (Location)

Lokalizacja elementu SectionBreak, który rozpoczyna sekcję, do której należy ten nagłówek. Jeśli zasada „sectionBreakLocation” jest nieskonfigurowana lub odwołuje się do pierwszego podziału sekcji w treści dokumentu, nagłówek dotyczy obiektu DocumentStyle

Typ stopki

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

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

Utwórz żądanie stopki

Tworzy Footer. Nowa stopka jest stosowana do SectionStyle w lokalizacji SectionBreak (jeśli jest określona). W przeciwnym razie jest stosowana do DocumentStyle.

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

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

enum (HeaderFooterType)

Typ stopki do utworzenia.

sectionBreakLocation

object (Location)

Lokalizacja tagu SectionBreak znajdującego się bezpośrednio przed sekcją, do której powinna należeć SectionStyle. Jeśli zasada jest nieskonfigurowana lub odwołuje się do pierwszego podziału sekcji w dokumencie, stopka dotyczy stylu dokumentu.

Prośba o utworzenie stopki

Tworzy segment Footnote i wstawia do niego nowy obiekt FootnoteReference w podanej lokalizacji.

Nowy segment Footnote będzie zawierać spację, po której będzie 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 sumy: footnote_reference_location. Lokalizacja, w której należy wstawić przypis. footnote_reference_location może być tylko jedną z tych wartości:
location

object (Location)

Wstawia przypis w określonym indeksie w dokumencie.

Odwołanie do przypisu musi zostać wstawione do limitów istniejącego Paragraph. Na przykład nie można go wstawić do indeksu początkowego tabeli (tj. między tabelą a poprzednim akapitem).

Odwołań do przypisów nie można wstawić do równania, nagłówka, stopki ani przypisu. Odwołania do przypisów można wstawiać tylko w treści, dlatego pole segment ID musi być puste.

endOfSegmentLocation

object (EndOfSegmentLocation)

Wstawia przypis na końcu treści dokumentu.

Odwołań do przypisów nie można wstawiać do nagłówka, stopki ani przypisu. Odwołania do przypisów można wstawiać tylko w treści, dlatego pole segment ID musi być puste.

ŻądanieRequestNameContentContent

Zastępuje zawartość określonego elementu NamedRange lub NamedRanges określoną zawartością zastępczą.

Pamiętaj, że pojedynczy element NamedRange może się składać z wielu nieciągłych wartości ranges. W takim przypadku zostanie zastąpiona tylko treść z pierwszego zakresu. Pozostałe zakresy wraz z zawartością zostaną usunięte.

Jeśli zastąpienie lub usunięcie któregoś z tych zakresów spowodowałoby nieprawidłową strukturę dokumentu, zwracany jest błąd 400 dotyczący nieprawidłowego żądania.

Zapis JSON 
{

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

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "namedRangeName": string
  // End of list of possible types for union field named_range_reference.
}
Pola
Pole sumy: replacement_content. Zawartość, która ma zastąpić istniejącą zawartość zakresu nazwanego. replacement_content może być tylko jedną z tych wartości:
text

string

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

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

string

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

Jeśli nie ma zakresu nazwanego o podanym identyfikatorze, zwracany jest błąd 400 „złe żądanie”.

namedRangeName

string

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

Jeśli występuje wiele elementów named ranges o podanej nazwie, zawartość każdej z nich zostanie zastąpiona. Jeśli nie ma zakresów nazwanych o podanej nazwie, żądanie nie będzie działać w sposób automatyczny.

Żądanie UpdateSectionStyle

Aktualizuje SectionStyle.

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

object (Range)

Zakres nakładający się na sekcje.

Podziały sekcji można wstawić tylko w treści, dlatego pole segment ID musi być puste.

sectionStyle

object (SectionStyle)

Style do ustawienia w sekcji.

Niektóre zmiany stylu sekcji mogą powodować inne zmiany odzwierciedlające działanie edytora Dokumentów. Więcej informacji znajdziesz w dokumentacji SectionStyle.

fields

string (FieldMask format)

Pola, które należy zaktualizować.

Musisz określić co najmniej jedno pole. Pierwiastek sectionStyle jest domniemany i nie można go określić. Pojedyncza właściwość "*" może służyć jako krótka lista usług.

Aby na przykład zaktualizować lewy margines, ustaw fields na "marginLeft".

Żądanie podziału sekcji

Wstawia podział sekcji w danej lokalizacji.

Przed podziałem sekcji pojawi się 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 sumy: insertion_location. Lokalizacja, w której chcesz wstawić przerwę. insertion_location może być tylko jedną z tych wartości:
location

object (Location)

Wstawia nowy wiersz i podział sekcji w określonym indeksie w dokumencie.

Podział sekcji należy wstawić do limitów istniejącego znacznika Paragraph. Na przykład nie można go wstawić do indeksu początkowego tabeli (tj. między tabelą a poprzednim akapitem).

podziałów sekcji nie można umieszczać w tabeli, równaniu, przypisie, nagłówku ani stopce; Podziały sekcji można wstawić tylko w treści, dlatego pole segment ID musi być puste.

endOfSegmentLocation

object (EndOfSegmentLocation)

Wstawia nowy wiersz i podział sekcji na końcu treści dokumentu.

podziałów sekcji nie można umieszczać w przypisach, nagłówkach ani stopkach; Podziały sekcji można wstawić tylko w treści, dlatego pole segment ID musi być puste.

Żądanie deleteHeader

Usuwa Header z dokumentu.

Zapis JSON 
{
  "headerId": string
}
Pola
headerId

string

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

Prośba o usunięcie stopki

Usuwa Footer z dokumentu.

Zapis JSON 
{
  "footerId": string
}
Pola
footerId

string

Identyfikator stopki do usunięcia. Jeśli ta stopka jest zdefiniowana w DocumentStyle, odwołanie do tej stopki zostanie usunięte, przez co taka stopka nie będzie widoczna w pierwszej sekcji dokumentu. Jeśli stopka jest zdefiniowana w SectionStyle, odniesienie do tej stopki jest usuwane, a stopka tego typu jest kontynuowana z poprzedniej sekcji.

PinTableHeaderRowsRequest

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

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

object (Location)

Lokalizacja, w której dokument zaczyna się w tabeli.

pinnedHeaderRowsCount

integer

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