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 的初始轉換一律為身分轉換。

title

string

網頁元素的標題。與說明文字搭配使用,用於顯示替代文字。

Group 元素不支援這個欄位。

description

string

網頁元素的說明。與標題結合,用於顯示替代文字。

Group 元素不支援這個欄位。

聯集欄位 element_kind。這個 PageElement 代表的元素類型。每則訊息都包含該類網頁元素的任何專屬屬性。element_kind 只能是下列其中一項:
elementGroup

object (Group)

一組網頁元素,合併為一個單元。

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 類型代表已彙整的 PageElements 集合。

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

Page 的屬性,僅適用於 pageType 為 SLIDE 的網頁。

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

Page 的屬性,僅適用於具有 pageType NOTES 的網頁。

JSON 表示法
{
  "speakerNotesObjectId": string
}
欄位
speakerNotesObjectId

string

此備註頁面上形狀的物件 ID,其中包含對應投影片單的講者備註。實際的形狀可能不會一律出現在備忘稿頁面上。使用這個物件 ID 插入文字時,系統會自動建立形狀。在這種情況下,實際形狀可能會有不同的物件 ID。presentations.getpages.get 動作一律會傳回最新的物件 ID。

MasterProperties

Page 的屬性,僅適用於頁面類型為 MASTER 的網頁。

JSON 表示法
{
  "displayName": string
}
欄位
displayName

string

主檔案的使用者可讀名稱。

PageProperties

Page 的屬性。

該頁面會繼承父頁面的屬性。階層會根據網頁類型,在 SlidePropertiesLayoutProperties 中定義。

JSON 表示法
{
  "pageBackgroundFill": {
    object (PageBackgroundFill)
  },
  "colorScheme": {
    object (ColorScheme)
  }
}
欄位
pageBackgroundFill

object (PageBackgroundFill)

頁面的背景填滿。如果未設定,背景填充會沿用父項網頁 (如果有的話)。如果頁面沒有父項,背景填充預設為相應的填充,並顯示在投影片編輯器中。

colorScheme

object (ColorScheme)

網頁的色彩配置。如未設定,則會沿用上層頁面的色彩配置。如果網頁沒有父項,色彩配置會採用預設的 Google 簡報色彩配置,與 Google 簡報編輯器中的預設設定一致。

只有前 12 個 ThemeColorType 的具體顏色可供編輯。此外,您只能更新 Master 頁面上的色彩配置。如要更新這個欄位,您必須提供色彩配置,其中包含從前 12 個 ThemeColorType 到其具體顏色的對應項目。系統會忽略其他 ThemeColorType 的顏色。

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:

圖片的網址,預設有效時間為 30 分鐘。這個網址會標記要求者的帳戶。凡是取得網址的使用者,都可以以原始要求者的身分存取相片。如果簡報的共用設定有所變更,圖片存取權可能會遺失。

寫入 contentUrl:

系統會在插入畫面時擷取相片一次,並會儲存副本供簡報使用。相片大小不得超過 50 MB,且不得超過 2,500 萬像素,格式必須為 PNG、JPEG 或 GIF。

提供的網址長度上限為 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)

與上述主題顏色類型相對應的具體顏色。

方法

get

取得簡報中指定頁面的最新版本。

getThumbnail

產生簡報中指定網頁最新版本的縮圖,並傳回縮圖圖片的網址。