דף זה תורגם על ידי Cloud Translation API.

הפניית API של Google Picker

הדף הזה מכיל רשימה של מחלקות, שיטות וסוגים ממוינים שזמינים ב-Google Picker API. כל הרכיבים האלו שייכים למרחב השמות google.picker.* יש שני סוגים של מחלקות וסוגים ממוינים: אלה המשמשים ליצירה והגדרה של בורר Google, ואלה שמוחזרים על ידי Google Picker אחרי שהמשתמש בוחר פריט.

סיווגים וסוגים של הגדרות

המחלקות והסוגים הבאים משמשים ליצירה ולהגדרה של Google Picker.

DocsUploadView

אפשר להשתמש בDocsUploadView כדי להעלות מסמכים ל-Google Drive.

`DocsUploadView()`	Constructor.
`DocsUploadView.setIncludeFolders(boolean)`	מאפשרת למשתמש לבחור תיקייה ב-Google Drive כדי להעלות אליה.
`DocsUploadView.setParent(string)`	מגדיר את יעד ההעלאה לתיקייה שצוינה. הערך הזה מבטל את `setIncludeFolders` ל-FALSE.

DocsView

DocsView היא מחלקה משנית של View שניתן להשתמש בה לתצוגות ב-Google Drive.

`DocsView(ViewId \| undefined)`	Constructor. הקובץ `ViewId` חייב להיות אחת מהתצוגות ב-Google Drive. ברירת המחדל היא `ViewId.DOCS`.
`DocsView.setEnableDrives(boolean)`	כאן מוצגות תיקיות האחסון השיתופי והקבצים שהן מכילות. לפני ההפעלה, כדאי לעיין במסמכי התיעוד של Google Drive API להפעלת תיקיות אחסון שיתופי.
`DocsView.setIncludeFolders(boolean)`	הצגת התיקיות בתצוגת הפריטים. אין לשלב עם `setOwnedByMe`. אם המדיניות `setIncludeFolders(true)` מוגדרת, המערכת מתעלמת מהמדיניות `setOwnedByMe`.
`DocsView.setSelectFolderEnabled(boolean)`	מאפשרת למשתמש לבחור תיקייה ב-Google Drive.
`DocsView.setMode(DocsViewMode)`	בחירת המצב להצגת המסמכים בתצוגה.
`DocsView.setOwnedByMe(boolean \| undefined)`	סינון המסמכים מתבצע בהתאם לבעלות על המשתמש או לשיתוף עם המשתמש. אין לשלב את ההגדרה הזו עם `setIncludeFolders`. אם המדיניות `setIncludeFolders(true)` מוגדרת, המערכת מתעלמת מהמדיניות `setOwnedByMe`.
`DocsView.setParent(string)`	מגדיר את תיקיית ההורה הראשונית לתצוגה.
`DocsView.setStarred(boolean)`	סינון המסמכים על סמך סימון המשתמש בכוכב.

DocsViewMode

DocsViewMode הוא סוג של ספירה להצגת נתונים בתוך DocsView. כדאי להשתמש בערכים האלה בשיחות אל DocsView.setMode.

`DocsViewMode.GRID`	הצגת מסמכים ברשת של תמונות ממוזערות.
`DocsViewMode.LIST`	הצגת מסמכים ברשימה מפורטת.

התכונה

Feature הוא סוג של ספירה לצורך הפעלה או השבתה של תכונות בתצוגות שונות. יש להשתמש בערכים האלה בשיחות אל PickerBuilder.enableFeature ואל PickerBuilder.disableFeature.

`Feature.MINE_ONLY`	הצגת מסמכים שבבעלות המשתמש בלבד בעת הצגת פריטים מ-Google Drive.
`Feature.MULTISELECT_ENABLED`	המשתמשים יכולים לבחור יותר מפריט אחד.
`Feature.NAV_HIDDEN`	הסתרת חלונית הניווט. אם חלונית הניווט מוסתרת, המשתמשים יכולים לבחור רק מהתצוגה הראשונה שנבחרה.
`Feature.SIMPLE_UPLOAD_ENABLED`	בהעלאות של תמונות, המדיניות קובעת אם האפשרות לבחירה לפי תמונה (בניגוד לבחירה לפי אלבום) מופעלת.
`Feature.SUPPORT_DRIVES`	הוצא משימוש: פריטים באחסון השיתופי נכללים עכשיו כברירת מחדל. אם פריטים באחסון השיתופי נכללים בתוצאות.

בורר

Picker הוא האובייקט ברמה העליונה שמייצג את הפעולה בממשק המשתמש עם המשתמש. האובייקטים האלה לא נוצרים ישירות, אלא משתמשים באובייקט PickerBuilder.

`Picker.isVisible()`	מקבלים ערך בוליאני שמציין את הרשאות הגישה הנוכחית של הבורר.
`Picker.setCallback(function(object))`	צריך לציין את שיטת הקריאה החוזרת (callback) שאליה תתבצע קריאה בכל פעם שהמשתמש בחר פריט (או ביטל).
`Picker.setRelayUrl(string)`	צריך לציין כתובת URL של שרת ממסר כדי לעקוף בעיות בכמה דומיינים.
`Picker.setVisible(boolean)`	שליטה בחשיפה של אובייקט הבורר.
`Picker.dispose()`	מוחק את האובייקט של הבורר.

PickerBuilder

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

`PickerBuilder()`	Constructor.
`PickerBuilder.addView(View \| ViewId)`	מוסיפים `View` לחלונית הניווט.
`PickerBuilder.addViewGroup(ViewGroup)`	מוסיפים `ViewGroup` לחלונית הניווט ברמה העליונה.
`PickerBuilder.build()`	יוצרים את האובייקט Picker. האובייקט Picker מוחזר.
`PickerBuilder.disableFeature(Feature)`	השבתה של תכונה בבוחר.
`PickerBuilder.enableFeature(Feature)`	הפעלת תכונת בוחר.
`PickerBuilder.getRelayUrl()`	מוצאים את כתובת ה-URL לשידור, המשמשת עבור גאדג'טים.rpc.
`PickerBuilder.getTitle()`	משיגים את הכותרת של תיבת הדו-שיח.
`PickerBuilder.hideTitleBar()`	השבתת ההצגה של סרגל הכותרת. כדי להפעיל אותו מחדש, צריך לקרוא לפונקציה `setTitle` עם כותרת שאינה ריקה או ללא הגדרה.
`PickerBuilder.isFeatureEnabled(Feature)`	בודקים אם הבורר `Feature` מופעל.
`PickerBuilder.setAppId(string)`	מגדיר את מזהה האפליקציה של Google Drive הדרוש כדי לאפשר לאפליקציה לגשת לקבצים של המשתמש באמצעות Google Drive API.
`PickerBuilder.setCallback(method)`	מגדירים את שיטת הקריאה החוזרת. מתבצעת קריאה לשיטה הזו כשהמשתמש בוחר פריטים או מבטל. שיטת הקריאה החוזרת מקבלת אובייקט קריאה חוזרת יחיד. המבנה של אובייקט הקריאה החוזרת מתואר במדריך JSON.
`PickerBuilder.setDeveloperKey(string)`	מגדיר את מפתח ה-API של הדפדפן שהתקבל ממסוף Google API. במדריך למפתחים מוסבר איך לקבל את מפתח ה-API של הדפדפן.
`PickerBuilder.setDocument(document)`	מגדירים את המסמך.
`PickerBuilder.setLocale(string)`	קוד שפה לפי תקן ISO 639. אם השפה לא נתמכת, נעשה שימוש בקידוד en-US. השיטה הזו מספקת חלופה להגדרת הלוקאל בזמן google.load() . במדריך למפתחים מופיעה רשימה של הלוקאלים הנתמכים.
`PickerBuilder.setMaxItems(number)`	מגדירה את מספר הפריטים המקסימלי שהמשתמש יכול לבחור.
`PickerBuilder.setOAuthToken(string)`	מגדיר אסימון OAuth שישמש לאימות המשתמש הנוכחי. רק תצוגות מסוימות מציגות נתונים, בהתאם להיקף של האסימון. היקפי ההרשאות החוקיים הם Google Docs ו-Drive.
`PickerBuilder.setOrigin(string)`	מגדיר את המקור של תיבת הדו-שיח של 'בורר Google'. אם האפליקציה פועלת ב-iframe, צריך להגדיר את המקור לערך `window.location.protocol + '//' + window.location.host` של הדף העליון.
`PickerBuilder.setRelayUrl(string)`	הגדר את כתובת האתר להעברה, המשמשת עבור גאדג'טים.rpc.
`PickerBuilder.setSelectableMimeTypes(string)`	הגדרת הרשימה של סוגי MIME שניתן לבחור. צריך להשתמש בפסיקים כדי להפריד בין סוגי MIME אם יש צורך ביותר מאחד.
`PickerBuilder.setSize()`	הגדרת הגודל המועדף של תיבת הדו-שיח. תיבת הדו-שיח ממורכזת באופן אוטומטי. הגודל המינימלי הוא (566,350) והגודל המקסימלי שלו הוא (1051,650).
`PickerBuilder.setTitle(string)`	הגדרת כותרת לתיבת הדו-שיח.
`PickerBuilder.toUri()`	מחזירה את ה-URI שנוצר על ידי ה-builder.

ResourceId

ResourceId הוא מחלקה סטטית המשמשת ליצירת מזהי משאבים שמתאימים ל-Google Documents List API.

ResourceId.generate(Document) מיפוי אובייקט של מסמך למזהה משאב.

מעבר למצב תצוגה

View הוא מחלקת הבסיס המופשטת של מחלקות התצוגה השונות, כמו DocsView.

`View(ViewId)`	Constructor.
`View.getId()`	הפונקציה מחזירה את ה-ViewId של התצוגה המפורטת הזו.
`View.setMimeTypes(string)`	מגדיר את סוגי ה-MIME שכלולים בתצוגה. צריך להשתמש בפסיקים כדי להפריד בין סוגי MIME אם יש צורך ביותר מאחד. אם לא תגדירו סוגי MIME, קבצים מכל סוגי ה-MIME יוצגו בתצוגה.
`View.setQuery(string)`	לתצוגות שכוללות חיפושים, יש לאכלס מראש את שאילתת החיפוש במונחים האלה.

ViewGroup

ViewGroup הוא קיבוץ חזותי של תצוגות מפורטות. פריט הבסיס של ה-ViewGroup עצמו חייב להיות View.

`ViewGroup(View \| ViewId)`	`ViewGroup` הוא קיבוץ חזותי של התצוגות בחלונית הניווט. הפריט הבסיסי (root) של `ViewGroup` עצמו חייב להיות `View`.
`ViewGroup.addLabel(string)`	הוסף תווית ל`ViewGroup` הזה.
`ViewGroup.addView(ViewId \| View)`	הוסף תצוגה מפורטת ל-`ViewGroup`. את `View` אפשר לייצג אובייקט שנגזר מ-`view`, או פשוט על ידי ViewId.
`ViewGroup.addViewGroup(ViewGroup)`	Nest `ViewGroup` בתוך `ViewGroup` הנוכחי.

ViewId

ViewId הוא סוג של ספירה, המשמש ליצירת אובייקטים View ו-ViewGroup.

`ViewId.DOCS`	כל סוגי המסמכים ב-Google Drive.
`ViewId.DOCS_IMAGES`	תמונות ב-Google Drive.
`ViewId.DOCS_IMAGES_AND_VIDEOS`	תמונות וסרטונים ב-Google Drive.
`ViewId.DOCS_VIDEOS`	סרטונים ב-Google Drive.
`ViewId.DOCUMENTS`	מסמכים ב-Google Drive.
`ViewId.DRAWINGS`	שרטוטים ב-Google Drive.
`ViewId.FOLDERS`	תיקיות ב-Google Drive.
`ViewId.FORMS`	טפסים ב-Google Drive.
`ViewId.PDFS`	קובצי PDF השמורים ב-Google Drive.
`ViewId.PRESENTATIONS`	מצגות ב-Google Drive.
`ViewId.SPREADSHEETS`	גיליונות אלקטרוניים ב-Google Drive.

סוגי קריאה חוזרת (callback)

הסוגים המפורטים הבאים נמצאים בנתוני הקריאה החוזרת (callback) שהוחזרו על ידי Google Picker API.

פעולה

Action הוא סוג של ספירה שמייצג את הפעולה שביצע המשתמש כדי לסגור את תיבת הדו-שיח. הערך הזה נמצא בשדה Response.ACTION בנתוני הקריאה החוזרת.

`Action.CANCEL`	המשתמש ביטל את תיבת הדו-שיח של בוחר Google.
`Action.PICKED`	המשתמש בחר פריט אחד לפחות.

מסמך

Document הוא סוג של ספירה המשמש להעברת מידע על פריט ספציפי שנבחר. מוחזרים רק שדות שרלוונטיים לפריט שנבחר. הערך הזה נמצא בשדה Response.DOCUMENTS בנתוני הקריאה החוזרת.

`Document.DESCRIPTION`	תיאור של הפריט שנבחר שנוסף על ידי משתמשים.
`Document.DURATION`	משך הזמן של הסרטון שנבחר.
`Document.EMBEDDABLE_URL`	כתובת URL לפריט הזה מתאימה להטמעה בדף אינטרנט.
`Document.ICON_URL`	כתובת URL לסמל של הפריט הזה.
`Document.ID`	המזהה של הפריט שנבחר.
`Document.IS_NEW`	הפונקציה מחזירה את הערך True אם הפריט שנבחר הועלה הרגע.
`Document.LAST_EDITED_UTC`	חותמת הזמן שמציינת מתי בוצעה העריכה האחרונה של הפריט.
`Document.MIME_TYPE`	סוג ה-MIME של הפריט הזה.
`Document.NAME`	השם של הפריט הזה.
`Document.NUM_CHILDREN`	מספר הצאצאים שנכללים בפריט הזה. לדוגמה, מספר הקבצים בתיקייה שנבחרה.
`Document.PARENT_ID`	מזהה ההורה של הפריט הזה. לדוגמה, התיקייה שמכילה את הקובץ הזה.
`Document.SERVICE_ID`	`ServiceId` שמתאר את השירות שבו נבחר הפריט הזה.
`Document.THUMBNAILS`	מערך של מאפייני `Thumbnail` שמתארים את המאפיינים של תמונה או סרטון. תמונות ממוזערות לא מוחזרות אם הפריטים שנבחרו שייכים ל-Google Drive.
`Document.TYPE`	ה-`Type` של הפריט שנבחר.
`Document.URL`	כתובת URL לפריט הזה.

תשובה

Response הוא סוג של ספירה המשמש להעברת מידע על הפריטים שהמשתמש בוחר.

`Response.ACTION`	סוג `Action` שמייצג את הפעולה שהמשתמש ביצע כדי לסגור את תיבת הדו-שיח.
`Response.DOCUMENTS`	מערך של `Document` שנבחרו על ידי המשתמש.
`Response.PARENTS`	המזהים של תיקיות ההורה של הפריטים שנבחרו. (לדוגמה, מזהים של תיקיות ההורה שהקבצים נבחרו).
`Response.VIEW`	`View` שממנה המשתמש בחר את הפריטים האלה.

מזהה שירות

ServiceId הוא סוג של ספירה שמשמשת לתיאור השירות שממנו הפריט נבחר. הערך הזה נמצא בשדה Document.SERVICE_ID של Document שבחרת.

ServiceId.DOCS Google Drive.

תמונה ממוזערת

המאפיין Thumbnail משמש להעברת מידע על תמונה או סרטון שנבחרו. הערך הזה נמצא בשדה Document.THUMBNAILS של Document שבחרתם.

`Thumbnail.HEIGHT`	גובה התמונה או הסרטון בפיקסלים.
`Thumbnail.WIDTH`	רוחב התמונה או הסרטון בפיקסלים.
`Thumbnail.URL`	כתובת URL של התמונה או הסרטון שנבחרו.

סוג

Type הוא סוג של ספירה שמשמש לסיווג הפריט שנבחר. הערך הזה נמצא בשדה Document.TYPE של Document שבחרתם.

`Type.DOCUMENT`	הפריט הוא מסמך.
`Type.PHOTO`	הפריט הוא תמונה.
`Type.VIDEO`	הפריט הוא סרטון.