アーキファクト

google-docs

orc google-docs files list --query TEXT は Docs ファイルを新しい順に検索し、--limit と --cursor でページを指定します。exports get CONNECTION_ID DOCUMENT_ID --format pdf|docx|txt|html|md --output FILE は Drive files.export を使って保存します。既定は pdf、md の MIME type は text/markdown、上限は10 MBです。copies create CONNECTION_ID DOCUMENT_ID --name NAME --parent-folder-id FOLDER_ID はファイル全体をコピーします。名前とフォルダーは省略できます。--dry-run は Google を呼ばず計画を返し、--readonly はコピーを拒否します。Drive の読み取り権限、コピーには書き込み権限が必要です。drive.file では Orchestor で作成または開いたファイルだけにアクセスできます。対象外は CONFLICT と制約の説明を返します。コピー結果が不明な場合は再送前に一覧を確認してください。

orc google-docs comments list CONNECTION_ID DOCUMENT_ID はコメント本文・引用テキスト・Drive anchor・返信を返します。comments get CONNECTION_ID DOCUMENT_ID COMMENT_ID は1件を取得します。comments create --content TEXT [--quoted-text TEXT] [--anchor JSON]、comments replies create CONNECTION_ID DOCUMENT_ID COMMENT_ID --content TEXT、comments update --content TEXT、comments delete で管理します。comments update --resolved true|false は Drive の返信 action で解決・再開します。本文と resolved を同時に指定すると本文を先に更新するため、後続の action が失敗した場合は再取得してください。コメントには Drive 権限が必要で、drive.file では Orchestor で作成または開いたファイルだけにアクセスできます。403/404 はこの制約を説明する CONFLICT を返します。本文・引用・anchor は顧客コンテンツのため、--wrap-untrusted で読んでください。ラップ時は human/table の出力を JSON に切り替え、マーカーと本文の切り詰めを防ぎます。anchor は Drive の不透明な文字列で、Docs の UTF-16 インデックスではありません。コメント操作には revision guard を適用せず、書き込みの --dry-run は Google 呼び出しや監査ログなしでリクエスト計画を返します。

orc google-docs tabs list CONNECTION_ID DOCUMENT_ID は子タブを含む全タブの ID・タイトル・親 ID・階層・並び順を返します。tabs create --title TITLE [--parent TAB] [--index N] はタブを作成します。tabs update --tab TAB は --title TITLE で名前を変更し、--parent TAB と --index N で移動します。--parent "" はルートへ移動します。index は親の中での0始まりの並び順で、テキストの位置ではありません。--tab と --parent は子タブを含む ID または完全一致する一意のタイトルを受け付け、ID を優先します。同名が複数ある場合は書き込まずに失敗するため、list の ID を使ってください。tabs delete --tab TAB は子タブも削除します。編集は読み取り時の revision を自動付与し、--dry-run は解決済み requests を返すだけです。revision 不一致は version_conflict、--readonly は編集を拒否します。

orc google-docs images create --url URL は公開 PNG・JPEG・GIF を挿入します。--width・--height はポイント指定で縦横比を保ちます。ローカル画像のアップロードは対象外です。page-breaks create は改ページ、footnotes create は脚注を作成します。chips create --type person --email EMAIL [--name NAME] は人物チップ、chips create --type date --date YYYY-MM-DD は UTC 午前0時の日付チップを挿入します。日付には --time-zone Asia/Tokyo・--locale ja を指定できます。これらの挿入は --index・--at TEXT・--end true の1つと、共有の --occurrence・--match-case・--tab・--segment を使います。位置は UTF-16 コード単位です。改ページと脚注は本文のみ、画像は脚注へ挿入できません。Google は表内の改ページも拒否します。

headers create・footers create は最初のタブまたは --tab の既定ヘッダー/フッターを作成します。作成結果の replies[].createHeader.headerId または replies[].createFooter.footerId を使い、orc google-docs text insert CONNECTION_ID DOCUMENT_ID --segment ID --end true --text TEXT で本文を書きます。headers delete --segment ID・footers delete --segment ID で削除します。脚注も作成結果の replies[].createFootnote.footnoteId を --segment に指定して本文を書きます。

named-ranges list は最初のタブまたは --tab の名前・ID・UTF-16 範囲を返します。named-ranges create --name NAME は --at TEXT または --start N --end N に名前を付けます。名前は256 UTF-16 コード単位以内で、重複できます。named-ranges delete は --named-range-id ID または --name NAME を受け取り、指定タブ内の ID または同名の全範囲を削除します。

page-layout update --width 612 --height 792 --margin-top 72 --margin-bottom 72 --margin-left 72 --margin-right 72 --orientation landscape は選択タブのページ設定を更新します。寸法と余白はポイント、width と height は同時指定です。portrait は Google の flipPageOrientation を解除し、landscape は基本寸法の縦横を反転します。ページなしモードでは表示に反映されません。各編集は先に読み取り、writeControl.requiredRevisionId を付与します。--dry-run は解決済み requests と revision を返して書き込みません。revision 不一致は version_conflict、--readonly は編集を拒否します。

orc google-docs tables create --rows JSON は文字列の二次元配列から表を作成します。--index・--at・--end true は1つだけ指定します。挿入後に構造と revision を再取得し、Google が返すセル位置へ右下から入力します。--dry-run は挿入の requests のみを返し、table_population=after_insertion と表示します。途中で失敗すると空の表が残る場合があります。table_cells_not_filled が返ったら再作成する前に読み取ってください。

既存の表は --table N(1始まり、入れ子を含む)または --at TEXT で選びます。セル内のアンカーはその表、表の外のアンカーは一致直後の表を選びます。行と列は0始まりです。tables cells update --row N --column N --text TEXT はセル全体を置換し、空文字列はセルを空にします。--cell-style JSON --style-fields FIELD_MASK は Google TableCellStyle を適用します。マスクに含めて値を省略するとリセットします。セルの罫線も設定できます。入れ子の表を含むセルの本文置換は拒否します。

tables rows create --row N --below true|false は参照行の下または上、tables columns create --column N --right true|false は右または左に挿入します。既定は下・右です。rows delete と columns delete は結合された参照セルが占める行・列を削除します。最後の行・列を削除すると表全体が削除されます。tables merges create|delete --row N --column N --row-span N --column-span N は範囲を結合・解除します。結合は本文を先頭セルへ集め、解除しても本文は先頭セルに残ります。すべての操作は読み取り時の revision を自動付与します。

orc google-docs markdown update CONNECTION_ID DOCUMENT_ID --markdown FILE --append は UTF-8 の Markdown ファイルを追記します。--markdown - は標準入力の Markdown、--stdin は JSON リクエストを読みます。--replace は最初のタブ本文を置換し、--tab TAB_ID で対象を選びます。--at TEXT は一致の直後へ挿入します。--occurrence・--match-case・--index・--end true・--segment は共有の位置解決を使います。append / replace / at / index / end は1つだけ指定します。画像は公開 URL から insertInlineImage で挿入し、読み戻すと元の代替テキストを失います。番号付きリストは 1 から始まります。未チェックのタスク項目(- [ ])は BULLET_CHECKBOX のチェックボックスリストになります。チェック済み項目(- [x])は API で状態を設定できないため、Google 呼び出し前に書き込み全体を拒否し、入力の行番号を返します。表は第1段階で本文と空の表を挿入し、再読み取りで得たセル位置と新しい revision を使う第2段階で右下から埋めます。表の --dry-run は第1段階の requests と table_population=after_insertion を表示し、セル内容の書き込みは挿入後に行うことを示します。第2段階が失敗すると document_id と table_cells_not_filled を返します。再送前に本文を確認してください。ローカル画像ファイルは対応しません。URI のない画像参照はリンク付きプレースホルダーとして残します。本文は読み取り時の revision で保護し、--dry-run は Google に書き込まず requests を表示します。脚注内容は本文と表のセルを書いた後、Google が返す ID と新しい revision を使う追加の batch で書き込みます。表のない dry-run の $footnote:N は最初の batch の reply N から得る ID です。表のプレビューではセルと脚注の requests は挿入後まで保留します。繰り返し参照は個別のネイティブ脚注を作り、名前付き範囲で同じ Markdown 定義へまとめます。途中で失敗すると部分的に適用され得るため、再送前に読み取ってください。

orc google-docs formats update は --bold true|false、--italic、--underline、--strikethrough、--font、--size、--color、--highlight、--link と段落の --named-style、--alignment、--line-spacing、--space-above、--space-below、--indent-start、--indent-end、--indent-first-line を設定します。色は #RRGGBB、サイズ・余白・字下げはポイント、行間は百分率(100 が通常)です。--color reset は継承色に戻し、--highlight reset と --link reset は解除します。--at TEXT は一致文字列全体を対象にし、--start N --end N は UTF-16 の開始位置を含み終了位置を含まない範囲です。--occurrence、--match-case、--tab、--segment も指定できます。段落書式は範囲と重なる段落に適用します。orc google-docs lists create は箇条書きを作成し、--bullet-preset NUMBERED_DECIMAL_NESTED などの NUMBERED_* で番号付きリストを作成します。lists delete は箇条書きや番号を解除します。Google はリスト作成時に先頭タブを取り除いて階層を決めるため、適用後は再度読み取って位置を確認してください。3コマンドとも読み取り時の revision を自動付与し、--dry-run で解決済み requests を表示します。

orc google-docs get はドキュメント ID または Google Docs URL を受け取ります。--format json は Google documents.get の本文を返し、--format text は本文をプレーンテキストで表示します。--format markdown は documents.get の本文を見出し・段落・太字・斜体・取り消し線・コード・リンク・入れ子リスト・表・画像参照・脚注付きの Markdown に変換します。Drive export を使わず、Orchestor で開いていないドキュメントも読み取れます。等幅フォントはインラインコードとして表示し、画像は取得せず URI を参照します。Markdown の文字位置は Docs のインデックスとは異なるため、編集位置は text または structure で確認してください。--all-tabs true --format markdown は子タブを含む各タブをタイトル付きのセクションとして出力します。--tab TAB_ID は指定タブ、--all-tabs true は子タブを含む全タブを読みます。指定しない場合は最初のタブです。両方は指定できません。

テキストの位置は UTF-16 コード単位です。各タブ本文でオフセット n は Docs のインデックス n+1 に対応します。画像・改ページなどの非テキスト要素と、表・行・セルの境界などの構造部分は U+FFFC で埋めます。絵文字などは 2 コード単位になる場合があります。タブごとに位置は独立し、全タブの出力に付く見出しは本文に含まれません。--wrap-untrusted は外部テキストをマーカーで囲み、位置を変えるため、ラップ後の文字列から Docs の位置を計算しないでください。JSON 出力の startIndex / endIndex は Google の値を保ちます。

--suggestions-view-mode は Google の提案表示モードを指定します。位置は返された表示に対して有効です。orc google-docs create --title は空のドキュメントを作り、document_id と url を返します。--readonly は作成を拒否します。作成の結果が不明な場合は、再送する前に Google Docs で確認してください。

orc google-docs structure CONNECTION_ID DOCUMENT_ID は全タブの段落・見出し・表の行列数と、body / header / footer / footnote の segment を返します。start_index は含み、end_index は含みません。本文の編集位置は 1 から、他の segment は 0 から始まります。

orc google-docs text insert は --index、--at TEXT、--end true のいずれか1つで位置を指定します。--at は一致の直後へ挿入します。--occurrence は1始まりで既定1、--match-case true で大文字小文字を区別します。--tab の既定は最初のタブ、--segment は header / footer / footnote ID で、省略時は本文です。text delete は --at の一致または --start N --end N の範囲を削除します。最終改行は削除できません。replacements create --at TEXT --text REPLACEMENT は全一致を置換し、--tab で対象タブを限定します。

これら3つの名前付き編集は必ず読み取り時の revision を writeControl.requiredRevisionId に指定します。アンカー欠落・範囲外の occurrence・複数の位置指定は INVALID_REQUEST と原因を返し、書き込みません。revision 不一致は version_conflict を返すため、再度読み取り、位置を解決してください。--dry-run はサーバーで読み取りと位置解決を行い、解決済み batchUpdate requests と revision を表示します。Google へは書き込みません。--readonly はこれらの編集を拒否します。

orc google-docs schemas list は使用できるメソッドと batchUpdate request type を列挙し、schemas get NAME は定義・参照 schema・Discovery revision を返します。api get --method documents.get --params JSON は読み取り、api update --method documents.create|documents.batchUpdate --params JSON --body JSON は書き込みです。固定した Discovery にないメソッドや request type は Google 呼び出し前に拒否します。

orc google-docs batch-requests create CONNECTION_ID DOCUMENT_ID --requests JSON または --stdin で batchUpdate requests を渡します。各 request は許可されたキーをちょうど1つ持ちます。--dry-run はキーと件数を検証し、送信せずにリクエストを表示します。Google は全 request を検証し、全件を適用するか全件を拒否します。--write-control は Google WriteControl を渡します。revision は自動付与されません。書き込みの結果が不明な場合は、再送前に本文を確認してください。すべての位置は UTF-16 コード単位です。

使い方

terminal
orc connections list --workspace YOUR_WORKSPACE_ID --provider google-workspace --format json

接続を確認する

サブコマンド

create

Create a Google Doc

terminal
orc google-docs create <id> [options]

固有のオプション

--title

(required) Body field: title; max 500 chars

型: string。任意。

terminal
orc google-docs create <id> --title <value>

get

Read a Google Doc

terminal
orc google-docs get <id> <document-id> [options]

固有のオプション

--tab

Tab ID to read, including nested tabs. Cannot be combined with all_tabs=true.; max 200 chars

型: string。任意。

terminal
orc google-docs get <id> <document-id> --tab <value>
--all-tabs

Read every tab, including nested tabs. Each tab is a separate index segment.; enum: true|false

型: string。任意。

terminal
orc google-docs get <id> <document-id> --all-tabs <value>
--suggestions-view-mode

Google suggestions view mode. Indices apply to the returned view.; enum: DEFAULT_FOR_CURRENT_ACCESS|SUGGESTIONS_INLINE|PREVIEW_SUGGESTIONS_ACCEPTED|PREVIEW_WITHOUT_SUGGESTIONS

型: string。任意。

terminal
orc google-docs get <id> <document-id> --suggestions-view-mode <value>

api get

Call a read-only Docs API method

terminal
orc google-docs api get <id> [options]

固有のオプション

--body

Google request body. All Docs indices use UTF-16 code units.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

terminal
orc google-docs api get <id> --body <value>
--method

(required) Read-only Discovery method id (documents.get).; enum: documents.get

型: string。任意。

terminal
orc google-docs api get <id> --method <value>
--params

Path and query parameters by Discovery name, for example {"documentId":"…"}. Run orc docs schemas get <method> for the list.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

terminal
orc google-docs api get <id> --params <value>

api update

Call a mutating Docs API method

terminal
orc google-docs api update <id> [options]

固有のオプション

--body

Google request body. All Docs indices use UTF-16 code units.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

terminal
orc google-docs api update <id> --body <value>
--method

(required) Mutating Discovery method id (documents.create or documents.batchUpdate).; enum: documents.batchUpdate|documents.create

型: string。任意。

terminal
orc google-docs api update <id> --method <value>
--params

Path and query parameters by Discovery name, for example {"documentId":"…"}. Run orc docs schemas get <method> for the list.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

terminal
orc google-docs api update <id> --params <value>

batch-requests create

Apply batchUpdate requests

terminal
orc google-docs batch-requests create <id> <document-id> [options]

固有のオプション

--requests

(required) batchUpdate requests, each with exactly one pinned Request type key, for example {"insertText":{"location":{"index":1},"text":"Hello"}}. All indices use UTF-16 code units. Run orc docs schemas list for the types.; JSON array of objects (use --stdin for large resources)

型: string。任意。

terminal
orc google-docs batch-requests create <id> <document-id> --requests <value>
--write-control

Google WriteControl, for example {"requiredRevisionId":"…"}. No revision is attached automatically.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

terminal
orc google-docs batch-requests create <id> <document-id> --write-control <value>

schemas list

List Docs API methods and request types

terminal
orc google-docs schemas list [options]

schemas get

Get a Docs API schema

terminal
orc google-docs schemas get <name> [options]

replacements create

Replace literal text in a Google Doc

terminal
orc google-docs replacements create <id> <document-id> [options]

固有のオプション

--at

(required) Literal text to replace throughout the document or selected tab.; max 65536 chars

型: string。任意。

terminal
orc google-docs replacements create <id> <document-id> --at <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs replacements create <id> <document-id> --match-case <value>
--tab

Tab ID to limit replacements using tabsCriteria. Omit to replace in every tab.; max 200 chars

型: string。任意。

terminal
orc google-docs replacements create <id> <document-id> --tab <value>
--text

(required) Replacement text; an empty string removes matches.; max 65536 chars

型: string。任意。

terminal
orc google-docs replacements create <id> <document-id> --text <value>

structure

Inspect Google Docs structure

terminal
orc google-docs structure <id> <document-id> [options]

text delete

Delete a text match or range

terminal
orc google-docs text delete <id> <document-id> [options]

固有のオプション

--at

Literal anchor text within the selected tab and segment.; max 65536 chars

型: string。任意。

terminal
orc google-docs text delete <id> <document-id> --at <value>
--end

Exclusive range end. The final segment newline cannot be deleted.

型: number。任意。

terminal
orc google-docs text delete <id> <document-id> --end <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs text delete <id> <document-id> --match-case <value>
--occurrence

1-based anchor occurrence, default 1. An absent occurrence fails without a write.

型: number。任意。

terminal
orc google-docs text delete <id> <document-id> --occurrence <value>
--segment

Header, footer or footnote ID in the selected tab. Omit for the body.; max 200 chars

型: string。任意。

terminal
orc google-docs text delete <id> <document-id> --segment <value>
--start

Inclusive range start. Use start and end together, or at.

型: number。任意。

terminal
orc google-docs text delete <id> <document-id> --start <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs text delete <id> <document-id> --tab <value>

text insert

Insert text at a named location

terminal
orc google-docs text insert <id> <document-id> [options]

固有のオプション

--at

Literal anchor text within the selected tab and segment.; max 65536 chars

型: string。任意。

terminal
orc google-docs text insert <id> <document-id> --at <value>
--end

Insert before the segment final newline. Specify exactly one of index, at, or end=true.

型: string。任意。

terminal
orc google-docs text insert <id> <document-id> --end <value>
--index

Google Docs index in UTF-16 code units.

型: number。任意。

terminal
orc google-docs text insert <id> <document-id> --index <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs text insert <id> <document-id> --match-case <value>
--occurrence

1-based anchor occurrence, default 1. An absent occurrence fails without a write.

型: number。任意。

terminal
orc google-docs text insert <id> <document-id> --occurrence <value>
--segment

Header, footer or footnote ID in the selected tab. Omit for the body.; max 200 chars

型: string。任意。

terminal
orc google-docs text insert <id> <document-id> --segment <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs text insert <id> <document-id> --tab <value>
--text

(required) Text to insert. With at, inserts after the selected match.; max 65536 chars

型: string。任意。

terminal
orc google-docs text insert <id> <document-id> --text <value>

markdown update

Update Markdown in a Google Doc

terminal
orc google-docs markdown update <id> <document-id> [options]

固有のオプション

--append

Append before the final newline of the body or --tab. Use exactly one of append, replace, at, index, or end=true.

型: boolean。任意。

terminal
orc google-docs markdown update <id> <document-id> --append
--at

Literal anchor text within the selected tab and segment.; max 65536 chars

型: string。任意。

terminal
orc google-docs markdown update <id> <document-id> --at <value>
--end

Insert at the end of the selected segment, using the shared location resolver.

型: string。任意。

terminal
orc google-docs markdown update <id> <document-id> --end <value>
--index

Google Docs index in UTF-16 code units.

型: number。任意。

terminal
orc google-docs markdown update <id> <document-id> --index <value>
--markdown

(required) Markdown content. CLI: --markdown FILE reads a UTF-8 file; --markdown - reads raw Markdown from stdin. Images are inserted by public URL and lose their original alt text on readback. Ordered lists restart at 1. Unchecked task items (- [ ]) become BULLET_CHECKBOX lists. Checked items (- [x]) reject the whole write before any Google call, with the source line number. Tables are inserted first; cells are populated after insertion using reread document indices and revision. Table dry-run prints phase 1 only. No Drive import or local image upload.; max 65536 chars

型: string。任意。

terminal
orc google-docs markdown update <id> <document-id> --markdown <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs markdown update <id> <document-id> --match-case <value>
--occurrence

1-based anchor occurrence, default 1. An absent occurrence fails without a write.

型: number。任意。

terminal
orc google-docs markdown update <id> <document-id> --occurrence <value>
--replace

Replace the entire body of the first tab, or --tab. Keeps the reserved final newline.

型: boolean。任意。

terminal
orc google-docs markdown update <id> <document-id> --replace
--segment

Header, footer or footnote ID in the selected tab. Omit for the body.; max 200 chars

型: string。任意。

terminal
orc google-docs markdown update <id> <document-id> --segment <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs markdown update <id> <document-id> --tab <value>

formats update

Update text and paragraph formatting

terminal
orc google-docs formats update <id> <document-id> [options]

固有のオプション

--alignment

Body field: alignment; enum: START|CENTER|END|JUSTIFIED

型: string。任意。

terminal
orc google-docs formats update <id> <document-id> --alignment <value>
--at

Literal anchor text within the selected tab and segment.; max 65536 chars

型: string。任意。

terminal
orc google-docs formats update <id> <document-id> --at <value>
--bold

Body field: bold

型: string。任意。

terminal
orc google-docs formats update <id> <document-id> --bold <value>
--color

Text color as #RRGGBB; null resets the inherited color.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc google-docs formats update <id> <document-id> --color <value>
--end

Exclusive range end in UTF-16 code units. The final segment newline is reserved.

型: number。任意。

terminal
orc google-docs formats update <id> <document-id> --end <value>
--font

Font family, for example Arial.; max 200 chars

型: string。任意。

terminal
orc google-docs formats update <id> <document-id> --font <value>
--highlight

Highlight as #RRGGBB; null removes the highlight.; (use "null" or "reset" to clear)

型: string。任意。

terminal
orc google-docs formats update <id> <document-id> --highlight <value>
--indent-end

End indentation in points.

型: number。任意。

terminal
orc google-docs formats update <id> <document-id> --indent-end <value>
--indent-first-line

First line indentation in points; negative values allow hanging indentation.

型: number。任意。

terminal
orc google-docs formats update <id> <document-id> --indent-first-line <value>
--indent-start

Start indentation in points.

型: number。任意。

terminal
orc google-docs formats update <id> <document-id> --indent-start <value>
--italic

Body field: italic

型: string。任意。

terminal
orc google-docs formats update <id> <document-id> --italic <value>
--line-spacing

Line spacing as a percentage; 100 is normal.

型: number。任意。

terminal
orc google-docs formats update <id> <document-id> --line-spacing <value>

Link URL; null removes the link.; (use "null" or "reset" to clear); max 2048 chars

型: string。任意。

terminal
orc google-docs formats update <id> <document-id> --link <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs formats update <id> <document-id> --match-case <value>
--named-style

Apply a named paragraph style; does not edit the named style definition.; enum: NORMAL_TEXT|TITLE|SUBTITLE|HEADING_1|HEADING_2|HEADING_3|HEADING_4|HEADING_5|HEADING_6

型: string。任意。

terminal
orc google-docs formats update <id> <document-id> --named-style <value>
--occurrence

1-based anchor occurrence, default 1. An absent occurrence fails without a write.

型: number。任意。

terminal
orc google-docs formats update <id> <document-id> --occurrence <value>
--segment

Header, footer or footnote ID in the selected tab. Omit for the body.; max 200 chars

型: string。任意。

terminal
orc google-docs formats update <id> <document-id> --segment <value>
--size

Font size in points.

型: number。任意。

terminal
orc google-docs formats update <id> <document-id> --size <value>
--space-above

Space above the paragraph in points.

型: number。任意。

terminal
orc google-docs formats update <id> <document-id> --space-above <value>
--space-below

Space below the paragraph in points.

型: number。任意。

terminal
orc google-docs formats update <id> <document-id> --space-below <value>
--start

Inclusive range start. Specify start/end together, or at to span the entire matched text.

型: number。任意。

terminal
orc google-docs formats update <id> <document-id> --start <value>
--strikethrough

Body field: strikethrough

型: string。任意。

terminal
orc google-docs formats update <id> <document-id> --strikethrough <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs formats update <id> <document-id> --tab <value>
--underline

Body field: underline

型: string。任意。

terminal
orc google-docs formats update <id> <document-id> --underline <value>

lists create

Create bullets or numbering

terminal
orc google-docs lists create <id> <document-id> [options]

固有のオプション

--at

Literal anchor text within the selected tab and segment.; max 65536 chars

型: string。任意。

terminal
orc google-docs lists create <id> <document-id> --at <value>
--bullet-preset

Google bullet or numbering preset. NUMBERED_* creates numbering. Google removes leading tabs to determine nesting, which can change indices; re-read after applying.; enum: BULLET_DISC_CIRCLE_SQUARE|BULLET_DIAMONDX_ARROW3D_SQUARE|BULLET_CHECKBOX|BULLET_ARROW_DIAMOND_DISC|BULLET_STAR_CIRCLE_SQUARE|BULLET_ARROW3D_CIRCLE_SQUARE|BULLET_LEFTTRIANGLE_DIAMOND_DISC|BULLET_DIAMONDX_HOLLOWDIAMOND_SQUARE|BULLET_DIAMOND_CIRCLE_SQUARE|NUMBERED_DECIMAL_ALPHA_ROMAN|NUMBERED_DECIMAL_ALPHA_ROMAN_PARENS|NUMBERED_DECIMAL_NESTED|NUMBERED_UPPERALPHA_ALPHA_ROMAN|NUMBERED_UPPERROMAN_UPPERALPHA_DECIMAL|NUMBERED_ZERODECIMAL_ALPHA_ROMAN

型: string。任意。

terminal
orc google-docs lists create <id> <document-id> --bullet-preset <value>
--end

Exclusive range end in UTF-16 code units. The final segment newline is reserved.

型: number。任意。

terminal
orc google-docs lists create <id> <document-id> --end <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs lists create <id> <document-id> --match-case <value>
--occurrence

1-based anchor occurrence, default 1. An absent occurrence fails without a write.

型: number。任意。

terminal
orc google-docs lists create <id> <document-id> --occurrence <value>
--segment

Header, footer or footnote ID in the selected tab. Omit for the body.; max 200 chars

型: string。任意。

terminal
orc google-docs lists create <id> <document-id> --segment <value>
--start

Inclusive range start. Specify start/end together, or at to span the entire matched text.

型: number。任意。

terminal
orc google-docs lists create <id> <document-id> --start <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs lists create <id> <document-id> --tab <value>

lists delete

Remove bullets or numbering

terminal
orc google-docs lists delete <id> <document-id> [options]

固有のオプション

--at

Literal anchor text within the selected tab and segment.; max 65536 chars

型: string。任意。

terminal
orc google-docs lists delete <id> <document-id> --at <value>
--end

Exclusive range end in UTF-16 code units. The final segment newline is reserved.

型: number。任意。

terminal
orc google-docs lists delete <id> <document-id> --end <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs lists delete <id> <document-id> --match-case <value>
--occurrence

1-based anchor occurrence, default 1. An absent occurrence fails without a write.

型: number。任意。

terminal
orc google-docs lists delete <id> <document-id> --occurrence <value>
--segment

Header, footer or footnote ID in the selected tab. Omit for the body.; max 200 chars

型: string。任意。

terminal
orc google-docs lists delete <id> <document-id> --segment <value>
--start

Inclusive range start. Specify start/end together, or at to span the entire matched text.

型: number。任意。

terminal
orc google-docs lists delete <id> <document-id> --start <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs lists delete <id> <document-id> --tab <value>

tables cells update

Update table cell text and style

terminal
orc google-docs tables cells update <id> <document-id> [options]

固有のオプション

--at

Literal anchor text within the selected tab and segment.; max 65536 chars

型: string。任意。

terminal
orc google-docs tables cells update <id> <document-id> --at <value>
--cell-style

Google TableCellStyle JSON, e.g. {"backgroundColor":{"color":{"rgbColor":{"red":1}}}}. Cell borders are supported.; (JSON object, e.g. '{"custom_id":"x"}')

型: string。任意。

terminal
orc google-docs tables cells update <id> <document-id> --cell-style <value>
--column

(required) Zero-based column index.

型: number。任意。

terminal
orc google-docs tables cells update <id> <document-id> --column <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs tables cells update <id> <document-id> --match-case <value>
--occurrence

1-based anchor occurrence, default 1. An absent occurrence fails without a write.

型: number。任意。

terminal
orc google-docs tables cells update <id> <document-id> --occurrence <value>
--row

(required) Zero-based row index.

型: number。任意。

terminal
orc google-docs tables cells update <id> <document-id> --row <value>
--segment

Header, footer or footnote ID in the selected tab. Omit for the body.; max 200 chars

型: string。任意。

terminal
orc google-docs tables cells update <id> <document-id> --segment <value>
--style-fields

Explicit TableCellStyle field mask, required with cell_style. Include an omitted field to reset it.; max 1000 chars

型: string。任意。

terminal
orc google-docs tables cells update <id> <document-id> --style-fields <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs tables cells update <id> <document-id> --tab <value>
--table

1-based table ordinal in the selected tab/segment, including nested tables. Use table or at. at selects the innermost table containing the match, otherwise the next table after it.

型: number。任意。

terminal
orc google-docs tables cells update <id> <document-id> --table <value>
--text

Replace the entire cell text, preserving its final newline. Empty string clears it. Nested tables must be edited separately.; max 65536 chars

型: string。任意。

terminal
orc google-docs tables cells update <id> <document-id> --text <value>

tables columns create

Insert a table column

terminal
orc google-docs tables columns create <id> <document-id> [options]

固有のオプション

--at

Literal anchor text within the selected tab and segment.; max 65536 chars

型: string。任意。

terminal
orc google-docs tables columns create <id> <document-id> --at <value>
--column

(required) Zero-based column index.

型: number。任意。

terminal
orc google-docs tables columns create <id> <document-id> --column <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs tables columns create <id> <document-id> --match-case <value>
--occurrence

1-based anchor occurrence, default 1. An absent occurrence fails without a write.

型: number。任意。

terminal
orc google-docs tables columns create <id> <document-id> --occurrence <value>

Insert right of the reference column; false inserts left.

型: string。任意。

terminal
orc google-docs tables columns create <id> <document-id> --right <value>
--segment

Header, footer or footnote ID in the selected tab. Omit for the body.; max 200 chars

型: string。任意。

terminal
orc google-docs tables columns create <id> <document-id> --segment <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs tables columns create <id> <document-id> --tab <value>
--table

1-based table ordinal in the selected tab/segment, including nested tables. Use table or at. at selects the innermost table containing the match, otherwise the next table after it.

型: number。任意。

terminal
orc google-docs tables columns create <id> <document-id> --table <value>

tables columns delete

Delete a table column

terminal
orc google-docs tables columns delete <id> <document-id> [options]

固有のオプション

--at

Literal anchor text within the selected tab and segment.; max 65536 chars

型: string。任意。

terminal
orc google-docs tables columns delete <id> <document-id> --at <value>
--column

(required) Zero-based column index.

型: number。任意。

terminal
orc google-docs tables columns delete <id> <document-id> --column <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs tables columns delete <id> <document-id> --match-case <value>
--occurrence

1-based anchor occurrence, default 1. An absent occurrence fails without a write.

型: number。任意。

terminal
orc google-docs tables columns delete <id> <document-id> --occurrence <value>
--segment

Header, footer or footnote ID in the selected tab. Omit for the body.; max 200 chars

型: string。任意。

terminal
orc google-docs tables columns delete <id> <document-id> --segment <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs tables columns delete <id> <document-id> --tab <value>
--table

1-based table ordinal in the selected tab/segment, including nested tables. Use table or at. at selects the innermost table containing the match, otherwise the next table after it.

型: number。任意。

terminal
orc google-docs tables columns delete <id> <document-id> --table <value>

tables create

Create a table with plain-text data

terminal
orc google-docs tables create <id> <document-id> [options]

固有のオプション

--at

Literal anchor text within the selected tab and segment.; max 65536 chars

型: string。任意。

terminal
orc google-docs tables create <id> <document-id> --at <value>
--end

Insert before the final newline. Use exactly one of index, at, end=true.

型: string。任意。

terminal
orc google-docs tables create <id> <document-id> --end <value>
--index

Google Docs index in UTF-16 code units.

型: number。任意。

terminal
orc google-docs tables create <id> <document-id> --index <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs tables create <id> <document-id> --match-case <value>
--occurrence

1-based anchor occurrence, default 1. An absent occurrence fails without a write.

型: number。任意。

terminal
orc google-docs tables create <id> <document-id> --occurrence <value>
--rows

(required) Rectangular JSON array of rows of plain-text cell values, for example [["Name","Count"],["A","2"]]. At most 500 cells and 65536 UTF-16 units total. Tables cannot be inserted in footnotes. Cells are filled after rereading the inserted structure; dry-run previews insertion only.; JSON array of arrays (use --stdin for large resources)

型: string。任意。

terminal
orc google-docs tables create <id> <document-id> --rows <value>
--segment

Header, footer or footnote ID in the selected tab. Omit for the body.; max 200 chars

型: string。任意。

terminal
orc google-docs tables create <id> <document-id> --segment <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs tables create <id> <document-id> --tab <value>

tables merges create

Merge table cells

terminal
orc google-docs tables merges create <id> <document-id> [options]

固有のオプション

--at

Literal anchor text within the selected tab and segment.; max 65536 chars

型: string。任意。

terminal
orc google-docs tables merges create <id> <document-id> --at <value>
--column

(required) Zero-based column index.

型: number。任意。

terminal
orc google-docs tables merges create <id> <document-id> --column <value>
--column-span

(required) Number of columns in the merge/unmerge range.

型: number。任意。

terminal
orc google-docs tables merges create <id> <document-id> --column-span <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs tables merges create <id> <document-id> --match-case <value>
--occurrence

1-based anchor occurrence, default 1. An absent occurrence fails without a write.

型: number。任意。

terminal
orc google-docs tables merges create <id> <document-id> --occurrence <value>
--row

(required) Zero-based row index.

型: number。任意。

terminal
orc google-docs tables merges create <id> <document-id> --row <value>
--row-span

(required) Number of rows in the merge/unmerge range.

型: number。任意。

terminal
orc google-docs tables merges create <id> <document-id> --row-span <value>
--segment

Header, footer or footnote ID in the selected tab. Omit for the body.; max 200 chars

型: string。任意。

terminal
orc google-docs tables merges create <id> <document-id> --segment <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs tables merges create <id> <document-id> --tab <value>
--table

1-based table ordinal in the selected tab/segment, including nested tables. Use table or at. at selects the innermost table containing the match, otherwise the next table after it.

型: number。任意。

terminal
orc google-docs tables merges create <id> <document-id> --table <value>

tables merges delete

Unmerge table cells

terminal
orc google-docs tables merges delete <id> <document-id> [options]

固有のオプション

--at

Literal anchor text within the selected tab and segment.; max 65536 chars

型: string。任意。

terminal
orc google-docs tables merges delete <id> <document-id> --at <value>
--column

(required) Zero-based column index.

型: number。任意。

terminal
orc google-docs tables merges delete <id> <document-id> --column <value>
--column-span

(required) Number of columns in the merge/unmerge range.

型: number。任意。

terminal
orc google-docs tables merges delete <id> <document-id> --column-span <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs tables merges delete <id> <document-id> --match-case <value>
--occurrence

1-based anchor occurrence, default 1. An absent occurrence fails without a write.

型: number。任意。

terminal
orc google-docs tables merges delete <id> <document-id> --occurrence <value>
--row

(required) Zero-based row index.

型: number。任意。

terminal
orc google-docs tables merges delete <id> <document-id> --row <value>
--row-span

(required) Number of rows in the merge/unmerge range.

型: number。任意。

terminal
orc google-docs tables merges delete <id> <document-id> --row-span <value>
--segment

Header, footer or footnote ID in the selected tab. Omit for the body.; max 200 chars

型: string。任意。

terminal
orc google-docs tables merges delete <id> <document-id> --segment <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs tables merges delete <id> <document-id> --tab <value>
--table

1-based table ordinal in the selected tab/segment, including nested tables. Use table or at. at selects the innermost table containing the match, otherwise the next table after it.

型: number。任意。

terminal
orc google-docs tables merges delete <id> <document-id> --table <value>

tables rows create

Insert a table row

terminal
orc google-docs tables rows create <id> <document-id> [options]

固有のオプション

--at

Literal anchor text within the selected tab and segment.; max 65536 chars

型: string。任意。

terminal
orc google-docs tables rows create <id> <document-id> --at <value>
--below

Insert below the reference row; false inserts above.

型: string。任意。

terminal
orc google-docs tables rows create <id> <document-id> --below <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs tables rows create <id> <document-id> --match-case <value>
--occurrence

1-based anchor occurrence, default 1. An absent occurrence fails without a write.

型: number。任意。

terminal
orc google-docs tables rows create <id> <document-id> --occurrence <value>
--row

(required) Zero-based row index.

型: number。任意。

terminal
orc google-docs tables rows create <id> <document-id> --row <value>
--segment

Header, footer or footnote ID in the selected tab. Omit for the body.; max 200 chars

型: string。任意。

terminal
orc google-docs tables rows create <id> <document-id> --segment <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs tables rows create <id> <document-id> --tab <value>
--table

1-based table ordinal in the selected tab/segment, including nested tables. Use table or at. at selects the innermost table containing the match, otherwise the next table after it.

型: number。任意。

terminal
orc google-docs tables rows create <id> <document-id> --table <value>

tables rows delete

Delete a table row

terminal
orc google-docs tables rows delete <id> <document-id> [options]

固有のオプション

--at

Literal anchor text within the selected tab and segment.; max 65536 chars

型: string。任意。

terminal
orc google-docs tables rows delete <id> <document-id> --at <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs tables rows delete <id> <document-id> --match-case <value>
--occurrence

1-based anchor occurrence, default 1. An absent occurrence fails without a write.

型: number。任意。

terminal
orc google-docs tables rows delete <id> <document-id> --occurrence <value>
--row

(required) Zero-based row index.

型: number。任意。

terminal
orc google-docs tables rows delete <id> <document-id> --row <value>
--segment

Header, footer or footnote ID in the selected tab. Omit for the body.; max 200 chars

型: string。任意。

terminal
orc google-docs tables rows delete <id> <document-id> --segment <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs tables rows delete <id> <document-id> --tab <value>
--table

1-based table ordinal in the selected tab/segment, including nested tables. Use table or at. at selects the innermost table containing the match, otherwise the next table after it.

型: number。任意。

terminal
orc google-docs tables rows delete <id> <document-id> --table <value>

chips create

Insert a person or date chip

terminal
orc google-docs chips create <id> <document-id> [options]

固有のオプション

--at

Literal anchor text within the selected tab and segment.; max 65536 chars

型: string。任意。

terminal
orc google-docs chips create <id> <document-id> --at <value>
--date

Calendar date as YYYY-MM-DD, inserted at midnight UTC.

型: string。任意。

terminal
orc google-docs chips create <id> <document-id> --date <value>
--email

Body field: email; max 320 chars

型: string。任意。

terminal
orc google-docs chips create <id> <document-id> --email <value>
--end

Insert before the final newline. Use exactly one of index, at, end=true.

型: string。任意。

terminal
orc google-docs chips create <id> <document-id> --end <value>
--index

Google Docs index in UTF-16 code units.

型: number。任意。

terminal
orc google-docs chips create <id> <document-id> --index <value>
--locale

Google date display locale, for example ja or en.; max 20 chars

型: string。任意。

terminal
orc google-docs chips create <id> <document-id> --locale <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs chips create <id> <document-id> --match-case <value>
--name

Optional display name for a person chip.; max 500 chars

型: string。任意。

terminal
orc google-docs chips create <id> <document-id> --name <value>
--occurrence

1-based anchor occurrence, default 1. An absent occurrence fails without a write.

型: number。任意。

terminal
orc google-docs chips create <id> <document-id> --occurrence <value>
--segment

Header, footer or footnote ID in the selected tab. Omit for the body.; max 200 chars

型: string。任意。

terminal
orc google-docs chips create <id> <document-id> --segment <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs chips create <id> <document-id> --tab <value>
--time-zone

Date display time zone, for example Asia/Tokyo. Google defaults to UTC.; max 200 chars

型: string。任意。

terminal
orc google-docs chips create <id> <document-id> --time-zone <value>
--type

(required) person requires email; date requires date. Other type-specific fields are rejected.; enum: person|date

型: string。任意。

terminal
orc google-docs chips create <id> <document-id> --type <value>

footers create

Create the default footer

terminal
orc google-docs footers create <id> <document-id> [options]

固有のオプション

--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs footers create <id> <document-id> --tab <value>

footers delete

Delete a footer

terminal
orc google-docs footers delete <id> <document-id> [options]

固有のオプション

--segment

(required) Footer ID from structure or the create reply.; max 200 chars

型: string。任意。

terminal
orc google-docs footers delete <id> <document-id> --segment <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs footers delete <id> <document-id> --tab <value>

footnotes create

Create a footnote

terminal
orc google-docs footnotes create <id> <document-id> [options]

固有のオプション

--at

Literal anchor text within the selected tab and segment.; max 65536 chars

型: string。任意。

terminal
orc google-docs footnotes create <id> <document-id> --at <value>
--end

Insert before the final newline. Use exactly one of index, at, end=true.

型: string。任意。

terminal
orc google-docs footnotes create <id> <document-id> --end <value>
--index

Google Docs index in UTF-16 code units.

型: number。任意。

terminal
orc google-docs footnotes create <id> <document-id> --index <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs footnotes create <id> <document-id> --match-case <value>
--occurrence

1-based anchor occurrence, default 1. An absent occurrence fails without a write.

型: number。任意。

terminal
orc google-docs footnotes create <id> <document-id> --occurrence <value>
--segment

Header, footer or footnote ID in the selected tab. Omit for the body.; max 200 chars

型: string。任意。

terminal
orc google-docs footnotes create <id> <document-id> --segment <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs footnotes create <id> <document-id> --tab <value>

headers create

Create the default header

terminal
orc google-docs headers create <id> <document-id> [options]

固有のオプション

--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs headers create <id> <document-id> --tab <value>

headers delete

Delete a header

terminal
orc google-docs headers delete <id> <document-id> [options]

固有のオプション

--segment

(required) Header ID from structure or the create reply.; max 200 chars

型: string。任意。

terminal
orc google-docs headers delete <id> <document-id> --segment <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs headers delete <id> <document-id> --tab <value>

images create

Insert an image from a public URL

terminal
orc google-docs images create <id> <document-id> [options]

固有のオプション

--at

Literal anchor text within the selected tab and segment.; max 65536 chars

型: string。任意。

terminal
orc google-docs images create <id> <document-id> --at <value>
--end

Insert before the final newline. Use exactly one of index, at, end=true.

型: string。任意。

terminal
orc google-docs images create <id> <document-id> --end <value>
--height

Image height in points; aspect ratio is preserved.

型: number。任意。

terminal
orc google-docs images create <id> <document-id> --height <value>
--index

Google Docs index in UTF-16 code units.

型: number。任意。

terminal
orc google-docs images create <id> <document-id> --index <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs images create <id> <document-id> --match-case <value>
--occurrence

1-based anchor occurrence, default 1. An absent occurrence fails without a write.

型: number。任意。

terminal
orc google-docs images create <id> <document-id> --occurrence <value>
--segment

Header, footer or footnote ID in the selected tab. Omit for the body.; max 200 chars

型: string。任意。

terminal
orc google-docs images create <id> <document-id> --segment <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs images create <id> <document-id> --tab <value>
--url

(required) Public PNG, JPEG or GIF URL fetched by Google; no local uploads.; max 2048 chars

型: string。任意。

terminal
orc google-docs images create <id> <document-id> --url <value>
--width

Image width in points; aspect ratio is preserved.

型: number。任意。

terminal
orc google-docs images create <id> <document-id> --width <value>

named-ranges list

List named ranges in a tab

terminal
orc google-docs named-ranges list <id> <document-id> [options]

固有のオプション

--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs named-ranges list <id> <document-id> --tab <value>

named-ranges create

Create a named range

terminal
orc google-docs named-ranges create <id> <document-id> [options]

固有のオプション

--at

Literal anchor text within the selected tab and segment.; max 65536 chars

型: string。任意。

terminal
orc google-docs named-ranges create <id> <document-id> --at <value>
--end

Exclusive range end in UTF-16 code units. The final segment newline is reserved.

型: number。任意。

terminal
orc google-docs named-ranges create <id> <document-id> --end <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs named-ranges create <id> <document-id> --match-case <value>
--name

(required) Range name, measured in UTF-16 code units; names need not be unique.; max 256 chars

型: string。任意。

terminal
orc google-docs named-ranges create <id> <document-id> --name <value>
--occurrence

1-based anchor occurrence, default 1. An absent occurrence fails without a write.

型: number。任意。

terminal
orc google-docs named-ranges create <id> <document-id> --occurrence <value>
--segment

Header, footer or footnote ID in the selected tab. Omit for the body.; max 200 chars

型: string。任意。

terminal
orc google-docs named-ranges create <id> <document-id> --segment <value>
--start

Inclusive range start. Specify start/end together, or at to span the entire matched text.

型: number。任意。

terminal
orc google-docs named-ranges create <id> <document-id> --start <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs named-ranges create <id> <document-id> --tab <value>

named-ranges delete

Delete named ranges

terminal
orc google-docs named-ranges delete <id> <document-id> [options]

固有のオプション

--name

Delete every range with this name in the selected tab.; max 256 chars

型: string。任意。

terminal
orc google-docs named-ranges delete <id> <document-id> --name <value>
--named-range-id

Delete this range ID in the selected tab. Use exactly one of name or named_range_id.; max 200 chars

型: string。任意。

terminal
orc google-docs named-ranges delete <id> <document-id> --named-range-id <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs named-ranges delete <id> <document-id> --tab <value>

page-breaks create

Insert a page break

terminal
orc google-docs page-breaks create <id> <document-id> [options]

固有のオプション

--at

Literal anchor text within the selected tab and segment.; max 65536 chars

型: string。任意。

terminal
orc google-docs page-breaks create <id> <document-id> --at <value>
--end

Insert before the final newline. Use exactly one of index, at, end=true.

型: string。任意。

terminal
orc google-docs page-breaks create <id> <document-id> --end <value>
--index

Google Docs index in UTF-16 code units.

型: number。任意。

terminal
orc google-docs page-breaks create <id> <document-id> --index <value>
--match-case

Match case exactly, default false.

型: string。任意。

terminal
orc google-docs page-breaks create <id> <document-id> --match-case <value>
--occurrence

1-based anchor occurrence, default 1. An absent occurrence fails without a write.

型: number。任意。

terminal
orc google-docs page-breaks create <id> <document-id> --occurrence <value>
--segment

Header, footer or footnote ID in the selected tab. Omit for the body.; max 200 chars

型: string。任意。

terminal
orc google-docs page-breaks create <id> <document-id> --segment <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs page-breaks create <id> <document-id> --tab <value>

page-layout update

Update page size, margins and orientation

terminal
orc google-docs page-layout update <id> <document-id> [options]

固有のオプション

--height

Base page height in points. Requires width.

型: number。任意。

terminal
orc google-docs page-layout update <id> <document-id> --height <value>
--margin-bottom

Bottom margin in points.

型: number。任意。

terminal
orc google-docs page-layout update <id> <document-id> --margin-bottom <value>
--margin-left

Left margin in points.

型: number。任意。

terminal
orc google-docs page-layout update <id> <document-id> --margin-left <value>
--margin-right

Right margin in points.

型: number。任意。

terminal
orc google-docs page-layout update <id> <document-id> --margin-right <value>
--margin-top

Top margin in points.

型: number。任意。

terminal
orc google-docs page-layout update <id> <document-id> --margin-top <value>
--orientation

portrait clears flipPageOrientation; landscape sets it, flipping the base page dimensions. Only rendered in paged documents.; enum: portrait|landscape

型: string。任意。

terminal
orc google-docs page-layout update <id> <document-id> --orientation <value>
--tab

Tab ID. Defaults to the first tab; use structure to inspect nested tabs.; max 200 chars

型: string。任意。

terminal
orc google-docs page-layout update <id> <document-id> --tab <value>
--width

Base page width in points. Requires height; orientation flips these base dimensions.

型: number。任意。

terminal
orc google-docs page-layout update <id> <document-id> --width <value>

tabs list

List document tabs, including nested tabs

terminal
orc google-docs tabs list <id> <document-id> [options]

tabs create

Create a document tab

terminal
orc google-docs tabs create <id> <document-id> [options]

固有のオプション

--index

Zero-based sibling position within the parent, not a text offset.

型: number。任意。

terminal
orc google-docs tabs create <id> <document-id> --index <value>
--parent

Parent tab ID or exact, unique title. Empty string selects the document root; omit to keep the current parent on update.; max 500 chars

型: string。任意。

terminal
orc google-docs tabs create <id> <document-id> --parent <value>
--title

New tab title. Omit for the Google default.; max 500 chars

型: string。任意。

terminal
orc google-docs tabs create <id> <document-id> --title <value>

tabs delete

Delete a document tab and its children

terminal
orc google-docs tabs delete <id> <document-id> [options]

固有のオプション

--tab

(required) Tab ID or exact, unique title, including nested tabs. Ambiguous titles fail without writing; use tabs list for IDs.; max 500 chars

型: string。任意。

terminal
orc google-docs tabs delete <id> <document-id> --tab <value>

tabs update

Rename or move a document tab

terminal
orc google-docs tabs update <id> <document-id> [options]

固有のオプション

--index

Zero-based sibling position within the parent, not a text offset.

型: number。任意。

terminal
orc google-docs tabs update <id> <document-id> --index <value>
--parent

Parent tab ID or exact, unique title. Empty string selects the document root; omit to keep the current parent on update.; max 500 chars

型: string。任意。

terminal
orc google-docs tabs update <id> <document-id> --parent <value>
--tab

(required) Tab ID or exact, unique title, including nested tabs. Ambiguous titles fail without writing; use tabs list for IDs.; max 500 chars

型: string。任意。

terminal
orc google-docs tabs update <id> <document-id> --tab <value>
--title

Rename the selected tab.; max 500 chars

型: string。任意。

terminal
orc google-docs tabs update <id> <document-id> --title <value>

comments list

List document comments with quoted text and anchors

terminal
orc google-docs comments list <id> <document-id> [options]

固有のオプション

--include-deleted

enum: true|false

型: string。任意。

terminal
orc google-docs comments list <id> <document-id> --include-deleted <value>

comments create

Create a document comment

terminal
orc google-docs comments create <id> <document-id> [options]

固有のオプション

--anchor

Opaque Drive anchor JSON string. Drive anchors are not Docs UTF-16 indices and may not appear inline in the Google Docs editor.; max 65536 chars

型: string。任意。

terminal
orc google-docs comments create <id> <document-id> --anchor <value>
--content

(required) Plain-text comment body. Customer content; use --wrap-untrusted when reading comments.; max 65536 chars

型: string。任意。

terminal
orc google-docs comments create <id> <document-id> --content <value>
--quoted-text

Quoted document text returned with the comment.; max 65536 chars

型: string。任意。

terminal
orc google-docs comments create <id> <document-id> --quoted-text <value>

comments get

Get a document comment and its replies

terminal
orc google-docs comments get <id> <document-id> <comment-id> [options]

comments delete

Delete a document comment

terminal
orc google-docs comments delete <id> <document-id> <comment-id> [options]

comments replies create

Reply to a document comment

terminal
orc google-docs comments replies create <id> <document-id> <comment-id> [options]

固有のオプション

--content

(required) Plain-text comment body. Customer content; use --wrap-untrusted when reading comments.; max 65536 chars

型: string。任意。

terminal
orc google-docs comments replies create <id> <document-id> <comment-id> --content <value>

comments update

Edit, resolve or reopen a document comment

terminal
orc google-docs comments update <id> <document-id> <comment-id> [options]

固有のオプション

--content

Plain-text comment body. Customer content; use --wrap-untrusted when reading comments.; max 65536 chars

型: string。任意。

terminal
orc google-docs comments update <id> <document-id> <comment-id> --content <value>
--resolved

true resolves and false reopens via a Drive reply action. May be combined with content.

型: string。任意。

terminal
orc google-docs comments update <id> <document-id> <comment-id> --resolved <value>

copies create

Copy a document

terminal
orc google-docs copies create <id> <document-id> [options]

固有のオプション

--name

Name of the copy. Defaults to "Copy of …".; max 500 chars

型: string。任意。

terminal
orc google-docs copies create <id> <document-id> --name <value>
--parent-folder-id

Drive folder for the copy. Defaults to the source folder.

型: string。任意。

terminal
orc google-docs copies create <id> <document-id> --parent-folder-id <value>

exports get

Export a document

terminal
orc google-docs exports get <id> <document-id> [options]

files list

List documents

terminal
orc google-docs files list <id> [options]

固有のオプション

--query

Only documents whose name contains this text.; max 200 chars

型: string。任意。

terminal
orc google-docs files list <id> --query <value>

使用例

Docs を検索・エクスポート・コピーする

terminal
orc google-docs files list YOUR_CONNECTION_ID --workspace YOUR_WORKSPACE_ID --query Report --format json
orc google-docs exports get YOUR_CONNECTION_ID DOCUMENT_ID --workspace YOUR_WORKSPACE_ID --format pdf --output report.pdf
orc google-docs copies create YOUR_CONNECTION_ID DOCUMENT_ID --workspace YOUR_WORKSPACE_ID --name "Report copy" --dry-run

Docs を検索・エクスポート・コピーする

Markdown をプレビューする

terminal
orc google-docs markdown update YOUR_CONNECTION_ID DOCUMENT_ID --workspace YOUR_WORKSPACE_ID --markdown report.md --replace --tab TAB_ID --dry-run

Markdown をプレビューする

全タブを Markdown で読む

terminal
orc google-docs get YOUR_CONNECTION_ID DOCUMENT_ID --workspace YOUR_WORKSPACE_ID --format markdown --all-tabs true --readonly

全タブを Markdown で読む

Google の本文を取得する

terminal
orc google-docs get YOUR_CONNECTION_ID DOCUMENT_ID --workspace YOUR_WORKSPACE_ID --format json

Google の本文を取得する

URL からテキストを読む

terminal
orc google-docs get YOUR_CONNECTION_ID https://docs.google.com/document/d/DOCUMENT_ID/edit --workspace YOUR_WORKSPACE_ID --format text --readonly

URL からテキストを読む

タブを選んで安全に読む

terminal
orc google-docs get YOUR_CONNECTION_ID DOCUMENT_ID --workspace YOUR_WORKSPACE_ID --tab TAB_ID --format text --wrap-untrusted
orc google-docs get YOUR_CONNECTION_ID DOCUMENT_ID --workspace YOUR_WORKSPACE_ID --all-tabs true --format json

タブを選んで安全に読む

位置を指定して挿入を確認する

terminal
orc google-docs structure YOUR_CONNECTION_ID DOCUMENT_ID --workspace YOUR_WORKSPACE_ID
orc google-docs text insert YOUR_CONNECTION_ID DOCUMENT_ID --workspace YOUR_WORKSPACE_ID --at X --occurrence 2 --text "New text" --dry-run

位置を指定して挿入を確認する

API 定義を確認する

terminal
orc google-docs schemas list --workspace YOUR_WORKSPACE_ID
orc google-docs schemas get insertText --workspace YOUR_WORKSPACE_ID

API 定義を確認する

一括編集を送信前に検証する

terminal
orc google-docs batch-requests create YOUR_CONNECTION_ID DOCUMENT_ID --workspace YOUR_WORKSPACE_ID --requests '[{"insertText":{"location":{"index":1},"text":"Hello"}}]' --dry-run

一括編集を送信前に検証する

ドキュメントを作成する

terminal
orc google-docs create YOUR_CONNECTION_ID --workspace YOUR_WORKSPACE_ID --title "Weekly report" --format json

ドキュメントを作成する

必要な権限

Google Workspace 接続を使います。既存の Google Sheets 接続には Docs の権限がないため、Google Workspace を接続してください。読み取りには documents.readonly または documents、書き込みには documents が必要です。ドキュメントは接続した Google アカウントと共有されている必要があります。ログインと Workspace へのアクセスも必要です。

グローバルオプション

orc google-docs では、次のグローバルオプションを使用できます。

各オプションの詳細と使用例は、グローバルオプションを参照してください。