REST Resource: documents

Zasób: Document

dokument w Dokumentach Google,

Zapis JSON
{
  "documentId": string,
  "title": string,
  "tabs": [
    {
      object (Tab)
    }
  ],
  "revisionId": string,
  "suggestionsViewMode": enum (SuggestionsViewMode),
  "commentsViewMode": enum (CommentsViewMode),
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "suggestions": [
    {
      object (SuggestionThread)
    }
  ],
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  }
}
Pola
documentId

string

Tylko dane wyjściowe. Identyfikator dokumentu.

title

string

Tytuł dokumentu.

tabs[]

object (Tab)

karty, które są częścią dokumentu;

Karty mogą zawierać karty podrzędne, czyli karty zagnieżdżone w innych kartach. Karty podrzędne są reprezentowane przez pole Tab.childTabs.

revisionId

string

Tylko dane wyjściowe. Identyfikator wersji dokumentu. Może być używany w prośbach o aktualizację, aby określić, do której wersji dokumentu mają być stosowane aktualizacje, i jak prośba powinna się zachowywać, jeśli dokument został zmodyfikowany od czasu tej wersji. Wypełniane tylko wtedy, gdy użytkownik ma uprawnienia do edycji dokumentu.

Identyfikator wersji nie jest liczbą porządkową, ale nieprzejrzystym ciągiem znaków. Format identyfikatora wersji może się z czasem zmienić. Zwrócony identyfikator wersji jest ważny tylko przez 24 godziny od momentu zwrócenia i nie można go udostępniać innym użytkownikom. Jeśli identyfikator wersji nie zmienia się między wywołaniami, oznacza to, że dokument nie został zmieniony. Z kolei zmieniony identyfikator (w przypadku tego samego dokumentu i użytkownika) zwykle oznacza, że dokument został zaktualizowany. Zmiana identyfikatora może być jednak spowodowana również czynnikami wewnętrznymi, takimi jak zmiany formatu identyfikatora.

suggestionsViewMode

enum (SuggestionsViewMode)

Tylko dane wyjściowe. Tryb wyświetlania sugestii zastosowany w dokumencie.

Uwaga: podczas edytowania dokumentu zmiany muszą być oparte na dokumencie z symbolem SUGGESTIONS_INLINE.

commentsViewMode

enum (CommentsViewMode)

Tylko dane wyjściowe. Tryb wyświetlania komentarzy zastosowany w dokumencie.

comments[]

object (CommentThread)

Tylko dane wyjściowe. Komentarze powiązane z dokumentem. Wypełniony tylko wtedy, gdy parametr commentsViewMode jest ustawiony na wymaganie komentarzy (np. COMMENTS_VIEW_MODE_INCLUDED).

suggestions[]

object (SuggestionThread)

Tylko dane wyjściowe. sugestie powiązane z dokumentem; Wypełniony tylko wtedy, gdy parametr commentsViewMode jest ustawiony na wymaganie komentarzy (np. COMMENTS_VIEW_MODE_INCLUDED).

body

object (Body)

Tylko dane wyjściowe. Główna część dokumentu.

Pole starszego typu: zamiast niego używaj Document.tabs.documentTab.body, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.

headers

map (key: string, value: object (Header))

Tylko dane wyjściowe. Nagłówki w dokumencie, z kluczem w postaci identyfikatora nagłówka.

Pole starszego typu: zamiast niego używaj Document.tabs.documentTab.headers, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.

footers

map (key: string, value: object (Footer))

Tylko dane wyjściowe. Stopki w dokumencie, z kluczem w postaci identyfikatora stopki.

Pole starszego typu: zamiast niego używaj Document.tabs.documentTab.footers, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.

footnotes

map (key: string, value: object (Footnote))

Tylko dane wyjściowe. Przypisy w dokumencie, z kluczem w postaci identyfikatora przypisu.

Starsze pole: zamiast niego używaj Document.tabs.documentTab.footnotes, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.

documentStyle

object (DocumentStyle)

Tylko dane wyjściowe. Styl dokumentu.

Pole starszego typu: zamiast niego używaj Document.tabs.documentTab.documentStyle, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.

suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

Tylko dane wyjściowe. Sugerowane zmiany stylu dokumentu, z kluczem w postaci identyfikatora sugestii.

Pole starszego typu: zamiast niego używaj Document.tabs.documentTab.suggestedDocumentStyleChanges, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.

namedStyles

object (NamedStyles)

Tylko dane wyjściowe. Style nazwane dokumentu.

Starsze pole: zamiast niego używaj Document.tabs.documentTab.namedStyles, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.

suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

Tylko dane wyjściowe. Proponowane zmiany w nazwanych stylach dokumentu, z kluczem w postaci identyfikatora sugestii.

Pole starszego typu: zamiast niego używaj Document.tabs.documentTab.suggestedNamedStylesChanges, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.

lists

map (key: string, value: object (List))

Tylko dane wyjściowe. Listy w dokumencie, z kluczem w postaci identyfikatora listy.

Starsze pole: zamiast niego używaj Document.tabs.documentTab.lists, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.

namedRanges

map (key: string, value: object (NamedRanges))

Tylko dane wyjściowe. Zakresy nazwane w dokumencie, kluczowane według nazwy.

Pole starszego typu: zamiast niego używaj Document.tabs.documentTab.namedRanges, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.

inlineObjects

map (key: string, value: object (InlineObject))

Tylko dane wyjściowe. Obiekty wbudowane w dokumencie, z kluczem w postaci identyfikatora obiektu.

Starsze pole: zamiast niego używaj Document.tabs.documentTab.inlineObjects, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.

positionedObjects

map (key: string, value: object (PositionedObject))

Tylko dane wyjściowe. Obiekty w dokumencie z określonym położeniem, z kluczami w postaci identyfikatorów obiektów.

Starsze pole: zamiast niego używaj Document.tabs.documentTab.positionedObjects, które udostępnia rzeczywistą zawartość dokumentu ze wszystkich kart, gdy parametr includeTabsContent ma wartość true. Jeśli wartość tego pola to false lub jest ono nieustawione, zawiera ono informacje o pierwszej karcie w dokumencie.

Tab

karta w dokumencie;

Zapis JSON
{
  "tabProperties": {
    object (TabProperties)
  },
  "childTabs": [
    {
      object (Tab)
    }
  ],

  "documentTab": {
    object (DocumentTab)
  }
}
Pola
tabProperties

object (TabProperties)

Właściwości karty, takie jak identyfikator i tytuł.

childTabs[]

object (Tab)

Karty podrzędne zagnieżdżone na tej karcie.

Pole zbiorcze content. Zawartość karty. content może mieć tylko jedną z tych wartości:
documentTab

object (DocumentTab)

karta z zawartością dokumentu, np. tekstem i obrazami;

TabProperties

Właściwości karty.

Zapis JSON
{
  "tabId": string,
  "title": string,
  "parentTabId": string,
  "index": integer,
  "nestingLevel": integer,
  "iconEmoji": string
}
Pola
tabId

string

Stały identyfikator karty.

title

string

Nazwa karty widoczna dla użytkownika.

parentTabId

string

Opcjonalnie. Identyfikator karty nadrzędnej. Puste, gdy bieżąca karta jest kartą najwyższego poziomu, co oznacza, że nie ma żadnych kart nadrzędnych.

index

integer

Indeks karty w elemencie nadrzędnym liczony od zera.

nestingLevel

integer

Tylko dane wyjściowe. Głębokość karty w dokumencie. Karty najwyższego poziomu zaczynają się od 0.

iconEmoji

string

Opcjonalnie. Ikona emoji wyświetlana na karcie. Prawidłowa ikona emoji jest reprezentowana przez niepusty ciąg znaków Unicode. Każdy zestaw znaków, który nie reprezentuje pojedynczego emoji, jest nieprawidłowy.

Jeśli emotikon jest nieprawidłowy, zwracany jest błąd 400 (Nieprawidłowe żądanie).

Jeśli ta wartość jest nieskonfigurowana lub pusta, na karcie wyświetli się domyślna ikona karty.

DocumentTab

Karta z treścią dokumentu.

Zapis JSON
{
  "body": {
    object (Body)
  },
  "headers": {
    string: {
      object (Header)
    },
    ...
  },
  "footers": {
    string: {
      object (Footer)
    },
    ...
  },
  "footnotes": {
    string: {
      object (Footnote)
    },
    ...
  },
  "documentStyle": {
    object (DocumentStyle)
  },
  "suggestedDocumentStyleChanges": {
    string: {
      object (SuggestedDocumentStyle)
    },
    ...
  },
  "namedStyles": {
    object (NamedStyles)
  },
  "suggestedNamedStylesChanges": {
    string: {
      object (SuggestedNamedStyles)
    },
    ...
  },
  "lists": {
    string: {
      object (List)
    },
    ...
  },
  "namedRanges": {
    string: {
      object (NamedRanges)
    },
    ...
  },
  "inlineObjects": {
    string: {
      object (InlineObject)
    },
    ...
  },
  "positionedObjects": {
    string: {
      object (PositionedObject)
    },
    ...
  },
  "commentAnchors": {
    string: {
      object (CommentAnchor)
    },
    ...
  }
}
Pola
body

object (Body)

Główna część karty dokumentu.

headers

map (key: string, value: object (Header))

Nagłówki na karcie dokumentu, kluczowane według identyfikatora nagłówka.

footers

map (key: string, value: object (Footer))

Stopki na karcie dokumentu, z kluczem w postaci identyfikatora stopki.

footnotes

map (key: string, value: object (Footnote))

Przypisy w karcie dokumentu, z kluczem w postaci identyfikatora przypisu.

documentStyle

object (DocumentStyle)

Styl karty dokumentu.

suggestedDocumentStyleChanges

map (key: string, value: object (SuggestedDocumentStyle))

Proponowane zmiany stylu karty dokumentu, z kluczem w postaci identyfikatora sugestii.

namedStyles

object (NamedStyles)

Nazwane style karty dokumentu.

suggestedNamedStylesChanges

map (key: string, value: object (SuggestedNamedStyles))

Proponowane zmiany w stylach nazwanych na karcie dokumentu, z kluczem w postaci identyfikatora sugestii.

lists

map (key: string, value: object (List))

Listy na karcie dokumentu, kluczowane według identyfikatora listy.

namedRanges

map (key: string, value: object (NamedRanges))

Zakresy nazwane na karcie dokumentu, kluczowane według nazwy.

inlineObjects

map (key: string, value: object (InlineObject))

Obiekty wstawione w karcie dokumentu, z kluczem w postaci identyfikatora obiektu.

positionedObjects

map (key: string, value: object (PositionedObject))

Obiekty umieszczone na karcie dokumentu, z kluczem w postaci identyfikatora obiektu.

commentAnchors

map (key: string, value: object (CommentAnchor))

Komentarz jest zakotwiczony na karcie dokumentu i powiązany z identyfikatorem kotwicy. Wypełniony tylko wtedy, gdy parametr commentsViewMode jest ustawiony na wymaganie komentarzy (np. COMMENTS_VIEW_MODE_INCLUDED).

Treść

Treść dokumentu.

Treść zwykle zawiera pełną zawartość dokumentu z wyjątkiem headers, footersfootnotes.

Zapis JSON
{
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
Pola
content[]

object (StructuralElement)

Zawartość treści.

Indeksy treści w treści zaczynają się od zera.

StructuralElement

Element strukturalny opisuje treść, która nadaje dokumentowi strukturę.

Zapis JSON
{
  "startIndex": integer,
  "endIndex": integer,

  "paragraph": {
    object (Paragraph)
  },
  "sectionBreak": {
    object (SectionBreak)
  },
  "table": {
    object (Table)
  },
  "tableOfContents": {
    object (TableOfContents)
  }
}
Pola
startIndex

integer

Indeks początkowy tego elementu strukturalnego liczony od zera w jednostkach kodu UTF-16.

endIndex

integer

Indeks końcowy tego elementu strukturalnego (liczony od zera), z wyłączeniem jednostek kodu UTF-16.

Pole zbiorcze content. Zawartość elementu strukturalnego. content może mieć tylko jedną z tych wartości:
paragraph

object (Paragraph)

Typ akapitu elementu strukturalnego.

sectionBreak

object (SectionBreak)

Typ podziału sekcji elementu strukturalnego.

table

object (Table)

Typ elementu strukturalnego w formie tabeli.

tableOfContents

object (TableOfContents)

Element strukturalny typu spis treści.

Akapit

StructuralElement reprezentujący akapit. Akapit to zakres treści zakończony znakiem nowego wiersza.

Zapis JSON
{
  "elements": [
    {
      object (ParagraphElement)
    }
  ],
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "suggestedParagraphStyleChanges": {
    string: {
      object (SuggestedParagraphStyle)
    },
    ...
  },
  "bullet": {
    object (Bullet)
  },
  "suggestedBulletChanges": {
    string: {
      object (SuggestedBullet)
    },
    ...
  },
  "positionedObjectIds": [
    string
  ],
  "suggestedPositionedObjectIds": {
    string: {
      object (ObjectReferences)
    },
    ...
  }
}
Pola
elements[]

object (ParagraphElement)

Treść akapitu podzielona na części składowe.

paragraphStyle

object (ParagraphStyle)

Styl tego akapitu.

suggestedParagraphStyleChanges

map (key: string, value: object (SuggestedParagraphStyle))

Sugerowany styl akapitu zmienia się w tym akapicie, kluczowany przez identyfikator sugestii.

bullet

object (Bullet)

Punktor tego akapitu. Jeśli nie występuje, akapit nie należy do listy.

suggestedBulletChanges

map (key: string, value: object (SuggestedBullet))

Sugerowane zmiany w punkcie tego akapitu.

positionedObjectIds[]

string

Identyfikatory obiektów umieszczonych, które są powiązane z tym akapitem.

suggestedPositionedObjectIds

map (key: string, value: object (ObjectReferences))

Identyfikatory sugerowanych obiektów umieszczonych, które mają być dołączone do tego akapitu, z kluczem w postaci identyfikatora sugestii.

ParagraphElement

Element ParagraphElement opisuje treść w Paragraph.

Zapis JSON
{
  "startIndex": integer,
  "endIndex": integer,

  "textRun": {
    object (TextRun)
  },
  "autoText": {
    object (AutoText)
  },
  "pageBreak": {
    object (PageBreak)
  },
  "columnBreak": {
    object (ColumnBreak)
  },
  "footnoteReference": {
    object (FootnoteReference)
  },
  "horizontalRule": {
    object (HorizontalRule)
  },
  "equation": {
    object (Equation)
  },
  "inlineObjectElement": {
    object (InlineObjectElement)
  },
  "person": {
    object (Person)
  },
  "richLink": {
    object (RichLink)
  },
  "dateElement": {
    object (DateElement)
  }
}
Pola
startIndex

integer

Indeks początkowy tego elementu akapitu (od zera) w jednostkach kodu UTF-16.

endIndex

integer

Indeks końcowy tego elementu akapitu (liczony od zera), bez uwzględniania znaku, w jednostkach kodu UTF-16.

Pole zbiorcze content. Treść elementu akapitu. content może mieć tylko jedną z tych wartości:
textRun

object (TextRun)

Element akapitu z ciągiem tekstowym.

autoText

object (AutoText)

Element akapitu tekstu automatycznego.

pageBreak

object (PageBreak)

Element akapitu podziału strony.

columnBreak

object (ColumnBreak)

Element akapitu podziału kolumny.

footnoteReference

object (FootnoteReference)

Element akapitu odwołania do przypisu.

horizontalRule

object (HorizontalRule)

Element akapitu linijki poziomej.

equation

object (Equation)

Element akapitu z równaniem.

inlineObjectElement

object (InlineObjectElement)

Element akapitu obiektu wbudowanego.

person

object (Person)

Element akapitu, który zawiera link do osoby lub adresu e-mail.

dateElement

object (DateElement)

Element akapitu reprezentujący datę.

TextRun

ParagraphElement reprezentujący ciąg tekstu, który ma ten sam styl.

Zapis JSON
{
  "content": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Pola
content

string

Tekst tego uruchomienia.

Wszystkie elementy inne niż tekst w ciągu są zastępowane znakiem Unicode U+E907.

suggestedInsertionIds[]

string

Identyfikatory sugerowanych wstawień. TextRun może mieć wiele identyfikatorów wstawienia, jeśli jest to zagnieżdżona sugerowana zmiana. Jeśli jest puste, nie jest to sugerowane wstawienie.

suggestedDeletionIds[]

string

Identyfikatory sugerowanych usunięć. Jeśli jest puste, nie ma sugerowanych usunięć tych treści.

textStyle

object (TextStyle)

Styl tekstu tego fragmentu.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Sugerowany styl tekstu zmienia się w tym przebiegu, a kluczem jest identyfikator sugestii.

TextStyle

Reprezentuje style, które można zastosować do tekstu.

Dziedziczone style tekstu są w tej wiadomości reprezentowane jako nieustawione pola. Element nadrzędny stylu tekstu zależy od tego, gdzie jest on zdefiniowany:

  • TextStyle tekstu w Paragraph dziedziczy z odpowiedniego named style type akapitu.
  • Element TextStyle w named style dziedziczy styl o nazwie normal text.
  • Styl tekstu normal text o nazwie styl dziedziczy domyślny styl tekstu w edytorze Dokumentów.
  • Styl tekstu w elemencie Paragraph zawartym w tabeli może dziedziczyć styl tekstu ze stylu tabeli.

Jeśli styl tekstu nie jest dziedziczony z elementu nadrzędnego, usunięcie ustawień pól przywróci styl do wartości domyślnych w edytorze Dokumentów.

Zapis JSON
{
  "bold": boolean,
  "italic": boolean,
  "underline": boolean,
  "strikethrough": boolean,
  "smallCaps": boolean,
  "backgroundColor": {
    object (OptionalColor)
  },
  "foregroundColor": {
    object (OptionalColor)
  },
  "fontSize": {
    object (Dimension)
  },
  "weightedFontFamily": {
    object (WeightedFontFamily)
  },
  "baselineOffset": enum (BaselineOffset),
  "link": {
    object (Link)
  }
}
Pola
bold

boolean

Określa, czy tekst jest renderowany jako pogrubiony.

italic

boolean

Określa, czy tekst jest zapisany kursywą.

underline

boolean

Czy tekst jest podkreślony.

strikethrough

boolean

Określa, czy tekst jest przekreślony.

smallCaps

boolean

Określa, czy tekst jest pisany kapitalikami.

backgroundColor

object (OptionalColor)

Kolor tła tekstu. Jeśli jest ustawiony, kolor jest kolorem RGB lub przezroczystym, w zależności od pola color.

foregroundColor

object (OptionalColor)

Kolor pierwszego planu tekstu. Jeśli jest ustawiony, kolor jest kolorem RGB lub przezroczystym, w zależności od pola color.

fontSize

object (Dimension)

Rozmiar czcionki tekstu.

weightedFontFamily

object (WeightedFontFamily)

Rodzina czcionek i grubość tekstu.

Jeśli w żądaniu aktualizacji podano wartości zarówno dla parametru weightedFontFamily, jak i bold, najpierw stosowany jest parametr weightedFontFamily, a potem bold.

Jeśli nie jest ustawiona, domyślnie przyjmuje wartość 400.weightedFontFamily#weight

Jeśli parametr weightedFontFamily jest ustawiony, parametr weightedFontFamily#fontFamily musi też być ustawiony na wartość niepustą. W przeciwnym razie zwracany jest błąd 400 (Nieprawidłowe żądanie).

baselineOffset

enum (BaselineOffset)

Pionowe przesunięcie tekstu względem jego normalnej pozycji.

Tekst z przesunięciem linii bazowej SUPERSCRIPT lub SUBSCRIPT jest automatycznie renderowany mniejszą czcionką, obliczaną na podstawie pola fontSize. Zmiany w tym polu nie mają wpływu na fontSize.

OptionalColor

Kolor, który może być w pełni nieprzezroczysty lub w pełni przezroczysty.

Zapis JSON
{
  "color": {
    object (Color)
  }
}
Pola
color

object (Color)

Jeśli jest ustawiony, będzie używany jako kolor nieprzezroczysty. Jeśli nie jest ustawiony, oznacza kolor przezroczysty.

Kolor

jednolity kolor,

Zapis JSON
{
  "rgbColor": {
    object (RgbColor)
  }
}
Pola
rgbColor

object (RgbColor)

Wartość koloru RGB.

RgbColor

Kolor RGB.

Zapis JSON
{
  "red": number,
  "green": number,
  "blue": number
}
Pola
red

number

Składowa czerwona koloru, od 0,0 do 1,0.

green

number

Składowa zielona koloru, od 0,0 do 1,0.

blue

number

Składowa niebieska koloru, od 0,0 do 1,0.

Wymiar

Wartość w jednym kierunku w określonych jednostkach.

Zapis JSON
{
  "magnitude": number,
  "unit": enum (Unit)
}
Pola
magnitude

number

Wielkość.

unit

enum (Unit)

Jednostki wielkości.

Jednostka

Jednostki miary.

Wartości w polu enum
UNIT_UNSPECIFIED Jednostki są nieznane.
PT Punkt, czyli 1/72 cala.

WeightedFontFamily

Reprezentuje rodzinę i grubość czcionki tekstu.

Zapis JSON
{
  "fontFamily": string,
  "weight": integer
}
Pola
fontFamily

string

Rodzina czcionek tekstu.

Rodzina czcionek może być dowolną czcionką z menu Czcionka w Dokumentach lub z Google Fonts. Jeśli nazwa czcionki jest nierozpoznana, tekst jest renderowany w czcionce Arial.

weight

integer

Grubość czcionki. To pole może mieć dowolną wartość, która jest wielokrotnością liczby 100 z zakresu od 100 do 900 włącznie. Ten zakres odpowiada wartościom liczbowym opisanym w specyfikacji CSS 2.1, sekcja 15.6. Wartości nieliczbowe są niedozwolone.

Wartością domyślną jest 400 („normal”).

Grubość czcionki to tylko jeden z komponentów renderowanej grubości czcionki. Na renderowaną grubość czcionki wpływa połączenie wartości weight i wartości bold stylu tekstu po uwzględnieniu dziedziczenia:

  • Jeśli tekst jest pogrubiony, a waga jest mniejsza niż 400, waga renderowana wynosi 400.
  • Jeśli tekst jest pogrubiony, a waga jest większa lub równa 400, ale mniejsza niż 700, renderowana waga to 700.
  • Jeśli waga jest większa lub równa 700, renderowana waga jest równa wadze.
  • Jeśli tekst nie jest pogrubiony, renderowana grubość jest równa grubości.

BaselineOffset

Sposoby, w jakie tekst może być przesunięty w pionie względem normalnej pozycji.

Wartości w polu enum
BASELINE_OFFSET_UNSPECIFIED Przesunięcie linii bazowej tekstu jest dziedziczone z elementu nadrzędnego.
NONE Tekst nie jest przesunięty w pionie.
SUPERSCRIPT Tekst jest przesunięty w pionie do góry (indeks górny).
SUBSCRIPT Tekst jest przesunięty w pionie w dół (indeks dolny).

SuggestedTextStyle

Sugerowana zmiana w TextStyle.

Zapis JSON
{
  "textStyle": {
    object (TextStyle)
  },
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
Pola
textStyle

object (TextStyle)

TextStyle, która zawiera tylko zmiany wprowadzone w tej sugestii. Możesz użyć tej funkcji w połączeniu z textStyleSuggestionState, aby sprawdzić, które pola uległy zmianie i jakie są ich nowe wartości.

textStyleSuggestionState

object (TextStyleSuggestionState)

Maska wskazująca, które pola w podstawowym obiekcie TextStyle zostały zmienione w tej sugestii.

TextStyleSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie TextStyle zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

Zapis JSON
{
  "boldSuggested": boolean,
  "italicSuggested": boolean,
  "underlineSuggested": boolean,
  "strikethroughSuggested": boolean,
  "smallCapsSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "foregroundColorSuggested": boolean,
  "fontSizeSuggested": boolean,
  "weightedFontFamilySuggested": boolean,
  "baselineOffsetSuggested": boolean,
  "linkSuggested": boolean
}
Pola
boldSuggested

boolean

Wskazuje, czy zaproponowano zmianę w bold.

italicSuggested

boolean

Wskazuje, czy zaproponowano zmianę w italic.

underlineSuggested

boolean

Wskazuje, czy zaproponowano zmianę w underline.

strikethroughSuggested

boolean

Wskazuje, czy zaproponowano zmianę w strikethrough.

smallCapsSuggested

boolean

Wskazuje, czy zaproponowano zmianę w smallCaps.

backgroundColorSuggested

boolean

Wskazuje, czy zaproponowano zmianę w backgroundColor.

foregroundColorSuggested

boolean

Wskazuje, czy zaproponowano zmianę w foregroundColor.

fontSizeSuggested

boolean

Wskazuje, czy zaproponowano zmianę w fontSize.

weightedFontFamilySuggested

boolean

Wskazuje, czy zaproponowano zmianę w weightedFontFamily.

baselineOffsetSuggested

boolean

Wskazuje, czy zaproponowano zmianę w baselineOffset.

AutoText

ParagraphElement – symbol reprezentujący miejsce w tekście, które jest dynamicznie zastępowane treścią, która może się zmieniać z biegiem czasu, np. numerem strony.

Zapis JSON
{
  "type": enum (Type),
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Pola
type

enum (Type)

Typ tego tekstu automatycznego.

suggestedInsertionIds[]

string

Identyfikatory sugerowanych wstawień. AutoText może mieć wiele identyfikatorów wstawienia, jeśli jest to zagnieżdżona sugerowana zmiana. Jeśli jest puste, nie jest to sugerowane wstawienie.

suggestedDeletionIds[]

string

Identyfikatory sugerowanych usunięć. Jeśli jest puste, nie ma sugerowanych usunięć tych treści.

textStyle

object (TextStyle)

Styl tekstu tego tekstu automatycznego.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Sugerowany styl tekstu zmienia się na ten autotekst, który jest powiązany z identyfikatorem sugestii.

Typ

Rodzaje autotekstu.

Wartości w polu enum
TYPE_UNSPECIFIED Nieokreślony typ tekstu automatycznego.
PAGE_NUMBER Wpisz tekst automatyczny, który będzie reprezentować bieżący numer strony.
PAGE_COUNT Typ tekstu automatycznego, który reprezentuje łączną liczbę stron w dokumencie.

PageBreak

Symbol ParagraphElement reprezentujący podział strony. Podział strony powoduje, że następny tekst zaczyna się u góry następnej strony.

Zapis JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Pola
suggestedInsertionIds[]

string

Identyfikatory sugerowanych wstawień. PageBreak może mieć wiele identyfikatorów wstawienia, jeśli jest to zagnieżdżona sugerowana zmiana. Jeśli jest puste, nie jest to sugerowane wstawienie.

suggestedDeletionIds[]

string

Identyfikatory sugerowanych usunięć. Jeśli jest puste, nie ma sugerowanych usunięć tych treści.

textStyle

object (TextStyle)

Styl tekstu tego podziału strony.

Podobnie jak w przypadku treści tekstowych, takich jak ciągi tekstowe i odwołania do przypisów, styl tekstu podziału strony może wpływać na układ treści, a także na styl tekstu wstawionego obok niego.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Sugerowany styl tekstu zmienia się na ten podział strony, z kluczem w postaci identyfikatora sugestii.

ColumnBreak

Symbol ParagraphElement reprezentujący podział kolumny. Podział kolumny powoduje, że następny tekst zaczyna się u góry kolejnej kolumny.

Zapis JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Pola
suggestedInsertionIds[]

string

Identyfikatory sugerowanych wstawień. ColumnBreak może mieć wiele identyfikatorów wstawienia, jeśli jest to zagnieżdżona sugerowana zmiana. Jeśli jest puste, nie jest to sugerowane wstawienie.

suggestedDeletionIds[]

string

Identyfikatory sugerowanych usunięć. Jeśli jest puste, nie ma sugerowanych usunięć tych treści.

textStyle

object (TextStyle)

Styl tekstu tego obiektu ColumnBreak.

Podobnie jak w przypadku treści tekstowych, takich jak ciągi tekstowe i odwołania do przypisów, styl tekstu w podziale kolumny może wpływać na układ treści, a także na styl tekstu wstawionego obok niego.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Sugerowany styl tekstu zmienia się na ten ColumnBreak, z kluczem w postaci identyfikatora sugestii.

FootnoteReference

ParagraphElement reprezentujący odwołanie do przypisu. Odwołanie do przypisu to treść w tekście, która jest renderowana z numerem i służy do identyfikowania przypisu.

Zapis JSON
{
  "footnoteId": string,
  "footnoteNumber": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Pola
footnoteId

string

Identyfikator elementu footnote, który zawiera treść tego odwołania do przypisu.

footnoteNumber

string

Wyrenderowany numer tego przypisu.

suggestedInsertionIds[]

string

Identyfikatory sugerowanych wstawień. FootnoteReference może mieć wiele identyfikatorów wstawienia, jeśli jest to zagnieżdżona sugerowana zmiana. Jeśli jest puste, nie jest to sugerowane wstawienie.

suggestedDeletionIds[]

string

Identyfikatory sugerowanych usunięć. Jeśli jest puste, nie ma sugerowanych usunięć tych treści.

textStyle

object (TextStyle)

Styl tekstu tego elementu FootnoteReference.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Sugerowany styl tekstu zmienia się na ten styl FootnoteReference, z kluczem w postaci identyfikatora sugestii.

HorizontalRule

Symbol ParagraphElement reprezentujący linię poziomą.

Zapis JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Pola
suggestedInsertionIds[]

string

Identyfikatory sugerowanych wstawień. HorizontalRule może mieć wiele identyfikatorów wstawienia, jeśli jest zagnieżdżoną sugerowaną zmianą. Jeśli jest puste, nie jest to sugerowane wstawienie.

suggestedDeletionIds[]

string

Identyfikatory sugerowanych usunięć. Jeśli jest puste, nie ma sugerowanych usunięć tych treści.

textStyle

object (TextStyle)

Styl tekstu tego elementu HorizontalRule.

Podobnie jak w przypadku treści tekstowych, takich jak ciągi tekstowe i odwołania do przypisów, styl tekstu linii poziomej może wpływać na układ treści, a także na styl tekstu wstawionego obok niej.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Sugerowany styl tekstu zmienia się na ten element HorizontalRule, z kluczem w postaci identyfikatora sugestii.

Równanie

Symbol ParagraphElement reprezentujący równanie.

Zapis JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
Pola
suggestedInsertionIds[]

string

Identyfikatory sugerowanych wstawień. Equation może mieć wiele identyfikatorów wstawienia, jeśli jest to zagnieżdżona sugerowana zmiana. Jeśli jest puste, nie jest to sugerowane wstawienie.

suggestedDeletionIds[]

string

Identyfikatory sugerowanych usunięć. Jeśli jest puste, nie ma sugerowanych usunięć tych treści.

InlineObjectElement

ParagraphElement, który zawiera InlineObject.

Zapis JSON
{
  "inlineObjectId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  }
}
Pola
inlineObjectId

string

Identyfikator InlineObject, który zawiera ten element.

suggestedInsertionIds[]

string

Identyfikatory sugerowanych wstawień. InlineObjectElement może mieć wiele identyfikatorów wstawienia, jeśli jest to zagnieżdżona sugerowana zmiana. Jeśli jest puste, nie jest to sugerowane wstawienie.

suggestedDeletionIds[]

string

Identyfikatory sugerowanych usunięć. Jeśli jest puste, nie ma sugerowanych usunięć tych treści.

textStyle

object (TextStyle)

Styl tekstu tego elementu InlineObjectElement.

Podobnie jak w przypadku treści tekstowych, takich jak ciągi tekstowe i odwołania do przypisów, styl tekstu elementu obiektu wbudowanego może wpływać na układ treści, a także na styl tekstu wstawionego obok niego.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Sugerowany styl tekstu zmienia się na ten InlineObject, z kluczem w postaci identyfikatora sugestii.

Osoba

osoba lub adres e-mail wspomniany w dokumencie; Wzmianki te działają jak pojedynczy, niezmienny element zawierający imię i nazwisko lub adres e-mail osoby.

Zapis JSON
{
  "personId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "personProperties": {
    object (PersonProperties)
  }
}
Pola
personId

string

Tylko dane wyjściowe. Unikalny identyfikator tego linku.

suggestedInsertionIds[]

string

Identyfikatory sugestii, które wstawiają do dokumentu link do tej osoby. Person może mieć wiele identyfikatorów wstawienia, jeśli jest to zagnieżdżona sugerowana zmiana (np. sugestia w sugestii innego użytkownika). Jeśli jest puste, link do tej osoby nie jest sugerowanym wstawieniem.

suggestedDeletionIds[]

string

Identyfikatory sugestii, które usuwają link do tej osoby z dokumentu. Person może mieć wiele identyfikatorów usuwania, jeśli na przykład wielu użytkowników zasugeruje jego usunięcie. Jeśli to pole jest puste, link do tej osoby nie jest sugerowany do usunięcia.

textStyle

object (TextStyle)

Styl tekstu tego Person.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Sugerowany styl tekstu zmienia się na Person, z kluczem w postaci identyfikatora sugestii.

personProperties

object (PersonProperties)

Tylko dane wyjściowe. Właściwości tego elementu Person. To pole jest zawsze obecne.

PersonProperties

Usługi powiązane z konkretną usługą Person.

Zapis JSON
{
  "name": string,
  "email": string
}
Pola
name

string

Imię i nazwisko osoby, jeśli jest wyświetlane w tekście linku zamiast adresu e-mail.

email

string

Adres e-mail połączony z tym Person. To pole jest zawsze obecne.

RichLinkProperties

Właściwości charakterystyczne dla RichLink.

Zapis JSON
{
  "title": string,
  "uri": string,
  "mimeType": string
}
Pola
title

string

Tytuł RichLink wyświetlany w linku. Tytuł ten jest zgodny z tytułem połączonego zasobu w momencie wstawienia lub ostatniej aktualizacji linku. To pole jest zawsze obecne.

uri

string

Identyfikator URI do RichLink. Ten element jest zawsze obecny.

mimeType

string

Typ MIME RichLink, jeśli istnieje (np. gdy jest to plik na Dysku).

DateElement

Wystąpienie daty wspomniane w dokumencie.

Zapis JSON
{
  "dateId": string,
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "textStyle": {
    object (TextStyle)
  },
  "suggestedTextStyleChanges": {
    string: {
      object (SuggestedTextStyle)
    },
    ...
  },
  "dateElementProperties": {
    object (DateElementProperties)
  },
  "suggestedDateElementPropertiesChanges": {
    string: {
      object (SuggestedDateElementProperties)
    },
    ...
  }
}
Pola
dateId

string

Tylko dane wyjściowe. Unikalny identyfikator tej daty.

suggestedInsertionIds[]

string

Identyfikatory sugestii, które wstawiają tę datę do dokumentu. Element DateElement może mieć wiele identyfikatorów wstawiania, jeśli jest zagnieżdżoną sugerowaną zmianą (np. sugestią w sugestii innego użytkownika). Jeśli to pole jest puste, ta data nie jest sugerowaną datą wstawienia.

suggestedDeletionIds[]

string

Identyfikatory sugestii, które usuwają tę datę z dokumentu. Element daty może mieć kilka identyfikatorów usuwania, jeśli na przykład kilku użytkowników zaproponuje jego usunięcie. Jeśli to pole jest puste, ta data nie jest sugerowana do usunięcia.

textStyle

object (TextStyle)

Styl tekstu tego elementu DateElement.

suggestedTextStyleChanges

map (key: string, value: object (SuggestedTextStyle))

Sugerowany styl tekstu zmienia się na ten element DateElement, kluczowany przez identyfikator sugestii.

dateElementProperties

object (DateElementProperties)

Właściwości tego elementu DateElement.

suggestedDateElementPropertiesChanges

map (key: string, value: object (SuggestedDateElementProperties))

Sugerowane zmiany właściwości elementu daty, z kluczem w postaci identyfikatora sugestii.

DateElementProperties

Właściwości DateElement.

Zapis JSON
{
  "timestamp": string,
  "timeZoneId": string,
  "locale": string,
  "dateFormat": enum (DateFormat),
  "timeFormat": enum (TimeFormat),
  "displayText": string
}
Pola
timestamp

string (Timestamp format)

Punkt w czasie do przedstawienia w sekundach i nanosekundach od epoki uniksowej: 1 stycznia 1970 r. o północy czasu UTC.

Sygnatura czasowa powinna być podana w czasie UTC. Jeśli parametr timeZoneId jest ustawiony, sygnatura czasowa jest dostosowywana do strefy czasowej. Na przykład sygnatura czasowa 18000 z formatem daty DATE_FORMAT_ISO8601 i formatem czasu TIME_FORMAT_HOUR_MINUTE będzie wyświetlana jako 1970-01-01 5:00 AM. Sygnatura czasowa 18000 z formatem daty DATE_FORMAT_ISO8601, formatem czasu TIME_FORMAT_HOUR_MINUTE i strefą czasową ustawioną na America/New_York zostanie zmieniona na 1970-01-01 12:00 AM.

timeZoneId

string

Strefa czasowa elementu DateElement zdefiniowana przez projekt Unicode Common Locale Data Repository (CLDR). Na przykład: America/New_York. Jeśli nie określisz tego ustawienia, domyślną strefą czasową jest etc/UTC.

locale

string

Kod języka elementu DateElement. Na przykład: en. Jeśli nie określisz tego ustawienia, domyślnym językiem jest en.

Ograniczone do tych języków: af, am, ar, as, az, be, bg, bn, ca, cs, da, de, el, en, en-CA, en-GB, es, es-419, et, eu, fa, fi, fil, fr, fr-CA, gl, gu, hi, hr, hu, hy, id, is, it, iw, ja, ka, kk, km, kn, ko, lo, lt, lv, mk, ml, mn, mr, ms, ne, nl, no, or, pa, pl, pt-BR, pt-PT, ro, ru, si, sk, sl, sq, sr, sv, sw, ta, te, th, tr, uk, ur, uz, vi, zh-CN, zh-HK, zh-TW, zu, cy, my.

dateFormat

enum (DateFormat)

Określa sposób wyświetlania części daty elementu DateElement w dokumencie.

Jeśli nie jest ustawiona, domyślna wartość to DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, co oznacza, że element DateElement będzie formatowany jako MMM d, y w en lub w odpowiedniku w danym języku.

timeFormat

enum (TimeFormat)

Określa, jak część czasu elementu DateElement będzie wyświetlana w dokumencie.

Jeśli nie jest ustawiona, domyślna wartość to TIME_FORMAT_DISABLED, co oznacza, że nie powinna być wyświetlana żadna godzina.

displayText

string

Tylko dane wyjściowe. Określa sposób wyświetlania elementu DateElement w dokumencie.

DateFormat

Możliwe formaty daty w przypadku DateElement.

Wartości w polu enum
DATE_FORMAT_UNSPECIFIED Format daty nie został określony.
DATE_FORMAT_CUSTOM Tylko dane wyjściowe. Format daty jest importowany ze źródła zewnętrznego.
DATE_FORMAT_MONTH_DAY_ABBREVIATED Format daty to skrócona nazwa miesiąca, po której następuje dzień. Na przykład „1 stycznia”.
DATE_FORMAT_MONTH_DAY_FULL Format daty to miesiąc, a po nim dzień. Na przykład „1 stycznia”.
DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED Format daty to skrócona nazwa miesiąca, po której następuje dzień i rok. np. „1 stycznia 1970 r.”.
DATE_FORMAT_ISO8601 Format daty to ISO 8601. Na przykład „1970-01-01”.

TimeFormat

Możliwe formaty czasu w przypadku DateElement.

Wartości w polu enum
TIME_FORMAT_UNSPECIFIED Format czasu nie został określony.
TIME_FORMAT_DISABLED Wskazuje, że data nie zawiera godziny.
TIME_FORMAT_HOUR_MINUTE Format czasu pokazuje godzinę i minutę. Na przykład „1 stycznia 1970 r. 12:00”.
TIME_FORMAT_HOUR_MINUTE_TIMEZONE Format czasu zawiera godzinę, minutę i strefę czasową. Na przykład „1 stycznia 1970 r. 12:00 UTC”.

SuggestedDateElementProperties

Sugerowana zmiana w DateElementProperties.

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

object (DateElementProperties)

DateElementProperties, która zawiera tylko zmiany wprowadzone w tej sugestii. Możesz użyć tej funkcji w połączeniu z dateElementPropertiesSuggestionState, aby sprawdzić, które pola uległy zmianie i jakie są ich nowe wartości.

dateElementPropertiesSuggestionState

object (DateElementPropertiesSuggestionState)

Maska wskazująca, które pola w podstawowym obiekcie DateElementProperties zostały zmienione w tej sugestii.

DateElementPropertiesSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie DateElementProperties zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

Zapis JSON
{
  "timestampSuggested": boolean,
  "timeZoneIdSuggested": boolean,
  "localeSuggested": boolean,
  "dateFormatSuggested": boolean,
  "timeFormatSuggested": boolean
}
Pola
timestampSuggested

boolean

Wskazuje, czy zaproponowano zmianę w timestamp.

timeZoneIdSuggested

boolean

Wskazuje, czy zaproponowano zmianę w timeZoneId.

localeSuggested

boolean

Wskazuje, czy zaproponowano zmianę w locale.

dateFormatSuggested

boolean

Wskazuje, czy zaproponowano zmianę w dateFormat.

timeFormatSuggested

boolean

Wskazuje, czy zaproponowano zmianę w timeFormat.

ParagraphStyle

Style, które mają zastosowanie do całego akapitu.

Dziedziczone style akapitów są w tej wiadomości reprezentowane jako nieustawione pola. Styl akapitu nadrzędnego zależy od tego, gdzie jest zdefiniowany styl akapitu:

  • Element ParagraphStyle w Paragraph dziedziczy po odpowiednim elemencie named style type w akapicie.
  • Obiekt ParagraphStyle w obiekcie named style dziedziczy styl o nazwie normal text.
  • Element ParagraphStyle stylu nazwanego normal text dziedziczy po domyślnym stylu akapitu w edytorze Dokumentów.
  • Element Paragraph w tabeli może dziedziczyć styl akapitu ze stylu tabeli.

Jeśli styl akapitu nie dziedziczy po elemencie nadrzędnym, usunięcie ustawień pól przywróci styl do wartości domyślnych w edytorze Dokumentów.

Zapis JSON
{
  "headingId": string,
  "namedStyleType": enum (NamedStyleType),
  "alignment": enum (Alignment),
  "lineSpacing": number,
  "direction": enum (ContentDirection),
  "spacingMode": enum (SpacingMode),
  "spaceAbove": {
    object (Dimension)
  },
  "spaceBelow": {
    object (Dimension)
  },
  "borderBetween": {
    object (ParagraphBorder)
  },
  "borderTop": {
    object (ParagraphBorder)
  },
  "borderBottom": {
    object (ParagraphBorder)
  },
  "borderLeft": {
    object (ParagraphBorder)
  },
  "borderRight": {
    object (ParagraphBorder)
  },
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "indentEnd": {
    object (Dimension)
  },
  "tabStops": [
    {
      object (TabStop)
    }
  ],
  "keepLinesTogether": boolean,
  "keepWithNext": boolean,
  "avoidWidowAndOrphan": boolean,
  "shading": {
    object (Shading)
  },
  "pageBreakBefore": boolean
}
Pola
headingId

string

Identyfikator nagłówka akapitu. Jeśli jest puste, ten akapit nie jest nagłówkiem.

Ta właściwość jest tylko do odczytu.

namedStyleType

enum (NamedStyleType)

Nazwany typ stylu akapitu.

Ponieważ aktualizacja typu stylu nazwanego wpływa na inne właściwości w obiekcie ParagraphStyle, typ stylu nazwanego jest stosowany przed aktualizacją innych właściwości.

alignment

enum (Alignment)

Wyrównanie tekstu w tym akapicie.

lineSpacing

number

Wielkość odstępu między wierszami jako procent normalnego odstępu, gdzie normalny odstęp jest reprezentowany jako 100, 0. Jeśli nie zostanie ustawiona, wartość jest dziedziczona z elementu nadrzędnego.

direction

enum (ContentDirection)

Kierunek tekstu w tym akapicie. Jeśli nie jest ustawiona, domyślnie przyjmuje wartość LEFT_TO_RIGHT, ponieważ kierunek akapitu nie jest dziedziczony.

spacingMode

enum (SpacingMode)

Tryb odstępów w akapicie.

spaceAbove

object (Dimension)

Wielkość dodatkowego odstępu nad akapitem. Jeśli nie zostanie ustawiona, wartość jest dziedziczona z elementu nadrzędnego.

spaceBelow

object (Dimension)

Wielkość dodatkowego odstępu pod akapitem. Jeśli nie zostanie ustawiona, wartość jest dziedziczona z elementu nadrzędnego.

borderBetween

object (ParagraphBorder)

Obramowanie między tym akapitem a następnym i poprzednim akapitem. Jeśli nie zostanie ustawiona, wartość jest dziedziczona z elementu nadrzędnego.

Obramowanie wewnętrzne jest renderowane, gdy sąsiedni akapit ma takie same właściwości obramowania i wcięcia.

Nie można częściowo zaktualizować obramowań akapitu. Podczas zmiany obramowania akapitu należy określić nowe obramowanie w całości.

borderTop

object (ParagraphBorder)

Obramowanie u góry tego akapitu. Jeśli nie zostanie ustawiona, wartość jest dziedziczona z elementu nadrzędnego.

Górna krawędź jest renderowana, gdy akapit powyżej ma inne właściwości krawędzi i wcięcia.

Nie można częściowo zaktualizować obramowań akapitu. Podczas zmiany obramowania akapitu należy określić nowe obramowanie w całości.

borderBottom

object (ParagraphBorder)

Obramowanie u dołu tego akapitu. Jeśli nie zostanie ustawiona, wartość jest dziedziczona z elementu nadrzędnego.

Dolna krawędź jest renderowana, gdy akapit poniżej ma inne właściwości krawędzi i wcięcia.

Nie można częściowo zaktualizować obramowań akapitu. Podczas zmiany obramowania akapitu należy określić nowe obramowanie w całości.

borderLeft

object (ParagraphBorder)

Obramowanie po lewej stronie tego akapitu. Jeśli nie zostanie ustawiona, wartość jest dziedziczona z elementu nadrzędnego.

Nie można częściowo zaktualizować obramowań akapitu. Podczas zmiany obramowania akapitu należy określić nowe obramowanie w całości.

borderRight

object (ParagraphBorder)

Obramowanie po prawej stronie tego akapitu. Jeśli nie zostanie ustawiona, wartość jest dziedziczona z elementu nadrzędnego.

Nie można częściowo zaktualizować obramowań akapitu. Podczas zmiany obramowania akapitu należy określić nowe obramowanie w całości.

indentFirstLine

object (Dimension)

Wielkość wcięcia pierwszego wiersza akapitu. Jeśli nie zostanie ustawiona, wartość jest dziedziczona z elementu nadrzędnego.

indentStart

object (Dimension)

Wielkość wcięcia akapitu po stronie odpowiadającej początkowi tekstu, na podstawie bieżącego kierunku akapitu. Jeśli nie zostanie ustawiona, wartość jest dziedziczona z elementu nadrzędnego.

indentEnd

object (Dimension)

Wielkość wcięcia akapitu po stronie odpowiadającej końcowi tekstu, na podstawie bieżącego kierunku akapitu. Jeśli nie zostanie ustawiona, wartość jest dziedziczona z elementu nadrzędnego.

tabStops[]

object (TabStop)

Lista tabulatorów tego akapitu. Lista tabulatorów nie jest dziedziczona.

Ta właściwość jest tylko do odczytu.

keepLinesTogether

boolean

Określa, czy wszystkie wiersze akapitu powinny być umieszczone na tej samej stronie lub w tej samej kolumnie, jeśli to możliwe. Jeśli nie zostanie ustawiona, wartość jest dziedziczona z elementu nadrzędnego.

keepWithNext

boolean

Określa, czy przynajmniej część tego akapitu powinna być umieszczona na tej samej stronie lub w tej samej kolumnie co następny akapit, jeśli to możliwe. Jeśli nie zostanie ustawiona, wartość jest dziedziczona z elementu nadrzędnego.

avoidWidowAndOrphan

boolean

Określa, czy w akapitach należy unikać sierot i wdów. Jeśli nie zostanie ustawiona, wartość jest dziedziczona z elementu nadrzędnego.

shading

object (Shading)

Cieniowanie akapitu. Jeśli nie zostanie ustawiona, wartość jest dziedziczona z elementu nadrzędnego.

pageBreakBefore

boolean

Określa, czy bieżący akapit ma zawsze zaczynać się na początku strony. Jeśli nie zostanie ustawiona, wartość jest dziedziczona z elementu nadrzędnego.

Próba zaktualizowania pageBreakBefore w przypadku akapitów w nieobsługiwanych regionach, w tym Table, Header, FooterFootnote, może spowodować nieprawidłowy stan dokumentu, który zwraca błąd 400 (nieprawidłowe żądanie).

NamedStyleType

Typy nazwanych stylów.

Wartości w polu enum
NAMED_STYLE_TYPE_UNSPECIFIED Typ stylu nazwanego nie został określony.
NORMAL_TEXT Zwykły tekst.
TITLE Tytuł.
SUBTITLE Podtytuł.
HEADING_1 Nagłówek 1.
HEADING_2 Nagłówek 2.
HEADING_3 Nagłówek 3.
HEADING_4 Nagłówek 4.
HEADING_5 Nagłówek 5.
HEADING_6 Nagłówek 6.

Wyrównanie

Rodzaje wyrównania tekstu w akapicie.

Wartości w polu enum
ALIGNMENT_UNSPECIFIED Wyrównanie akapitu jest dziedziczone z elementu nadrzędnego.
START Akapit jest wyrównany do początku wiersza. Wyrównanie do lewej w przypadku tekstu od lewej do prawej, w przeciwnym razie wyrównanie do prawej.
CENTER Akapit jest wyśrodkowany.
END Akapit jest wyrównany do końca wiersza. Wyrównanie do prawej w przypadku tekstu od lewej do prawej, w przeciwnym razie wyrównanie do lewej.
JUSTIFIED Akapit jest wyjustowany.

ContentDirection

Kierunek, w którym mogą przepływać treści dotyczące wskazówek.

Wartości w polu enum
CONTENT_DIRECTION_UNSPECIFIED Kierunek treści jest nieokreślony.
LEFT_TO_RIGHT Treść jest wyświetlana od lewej do prawej.
RIGHT_TO_LEFT Treść jest wyświetlana od prawej do lewej.

SpacingMode

Różne tryby odstępów między akapitami.

Wartości w polu enum
SPACING_MODE_UNSPECIFIED Tryb odstępu jest dziedziczony z elementu nadrzędnego.
NEVER_COLLAPSE Odstępy między akapitami są zawsze renderowane.
COLLAPSE_LISTS Odstępy między akapitami są pomijane między elementami listy.

ParagraphBorder

Obramowanie akapitu.

Zapis JSON
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "padding": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
Pola
color

object (OptionalColor)

Kolor obramowania.

width

object (Dimension)

Szerokość obramowania.

padding

object (Dimension)

Wypełnienie obramowania.

dashStyle

enum (DashStyle)

Styl kreskowania obramowania.

DashStyle

Rodzaje kresek, za pomocą których można renderować geometrię liniową. Te wartości są oparte na typie prostym „ST_PresetLineDashVal” opisanym w sekcji 20.1.10.49 dokumentu „Office Open XML File Formats - Fundamentals and Markup Language Reference”, części 1 5 edycji standardu ECMA-376.

Wartości w polu enum
DASH_STYLE_UNSPECIFIED Nieokreślony styl kreski.
SOLID Linia ciągła. Odpowiada wartości „solid” w ECMA-376 ST_PresetLineDashVal. Jest to domyślny styl kreski.
DOT Linia przerywana. Odpowiada wartości „dot” w ECMA-376 ST_PresetLineDashVal.
DASH Linia przerywana. Odpowiada wartości „dash” w ECMA-376 ST_PresetLineDashVal.

TabStop

tabulator w akapicie,

Zapis JSON
{
  "offset": {
    object (Dimension)
  },
  "alignment": enum (TabStopAlignment)
}
Pola
offset

object (Dimension)

Przesunięcie tego tabulatora względem marginesu początkowego.

alignment

enum (TabStopAlignment)

Wyrównanie tego tabulatora. Jeśli nie jest ustawiona, domyślną wartością jest START.

TabStopAlignment

Wyrównanie tabulatora.

Wartości w polu enum
TAB_STOP_ALIGNMENT_UNSPECIFIED Wyrównanie tabulatora jest nieokreślone.
START Tabulator jest wyrównany do początku wiersza. Jest to ustawienie domyślne.
CENTER Tabulator jest wyrównany do środka wiersza.
END Tabulator jest wyrównany do końca wiersza.

Cieniowanie

cieniowanie akapitu,

Zapis JSON
{
  "backgroundColor": {
    object (OptionalColor)
  }
}
Pola
backgroundColor

object (OptionalColor)

Kolor tła cieniowania tego akapitu.

SuggestedParagraphStyle

Sugerowana zmiana w ParagraphStyle.

Zapis JSON
{
  "paragraphStyle": {
    object (ParagraphStyle)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
Pola
paragraphStyle

object (ParagraphStyle)

ParagraphStyle, która zawiera tylko zmiany wprowadzone w tej sugestii. Możesz użyć tej funkcji w połączeniu z paragraphStyleSuggestionState, aby sprawdzić, które pola uległy zmianie i jakie są ich nowe wartości.

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

Maska wskazująca, które pola w podstawowym obiekcie ParagraphStyle zostały zmienione w tej sugestii.

ParagraphStyleSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie ParagraphStyle zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

Zapis JSON
{
  "headingIdSuggested": boolean,
  "namedStyleTypeSuggested": boolean,
  "alignmentSuggested": boolean,
  "lineSpacingSuggested": boolean,
  "directionSuggested": boolean,
  "spacingModeSuggested": boolean,
  "spaceAboveSuggested": boolean,
  "spaceBelowSuggested": boolean,
  "borderBetweenSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "indentEndSuggested": boolean,
  "keepLinesTogetherSuggested": boolean,
  "keepWithNextSuggested": boolean,
  "avoidWidowAndOrphanSuggested": boolean,
  "shadingSuggestionState": {
    object (ShadingSuggestionState)
  },
  "pageBreakBeforeSuggested": boolean
}
Pola
headingIdSuggested

boolean

Wskazuje, czy zaproponowano zmianę w headingId.

namedStyleTypeSuggested

boolean

Wskazuje, czy zaproponowano zmianę w namedStyleType.

alignmentSuggested

boolean

Wskazuje, czy zaproponowano zmianę w alignment.

lineSpacingSuggested

boolean

Wskazuje, czy zaproponowano zmianę w lineSpacing.

directionSuggested

boolean

Wskazuje, czy zaproponowano zmianę w direction.

spacingModeSuggested

boolean

Wskazuje, czy zaproponowano zmianę w spacingMode.

spaceAboveSuggested

boolean

Wskazuje, czy zaproponowano zmianę w spaceAbove.

spaceBelowSuggested

boolean

Wskazuje, czy zaproponowano zmianę w spaceBelow.

borderBetweenSuggested

boolean

Wskazuje, czy zaproponowano zmianę w borderBetween.

borderTopSuggested

boolean

Wskazuje, czy zaproponowano zmianę w borderTop.

borderBottomSuggested

boolean

Wskazuje, czy zaproponowano zmianę w borderBottom.

borderLeftSuggested

boolean

Wskazuje, czy zaproponowano zmianę w borderLeft.

borderRightSuggested

boolean

Wskazuje, czy zaproponowano zmianę w borderRight.

indentFirstLineSuggested

boolean

Wskazuje, czy zaproponowano zmianę w indentFirstLine.

indentStartSuggested

boolean

Wskazuje, czy zaproponowano zmianę w indentStart.

indentEndSuggested

boolean

Wskazuje, czy zaproponowano zmianę w indentEnd.

keepLinesTogetherSuggested

boolean

Wskazuje, czy zaproponowano zmianę w keepLinesTogether.

keepWithNextSuggested

boolean

Wskazuje, czy zaproponowano zmianę w keepWithNext.

avoidWidowAndOrphanSuggested

boolean

Wskazuje, czy zaproponowano zmianę w avoidWidowAndOrphan.

shadingSuggestionState

object (ShadingSuggestionState)

Maska wskazująca, które pola w parametrze shading zostały zmienione w tej sugestii.

pageBreakBeforeSuggested

boolean

Wskazuje, czy zaproponowano zmianę w pageBreakBefore.

ShadingSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie Shading zostały zmienione w tej proponowanej zmianie. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

Zapis JSON
{
  "backgroundColorSuggested": boolean
}
Pola
backgroundColorSuggested

boolean

Wskazuje, czy zaproponowano zmianę w Shading.

Punktor

Opisuje punktor akapitu.

Zapis JSON
{
  "listId": string,
  "nestingLevel": integer,
  "textStyle": {
    object (TextStyle)
  }
}
Pola
listId

string

Identyfikator listy, do której należy ten akapit.

nestingLevel

integer

Poziom zagnieżdżenia tego akapitu na liście.

textStyle

object (TextStyle)

Styl tekstu akapitu zastosowany do tego punktu.

SuggestedBullet

Sugerowana zmiana w Bullet.

Zapis JSON
{
  "bullet": {
    object (Bullet)
  },
  "bulletSuggestionState": {
    object (BulletSuggestionState)
  }
}
Pola
bullet

object (Bullet)

Bullet, która zawiera tylko zmiany wprowadzone w tej sugestii. Możesz użyć tej funkcji w połączeniu z bulletSuggestionState, aby sprawdzić, które pola uległy zmianie i jakie są ich nowe wartości.

bulletSuggestionState

object (BulletSuggestionState)

Maska wskazująca, które pola w podstawowym obiekcie Bullet zostały zmienione w tej sugestii.

BulletSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie Bullet zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

Zapis JSON
{
  "listIdSuggested": boolean,
  "nestingLevelSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  }
}
Pola
listIdSuggested

boolean

Wskazuje, czy zaproponowano zmianę w listId.

nestingLevelSuggested

boolean

Wskazuje, czy zaproponowano zmianę w nestingLevel.

textStyleSuggestionState

object (TextStyleSuggestionState)

Maska wskazująca, które pola w parametrze text style zostały zmienione w tej sugestii.

ObjectReferences

Kolekcja identyfikatorów obiektów.

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

string

Identyfikatory obiektów.

SectionBreak

Znak StructuralElement reprezentujący podział sekcji. Sekcja to zakres treści, które mają ten sam parametr SectionStyle. Podział sekcji oznacza początek nowej sekcji, a styl sekcji jest stosowany do sekcji po podziale.

Treść dokumentu zawsze zaczyna się od podziału sekcji.

Zapis JSON
{
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "sectionStyle": {
    object (SectionStyle)
  }
}
Pola
suggestedInsertionIds[]

string

Identyfikatory sugerowanych wstawień. SectionBreak może mieć wiele identyfikatorów wstawienia, jeśli jest to zagnieżdżona sugerowana zmiana. Jeśli jest puste, nie jest to sugerowane wstawienie.

suggestedDeletionIds[]

string

Identyfikatory sugerowanych usunięć. Jeśli jest puste, nie ma sugerowanych usunięć tych treści.

sectionStyle

object (SectionStyle)

Styl sekcji po tym podziale.

SectionStyle

Styl stosowany w sekcji.

Zapis JSON
{
  "columnProperties": [
    {
      object (SectionColumnProperties)
    }
  ],
  "columnSeparatorStyle": enum (ColumnSeparatorStyle),
  "contentDirection": enum (ContentDirection),
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "sectionType": enum (SectionType),
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "flipPageOrientation": boolean
}
Pola
columnProperties[]

object (SectionColumnProperties)

Właściwości kolumn sekcji.

Jeśli jest pusta, sekcja zawiera 1 kolumnę z właściwościami domyślnymi w edytorze Dokumentów. Sekcja może zawierać maksymalnie 3 kolumny.

Podczas aktualizowania tej właściwości wymagane jest ustawienie konkretnej wartości. Usunięcie tej właściwości spowoduje błąd 400 (Nieprawidłowe żądanie).

columnSeparatorStyle

enum (ColumnSeparatorStyle)

Styl separatorów kolumn.

Ten styl można ustawić nawet wtedy, gdy sekcja zawiera tylko 1 kolumnę.

Podczas aktualizowania tej właściwości wymagane jest ustawienie konkretnej wartości. Usunięcie tej właściwości spowoduje błąd 400 (Nieprawidłowe żądanie).

contentDirection

enum (ContentDirection)

Kierunek treści w tej sekcji. Jeśli nie jest ustawiona, domyślną wartością jest LEFT_TO_RIGHT.

Podczas aktualizowania tej właściwości wymagane jest ustawienie konkretnej wartości. Usunięcie tej właściwości spowoduje błąd 400 (Nieprawidłowe żądanie).

marginTop

object (Dimension)

Górny margines strony sekcji. Jeśli nie zostanie ustawiona, domyślną wartością będzie marginTop z DocumentStyle.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

Podczas aktualizowania tej właściwości wymagane jest ustawienie konkretnej wartości. Usunięcie tej właściwości spowoduje błąd 400 (Nieprawidłowe żądanie).

marginBottom

object (Dimension)

Dolny margines strony sekcji. Jeśli nie zostanie ustawiona, domyślną wartością będzie marginBottom z DocumentStyle.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

Podczas aktualizowania tej właściwości wymagane jest ustawienie konkretnej wartości. Usunięcie tej właściwości spowoduje błąd 400 (Nieprawidłowe żądanie).

marginRight

object (Dimension)

Prawy margines strony sekcji. Jeśli nie zostanie ustawiona, domyślną wartością będzie marginRight z DocumentStyle. Zmiana prawego marginesu powoduje zmianę rozmiaru kolumn w tej sekcji. Margines wpływa na szerokość kolumny, dlatego jest stosowany przed właściwościami kolumny.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

Podczas aktualizowania tej właściwości wymagane jest ustawienie konkretnej wartości. Usunięcie tej właściwości spowoduje błąd 400 (Nieprawidłowe żądanie).

marginLeft

object (Dimension)

Lewy margines strony sekcji. Jeśli nie zostanie ustawiona, domyślną wartością będzie marginLeft z DocumentStyle. Zmiana lewego marginesu powoduje zmianę rozmiaru kolumn w tej sekcji. Margines wpływa na szerokość kolumny, dlatego jest stosowany przed właściwościami kolumny.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

Podczas aktualizowania tej właściwości wymagane jest ustawienie konkretnej wartości. Usunięcie tej właściwości spowoduje błąd 400 (Nieprawidłowe żądanie).

marginHeader

object (Dimension)

Margines nagłówka sekcji. Jeśli nie zostanie ustawiona, domyślną wartością będzie marginHeader z DocumentStyle. Jeśli zostanie zaktualizowany, w DocumentStyle wartość useCustomHeaderFooterMargins zostanie ustawiona na true. Wartość pola useCustomHeaderFooterMargins w obiekcie DocumentStyle wskazuje, czy w tej sekcji uwzględniany jest margines nagłówka.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

Podczas aktualizowania tej właściwości wymagane jest ustawienie konkretnej wartości. Usunięcie tej właściwości spowoduje błąd 400 (Nieprawidłowe żądanie).

sectionType

enum (SectionType)

Tylko dane wyjściowe. Typ sekcji.

defaultHeaderId

string

Identyfikator domyślnego nagłówka. Jeśli ta opcja nie jest ustawiona, wartość jest dziedziczona z poprzedniego elementu SectionBreak's SectionStyle. Jeśli wartość nie jest ustawiona w pierwszym SectionBreak, jest dziedziczona z defaultHeaderId w DocumentStyle.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

Ta właściwość jest tylko do odczytu.

firstPageHeaderId

string

Identyfikator nagłówka używany tylko na pierwszej stronie sekcji. Jeśli wartość useFirstPageHeaderFooter to „true”, ta wartość jest używana jako nagłówek na pierwszej stronie sekcji. Jeśli wartość jest fałszywa, nagłówek na pierwszej stronie sekcji używa defaultHeaderId. Jeśli ta opcja nie jest ustawiona, wartość jest dziedziczona z poprzedniego elementu SectionBreak's SectionStyle. Jeśli wartość nie jest ustawiona w pierwszym SectionBreak, jest dziedziczona z firstPageHeaderId w DocumentStyle.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

Ta właściwość jest tylko do odczytu.

evenPageHeaderId

string

Identyfikator nagłówka używanego tylko na stronach parzystych. Jeśli wartość useEvenPageHeaderFooter w DocumentStyle to prawda, ta wartość jest używana w nagłówkach na stronach parzystych w sekcji. W przypadku wartości false (fałsz) nagłówki na stronach parzystych używają znaku defaultHeaderId. Jeśli ta opcja nie jest ustawiona, wartość jest dziedziczona z poprzedniego elementu SectionBreak's SectionStyle. Jeśli wartość nie jest ustawiona w pierwszym SectionBreak, jest dziedziczona z evenPageHeaderId w DocumentStyle.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

Ta właściwość jest tylko do odczytu.

pageNumberStart

integer

Numer strony, od którego ma się rozpocząć liczenie stron w tej sekcji. Jeśli nie jest ustawione, numerowanie stron jest kontynuowane z poprzedniej sekcji. Jeśli wartość nie jest ustawiona w pierwszym SectionBreak, zapoznaj się z pageNumberStart w DocumentStyle.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

Podczas aktualizowania tej właściwości wymagane jest ustawienie konkretnej wartości. Usunięcie tej właściwości spowoduje błąd 400 (Nieprawidłowe żądanie).

flipPageOrientation

boolean

Opcjonalnie. Wskazuje, czy w przypadku tej sekcji należy odwrócić wymiary pageSize w obiekcie DocumentStyle, co umożliwia zmianę orientacji strony z pionowej na poziomą i odwrotnie. Jeśli nie jest ustawiona, wartość jest dziedziczona z atrybutu flipPageOrientation elementu DocumentStyle.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

Podczas aktualizowania tej właściwości wymagane jest ustawienie konkretnej wartości. Usunięcie tej właściwości spowoduje błąd 400 (Nieprawidłowe żądanie).

SectionColumnProperties

Właściwości, które mają zastosowanie do kolumny sekcji.

Zapis JSON
{
  "width": {
    object (Dimension)
  },
  "paddingEnd": {
    object (Dimension)
  }
}
Pola
width

object (Dimension)

Tylko dane wyjściowe. Szerokość kolumny.

paddingEnd

object (Dimension)

Dopełnienie na końcu kolumny.

ColumnSeparatorStyle

Styl separatorów kolumn między kolumnami.

Wartości w polu enum
COLUMN_SEPARATOR_STYLE_UNSPECIFIED Nieokreślony styl separatora kolumn.
NONE Brak linii rozdzielających kolumny.
BETWEEN_EACH_COLUMN Wyświetla linię separatora kolumn między poszczególnymi kolumnami.

SectionType

Określa, jak początek bieżącej sekcji jest umiejscowiony względem poprzedniej sekcji.

Wartości w polu enum
SECTION_TYPE_UNSPECIFIED Typ sekcji nie został określony.
CONTINUOUS Sekcja zaczyna się bezpośrednio po ostatnim akapicie poprzedniej sekcji.
NEXT_PAGE Sekcja zaczyna się na następnej stronie.

Tabela

StructuralElement reprezentująca tabelę.

Zapis JSON
{
  "rows": integer,
  "columns": integer,
  "tableRows": [
    {
      object (TableRow)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableStyle": {
    object (TableStyle)
  }
}
Pola
rows

integer

Liczba wierszy w tabeli.

columns

integer

Liczba kolumn w tabeli.

Tabela może nie być prostokątna, więc niektóre wiersze mogą mieć inną liczbę komórek.

tableRows[]

object (TableRow)

Zawartość i styl każdego wiersza.

suggestedInsertionIds[]

string

Identyfikatory sugerowanych wstawień. Table może mieć wiele identyfikatorów wstawienia, jeśli jest to zagnieżdżona sugerowana zmiana. Jeśli jest puste, nie jest to sugerowane wstawienie.

suggestedDeletionIds[]

string

Identyfikatory sugerowanych usunięć. Jeśli jest puste, nie ma sugerowanych usunięć tych treści.

tableStyle

object (TableStyle)

Styl tabeli.

TableRow

Zawartość i styl wiersza w Table.

Zapis JSON
{
  "startIndex": integer,
  "endIndex": integer,
  "tableCells": [
    {
      object (TableCell)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "suggestedTableRowStyleChanges": {
    string: {
      object (SuggestedTableRowStyle)
    },
    ...
  }
}
Pola
startIndex

integer

Indeks początkowy tego wiersza liczony od zera w jednostkach kodu UTF-16.

endIndex

integer

Indeks końcowy tego wiersza (liczony od zera, wyłączny) w jednostkach kodu UTF-16.

tableCells[]

object (TableCell)

Zawartość i styl każdej komórki w tym wierszu.

Tabela może nie być prostokątna, więc niektóre wiersze mogą mieć inną liczbę komórek niż inne wiersze w tej samej tabeli.

suggestedInsertionIds[]

string

Identyfikatory sugerowanych wstawień. TableRow może mieć wiele identyfikatorów wstawienia, jeśli jest to zagnieżdżona sugerowana zmiana. Jeśli jest puste, nie jest to sugerowane wstawienie.

suggestedDeletionIds[]

string

Identyfikatory sugerowanych usunięć. Jeśli jest puste, nie ma sugerowanych usunięć tych treści.

tableRowStyle

object (TableRowStyle)

Styl wiersza tabeli.

suggestedTableRowStyleChanges

map (key: string, value: object (SuggestedTableRowStyle))

Sugerowane zmiany stylu w tym wierszu, z kluczem w postaci identyfikatora sugestii.

TableCell

Zawartość i styl komórki w Table.

Zapis JSON
{
  "startIndex": integer,
  "endIndex": integer,
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ],
  "suggestedTableCellStyleChanges": {
    string: {
      object (SuggestedTableCellStyle)
    },
    ...
  }
}
Pola
startIndex

integer

Indeks początkowy tej komórki liczony od zera w jednostkach kodu UTF-16.

endIndex

integer

Indeks końcowy tej komórki (liczony od zera, wyłączny) w jednostkach kodu UTF-16.

content[]

object (StructuralElement)

Zawartość komórki.

tableCellStyle

object (TableCellStyle)

Styl komórki.

suggestedInsertionIds[]

string

Identyfikatory sugerowanych wstawień. TableCell może mieć wiele identyfikatorów wstawienia, jeśli jest to zagnieżdżona sugerowana zmiana. Jeśli jest puste, nie jest to sugerowane wstawienie.

suggestedDeletionIds[]

string

Identyfikatory sugerowanych usunięć. Jeśli jest puste, nie ma sugerowanych usunięć tych treści.

suggestedTableCellStyleChanges

map (key: string, value: object (SuggestedTableCellStyle))

Sugerowane zmiany stylu komórki tabeli, kluczowane według identyfikatora sugestii.

TableCellStyle

Styl elementu TableCell.

Style komórek tabeli, które zostały odziedziczone, są w tym komunikacie reprezentowane jako pola bez ustawionej wartości. Styl komórki tabeli może dziedziczyć styl tabeli.

Zapis JSON
{
  "rowSpan": integer,
  "columnSpan": integer,
  "backgroundColor": {
    object (OptionalColor)
  },
  "borderLeft": {
    object (TableCellBorder)
  },
  "borderRight": {
    object (TableCellBorder)
  },
  "borderTop": {
    object (TableCellBorder)
  },
  "borderBottom": {
    object (TableCellBorder)
  },
  "paddingLeft": {
    object (Dimension)
  },
  "paddingRight": {
    object (Dimension)
  },
  "paddingTop": {
    object (Dimension)
  },
  "paddingBottom": {
    object (Dimension)
  },
  "contentAlignment": enum (ContentAlignment)
}
Pola
rowSpan

integer

Liczba wierszy, które zajmuje komórka.

Ta właściwość jest tylko do odczytu.

columnSpan

integer

Zakres kolumn komórki.

Ta właściwość jest tylko do odczytu.

backgroundColor

object (OptionalColor)

Kolor tła komórki.

borderLeft

object (TableCellBorder)

Lewa krawędź komórki.

borderRight

object (TableCellBorder)

Prawa krawędź komórki.

borderTop

object (TableCellBorder)

Górna krawędź komórki.

borderBottom

object (TableCellBorder)

Dolna krawędź komórki.

paddingLeft

object (Dimension)

Dopełnienie z lewej strony komórki.

paddingRight

object (Dimension)

Dopełnienie z prawej strony komórki.

paddingTop

object (Dimension)

Dopełnienie u góry komórki.

paddingBottom

object (Dimension)

Dopełnienie komórki u dołu.

contentAlignment

enum (ContentAlignment)

Wyrównanie treści w komórce tabeli. Domyślne wyrównanie jest zgodne z wyrównaniem nowo utworzonych komórek tabeli w edytorze Dokumentów.

TableCellBorder

Obramowanie komórki tabeli.

Obramowania komórek tabeli nie mogą być przezroczyste. Aby ukryć obramowanie komórki tabeli, ustaw jego szerokość na 0.

Zapis JSON
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle)
}
Pola
color

object (OptionalColor)

Kolor obramowania.

Ten kolor nie może być przezroczysty.

width

object (Dimension)

Szerokość obramowania.

dashStyle

enum (DashStyle)

Styl kreskowania obramowania.

ContentAlignment

Rodzaje dopasowania treści.

Pochodzi z podzbioru wartości typu prostego „ST_TextAnchoringType” w sekcji 20.1.10.60 dokumentu „Office Open XML File Formats - Fundamentals and Markup Language Reference”, części 1 ECMA-376 w wersji 5.

Wartości w polu enum
CONTENT_ALIGNMENT_UNSPECIFIED Nieokreślone wyrównanie treści. Wyrównanie treści jest dziedziczone z elementu nadrzędnego, jeśli taki istnieje.
CONTENT_ALIGNMENT_UNSUPPORTED Nieobsługiwane wyrównanie treści.
TOP Wyrównanie, które wyrównuje treść do góry kontenera treści. Odpowiada typowi ECMA-376 ST_TextAnchoringType „t”.
MIDDLE Wyrównanie, które wyrównuje treść do środka kontenera treści. Odpowiada typowi ECMA-376 ST_TextAnchoringType „ctr”.
BOTTOM Wyrównanie, które wyrównuje treść do dołu kontenera treści. Odpowiada typowi ECMA-376 ST_TextAnchoringType „b”.

SuggestedTableCellStyle

Sugerowana zmiana w TableCellStyle.

Zapis JSON
{
  "tableCellStyle": {
    object (TableCellStyle)
  },
  "tableCellStyleSuggestionState": {
    object (TableCellStyleSuggestionState)
  }
}
Pola
tableCellStyle

object (TableCellStyle)

TableCellStyle, która zawiera tylko zmiany wprowadzone w tej sugestii. Możesz użyć tej funkcji w połączeniu z tableCellStyleSuggestionState, aby sprawdzić, które pola uległy zmianie i jakie są ich nowe wartości.

tableCellStyleSuggestionState

object (TableCellStyleSuggestionState)

Maska wskazująca, które pola w podstawowym obiekcie TableCellStyle zostały zmienione w tej sugestii.

TableCellStyleSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie TableCellStyle zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

Zapis JSON
{
  "rowSpanSuggested": boolean,
  "columnSpanSuggested": boolean,
  "backgroundColorSuggested": boolean,
  "borderLeftSuggested": boolean,
  "borderRightSuggested": boolean,
  "borderTopSuggested": boolean,
  "borderBottomSuggested": boolean,
  "paddingLeftSuggested": boolean,
  "paddingRightSuggested": boolean,
  "paddingTopSuggested": boolean,
  "paddingBottomSuggested": boolean,
  "contentAlignmentSuggested": boolean
}
Pola
rowSpanSuggested

boolean

Wskazuje, czy zaproponowano zmianę w rowSpan.

columnSpanSuggested

boolean

Wskazuje, czy zaproponowano zmianę w columnSpan.

backgroundColorSuggested

boolean

Wskazuje, czy zaproponowano zmianę w backgroundColor.

borderLeftSuggested

boolean

Wskazuje, czy zaproponowano zmianę w borderLeft.

borderRightSuggested

boolean

Wskazuje, czy zaproponowano zmianę w borderRight.

borderTopSuggested

boolean

Wskazuje, czy zaproponowano zmianę w borderTop.

borderBottomSuggested

boolean

Wskazuje, czy zaproponowano zmianę w borderBottom.

paddingLeftSuggested

boolean

Wskazuje, czy zaproponowano zmianę w paddingLeft.

paddingRightSuggested

boolean

Wskazuje, czy zaproponowano zmianę w paddingRight.

paddingTopSuggested

boolean

Wskazuje, czy zaproponowano zmianę w paddingTop.

paddingBottomSuggested

boolean

Wskazuje, czy zaproponowano zmianę w paddingBottom.

contentAlignmentSuggested

boolean

Wskazuje, czy zaproponowano zmianę w contentAlignment.

TableRowStyle

Style, które mają zastosowanie do wiersza tabeli.

Zapis JSON
{
  "minRowHeight": {
    object (Dimension)
  },
  "tableHeader": boolean,
  "preventOverflow": boolean
}
Pola
minRowHeight

object (Dimension)

Minimalna wysokość wiersza. Wiersz zostanie wyrenderowany w edytorze Dokumentów na wysokości równej lub większej od tej wartości, aby wyświetlić całą zawartość komórek wiersza.

tableHeader

boolean

Określa, czy wiersz jest nagłówkiem tabeli.

preventOverflow

boolean

Określa, czy wiersz nie może przekraczać granic strony lub kolumny.

SuggestedTableRowStyle

Sugerowana zmiana w TableRowStyle.

Zapis JSON
{
  "tableRowStyle": {
    object (TableRowStyle)
  },
  "tableRowStyleSuggestionState": {
    object (TableRowStyleSuggestionState)
  }
}
Pola
tableRowStyle

object (TableRowStyle)

TableRowStyle, która zawiera tylko zmiany wprowadzone w tej sugestii. Możesz użyć tej funkcji w połączeniu z tableRowStyleSuggestionState, aby sprawdzić, które pola uległy zmianie i jakie są ich nowe wartości.

tableRowStyleSuggestionState

object (TableRowStyleSuggestionState)

Maska wskazująca, które pola w podstawowym obiekcie TableRowStyle zostały zmienione w tej sugestii.

TableRowStyleSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie TableRowStyle zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

Zapis JSON
{
  "minRowHeightSuggested": boolean
}
Pola
minRowHeightSuggested

boolean

Wskazuje, czy zaproponowano zmianę w minRowHeight.

TableStyle

Style, które można zastosować do tabeli.

Zapis JSON
{
  "tableColumnProperties": [
    {
      object (TableColumnProperties)
    }
  ]
}
Pola
tableColumnProperties[]

object (TableColumnProperties)

Właściwości każdej kolumny.

Pamiętaj, że w Dokumentach tabele zawierają wiersze, a wiersze zawierają komórki, podobnie jak w HTML. Właściwości wiersza znajdziesz na jego tableRowStyle.

TableColumnProperties

Właściwości kolumny w tabeli.

Zapis JSON
{
  "widthType": enum (WidthType),
  "width": {
    object (Dimension)
  }
}
Pola
widthType

enum (WidthType)

Typ szerokości kolumny.

width

object (Dimension)

Szerokość kolumny. Ustaw, kiedy wartość widthType kolumny to FIXED_WIDTH.

WidthType

Typ szerokości kolumny.

Wartości w polu enum
WIDTH_TYPE_UNSPECIFIED Typ szerokości kolumny nie został określony.
EVENLY_DISTRIBUTED

Szerokość kolumny jest rozdzielana równomiernie między pozostałe kolumny o równomiernym rozkładzie.

Szerokość kolumny jest określana automatycznie i stanowi równą część szerokości pozostałej w tabeli po uwzględnieniu wszystkich kolumn o określonej szerokości.

FIXED_WIDTH stałą szerokość kolumny, Właściwość [width][google.apps.docs.v1.TableColumnProperties.width zawiera szerokość kolumny.

TableOfContents

Ikona StructuralElement reprezentująca spis treści.

Zapis JSON
{
  "content": [
    {
      object (StructuralElement)
    }
  ],
  "suggestedInsertionIds": [
    string
  ],
  "suggestedDeletionIds": [
    string
  ]
}
Pola
content[]

object (StructuralElement)

Zawartość spisu treści.

suggestedInsertionIds[]

string

Identyfikatory sugerowanych wstawień. TableOfContents może mieć wiele identyfikatorów wstawienia, jeśli jest zagnieżdżoną sugerowaną zmianą. Jeśli jest puste, nie jest to sugerowane wstawienie.

suggestedDeletionIds[]

string

Identyfikatory sugerowanych usunięć. Jeśli jest puste, nie ma sugerowanych usunięć tych treści.

Przypis

Przypis w dokumencie.

Zapis JSON
{
  "footnoteId": string,
  "content": [
    {
      object (StructuralElement)
    }
  ]
}
Pola
footnoteId

string

Identyfikator przypisu.

content[]

object (StructuralElement)

Treść przypisu.

Indeksy treści przypisu dolnego zaczynają się od zera.

DocumentStyle

Styl dokumentu.

Zapis JSON
{
  "background": {
    object (Background)
  },
  "defaultHeaderId": string,
  "defaultFooterId": string,
  "evenPageHeaderId": string,
  "evenPageFooterId": string,
  "firstPageHeaderId": string,
  "firstPageFooterId": string,
  "useFirstPageHeaderFooter": boolean,
  "useEvenPageHeaderFooter": boolean,
  "pageNumberStart": integer,
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "pageSize": {
    object (Size)
  },
  "marginHeader": {
    object (Dimension)
  },
  "marginFooter": {
    object (Dimension)
  },
  "useCustomHeaderFooterMargins": boolean,
  "flipPageOrientation": boolean,
  "documentFormat": {
    object (DocumentFormat)
  }
}
Pola
background

object (Background)

tło dokumentu, Dokumenty nie mogą mieć przezroczystego koloru tła.

defaultHeaderId

string

Identyfikator domyślnego nagłówka. Jeśli nie zostanie ustawiony, nie będzie domyślnego nagłówka.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

Ta właściwość jest tylko do odczytu.

evenPageHeaderId

string

Identyfikator nagłówka używanego tylko na stronach parzystych. Wartość useEvenPageHeaderFooter określa, czy w nagłówku na stronach parzystych ma być używana wartość defaultHeaderId czy ta wartość. Jeśli nie jest ustawiony, nagłówek stron parzystych nie jest wyświetlany.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

Ta właściwość jest tylko do odczytu.

firstPageHeaderId

string

Identyfikator nagłówka używany tylko na pierwszej stronie. Jeśli nie jest ustawiony, oznacza to, że nie ma unikalnego nagłówka pierwszej strony. Wartość useFirstPageHeaderFooter określa, czy w nagłówku na pierwszej stronie ma być użyta wartość defaultHeaderId czy ta wartość. Jeśli nie jest ustawiony, nagłówek pierwszej strony nie jest wyświetlany.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

Ta właściwość jest tylko do odczytu.

pageNumberStart

integer

Numer strony, od którego ma się rozpocząć liczenie stron.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

marginTop

object (Dimension)

Górny margines strony.

Zaktualizowanie górnego marginesu strony w stylu dokumentu powoduje wyczyszczenie górnego marginesu strony we wszystkich stylach sekcji.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

marginBottom

object (Dimension)

Dolny margines strony.

Zmiana dolnego marginesu strony w stylu dokumentu powoduje wyczyszczenie dolnego marginesu strony we wszystkich stylach sekcji.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

marginRight

object (Dimension)

Prawy margines strony.

Aktualizacja prawego marginesu strony w stylu dokumentu powoduje wyczyszczenie prawego marginesu strony we wszystkich stylach sekcji. Może to również spowodować zmianę rozmiaru kolumn we wszystkich sekcjach.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

marginLeft

object (Dimension)

Lewy margines strony.

Zmiana lewego marginesu strony w stylu dokumentu powoduje wyczyszczenie lewego marginesu strony we wszystkich stylach sekcji. Może to również spowodować zmianę rozmiaru kolumn we wszystkich sekcjach.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

pageSize

object (Size)

Rozmiar strony w dokumencie.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

marginHeader

object (Dimension)

Ilość miejsca między górą strony a zawartością nagłówka.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

flipPageOrientation

boolean

Opcjonalnie. Określa, czy odwrócić wymiary elementu pageSize, co umożliwia zmianę orientacji strony z pionowej na poziomą i odwrotnie.

Jeśli [DocumentMode][google.apps.docs.v1.DocumentStyle.document_format.document_mode] ma wartość PAGELESS, ta właściwość nie będzie renderowana.

documentFormat

object (DocumentFormat)

Określa ustawienia formatu na poziomie dokumentu, takie jak tryb dokumentu (z podziałem na strony lub bez podziału na strony).

Tło

Reprezentuje tło dokumentu.

Zapis JSON
{
  "color": {
    object (OptionalColor)
  }
}
Pola
color

object (OptionalColor)

Kolor tła.

Rozmiar

szerokość i wysokość;

Zapis JSON
{
  "height": {
    object (Dimension)
  },
  "width": {
    object (Dimension)
  }
}
Pola
height

object (Dimension)

Wysokość obiektu.

width

object (Dimension)

Szerokość obiektu.

DocumentFormat

Reprezentuje ustawienia formatu na poziomie dokumentu.

Zapis JSON
{
  "documentMode": enum (DocumentMode)
}
Pola
documentMode

enum (DocumentMode)

Określa, czy dokument ma podział na strony, czy nie.

DocumentMode

Określa, czy dokument ma podział na strony, czy nie.

Wartości w polu enum
DOCUMENT_MODE_UNSPECIFIED Tryb dokumentu jest nieokreślony.
PAGES Dokument ma strony.
PAGELESS Dokument nie ma podziału na strony.

SuggestedDocumentStyle

Sugerowana zmiana w DocumentStyle.

Zapis JSON
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "documentStyleSuggestionState": {
    object (DocumentStyleSuggestionState)
  }
}
Pola
documentStyle

object (DocumentStyle)

DocumentStyle, która zawiera tylko zmiany wprowadzone w tej sugestii. Możesz użyć tej funkcji w połączeniu z documentStyleSuggestionState, aby sprawdzić, które pola uległy zmianie i jakie są ich nowe wartości.

documentStyleSuggestionState

object (DocumentStyleSuggestionState)

Maska wskazująca, które pola w podstawowym obiekcie DocumentStyle zostały zmienione w tej sugestii.

DocumentStyleSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie DocumentStyle zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

Zapis JSON
{
  "backgroundSuggestionState": {
    object (BackgroundSuggestionState)
  },
  "defaultHeaderIdSuggested": boolean,
  "defaultFooterIdSuggested": boolean,
  "evenPageHeaderIdSuggested": boolean,
  "evenPageFooterIdSuggested": boolean,
  "firstPageHeaderIdSuggested": boolean,
  "firstPageFooterIdSuggested": boolean,
  "useFirstPageHeaderFooterSuggested": boolean,
  "useEvenPageHeaderFooterSuggested": boolean,
  "pageNumberStartSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginLeftSuggested": boolean,
  "pageSizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginHeaderSuggested": boolean,
  "marginFooterSuggested": boolean,
  "useCustomHeaderFooterMarginsSuggested": boolean,
  "flipPageOrientationSuggested": boolean
}
Pola
backgroundSuggestionState

object (BackgroundSuggestionState)

Maska wskazująca, które pola w parametrze background zostały zmienione w tej sugestii.

defaultHeaderIdSuggested

boolean

Wskazuje, czy zaproponowano zmianę w defaultHeaderId.

evenPageHeaderIdSuggested

boolean

Wskazuje, czy zaproponowano zmianę w evenPageHeaderId.

firstPageHeaderIdSuggested

boolean

Wskazuje, czy zaproponowano zmianę w firstPageHeaderId.

pageNumberStartSuggested

boolean

Wskazuje, czy zaproponowano zmianę w pageNumberStart.

marginTopSuggested

boolean

Wskazuje, czy zaproponowano zmianę w marginTop.

marginBottomSuggested

boolean

Wskazuje, czy zaproponowano zmianę w marginBottom.

marginRightSuggested

boolean

Wskazuje, czy zaproponowano zmianę w marginRight.

marginLeftSuggested

boolean

Wskazuje, czy zaproponowano zmianę w marginLeft.

pageSizeSuggestionState

object (SizeSuggestionState)

Maska wskazująca, które pola w [size] [google.apps.docs.v1.DocumentStyle.size] zostały zmienione w tej sugestii.

marginHeaderSuggested

boolean

Wskazuje, czy zaproponowano zmianę w marginHeader.

flipPageOrientationSuggested

boolean

Opcjonalnie. Wskazuje, czy zaproponowano zmianę w flipPageOrientation.

BackgroundSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie Background zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” Backgound ma nową sugerowaną wartość.

Zapis JSON
{
  "backgroundColorSuggested": boolean
}
Pola
backgroundColorSuggested

boolean

Wskazuje, czy bieżący kolor tła został zmodyfikowany w tej sugestii.

SizeSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie Size zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” Size ma nową sugerowaną wartość.

Zapis JSON
{
  "heightSuggested": boolean,
  "widthSuggested": boolean
}
Pola
heightSuggested

boolean

Wskazuje, czy zaproponowano zmianę w height.

widthSuggested

boolean

Wskazuje, czy zaproponowano zmianę w width.

NamedStyles

Style nazwane. Akapity w dokumencie mogą dziedziczyć TextStyle i ParagraphStyle z tych nazwanych stylów.

Zapis JSON
{
  "styles": [
    {
      object (NamedStyle)
    }
  ]
}
Pola
styles[]

object (NamedStyle)

Style nazwane.

Każda możliwa wartość named style types ma swój wpis.

NamedStyle

Styl nazwany. Akapity w dokumencie mogą dziedziczyć TextStyle i ParagraphStyle z tego stylu nazwanego, jeśli mają ten sam typ stylu nazwanego.

Zapis JSON
{
  "namedStyleType": enum (NamedStyleType),
  "textStyle": {
    object (TextStyle)
  },
  "paragraphStyle": {
    object (ParagraphStyle)
  }
}
Pola
namedStyleType

enum (NamedStyleType)

Typ tego stylu nazwanego.

textStyle

object (TextStyle)

Styl tekstu tego stylu nazwanego.

paragraphStyle

object (ParagraphStyle)

Styl akapitu tego stylu nazwanego.

SuggestedNamedStyles

Sugerowana zmiana w NamedStyles.

Zapis JSON
{
  "namedStyles": {
    object (NamedStyles)
  },
  "namedStylesSuggestionState": {
    object (NamedStylesSuggestionState)
  }
}
Pola
namedStyles

object (NamedStyles)

NamedStyles, która zawiera tylko zmiany wprowadzone w tej sugestii. Możesz użyć tej funkcji w połączeniu z namedStylesSuggestionState, aby sprawdzić, które pola uległy zmianie i jakie są ich nowe wartości.

namedStylesSuggestionState

object (NamedStylesSuggestionState)

Maska wskazująca, które pola w podstawowym obiekcie NamedStyles zostały zmienione w tej sugestii.

NamedStylesSuggestionState

Stan sugestii wiadomości NamedStyles.

Zapis JSON
{
  "stylesSuggestionStates": [
    {
      object (NamedStyleSuggestionState)
    }
  ]
}
Pola
stylesSuggestionStates[]

object (NamedStyleSuggestionState)

Maska wskazująca, które pola w odpowiednim polu NamedStylestyles zostały zmienione w tej sugestii.

Kolejność tych stanów sugestii dotyczących stylu nazwanego odpowiada kolejności odpowiednich stylów nazwanych w named styles sugestii.

NamedStyleSuggestionState

Stan sugestii wiadomości NamedStyle.

Zapis JSON
{
  "namedStyleType": enum (NamedStyleType),
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "paragraphStyleSuggestionState": {
    object (ParagraphStyleSuggestionState)
  }
}
Pola
namedStyleType

enum (NamedStyleType)

Nazwany typ stylu, do którego odnosi się ten stan sugestii.

To pole jest udostępniane w celu ułatwienia dopasowania stanu NamedStyleSuggestionState do odpowiedniego elementu NamedStyle.

textStyleSuggestionState

object (TextStyleSuggestionState)

Maska wskazująca, które pola w parametrze text style zostały zmienione w tej sugestii.

paragraphStyleSuggestionState

object (ParagraphStyleSuggestionState)

Maska wskazująca, które pola w parametrze paragraph style zostały zmienione w tej sugestii.

Lista

Lista reprezentuje atrybuty listy dla grupy akapitów, które należą do tej samej listy. Akapit, który jest częścią listy, zawiera odwołanie do identyfikatora listy w polu bullet.

Zapis JSON
{
  "listProperties": {
    object (ListProperties)
  },
  "suggestedListPropertiesChanges": {
    string: {
      object (SuggestedListProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Pola
listProperties

object (ListProperties)

Właściwości listy.

suggestedListPropertiesChanges

map (key: string, value: object (SuggestedListProperties))

Sugerowane zmiany właściwości listy, z kluczami w postaci identyfikatorów sugestii.

suggestedInsertionId

string

Identyfikator sugerowanego wstawienia. Jeśli jest puste, nie jest to sugerowane wstawienie.

suggestedDeletionIds[]

string

Identyfikatory sugerowanych usunięć. Jeśli jest pusta, nie ma sugerowanych usunięć tej listy.

ListProperties

Właściwości elementu list, które opisują wygląd punktorów należących do akapitów powiązanych z listą.

Zapis JSON
{
  "nestingLevels": [
    {
      object (NestingLevel)
    }
  ]
}
Pola
nestingLevels[]

object (NestingLevel)

Opisuje właściwości punktorów na powiązanym poziomie.

Lista może mieć maksymalnie 9 poziomów zagnieżdżenia. Poziom 0 odpowiada najwyższemu poziomowi, a poziom 8 – najbardziej zagnieżdżonemu. Poziomy zagnieżdżenia są zwracane w kolejności rosnącej, przy czym najmniej zagnieżdżony jest zwracany jako pierwszy.

NestingLevel

Zawiera właściwości opisujące wygląd punktora listy na danym poziomie zagnieżdżenia.

Zapis JSON
{
  "bulletAlignment": enum (BulletAlignment),
  "glyphFormat": string,
  "indentFirstLine": {
    object (Dimension)
  },
  "indentStart": {
    object (Dimension)
  },
  "textStyle": {
    object (TextStyle)
  },
  "startNumber": integer,

  "glyphType": enum (GlyphType),
  "glyphSymbol": string
}
Pola
bulletAlignment

enum (BulletAlignment)

Wyrównanie punktora w przestrzeni przeznaczonej na jego renderowanie.

glyphFormat

string

Ciąg formatu używany przez punktor na tym poziomie zagnieżdżenia.

Format glifu zawiera co najmniej 1 symbol zastępczy, który jest zastępowany odpowiednimi wartościami w zależności od glyphType lub glyphSymbol. Zmienne mają format %[nestingLevel]. Poza tym wartości zastępcze mogą mieć prefiksy i sufiksy. Format glifu jest więc zgodny ze wzorcem <prefix>%[nestingLevel]<suffix>. Pamiętaj, że prefiks i sufiks są opcjonalne i mogą być dowolnymi ciągami znaków.

Na przykład format glifu %0. oznacza, że renderowany glif zastąpi symbol zastępczy odpowiednim glifem dla poziomu zagnieżdżenia 0, a następnie doda kropkę jako sufiks. Lista z typem glifu UPPER_ALPHA i formatem glifu %0. na poziomie zagnieżdżenia 0 spowoduje wyświetlenie listy z wyrenderowanymi glifami.

A.

B.

C.

Format glifu może zawierać symbole zastępcze dla bieżącego poziomu zagnieżdżenia, a także symbole zastępcze dla nadrzędnych poziomów zagnieżdżenia. Na przykład lista może mieć format glifu %0. na poziomie zagnieżdżenia 0 i format glifu %0.%1. na poziomie zagnieżdżenia 1. Jeśli oba poziomy zagnieżdżenia mają typy glifów DECIMAL, spowoduje to utworzenie listy z renderowanymi glifami.

1.

2.

2.1.

2.2.

3.

W przypadku zagnieżdżonych poziomów, które są uporządkowane, ciąg znaków zastępujący symbol zastępczy w formacie glifu dla danego akapitu zależy od kolejności akapitu na liście.

indentFirstLine

object (Dimension)

Wielkość wcięcia pierwszego wiersza akapitów na tym poziomie zagnieżdżenia.

indentStart

object (Dimension)

Wielkość wcięcia akapitów na tym poziomie zagnieżdżenia. Stosowane po stronie odpowiadającej początkowi tekstu, na podstawie kierunku treści akapitu.

textStyle

object (TextStyle)

Styl tekstu punktorów na tym poziomie umieszczania.

startNumber

integer

Numer pierwszej pozycji listy na tym poziomie zagnieżdżenia.

W przypadku list oznaczonych literami i cyframi rzymskimi wartość 0 jest traktowana jako 1. W przypadku wartości 0 i 1 listy z literami i cyframi rzymskimi będą zaczynać się odpowiednio od a i i.

Ta wartość jest ignorowana w przypadku poziomów zagnieżdżenia z nieuporządkowanymi glifami.

Pole zbiorcze glyph_kind. Rodzaj glifu używanego w wypunktowaniach. Określa symbol punktora, który zastępuje symbole zastępcze w elemencie glyph_format. glyph_kind może mieć tylko jedną z tych wartości:
glyphType

enum (GlyphType)

Typ glifu używanego przez punktor, gdy akapity na tym poziomie zagnieżdżenia są uporządkowane.

Typ glifu określa rodzaj glifu używanego do zastępowania symboli zastępczych w elemencie glyphFormat, gdy akapity na tym poziomie zagnieżdżenia są uporządkowane. Jeśli na przykład poziom zagnieżdżenia wynosi 0, glyphFormat to %0., a typ glifu to DECIMAL, wyrenderowany glif zastąpi symbol zastępczy %0 w formacie glifu liczbą odpowiadającą kolejności elementu listy na liście.

glyphSymbol

string

Niestandardowy symbol glifu używany przez punktor, gdy akapity na tym poziomie zagnieżdżenia są nieuporządkowane.

Symbol glifu zastępuje symbole zastępcze w glyphFormat. Jeśli na przykład glyphSymbol to pełne koło odpowiadające punktowi kodu Unicode U+25cf, a glyphFormat to %0, renderowany znak to pełne koło.

BulletAlignment

Rodzaje wyrównania punktorów.

Wartości w polu enum
BULLET_ALIGNMENT_UNSPECIFIED Wyrównanie punktorów jest nieokreślone.
START Punktor jest wyrównany do początku miejsca przeznaczonego na jego renderowanie. Wyrównanie do lewej w przypadku tekstu od lewej do prawej, w przeciwnym razie wyrównanie do prawej.
CENTER Punktor jest wyrównany do środka miejsca przeznaczonego na jego renderowanie.
END Punktor jest wyrównany do końca miejsca przeznaczonego na jego renderowanie. Wyrównanie do prawej w przypadku tekstu od lewej do prawej, w przeciwnym razie wyrównanie do lewej.

GlyphType

Rodzaje glifów używanych przez punktor, gdy akapity na tym poziomie zagnieżdżenia są uporządkowane.

Wartości w polu enum
GLYPH_TYPE_UNSPECIFIED Typ glifu jest nieokreślony lub nieobsługiwany.
NONE Pusty ciąg znaków.
DECIMAL Liczba, np. 1, 2 lub 3.
ZERO_DECIMAL Liczba, w której jednocyfrowe numery są poprzedzone zerem, np. 01, 02 lub 03. Liczby wielocyfrowe nie mają zera na początku.
UPPER_ALPHA Wielka litera, np. A, B lub C.
ALPHA małą literę, np. a, b lub c;
UPPER_ROMAN Wielka litera rzymska, np. I, II lub III.
ROMAN Mała cyfra rzymska, np. i, ii lub iii.

SuggestedListProperties

Sugerowana zmiana w ListProperties.

Zapis JSON
{
  "listProperties": {
    object (ListProperties)
  },
  "listPropertiesSuggestionState": {
    object (ListPropertiesSuggestionState)
  }
}
Pola
listProperties

object (ListProperties)

ListProperties, która zawiera tylko zmiany wprowadzone w tej sugestii. Możesz użyć tej funkcji w połączeniu z listPropertiesSuggestionState, aby sprawdzić, które pola uległy zmianie i jakie są ich nowe wartości.

listPropertiesSuggestionState

object (ListPropertiesSuggestionState)

Maska wskazująca, które pola w podstawowym obiekcie ListProperties zostały zmienione w tej sugestii.

ListPropertiesSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie ListProperties zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

Zapis JSON
{
  "nestingLevelsSuggestionStates": [
    {
      object (NestingLevelSuggestionState)
    }
  ]
}
Pola
nestingLevelsSuggestionStates[]

object (NestingLevelSuggestionState)

Maska wskazująca, które pola w odpowiednim polu NestingLevelnestingLevels zostały zmienione w tej sugestii.

Stany sugestii poziomu zagnieżdżenia są zwracane w kolejności rosnącej poziomu zagnieżdżenia, przy czym najpierw zwracany jest najmniej zagnieżdżony poziom.

NestingLevelSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie NestingLevel zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

Zapis JSON
{
  "bulletAlignmentSuggested": boolean,
  "glyphTypeSuggested": boolean,
  "glyphFormatSuggested": boolean,
  "glyphSymbolSuggested": boolean,
  "indentFirstLineSuggested": boolean,
  "indentStartSuggested": boolean,
  "textStyleSuggestionState": {
    object (TextStyleSuggestionState)
  },
  "startNumberSuggested": boolean
}
Pola
bulletAlignmentSuggested

boolean

Wskazuje, czy zaproponowano zmianę w bulletAlignment.

glyphTypeSuggested

boolean

Wskazuje, czy zaproponowano zmianę w glyphType.

glyphFormatSuggested

boolean

Wskazuje, czy zaproponowano zmianę w glyphFormat.

glyphSymbolSuggested

boolean

Wskazuje, czy zaproponowano zmianę w glyphSymbol.

indentFirstLineSuggested

boolean

Wskazuje, czy zaproponowano zmianę w indentFirstLine.

indentStartSuggested

boolean

Wskazuje, czy zaproponowano zmianę w indentStart.

textStyleSuggestionState

object (TextStyleSuggestionState)

Maska wskazująca, które pola w parametrze text style zostały zmienione w tej sugestii.

startNumberSuggested

boolean

Wskazuje, czy zaproponowano zmianę w startNumber.

NamedRanges

Kolekcja wszystkich NamedRangew dokumencie, które mają daną nazwę.

Zapis JSON
{
  "name": string,
  "namedRanges": [
    {
      object (NamedRange)
    }
  ]
}
Pola
name

string

Nazwa, która jest wspólna dla wszystkich named ranges.

namedRanges[]

object (NamedRange)

NamedRange o tej samej nazwie.

NamedRange

Kolekcja obiektów Range o tym samym identyfikatorze zakresu nazwanego.

Nazwane zakresy umożliwiają deweloperom powiązanie części dokumentu z dowolną etykietą zdefiniowaną przez użytkownika, dzięki czemu zawartość można później odczytać lub edytować programowo. Dokument może zawierać wiele zakresów nazwanych o tej samej nazwie, ale każdy zakres nazwany ma unikalny identyfikator.

Zakres nazwany jest tworzony za pomocą pojedynczego znaku Range, a treści wstawiane do zakresu nazwanego zwykle go rozszerzają. Niektóre zmiany w dokumencie mogą jednak spowodować podział zakresu na kilka mniejszych.

Zakresy nazwane nie są prywatne. Wszystkie aplikacje i współpracownicy, którzy mają dostęp do dokumentu, mogą wyświetlać jego nazwane zakresy.

Zapis JSON
{
  "namedRangeId": string,
  "name": string,
  "ranges": [
    {
      object (Range)
    }
  ]
}
Pola
namedRangeId

string

Identyfikator nazwanego zakresu.

name

string

Nazwa zakresu nazwanego.

ranges[]

object (Range)

Zakresy należące do tego zakresu nazwanego.

Zakres

Określa ciągły zakres tekstu.

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

string

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

startIndex

integer

Indeks początkowy tego zakresu (liczony od zera) w jednostkach kodu UTF-16.

We wszystkich obecnych zastosowaniach należy podać indeks początkowy. To pole jest typu Int32Value, aby uwzględnić przyszłe przypadki użycia z zakresami otwartymi.

endIndex

integer

Indeks końcowy tego zakresu (liczony od zera, wyłączony) w jednostkach kodu UTF-16.

We wszystkich obecnych zastosowaniach należy podać indeks końcowy. To pole jest typu Int32Value, aby uwzględnić przyszłe przypadki użycia z zakresami otwartymi.

tabId

string

Karta, która zawiera ten zakres. Jeśli ten parametr zostanie pominięty, żądanie będzie dotyczyć pierwszej karty.

W dokumencie zawierającym jedną kartę:

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

  • Jeśli ten argument nie zostanie podany, żą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 zostanie zastosowane do pierwszej karty w dokumencie.

InlineObject

Obiekt, który pojawia się w tekście. Obiekt InlineObject zawiera EmbeddedObject, np. obraz.

Zapis JSON
{
  "objectId": string,
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "suggestedInlineObjectPropertiesChanges": {
    string: {
      object (SuggestedInlineObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Pola
objectId

string

Identyfikator tego obiektu wstawionego. Może służyć do aktualizowania właściwości obiektu.

inlineObjectProperties

object (InlineObjectProperties)

Właściwości tego obiektu wbudowanego.

suggestedInlineObjectPropertiesChanges

map (key: string, value: object (SuggestedInlineObjectProperties))

Sugerowane zmiany właściwości obiektu wbudowanego, z kluczem w postaci identyfikatora sugestii.

suggestedInsertionId

string

Identyfikator sugerowanego wstawienia. Jeśli jest puste, nie jest to sugerowane wstawienie.

suggestedDeletionIds[]

string

Identyfikatory sugerowanych usunięć. Jeśli jest puste, nie ma sugerowanych usunięć tych treści.

InlineObjectProperties

Właściwości InlineObject.

Zapis JSON
{
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
Pola
embeddedObject

object (EmbeddedObject)

Umieszczony obiekt tego obiektu wbudowanego.

EmbeddedObject

Obiekt umieszczony w dokumencie.

Zapis JSON
{
  "title": string,
  "description": string,
  "embeddedObjectBorder": {
    object (EmbeddedObjectBorder)
  },
  "size": {
    object (Size)
  },
  "marginTop": {
    object (Dimension)
  },
  "marginBottom": {
    object (Dimension)
  },
  "marginRight": {
    object (Dimension)
  },
  "marginLeft": {
    object (Dimension)
  },
  "linkedContentReference": {
    object (LinkedContentReference)
  },

  "embeddedDrawingProperties": {
    object (EmbeddedDrawingProperties)
  },
  "imageProperties": {
    object (ImageProperties)
  }
}
Pola
title

string

Tytuł osadzonego obiektu. Elementy titledescription są łączone w celu wyświetlenia tekstu alternatywnego.

description

string

Opis obiektu osadzonego. Elementy titledescription są łączone w celu wyświetlenia tekstu alternatywnego.

embeddedObjectBorder

object (EmbeddedObjectBorder)

Obramowanie umieszczonego obiektu.

size

object (Size)

Widoczny rozmiar obrazu po przycięciu.

marginTop

object (Dimension)

Górny margines obiektu osadzonego.

marginBottom

object (Dimension)

Dolny margines obiektu osadzonego.

marginRight

object (Dimension)

Prawy margines obiektu osadzonego.

marginLeft

object (Dimension)

Lewy margines obiektu osadzonego.

linkedContentReference

object (LinkedContentReference)

Odniesienie do połączonych treści ze źródła zewnętrznego. Na przykład zawiera odwołanie do źródłowego wykresu Arkuszy Google, gdy osadzony obiekt jest połączonym wykresem.

Jeśli to pole nie jest ustawione, umieszczony obiekt nie jest połączony.

Pole zbiorcze properties. Właściwości, które są specyficzne dla każdego typu obiektu osadzonego. properties może mieć tylko jedną z tych wartości:
embeddedDrawingProperties

object (EmbeddedDrawingProperties)

Właściwości rysunku umieszczonego.

imageProperties

object (ImageProperties)

Właściwości obrazu.

EmbeddedDrawingProperties

Ten typ nie ma pól.

Właściwości umieszczonego rysunku służą do rozróżniania typu obiektu. Rysunek umieszczony to taki, który został utworzony i edytowany w dokumencie. Pamiętaj, że szczegółowe informacje nie są obsługiwane.

ImageProperties

Właściwości obrazu.

Zapis JSON
{
  "contentUri": string,
  "sourceUri": string,
  "brightness": number,
  "contrast": number,
  "transparency": number,
  "cropProperties": {
    object (CropProperties)
  },
  "angle": number
}
Pola
contentUri

string

Identyfikator URI obrazu z domyślnym czasem życia wynoszącym 30 minut. Ten identyfikator URI jest oznaczony kontem osoby składającej prośbę. Każda osoba, która ma identyfikator URI, uzyskuje dostęp do obrazu jako pierwotny wnioskodawca. Jeśli ustawienia udostępniania dokumentu ulegną zmianie, dostęp do obrazu może zostać utracony.

sourceUri

string

Identyfikator URI źródła to identyfikator URI użyty do wstawienia obrazu. Identyfikator URI źródła może być pusty.

brightness

number

Efekt jasności obrazu. Wartość powinna mieścić się w przedziale [-1,0, 1,0], gdzie 0 oznacza brak efektu.

contrast

number

Efekt kontrastu obrazu. Wartość powinna mieścić się w przedziale [-1,0, 1,0], gdzie 0 oznacza brak efektu.

transparency

number

Efekt przezroczystości obrazu. Wartość powinna mieścić się w przedziale [0,0, 1,0], gdzie 0 oznacza brak efektu, a 1 – przezroczystość.

cropProperties

object (CropProperties)

Właściwości przycięcia obrazu.

angle

number

Kąt obrotu obrazu w prawo w radianach.

CropProperties

Właściwości przycięcia obrazu.

Prostokąt przycięcia jest reprezentowany za pomocą ułamkowych przesunięć od 4 krawędzi oryginalnej treści.

  • Jeśli przesunięcie mieści się w przedziale (0, 1), odpowiednia krawędź prostokąta przycinania jest umieszczana wewnątrz pierwotnego prostokąta ograniczającego obrazu.
  • Jeśli przesunięcie jest ujemne lub większe niż 1, odpowiednia krawędź prostokąta przycinania jest umieszczana poza oryginalnym prostokątem ograniczającym obrazu.
  • Jeśli wszystkie przesunięcia i kąty obrotu wynoszą 0, obraz nie jest przycinany.
Zapis JSON
{
  "offsetLeft": number,
  "offsetRight": number,
  "offsetTop": number,
  "offsetBottom": number,
  "angle": number
}
Pola
offsetLeft

number

Przesunięcie określa, jak daleko od lewej krawędzi oryginalnej treści znajduje się lewa krawędź prostokąta przycinania. Jest to ułamek szerokości oryginalnej treści.

offsetRight

number

Przesunięcie określa, jak daleko od prawej krawędzi oryginalnej treści znajduje się prawa krawędź prostokąta przycinania. Jest to ułamek szerokości oryginalnej treści.

offsetTop

number

Przesunięcie określa, jak daleko od górnej krawędzi oryginalnej treści znajduje się górna krawędź prostokąta przycięcia. Jest to ułamek wysokości oryginalnej treści.

offsetBottom

number

Przesunięcie określa, jak daleko od dolnej krawędzi oryginalnej treści znajduje się dolna krawędź prostokąta przycinania. Jest to ułamek wysokości oryginalnej treści.

angle

number

Kąt obrotu prostokąta przycinania wokół jego środka w radianach. Obrót jest stosowany po przesunięciach.

EmbeddedObjectBorder

Obramowanie wokół EmbeddedObject.

Zapis JSON
{
  "color": {
    object (OptionalColor)
  },
  "width": {
    object (Dimension)
  },
  "dashStyle": enum (DashStyle),
  "propertyState": enum (PropertyState)
}
Pola
color

object (OptionalColor)

Kolor obramowania.

width

object (Dimension)

Szerokość obramowania.

dashStyle

enum (DashStyle)

Styl kreskowania obramowania.

propertyState

enum (PropertyState)

Stan właściwości właściwości obramowania.

PropertyState

Możliwe stany usługi.

Wartości w polu enum
RENDERED Jeśli stan właściwości to RENDERED, element ma odpowiednią właściwość podczas renderowania w dokumencie. Jest to wartość domyślna.
NOT_RENDERED Jeśli stan właściwości to NOT_RENDERED, element nie ma odpowiedniej właściwości podczas renderowania w dokumencie.

LinkedContentReference

Odniesienie do połączonych treści ze źródła zewnętrznego.

Zapis JSON
{

  "sheetsChartReference": {
    object (SheetsChartReference)
  }
}
Pola
Pole zbiorcze reference. Odwołanie do konkretnego typu połączonych treści. reference może mieć tylko jedną z tych wartości:
sheetsChartReference

object (SheetsChartReference)

Odwołanie do połączonego wykresu.

SheetsChartReference

Odwołanie do połączonego wykresu umieszczonego z Arkuszy Google.

Zapis JSON
{
  "spreadsheetId": string,
  "chartId": integer
}
Pola
spreadsheetId

string

Identyfikator arkusza kalkulacyjnego Google, który zawiera wykres źródłowy.

chartId

integer

Identyfikator konkretnego wykresu w osadzonym arkuszu kalkulacyjnym Google.

SuggestedInlineObjectProperties

Sugerowana zmiana w InlineObjectProperties.

Zapis JSON
{
  "inlineObjectProperties": {
    object (InlineObjectProperties)
  },
  "inlineObjectPropertiesSuggestionState": {
    object (InlineObjectPropertiesSuggestionState)
  }
}
Pola
inlineObjectProperties

object (InlineObjectProperties)

InlineObjectProperties, która zawiera tylko zmiany wprowadzone w tej sugestii. Możesz użyć tej funkcji w połączeniu z inlineObjectPropertiesSuggestionState, aby sprawdzić, które pola uległy zmianie i jakie są ich nowe wartości.

inlineObjectPropertiesSuggestionState

object (InlineObjectPropertiesSuggestionState)

Maska wskazująca, które pola w podstawowym obiekcie InlineObjectProperties zostały zmienione w tej sugestii.

InlineObjectPropertiesSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie InlineObjectProperties zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

Zapis JSON
{
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
Pola
embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

Maska wskazująca, które pola w parametrze embeddedObject zostały zmienione w tej sugestii.

EmbeddedObjectSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie EmbeddedObject zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

Zapis JSON
{
  "embeddedDrawingPropertiesSuggestionState": {
    object (EmbeddedDrawingPropertiesSuggestionState)
  },
  "imagePropertiesSuggestionState": {
    object (ImagePropertiesSuggestionState)
  },
  "titleSuggested": boolean,
  "descriptionSuggested": boolean,
  "embeddedObjectBorderSuggestionState": {
    object (EmbeddedObjectBorderSuggestionState)
  },
  "sizeSuggestionState": {
    object (SizeSuggestionState)
  },
  "marginLeftSuggested": boolean,
  "marginRightSuggested": boolean,
  "marginTopSuggested": boolean,
  "marginBottomSuggested": boolean,
  "linkedContentReferenceSuggestionState": {
    object (LinkedContentReferenceSuggestionState)
  }
}
Pola
embeddedDrawingPropertiesSuggestionState

object (EmbeddedDrawingPropertiesSuggestionState)

Maska wskazująca, które pola w parametrze embeddedDrawingProperties zostały zmienione w tej sugestii.

imagePropertiesSuggestionState

object (ImagePropertiesSuggestionState)

Maska wskazująca, które pola w parametrze imageProperties zostały zmienione w tej sugestii.

titleSuggested

boolean

Wskazuje, czy zaproponowano zmianę w title.

descriptionSuggested

boolean

Wskazuje, czy zaproponowano zmianę w description.

embeddedObjectBorderSuggestionState

object (EmbeddedObjectBorderSuggestionState)

Maska wskazująca, które pola w parametrze embeddedObjectBorder zostały zmienione w tej sugestii.

sizeSuggestionState

object (SizeSuggestionState)

Maska wskazująca, które pola w parametrze size zostały zmienione w tej sugestii.

marginLeftSuggested

boolean

Wskazuje, czy zaproponowano zmianę w marginLeft.

marginRightSuggested

boolean

Wskazuje, czy zaproponowano zmianę w marginRight.

marginTopSuggested

boolean

Wskazuje, czy zaproponowano zmianę w marginTop.

marginBottomSuggested

boolean

Wskazuje, czy zaproponowano zmianę w marginBottom.

linkedContentReferenceSuggestionState

object (LinkedContentReferenceSuggestionState)

Maska wskazująca, które pola w parametrze linkedContentReference zostały zmienione w tej sugestii.

EmbeddedDrawingPropertiesSuggestionState

Ten typ nie ma pól.

Maska wskazująca, które pola w podstawowym obiekcie EmbeddedDrawingProperties zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

ImagePropertiesSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie ImageProperties zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

Zapis JSON
{
  "contentUriSuggested": boolean,
  "sourceUriSuggested": boolean,
  "brightnessSuggested": boolean,
  "contrastSuggested": boolean,
  "transparencySuggested": boolean,
  "cropPropertiesSuggestionState": {
    object (CropPropertiesSuggestionState)
  },
  "angleSuggested": boolean
}
Pola
contentUriSuggested

boolean

Wskazuje, czy zaproponowano zmianę w contentUri.

sourceUriSuggested

boolean

Wskazuje, czy zaproponowano zmianę w [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri].

brightnessSuggested

boolean

Wskazuje, czy zaproponowano zmianę [jasności] [google.apps.docs.v1.EmbeddedObject.brightness].

contrastSuggested

boolean

Wskazuje, czy zaproponowano zmianę [kontrastu] [google.apps.docs.v1.EmbeddedObject.contrast].

transparencySuggested

boolean

Wskazuje, czy zaproponowano zmianę [przezroczystości] [google.apps.docs.v1.EmbeddedObject.transparency].

cropPropertiesSuggestionState

object (CropPropertiesSuggestionState)

Maska wskazująca, które pola w parametrze cropProperties zostały zmienione w tej sugestii.

angleSuggested

boolean

Wskazuje, czy zaproponowano zmianę [angle] [google.apps.docs.v1.EmbeddedObject.angle].

CropPropertiesSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie CropProperties zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

Zapis JSON
{
  "offsetLeftSuggested": boolean,
  "offsetRightSuggested": boolean,
  "offsetTopSuggested": boolean,
  "offsetBottomSuggested": boolean,
  "angleSuggested": boolean
}
Pola
offsetLeftSuggested

boolean

Wskazuje, czy zaproponowano zmianę w offsetLeft.

offsetRightSuggested

boolean

Wskazuje, czy zaproponowano zmianę w offsetRight.

offsetTopSuggested

boolean

Wskazuje, czy zaproponowano zmianę w offsetTop.

offsetBottomSuggested

boolean

Wskazuje, czy zaproponowano zmianę w offsetBottom.

angleSuggested

boolean

Wskazuje, czy zaproponowano zmianę w angle.

EmbeddedObjectBorderSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie EmbeddedObjectBorder zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

Zapis JSON
{
  "colorSuggested": boolean,
  "widthSuggested": boolean,
  "dashStyleSuggested": boolean,
  "propertyStateSuggested": boolean
}
Pola
colorSuggested

boolean

Wskazuje, czy zaproponowano zmianę [koloru] [google.apps.docs.v1.EmbeddedBorderObject.color].

widthSuggested

boolean

Wskazuje, czy zaproponowano zmianę [width] [google.apps.docs.v1.EmbeddedBorderObject.width].

dashStyleSuggested

boolean

Wskazuje, czy zaproponowano zmianę [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style].

propertyStateSuggested

boolean

Wskazuje, czy zaproponowano zmianę w [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state].

LinkedContentReferenceSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie LinkedContentReference zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

Zapis JSON
{
  "sheetsChartReferenceSuggestionState": {
    object (SheetsChartReferenceSuggestionState)
  }
}
Pola
sheetsChartReferenceSuggestionState

object (SheetsChartReferenceSuggestionState)

Maska wskazująca, które pola w parametrze sheetsChartReference zostały zmienione w tej sugestii.

SheetsChartReferenceSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie SheetsChartReference zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

Zapis JSON
{
  "spreadsheetIdSuggested": boolean,
  "chartIdSuggested": boolean
}
Pola
spreadsheetIdSuggested

boolean

Wskazuje, czy zaproponowano zmianę w spreadsheetId.

chartIdSuggested

boolean

Wskazuje, czy zaproponowano zmianę w chartId.

PositionedObject

Obiekt, który jest przywiązany do Paragraph i umieszczony względem początku akapitu. Obiekt PositionedObject zawiera EmbeddedObject, np. obraz.

Zapis JSON
{
  "objectId": string,
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "suggestedPositionedObjectPropertiesChanges": {
    string: {
      object (SuggestedPositionedObjectProperties)
    },
    ...
  },
  "suggestedInsertionId": string,
  "suggestedDeletionIds": [
    string
  ]
}
Pola
objectId

string

Identyfikator tego obiektu umieszczonego w określonym miejscu.

positionedObjectProperties

object (PositionedObjectProperties)

Właściwości tego obiektu z określonym położeniem.

suggestedPositionedObjectPropertiesChanges

map (key: string, value: object (SuggestedPositionedObjectProperties))

Sugerowane zmiany właściwości obiektu umieszczonego w określonym miejscu, z kluczem w postaci identyfikatora sugestii.

suggestedInsertionId

string

Identyfikator sugerowanego wstawienia. Jeśli jest puste, nie jest to sugerowane wstawienie.

suggestedDeletionIds[]

string

Identyfikatory sugerowanych usunięć. Jeśli jest puste, nie ma sugerowanych usunięć tych treści.

PositionedObjectProperties

Właściwości PositionedObject.

Zapis JSON
{
  "positioning": {
    object (PositionedObjectPositioning)
  },
  "embeddedObject": {
    object (EmbeddedObject)
  }
}
Pola
positioning

object (PositionedObjectPositioning)

Położenie tego obiektu względem znaku nowego wiersza w elemencie Paragraph, który odwołuje się do tego obiektu.

embeddedObject

object (EmbeddedObject)

Umieszczony obiekt tego obiektu z określonym położeniem.

PositionedObjectPositioning

Położenie PositionedObject. Pozycjonowany obiekt jest umieszczany względem początku Paragraph, do którego jest przywiązany.

Zapis JSON
{
  "layout": enum (PositionedObjectLayout),
  "leftOffset": {
    object (Dimension)
  },
  "topOffset": {
    object (Dimension)
  }
}
Pola
layout

enum (PositionedObjectLayout)

Układ tego obiektu umieszczonego w określonym miejscu.

leftOffset

object (Dimension)

Przesunięcie lewej krawędzi pozycjonowanego obiektu względem początku Paragraph, do którego jest on przywiązany. Dokładne położenie obiektu może zależeć od innych treści w dokumencie i stylu dokumentu.

topOffset

object (Dimension)

Przesunięcie górnej krawędzi pozycjonowanego obiektu względem początku Paragraph, do którego jest on przywiązany. Dokładne położenie obiektu może zależeć od innych treści w dokumencie i stylu dokumentu.

PositionedObjectLayout

Możliwe układy [PositionedObject][google.aps.docs.v1.PositionedObject].

Wartości w polu enum
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED Układ jest nieokreślony.
WRAP_TEXT Tekst owija się wokół umieszczonego obiektu.
BREAK_LEFT Podział tekstu tak, aby umieszczony obiekt znajdował się po lewej stronie, a tekst po prawej.
BREAK_RIGHT Łamie tekst tak, aby umieszczony obiekt znajdował się po prawej stronie, a tekst po lewej.
BREAK_LEFT_RIGHT Powoduje podział tekstu w taki sposób, że po lewej i prawej stronie umieszczonego obiektu nie ma tekstu.
IN_FRONT_OF_TEXT Obiekt jest umieszczony przed tekstem.
BEHIND_TEXT Umieszczony obiekt znajduje się za tekstem.

SuggestedPositionedObjectProperties

Sugerowana zmiana w PositionedObjectProperties.

Zapis JSON
{
  "positionedObjectProperties": {
    object (PositionedObjectProperties)
  },
  "positionedObjectPropertiesSuggestionState": {
    object (PositionedObjectPropertiesSuggestionState)
  }
}
Pola
positionedObjectProperties

object (PositionedObjectProperties)

PositionedObjectProperties, która zawiera tylko zmiany wprowadzone w tej sugestii. Możesz użyć tej funkcji w połączeniu z positionedObjectPropertiesSuggestionState, aby sprawdzić, które pola uległy zmianie i jakie są ich nowe wartości.

positionedObjectPropertiesSuggestionState

object (PositionedObjectPropertiesSuggestionState)

Maska wskazująca, które pola w podstawowym obiekcie PositionedObjectProperties zostały zmienione w tej sugestii.

PositionedObjectPropertiesSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie PositionedObjectProperties zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

Zapis JSON
{
  "positioningSuggestionState": {
    object (PositionedObjectPositioningSuggestionState)
  },
  "embeddedObjectSuggestionState": {
    object (EmbeddedObjectSuggestionState)
  }
}
Pola
positioningSuggestionState

object (PositionedObjectPositioningSuggestionState)

Maska wskazująca, które pola w parametrze positioning zostały zmienione w tej sugestii.

embeddedObjectSuggestionState

object (EmbeddedObjectSuggestionState)

Maska wskazująca, które pola w parametrze embeddedObject zostały zmienione w tej sugestii.

PositionedObjectPositioningSuggestionState

Maska wskazująca, które pola w podstawowym obiekcie PositionedObjectPositioning zostały zmienione w tej sugestii. W przypadku każdego pola ustawionego na wartość „true” pojawi się nowa sugerowana wartość.

Zapis JSON
{
  "layoutSuggested": boolean,
  "leftOffsetSuggested": boolean,
  "topOffsetSuggested": boolean
}
Pola
layoutSuggested

boolean

Wskazuje, czy zaproponowano zmianę w layout.

leftOffsetSuggested

boolean

Wskazuje, czy zaproponowano zmianę w leftOffset.

topOffsetSuggested

boolean

Wskazuje, czy zaproponowano zmianę w topOffset.

CommentAnchor

Co najmniej 1 lokalizacja w dokumencie, która jest powiązana z CommentThreads z tym samym anchorId. Uwaga: wiele kotwic może odnosić się do tej samej lokalizacji.

Zapis JSON
{
  "anchorId": string,
  "ranges": [
    {
      object (Range)
    }
  ]
}
Pola
anchorId

string

Identyfikator kotwicy komentarza.

ranges[]

object (Range)

Kolekcja Range w dokumencie, które są powiązane z tym punktem zakotwiczenia.

SuggestionsViewMode

Tryb wyświetlania sugestii zastosowany w dokumencie, który określa sposób przedstawiania sugerowanych zmian. Umożliwia odczytanie dokumentu ze wszystkimi sugestiami w tekście, zaakceptowanymi lub odrzuconymi.

Wartości w polu enum
DEFAULT_FOR_CURRENT_ACCESS Tryb SuggestionsViewMode zastosowany do zwróconego dokumentu zależy od bieżącego poziomu dostępu użytkownika. Jeśli użytkownik ma tylko dostęp do wyświetlania, stosowana jest wartość PREVIEW_WITHOUT_SUGGESTIONS. W przeciwnym razie zastosujemy ustawienie SUGGESTIONS_INLINE. Jest to domyślny tryb wyświetlania sugestii.
SUGGESTIONS_INLINE

Zwrócony dokument zawiera sugestie w tekście. Sugerowane zmiany będą odróżniane od podstawowej treści dokumentu.

Żądania pobrania dokumentu w tym trybie będą zwracać błąd 403, jeśli użytkownik nie ma uprawnień do wyświetlania sugerowanych zmian.

PREVIEW_SUGGESTIONS_ACCEPTED

Zwrócony dokument to podgląd ze wszystkimi zaakceptowanymi sugerowanymi zmianami.

Żądania pobrania dokumentu w tym trybie będą zwracać błąd 403, jeśli użytkownik nie ma uprawnień do wyświetlania sugerowanych zmian.

PREVIEW_WITHOUT_SUGGESTIONS Zwrócony dokument to podgląd ze wszystkimi odrzuconymi sugerowanymi zmianami, jeśli w dokumencie znajdują się jakieś sugestie.

CommentsViewMode

Tryb wyświetlania komentarzy zastosowany w dokumencie, który wskazuje, czy komentarze są uwzględnione. Umożliwia czytanie dokumentu z komentarzami i kotwicami komentarzy lub bez nich.

Wartości w polu enum
COMMENTS_VIEW_MODE_UNSPECIFIED Wartość CommentsViewMode jest nieokreślona. Zastosowano ustawienie OMITTED.
COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS Zastosowany do zwróconego dokumentu tryb CommentsViewMode zależy od bieżącego poziomu dostępu użytkownika. Jeśli użytkownik ma tylko dostęp do wyświetlania, stosowana jest wartość OMITTED. W przeciwnym razie zastosujemy ustawienie INCLUDED.
COMMENTS_VIEW_MODE_OMITTED Zwrócony dokument nie zawiera komentarzy.
COMMENTS_VIEW_MODE_INCLUDED

Zwrócony dokument zawiera komentarze.

Żądania pobrania dokumentu w tym trybie zwrócą błąd 403, jeśli użytkownik nie ma uprawnień do wyświetlania komentarzy.

CommentThread

Reprezentuje pojedynczy wątek komentarza.

Zapis JSON
{
  "commentId": string,
  "anchorId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),

  "plainTextQuote": string
}
Pola
commentId

string

Unikalny identyfikator wątku komentarzy.

anchorId

string

Identyfikator CommentAnchor w dokumencie, z którym powiązany jest ten wątek. Do tego samego elementu CommentAnchor może być przypisanych wiele wątków komentarzy.

headPost

object (Post)

Pierwszy post w wątku.

replies[]

object (Post)

Odpowiedzi na posta głównego.

status

enum (Status)

Czy wątek jest otwarty czy rozwiązany.

Pole zbiorcze quote. Cytowany tekst z dokumentu w momencie utworzenia komentarza. quote może mieć tylko jedną z tych wartości:
plainTextQuote

string

Cytowany tekst z dokumentu w momencie utworzenia komentarza, sformatowany jako zwykły tekst.

Opublikuj

Reprezentuje pojedynczy post w wątku komentarzy lub sugestii.

Zapis JSON
{
  "postId": string,
  "content": string,
  "contentHtml": string,
  "author": {
    object (PostAuthor)
  },
  "createTime": string,
  "updateTime": string,
  "deleted": boolean,
  "fromImportedDocument": boolean,
  "fromCopiedDocument": boolean,
  "fromDocumentComparison": boolean,
  "assigneeEmail": string,

  "commentAction": enum (CommentActionType),
  "suggestionAction": enum (SuggestionActionType)
}
Pola
postId

string

Tylko dane wyjściowe. Unikalny identyfikator posta.

content

string

Treść posta.

Pole nie może być puste, jeśli commentAction nie ma wartości RESOLVE lub REOPEN.

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

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

contentHtml

string

Tylko dane wyjściowe. Treść posta w formacie HTML.

author

object (PostAuthor)

Tylko dane wyjściowe. Użytkownik, który utworzył posta.

createTime

string (Timestamp format)

Tylko dane wyjściowe. Czas utworzenia posta.

updateTime

string (Timestamp format)

Tylko dane wyjściowe. Czas ostatniej aktualizacji posta.

deleted

boolean

Tylko dane wyjściowe. Określa, czy post został usunięty. Jeśli pola true, contentauthor będą puste.

fromImportedDocument

boolean

Tylko dane wyjściowe. Czy post pochodzi z zaimportowanego dokumentu. Dzwoniący nie mogą bezpośrednio ustawiać tego pola.

fromCopiedDocument

boolean

Tylko dane wyjściowe. Czy post pochodzi ze skopiowanego dokumentu. Dzwoniący nie mogą bezpośrednio ustawiać tego pola.

fromDocumentComparison

boolean

Tylko dane wyjściowe. Określa, czy post pochodzi z porównania dokumentów. Dzwoniący nie mogą bezpośrednio ustawiać tego pola.

assigneeEmail

string

Opcjonalnie. Adres e-mail użytkownika, który jest nowo przypisywany do wątku w ramach tego posta.

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

Pole zbiorcze action. Działanie podjęte w ramach tworzenia posta. action może mieć tylko jedną z tych wartości:
commentAction

enum (CommentActionType)

Opcjonalnie. Typ działania w przypadku postów z komentarzami.

suggestionAction

enum (SuggestionActionType)

Tylko dane wyjściowe. Typ działania w przypadku postów z sugestiami.

PostAuthor

Reprezentuje użytkownika, który jest autorem komentarza lub posta z sugestią.

Zapis JSON
{
  "displayName": string,
  "me": boolean,
  "anonymous": boolean,
  "user": string
}
Pola
displayName

string

Wyświetlana nazwa użytkownika. Może nie występować, jeśli autor jest anonimowy.

me

boolean

Określa, czy użytkownik jest uwierzytelnionym użytkownikiem wysyłającym żądanie.

anonymous

boolean

Informacja, czy użytkownik jest anonimowy.

user

string

Nazwa zasobu użytkownika będącego autorem posta, której można też używać do identyfikowania użytkownika w interfejsie Google People API. Format: users/{user}. Nie zostanie wypełnione, jeśli pole anonimowe ma wartość true lub jeśli post pochodzi z zaimportowanego dokumentu.

CommentActionType

Działanie podjęte w odpowiedzi na wątek komentarzy.

Wartości w polu enum
COMMENT_ACTION_TYPE_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
NO_COMMENT_ACTION_CHANGE W tym poście nie ma żadnych zmian dotyczących działań.
RESOLVE Ten post rozwiązuje wątek.
REOPEN Ten post ponownie otworzy wątek.

SuggestionActionType

Działanie podjęte w odpowiedzi na wątek sugestii.

Wartości w polu enum
SUGGESTION_ACTION_TYPE_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
NO_SUGGESTION_ACTION_CHANGE W tym poście nie ma żadnych zmian dotyczących działań.
ACCEPT Ten post akceptuje sugestię.
REJECT Ten post odrzuca sugestię.

Stan

Opcje stanu wątku komentarzy.

Wartości w polu enum
STATUS_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
OPEN Wątek komentarzy jest otwarty.
RESOLVED Wątek komentarzy zostanie zakończony.

SuggestionThread

Reprezentuje pojedynczy wątek sugestii. Wątki sugestii powstają jako efekt uboczny zapisywania zmian w dokumencie w trybie sugestii i nie można ich tworzyć bezpośrednio.

Zapis JSON
{
  "suggestionId": string,
  "headPost": {
    object (Post)
  },
  "replies": [
    {
      object (Post)
    }
  ],
  "status": enum (Status),
  "summaryText": string,
  "summaryHtml": string
}
Pola
suggestionId

string

Unikalny identyfikator sugestii.

headPost

object (Post)

Pierwszy post w wątku.

replies[]

object (Post)

Odpowiedzi na posta głównego.

status

enum (Status)

Określa, czy wątek jest otwarty, zaakceptowany czy odrzucony.

summaryText

string

Podsumowanie sugerowanych zmian w dokumencie w postaci zwykłego tekstu. Może być puste.

summaryHtml

string

Podsumowanie proponowanych zmian w dokumencie w formacie HTML. Może być puste.

Stan

Opcje stanu wątku sugestii.

Wartości w polu enum
STATUS_UNSPECIFIED Wartość domyślna. Ta wartość nie jest używana.
OPEN Wątek sugestii jest otwarty.
ACCEPTED Wątek sugestii został zaakceptowany.
REJECTED Wątek sugestii zostanie odrzucony.

Metody

batchUpdate

Stosuje w dokumencie co najmniej 1 aktualizację.

create

Tworzy pusty dokument z tytułem podanym w żądaniu.

get

Pobiera najnowszą wersję określonego dokumentu.