REST Resource: presentations.pages

リソース: ページ

プレゼンテーション内のページ。

JSON 表現
{
  "objectId": string,
  "pageType": enum (PageType),
  "pageElements": [
    {
      object (PageElement)
    }
  ],
  "revisionId": string,
  "pageProperties": {
    object (PageProperties)
  },
  "commentAnchors": [
    {
      object (CommentAnchor)
    }
  ],
  "comments": [
    {
      object (CommentThread)
    }
  ],
  "commentsViewMode": enum (CommentsViewMode),

  "slideProperties": {
    object (SlideProperties)
  },
  "layoutProperties": {
    object (LayoutProperties)
  },
  "notesProperties": {
    object (NotesProperties)
  },
  "masterProperties": {
    object (MasterProperties)
  }
}
フィールド
objectId

string

このページのオブジェクト ID。Page と PageElement で使用されるオブジェクト ID は、同じ Namespace を共有します。

pageType

enum (PageType)

ページの種類。

pageElements[]

object (PageElement)

ページにレンダリングされたページ要素。

revisionId

string

出力専用。プレゼンテーションのリビジョン ID。更新リクエストで使用して、前回の読み取りオペレーション以降にプレゼンテーションのリビジョンが変更されていないことをアサートできます。ユーザーがプレゼンテーションの編集権限を持っている場合にのみ入力されます。

リビジョン ID は連番ではなく、不透明な文字列です。リビジョン ID の形式は今後変更される可能性があります。返されたリビジョン ID は、返されてから 24 時間のみ有効であることが保証されており、ユーザー間で共有することはできません。呼び出し間でリビジョン ID が変更されていない場合、プレゼンテーションは変更されていません。逆に、ID が変更された場合(同じプレゼンテーションとユーザーの場合)、通常はプレゼンテーションが更新されたことを意味します。ただし、ID の変更は、ID 形式の変更などの内部要因による場合もあります。

pageProperties

object (PageProperties)

ページのプロパティ。

commentAnchors[]

object (CommentAnchor)

出力専用。ページに存在するコメント アンカー。

comments[]

object (CommentThread)

出力専用。ページに関連付けられているコメント スレッド。commentsViewMode が入力された GetPageRequest を介してページが取得された場合にのみ入力されます。それ以外の場合、コメントは GetPresentationRequest を介して Presentation で返されます。

commentsViewMode

enum (CommentsViewMode)

出力専用。ページに適用されているコメント ビューモード。commentsViewMode が入力された GetPageRequest を介してページが取得された場合にのみ入力されます。

ページタイプごとに固有のプロパティ。マスターには追加のプロパティは必要ありません。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
slideProperties

object (SlideProperties)

スライド固有のプロパティ。pageType = SLIDE の場合にのみ設定されます。

layoutProperties

object (LayoutProperties)

レイアウト固有のプロパティ。pageType = LAYOUT の場合にのみ設定します。

notesProperties

object (NotesProperties)

メモ固有のプロパティ。pageType = NOTES の場合にのみ設定します。

masterProperties

object (MasterProperties)

特定のプロパティをマスターします。pageType = MASTER の場合にのみ設定します。

相互に排他的なフィールドの終わり。

PageType

ページの種類。

列挙型
SLIDE スライドのページ。
MASTER マスター スライドのページ。
LAYOUT レイアウト ページ。
NOTES メモページ。
NOTES_MASTER ノート マスター ページ。

PageElement

ページにレンダリングされる視覚要素。

JSON 表現
{
  "objectId": string,
  "size": {
    object (Size)
  },
  "transform": {
    object (AffineTransform)
  },
  "title": string,
  "description": string,

  "elementGroup": {
    object (Group)
  },
  "shape": {
    object (Shape)
  },
  "image": {
    object (Image)
  },
  "video": {
    object (Video)
  },
  "line": {
    object (Line)
  },
  "table": {
    object (Table)
  },
  "wordArt": {
    object (WordArt)
  },
  "sheetsChart": {
    object (SheetsChart)
  },
  "speakerSpotlight": {
    object (SpeakerSpotlight)
  }
}
フィールド
objectId

string

このページ要素のオブジェクト ID。google.apps.slides.v1.Page と google.apps.slides.v1.PageElement で使用されるオブジェクト ID は、同じ Namespace を共有します。

size

object (Size)

ページ要素のサイズ。

transform

object (AffineTransform)

ページ要素の変換。

ページ要素の視覚的な外観は、絶対変換によって決まります。絶対変換を計算するには、ページ要素の変換を、その親グループのすべての変換と事前に連結します。ページ要素がグループに属していない場合、その絶対変換はこのフィールドの値と同じになります。

新しく作成された Group の初期変換は常に恒等変換です。

title

string

ページ要素のタイトル。説明と組み合わせて代替テキストを表示します。

このフィールドは Group 要素では対象外です。

description

string

ページ要素の説明。タイトルと組み合わせて代替テキストを表示します。

このフィールドは Group 要素では対象外です。

この PageElement が表す要素の種類。各メッセージには、その種類のページ要素に固有のプロパティが含まれています。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
elementGroup

object (Group)

1 つのユニットとして結合されたページ要素のコレクション。

shape

object (Shape)

一般的なシェイプ。

image

object (Image)

画像ページ要素。

video

object (Video)

動画ページ要素。

line

object (Line)

行のページ要素。

table

object (Table)

テーブル ページ要素。

wordArt

object (WordArt)

ワードアートのページ要素。

sheetsChart

object (SheetsChart)

Google スプレッドシートから埋め込まれたリンクされたグラフ。リンクが解除されたグラフは画像として表示されます。

speakerSpotlight

object (SpeakerSpotlight)

スピーカー スポットライト。

相互に排他的なフィールドの終わり。

グループ

PageElement の結合されたコレクションを表す PageElement 種類。

JSON 表現
{
  "children": [
    {
      object (PageElement)
    }
  ]
}
フィールド
children[]

object (PageElement)

グループ内の要素のコレクション。グループの最小サイズは 2 です。

WordArt

ワードアートを表す PageElement 種類。

JSON 表現
{
  "renderedText": string
}
フィールド
renderedText

string

ワードアートとしてレンダリングされたテキスト。

SpeakerSpotlight

スピーカー スポットライトを表す PageElement 種類。

JSON 表現
{
  "speakerSpotlightProperties": {
    object (SpeakerSpotlightProperties)
  }
}
フィールド
speakerSpotlightProperties

object (SpeakerSpotlightProperties)

スピーカー スポットライトのプロパティ。

SpeakerSpotlightProperties

SpeakerSpotlight のプロパティ。

JSON 表現
{
  "outline": {
    object (Outline)
  },
  "shadow": {
    object (Shadow)
  }
}
フィールド
outline

object (Outline)

スピーカー スポットライトの概要。設定しない場合、アウトラインは表示されません。

shadow

object (Shadow)

スピーカー スポットライトの影。設定されていない場合、シャドウはありません。

SlideProperties

pageType が SLIDE のページにのみ関連する Page のプロパティ。

JSON 表現
{
  "layoutObjectId": string,
  "masterObjectId": string,
  "notesPage": {
    object (Page)
  },
  "isSkipped": boolean
}
フィールド
layoutObjectId

string

このスライドの基になるレイアウトのオブジェクト ID。このプロパティは読み取り専用です。

masterObjectId

string

このスライドの基となるマスターのオブジェクト ID。このプロパティは読み取り専用です。

notesPage

object (Page)

このスライドに関連付けられているノートページ。これは、スピーカー ノートを含むスライドを印刷またはエクスポートする際のノートページの外観を定義します。メモページは notes master からプロパティを継承します。ノートページの BODY タイプのプレースホルダ図形には、このスライドのスピーカー ノートが含まれています。このシェイプの ID は speakerNotesObjectId フィールドで識別されます。ノート ページは、スピーカー ノートの図形のテキスト コンテンツとスタイルを除き、読み取り専用です。このプロパティは読み取り専用です。

isSkipped

boolean

プレゼンテーション モードでスライドがスキップされるかどうか。デフォルトは false です。

LayoutProperties

Page のプロパティは、pageType が LAYOUT のページにのみ関連します。

JSON 表現
{
  "masterObjectId": string,
  "name": string,
  "displayName": string
}
フィールド
masterObjectId

string

このレイアウトの基となるマスターのオブジェクト ID。

name

string

レイアウトの名前。

displayName

string

レイアウトの人が読める形式の名前。

NotesProperties

pageType が NOTES のページにのみ関連する Page のプロパティ。

JSON 表現
{
  "speakerNotesObjectId": string
}
フィールド
speakerNotesObjectId

string

対応するスライドのスピーカー ノートを含む、このノートページの図形のオブジェクト ID。実際の図形がノートページに常に存在するとは限りません。このオブジェクト ID を使用してテキストを挿入すると、図形が自動的に作成されます。この場合、実際のシェイプのオブジェクト ID が異なる可能性があります。presentations.get または pages.get アクションは常に最新のオブジェクト ID を返します。

MasterProperties

pageType が MASTER のページにのみ関連する Page のプロパティ。

JSON 表現
{
  "displayName": string
}
フィールド
displayName

string

人が読める形式のマスター名。

PageProperties

Page のプロパティ。

ページは親ページからプロパティを継承します。ページタイプに応じて、階層は SlideProperties または LayoutProperties のいずれかで定義されます。

JSON 表現
{
  "pageBackgroundFill": {
    object (PageBackgroundFill)
  },
  "colorScheme": {
    object (ColorScheme)
  }
}
フィールド
pageBackgroundFill

object (PageBackgroundFill)

ページの背景の塗りつぶし。設定されていない場合、背景の塗りつぶしは、親ページが存在すれば親ページから継承されます。ページに親がない場合、背景の塗りつぶしはデフォルトでスライド エディタの対応する塗りつぶしになります。

colorScheme

object (ColorScheme)

ページのカラーパターン。設定されていない場合、カラーパターンは親ページから継承されます。ページに親がない場合、カラーパターンはデフォルトのスライドのカラーパターンを使用し、スライド エディタのデフォルトと一致します。

最初の 12 個の ThemeColorType の具体的な色のみ編集できます。また、Master ページのカラーパターンのみ更新できます。フィールドを更新するには、最初の 12 個の ThemeColorType から具体的な色へのマッピングを含むカラーパターンを指定する必要があります。残りの ThemeColorTypes の色は無視されます。

PageBackgroundFill

ページの背景の塗りつぶし。

JSON 表現
{
  "propertyState": enum (PropertyState),

  "solidFill": {
    object (SolidFill)
  },
  "stretchedPictureFill": {
    object (StretchedPictureFill)
  }
}
フィールド
propertyState

enum (PropertyState)

背景塗りつぶしプロパティの状態。

ページで塗りつぶしを更新すると、同じリクエストで別の値が指定されていない限り、このフィールドは暗黙的に RENDERED に更新されます。ページに塗りつぶしがないようにするには、このフィールドを NOT_RENDERED に設定します。この場合、同じリクエストで設定された他の塗りつぶしフィールドは無視されます。

背景の塗りつぶしの種類。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
solidFill

object (SolidFill)

単色の塗りつぶし。

stretchedPictureFill

object (StretchedPictureFill)

画像の塗りつぶしを拡大縮小します。

相互に排他的なフィールドの終わり。

StretchedPictureFill

引き伸ばされた画像の塗りつぶし。ページまたはページ要素が指定した画像で完全に塗りつぶされます。画像がコンテナに合わせて拡大されます。

JSON 表現
{
  "contentUrl": string,
  "size": {
    object (Size)
  }
}
フィールド
contentUrl

string

contentUrl を読み取ります。

デフォルトの有効期間が 30 分の写真の URL。この URL には、リクエストしたアカウントのタグが付けられています。URL を知っているユーザーは、元のリクエスト者として画像にアクセスできます。プレゼンテーションの共有設定が変更されると、画像へのアクセス権が失われることがあります。

contentUrl の記述:

画像は挿入時に 1 回取得され、プレゼンテーション内で表示するためにコピーが保存されます。画像のサイズは 50 MB 未満、25 メガピクセル以下で、PNG、JPEG、GIF のいずれかの形式である必要があります。

指定できる URL の長さは最大 2 kB です。

size

object (Size)

画像塗りつぶしの元のサイズ。このフィールドは読み取り専用です。

ColorScheme

ページの事前定義された色のパレット。

JSON 表現
{
  "colors": [
    {
      object (ThemeColorPair)
    }
  ]
}
フィールド
colors[]

object (ThemeColorPair)

ThemeColorType と対応する具体的な色のペア。

ThemeColorPair

テーマのカラータイプと、それが表す具体的な色をマッピングするペア。

JSON 表現
{
  "type": enum (ThemeColorType),
  "color": {
    object (RgbColor)
  }
}
フィールド
type

enum (ThemeColorType)

テーマカラーのタイプ。

color

object (RgbColor)

上記のテーマカラータイプに対応するコンクリートの色。

CommentAnchor

同じ anchorId を介して CommentThread にアンカーされている Page 内のすべてのロケーションのリストが含まれます。複数の別々のアンカーが、Page 内または異なるページ間で同じ場所を参照する場合があります。

JSON 表現
{
  "anchorId": string,
  "objectAnchors": [
    {
      object (ObjectAnchor)
    }
  ]
}
フィールド
anchorId

string

出力専用。コメント アンカーの一意の ID。

objectAnchors[]

object (ObjectAnchor)

出力専用。アンカー ID を参照するページ内のすべてのオブジェクト ID ベースの場所。

ObjectAnchor

スライド オブジェクト(Page や PageElement など)に関連付けられたコメント アンカー データを表します。

JSON 表現
{
  "objectId": string,

  "shapeTextAnchors": {
    object (ShapeTextAnchors)
  },
  "tableCellAnchors": {
    object (TableCellAnchors)
  }
}
フィールド
objectId

string

出力専用。コメント スレッドがアンカーされているページまたはページ要素。

出力専用。コメント スレッドがアンカーされているページ要素内のテキスト範囲。コメント アンカーが要素内のテキスト範囲ではなく、ページ全体またはページ要素を対象としている場合は空になります。以下は、相互に排他的なフィールドのリストです。レスポンスに設定されるフィールドは、最大 1 つです。
shapeTextAnchors

object (ShapeTextAnchors)

図形の [text][google.apps.slides.v1.Shape.TextContent] のテキスト範囲にコメントがアンカーされている Shapes に入力されます。

tableCellAnchors

object (TableCellAnchors)

テーブルの 1 つ以上のセルのテキスト範囲にコメントがアンカーされている Tables に入力されます。

相互に排他的なフィールドの終わり。

ShapeTextAnchors

コメント アンカーで覆われたシェイプ内のテキスト範囲を表します。

JSON 表現
{
  "ranges": [
    {
      object (TextRange)
    }
  ]
}
フィールド
ranges[]

object (TextRange)

コメント アンカーでカバーされるテキスト範囲のリスト。

TextRange

図形または表のセルの text 内の連続したテキスト範囲を指定します。

JSON 表現
{
  "startIndex": integer,
  "endIndex": integer
}
フィールド
startIndex

integer

ゼロから始まる範囲の開始インデックス。このフィールドは、範囲が限定されない将来のユースケースに対応するために Int32Value です。

endIndex

integer

範囲の末尾のゼロベースのインデックス。このフィールドは、範囲が限定されない将来のユースケースに対応するために Int32Value です。

TableCellAnchors

コメント アンカーでカバーされているテーブル内のテーブル セル範囲を表します。

JSON 表現
{
  "cellRanges": [
    {
      object (TableCellTextRanges)
    }
  ]
}
フィールド
cellRanges[]

object (TableCellTextRanges)

表内のアンカーでテキストが覆われている表内のすべてのセルの一覧。

TableCellTextRanges

コメント アンカーでカバーされているテーブル セル内のテキスト範囲を表します。

JSON 表現
{
  "cellLocation": {
    object (TableCellLocation)
  },
  "ranges": [
    {
      object (TextRange)
    }
  ]
}
フィールド
cellLocation

object (TableCellLocation)

表のセルの位置。

ranges[]

object (TextRange)

このセル内のアンカーでカバーされるすべてのテキスト範囲のリスト。

メソッド

get

プレゼンテーション内の指定されたページの最新バージョンを取得します。

getThumbnail

プレゼンテーション内の指定されたページの最新バージョンのサムネイルを生成し、サムネイル画像の URL を返します。