Requests

Żądanie

Pojedyncza aktualizacja do zastosowania w dokumencie.

Zapis JSON 
{

  "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)
  },
  "addDocumentTab": {
    object (AddDocumentTabRequest)
  },
  "deleteTab": {
    object (DeleteTabRequest)
  },
  "updateDocumentTabProperties": {
    object (UpdateDocumentTabPropertiesRequest)
  },
  "insertPerson": {
    object (InsertPersonRequest)
  },
  "updateNamedStyle": {
    object (UpdateNamedStyleRequest)
  },
  "insertRichLink": {
    object (InsertRichLinkRequest)
  },
  "insertDate": {
    object (InsertDateRequest)
  },
  "insertComment": {
    object (InsertCommentRequest)
  },
  "addCommentReply": {
    object (AddCommentReplyRequest)
  },
  "updateCommentPost": {
    object (UpdateCommentPostRequest)
  },
  "deleteComment": {
    object (DeleteCommentRequest)
  },
  "deleteCommentReply": {
    object (DeleteCommentReplyRequest)
  },
  "acceptSuggestion": {
    object (AcceptSuggestionRequest)
  },
  "rejectSuggestion": {
    object (RejectSuggestionRequest)
  },
  "deleteSuggestion": {
    object (DeleteSuggestionRequest)
  }
}
Pola
Konkretne żądanie do zastosowania. Wymagane jest dokładnie jedno pole. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
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)

Tworzy wypunktowania akapitów.

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

Usuwa wypunktowania 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ść z dokumentu.

insertInlineImage

object (InsertInlineImageRequest)

Wstawia obraz w tekście 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 obiekt umieszczony w określonym miejscu.

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)

Cofa scalenie komórek 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)

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

addDocumentTab

object (AddDocumentTabRequest)

Dodaje kartę dokumentu.

deleteTab

object (DeleteTabRequest)

Usuwa kartę dokumentu.

updateDocumentTabProperties

object (UpdateDocumentTabPropertiesRequest)

Aktualizuje właściwości karty dokumentu.

insertPerson

object (InsertPersonRequest)

Wstawia wzmiankę o osobie.

updateNamedStyle

object (UpdateNamedStyleRequest)

Aktualizuje styl nazwany.

insertDate

object (InsertDateRequest)

Wstawia datę.

insertComment

object (InsertCommentRequest)

Wstawia do dokumentu znak CommentThread.

addCommentReply

object (AddCommentReplyRequest)

Dodaje odpowiedź do CommentThread lub SuggestionThread.

updateCommentPost

object (UpdateCommentPostRequest)

Aktualizuje istniejący post (główny post lub odpowiedź) w CommentThread lub SuggestionThread.

deleteComment

object (DeleteCommentRequest)

Usuwa CommentThread.

deleteCommentReply

object (DeleteCommentReplyRequest)

usuwa odpowiedź Post z CommentThread lub SuggestionThread.

acceptSuggestion

object (AcceptSuggestionRequest)

Akceptuje sugestię.

rejectSuggestion

object (RejectSuggestionRequest)

Odrzuca sugestię.

deleteSuggestion

object (DeleteSuggestionRequest)

Usuwa sugestię.

Koniec pól wykluczających się nawzajem.

ReplaceAllTextRequest

Zastępuje wszystkie wystąpienia tekstu spełniającego kryteria wartością replace text.

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

  "containsText": {
    object (SubstringMatchCriteria)
  }
}
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ć zamiana.

Jeśli ten parametr zostanie pominięty, zamiana zostanie zastosowana do wszystkich kart.

W dokumencie zawierającym jedną kartę:

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

  • Jeśli ten atrybut zostanie pominięty, zamiana zostanie zastosowana do pojedynczej karty.

W dokumencie zawierającym wiele kart:

  • Jeśli podano, zamiana dotyczy określonych kart.

  • Jeśli ten parametr zostanie pominięty, zastąpienie zostanie zastosowane do wszystkich kart.

Kryteria używane do dopasowania tekstu do zastąpienia. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
containsText

object (SubstringMatchCriteria)

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

Koniec pól wykluczających się nawzajem.

SubstringMatchCriteria

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

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

string

Tekst do wyszukania w dokumencie.

matchCase

boolean

Wskazuje, czy w wyszukiwaniu ma być uwzględniana wielkość liter:

  • True: w wyszukiwaniu jest rozróżniana wielkość liter.
  • False: wyszukiwanie nie uwzględnia wielkości liter.
searchByRegex

boolean

Opcjonalnie: Wartość PRAWDA, jeśli wartość do znalezienia ma być traktowana jako wyrażenie regularne. Wzorzec nie może zawierać ukośników odwrotnych.

  • True: tekst wyszukiwania jest traktowany jako wyrażenie regularne.
  • False: tekst wyszukiwania jest traktowany jako podciąg do dopasowania.

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 jest wykonywane żądanie.

InsertTextRequest

Wstawia tekst w określonym miejscu.

Zapis JSON 
{
  "text": string,

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Pola
text

string

Tekst do wstawienia.

Wstawienie znaku nowego wiersza spowoduje niejawne utworzenie nowego znaku Paragraph w tym indeksie. Styl akapitu nowego akapitu zostanie skopiowany z akapitu w bieżącym indeksie wstawiania, w tym listy i punktorów.

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 sterujące (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.

Miejsce, w którym zostanie wstawiony tekst. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
location

object (Location)

Wstawia tekst w określonym indeksie w dokumencie.

Tekst musi być wstawiony w granicach istniejącego elementu Paragraph. Na przykład nie można wstawić tekstu w indeksie początkowym tabeli (czyli między tabelą a poprzedzającym ją akapitem). Tekst musi zostać wstawiony w poprzednim akapicie.

endOfSegmentLocation

object (EndOfSegmentLocation)

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

Koniec pól wykluczających się nawzajem.

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 liczony od zera w jednostkach kodu UTF-16.

Indeks jest określany względem początku segmentu wskazanego przez segmentId.

tabId

string

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ę:

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

  • Jeśli ten parametr zostanie pominięty, żądanie będzie dotyczyć pojedynczej karty.

W dokumencie zawierającym wiele kart:

  • Jeśli podano, żądanie dotyczy określonej karty.

  • Jeśli ten parametr zostanie pominięty, żądanie będzie dotyczyć pierwszej karty w dokumencie.

EndOfSegmentLocation

Lokalizacja 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

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 ten parametr zostanie pominięty, żądanie zostanie zastosowane do pierwszej karty.

W dokumencie zawierającym jedną kartę:

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

  • Jeśli ten parametr zostanie pominięty, żądanie będzie dotyczyć pojedynczej karty.

W dokumencie zawierającym wiele kart:

  • Jeśli podano, żądanie dotyczy określonej karty.

  • Jeśli ten parametr zostanie pominięty, żądanie będzie dotyczyć pierwszej karty w dokumencie.

UpdateTextStyleRequest

Zaktualizuj styl tekstu.

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

  "range": {
    object (Range)
  }
}
Pola
textStyle

object (TextStyle)

Style, które mają zostać zastosowane do tekstu.

Jeśli wartość danego stylu jest zgodna z wartością 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 TextStyle.

fields

string (FieldMask format)

Pola, które należy zaktualizować.

Musisz określić co najmniej 1 pole. Katalog główny textStyle jest domyślny i nie należy go podawać. Pojedynczy znak "*" może być używany jako skrót do wyświetlania wszystkich pól.

Jeśli na przykład chcesz zmienić styl tekstu na pogrubiony, ustaw fields na "bold".

Aby przywrócić właściwości wartość domyślną, uwzględnij nazwę pola w masce pola, ale pozostaw samo pole nieustawione.

Typ zakresu, w którym zostanie zaktualizowany styl tekstu. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
range

object (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.

Koniec pól wykluczających się nawzajem.

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ąć nadmiernego odstępu między punktem a odpowiednim akapitem, te karty wiodące są usuwane na podstawie tej prośby. 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 zostaną dodane do tej listy.

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

object (Range)

Zakres, do którego chcesz zastosować gotowe ustawienia punktorów.

bulletPreset

enum (BulletGlyphPreset)

Rodzaje glifów punktorów, które mają być używane.

BulletGlyphPreset

Gotowe wzory glifów punktora dla list.

W tych wzorcach 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: romb z literą „x” w środku, odpowiadający punktowi kodowemu Unicode U+2756.
  • HOLLOWDIAMOND : pusty romb odpowiadający punktowi kodowemu Unicode U+25c7.
  • DISC: pełne koło 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: duża 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 wielocyfrowe 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 punktora 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 punktami 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ępują nawiasy.
NUMBERED_DECIMAL_NESTED Lista numerowana z DECIMAL glifami numerycznymi oddzielonymi 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 (Range)
  }
}
Pola
range

object (Range)

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

CreateNamedRangeRequest

Tworzy NamedRange odwołującą się do podanego zakresu.

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

string

Nazwa NamedRange. Nazwy nie muszą być unikalne.

Nazwy muszą 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 być zastosowana nazwa.

DeleteNamedRangeRequest

Usuwa NamedRange.

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

  "namedRangeId": string,
  "name": string
}
Pola
tabsCriteria

object (TabsCriteria)

Opcjonalnie: Kryteria używane do określania, w 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ę:

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

  • Jeśli ten parametr zostanie pominięty, usunięcie zakresu będzie dotyczyć pojedynczej karty.

W dokumencie zawierającym wiele kart:

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

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

Wartość określająca zakresy do usunięcia. Musisz ustawić dokładnie jedną z tych wartości. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
namedRangeId

string

Identyfikator zakresu nazwanego do usunięcia.

name

string

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

Koniec pól wykluczających się nawzajem.

UpdateParagraphStyleRequest

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

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

  "range": {
    object (Range)
  }
}
Pola
paragraphStyle

object (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 ParagraphStyle.

fields

string (FieldMask format)

Pola, które należy zaktualizować.

Musisz określić co najmniej 1 pole. Katalog główny paragraphStyle jest domyślny i nie należy go podawać. Pojedynczy znak "*" może być używany jako skrót do wyświetlania wszystkich pól.

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

Aby przywrócić właściwości wartość domyślną, uwzględnij nazwę pola w masce pola, ale pozostaw samo pole nieustawione.

Typ zakresu, w którym zostanie zaktualizowany styl akapitu. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
range

object (Range)

Zakres nakładający się na akapity, które mają zostać sformatowane.

Koniec pól wykluczających się nawzajem.

DeleteContentRangeRequest

Usuwa treść 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 w stylach akapitów, listach, obiektach umieszczonych w określonym miejscu 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 takim przypadku zwracany jest błąd 400 (Nieprawidłowe żądanie).

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

InsertInlineImageRequest

Wstawia InlineObject zawierający obraz w podanej lokalizacji.

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

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Pola
uri

string

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ą mieć więcej niż 25 megapikseli i muszą być w formacie PNG, JPEG lub GIF.

Podany identyfikator URI musi być publicznie dostępny i mieć długość maksymalnie 2 KB. Identyfikator URI jest zapisywany razem z obrazem i udostępniany w polu ImageProperties.content_uri.

objectSize

object (Size)

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 ani 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 podasz zarówno szerokość, jak i wysokość, obraz zostanie przeskalowany tak, aby mieścił się w podanych wymiarach przy zachowaniu współczynnika proporcji.

Lokalizacja, w której zostanie wstawiony obraz. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
location

object (Location)

Wstawia obraz w określonym indeksie w dokumencie.

Obraz musi być wstawiony w granicach istniejącego elementu Paragraph. Nie można go na przykład wstawić w indeksie początkowym tabeli (czyli między tabelą a poprzedzającym ją akapitem).

Obrazów w tekście nie można wstawiać w przypisach ani równaniach.

endOfSegmentLocation

object (EndOfSegmentLocation)

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

Obrazów w tekście nie można wstawiać w przypisach.

Koniec pól wykluczających się nawzajem.

InsertTableRequest

Wstawia tabelę w określonym miejscu.

Przed wstawioną tabelą zostanie wstawiony znak nowego wiersza.

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

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Pola
rows

integer

Liczba wierszy w tabeli.

columns

integer

Liczba kolumn w tabeli.

Lokalizacja, w której zostanie wstawiona tabela. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
location

object (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 granicach istniejącego elementu Paragraph. Nie można go na przykład wstawić w indeksie początkowym tabeli (czyli między istniejącą tabelą a poprzedzającym ją akapitem).

Tabel nie można wstawiać w przypisach ani równaniach.

endOfSegmentLocation

object (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.

Koniec pól wykluczających się nawzajem.

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

boolean

Określa, czy nowy wiersz ma zostać wstawiony poniżej komórki odniesienia.

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

TableCellLocation

Lokalizacja pojedynczej komórki w tabeli.

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

object (Location)

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

rowIndex

integer

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

columnIndex

integer

Indeks kolumny w skali od 0. Na przykład druga kolumna w tabeli ma indeks kolumny 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 odniesienia.

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

DeleteTableRowRequest

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, 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 komórka. Jeśli po usunięciu wierszy w tabeli nie pozostaną żadne wiersze, cała tabela zostanie usunięta.

DeleteTableColumnRequest

Usuwa kolumnę z tabeli.

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

object (TableCellLocation)

Lokalizacja komórki tabeli referencyjnej, 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 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 
{

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Pola
Miejsce, w którym zostanie wstawiony podział strony. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
location

object (Location)

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

Podział strony musi być wstawiony w granicach istniejącego elementu Paragraph. Nie można go na przykład wstawić w indeksie początkowym tabeli (czyli między tabelą a poprzedzającym ją akapitem).

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 segment ID musi być puste.

endOfSegmentLocation

object (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 segment ID musi być puste.

Koniec pól wykluczających się nawzajem.

DeletePositionedObjectRequest

Usuwa z dokumentu element PositionedObject.

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

string

Identyfikator obiektu umieszczonego w określonym miejscu do usunięcia.

tabId

string

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ę:

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

  • Jeśli ten parametr zostanie pominięty, żądanie będzie dotyczyć pojedynczej karty.

W dokumencie zawierającym wiele kart:

  • Jeśli podano, żądanie dotyczy określonej karty.

  • Jeśli ten parametr zostanie pominięty, żądanie będzie dotyczyć pierwszej karty w dokumencie.

UpdateTableColumnPropertiesRequest

Aktualizuje TableColumnProperties kolumn w tabeli.

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

object (Location)

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

columnIndices[]

integer

Lista indeksów kolumn (liczonych od zera), których właściwość ma zostać zaktualizowana. Jeśli nie podasz żadnych indeksów, zaktualizowane zostaną wszystkie kolumny.

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łowe żądanie).

fields

string (FieldMask format)

Pola, które należy zaktualizować.

Musisz określić co najmniej 1 pole. Katalog główny tableColumnProperties jest domyślny i nie należy go podawać. Pojedynczy znak "*" może być używany jako skrót do wyświetlania wszystkich pól.

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

UpdateTableCellStyleRequest

Aktualizuje styl zakresu komórek tabeli.

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

  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
}
Pola
tableCellStyle

object (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ólnego dla sąsiednich komórek w tym samym żądaniu może powodować sprzeczne aktualizacje obramowania, dlatego aktualizacje obramowania 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. Katalog główny tableCellStyle jest domyślny i nie należy go podawać. Pojedynczy znak "*" może być używany jako skrót do wyświetlania wszystkich pól.

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

Aby przywrócić właściwości wartość domyślną, uwzględnij nazwę pola w masce pola, ale pozostaw samo pole nieustawione.

Komórki, które zostaną zaktualizowane. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
tableRange

object (TableRange)

Zakres tabeli reprezentujący podzbiór tabeli, do którego stosowane są aktualizacje.

tableStartLocation

object (Location)

Miejsce, w którym tabela zaczyna się w dokumencie. Jeśli zostanie określony, zmiany zostaną zastosowane do wszystkich komórek w tabeli.

Koniec pól wykluczających się nawzajem.

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

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

Zakres tabeli z lokalizacją komórki tabeli = (tableStartLocation, wiersz = 0, kolumna = 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 (TableCellLocation)
  },
  "rowSpan": integer,
  "columnSpan": integer
}
Pola
tableCellLocation

object (TableCellLocation)

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

rowSpan

integer

Zakres wierszy zakresu tabeli.

columnSpan

integer

Zakres kolumn tabeli.

UpdateTableRowStyleRequest

Aktualizuje TableRowStyle wierszy w tabeli.

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

object (Location)

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

rowIndices[]

integer

Lista indeksów wierszy liczonych od zera, których styl należy zaktualizować. Jeśli nie podasz żadnych indeksów, wszystkie wiersze zostaną zaktualizowane.

tableRowStyle

object (TableRowStyle)

Style, które mają być zastosowane do wierszy.

fields

string (FieldMask format)

Pola, które należy zaktualizować.

Musisz określić co najmniej 1 pole. Katalog główny tableRowStyle jest domyślny i nie należy go podawać. Pojedynczy znak "*" może być używany jako skrót do wyświetlania wszystkich pól.

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

ReplaceImageRequest

Zastępuje istniejący obraz nowym.

Zastąpienie obrazu powoduje usunięcie niektórych elementówimage effectsz istniejącego 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 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 ImageProperties.source_uri.

imageReplaceMethod

enum (ImageReplaceMethod)

Metoda zastępowania.

tabId

string

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ę:

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

  • Jeśli ten parametr zostanie pominięty, żądanie będzie dotyczyć pojedynczej karty.

W dokumencie zawierającym wiele kart:

  • Jeśli podano, żądanie dotyczy określonej karty.

  • Jeśli ten parametr zostanie pominięty, żądanie będzie dotyczyć 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 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 (DocumentStyle)
  },
  "fields": string,
  "tabId": string
}
Pola
documentStyle

object (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 DocumentStyle.

fields

string (FieldMask format)

Pola, które należy zaktualizować.

Musisz określić co najmniej 1 pole. Katalog główny documentStyle jest domyślny i nie należy go podawać. Pojedynczy znak "*" może być używany jako skrót do wyświetlania wszystkich pól.

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

tabId

string

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ę:

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

  • Jeśli ten parametr zostanie pominięty, żądanie będzie dotyczyć pojedynczej karty.

W dokumencie zawierającym wiele kart:

  • Jeśli podano, żądanie dotyczy określonej karty.

  • Jeśli nie zostanie podany, żądanie dotyczy pierwszej karty w dokumencie.

MergeTableCellsRequest

Scala komórki w zakresie 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 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 obejmuje on komórki, które są już scalone, lub gdy tabela nie jest prostokątna), zwracany jest błąd 400.

UnmergeTableCellsRequest

Rozdziela komórki w zakresie Table.

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

object (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 wykona żadnej operacji.

Jeśli w którejkolwiek ze scalonych komórek znajduje się tekst, pozostanie on w komórce „głównej” w wynikowym 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 (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 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 stopkę,

CreateFooterRequest

Tworzy Footer. Nowa stopka jest stosowana do elementu SectionStyle w lokalizacji elementu SectionBreak, jeśli jest on określony. W przeciwnym razie jest stosowana do elementu DocumentStyle.

Jeśli stopka określonego typu już istnieje, zwracany jest błąd 400 (nieprawidłowe żądanie).

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

enum (HeaderFooterType)

Typ stopki do utworzenia.

sectionBreakLocation

object (Location)

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

CreateFootnoteRequest

Tworzy segmentFootnotei wstawia do niego nowyFootnoteReferencew podanej lokalizacji.

Nowy segment Footnote będzie zawierać spację, a po niej znak nowego wiersza.

Zapis JSON 
{

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Pola
Miejsce, w którym ma zostać wstawione odwołanie do przypisu. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
location

object (Location)

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

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

Odwołań do przypisów nie można wstawiać w równaniach, nagłówkach, stopkach ani przypisach. Ponieważ odwołania do przypisów dolnych można wstawiać tylko w treści, pole segment ID musi być puste.

endOfSegmentLocation

object (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 dolnych można wstawiać tylko w treści, pole segment ID musi być puste.

Koniec pól wykluczających się nawzajem.

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 spowoduje nieprawidłową strukturę dokumentu, zwracany jest błąd 400 (Nieprawidłowe żądanie).

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

  "text": string

  "namedRangeId": string,
  "namedRangeName": string
}
Pola
tabsCriteria

object (TabsCriteria)

Opcjonalnie: Kryteria używane do określania, na których kartach ma nastąpić zamiana. Jeśli ten parametr zostanie pominięty, zamiana zostanie zastosowana do wszystkich kart.

W dokumencie zawierającym jedną kartę:

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

  • Jeśli ten atrybut zostanie pominięty, zamiana zostanie zastosowana do pojedynczej karty.

W dokumencie zawierającym wiele kart:

  • Jeśli podano, zamiana dotyczy określonych kart.

  • Jeśli ten parametr zostanie pominięty, zastąpienie zostanie zastosowane do wszystkich kart.

Treść, którą chcesz zastąpić istniejącą treść w zakresie nazwanym. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
text

string

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

Koniec pól wykluczających się nawzajem.
Odwołanie do zakresu nazwanego(zakresów nazwanych), którego zawartość zostanie zastąpiona. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
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 (nieprawidłowe żądanie).

namedRangeName

string

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

Jeśli istnieje wiele plikównamed rangeso podanej nazwie, zawartość każdego z nich zostanie zastąpiona. Jeśli nie ma nazwanych zakresów o podanej nazwie, żądanie nie zostanie zrealizowane.

Koniec pól wykluczających się nawzajem.

UpdateSectionStyleRequest

Aktualizuje SectionStyle.

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

object (Range)

Zakres nakładający się na sekcje do sformatowania.

Podziały sekcji 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 odzwierciedlać 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 1 pole. Element główny sectionStyle jest domyślny i nie trzeba go określać. Pojedynczy znak "*" może być używany jako skrót do wyświetlania wszystkich pól.

Na przykład aby zaktualizować lewy margines, ustaw wartość fields na "marginLeft".

InsertSectionBreakRequest

Wstawia podział sekcji w danym miejscu.

Przed podziałem sekcji zostanie wstawiony znak nowego wiersza.

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

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Pola
sectionType

enum (SectionType)

Typ sekcji do wstawienia.

Miejsce, w którym zostanie wstawiona przerwa. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
location

object (Location)

Wstawia znak nowego wiersza i podział sekcji w określonym indeksie w dokumencie.

Podział sekcji musi być wstawiony w granicach istniejącego elementu Paragraph. Nie można go na przykład wstawić w indeksie początkowym tabeli (czyli między tabelą a poprzedzającym ją akapitem).

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

endOfSegmentLocation

object (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 segment ID musi być puste.

Koniec pól wykluczających się nawzajem.

DeleteHeaderRequest

Usuwa z dokumentu element Header.

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

string

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

tabId

string

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ę:

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

  • Jeśli ten parametr zostanie pominięty, żądanie będzie dotyczyć pojedynczej karty.

W dokumencie zawierającym wiele kart:

  • Jeśli podano, żądanie dotyczy określonej karty.

  • Jeśli ten parametr zostanie pominięty, żądanie będzie dotyczyć 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 ta stopka jest zdefiniowana w DocumentStyle, odwołanie do niej zostanie usunięte, co spowoduje, że w pierwszej sekcji dokumentu nie będzie stopki tego typu. Jeśli ten stopka jest zdefiniowana w SectionStyle, odwołanie do niej zostanie usunięte, a stopka tego typu będzie kontynuowana od poprzedniej sekcji.

tabId

string

Karta zawierająca stopkę do usunięcia. Jeśli ten parametr zostanie pominięty, żądanie zostanie zastosowane do pierwszej karty.

W dokumencie zawierającym jedną kartę:

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

  • Jeśli ten parametr zostanie pominięty, żądanie będzie dotyczyć pojedynczej karty.

W dokumencie zawierającym wiele kart:

  • Jeśli podano, żądanie dotyczy określonej karty.

  • Jeśli ten parametr zostanie pominięty, żądanie będzie dotyczyć pierwszej karty w dokumencie.

PinTableHeaderRowsRequest

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

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

object (Location)

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

pinnedHeaderRowsCount

integer

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

AddDocumentTabRequest

Dodaje kartę dokumentu. Gdy karta zostanie dodana w danym indeksie, indeksy wszystkich kolejnych kart zostaną zwiększone.

Zapis JSON 
{
  "tabProperties": {
    object (TabProperties)
  }
}
Pola
tabProperties

object (TabProperties)

Właściwości karty do dodania. Wszystkie właściwości są opcjonalne.

DeleteTabRequest

Usuwa kartę. Jeśli karta ma karty podrzędne, one również zostaną usunięte.

Zapis JSON 
{
  "tabId": string
}
Pola
tabId

string

Identyfikator karty do usunięcia.

UpdateDocumentTabPropertiesRequest

Zaktualizuj właściwości karty dokumentu.

Zapis JSON 
{
  "tabProperties": {
    object (TabProperties)
  },
  "fields": string
}
Pola
tabProperties

object (TabProperties)

Właściwości karty do zaktualizowania.

fields

string (FieldMask format)

Pola, które należy zaktualizować.

Musisz określić co najmniej 1 pole. Katalog główny tabProperties jest domyślny i nie należy go podawać. Pojedynczy znak "*" może być używany jako skrót do wyświetlania wszystkich pól.

InsertPersonRequest

Wstawia wzmiankę o osobie.

Zapis JSON 
{
  "personProperties": {
    object (PersonProperties)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Pola
personProperties

object (PersonProperties)

Właściwości wzmianki o osobie do wstawienia.

Lokalizacja, w której zostanie wstawiona wzmianka o osobie. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
location

object (Location)

Wstawia wzmiankę o osobie w określonym indeksie w dokumencie.

Wzmianka o osobie musi być wstawiona w granicach istniejącego elementu Paragraph. Nie można go na przykład wstawić w indeksie początkowym tabeli (czyli między tabelą a poprzedzającym ją akapitem).

Wzmianek o osobach nie można wstawiać w równaniach.

endOfSegmentLocation

object (EndOfSegmentLocation)

Wstawia wzmiankę o osobie na końcu nagłówka, stopki, przypisu lub treści dokumentu.

Koniec pól wykluczających się nawzajem.

UpdateNamedStyleRequest

Aktualizuje styl nazwany.

Zapis JSON 
{
  "namedStyle": {
    object (NamedStyle)
  },
  "fields": string,
  "tabId": string
}
Pola
namedStyle

object (NamedStyle)

Styl dokumentu do zaktualizowania.

fields

string (FieldMask format)

Pola NamedStyle, które mają zostać zaktualizowane.

Musisz określić co najmniej namedStyleType. Katalog główny namedStyle jest domyślny i nie należy go podawać. Pojedynczy znak "*" może być używany jako skrót do wyświetlania wszystkich pól.

Jeśli na przykład chcesz zmienić styl tekstu na pogrubiony, ustaw fields tak, aby zawierał "textStyle" i "textStyle.bold". Aby zaktualizować właściwość wyrównania stylu akapitu, ustaw fields tak, aby zawierała "paragraphStyle" i "paragraphStyle.alignment".

Aby przywrócić właściwości wartość domyślną, uwzględnij nazwę pola w masce pola, ale pozostaw samo pole nieustawione. Określenie "textStyle" lub "paragraphStyle" z pustym stylem tekstu lub stylem akapitu spowoduje zresetowanie wszystkich zagnieżdżonych pól.

tabId

string

Karta dokumentu do zaktualizowania. Domyślnie aktualizacja jest stosowana do pierwszej karty.

InsertRichLinkRequest

Wstawia znak RichLink w określonym miejscu.

Zapis JSON 
{
  "richLinkProperties": {
    object (RichLinkProperties)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Pola
Lokalizacja, w której zostanie wstawiony link z elementami multimedialnymi. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
location

object (Location)

Wstawia link z elementami multimedialnymi w określonym indeksie w dokumencie.

Link z elementami rozszerzonymi musi być wstawiony w granicach istniejącego elementu Paragraph. Nie można go na przykład wstawić w indeksie początkowym tabeli (czyli między tabelą a poprzedzającym ją akapitem).

Linku z elementami multimedialnymi nie można wstawić w równaniu.

endOfSegmentLocation

object (EndOfSegmentLocation)

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

Koniec pól wykluczających się nawzajem.

InsertDateRequest

Wstawia datę w określonym miejscu.

Zapis JSON 
{
  "dateElementProperties": {
    object (DateElementProperties)
  },

  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
}
Pola
dateElementProperties

object (DateElementProperties)

Właściwości daty do wstawienia.

Lokalizacja, w której zostanie wstawiona data. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
location

object (Location)

Wstawia datę w określonym miejscu w dokumencie.

Data musi być wstawiona w granicach istniejącego elementu Paragraph. Nie można go na przykład wstawić w indeksie początkowym tabeli (czyli między istniejącą tabelą a poprzedzającym ją akapitem).

endOfSegmentLocation

object (EndOfSegmentLocation)

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

Koniec pól wykluczających się nawzajem.

InsertCommentRequest

Wstawia do dokumentu znak CommentThread.

Zapis JSON 
{
  "content": string,
  "assigneeEmailAddress": string,

  "range": {
    object (Range)
  }
}
Pola
content

string

Tekst komentarza w formie zwykłego tekstu.

Ten tekst będzie traktowany podobnie jak komentarze utworzone w edytorze Dokumentów. Będzie się zachowywać podobnie w przypadku formatowania, powiadomień itp.

To pole nie może być puste i nie może przekraczać 2048 jednostek kodu UTF-8.

assigneeEmailAddress

string

Opcjonalnie: Adres e-mail osoby przypisanej do komentarza.

Aby dodać nieprzypisany komentarz, pozostaw to pole puste.

Nie może przekraczać 2048 jednostek kodu UTF-8.

Miejsce w dokumencie powiązane z tym komentarzem. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
range

object (Range)

Range w dokumencie, która jest powiązana z tym komentarzem.

Koniec pól wykluczających się nawzajem.

AddCommentReplyRequest

Wstawia odpowiedź Post do CommentThread lub SuggestionThread.

Zapis JSON 
{
  "post": {
    object (Post)
  },

  "commentId": string,
  "suggestionId": string
}
Pola
post

object (Post)

IkonaPost reprezentująca odpowiedź.

Identyfikator wątku, do którego chcesz dodać odpowiedź. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
commentId

string

Identyfikator CommentThread, do którego chcesz dodać odpowiedź.

suggestionId

string

Identyfikator SuggestionThread, do którego chcesz dodać odpowiedź.

Koniec pól wykluczających się nawzajem.

UpdateCommentPostRequest

Aktualizuje pole Post w obiekcie CommentThread lub SuggestionThread.

Zwraca błąd 400 (Nieprawidłowe żądanie), jeśli:

  • Post jest headPost wątku sugestii.

  • Użytkownik przesyłający prośbę nie jest autorem posta.

Zapis JSON 
{
  "postId": string,
  "content": string,

  "commentId": string,
  "suggestionId": string
}
Pola
postId

string

Identyfikator aktualizowanego posta.

content

string

Nowy tekst komentarza w formie zwykłego tekstu.

Ten tekst będzie traktowany podobnie jak komentarze utworzone w edytorze Dokumentów. Będzie się zachowywać podobnie w przypadku formatowania, powiadomień itp.

To pole nie może być puste i nie może przekraczać 2048 jednostek kodu UTF-8.

Identyfikator wątku, do którego należy post. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
commentId

string

Identyfikator CommentThread, do którego należy post.

suggestionId

string

Identyfikator SuggestionThread, do którego należy post.

Koniec pól wykluczających się nawzajem.

DeleteCommentRequest

Usuwa CommentThread.

Zwraca błąd 400 (Nieprawidłowe żądanie), jeśli użytkownik wysyłający żądanie nie jest autorem headPost.

Zapis JSON 
{
  "commentId": string
}
Pola
commentId

string

Identyfikator CommentThread, który jest usuwany.

DeleteCommentReplyRequest

Usuwa odpowiedź Post z CommentThread lub SuggestionThread.

Zwraca błąd 400 (Nieprawidłowe żądanie), jeśli:

  • Użytkownik przesyłający prośbę nie jest autorem posta.

  • Post z odpowiedzią zawiera [działanie][google.apps.docs.v1.Post.action].

  • Odpowiedź zawiera assignee.

Zapis JSON 
{
  "postId": string,

  "commentId": string,
  "suggestionId": string
}
Pola
postId

string

Identyfikator odpowiedzi Post do usunięcia.

Identyfikator wątku, do którego należy post. Poniżej znajduje się lista pól, które się wzajemnie wykluczają. W odpowiedzi zostanie ustawione co najwyżej jedno z tych pól:
commentId

string

Identyfikator CommentThread, do którego należy post.

suggestionId

string

Identyfikator SuggestionThread, do którego należy post.

Koniec pól wykluczających się nawzajem.

AcceptSuggestionRequest

Akceptuje sugestię.

Zwraca błąd 403 Forbidden, jeśli użytkownik wysyłający żądanie nie ma uprawnień do edycji dokumentu.

Zapis JSON 
{
  "suggestionId": string
}
Pola
suggestionId

string

Identyfikator sugestii.

RejectSuggestionRequest

Odrzuca sugestię.

Zwraca błąd 403 Forbidden, jeśli użytkownik wysyłający żądanie nie ma uprawnień do edycji dokumentu i nie jest autorem sugestii.

Zapis JSON 
{
  "suggestionId": string
}
Pola
suggestionId

string

Identyfikator sugestii.

DeleteSuggestionRequest

Usuwa sugestię.

Zwraca błąd 403 Forbidden, jeśli użytkownik wysyłający żądanie nie jest autorem sugestii.

Zapis JSON 
{
  "suggestionId": string
}
Pola
suggestionId

string

Identyfikator sugestii.