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),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "slideProperties": {
    object (SlideProperties)
  },
  "layoutProperties": {
    object (LayoutProperties)
  },
  "notesProperties": {
    object (NotesProperties)
  },
  "masterProperties": {
    object (MasterProperties)
  }
  // End of mutually exclusive fields.
}
فیلدها
objectId

string

شناسه شیء برای این صفحه. شناسه‌های شیء مورد استفاده توسط Page و PageElement فضای نام یکسانی را به اشتراک می‌گذارند.

pageType

enum ( PageType )

نوع صفحه.

pageElements[]

object ( PageElement )

عناصر صفحه که در صفحه رندر می‌شوند.

revisionId

string

فقط خروجی. شناسه‌ی ویرایش ارائه. می‌تواند در درخواست‌های به‌روزرسانی برای اثبات اینکه ویرایش ارائه از آخرین عملیات خواندن تغییر نکرده است، استفاده شود. فقط در صورتی پر می‌شود که کاربر دسترسی ویرایش به ارائه را داشته باشد.

شناسه‌ی بازبینی یک عدد ترتیبی نیست، بلکه یک رشته‌ی مبهم است. قالب شناسه‌ی بازبینی ممکن است با گذشت زمان تغییر کند. یک شناسه‌ی بازبینیِ برگردانده شده فقط تا ۲۴ ساعت پس از برگردانده شدن معتبر است و نمی‌توان آن را بین کاربران به اشتراک گذاشت. اگر شناسه‌ی بازبینی بین فراخوانی‌ها بدون تغییر باشد، ارائه تغییر نکرده است. برعکس، یک شناسه‌ی تغییر یافته (برای همان ارائه و کاربر) معمولاً به این معنی است که ارائه به‌روزرسانی شده است. با این حال، یک شناسه‌ی تغییر یافته همچنین می‌تواند به دلیل عوامل داخلی مانند تغییرات قالب شناسه باشد.

pageProperties

object ( PageProperties )

خواص صفحه.

commentAnchors[]

object ( CommentAnchor )

فقط خروجی. لنگرهای نظر موجود در صفحه.

comments[]

object ( CommentThread )

فقط خروجی. رشته‌های نظرات مرتبط با صفحه. فقط در صورتی که صفحه از طریق GetPageRequest با commentsViewMode پر شده باشد، پر می‌شوند. در غیر این صورت، نظرات از طریق GetPresentationRequest در Presentation برگردانده می‌شوند.

commentsViewMode

enum ( CommentsViewMode )

فقط خروجی. حالت نمایش نظرات به صفحه اعمال می‌شود. فقط در صورتی که صفحه از طریق GetPageRequest با commentsViewMode دریافت شده باشد، نمایش داده می‌شود.

ویژگی‌هایی که مختص هر نوع صفحه هستند. Masterها به هیچ ویژگی اضافی نیاز ندارند. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم می‌شود:
slideProperties

object ( SlideProperties )

ویژگی‌های خاص اسلاید. فقط در صورتی تنظیم می‌شود که pageType = SLIDE باشد.

layoutProperties

object ( LayoutProperties )

ویژگی‌های خاص طرح‌بندی. فقط در صورتی تنظیم می‌شود که pageType = LAYOUT باشد.

notesProperties

object ( NotesProperties )

ویژگی‌های خاص یادداشت‌ها. فقط در صورتی تنظیم می‌شود که pageType = NOTES باشد.

masterProperties

object ( MasterProperties )

ویژگی‌های خاص مستر. فقط در صورتی تنظیم می‌شود که pageType = MASTER باشد.

پایان میدان‌های ناسازگار.

نوع صفحه

نوع صفحه.

انوم‌ها
SLIDE یک صفحه اسلاید.
MASTER یک صفحه اسلاید اصلی.
LAYOUT یک صفحه طرح بندی.
NOTES یک صفحه یادداشت.
NOTES_MASTER یک صفحه اصلی یادداشت‌ها.

عنصر صفحه

یک عنصر بصری که در یک صفحه نمایش داده می‌شود.

نمایش JSON 
{
  "objectId": string,
  "size": {
    object (Size)
  },
  "transform": {
    object (AffineTransform)
  },
  "title": string,
  "description": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "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 mutually exclusive fields.
}
فیلدها
objectId

string

شناسه شیء برای این عنصر صفحه. شناسه‌های شیء استفاده شده توسط google.apps.slides.v1.Page و google.apps.slides.v1.PageElement فضای نام یکسانی را به اشتراک می‌گذارند.

size

object ( Size )

اندازه عنصر صفحه.

transform

object ( AffineTransform )

تبدیل عنصر صفحه.

ظاهر بصری عنصر صفحه توسط تبدیل مطلق آن تعیین می‌شود. برای محاسبه تبدیل مطلق، تبدیل یک عنصر صفحه را با تبدیل‌های همه گروه‌های والد آن از قبل الحاق کنید. اگر عنصر صفحه در یک گروه نباشد، تبدیل مطلق آن همان مقدار موجود در این فیلد است.

تبدیل اولیه برای Group تازه ایجاد شده همیشه تبدیل هویت است.

title

string

عنوان عنصر صفحه. همراه با توضیحات برای نمایش متن جایگزین.

این فیلد برای عناصر Group پشتیبانی نمی‌شود.

description

string

توضیحات عنصر صفحه. همراه با عنوان برای نمایش متن جایگزین.

این فیلد برای عناصر Group پشتیبانی نمی‌شود.

نوع عنصری که این PageElement نشان می‌دهد. هر پیام شامل هر ویژگی است که مختص آن نوع عنصر صفحه است. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در یک پاسخ تنظیم می‌شود:
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 Sheets جاسازی شده است. نمودارهای بدون پیوند به صورت تصویر نمایش داده می‌شوند.

speakerSpotlight

object ( SpeakerSpotlight )

نورافکن بلندگو.

پایان میدان‌های ناسازگار.

گروه

یک نوع PageElement که نشان‌دهنده‌ی مجموعه‌ای به هم پیوسته از PageElementها است.

نمایش JSON 
{
  "children": [
    {
      object (PageElement)
    }
  ]
}
فیلدها
children[]

object ( PageElement )

مجموعه‌ای از عناصر در گروه. حداقل اندازه یک گروه ۲ است.

وردآرت

نوعی از PageElement که نمایانگر هنر نوشتاری است.

نمایش JSON 
{
  "renderedText": string
}
فیلدها
renderedText

string

متن به صورت هنر کلمه ارائه شده است.

بلندگو

یک نوع PageElement که نشان‌دهنده‌ی Speaker Spotlight است.

نمایش JSON 
{
  "speakerSpotlightProperties": {
    object (SpeakerSpotlightProperties)
  }
}
فیلدها
speakerSpotlightProperties

object ( SpeakerSpotlightProperties )

ویژگی‌های چراغ قوه بلندگو.

ویژگی‌های بلندگو

ویژگی‌های SpeakerSpotlight .

نمایش JSON 
{
  "outline": {
    object (Outline)
  },
  "shadow": {
    object (Shadow)
  }
}
فیلدها
outline

object ( Outline )

طرح کلی نورافکن بلندگو. اگر تنظیم نشده باشد، هیچ طرحی ندارد.

shadow

object ( Shadow )

سایه‌ی چراغ قوه‌ی بلندگو. اگر تنظیم نشده باشد، سایه‌ای نخواهد داشت.

ویژگی‌های اسلاید

ویژگی‌هایی از Page که فقط برای صفحاتی با pageType SLIDE مرتبط هستند.

نمایش JSON 
{
  "layoutObjectId": string,
  "masterObjectId": string,
  "notesPage": {
    object (Page)
  },
  "isSkipped": boolean
}
فیلدها
layoutObjectId

string

شناسه‌ی شیء طرح‌بندی که این اسلاید بر اساس آن ساخته شده است. این ویژگی فقط خواندنی است.

masterObjectId

string

شناسه شیء اصلی که این اسلاید بر اساس آن ساخته شده است. این ویژگی فقط خواندنی است.

notesPage

object ( Page )

صفحه یادداشت‌هایی که این اسلاید به آن مرتبط است. این صفحه، ظاهر بصری صفحه یادداشت‌ها را هنگام چاپ یا خروجی گرفتن از اسلایدها با یادداشت‌های گوینده تعریف می‌کند. یک صفحه یادداشت، ویژگی‌هایی را از notes master به ارث می‌برد. شکل نگهدارنده با نوع BODY در صفحه یادداشت‌ها، حاوی یادداشت‌های گوینده برای این اسلاید است. شناسه این شکل توسط فیلد speakerNotesObjectId شناسایی می‌شود. صفحه یادداشت‌ها فقط خواندنی است، به جز محتوای متن و سبک‌های شکل یادداشت‌های گوینده. این ویژگی فقط خواندنی است.

isSkipped

boolean

اینکه آیا اسلاید در حالت ارائه رد شود یا خیر. مقدار پیش‌فرض false است.

ویژگی‌های طرح‌بندی

ویژگی‌های Page فقط برای صفحاتی با طرح‌بندی pageType مرتبط هستند.

نمایش JSON 
{
  "masterObjectId": string,
  "name": string,
  "displayName": string
}
فیلدها
masterObjectId

string

شناسه شیءِ master که این طرح‌بندی بر اساس آن ساخته شده است.

name

string

نام طرح بندی.

displayName

string

نام قابل خواندن توسط انسان برای طرح‌بندی.

یادداشت‌هاویژگی‌ها

ویژگی‌های Page که فقط برای صفحاتی با نوع صفحه مرتبط هستند.

نمایش JSON 
{
  "speakerNotesObjectId": string
}
فیلدها
speakerNotesObjectId

string

شناسه شیء شکل در این صفحه یادداشت‌ها که شامل یادداشت‌های گوینده برای اسلاید مربوطه است. شکل واقعی ممکن است همیشه در صفحه یادداشت‌ها وجود نداشته باشد. درج متن با استفاده از این شناسه شیء به طور خودکار شکل را ایجاد می‌کند. در این حالت، شکل واقعی ممکن است شناسه شیء متفاوتی داشته باشد. عمل presentations.get یا pages.get همیشه آخرین شناسه شیء را برمی‌گرداند.

املاک اصلی

ویژگی‌هایی از Page که فقط برای صفحاتی با pageType MASTER مرتبط هستند.

نمایش JSON 
{
  "displayName": string
}
فیلدها
displayName

string

نام قابل خواندن توسط انسانِ استاد.

ویژگی‌های صفحه

ویژگی‌های Page .

این صفحه ویژگی‌هایی را از صفحه والد به ارث می‌برد. بسته به نوع صفحه، سلسله مراتب در SlideProperties یا LayoutProperties تعریف می‌شود.

نمایش JSON 
{
  "pageBackgroundFill": {
    object (PageBackgroundFill)
  },
  "colorScheme": {
    object (ColorScheme)
  }
}
فیلدها
pageBackgroundFill

object ( PageBackgroundFill )

رنگ پس‌زمینه صفحه. اگر تنظیم نشده باشد، رنگ پس‌زمینه از صفحه والد (در صورت وجود) به ارث می‌رسد. اگر صفحه والد نداشته باشد، رنگ پس‌زمینه به طور پیش‌فرض با رنگ متناظر در ویرایشگر اسلایدها مطابقت دارد.

colorScheme

object ( ColorScheme )

طرح رنگ صفحه. اگر تنظیم نشده باشد، طرح رنگ از صفحه والد به ارث می‌رسد. اگر صفحه والد نداشته باشد، طرح رنگ از طرح رنگ پیش‌فرض اسلایدها استفاده می‌کند که با پیش‌فرض‌های ویرایشگر اسلایدها مطابقت دارد.

فقط رنگ‌های اصلی ۱۲ ThemeColorType اول قابل ویرایش هستند. علاوه بر این، فقط طرح رنگ صفحات Master قابل به‌روزرسانی است. برای به‌روزرسانی فیلد، باید یک طرح رنگ حاوی نگاشت‌هایی از تمام ۱۲ ThemeColorType اول به رنگ‌های اصلی آنها ارائه شود. رنگ‌های ThemeColorTypeهای باقی‌مانده نادیده گرفته می‌شوند.

پر کردن پس‌زمینه صفحه

پر کردن پس‌زمینه صفحه.

نمایش JSON 
{
  "propertyState": enum (PropertyState),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "solidFill": {
    object (SolidFill)
  },
  "stretchedPictureFill": {
    object (StretchedPictureFill)
  }
  // End of mutually exclusive fields.
}
فیلدها
propertyState

enum ( PropertyState )

حالت ویژگی پر کردن پس‌زمینه.

به‌روزرسانی مقدار پرکننده در یک صفحه، به طور ضمنی این فیلد را به RENDERED به‌روزرسانی می‌کند، مگر اینکه مقدار دیگری در همان درخواست مشخص شده باشد. برای اینکه صفحه‌ای بدون مقدار پرکننده باشد، این فیلد را روی NOT_RENDERED تنظیم کنید. در این حالت، هر فیلد پرکننده دیگری که در همان درخواست تنظیم شود، نادیده گرفته خواهد شد.

نوع پر کردن پس‌زمینه. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در پاسخ تنظیم خواهد شد:
solidFill

object ( SolidFill )

پر کردن با رنگ ثابت.

stretchedPictureFill

object ( StretchedPictureFill )

تصویر کشیده شده.

پایان میدان‌های ناسازگار.

تصویر کشیده شده

تصویر کشیده شده. صفحه یا عنصر صفحه به طور کامل با تصویر مشخص شده پر می‌شود. تصویر کشیده می‌شود تا در ظرف خود جای گیرد.

نمایش JSON 
{
  "contentUrl": string,
  "size": {
    object (Size)
  }
}
فیلدها
contentUrl

string

خواندن contentUrl:

یک URL به یک تصویر با طول عمر پیش‌فرض ۳۰ دقیقه. این URL با حساب درخواست‌کننده برچسب‌گذاری شده است. هر کسی که URL را داشته باشد، عملاً به عنوان درخواست‌کننده اصلی به تصویر دسترسی پیدا می‌کند. در صورت تغییر تنظیمات اشتراک‌گذاری ارائه، ممکن است دسترسی به تصویر از بین برود.

نوشتن contentUrl:

تصویر یک بار در زمان درج دریافت می‌شود و یک کپی برای نمایش در داخل ارائه ذخیره می‌شود. حجم تصاویر باید کمتر از ۵۰ مگابایت باشد، نمی‌تواند از ۲۵ مگاپیکسل بیشتر باشد و باید در یکی از قالب‌های PNG، JPEG یا GIF باشد.

طول URL ارائه شده می‌تواند حداکثر ۲ کیلوبایت باشد.

size

object ( Size )

اندازه اصلی تصویر. این فیلد فقط خواندنی است.

طرح رنگ

پالت رنگ‌های از پیش تعریف‌شده برای یک صفحه.

نمایش JSON 
{
  "colors": [
    {
      object (ThemeColorPair)
    }
  ]
}
فیلدها
colors[]

object ( ThemeColorPair )

ThemeColorType و جفت‌های رنگ عینی مربوطه.

جفت رنگ تم

جفتی که یک نوع رنگ تم را به رنگ مشخصی که نشان می‌دهد، نگاشت می‌کند.

نمایش JSON 
{
  "type": enum (ThemeColorType),
  "color": {
    object (RgbColor)
  }
}
فیلدها
type

enum ( ThemeColorType )

نوع رنگ تم.

color

object ( RgbColor )

رنگ مشخص مربوط به نوع رنگ تم بالا.

لنگر کامنت

شامل لیستی از تمام مکان‌های موجود در یک Page است که از طریق anchorId یکسان به یک CommentThread متصل شده‌اند. چندین anchor جداگانه ممکن است به یک مکان، چه در داخل یک Page و چه در صفحات مختلف، اشاره کنند.

نمایش JSON 
{
  "anchorId": string,
  "objectAnchors": [
    {
      object (ObjectAnchor)
    }
  ]
}
فیلدها
anchorId

string

فقط خروجی. شناسه منحصر به فرد لنگر نظر.

objectAnchors[]

object ( ObjectAnchor )

فقط خروجی. تمام مکان‌های مبتنی بر شناسه شیء در یک صفحه که به شناسه لنگر اشاره دارند.

شیء لنگر

نشان‌دهنده‌ی داده‌های لنگر کامنت است که به یک شیء اسلاید، مثلاً یک Page یا PageElement گره خورده‌اند.

نمایش JSON 
{
  "objectId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "shapeTextAnchors": {
    object (ShapeTextAnchors)
  },
  "tableCellAnchors": {
    object (TableCellAnchors)
  }
  // End of mutually exclusive fields.
}
فیلدها
objectId

string

فقط خروجی. صفحه یا عنصر صفحه‌ای که رشته نظر به آن متصل شده است.

فقط خروجی. محدوده متن درون عنصر صفحه‌ای که رشته نظر به آن متصل شده است. اگر لنگر نظر برای کل صفحه یا عنصر صفحه باشد، نه یک محدوده متن درون عنصر، خالی خواهد بود. در زیر لیستی از فیلدهای ناسازگار آمده است. حداکثر یکی از فیلدها در یک پاسخ تنظیم می‌شود:
shapeTextAnchors

object ( ShapeTextAnchors )

برای Shapes که نظراتشان به محدوده‌ای از متن در [text][google.apps.slides.v1.Shape.TextContent] شکل متصل شده است، پر می‌شود.

tableCellAnchors

object ( TableCellAnchors )

برای Tables که نظراتشان به محدوده‌ای از متن در یک یا چند سلول جدول متصل است، پر می‌شود.

پایان میدان‌های ناسازگار.

لنگرهای ShapeText

محدوده‌های متنی درون شکلی که توسط یک لنگر نظر (comment anchor) پوشش داده شده است را نشان می‌دهد.

نمایش JSON 
{
  "ranges": [
    {
      object (TextRange)
    }
  ]
}
فیلدها
ranges[]

object ( TextRange )

فهرستی از محدوده‌های متنی که توسط لنگر نظر پوشش داده می‌شوند.

محدوده متن

محدوده‌ای پیوسته از متن را در text یک شکل یا سلول جدول مشخص می‌کند.

نمایش JSON 
{
  "startIndex": integer,
  "endIndex": integer
}
فیلدها
startIndex

integer

اندیس مبتنی بر صفرِ محدوده‌ی آغازین. این فیلد یک Int32Value است تا بتوان در موارد استفاده‌ی آینده با محدوده‌های باز-انتها از آن استفاده کرد.

endIndex

integer

اندیس مبتنی بر صفر انتهای بازه. این فیلد یک Int32Value است تا بتوان در موارد استفاده بعدی با بازه‌های باز نیز از آن استفاده کرد.

لنگرهای سلول جدولی

محدوده‌های سلول‌های جدول را در یک جدول که توسط یک لنگر نظر پوشش داده شده است، نشان می‌دهد.

نمایش JSON 
{
  "cellRanges": [
    {
      object (TableCellTextRanges)
    }
  ]
}
فیلدها
cellRanges[]

object ( TableCellTextRanges )

فهرستی از تمام سلول‌های جدول در یک جدول که متن آنها توسط لنگر در جدول پوشانده شده است.

محدوده‌های متن و سلول جدول

محدوده‌های متنی درون یک سلول جدول که توسط یک لنگر نظر پوشش داده شده‌اند را نشان می‌دهد.

نمایش JSON 
{
  "cellLocation": {
    object (TableCellLocation)
  },
  "ranges": [
    {
      object (TextRange)
    }
  ]
}
فیلدها
cellLocation

object ( TableCellLocation )

محل سلول جدول.

ranges[]

object ( TextRange )

فهرستی از تمام محدوده‌های متنی که توسط لنگر در این سلول پوشش داده می‌شوند.

روش‌ها

get

 آخرین نسخه از صفحه مشخص شده در ارائه را دریافت می‌کند.

getThumbnail

 یک تصویر کوچک از آخرین نسخه صفحه مشخص شده در ارائه ایجاد می‌کند و یک URL به تصویر کوچک برمی‌گرداند.