Method: spreadsheets.get

הפונקציה מחזירה את גיליון אלקטרוני עם המזהה שצוין. המתקשר צריך לציין את מזהה הגיליון האלקטרוני.

כברירת מחדל, נתונים בטבלאות לא מוחזרים. אפשר לכלול נתונים של רשת באחת משתי דרכים:

  • מציינים field mask עם רשימה של השדות הרצויים באמצעות פרמטר כתובת ה-URL ‏fields ב-HTTP

  • מגדירים את פרמטר כתובת ה-URL‏ includeGridData כ-true. אם מוגדרת מסכת שדות, המערכת מתעלמת מהפרמטר includeGridData

בגיליונות אלקטרוניים גדולים, מומלץ לאחזר רק את השדות הספציפיים שרוצים.

כדי לאחזר רק קבוצות משנה של נתונים מגיליון אלקטרוני, משתמשים בפרמטר ranges של כתובת ה-URL. הטווחים מצוינים באמצעות סימון A1. אפשר להגדיר תא יחיד (לדוגמה, A1) או כמה תאים (לדוגמה, A1:D5). אפשר גם לקבל תאים מגיליונות אחרים באותו גיליון אלקטרוני (לדוגמה, Sheet2!A1:C4) או לאחזר כמה טווחים בבת אחת (לדוגמה, ?ranges=A1:D5&ranges=Sheet2!A1:C4). הגבלת הטווח מחזירה רק את החלקים בגיליון האלקטרוני שחופפים לטווחים המבוקשים.

בקשת HTTP

GET https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
spreadsheetId

string

הגיליון האלקטרוני שרוצים לבקש.

פרמטרים של שאילתה

פרמטרים
ranges[]

string

הטווחים לאחזור מהגיליון האלקטרוני.
includeGridData

boolean

הערך True אם צריך להחזיר נתונים של רשת. אם מוגדרת מסכת שדות בבקשה, המערכת מתעלמת מהפרמטר הזה.
excludeTablesInBandedRanges

boolean

הערך הוא True אם רוצים להחריג טבלאות מהטווחים המקובצים. אם לא מוגדר, הערך הוא False.
commentsViewMode

enum (CommentsViewMode)

מצב התצוגה של התגובות שיוחל על הגיליון האלקטרוני. כך אפשר לראות את הגיליון האלקטרוני בלי התגובות או עם התגובות. אם לא מציינים ערך, המערכת משתמשת בערך COMMENTS_VIEW_MODE_OMITTED.

גוף הבקשה

גוף הבקשה צריך להיות ריק.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל מופע של Spreadsheet.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets
  • https://www.googleapis.com/auth/spreadsheets.readonly

מידע נוסף זמין במדריך ההרשאות.