LoginSignup
0
0
@doran

[Google Docs API(V1)] Javaでドキュメントの情報を取得する

Posted at

Google Docs API V1(Java)を使用して、
Googleドキュメントの情報を取得する方法
についてご紹介します。

APIを利用する環境の準備から始める場合や、コードを実行する際は、
⧉[Google Docs API(V1)] JavaでDocs APIを使う
を参照ください。

No 目次
1 ドキュメントを取得
1 スコープ
2 実行
3 レスポンスの内容

1. ドキュメントを取得

ドキュメントの情報を取得します。

1.1. スコープ

このAPIを実行するには、以下のいずれかのスコープを指定してください。

DocsScopes.DOCUMENTS
DocsScopes.DOCUMENTS_READONLY
DocsScopes.DRIVE
DocsScopes.DRIVE_READONLY
DocsScopes.DRIVE_FILE

⧉[Google Docs API(V1)] JavaでDocs APIを使う(2.2 Docsインスタンスを取得)
でスコープを指定してください。

1.2. 実行

public static void main(String[] args) throws Exception{
    Docs docs = getDocs();
    Docs.Documents documents = docs.documents();
    
    Docs.Documents.Get get = documents.get("ドキュメントID");
    
    Document res = get.execute();
    System.out.println(res);
}

1.2.1. HTTPリクエスト

GET:　https://docs.googleapis.com/v1/documents/{ドキュメントID}
が実行されます。

1.2.2. クエリパラメータ

Docs.Documents.Getのsetメソッドにより、クエリパラメータを追加できます。

メソッド 引数 説明
setSuggestionsViewMode SuggestionsViewMode(enum) ドキュメントに適用する候補表示モード

SuggestionsViewMode

定義値 内容
DEFAULT_FOR_CURRENT_ACCESS ユーザーの現在のアクセスレベルによって異なる
SUGGESTIONS_INLINE インラインの提案あり
PREVIEW_SUGGESTIONS_ACCEPTED 提案された変更をすべて承認したプレビュー
PREVIEW_WITHOUT_SUGGESTIONS ドキュメント内に提案があれば提案された変更をすべて拒否

1.3. レスポンスの内容

Document

メソッド 戻り値 説明
getDocumentId String 出力のみ。ドキュメントID
getTitle String ドキュメントのタイトル
getBody Body 出力のみ。ドキュメントの本文
getHeaders Map<String,Header> 出力のみ。ドキュメント内のヘッダー
key：ヘッダーID
getFooters Map<String,Footer> 出力のみ。ドキュメント内のフッター
key：フッターID
getFootnotes Map<String,Footnote> 出力のみ。ドキュメントの脚注IDをキーにしたドキュメント
getDocumentStyle DocumentStyle 出力のみ。ドキュメントのスタイル
getSuggestedDocumentStyleChanges Map<String,SuggestedDocumentStyle> 出力のみ。ドキュメントのスタイルへの提案された変更
key：提案ID
getNamedStyles NamedStyles 出力のみ。ドキュメントの名前付きスタイル
getSuggestedNamedStylesChanges Map<String,SuggestedNamedStyles> 出力のみ。ドキュメントの名前付きスタイルに対する変更の提案
key：候補ID
getLists Map<String,List> 出力のみ。ドキュメント内のリスト
key：リストID
getNamedRanges Map<String,NamedRanges> 出力のみ。ドキュメント内の名前付き範囲
key：名前
getRevisionId String 出力のみ。ドキュメントのリビジョンID
getSuggestionsViewMode SuggestionsViewMode(enum) 出力のみ。ドキュメントに適用された候補表示モード
getInlineObjects Map<String,InlineObject> 出力のみ。ドキュメント内のインラインオブジェクト
key：オブジェクトID
getPositionedObjects Map<String,PositionedObject> 出力のみ。ドキュメント内に配置されたオブジェクト
key：オブジェクトID

Body

メソッド 戻り値 説明
getContent List<StructuralElement> 本文のコンテンツ

StructuralElement

メソッド 戻り値 説明
getStartIndex Integer 構造要素の開始インデックス(0開始)
getEndIndex Integer 構造要素の終了インデックス(0開始)
paragraph Paragraph 構造要素の段落タイプ
getSectionBreak SectionBreak 構造要素のセクション区切りタイプ
getTable Table 構造要素のテーブルタイプ
getTableOfContents TableOfContents 構造要素の目次タイプ

Paragraph

メソッド 戻り値 説明
getElements List<ParagraphElement> 構成要素に分割された段落の内容
getParagraphStyle ParagraphStyle この段落のスタイル
getSuggestedParagraphStyleChanges Map<String,SuggestedParagraphStyle> 提案された段落のスタイル
key：提案ID
getBullet Bullet この段落の箇条書き
getSuggestedBulletChanges Map<String,SuggestedBullet> この段落の箇条書きに対して推奨される変更
getPositionedObjectIds List<String> この段落にテザリングされている配置されたオブジェクトID
getSuggestedPositionedObjectIds Map<String,ObjectReferences> この段落に添付することが提案された配置されたオブジェクト
key：提案ID

ObjectReferences

メソッド 戻り値 説明
getObjectIds List<String> オブジェクトID

ParagraphElement

メソッド 戻り値 説明
getStartIndex Integer 段落要素の開始インデックス(0開始)
getEndIndex Integer 段落要素の終了インデックス(0開始)
textRun TextRun テキスト実行の段落要素
getAutoText AutoText 自動テキストの段落要素
getPageBreak PageBreak 改ページ段落要素
getColumnBreak ColumnBreak 列区切りの段落要素
getFootnoteReference FootnoteReference 脚注参照段落の要素
getHorizontalRule HorizontalRule 水平方向の規則の段落要素
getEquation Equation 方程式の段落要素
getInlineObjectElement InlineObjectElement インライン オブジェクト段落要素
getPerson Person 個人またはメールアドレスにリンクする段落要素
getRichLink RichLink Googleリソース

TextRun

メソッド 戻り値 説明
getContent String この実行のテキスト
getSuggestedInsertionIds List<String> 提案された挿入ID
getSuggestedDeletionIds List<String> 提案された削除ID
getTextStyle TextStyle この実行のテキストスタイル
getSuggestedTextStyleChanges Map<String,SuggestedTextStyle> 候補のテキストスタイル
key：候補ID

TextStyle

メソッド 戻り値 説明
getBold Boolean テキストを太字でレンダリングするか
getItalic Boolean テキストを斜体にするか
getUnderline Boolean テキストに下線を引くか
getStrikethrough Boolean テキストに取り消し線が引かれるか
getSmallCaps Boolean テキストが小文字の大文字表記か
getBackgroundColor OptionalColor テキストの背景色
getForegroundColor OptionalColor テキストの前景色
getFontSize Dimension テキストのフォントのサイズ
getWeightedFontFamily WeightedFontFamily フォント ファミリーと、テキストのレンダリングの太さ
getBaselineOffset BaselineOffset(enum) 通常の位置からのテキストの垂直オフセット
getLink Link テキストのハイパーリンクのリンク先

OptionalColor

メソッド 戻り値 説明
getColor Color 透明な色

Color

メソッド 戻り値 説明
getRgbColor RgbColor RGB カラー値

RgbColor

メソッド 戻り値 説明
getRed Float 赤色（0.0 ～ 1.0）
getGreen Float 緑色（0.0 ～ 1.0）
getBlue Float 青色（0.0 ～ 1.0）

Dimension

メソッド 戻り値 説明
getMagnitude Double 強度
getUnit Unit(enum) 大きさの単位

Unit

定義値 内容
UNIT_UNSPECIFIED 単位が不明
PT ポイント

WeightedFontFamily

メソッド 戻り値 説明
getFontFamily String テキストのフォントファミリー
getWeight Integer フォントの太さ

BaselineOffset

定義値 内容
BASELINE_OFFSET_UNSPECIFIED テキストのベースライン
NONE テキストが垂直方向にオフセットされていない
SUPERSCRIPT テキストは垂直方向に上向き（上付き文字）
SUBSCRIPT テキストは垂直方向に下方向（下付き文字）

Link

メソッド 戻り値 説明
url String 外部 URL
getBookmarkId String このドキュメント内のブックマークID
getHeadingId String このドキュメントの見出しID

SuggestedTextStyle

メソッド 戻り値 説明
getTextStyle TextStyle この提案に加えられた変更のみを含むテキストスタイル
getTextStyleSuggestionState TextStyleSuggestionState この提案で変更されたベースTextStyle のフィールドを示すマスク

TextStyleSuggestionState

メソッド 戻り値 説明
getBoldSuggested Boolean bold への変更が提案されたか
getItalicSuggested Boolean italic への変更が提案されたか
getUnderlineSuggested Boolean underline への変更が提案されたか
getStrikethroughSuggested Boolean strikethrough への変更が提案されたか
getSmallCapsSuggested Boolean smallCaps への変更が提案されたか
getBackgroundColorSuggested Boolean backgroundColor への変更が提案されたか
getForegroundColorSuggested Boolean foregroundColor への変更が提案されたか
getFontSizeSuggested Boolean fontSize への変更が提案されたか
getWeightedFontFamilySuggested Boolean weightedFontFamily への変更が提案されたか
getBaselineOffsetSuggested Boolean baselineOffset への変更が提案されたか
getLinkSuggested Boolean link への変更が提案されたか

AutoText

メソッド 戻り値 説明
getType Type(enum) この自動テキストのタイプ
getSuggestedInsertionIds List<String> 提案された挿入ID
getSuggestedDeletionIds List<String> 提案された削除ID
getTextStyle TextStyle テキストスタイル
getSuggestedTextStyleChanges Map<String,SuggestedTextStyle> 候補のテキストスタイル
key：候補ID

Type

定義値 内容
TYPE_UNSPECIFIED 未指定の自動テキストタイプ
PAGE_NUMBER 現在のページ番号を表す自動テキストを入力
PAGE_COUNT ドキュメント内の総ページ数を表す自動テキストを入力

PageBreak

メソッド 戻り値 説明
getSuggestedInsertionIds List<String> 提案された挿入ID
getSuggestedDeletionIds List<String> 提案された削除ID
getTextStyle TextStyle テキストスタイル
getSuggestedTextStyleChanges Map<String,SuggestedTextStyle> 候補のテキストスタイル
key：候補ID

ColumnBreak

メソッド 戻り値 説明
getSuggestedInsertionIds List<String> 提案された挿入ID
getSuggestedDeletionIds List<String> 提案された削除ID
getTextStyle TextStyle テキストスタイル
getSuggestedTextStyleChanges Map<String,SuggestedTextStyle> 提案されたテキストスタイル
key：提案ID

FootnoteReference

メソッド 戻り値 説明
getFootnoteId String この脚注参照のコンテンツが含まれているfootnoteID
getFootnoteNumber String この脚注のレンダリング番号
getSuggestedInsertionIds List<String> 提案された挿入ID
getSuggestedDeletionIds List<String> 提案された削除ID
getTextStyle TextStyle テキストスタイル
getSuggestedTextStyleChanges Map<String,SuggestedTextStyle> 提案されたテキストスタイル
key：提案ID

HorizontalRule

メソッド 戻り値 説明
getSuggestedInsertionIds List<String> 提案された挿入ID
getSuggestedDeletionIds List<String> 提案された削除ID
getTextStyle TextStyle テキストスタイル
getSuggestedTextStyleChanges Map<String,SuggestedTextStyle> 候補のテキストスタイル
key：候補ID

Equation

メソッド 戻り値 説明
getSuggestedInsertionIds List<String> 提案された挿入ID
getSuggestedDeletionIds List<String> 提案された削除ID

InlineObjectElement

メソッド 戻り値 説明
getInlineObjectId String この要素に含まれるInlineObjectID
getSuggestedInsertionIds List<String> 提案された挿入ID
getSuggestedDeletionIds List<String> 提案された削除ID
getTextStyle TextStyle テキストスタイル
getSuggestedTextStyleChanges Map<String,SuggestedTextStyle> 候補のテキストスタイル
key：候補ID

Person

メソッド 戻り値 説明
getPersonId String 出力のみ。リンクID
getSuggestedInsertionIds List<String> ドキュメントに挿入する候補ID
getSuggestedDeletionIds List<String> ドキュメントからこのユーザーのリンクを削除する提案ID
getTextStyle TextStyle テキストスタイル
getSuggestedTextStyleChanges Map<String,SuggestedTextStyle> 候補のテキストスタイル
key：候補ID
getPersonProperties PersonProperties 出力のみ。この Person のプロパティ。このフィールドは常に存在します

PersonProperties

メソッド 戻り値 説明
getName String 出力のみ。名前
getEmail String 出力のみ。メールアドレス

RichLink

メソッド 戻り値 説明
getRichLinkId String 出力のみ。リンクID
getSuggestedInsertionIds List<String> リンクをドキュメントに挿入する候補ID
getSuggestedDeletionIds List<String> ドキュメントからこのリンクを削除する提案ID
getTextStyle TextStyle テキストスタイル
getSuggestedTextStyleChanges Map<String,SuggestedTextStyle> 候補のテキストスタイル
key：候補ID
getRichLinkProperties RichLinkProperties 出力のみ。RichLinkプロパティ

RichLinkProperties

メソッド 戻り値 説明
getTitle String 出力のみ。タイトル
getUri String 出力のみ。URI
getMimeType String 出力のみ。MIMEタイプ

ParagraphStyle

メソッド 戻り値 説明
getHeadingId String 段落の見出しID
getNamedStyleType NamedStyleType(enum) 段落の名前付きスタイルタイプ
getAlignment Alignment(enum) この段落のテキストの配置
getLineSpacing Float 行間のスペースの法線に対する割合
getDirection ContentDirection(enum) この段落のテキストの向き
getSpacingMode SpacingMode(enum) 段落の間隔モード
getSpaceAbove Dimension 段落の上に表示される余分なスペースの量
getSpaceBelow Dimension 段落の下のスペースの量
getBorderBetween ParagraphBorder この段落と、次の段落や前の段落との間の枠線
getBorderTop ParagraphBorder この段落の上部にある枠線
getBorderBottom ParagraphBorder この段落の一番下にある枠線
getBorderLeft ParagraphBorder この段落の左側の枠線
getBorderRight ParagraphBorder この段落の右側の枠線
getIndentFirstLine Dimension 段落の1行目のインデントの量
getIndentStart Dimension 現在の段落の方向に基づく、テキストの先頭に対応する側の段落のインデントの量
getIndentEnd Dimension 現在の段落の方向に基づく、テキストの末尾に対応する側の段落のインデントの量
getTabStops List<TabStop> この段落のタブ位置のリスト
getKeepLinesTogether Boolean 段落の行、列にレイアウトするか
getKeepWithNext Boolean この段落の少なくとも一部を、可能であれば次の段落と同じページや列に配置するか
getAvoidWidowAndOrphan Boolean 段落で未亡人や孤児を避けるか
getShading Shading 段落の網かけ
getPageBreakBefore Boolean 現在の段落を常にページの先頭から開始するか

NamedStyleType

定義値 内容
NAMED_STYLE_TYPE_UNSPECIFIED 指定無し
NORMAL_TEXT 標準テキスト
TITLE タイトル
SUBTITLE サブタイトル
HEADING_1 見出し1
HEADING_2 見出し2
HEADING_3 見出し3
HEADING_4 見出し4
HEADING_5 見出し5
HEADING_6 見出し6

Alignment

定義値 内容
ALIGNMENT_UNSPECIFIED 段落の配置は親から継承
START 段落は行頭に揃えられる
CENTER 段落が中央に配置
END 段落は行末に揃えられる
JUSTIFIED 段落が両端揃え

ContentDirection

定義値 内容
CONTENT_DIRECTION_UNSPECIFIED 指定無し
LEFT_TO_RIGHT コンテンツは左から右
RIGHT_TO_LEFT コンテンツは右から左

SpacingMode

定義値 内容
SPACING_MODE_UNSPECIFIED 間隔モードは親から継承
NEVER_COLLAPSE 段落の間隔は常にレンダリング
COLLAPSE_LISTS リスト要素間の段落間隔はスキップ

ParagraphBorder

メソッド 戻り値 説明
getColor OptionalColor 枠線の色
getWidth Dimension 枠線の幅
getPadding Dimension 枠線のパディング
getDashStyle DashStyle(enum) 枠線の破線スタイル

DashStyle

定義値 内容
DASH_STYLE_UNSPECIFIED 指定無し
SOLID 実線
DOT 点線
DASH 破線

TabStop

メソッド 戻り値 説明
getOffset Dimension タブ位置と開始余白の間のオフセット
getAlignment TabStopAlignment(enum) タブ位置の配置

TabStopAlignment

定義値 内容
TAB_STOP_ALIGNMENT_UNSPECIFIED 指定無し
START タブ位置は行頭に揃えられる
CENTER タブ位置は行の中央に揃えられる
END タブ位置は行末に揃えられる

Shading

メソッド 戻り値 説明
getBackgroundColor OptionalColor 段落の網かけの背景色

SuggestedParagraphStyle

メソッド 戻り値 説明
getParagraphStyle ParagraphStyle 提案に加えられた変更のみを含む情報
getParagraphStyleSuggestionState ParagraphStyleSuggestionState この提案で変更されたベース ParagraphStyle のフィールドを示すマスク

ParagraphStyleSuggestionState

メソッド 戻り値 説明
getHeadingIdSuggested Boolean headingId への変更が提案されたか
getNamedStyleTypeSuggested Boolean namedStyleType への変更が提案されたか
getAlignmentSuggested Boolean alignment への変更が提案されたか
getLineSpacingSuggested Boolean lineSpacing への変更が提案されたか
getDirectionSuggested Boolean direction への変更が提案されたか
getSpacingModeSuggested Boolean spacingMode への変更が提案されたか
getSpaceAboveSuggested Boolean spaceAbove への変更が提案されたか
getSpaceBelowSuggested Boolean spaceBelow への変更が提案されたか
getBorderBetweenSuggested Boolean borderBetween への変更が提案されたか
getBorderTopSuggested Boolean borderTop への変更が提案されたか
getBorderBottomSuggested Boolean borderBottom への変更が提案されたか
getBorderLeftSuggested Boolean borderLeft への変更が提案されたか
getBorderRightSuggested Boolean borderRight への変更が提案されたか
getIndentFirstLineSuggested Boolean indentFirstLine への変更が提案されたか
getIndentStartSuggested Boolean indentStart への変更が提案されたか
getIndentEndSuggested Boolean indentEnd への変更が提案されたか
getKeepLinesTogetherSuggested Boolean keepLinesTogether への変更が提案されたか
getKeepWithNextSuggested Boolean keepWithNext への変更が提案されたか
getAvoidWidowAndOrphanSuggested Boolean avoidWidowAndOrphan への変更が提案されたか
getShadingSuggestionState ShadingSuggestionState この提案で変更された shading のフィールドを示すマスク
getPageBreakBeforeSuggested Boolean pageBreakBefore への変更が提案されたか

ShadingSuggestionState

メソッド 戻り値 説明
getBackgroundColorSuggested Boolean Shading の変更が提案されたか

Bullet

メソッド 戻り値 説明
getListId String この段落が属するリストID
getNestingLevel Integer リスト内のこの段落のネストレベル
getTextStyle TextStyle この箇条書きに適用される段落固有のテキストスタイル

SuggestedBullet

メソッド 戻り値 説明
getBullet Bullet この提案に加えられた変更のみを含む情報
getBulletSuggestionState BulletSuggestionState この提案で変更されたベース Bullet のフィールドを示すマスク

BulletSuggestionState

メソッド 戻り値 説明
getListIdSuggested Boolean listId の変更が提案されたか
getNestingLevelSuggested Boolean nestingLevel の変更が提案されたか
getTextStyleSuggestionState TextStyleSuggestionState この提案で変更された text style のフィールドを示すマスク

ObjectReference

メソッド 戻り値 説明
getObjectIds List<String> オブジェクトID

SectionBreak

メソッド 戻り値 説明
getSuggestedInsertionIds List<String> 提案された挿入ID
getSuggestedDeletionIds List<String> 提案された削除ID
getSectionStyle SectionStyle このセクション区切りの後のセクションのスタイル

SectionStyle

メソッド 戻り値 説明
getColumnProperties List<SectionColumnProperties> セクションの列のプロパティ
getColumnSeparatorStyle ColumnSeparatorStyle(enum) 列区切りのスタイル
getContentDirection ContentDirection(enum) このセクションのコンテンツの方向
getMarginTop Dimension セクションのトップページの余白
getMarginBottom Dimension セクションの下部ページの余白
getMarginRight Dimension セクションの右側のページ余白
getMarginLeft Dimension セクションの左のページ余白
getMarginHeader Dimension セクションのヘッダーマージン
getMarginFooter Dimension セクションのフッターマージン
getSectionType SectionType(enum) 出力のみ。セクションのタイプ
getDefaultHeaderId String デフォルトヘッダーID
getDefaultFooterId String デフォルトのフッターID
getFirstPageHeaderId String セクションの1ページ目でのみ使用されるヘッダーID
getFirstPageFooterId String セクションの最初のページでのみ使用されるフッターID
getEvenPageHeaderId String 偶数ページでのみ使用されるヘッダーID
getEvenPageFooterId String 偶数ページでのみ使用されるフッターID
getUseFirstPageHeaderFooter Boolean セクションの最初のページに最初のページのヘッダーまたはフッターのIDを使用するか
getPageNumberStart Integer このセクションのページ数のカウントを開始するページ番号
getFlipPageOrientation Boolean このセクションの DocumentStyleのpageSize のサイズを反転するか

SectionColumnProperties

メソッド 戻り値 説明
getWidth Dimension 出力のみ。列の幅
getPaddingEnd Dimension 列の末尾のパディング

ColumnSeparatorStyle

定義値 内容
COLUMN_SEPARATOR_STYLE_UNSPECIFIED 指定無し
NONE 列間に列区切り線を入れない
BETWEEN_EACH_COLUMN 各列の間に列区切り線をレンダリング

SectionType

定義値 内容
SECTION_TYPE_UNSPECIFIED 指定無し
CONTINUOUS 前のセクションの最後の段落の直後に開始
NEXT_PAGE 次のページから開始

Table

メソッド 戻り値 説明
getRows Integer テーブル内の行数
getColumns Integer テーブル内の列数
getTableRows List<TableRow> 各行のコンテンツとスタイル
getSuggestedInsertionIds List<String> 提案された挿入ID
getSuggestedDeletionIds List<String> 提案された削除ID
getTableStyle TableStyle 表のスタイル

TableRow

メソッド 戻り値 説明
getStartIndex Integer 行の開始インデックス(0開始)
getEndIndex Integer 行の終了インデックス(0開始)
getTableCells List<TableCell> この行の各セルのコンテンツとスタイル
getSuggestedInsertionIds List<String> 提案された挿入ID
getSuggestedDeletionIds List<String> 提案された削除ID
getTableRowStyle TableRowStyle 表の行のスタイル
getSuggestedTableRowStyleChanges Map<String,SuggestedTableRowStyle> 提案されたスタイル
key：提案ID

TableCell

メソッド 戻り値 説明
getStartIndex Integer セルの開始インデックス(0開始)
getEndIndex Integer セルの終了インデックス(0開始)
getContent List<StructuralElement> セルのコンテンツ
getTableCellStyle TableCellStyle セルのスタイル
getSuggestedInsertionIds List<String> 提案された挿入ID
getSuggestedDeletionIds List<String> 提案された削除ID
getSuggestedTableCellStyleChanges Map<String,SuggestedTableCellStyle> 表のセルのスタイルに対する提案された変更
key：候補ID

TableCellStyle

メソッド 戻り値 説明
getRowSpan Integer セルの行スパン
getColumnSpan Integer セルの列スパン
getBackgroundColor OptionalColor セルの背景色
getBorderLeft TableCellBorder セルの左枠線
getBorderRight TableCellBorder セルの右枠線
getBorderTop TableCellBorder セルの上枠線
getBorderBottom TableCellBorder セルの下枠線
getPaddingLeft Dimension セルの左側のパディング
getPaddingRight Dimension セルの右パディング
getPaddingTop Dimension セルの上部のパディング
getPaddingBottom Dimension セルの下のパディング
getContentAlignment ContentAlignment(enum) 表のセル内のコンテンツの配置

TableCellBorder

メソッド 戻り値 説明
getColor OptionalColor 枠線の色
getWidth Dimension 枠線の幅
getDashStyle DashStyle(enum) 枠線の破線スタイル

ContentAlignment

定義値 内容
CONTENT_ALIGNMENT_UNSPECIFIED 未指定のコンテンツの配置
CONTENT_ALIGNMENT_UNSUPPORTED サポートされていないコンテンツの配置
TOP コンテンツをコンテンツ ホルダーの上端に揃える配置
MIDDLE コンテンツをコンテンツ ホルダーの中央に揃える配置
BOTTOM コンテンツをコンテンツ ホルダーの下部に揃える配置

SuggestedTableCellStyle

メソッド 戻り値 説明
getTableCellStyle TableCellStyle この提案に加えられた変更のみを含む情報
getTableCellStyleSuggestionState TableCellStyleSuggestionState この提案で変更されたベース TableCellStyle のフィールドを示すマスク

TableCellStyleSuggestionState

メソッド 戻り値 説明
getRowSpanSuggested Boolean rowSpan への変更が提案されたか
getColumnSpanSuggested Boolean columnSpan への変更が提案されたか
getBackgroundColorSuggested Boolean backgroundColor への変更が提案されたか
getBorderLeftSuggested Boolean borderLeft への変更が提案されたか
getBorderRightSuggested Boolean borderRight への変更が提案されたか
getBorderTopSuggested Boolean borderTop への変更が提案されたか
getBorderBottomSuggested Boolean borderBottom への変更が提案されたか
getPaddingLeftSuggested Boolean paddingLeft への変更が提案されたか
getPaddingRightSuggested Boolean paddingRight への変更が提案されたか
getPaddingTopSuggested Boolean paddingTop への変更が提案されたか
getPaddingBottomSuggested Boolean paddingBottom への変更が提案されたか
getContentAlignmentSuggested Boolean contentAlignment への変更が提案されたか

TableRowStyle

メソッド 戻り値 説明
getMinRowHeight Dimension 行の最小の高さ
getTableHeader Boolean 行が表の見出しか
getPreventOverflow Boolean 行がページまたは列の境界を越えてはみ出さないかどうか

SuggestedTableRowStyle

メソッド 戻り値 説明
getTableRowStyle TableRowStyle この提案に加えられた変更のみを含む情報
getTableRowStyleSuggestionState TableRowStyleSuggestionState この提案で変更されたベース TableRowStyle のフィールドを示すマスク

TableRowStyleSuggestionState

メソッド 戻り値 説明
getMinRowHeightSuggested Boolean minRowHeight への変更が提案されたか

TableStyle

メソッド 戻り値 説明
getTableColumnProperties List<TableColumnProperties> 各列のプロパティ

TableColumnProperties

メソッド 戻り値 説明
getWidthType WidthType(enum) 列の幅の型
getWidth Dimension 列の幅

WidthType

定義値 内容
WIDTH_TYPE_UNSPECIFIED 指定無し
EVENLY_DISTRIBUTED 列幅は均等に分散した他の列間で均等に分配
getFIXED_WIDTH 固定の列幅

TableOfContents

メソッド 戻り値 説明
getContent List<StructuralElement> 目次の内容
getSuggestedInsertionIds List<String> 提案された挿入ID
getSuggestedDeletionIds List<String> 提案された削除ID

Header

メソッド 戻り値 説明
getHeaderId String ヘッダーの ID
getContent List<StructuralElement> ヘッダーの内容

Footer

メソッド 戻り値 説明
getFooterId String フッターの ID
getContent List<StructuralElement> フッターのコンテンツ

Footnote

メソッド 戻り値 説明
getFootnoteId String 脚注の ID
getContent List<StructuralElement> 脚注の内容

DocumentStyle

メソッド 戻り値 説明
getBackground Background ドキュメントの背景
getDefaultHeaderId String デフォルト ヘッダーID
getDefaultFooterId String デフォルトのフッターID
getEvenPageHeaderId String 偶数ページでのみ使用されるヘッダーID
getEvenPageFooterId String 偶数ページでのみ使用されるフッターID
getFirstPageHeaderId String 最初のページでのみ使用されるヘッダーID
getFirstPageFooterId String 最初のページでのみ使用されるフッターID
getUseFirstPageHeaderFooter Boolean 最初のページで最初のページのヘッダーまたはフッターのIDを使用するか
getUseEvenPageHeaderFooter Boolean 偶数ページで偶数ページのヘッダー/フッターIDを使用するか
getPageNumberStart Integer ページ数のカウントを開始するページ番号
getMarginTop Dimension トップページのマージン
getMarginBottom Dimension ページの下部余白
getMarginRight Dimension ページの右余白
getMarginLeft Dimension 左のページ余白
getPageSize Size ドキュメント内のページのサイズ
getMarginHeader Dimension ページの上部とヘッダー コンテンツの間のスペースの大きさ
getMarginFooter Dimension ページの下部とフッターのコンテンツの間のスペースの量
getUseCustomHeaderFooterMargins Boolean ヘッダーまたはフッダーを遵守されるか
getFlipPageOrientation Boolean サイズを反転して、ページの向き（縦向きと横向き）を変更できるか

Background

メソッド 戻り値 説明
getColor OptionalColor 背景色

Size

メソッド 戻り値 説明
getHeight Dimension オブジェクトの高さ
getWidth Dimension オブジェクトの幅

SuggestedDocumentStyle

メソッド 戻り値 説明
getDocumentStyle DocumentStyle この提案に加えられた変更のみを含む情報
getDocumentStyleSuggestionState DocumentStyleSuggestionState この提案で変更されたベース DocumentStyle のフィールドを示すマスク

DocumentStyleSuggestionState

メソッド 戻り値 説明
getBackgroundSuggestionState BackgroundSuggestionState この提案で変更された background のフィールドを示すマスク
getDefaultHeaderIdSuggested Boolean defaultHeaderId への変更が提案されたか
getDefaultFooterIdSuggested Boolean defaultFooterId への変更が提案されたか
getEvenPageHeaderIdSuggested Boolean evenPageHeaderId への変更が提案されたか
getEvenPageFooterIdSuggested Boolean evenPageFooterId への変更が提案されたか
getFirstPageHeaderIdSuggested Boolean firstPageHeaderId への変更が提案されたか
getFirstPageFooterIdSuggested Boolean firstPageFooterId への変更が提案されたか
getUseFirstPageHeaderFooterSuggested Boolean useFirstPageHeaderFooter への変更が提案されたか
getUseEvenPageHeaderFooterSuggested Boolean useEvenPageHeaderFooter への変更が提案されたか
getPageNumberStartSuggested Boolean pageNumberStart への変更が提案されたか
getMarginTopSuggested Boolean marginTop への変更が提案されたか
getMarginBottomSuggested Boolean marginBottom への変更が提案されたか
getMarginRightSuggested Boolean marginRight への変更が提案されたか
getMarginLeftSuggested Boolean marginLeft への変更が提案されたか
getPageSizeSuggestionState SizeSuggestionState この提案で変更されたフィールドを示すマスク
getMarginHeaderSuggested Boolean marginHeader への変更が提案されたか
getMarginFooterSuggested Boolean marginFooter への変更が提案されたか
getUseCustomHeaderFooterMarginsSuggested Boolean useCustomHeaderFooterMargins への変更が提案されたか
getFlipPageOrientationSuggested Boolean （省略可）flipPageOrientation への変更が提案されたか

BackgroundSuggestionState

メソッド 戻り値 説明
getBackgroundColorSuggested Boolean この提案で現在の背景色が変更されたか

SizeSuggestionState

メソッド 戻り値 説明
getHeightSuggested Boolean height への変更が提案されたか
getWidthSuggested Boolean width への変更が提案されたか

NamedStyles

メソッド 戻り値 説明
getStyles List<NamedStyle> 名前を付けたスタイル

NamedStyle

メソッド 戻り値 説明
getNamedStyleType NamedStyleType(enum) この名前付きスタイルのタイプ
getTextStyle TextStyle この名前付きスタイルのテキスト スタイル
getParagraphStyle ParagraphStyle この名前付きスタイルの段落スタイル

SuggestedNamedStyles

メソッド 戻り値 説明
getNamedStyles NamedStyles この提案に加えられた変更のみを含む情報
getNamedStylesSuggestionState NamedStylesSuggestionState この提案で変更されたベース NamedStyles のフィールドを示すマスク

NamedStylesSuggestionState

メソッド 戻り値 説明
getStylesSuggestionStates List<NamedStyleSuggestionState> この提案で変更された styles の対応する NamedStyle のフィールドを示すマスク

NamedStyleSuggestionState

メソッド 戻り値 説明
getNamedStyleType NamedStyleType(enum) この候補の状態が対応する名前付きのスタイルタイプ
getTextStyleSuggestionState TextStyleSuggestionState この提案で変更された text style のフィールドを示すマスク
getParagraphStyleSuggestionState ParagraphStyleSuggestionState この提案で変更された paragraph style のフィールドを示すマスク

List

メソッド 戻り値 説明
getListProperties ListProperties リストのプロパティ
getSuggestedListPropertiesChanges Map<String,SuggestedListProperties> リストプロパティに対して推奨される変更
key：候補ID
getSuggestedInsertionId String 提案された挿入 ID。空の場合、挿入は推奨されません
getSuggestedDeletionIds List<String> 提案された削除 ID。空の場合、このリストの削除候補はありません

ListProperties

メソッド 戻り値 説明
getNestingLevels List<NestingLevel> 関連するレベルの箇条書きのプロパティ情報

NestingLevel

メソッド 戻り値 説明
getBulletAlignment BulletAlignment(enum) 箇条書きのレンダリング用に割り当てられるスペース内の箇条書きの配置
getGlyphFormat String このネスト レベルで箇条書きで使用する書式設定文字列
getIndentFirstLine Dimension このネストレベルでの段落の 1 行目のインデントの量
getIndentStart Dimension このネストレベルでの段落のインデントの量。段落のコンテンツの方向に基づいて、テキストの先頭に対応する側に適用されます
getTextStyle TextStyle このネストレベルの箇条書きテキスト スタイル
getStartNumber Integer このネストレベルの最初のリスト項目の数
glyphType GlyphType(enum) このレベルのネストで段落を並べ替える際に、箇条書きで使用するグリフの種類
getGlyphSymbol String このネストレベルの段落の順序がない場合に、箇条書きで使用するカスタムグリフ記号

BulletAlignment

定義値 内容
BULLET_ALIGNMENT_UNSPECIFIED 指定無し
START 箇条書きは、その表示用に割り当てられたスペースの先頭に合わせて配置
CENTER 箇条書きは、その表示に使用されるスペースの中央に揃えられる
END 箇条書きは、その表示用に割り当てられたスペースの端に揃えられる

GlyphType

定義値 内容
GLYPH_TYPE_UNSPECIFIED グリフのタイプが指定されていないか、サポートされていない
NONE 空の文字列
DECIMAL 数値
ZERO_DECIMAL 1桁の数字の前にゼロが付加された数字
UPPER_ALPHA 大文字
ALPHA 小文字
UPPER_ROMAN 大文字のローマ数字
ROMAN 小文字のローマ数字

SuggestedListProperties

メソッド 戻り値 説明
getListProperties ListProperties この提案に加えられた変更のみを含む情報
getListPropertiesSuggestionState ListPropertiesSuggestionState この提案で変更されたベース ListProperties のフィールドを示すマスク

ListPropertiesSuggestionState

メソッド 戻り値 説明
getNestingLevelsSuggestionStates List<NestingLevelSuggestionState> この提案で変更された nestingLevels の対応する NestingLevel のフィールドを示すマスク

NestingLevelSuggestionState

メソッド 戻り値 説明
getBulletAlignmentSuggested Boolean bulletAlignment への変更が提案されたか
getGlyphTypeSuggested Boolean glyphType への変更が提案されたか
getGlyphFormatSuggested Boolean glyphFormat への変更が提案されたか
getGlyphSymbolSuggested Boolean glyphSymbol への変更が提案されたか
getIndentFirstLineSuggested Boolean indentFirstLine への変更が提案されたか
getIndentStartSuggested Boolean indentStart への変更が提案されたか
getTextStyleSuggestionState TextStyleSuggestionState この提案で変更された text style のフィールドを示すマスク
getStartNumberSuggested Boolean startNumber への変更が提案されたか

NamedRanges

メソッド 戻り値 説明
getName String すべての named ranges が共有する名前
getNamedRanges List<NamedRange> 同じ名前を共有する NamedRange

NamedRange

メソッド 戻り値 説明
getNamedRangeId String 名前付き範囲ID
getName String 名前付き範囲の名前
getRanges List<Range> この名前付き範囲に属する範囲

Range

メソッド 戻り値 説明
getSegmentId String この範囲が含まれているヘッダー、フッター、または脚注ID
getStartIndex Integer 範囲の開始インデックス(0開始)
getEndIndex Integer 範囲の終了インデックス(0開始)

SuggestionsViewMode

定義値 内容
DEFAULT_FOR_CURRENT_ACCESS デフォルトの候補表示モード
SUGGESTIONS_INLINE インラインの提案
PREVIEW_SUGGESTIONS_ACCEPTED 提案された変更をすべて承認したプレビュー
PREVIEW_WITHOUT_SUGGESTIONS プレビューで、ドキュメント内に提案があれば提案された変更がすべて拒否

InlineObject

メソッド 戻り値 説明
getObjectId String オブジェクトID
getInlineObjectProperties InlineObjectProperties このインライン オブジェクトのプロパティ
getSuggestedInlineObjectPropertiesChanges Map<String,SuggestedInlineObjectProperties> インラインオブジェクト プロパティ
key：候補ID
getSuggestedInsertionId String 提案された挿入ID
getSuggestedDeletionIds List<String> 提案された削除ID

InlineObjectProperties

メソッド 戻り値 説明
getEmbeddedObject EmbeddedObject このインライン オブジェクトの埋め込みオブジェクト

EmbeddedObject

メソッド 戻り値 説明
getTitle String 埋め込みオブジェクトのタイトル
getDescription String 埋め込みオブジェクトの説明
getEmbeddedObjectBorder EmbeddedObjectBorder 埋め込みオブジェクトの枠線
getSize Size 切り抜き後の画像の表示サイズ
getMarginTop Dimension 埋め込みオブジェクトの上余白
getMarginBottom Dimension 埋め込みオブジェクトの下余白
getMarginRight Dimension 埋め込みオブジェクトの右余白
getMarginLeft Dimension 埋め込みオブジェクトの左マージン
getLinkedContentReference LinkedContentReference 外部のリンクされたソース コンテンツへの参照
getEmbeddeddrawingproperties Embeddeddrawingproperties 埋め込まれた図形描画のプロパティ
getImageProperties ImageProperties 画像のプロパティ

EmbeddedDrawingProperties

フィールドはありません。

ImageProperties

メソッド 戻り値 説明
getContentUri String デフォルトの有効期間が30分の画像へのURI
getSourceUri String 画像の挿入に使用されるURI
getBrightness Float 画像の明るさの効果(-1.0〜1.0)
getContrast Float 画像のコントラスト効果(-1.0〜1.0)
getTransparency Float 画像の透明度効果(0.0〜1.0)
getCropProperties CropProperties 画像の切り抜きプロパティ
getAngle Float 画像の時計回りの回転角度（ラジアン単位）

CropProperties

メソッド 戻り値 説明
getOffsetLeft Float 切り抜く四角形の左端から元のコンテンツの左端までのオフセット
getOffsetRight Float 切り抜く四角形の右端から元のコンテンツの右端から内側までのオフセット
getOffsetTop Float 切り抜く四角形の上端と元のコンテンツの上端の間のオフセット
getOffsetBottom Float 切り抜く四角形の下端が元のコンテンツの下端から内側へのオフセット
getAngle Float 切り抜き枠の中心を中心とした時計回りの回転角度（ラジアン単位）

EmbeddedObjectBorder

メソッド 戻り値 説明
getColor OptionalColor 枠線の色
getWidth Dimension 枠線の幅
getDashStyle DashStyle(enum) 枠線の破線スタイル
getPropertyState PropertyState(enum) ボーダー プロパティのプロパティ状態

PropertyState

定義値 内容
RENDERED デフォルト値
NOT_RENDERED 要素に対応するプロパティがない

LinkedContentReference

メソッド 戻り値 説明
sheetsChartReference SheetsChartReference リンクされたグラフへの参照

SheetsChartReference

メソッド 戻り値 説明
getSpreadsheetId String 元のグラフが含まれているGoogleスプレッドシートID
getChartId Integer 埋め込まれている Googleスプレッドシートの特定のグラフID

SuggestedInlineObjectProperties

メソッド 戻り値 説明
getInlineObjectProperties InlineObjectProperties この提案に加えられた変更のみを含む情報
getInlineObjectPropertiesSuggestionState InlineObjectPropertiesSuggestionState この提案で変更されたベース InlineObjectProperties のフィールドを示すマスク

InlineObjectPropertiesSuggestionState

メソッド 戻り値 説明
getEmbeddedObjectSuggestionState EmbeddedObjectSuggestionState この提案で変更された embeddedObject のフィールドを示すマスク

EmbeddedObjectSuggestionState

メソッド 戻り値 説明
getEmbeddedDrawingPropertiesSuggestionState EmbeddedDrawingPropertiesSuggestionState この提案で変更された embeddedDrawingProperties のフィールドを示すマスク
getImagePropertiesSuggestionState ImagePropertiesSuggestionState この提案で変更された imageProperties のフィールドを示すマスク
getTitleSuggested Boolean title への変更が提案されたか
getDescriptionSuggested Boolean description への変更が提案されたか
getEmbeddedObjectBorderSuggestionState EmbeddedObjectBorderSuggestionState この提案で変更された embeddedObjectBorder のフィールドを示すマスク
getSizeSuggestionState SizeSuggestionState この提案で変更された size のフィールドを示すマスク
getMarginLeftSuggested Boolean marginLeft への変更が提案されたか
getMarginRightSuggested Boolean marginRight への変更が提案されたか
getMarginTopSuggested Boolean marginTop への変更が提案されたか
getMarginBottomSuggested Boolean marginBottom への変更が提案されたか
getLinkedContentReferenceSuggestionState LinkedContentReferenceSuggestionState この提案で変更された linkedContentReference のフィールドを示すマスク

EmbeddedDrawingPropertiesSuggestionState

フィールドはありません。

ImagePropertiesSuggestionState

メソッド 戻り値 説明
getContentUriSuggested Boolean contentUri への変更が提案されたか
getSourceUriSuggested Boolean [sourceUri] [google.apps.docs.v1.EmbeddedObject.source_uri] に変更が提案されたか
getBrightnessSuggested Boolean [brightness] [google.apps.docs.v1.EmbeddedObject.brightness] の変更が提案されたか
getContrastSuggested Boolean [contrast] [google.apps.docs.v1.EmbeddedObject.contrast] に変更が提案されたか
getTransparencySuggested Boolean [transparency] [google.apps.docs.v1.EmbeddedObject.transparency] への変更が提案されたか
getCropPropertiesSuggestionState CropPropertiesSuggestionState この提案で変更された cropProperties のフィールドを示すマスク
getAngleSuggested Boolean [angle] [google.apps.docs.v1.EmbeddedObject.angle] の変更が提案されたか

CropPropertiesSuggestionState

メソッド 戻り値 説明
getOffsetLeftSuggested Boolean offsetLeft への変更が提案されたか
getOffsetRightSuggested Boolean offsetRight への変更が提案されたか
getOffsetTopSuggested Boolean offsetTop への変更が提案されたか
getOffsetBottomSuggested Boolean offsetBottom への変更が提案されたか
getAngleSuggested Boolean angle への変更が提案されたか

EmbeddedObjectBorderSuggestionState

メソッド 戻り値 説明
getColorSuggested Boolean [color] [google.apps.docs.v1.EmbeddedBorderObject.color] への変更が提案されたか
getWidthSuggested Boolean [width] [google.apps.docs.v1.EmbeddedBorderObject.width] に変更が提案されたか
getDashStyleSuggested Boolean [dashStyle] [google.apps.docs.v1.EmbeddedBorderObject.dash_style] に変更が提案されたか
getPropertyStateSuggested Boolean [propertyState] [google.apps.docs.v1.EmbeddedBorderObject.property_state] に対して提案された変更があったか

LinkedContentReferenceSuggestionState

メソッド 戻り値 説明
getSheetsChartReferenceSuggestionState SheetsChartReferenceSuggestionState この提案で変更された sheetsChartReference のフィールドを示すマスク

SheetsChartReferenceSuggestionState

メソッド 戻り値 説明
getSpreadsheetIdSuggested Boolean spreadsheetId への変更が提案されたか
getChartIdSuggested Boolean chartId への変更が提案されたか

PositionedObject

メソッド 戻り値 説明
getObjectId String この配置されたオブジェクトの ID
getPositionedObjectProperties PositionedObjectProperties この配置されたオブジェクトのプロパティ
getSuggestedPositionedObjectPropertiesChanges Map<String,SuggestedPositionedObjectProperties> 配置オブジェクトのプロパティに対して推奨される変更
key：提案ID
getSuggestedInsertionId String 提案された挿入ID
getSuggestedDeletionIds List<String> 提案された削除ID

PositionedObjectProperties

メソッド 戻り値 説明
getPositioning PositionedObjectPositioning この配置されたオブジェクトを参照する Paragraph の改行を基準とする、この配置されたオブジェクトの位置
getEmbeddedObject EmbeddedObject この配置されたオブジェクトの埋め込みオブジェクト

PositionedObjectPositioning

メソッド 戻り値 説明
getLayout PositionedObjectLayout(enum) この配置されたオブジェクトのレイアウト
getLeftOffset Dimension 配置されているオブジェクトの左端の、テザリング先の Paragraph の先頭を基準としたオフセット
getTopOffset Dimension 配置先オブジェクトの上端の、テザリング先の Paragraph の先頭を基準としたオフセット

PositionedObjectLayout

定義値 内容
POSITIONED_OBJECT_LAYOUT_UNSPECIFIED 指定無し
WRAP_TEXT テキストは配置されたオブジェクトの周りを囲む
BREAK_LEFT 配置されたオブジェクトが左側、テキストが右側になるように、テキストを分割
BREAK_RIGHT 配置されたオブジェクトが右側、テキストが左側になるように、テキストを分割
BREAK_LEFT_RIGHT 配置したオブジェクトの左右にテキストがなくなるようにテキストを分割
IN_FRONT_OF_TEXT 配置されたオブジェクトはテキストの前
BEHIND_TEXT 配置されたオブジェクトはテキストの背後

SuggestedPositionedObjectProperties

メソッド 戻り値 説明
getPositionedObjectProperties PositionedObjectProperties この提案に加えられた変更のみを含む情報
getPositionedObjectPropertiesSuggestionState PositionedObjectPropertiesSuggestionState この提案で変更されたベース PositionedObjectProperties のフィールドを示すマスク

PositionedObjectPropertiesSuggestionState

メソッド 戻り値 説明
getPositioningSuggestionState PositionedObjectPositioningSuggestionState この提案で変更された positioning のフィールドを示すマスク
getEmbeddedObjectSuggestionState EmbeddedObjectSuggestionState この提案で変更された embeddedObject のフィールドを示すマスク

PositionedObjectPositioningSuggestionState

メソッド 戻り値 説明
getLayoutSuggested Boolean layout への変更が提案されたか
getLeftOffsetSuggested Boolean leftOffset への変更が提案されたか
getTopOffsetSuggested Boolean topOffset への変更が提案されたか


おしまい。。
0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
0
0