หน้านี้มีรายการคลาส เมธอด และประเภทที่มีการแจกแจงที่มีอยู่ใน Google Picker API องค์ประกอบทั้งหมดนี้เป็นของเนมสเปซ google.picker.*
คลาสและประเภทของการแจกแจงมี 2 ประเภท ได้แก่ คลาสที่ใช้สร้างและกำหนดค่าเครื่องมือเลือกของ Google และคลาสที่เครื่องมือเลือกของ Google แสดงผลเมื่อผู้ใช้เลือกรายการแล้ว
คลาสและประเภทการกำหนดค่า
คลาสและประเภทรายการที่ระบุต่อไปนี้ใช้เพื่อสร้างและกำหนดค่า Google Picker
DocsUploadView
ใช้ DocsUploadView
เพื่ออัปโหลดเอกสารไปยัง Google ไดรฟ์
DocsUploadView() | เครื่องมือสร้าง |
DocsUploadView.setIncludeFolders(boolean) | อนุญาตให้ผู้ใช้เลือกโฟลเดอร์ใน Google ไดรฟ์ที่จะอัปโหลดไป |
DocsUploadView.setParent(string) | ตั้งค่าปลายทางการอัปโหลดไปยังโฟลเดอร์ที่ระบุ การดำเนินการนี้จะลบล้าง setIncludeFolders เป็น "เท็จ" |
DocsView
DocsView
เป็นคลาสย่อยของ View
ที่สามารถใช้สำหรับข้อมูลพร็อพเพอร์ตี้ Google ไดรฟ์
DocsView(ViewId | undefined) | เครื่องมือสร้าง ViewId ต้องเป็นหนึ่งในมุมมองของ Google ไดรฟ์ ค่าเริ่มต้นคือ ViewId.DOCS |
DocsView.setEnableDrives(boolean) | แสดงไดรฟ์ที่แชร์และไฟล์ที่อยู่ในนั้น ก่อนเปิดใช้ โปรดดูเอกสารประกอบของ Google Drive API สำหรับการเปิดใช้ไดรฟ์ที่แชร์ |
DocsView.setIncludeFolders(boolean) | แสดงโฟลเดอร์ในรายการมุมมอง อย่ารวมกับ setOwnedByMe เมื่อตั้งค่า setIncludeFolders(true) ระบบจะไม่สนใจ setOwnedByMe |
DocsView.setSelectFolderEnabled(boolean) | อนุญาตให้ผู้ใช้เลือกโฟลเดอร์ใน Google ไดรฟ์ |
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 ไดรฟ์ |
Feature.MULTISELECT_ENABLED | อนุญาตให้ผู้ใช้เลือกได้มากกว่า 1 รายการ |
Feature.NAV_HIDDEN | ซ่อนแผงการนำทาง หากแผงการนำทางซ่อนอยู่ ผู้ใช้จะเลือกได้จากมุมมองแรกที่เลือกไว้เท่านั้น |
Feature.SIMPLE_UPLOAD_ENABLED | สำหรับการอัปโหลดรูปภาพ จะควบคุมว่าจะเปิดใช้การเลือกต่อรูปภาพ (ตรงข้ามกับต่ออัลบั้ม) หรือไม่ |
Feature.SUPPORT_DRIVES |
เลิกใช้งาน: รายการในไดรฟ์ที่แชร์จะรวมอยู่โดยค่าเริ่มต้น ระบบรวมรายการในไดรฟ์ที่แชร์ไว้ในผลลัพธ์หรือไม่ |
Picker
Picker
เป็นออบเจ็กต์ระดับบนสุดที่แสดงการดำเนินการ UI กับผู้ใช้ ระบบจะไม่สร้างออบเจ็กต์เหล่านี้โดยตรง แต่ใช้ออบเจ็กต์ PickerBuilder
แทน
Picker.isVisible() | รับบูลีนที่ระบุระดับการเข้าถึงเครื่องมือเลือกปัจจุบัน |
Picker.setCallback(function(object)) | ระบุวิธีการเรียกกลับที่เรียก เมื่อใดก็ตามที่ผู้ใช้เลือกรายการ (หรือยกเลิก) |
Picker.setRelayUrl(string) | ระบุ URL รีเลย์เพื่อหลีกเลี่ยงปัญหาข้ามโดเมน |
Picker.setVisible(boolean) | ควบคุมการมองเห็นออบเจ็กต์เครื่องมือเลือก |
Picker.dispose() | ทิ้งออบเจ็กต์เครื่องมือเลือก |
PickerBuilder
PickerBuilder
จะใช้เพื่อสร้างออบเจ็กต์ Picker
วิธีการส่งคืนด้านล่างนี้เป็นประเภท PickerBuilder
ซึ่งอนุญาตให้คุณต่อสายทีละ 1 สายได้ เว้นแต่จะระบุไว้เป็นอย่างอื่น ดูตัวอย่างโค้ดเครื่องมือเลือกของ Google สำหรับการใช้งานทั่วไป
PickerBuilder() | เครื่องมือสร้าง |
PickerBuilder.addView( | เพิ่ม View ในแผงการนำทาง |
PickerBuilder.addViewGroup(ViewGroup) | เพิ่ม ViewGroup ในแผงการนำทางระดับบนสุด |
PickerBuilder.build() | สร้างออบเจ็กต์เครื่องมือเลือก ออบเจ็กต์เครื่องมือเลือกจะปรากฏขึ้น |
PickerBuilder.disableFeature(Feature) | ปิดใช้ฟีเจอร์เครื่องมือเลือก |
PickerBuilder.enableFeature(Feature) | เปิดใช้ฟีเจอร์เครื่องมือเลือก |
PickerBuilder.getRelayUrl() | รับ URL การส่งต่อที่ใช้สำหรับแกดเจ็ต.rpc |
PickerBuilder.getTitle() | รับชื่อกล่องโต้ตอบ |
PickerBuilder.hideTitleBar() | ปิดการแสดงแถบชื่อ หากต้องการเปิดใช้อีกครั้ง ให้เรียก setTitle ด้วยชื่อที่ไม่ว่างเปล่าหรือไม่ได้ระบุ |
PickerBuilder.isFeatureEnabled(Feature) | ตรวจสอบว่าเปิดใช้เครื่องมือเลือก Feature หรือไม่ |
PickerBuilder.setAppId(string) | ตั้งค่ารหัสแอป Google ไดรฟ์ที่ต้องใช้เพื่ออนุญาตให้แอปพลิเคชันเข้าถึงไฟล์ของผู้ใช้ผ่าน API ของ Google ไดรฟ์ |
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 เอกสารและไดรฟ์ |
PickerBuilder.setOrigin(string) | กำหนดต้นทางของกล่องโต้ตอบ Google Picker ควรตั้งค่าต้นทางเป็น window.location.protocol + '//' + window.location.host ของหน้าเว็บบนสุด หากแอปพลิเคชันของคุณทำงานใน iframe |
PickerBuilder.setRelayUrl(string) | ตั้งค่า URL การส่งต่อ ที่ใช้สำหรับแกดเจ็ต.rpc |
PickerBuilder.setSelectableMimeTypes(string) | ตั้งค่ารายการประเภท MIME ที่เลือกได้ ใช้เครื่องหมายจุลภาคเพื่อคั่นประเภท MIME หากต้องใช้มากกว่า 1 ประเภท |
PickerBuilder.setSize() | กำหนดขนาดกล่องโต้ตอบที่ต้องการ กล่องโต้ตอบจะอยู่ตรงกลางโดยอัตโนมัติ ขนาดขั้นต่ำคือ (566,350) และขนาดสูงสุดคือ (1051,650) |
PickerBuilder.setTitle(string) | ตั้งชื่อกล่องโต้ตอบ |
PickerBuilder.toUri() | แสดง URI ที่สร้างโดยเครื่องมือสร้างนี้ |
ResourceId
ResourceId
เป็นคลาสแบบคงที่ที่ใช้เพื่อสร้างรหัสทรัพยากรที่เหมาะสำหรับ API รายการเอกสารของ Google
ResourceId.generate(Document) | แมปออบเจ็กต์เอกสารกับรหัสทรัพยากร |
ดู
View
คือคลาสพื้นฐานเชิงนามธรรมสำหรับคลาสข้อมูลพร็อพเพอร์ตี้ต่างๆ เช่น DocsView
View(ViewId) | เครื่องมือสร้าง |
View.getId() | แสดง ViewId สำหรับมุมมองนี้ |
View.setMimeTypes(string) | ตั้งค่าประเภท MIME ที่รวมอยู่ในข้อมูลพร็อพเพอร์ตี้ ใช้เครื่องหมายจุลภาคเพื่อคั่นประเภท MIME หากต้องใช้มากกว่า 1 ประเภท หากไม่ตั้งค่าประเภท MIME ไว้ ไฟล์ประเภท MIME ทั้งหมดจะปรากฏในมุมมอง |
View.setQuery(string) | หากต้องการดูข้อมูลพร็อพเพอร์ตี้ที่เกี่ยวข้องกับการค้นหา ให้เติมข้อความค้นหาเหล่านี้ไว้ล่วงหน้าด้วยคำเหล่านี้ |
ViewGroup
ViewGroup
คือการจัดกลุ่มข้อมูลพร็อพเพอร์ตี้แบบภาพ รายการรูทของ ViewGroup ต้องเป็น View
ViewGroup(View | ViewId) | ViewGroup คือการจัดกลุ่มมุมมองในรูปแบบภาพในแผงการนำทาง รายการรูทของ ViewGroup ต้องเป็น View |
ViewGroup.addLabel(string) | เพิ่มป้ายกำกับลงใน ViewGroup นี้ |
ViewGroup.addView(ViewId | View) | เพิ่มมุมมองไปยัง ViewGroup View อาจแสดงด้วยออบเจ็กต์ที่มาจาก view หรือจะใช้ ViewId ก็ได้ |
ViewGroup.addViewGroup(ViewGroup) | ซ้อน ViewGroup ภายใน ViewGroup ปัจจุบัน |
ViewId
ViewId
เป็นประเภทแจกแจง ใช้สำหรับการสร้างออบเจ็กต์ View
และ ViewGroup
ViewId.DOCS | เอกสารทุกประเภทใน Google ไดรฟ์ |
ViewId.DOCS_IMAGES | รูปภาพ Google ไดรฟ์ |
ViewId.DOCS_IMAGES_AND_VIDEOS | รูปภาพและวิดีโอใน Google ไดรฟ์ |
ViewId.DOCS_VIDEOS | วิดีโอ Google ไดรฟ์ |
ViewId.DOCUMENTS | เอกสาร Google ไดรฟ์ |
ViewId.DRAWINGS | วาดเขียนของ Google ไดรฟ์ |
ViewId.FOLDERS | โฟลเดอร์ Google ไดรฟ์ |
ViewId.FORMS | ฟอร์มของ Google ไดรฟ์ |
ViewId.PDFS | ไฟล์ PDF ที่จัดเก็บใน Google ไดรฟ์ |
ViewId.PRESENTATIONS | งานนำเสนอ Google ไดรฟ์ |
ViewId.SPREADSHEETS | สเปรดชีต Google ไดรฟ์ |
ประเภทโค้ดเรียกกลับ
พบประเภทที่มีการแจกแจงต่อไปนี้ในข้อมูลโค้ดเรียกกลับที่แสดงผลโดย Google Picker API
การดำเนินการ
Action
เป็นประเภทแจกแจงซึ่งแสดงการดำเนินการที่ผู้ใช้ทำเพื่อปิดกล่องโต้ตอบ ค่านี้อยู่ในช่อง Response.ACTION
ในข้อมูลโค้ดเรียกกลับ
Action.CANCEL | ผู้ใช้ยกเลิกกล่องโต้ตอบเครื่องมือเลือกของ Google แล้ว |
Action.PICKED | ผู้ใช้ได้เลือกอย่างน้อย 1 รายการ |
เอกสาร
Document
เป็นประเภทแจกแจงที่ใช้ในการสื่อสารข้อมูลเกี่ยวกับรายการที่เลือกที่เฉพาะเจาะจง โดยจะแสดงเฉพาะช่องที่เกี่ยวข้องกับรายการที่เลือกเท่านั้น ค่านี้อยู่ในช่อง Response.DOCUMENTS
ในข้อมูลโค้ดเรียกกลับ
Document.DESCRIPTION | คำอธิบายของผู้ใช้สำหรับรายการที่เลือก |
Document.DURATION | ระยะเวลาของวิดีโอที่เลือก |
Document.EMBEDDABLE_URL | URL ของรายการนี้เหมาะสำหรับการฝังในหน้าเว็บ |
Document.ICON_URL | URL ไปยังไอคอนสำหรับรายการนี้ |
Document.ID | รหัสของรายการที่เลือก |
Document.IS_NEW | แสดงผลเป็น "จริง" หากเพิ่งอัปโหลดรายการที่เลือก |
Document.LAST_EDITED_UTC | การประทับเวลาที่อธิบายว่ารายการนี้มีการแก้ไขครั้งล่าสุดเมื่อใด |
Document.MIME_TYPE | ประเภท MIME ของรายการนี้ |
Document.NAME | ชื่อของรายการนี้ |
Document.NUM_CHILDREN | จำนวนเด็กที่อยู่ในรายการนี้ เช่น จำนวนไฟล์ในโฟลเดอร์ที่เลือก |
Document.PARENT_ID | รหัสหลักของรายการนี้ เช่น โฟลเดอร์ที่มีไฟล์นี้ |
Document.SERVICE_ID | ServiceId ซึ่งอธิบายบริการที่เลือกรายการนี้ |
Document.THUMBNAILS | อาร์เรย์ของ Thumbnail ซึ่งอธิบายแอตทริบิวต์ของรูปภาพหรือวิดีโอ ภาพขนาดย่อจะไม่แสดงหากรายการที่เลือกเป็นของ Google ไดรฟ์ |
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 ไดรฟ์ |
ภาพปก
Thumbnail
เป็นประเภทแจกแจงซึ่งใช้เพื่อสื่อสารข้อมูลเกี่ยวกับรูปภาพหรือวิดีโอที่เลือก ค่านี้จะอยู่ในช่อง Document.THUMBNAILS
ของ Document
ที่เลือกไว้
Thumbnail.HEIGHT | ความสูงของรูปภาพหรือวิดีโอในหน่วยพิกเซล |
Thumbnail.WIDTH | ความกว้างของรูปภาพหรือวิดีโอในหน่วยพิกเซล |
Thumbnail.URL | URL ของรูปภาพหรือวิดีโอที่เลือก |
ประเภท
Type
เป็นประเภทแจกแจงที่ใช้ในการจัดหมวดหมู่รายการที่เลือก ค่านี้จะอยู่ในช่อง Document.TYPE
ของ Document
ที่เลือกไว้
Type.DOCUMENT | รายการนี้เป็นเอกสาร |
Type.PHOTO | รายการนี้เป็นรูปภาพ |
Type.VIDEO | รายการนี้เป็นวิดีโอ |