Method: spreadsheets.get

מחזירה את הגיליון האלקטרוני במזהה הנתון. המתקשר חייב לציין את מזהה הגיליון האלקטרוני.

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

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

  • מגדירים את הפרמטר includeGridData של כתובת ה-URL כ-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.

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

פרמטרים
spreadsheetId

string

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

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

פרמטרים
ranges[]

string

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

boolean

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

גוף הבקשה

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

גוף התשובה

אם הפעולה בוצעה בהצלחה, גוף התגובה מכיל מופע של 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

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