במדריך הזה מוצגות השיטות העיקריות לבקשות ולתגובה, שמהן מורכבות Google Docs API ואיך אפשר לעדכן מסמכים בקבוצות.
אפשר להפעיל את Google Docs API באמצעות בקשת HTTP או באמצעות method בספריית לקוח ספציפית לשפה. מילות המפתח האלה מקבילות באופן כללי.
Google Docs API מחזיר תגובת HTTP, שכוללת בדרך כלל את התוצאה של הפעלת הבקשה. כשמשתמשים בספריית לקוח כדי לשלוח בקשות, תשובות מוחזרות באופן ספציפי לשפה.
שיטות בקשה
Docs API תומך בשיטות הבאות:
documents.create: כדי ליצור מסמך ריק ב-Google Docs.documents.get: החזרת המופע המלא של המסמך שצוין. אפשר לנתח את קובץ ה-JSON שהוחזר כדי לחלץ את התוכן, העיצוב ותכונות אחרות במסמך.documents.batchUpdate: שליחת רשימה של בקשות עריכה שיחולו על המסמך באופן אטומי, והחזרת רשימת תוצאות.
בשיטות documents.get ו-documents.batchUpdate נדרש פרמטר documentId כדי לציין את מסמך היעד. השיטה documents.create
מחזירה מופע של המסמך שנוצר, שממנו אפשר לקרוא
documentId. למידע נוסף על documentId, אפשר לעיין במסמך
מזהה.
עדכונים בכמות גדולה
documents.batchUpdate
לוקחת רשימה
request אובייקטים, כל אחד
שמציין בקשה יחידה לביצוע. לדוגמה, מעצבים פסקה
להוסיף תמונה בתוך שורה. כל בקשה מאומתת לפני שמחילים אותה,
הבקשות מעובדות לפי הסדר שבו הן מופיעות בבקשה באצווה.
כל הבקשות בעדכון בכמות גדולה מוחלות באופן אטומי. כלומר, אם יש בקשה כלשהי אינו תקף, אז העדכון כולו נכשל ואף אחד תלויים) הוחלו שינויים.
חלק מהשיטות של documents.batchUpdate מספקות תשובות עם מידע על
הבקשות שמוחלות. השיטות האלה מחזירות תגובה
גוף
מכיל רשימה של response
אובייקטים. בקשות אחרות לא צריכות להחזיר פרטים ולהציג
תשובה. לאובייקטים ברשימת התשובות יש סדר אינדקס זהה לזה של
בבקשה המתאימה.
דפוס פופולרי לשליחת בקשות באצווה נראה כך:
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
פרטים מלאים זמינים במאמר שיטות מומלצות לשליחת בקשות בכמות גדולה
איך לקבץ באצווה קריאות ל-Docs API
documents.batchUpdate
מסמכי עזר לסוגי בקשות ותגובות.
פעולות של עדכון באצווה
יש כל מיני סוגים של בקשות לעדכון באצווה. הנה פירוט של סוגי בקשות, מקובצים לפי קטגוריות שונות.