Requests

Permintaan

Satu update yang akan diterapkan ke dokumen.

Representasi JSON
{

  // Union field request can be only one of the following:
  "replaceAllText": {
    object (ReplaceAllTextRequest)
  },
  "insertText": {
    object (InsertTextRequest)
  },
  "updateTextStyle": {
    object (UpdateTextStyleRequest)
  },
  "createParagraphBullets": {
    object (CreateParagraphBulletsRequest)
  },
  "deleteParagraphBullets": {
    object (DeleteParagraphBulletsRequest)
  },
  "createNamedRange": {
    object (CreateNamedRangeRequest)
  },
  "deleteNamedRange": {
    object (DeleteNamedRangeRequest)
  },
  "updateParagraphStyle": {
    object (UpdateParagraphStyleRequest)
  },
  "deleteContentRange": {
    object (DeleteContentRangeRequest)
  },
  "insertInlineImage": {
    object (InsertInlineImageRequest)
  },
  "insertTable": {
    object (InsertTableRequest)
  },
  "insertTableRow": {
    object (InsertTableRowRequest)
  },
  "insertTableColumn": {
    object (InsertTableColumnRequest)
  },
  "deleteTableRow": {
    object (DeleteTableRowRequest)
  },
  "deleteTableColumn": {
    object (DeleteTableColumnRequest)
  },
  "insertPageBreak": {
    object (InsertPageBreakRequest)
  },
  "deletePositionedObject": {
    object (DeletePositionedObjectRequest)
  },
  "updateTableColumnProperties": {
    object (UpdateTableColumnPropertiesRequest)
  },
  "updateTableCellStyle": {
    object (UpdateTableCellStyleRequest)
  },
  "updateTableRowStyle": {
    object (UpdateTableRowStyleRequest)
  },
  "replaceImage": {
    object (ReplaceImageRequest)
  },
  "updateDocumentStyle": {
    object (UpdateDocumentStyleRequest)
  },
  "mergeTableCells": {
    object (MergeTableCellsRequest)
  },
  "unmergeTableCells": {
    object (UnmergeTableCellsRequest)
  },
  "createHeader": {
    object (CreateHeaderRequest)
  },
  "createFooter": {
    object (CreateFooterRequest)
  },
  "createFootnote": {
    object (CreateFootnoteRequest)
  },
  "replaceNamedRangeContent": {
    object (ReplaceNamedRangeContentRequest)
  },
  "updateSectionStyle": {
    object (UpdateSectionStyleRequest)
  },
  "insertSectionBreak": {
    object (InsertSectionBreakRequest)
  },
  "deleteHeader": {
    object (DeleteHeaderRequest)
  },
  "deleteFooter": {
    object (DeleteFooterRequest)
  },
  "pinTableHeaderRows": {
    object (PinTableHeaderRowsRequest)
  },
  "insertPerson": {
    object (InsertPersonRequest)
  }
  // End of list of possible types for union field request.
}
Kolom
Kolom gabungan request. Permintaan khusus yang akan diterapkan. Hanya satu kolom yang wajib diisi. request hanya dapat berupa salah satu dari berikut:
replaceAllText

object (ReplaceAllTextRequest)

Mengganti semua kemunculan teks yang ditentukan.

insertText

object (InsertTextRequest)

Menyisipkan teks di lokasi yang ditentukan.

updateTextStyle

object (UpdateTextStyleRequest)

Memperbarui gaya teks pada rentang yang ditentukan.

createParagraphBullets

object (CreateParagraphBulletsRequest)

Membuat butir untuk paragraf.

deleteParagraphBullets

object (DeleteParagraphBulletsRequest)

Menghapus butir dari paragraf.

createNamedRange

object (CreateNamedRangeRequest)

Membuat rentang bernama.

deleteNamedRange

object (DeleteNamedRangeRequest)

Menghapus rentang bernama.

updateParagraphStyle

object (UpdateParagraphStyleRequest)

Memperbarui gaya paragraf pada rentang yang ditentukan.

deleteContentRange

object (DeleteContentRangeRequest)

Menghapus konten dari dokumen.

insertInlineImage

object (InsertInlineImageRequest)

Menyisipkan gambar inline di lokasi yang ditentukan.

insertTable

object (InsertTableRequest)

Menyisipkan tabel di lokasi yang ditentukan.

insertTableRow

object (InsertTableRowRequest)

Menyisipkan baris kosong ke dalam tabel.

insertTableColumn

object (InsertTableColumnRequest)

Menyisipkan kolom kosong ke dalam tabel.

deleteTableRow

object (DeleteTableRowRequest)

Menghapus baris dari tabel.

deleteTableColumn

object (DeleteTableColumnRequest)

Menghapus kolom dari tabel.

insertPageBreak

object (InsertPageBreakRequest)

Menyisipkan jeda halaman di lokasi yang ditentukan.

deletePositionedObject

object (DeletePositionedObjectRequest)

Menghapus objek yang diposisikan dari dokumen.

updateTableColumnProperties

object (UpdateTableColumnPropertiesRequest)

Memperbarui properti kolom dalam tabel.

updateTableCellStyle

object (UpdateTableCellStyleRequest)

Memperbarui gaya sel tabel.

updateTableRowStyle

object (UpdateTableRowStyleRequest)

Memperbarui gaya baris dalam tabel.

replaceImage

object (ReplaceImageRequest)

Mengganti gambar dalam dokumen.

updateDocumentStyle

object (UpdateDocumentStyleRequest)

Memperbarui gaya dokumen.

mergeTableCells

object (MergeTableCellsRequest)

Menggabungkan sel dalam tabel.

unmergeTableCells

object (UnmergeTableCellsRequest)

Membatalkan penggabungan sel dalam tabel.

createHeader

object (CreateHeaderRequest)

Membuat header.

createFootnote

object (CreateFootnoteRequest)

Membuat catatan kaki.

replaceNamedRangeContent

object (ReplaceNamedRangeContentRequest)

Mengganti konten dalam rentang bernama.

updateSectionStyle

object (UpdateSectionStyleRequest)

Memperbarui gaya bagian rentang yang ditentukan.

insertSectionBreak

object (InsertSectionBreakRequest)

Menyisipkan jeda bagian di lokasi yang ditentukan.

deleteHeader

object (DeleteHeaderRequest)

Menghapus header dari dokumen.

pinTableHeaderRows

object (PinTableHeaderRowsRequest)

Memperbarui jumlah baris header yang disematkan dalam tabel.

insertPerson

object (InsertPersonRequest)

Menyisipkan sebutan orang.

ReplaceAllTextRequest

Mengganti semua kemunculan teks yang cocok dengan kriteria dengan replace text.

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

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

string

Teks yang akan menggantikan teks yang cocok.

tabsCriteria

object (TabsCriteria)

Opsional. Kriteria yang digunakan untuk menentukan di tab mana penggantian terjadi.

Jika tidak disertakan, penggantian akan berlaku untuk semua tab.

Dalam dokumen yang berisi satu tab:

  • Jika diberikan, harus cocok dengan ID tab tunggal.

  • Jika dihilangkan, penggantian akan berlaku untuk tab tunggal.

Dalam dokumen yang berisi beberapa tab:

  • Jika disediakan, penggantian berlaku untuk tab yang ditentukan.

  • Jika tidak ada, penggantian berlaku untuk semua tab.

Kolom gabungan criteria. Kriteria yang digunakan untuk mencocokkan teks yang akan diganti. criteria hanya dapat berupa salah satu dari berikut:
containsText

object (SubstringMatchCriteria)

Menemukan teks dalam dokumen yang cocok dengan substring ini.

SubstringMatchCriteria

Kriteria yang cocok dengan string teks tertentu dalam dokumen.

Representasi JSON
{
  "text": string,
  "matchCase": boolean,
  "searchByRegex": boolean
}
Kolom
text

string

Teks yang akan ditelusuri dalam dokumen.

matchCase

boolean

Menunjukkan apakah penelusuran harus memperhatikan huruf besar/kecil:

  • True : penelusuran peka huruf besar/kecil.
  • False : penelusuran tidak peka huruf besar/kecil.
searchByRegex

boolean

Opsional. Benar (true) jika nilai penelusuran harus diperlakukan sebagai ekspresi reguler. Setiap garis miring terbalik dalam pola harus di-escape.

  • True : teks penelusuran diperlakukan sebagai ekspresi reguler.
  • False : teks penelusuran diperlakukan sebagai substring untuk pencocokan.

TabsCriteria

Kriteria yang menentukan di tab mana permintaan dieksekusi.

Representasi JSON
{
  "tabIds": [
    string
  ]
}
Kolom
tabIds[]

string

Daftar ID tab tempat permintaan dijalankan.

InsertTextRequest

Menyisipkan teks di lokasi yang ditentukan.

Representasi JSON
{
  "text": string,

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Kolom
text

string

Teks yang akan disisipkan.

Menyisipkan karakter baris baru secara implisit akan membuat Paragraph baru pada indeks tersebut. Gaya paragraf paragraf baru akan disalin dari paragraf pada indeks penyisipan saat ini, termasuk daftar dan butir.

Gaya teks untuk teks yang disisipkan akan ditentukan secara otomatis, yang umumnya mempertahankan gaya teks di sekitarnya. Dalam sebagian besar kasus, gaya teks untuk teks yang disisipkan akan cocok dengan teks tepat sebelum indeks penyisipan.

Beberapa karakter kontrol (U+0000-U+0008, U+000C-U+001F) dan karakter dari Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) akan dihapus dari teks yang disisipkan.

Kolom gabungan insertion_location. Lokasi tempat teks akan disisipkan. insertion_location hanya dapat berupa salah satu dari berikut:
location

object (Location)

Menyisipkan teks pada indeks tertentu dalam dokumen.

Teks harus disisipkan di dalam batas Paragraph yang ada. Misalnya, teks tidak dapat disisipkan pada indeks awal tabel (yaitu di antara tabel dan paragraf sebelumnya). Teks harus disisipkan di paragraf sebelumnya.

endOfSegmentLocation

object (EndOfSegmentLocation)

Menyisipkan teks di akhir header, footer, catatan kaki, atau isi dokumen.

Lokasi

Lokasi tertentu dalam dokumen.

Representasi JSON
{
  "segmentId": string,
  "index": integer,
  "tabId": string
}
Kolom
segmentId

string

ID header, footer, atau catatan kaki tempat lokasi berada. ID segmen kosong menandakan isi dokumen.

index

integer

Indeks berbasis nol, dalam unit kode UTF-16.

Indeks relatif terhadap awal segmen yang ditentukan oleh segmentId.

tabId

string

Tab tempat lokasi berada. Jika tidak ada, permintaan diterapkan ke tab pertama.

Dalam dokumen yang berisi satu tab:

  • Jika diberikan, harus cocok dengan ID tab tunggal.

  • Jika tidak ada, permintaan berlaku untuk tab tunggal.

Dalam dokumen yang berisi beberapa tab:

  • Jika diberikan, permintaan berlaku untuk tab yang ditentukan.

  • Jika tidak disertakan, permintaan berlaku untuk tab pertama dalam dokumen.

EndOfSegmentLocation

Lokasi di akhir isi, header, footer, atau catatan kaki. Lokasinya tepat sebelum baris baru terakhir dalam segmen dokumen.

Representasi JSON
{
  "segmentId": string,
  "tabId": string
}
Kolom
segmentId

string

ID header, footer, atau catatan kaki tempat lokasi berada. ID segmen kosong menandakan isi dokumen.

tabId

string

Tab tempat lokasi berada. Jika tidak ada, permintaan diterapkan ke tab pertama.

Dalam dokumen yang berisi satu tab:

  • Jika diberikan, harus cocok dengan ID tab tunggal.

  • Jika tidak ada, permintaan berlaku untuk tab tunggal.

Dalam dokumen yang berisi beberapa tab:

  • Jika diberikan, permintaan berlaku untuk tab yang ditentukan.

  • Jika tidak disertakan, permintaan berlaku untuk tab pertama dalam dokumen.

UpdateTextStyleRequest

Perbarui gaya teks.

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

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
Kolom
textStyle

object (TextStyle)

Gaya yang akan ditetapkan pada teks.

Jika nilai untuk gaya tertentu cocok dengan gaya induk, gaya tersebut akan ditetapkan untuk mewarisi.

Perubahan gaya teks tertentu dapat menyebabkan perubahan lain untuk mencerminkan perilaku editor Dokumen. Lihat dokumentasi TextStyle untuk informasi selengkapnya.

fields

string (FieldMask format)

Kolom yang harus diperbarui.

Setidaknya satu kolom harus ditentukan. Root textStyle tersirat dan tidak boleh ditentukan. Satu "*" dapat digunakan sebagai singkatan untuk mencantumkan setiap kolom.

Misalnya, untuk memperbarui gaya teks menjadi tebal, tetapkan fields menjadi "bold".

Untuk mereset properti ke nilai defaultnya, sertakan nama kolomnya dalam mask kolom, tetapi biarkan kolom itu sendiri tidak disetel.

Kolom gabungan insertion_location. Jenis rentang yang digunakan tempat gaya teks akan diperbarui. insertion_location hanya dapat berupa salah satu dari berikut:
range

object (Range)

Rentang teks yang akan diberi gaya.

Rentang dapat diperluas untuk menyertakan baris baru yang berdekatan.

Jika rentang sepenuhnya berisi paragraf yang termasuk dalam daftar, butir paragraf juga diperbarui dengan gaya teks yang cocok.

Rentang tidak dapat disisipkan di dalam UpdateTextStyleRequest relatif.

CreateParagraphBulletsRequest

Membuat poin-poin untuk semua paragraf yang tumpang-tindih dengan rentang yang diberikan.

Tingkat tingkatan setiap paragraf akan ditentukan dengan menghitung tab di depan setiap paragraf. Untuk menghindari ruang berlebih antara butir dan paragraf yang sesuai, tab di depan ini dihapus oleh permintaan ini. Hal ini dapat mengubah indeks bagian teks.

Jika paragraf tepat sebelum paragraf yang diperbarui berada dalam daftar dengan preset yang cocok, paragraf yang diperbarui akan ditambahkan ke daftar sebelumnya tersebut.

Representasi JSON
{
  "range": {
    object (Range)
  },
  "bulletPreset": enum (BulletGlyphPreset)
}
Kolom
range

object (Range)

Rentang untuk menerapkan preset poin butir.

bulletPreset

enum (BulletGlyphPreset)

Jenis glyph butir yang akan digunakan.

BulletGlyphPreset

Pola glyph butir preset untuk daftar.

Pola ini menggunakan jenis butir berikut:

  • ARROW : Panah, sesuai dengan poin kode Unicode U+2794
  • ARROW3D : Panah dengan shading 3D, sesuai dengan titik kode Unicode U+27a2
  • CHECKBOX : Kotak berongga, sesuai dengan poin kode Unicode U+274f
  • CIRCLE : Lingkaran kosong, sesuai dengan titik kode Unicode U+25cb
  • DIAMOND : Berlian padat, sesuai dengan poin kode Unicode U+25c6
  • DIAMONDX : Berlian dengan 'x', sesuai dengan titik kode Unicode U+2756
  • HOLLOWDIAMOND : Berlian berongga, sesuai dengan poin kode Unicode U+25c7
  • DISC : Lingkaran solid, sesuai dengan poin kode Unicode U+25cf
  • SQUARE : Kotak solid, sesuai dengan poin kode Unicode U+25a0
  • STAR : Bintang, sesuai dengan poin kode Unicode U+2605
  • ALPHA : Huruf kecil, seperti 'a', 'b', atau 'c'.
  • UPPERALPHA : Huruf besar, seperti 'A', 'B', atau 'C'.
  • DECIMAL : Angka, seperti '1', '2', atau '3'.
  • ZERODECIMAL : Angka di mana angka satu digit diawali dengan nol, seperti '01', '02', atau '03'. Angka dengan lebih dari satu digit tidak diawali dengan nol.
  • ROMAN : Angka romawi huruf kecil, seperti 'i', 'ii', atau 'iii'.
  • UPPERROMAN : Angka romawi huruf besar, seperti 'I', 'II', atau 'III'.
  • LEFTTRIANGLE : Segitiga yang mengarah ke kiri, sesuai dengan poin kode Unicode U+25c4
Enum
BULLET_GLYPH_PRESET_UNSPECIFIED Preset glyph butir tidak ditentukan.
BULLET_DISC_CIRCLE_SQUARE Daftar berbutir dengan DISC, CIRCLE dan SQUARE glyph butir untuk 3 tingkat hierarki daftar pertama.
BULLET_DIAMONDX_ARROW3D_SQUARE Daftar berbutir dengan DIAMONDX, ARROW3D dan SQUARE glyph butir untuk 3 tingkat hierarki daftar pertama.
BULLET_CHECKBOX Daftar berbutir dengan CHECKBOX glyph butir untuk semua tingkat penataan daftar.
BULLET_ARROW_DIAMOND_DISC Daftar berbutir dengan ARROW, DIAMOND dan DISC glyph butir untuk 3 tingkat hierarki daftar pertama.
BULLET_STAR_CIRCLE_SQUARE Daftar berbutir dengan STAR, CIRCLE dan SQUARE glyph butir untuk 3 tingkat hierarki daftar pertama.
BULLET_ARROW3D_CIRCLE_SQUARE Daftar berbutir dengan ARROW3D, CIRCLE dan SQUARE glyph butir untuk 3 tingkat hierarki daftar pertama.
BULLET_LEFTTRIANGLE_DIAMOND_DISC Daftar berbutir dengan LEFTTRIANGLE, DIAMOND dan DISC glyph butir untuk 3 tingkat hierarki daftar pertama.
BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE Daftar berbutir dengan DIAMONDX, HOLLOWDIAMOND dan SQUARE glyph butir untuk 3 tingkat hierarki daftar pertama.
BULLET_DIAMOND_CIRCLE_SQUARE Daftar berbutir dengan DIAMOND, CIRCLE dan SQUARE glyph butir untuk 3 tingkat hierarki daftar pertama.
NUMBERED_DECIMAL_ALPHA_ROMAN Daftar bernomor dengan DECIMAL, ALPHA dan ROMAN glyph numerik untuk 3 tingkat hierarki daftar pertama, diikuti dengan titik.
NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS Daftar bernomor dengan DECIMAL, ALPHA dan ROMAN glyph numerik untuk 3 tingkat hierarki daftar pertama, diikuti dengan tanda kurung.
NUMBERED_DECIMAL_NESTED Daftar bernomor dengan DECIMAL glif numerik yang dipisahkan dengan titik, di mana setiap tingkat bertingkat menggunakan glif tingkat bertingkat sebelumnya sebagai awalan. Misalnya: '1.', '1.1.', '2.', '2.2.'.
NUMBERED_UPPERALPHA_ALPHA_ROMAN Daftar bernomor dengan UPPERALPHA, ALPHA dan ROMAN glyph numerik untuk 3 tingkat hierarki daftar pertama, diikuti dengan titik.
NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL Daftar bernomor dengan UPPERROMAN, UPPERALPHA dan DECIMAL glyph numerik untuk 3 tingkat hierarki daftar pertama, diikuti dengan titik.
NUMBERED_ZERODECIMAL_ALPHA_ROMAN Daftar bernomor dengan ZERODECIMAL, ALPHA dan ROMAN glyph numerik untuk 3 tingkat hierarki daftar pertama, diikuti dengan titik.

DeleteParagraphBulletsRequest

Menghapus butir dari semua paragraf yang tumpang-tindih dengan rentang yang diberikan.

Level tingkatan setiap paragraf akan dipertahankan secara visual dengan menambahkan indentasi ke awal paragraf yang sesuai.

Representasi JSON
{
  "range": {
    object (Range)
  }
}
Kolom
range

object (Range)

Rentang untuk menghapus butir.

CreateNamedRangeRequest

Membuat NamedRange yang mereferensikan rentang yang diberikan.

Representasi JSON
{
  "name": string,
  "range": {
    object (Range)
  }
}
Kolom
name

string

Nama NamedRange. Nama tidak harus unik.

Nama harus terdiri dari minimal 1 karakter dan maksimal 256 karakter, yang diukur dalam unit kode UTF-16.

range

object (Range)

Rentang untuk menerapkan nama.

DeleteNamedRangeRequest

Menghapus NamedRange.

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

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "name": string
  // End of list of possible types for union field named_range_reference.
}
Kolom
tabsCriteria

object (TabsCriteria)

Opsional. Kriteria yang digunakan untuk menentukan tab tempat penghapusan rentang harus terjadi. Jika tidak ada, penghapusan rentang akan diterapkan ke semua tab.

Dalam dokumen yang berisi satu tab:

  • Jika diberikan, harus cocok dengan ID tab tunggal.

  • Jika tidak ada, penghapusan rentang berlaku untuk tab tunggal.

Dalam dokumen yang berisi beberapa tab:

  • Jika disediakan, penghapusan rentang berlaku untuk tab yang ditentukan.

  • Jika tidak diberikan, penghapusan rentang berlaku untuk semua tab.

Kolom gabungan named_range_reference. Nilai yang menentukan rentang yang akan dihapus. Tepatnya satu yang harus ditetapkan. named_range_reference hanya dapat berupa salah satu dari berikut:
namedRangeId

string

ID rentang bernama yang akan dihapus.

name

string

Nama rentang yang akan dihapus. Semua rentang bernama dengan nama yang diberikan akan dihapus.

UpdateParagraphStyleRequest

Perbarui gaya semua paragraf yang tumpang-tindih dengan rentang yang diberikan.

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

  // Union field insertion_location can be only one of the following:
  "range": {
    object (Range)
  }
  // End of list of possible types for union field insertion_location.
}
Kolom
paragraphStyle

object (ParagraphStyle)

Gaya yang akan ditetapkan pada paragraf.

Perubahan gaya paragraf tertentu dapat menyebabkan perubahan lain untuk mencerminkan perilaku editor Dokumen. Lihat dokumentasi ParagraphStyle untuk informasi selengkapnya.

fields

string (FieldMask format)

Kolom yang harus diperbarui.

Setidaknya satu kolom harus ditentukan. Root paragraphStyle tersirat dan tidak boleh ditentukan. Satu "*" dapat digunakan sebagai singkatan untuk mencantumkan setiap kolom.

Misalnya, untuk memperbarui properti perataan gaya paragraf, tetapkan fields ke "alignment".

Untuk mereset properti ke nilai defaultnya, sertakan nama kolomnya dalam mask kolom, tetapi biarkan kolom itu sendiri tidak disetel.

Kolom gabungan insertion_location. Jenis rentang yang digunakan tempat gaya paragraf akan diperbarui. insertion_location hanya dapat berupa salah satu dari berikut:
range

object (Range)

Rentang yang tumpang-tindih dengan paragraf yang akan diberi gaya.

DeleteContentRangeRequest

Menghapus konten dari dokumen.

Representasi JSON
{
  "range": {
    object (Range)
  }
}
Kolom
range

object (Range)

Rentang konten yang akan dihapus.

Menghapus teks yang melintasi batas paragraf dapat menyebabkan perubahan pada gaya paragraf, daftar, objek yang diposisikan, dan bookmark karena kedua paragraf digabungkan.

Mencoba menghapus rentang tertentu dapat menyebabkan struktur dokumen tidak valid, sehingga menampilkan error 400 bad request.

Beberapa contoh permintaan penghapusan yang tidak valid meliputi:

InsertInlineImageRequest

Menyisipkan InlineObject yang berisi gambar di lokasi yang ditentukan.

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

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Kolom
uri

string

URI gambar.

Gambar diambil sekali pada saat penyisipan dan salinannya disimpan untuk ditampilkan di dalam dokumen. Ukuran gambar harus kurang dari 50 MB, tidak boleh melebihi 25 megapiksel, dan harus dalam salah satu format PNG, JPEG, atau GIF.

URI yang diberikan harus dapat diakses secara publik dan panjangnya maksimal 2 kB. URI itu sendiri disimpan bersama gambar, dan diekspos melalui kolom ImageProperties.content_uri.

objectSize

object (Size)

Ukuran gambar yang akan ditampilkan dalam dokumen. Properti ini bersifat opsional dan ukuran akhir gambar dalam dokumen ditentukan oleh aturan berikut: * Jika lebar maupun tinggi tidak ditentukan, ukuran default gambar akan dihitung berdasarkan resolusinya. * Jika satu dimensi ditentukan, dimensi lainnya akan dihitung untuk mempertahankan rasio aspek gambar. * Jika lebar dan tinggi ditentukan, gambar akan diskalakan agar sesuai dengan dimensi yang diberikan sambil mempertahankan rasio aspeknya.

Kolom gabungan insertion_location. Lokasi tempat gambar akan disisipkan. insertion_location hanya dapat berupa salah satu dari berikut:
location

object (Location)

Menyisipkan gambar pada indeks tertentu dalam dokumen.

Gambar harus disisipkan di dalam batas Paragraph yang ada. Misalnya, tidak dapat disisipkan pada indeks awal tabel (yaitu di antara tabel dan paragraf sebelumnya).

Gambar sebaris tidak dapat disisipkan di dalam catatan kaki atau persamaan.

endOfSegmentLocation

object (EndOfSegmentLocation)

Menyisipkan teks di akhir header, footer, atau isi dokumen.

Gambar sebaris tidak dapat disisipkan di dalam catatan kaki.

InsertTableRequest

Menyisipkan tabel di lokasi yang ditentukan.

Karakter baris baru akan disisipkan sebelum tabel yang disisipkan.

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

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Kolom
rows

integer

Jumlah baris dalam tabel.

columns

integer

Jumlah kolom dalam tabel.

Kolom gabungan insertion_location. Lokasi tempat tabel akan disisipkan. insertion_location hanya dapat berupa salah satu dari berikut:
location

object (Location)

Menyisipkan tabel pada indeks model tertentu.

Karakter baris baru akan disisipkan sebelum tabel yang disisipkan, sehingga indeks awal tabel akan berada di indeks lokasi yang ditentukan + 1.

Tabel harus disisipkan di dalam batas Paragraph yang ada. Misalnya, tidak dapat disisipkan pada indeks awal tabel (yaitu di antara tabel yang ada dan paragraf sebelumnya).

Tabel tidak dapat disisipkan di dalam catatan kaki atau persamaan.

endOfSegmentLocation

object (EndOfSegmentLocation)

Menyisipkan tabel di akhir header, footer, atau isi dokumen yang ditentukan. Karakter baris baru akan disisipkan sebelum tabel yang disisipkan.

Tabel tidak dapat disisipkan di dalam catatan kaki.

InsertTableRowRequest

Menyisipkan baris kosong ke dalam tabel.

Representasi JSON
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertBelow": boolean
}
Kolom
tableCellLocation

object (TableCellLocation)

Lokasi sel tabel referensi tempat baris akan disisipkan.

Baris baru akan disisipkan di atas (atau di bawah) baris tempat sel referensi berada. Jika sel referensi adalah sel gabungan, baris baru akan disisipkan di atas (atau di bawah) sel gabungan.

insertBelow

boolean

Apakah akan menyisipkan baris baru di bawah lokasi sel referensi.

  • True : sisipkan di bawah sel.
  • False : menyisipkan di atas sel.

TableCellLocation

Lokasi satu sel dalam tabel.

Representasi JSON
{
  "tableStartLocation": {
    object (Location)
  },
  "rowIndex": integer,
  "columnIndex": integer
}
Kolom
tableStartLocation

object (Location)

Lokasi tempat tabel dimulai dalam dokumen.

rowIndex

integer

Indeks baris berbasis nol. Misalnya, baris kedua dalam tabel memiliki indeks baris 1.

columnIndex

integer

Indeks kolom berbasis nol. Misalnya, kolom kedua dalam tabel memiliki indeks kolom 1.

InsertTableColumnRequest

Menyisipkan kolom kosong ke dalam tabel.

Representasi JSON
{
  "tableCellLocation": {
    object (TableCellLocation)
  },
  "insertRight": boolean
}
Kolom
tableCellLocation

object (TableCellLocation)

Lokasi sel tabel referensi tempat kolom akan disisipkan.

Kolom baru akan disisipkan di sebelah kiri (atau kanan) kolom tempat sel referensi berada. Jika sel referensi adalah sel gabungan, kolom baru akan disisipkan di sebelah kiri (atau kanan) sel gabungan.

insertRight

boolean

Apakah akan menyisipkan kolom baru di sebelah kanan lokasi sel referensi.

  • True : sisipkan ke kanan.
  • False : sisipkan ke kiri.

DeleteTableRowRequest

Menghapus baris dari tabel.

Representasi JSON
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
Kolom
tableCellLocation

object (TableCellLocation)

Lokasi sel tabel referensi tempat baris akan dihapus.

Baris yang mencakup sel ini akan dihapus. Jika ini adalah sel gabungan yang mencakup beberapa baris, semua baris yang dicakup sel akan dihapus. Jika tidak ada baris yang tersisa dalam tabel setelah penghapusan ini, seluruh tabel akan dihapus.

DeleteTableColumnRequest

Menghapus kolom dari tabel.

Representasi JSON
{
  "tableCellLocation": {
    object (TableCellLocation)
  }
}
Kolom
tableCellLocation

object (TableCellLocation)

Lokasi sel tabel referensi tempat kolom akan dihapus.

Kolom yang dicakup sel ini akan dihapus. Jika ini adalah sel gabungan yang mencakup beberapa kolom, semua kolom yang dicakup sel akan dihapus. Jika tidak ada kolom yang tersisa dalam tabel setelah penghapusan ini, seluruh tabel akan dihapus.

InsertPageBreakRequest

Menyisipkan jeda halaman yang diikuti dengan baris baru di lokasi yang ditentukan.

Representasi JSON
{

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Kolom
Kolom gabungan insertion_location. Lokasi tempat jeda halaman akan disisipkan. insertion_location hanya dapat berupa salah satu dari berikut:
location

object (Location)

Menyisipkan jeda halaman pada indeks tertentu dalam dokumen.

Pemisah halaman harus disisipkan di dalam batas Paragraph yang ada. Misalnya, tidak dapat disisipkan pada indeks awal tabel (yaitu di antara tabel dan paragraf sebelumnya).

Pemisah halaman tidak dapat disisipkan di dalam tabel, persamaan, catatan kaki, header, atau footer. Karena jeda halaman hanya dapat disisipkan di dalam isi, kolom segment ID harus kosong.

endOfSegmentLocation

object (EndOfSegmentLocation)

Menyisipkan jeda halaman di akhir isi dokumen.

Pemisah halaman tidak dapat disisipkan di dalam catatan kaki, header, atau footer. Karena jeda halaman hanya dapat disisipkan di dalam isi, kolom segment ID harus kosong.

DeletePositionedObjectRequest

Menghapus PositionedObject dari dokumen.

Representasi JSON
{
  "objectId": string,
  "tabId": string
}
Kolom
objectId

string

ID objek yang diposisikan untuk dihapus.

tabId

string

Tab tempat objek yang diposisikan untuk dihapus berada. Jika tidak ada, permintaan diterapkan ke tab pertama.

Dalam dokumen yang berisi satu tab:

  • Jika diberikan, harus cocok dengan ID tab tunggal.

  • Jika tidak ada, permintaan berlaku untuk tab tunggal.

Dalam dokumen yang berisi beberapa tab:

  • Jika diberikan, permintaan berlaku untuk tab yang ditentukan.

  • Jika tidak disertakan, permintaan berlaku untuk tab pertama dalam dokumen.

UpdateTableColumnPropertiesRequest

Memperbarui TableColumnProperties kolom dalam tabel.

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

object (Location)

Lokasi tempat tabel dimulai dalam dokumen.

columnIndices[]

integer

Daftar indeks kolom berbasis nol yang propertinya harus diperbarui. Jika tidak ada indeks yang ditentukan, semua kolom akan diperbarui.

tableColumnProperties

object (TableColumnProperties)

Properti kolom tabel yang akan diperbarui.

Jika nilai tableColumnProperties#width kurang dari 5 poin (5/72 inci), error 400 bad request akan ditampilkan.

fields

string (FieldMask format)

Kolom yang harus diperbarui.

Setidaknya satu kolom harus ditentukan. Root tableColumnProperties tersirat dan tidak boleh ditentukan. Satu "*" dapat digunakan sebagai singkatan untuk mencantumkan setiap kolom.

Misalnya, untuk memperbarui lebar kolom, tetapkan fields ke "width".

UpdateTableCellStyleRequest

Memperbarui gaya rentang sel tabel.

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

  // Union field cells can be only one of the following:
  "tableRange": {
    object (TableRange)
  },
  "tableStartLocation": {
    object (Location)
  }
  // End of list of possible types for union field cells.
}
Kolom
tableCellStyle

object (TableCellStyle)

Gaya yang akan ditetapkan pada sel tabel.

Saat memperbarui batas, jika sel berbagi batas dengan sel yang berdekatan, properti batas yang sesuai dari sel yang berdekatan juga akan diperbarui. Batas yang digabungkan dan tidak terlihat tidak diperbarui.

Karena memperbarui batas yang digunakan bersama oleh sel yang berdekatan dalam permintaan yang sama dapat menyebabkan konflik pembaruan batas, pembaruan batas diterapkan dalam urutan berikut:

  • borderRight
  • borderLeft
  • borderBottom
  • borderTop
fields

string (FieldMask format)

Kolom yang harus diperbarui.

Setidaknya satu kolom harus ditentukan. Root tableCellStyle tersirat dan tidak boleh ditentukan. Satu "*" dapat digunakan sebagai singkatan untuk mencantumkan setiap kolom.

Misalnya, untuk memperbarui warna latar belakang sel tabel, tetapkan fields ke "backgroundColor".

Untuk mereset properti ke nilai defaultnya, sertakan nama kolomnya dalam mask kolom, tetapi biarkan kolom itu sendiri tidak disetel.

Kolom gabungan cells. Sel yang akan diperbarui. cells hanya dapat berupa salah satu dari berikut:
tableRange

object (TableRange)

Rentang tabel yang merepresentasikan subset tabel tempat pembaruan diterapkan.

tableStartLocation

object (Location)

Lokasi tempat tabel dimulai dalam dokumen. Jika ditentukan, pembaruan akan diterapkan ke semua sel dalam tabel.

TableRange

Rentang tabel merepresentasikan referensi ke subset tabel.

Penting untuk diperhatikan bahwa sel yang ditentukan oleh rentang tabel tidak selalu membentuk persegi panjang. Misalnya, kita memiliki tabel 3 x 3 yang semua sel di baris terakhirnya digabungkan. Tabelnya akan terlihat seperti ini:

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

Rentang tabel dengan lokasi sel tabel = (tableStartLocation, baris = 0, kolom = 0), rentang baris = 3, dan rentang kolom = 2 menentukan sel berikut:

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

object (TableCellLocation)

Lokasi sel tempat rentang tabel dimulai.

rowSpan

integer

Rentang baris rentang tabel.

columnSpan

integer

Rentang kolom rentang tabel.

UpdateTableRowStyleRequest

Memperbarui TableRowStyle baris dalam tabel.

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

object (Location)

Lokasi tempat tabel dimulai dalam dokumen.

rowIndices[]

integer

Daftar indeks baris berbasis nol yang gayanya harus diperbarui. Jika tidak ada indeks yang ditentukan, semua baris akan diperbarui.

tableRowStyle

object (TableRowStyle)

Gaya yang akan ditetapkan pada baris.

fields

string (FieldMask format)

Kolom yang harus diperbarui.

Setidaknya satu kolom harus ditentukan. Root tableRowStyle tersirat dan tidak boleh ditentukan. Satu "*" dapat digunakan sebagai singkatan untuk mencantumkan setiap kolom.

Misalnya, untuk memperbarui tinggi baris minimum, tetapkan fields ke "minRowHeight".

ReplaceImageRequest

Mengganti gambar yang ada dengan gambar baru.

Mengganti gambar akan menghapus beberapa image effects dari gambar yang ada untuk mencerminkan perilaku editor Dokumen.

Representasi JSON
{
  "imageObjectId": string,
  "uri": string,
  "imageReplaceMethod": enum (ImageReplaceMethod),
  "tabId": string
}
Kolom
imageObjectId

string

ID gambar yang ada yang akan diganti. ID ini dapat diambil dari respons permintaan get.

uri

string

URI gambar baru.

Gambar diambil sekali pada saat penyisipan dan salinannya disimpan untuk ditampilkan di dalam dokumen. Ukuran gambar harus kurang dari 50 MB, tidak boleh melebihi 25 megapiksel, dan harus dalam format PNG, JPEG, atau GIF.

URI yang diberikan tidak boleh melebihi panjang 2 KB. URI disimpan dengan gambar, dan diekspos melalui kolom ImageProperties.source_uri.

imageReplaceMethod

enum (ImageReplaceMethod)

Metode penggantian.

tabId

string

Tab tempat gambar yang akan diganti berada. Jika tidak ada, permintaan diterapkan ke tab pertama.

Dalam dokumen yang berisi satu tab:

  • Jika diberikan, harus cocok dengan ID tab tunggal.

  • Jika tidak ada, permintaan berlaku untuk tab tunggal.

Dalam dokumen yang berisi beberapa tab:

  • Jika diberikan, permintaan berlaku untuk tab yang ditentukan.

  • Jika tidak disertakan, permintaan berlaku untuk tab pertama dalam dokumen.

ImageReplaceMethod

Metode penggantian gambar.

Enum
IMAGE_REPLACE_METHOD_UNSPECIFIED Metode penggantian gambar tidak ditentukan. Nilai ini tidak boleh digunakan.
CENTER_CROP Menskalakan dan memusatkan gambar untuk mengisi batas gambar asli. Gambar dapat dipangkas untuk mengisi batas gambar asli. Ukuran gambar yang dirender akan sama dengan gambar asli.

UpdateDocumentStyleRequest

Memperbarui DocumentStyle.

Representasi JSON
{
  "documentStyle": {
    object (DocumentStyle)
  },
  "fields": string,
  "tabId": string
}
Kolom
documentStyle

object (DocumentStyle)

Gaya yang akan ditetapkan pada dokumen.

Perubahan gaya dokumen tertentu dapat menyebabkan perubahan lain untuk mencerminkan perilaku editor Dokumen. Lihat dokumentasi DocumentStyle untuk informasi selengkapnya.

fields

string (FieldMask format)

Kolom yang harus diperbarui.

Setidaknya satu kolom harus ditentukan. Root documentStyle tersirat dan tidak boleh ditentukan. Satu "*" dapat digunakan sebagai singkatan untuk mencantumkan setiap kolom.

Misalnya, untuk memperbarui latar belakang, tetapkan fields ke "background".

tabId

string

Tab yang berisi gaya yang akan diperbarui. Jika tidak disertakan, permintaan berlaku untuk tab pertama.

Dalam dokumen yang berisi satu tab:

  • Jika diberikan, harus cocok dengan ID tab tunggal.

  • Jika tidak ada, permintaan berlaku untuk tab tunggal.

Dalam dokumen yang berisi beberapa tab:

  • Jika diberikan, permintaan berlaku untuk tab yang ditentukan.

  • Jika tidak diberikan, permintaan berlaku untuk tab pertama dalam dokumen.

MergeTableCellsRequest

Menggabungkan sel dalam Table.

Representasi JSON
{
  "tableRange": {
    object (TableRange)
  }
}
Kolom
tableRange

object (TableRange)

Rentang tabel yang menentukan sel tabel yang akan digabungkan.

Teks apa pun dalam sel yang digabungkan akan digabungkan dan disimpan dalam sel "head" rentang. Ini adalah sel kiri atas rentang saat arah konten adalah kiri ke kanan, dan sel kanan atas rentang jika tidak.

Jika rentang tidak berbentuk persegi panjang (yang dapat terjadi dalam beberapa kasus saat rentang mencakup sel yang sudah digabungkan atau saat tabel tidak berbentuk persegi panjang), error permintaan buruk 400 akan ditampilkan.

UnmergeTableCellsRequest

Memisahkan sel dalam Table.

Representasi JSON
{
  "tableRange": {
    object (TableRange)
  }
}
Kolom
tableRange

object (TableRange)

Rentang tabel yang menentukan sel tabel yang akan dipisahkan.

Semua sel gabungan dalam rentang ini akan dipisahkan, dan sel yang sudah dipisahkan tidak akan terpengaruh. Jika rentang tidak memiliki sel gabungan, permintaan tidak akan melakukan apa pun.

Jika ada teks di salah satu sel gabungan, teks akan tetap berada di sel "kepala" dari blok sel yang tidak digabungkan. Sel "head" adalah sel kiri atas jika arah konten dari kiri ke kanan, dan kanan atas jika tidak.

CreateHeaderRequest

Membuat Header. Header baru diterapkan ke SectionStyle di lokasi SectionBreak jika ditentukan, atau diterapkan ke DocumentStyle.

Jika header jenis yang ditentukan sudah ada, error 400 bad request akan ditampilkan.

Representasi JSON
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Kolom
type

enum (HeaderFooterType)

Jenis header yang akan dibuat.

sectionBreakLocation

object (Location)

Lokasi SectionBreak yang memulai bagian yang seharusnya menjadi bagian header ini. Jika `sectionBreakLocation' tidak disetel atau jika merujuk ke jeda bagian pertama dalam isi dokumen, header berlaku untuk DocumentStyle

HeaderFooterType

Jenis header dan footer yang dapat dibuat.

Enum
DEFAULT Header/footer default.

CreateFooterRequest

Membuat Footer. Footer baru diterapkan ke SectionStyle di lokasi SectionBreak jika ditentukan, atau diterapkan ke DocumentStyle.

Jika footer dengan jenis yang ditentukan sudah ada, error 400 bad request akan ditampilkan.

Representasi JSON
{
  "type": enum (HeaderFooterType),
  "sectionBreakLocation": {
    object (Location)
  }
}
Kolom
type

enum (HeaderFooterType)

Jenis footer yang akan dibuat.

sectionBreakLocation

object (Location)

Lokasi SectionBreak yang langsung mendahului bagian yang SectionStyle footer ini harus menjadi bagiannya. Jika tidak disetel atau merujuk ke jeda bagian pertama dalam dokumen, footer akan berlaku untuk gaya dokumen.

CreateFootnoteRequest

Membuat segmen Footnote dan menyisipkan FootnoteReference baru ke dalamnya di lokasi yang ditentukan.

Segmen Footnote baru akan berisi spasi yang diikuti dengan karakter baris baru.

Representasi JSON
{

  // Union field footnote_reference_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field footnote_reference_location.
}
Kolom
Kolom gabungan footnote_reference_location. Lokasi untuk menyisipkan referensi catatan kaki. footnote_reference_location hanya dapat berupa salah satu dari berikut:
location

object (Location)

Menyisipkan referensi catatan kaki pada indeks tertentu dalam dokumen.

Referensi catatan kaki harus disisipkan di dalam batas Paragraph yang ada. Misalnya, tidak dapat disisipkan pada indeks awal tabel (yaitu di antara tabel dan paragraf sebelumnya).

Referensi catatan kaki tidak dapat disisipkan di dalam persamaan, header, footer, atau catatan kaki. Karena referensi catatan kaki hanya dapat disisipkan di isi, kolom segment ID harus kosong.

endOfSegmentLocation

object (EndOfSegmentLocation)

Menyisipkan referensi catatan kaki di akhir isi dokumen.

Referensi catatan kaki tidak dapat disisipkan di dalam header, footer, atau catatan kaki. Karena referensi catatan kaki hanya dapat disisipkan di isi, kolom segment ID harus kosong.

ReplaceNamedRangeContentRequest

Mengganti konten NamedRange atau NamedRanges yang ditentukan dengan konten pengganti yang diberikan.

Perhatikan bahwa setiap individu NamedRange dapat terdiri dari beberapa ranges yang tidak berkesinambungan. Dalam hal ini, hanya konten dalam rentang pertama yang akan diganti. Rentang lainnya dan kontennya akan dihapus.

Jika penggantian atau penghapusan rentang apa pun akan menghasilkan struktur dokumen yang tidak valid, error 400 bad request akan ditampilkan.

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

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

  // Union field named_range_reference can be only one of the following:
  "namedRangeId": string,
  "namedRangeName": string
  // End of list of possible types for union field named_range_reference.
}
Kolom
tabsCriteria

object (TabsCriteria)

Opsional. Kriteria yang digunakan untuk menentukan di tab mana penggantian terjadi. Jika tidak disertakan, penggantian akan berlaku untuk semua tab.

Dalam dokumen yang berisi satu tab:

  • Jika diberikan, harus cocok dengan ID tab tunggal.

  • Jika dihilangkan, penggantian akan berlaku untuk tab tunggal.

Dalam dokumen yang berisi beberapa tab:

  • Jika disediakan, penggantian berlaku untuk tab yang ditentukan.

  • Jika tidak ada, penggantian berlaku untuk semua tab.

Kolom gabungan replacement_content. Konten untuk menggantikan konten yang ada di rentang bernama. replacement_content hanya dapat berupa salah satu dari berikut:
text

string

Mengganti konten rentang bernama yang ditentukan dengan teks yang diberikan.

Kolom gabungan named_range_reference. Referensi ke rentang bernama yang kontennya akan diganti. named_range_reference hanya dapat berupa salah satu dari berikut:
namedRangeId

string

ID rentang bernama yang kontennya akan diganti.

Jika tidak ada rentang bernama dengan ID yang diberikan, error 400 bad request akan ditampilkan.

namedRangeName

string

Nama NamedRanges yang kontennya akan diganti.

Jika ada beberapa named ranges dengan nama yang diberikan, konten setiap named ranges akan diganti. Jika tidak ada rentang bernama dengan nama yang diberikan, permintaan tidak akan melakukan apa pun.

UpdateSectionStyleRequest

Memperbarui SectionStyle.

Representasi JSON
{
  "range": {
    object (Range)
  },
  "sectionStyle": {
    object (SectionStyle)
  },
  "fields": string
}
Kolom
range

object (Range)

Rentang yang tumpang-tindih dengan bagian yang akan diberi gaya.

Karena jeda bagian hanya dapat disisipkan di dalam isi, kolom segment ID harus kosong.

sectionStyle

object (SectionStyle)

Gaya yang akan ditetapkan pada bagian.

Perubahan gaya bagian tertentu dapat menyebabkan perubahan lain untuk mencerminkan perilaku editor Dokumen. Lihat dokumentasi SectionStyle untuk informasi selengkapnya.

fields

string (FieldMask format)

Kolom yang harus diperbarui.

Setidaknya satu kolom harus ditentukan. Root sectionStyle tersirat dan tidak boleh ditentukan. Satu "*" dapat digunakan sebagai singkatan untuk mencantumkan setiap kolom.

Misalnya, untuk memperbarui margin kiri, tetapkan fields ke "marginLeft".

InsertSectionBreakRequest

Menyisipkan jeda bagian di lokasi yang ditentukan.

Karakter baris baru akan disisipkan sebelum jeda bagian.

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

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Kolom
sectionType

enum (SectionType)

Jenis bagian yang akan disisipkan.

Kolom gabungan insertion_location. Lokasi tempat jeda akan disisipkan. insertion_location hanya dapat berupa salah satu dari berikut:
location

object (Location)

Menyisipkan baris baru dan jeda bagian pada indeks tertentu dalam dokumen.

Pemisah bagian harus disisipkan di dalam batas Paragraph yang ada. Misalnya, tidak dapat disisipkan pada indeks awal tabel (yaitu di antara tabel dan paragraf sebelumnya).

Pemisah bagian tidak dapat disisipkan di dalam tabel, persamaan, catatan kaki, header, atau footer. Karena jeda bagian hanya dapat disisipkan di dalam isi, kolom segment ID harus kosong.

endOfSegmentLocation

object (EndOfSegmentLocation)

Menyisipkan baris baru dan jeda bagian di akhir isi dokumen.

Pemisah bagian tidak dapat disisipkan di dalam catatan kaki, header, atau footer. Karena jeda bagian hanya dapat disisipkan di dalam isi, kolom segment ID harus kosong.

DeleteHeaderRequest

Menghapus Header dari dokumen.

Representasi JSON
{
  "headerId": string,
  "tabId": string
}
Kolom
headerId

string

ID header yang akan dihapus. Jika header ini ditentukan di DocumentStyle, referensi ke header ini akan dihapus, sehingga tidak ada header jenis tersebut untuk bagian pertama dokumen. Jika header ini ditentukan pada SectionStyle, referensi ke header ini akan dihapus dan header jenis tersebut kini dilanjutkan dari bagian sebelumnya.

tabId

string

Tab yang berisi header yang akan dihapus. Jika tidak ada, permintaan diterapkan ke tab pertama.

Dalam dokumen yang berisi satu tab:

  • Jika diberikan, harus cocok dengan ID tab tunggal.

  • Jika tidak ada, permintaan berlaku untuk tab tunggal.

Dalam dokumen yang berisi beberapa tab:

  • Jika diberikan, permintaan berlaku untuk tab yang ditentukan.

  • Jika tidak disertakan, permintaan berlaku untuk tab pertama dalam dokumen.

DeleteFooterRequest

Menghapus Footer dari dokumen.

Representasi JSON
{
  "footerId": string,
  "tabId": string
}
Kolom
footerId

string

ID footer yang akan dihapus. Jika footer ini ditentukan di DocumentStyle, referensi ke footer ini akan dihapus, sehingga tidak ada footer jenis tersebut untuk bagian pertama dokumen. Jika footer ini ditentukan di SectionStyle, referensi ke footer ini akan dihapus dan footer jenis tersebut kini dilanjutkan dari bagian sebelumnya.

tabId

string

Tab yang berisi footer yang akan dihapus. Jika tidak ada, permintaan diterapkan ke tab pertama.

Dalam dokumen yang berisi satu tab:

  • Jika diberikan, harus cocok dengan ID tab tunggal.

  • Jika tidak ada, permintaan berlaku untuk tab tunggal.

Dalam dokumen yang berisi beberapa tab:

  • Jika diberikan, permintaan berlaku untuk tab yang ditentukan.

  • Jika tidak disertakan, permintaan berlaku untuk tab pertama dalam dokumen.

PinTableHeaderRowsRequest

Memperbarui jumlah baris header tabel yang disematkan dalam tabel.

Representasi JSON
{
  "tableStartLocation": {
    object (Location)
  },
  "pinnedHeaderRowsCount": integer
}
Kolom
tableStartLocation

object (Location)

Lokasi tempat tabel dimulai dalam dokumen.

pinnedHeaderRowsCount

integer

Jumlah baris tabel yang akan disematkan, dengan 0 berarti semua baris tidak disematkan.

InsertPersonRequest

Menyisipkan sebutan orang.

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

  // Union field insertion_location can be only one of the following:
  "location": {
    object (Location)
  },
  "endOfSegmentLocation": {
    object (EndOfSegmentLocation)
  }
  // End of list of possible types for union field insertion_location.
}
Kolom
personProperties

object (PersonProperties)

Properti sebutan orang yang akan disisipkan.

Kolom gabungan insertion_location. Lokasi tempat sebutan orang akan disisipkan. insertion_location hanya dapat berupa salah satu dari berikut:
location

object (Location)

Menyisipkan sebutan orang pada indeks tertentu dalam dokumen.

Penyebutan orang harus disisipkan dalam batas Paragraph yang ada. Misalnya, tidak dapat disisipkan pada indeks awal tabel (yaitu di antara tabel dan paragraf sebelumnya).

Penyebutan orang tidak dapat disisipkan di dalam persamaan.

endOfSegmentLocation

object (EndOfSegmentLocation)

Menyisipkan sebutan orang di akhir header, footer, catatan kaki, atau isi dokumen.