REST Resource: presentations.pages

リソース: ページ

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

JSON 表現
{
  "objectId": string,
  "pageType": enum (PageType),
  "pageElements": [
    {
      object (PageElement)
    }
  ],
  "revisionId": string,
  "pageProperties": {
    object (PageProperties)
  },

  // Union field properties can be only one of the following:
  "slideProperties": {
    object (SlideProperties)
  },
  "layoutProperties": {
    object (LayoutProperties)
  },
  "notesProperties": {
    object (NotesProperties)
  },
  "masterProperties": {
    object (MasterProperties)
  }
  // End of list of possible types for union field properties.
}
フィールド
objectId

string

このページのオブジェクト ID。PagePageElement で使用されるオブジェクト ID は同じ名前空間を共有します。

pageType

enum (PageType)

ページのタイプ。

pageElements[]

object (PageElement)

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

revisionId

string

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

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

pageProperties

object (PageProperties)

ページのプロパティ。

共用体フィールド properties。ページの種類ごとに固有のプロパティ。マスターの場合、追加のプロパティは必要ありません。properties は次のいずれかになります。
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,

  // Union field element_kind can be only one of the following:
  "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)
  }
  // End of list of possible types for union field element_kind.
}
フィールド
objectId

string

このページ要素のオブジェクト ID。google.apps.slides.v1.Pagegoogle.apps.slides.v1.PageElement で使用されるオブジェクト ID は同じ名前空間を共有します。

size

object (Size)

ページ要素のサイズ。

transform

object (AffineTransform)

ページ要素の変換。

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

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

title

string

ページ要素のタイトル。代替テキストは、説明と組み合わせて使用されます。

このフィールドは Group 要素ではサポートされていません。

description

string

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

このフィールドは Group 要素ではサポートされていません。

共用体フィールド element_kind。この PageElement が表す要素の種類。各メッセージには、その種類のページ要素に固有のプロパティが含まれます。element_kind は次のいずれかになります。
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)

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

グループ

PageElements の結合コレクションを表す 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 個の ThemeColorTypes すべてから具体的な色へのマッピングを含むカラーパターンを指定する必要があります。残りの ThemeColorTypes の色は無視されます。

PageBackgroundFill

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

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

  // Union field kind can be only one of the following:
  "solidFill": {
    object (SolidFill)
  },
  "stretchedPictureFill": {
    object (StretchedPictureFill)
  }
  // End of list of possible types for union field kind.
}
フィールド
propertyState

enum (PropertyState)

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

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

共用体フィールド kind。背景の塗りつぶしの種類。kind は次のいずれかになります。
solidFill

object (SolidFill)

単色の塗りつぶし。

stretchedPictureFill

object (StretchedPictureFill)

拡大画像塗りつぶし。

StretchedPictureFill

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

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

string

contentUrl の読み取り:

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

contentUrl を記述します。

画像は挿入時に一度取得され、プレゼンテーション内に表示するためにコピーが保存されます。画像は、サイズが 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)

上記のテーマカラータイプに対応する具体的な色。

Methods

get

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

getThumbnail

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