Diese Seite enthält eine Liste der Klassen, Methoden und Aufzählungstypen, die in der Google Picker API verfügbar sind. Alle diese Elemente gehören zum Namespace google.picker.*. Es gibt zwei Arten von Klassen und Enumerationstypen: diejenigen, die zum Erstellen und Konfigurieren der Google-Auswahl verwendet werden, und diejenigen, die von Google Picker zurückgegeben werden, nachdem der Nutzer ein Element ausgewählt hat.
Konfigurationsklassen und -typen
Die folgenden Klassen und Aufzählungstypen werden zum Erstellen und Konfigurieren der Google-Auswahl verwendet.
DocsUpload-Ansicht
Verwenden Sie DocsUploadView, um Dokumente in Google Drive hochzuladen.
DocsUploadView() | Konstruktor. |
DocsUploadView.setIncludeFolders(boolean) | Ermöglicht dem Nutzer, einen Ordner in Google Drive zum Hochladen auszuwählen. |
DocsUploadView.setParent(string) | Legt das Upload-Ziel auf den angegebenen Ordner fest. Dadurch wird setIncludeFolders auf „false“ überschrieben. |
Docs-Ansicht
DocsView ist eine abgeleitete Klasse von View, die für Google Drive-Ansichten verwendet werden kann.
DocsView(ViewId | undefined) | Konstruktor. Die ViewId muss eine der Google Drive-Ansichten sein. Der Standardwert ist ViewId.DOCS. |
DocsView.setEnableDrives(boolean) | Zeigt geteilte Ablagen und die darin enthaltenen Dateien an. Lesen Sie vor dem Aktivieren die Google Drive API-Dokumentation zum Aktivieren geteilter Ablagen. |
DocsView.setIncludeFolders(boolean) | Ordner in den Ansichtselementen anzeigen Nicht mit setOwnedByMe kombinieren. Wenn setIncludeFolders(true) festgelegt ist, wird setOwnedByMe ignoriert. |
DocsView.setSelectFolderEnabled(boolean) | Der Nutzer kann einen Ordner in Google Drive auswählen. |
DocsView.setMode(DocsViewMode) | Wählt aus, in welchem Modus die Ansicht angezeigt werden soll. |
DocsView.setOwnedByMe(boolean | undefined) | Filtert Dokumente danach, ob sie dem Nutzer gehören oder für ihn freigegeben wurden. Kombinieren Sie diese Einstellung nicht mit setIncludeFolders. Wenn setIncludeFolders(true) festgelegt ist, wird setOwnedByMe ignoriert. |
DocsView.setParent(string) | Legt den ursprünglichen übergeordneten Ordner fest, der angezeigt werden soll. |
DocsView.setStarred(boolean) | Filtert Dokumente danach, ob sie vom Nutzer markiert wurden. |
Docs-Ansichtsmodus
DocsViewMode ist ein Aufzählungstyp zum Anzeigen von Daten in einer DocsView. Verwenden Sie diese Werte in Aufrufen von DocsView.setMode.
DocsViewMode.GRID | Dokumente werden in einer Miniaturansicht als Raster angezeigt. |
DocsViewMode.LIST | Dokumente in einer detaillierten Liste anzeigen |
Funktion
Feature ist ein Aufzählungstyp zum Aktivieren/Deaktivieren von Funktionen für verschiedene Ansichten. Verwenden Sie diese Werte in Aufrufen von PickerBuilder.enableFeature und PickerBuilder.disableFeature.
Feature.MINE_ONLY | Nur Dokumente des Nutzers anzeigen, wenn Elemente aus Google Drive angezeigt werden. |
Feature.MULTISELECT_ENABLED | Nutzern erlauben, mehr als ein Element auszuwählen. |
Feature.NAV_HIDDEN | Navigationsbereich ausblenden Wenn der Navigationsbereich ausgeblendet ist, können Nutzer nur aus der ersten ausgewählten Ansicht auswählen. |
Feature.SIMPLE_UPLOAD_ENABLED | Mit dieser Option legen Sie für Fotouploads fest, ob die Auswahl pro Foto (anstatt pro Album) aktiviert ist. |
Feature.SUPPORT_DRIVES |
Eingestellt: Elemente in geteilten Ablagen sind jetzt standardmäßig enthalten. Gibt an, ob Elemente aus geteilten Ablagen in den Ergebnissen enthalten sind. |
Auswahlelement
Picker ist das Objekt der obersten Ebene, das die UI-Aktion mit dem Nutzer darstellt. Diese Objekte werden nicht direkt erstellt, sondern das Objekt PickerBuilder.
Picker.isVisible() | Ruft einen booleschen Wert für die aktuelle Sichtbarkeit von Picker ab. |
Picker.setCallback(function(object)) | Geben Sie die Callback-Methode an, die aufgerufen wird, wenn der Nutzer einen Artikel ausgewählt oder einen Vorgang abgebrochen hat. |
Picker.setRelayUrl(string) | Geben Sie eine Relay-URL an, um domainübergreifende Probleme zu umgehen. |
Picker.setVisible(boolean) | Sichtbarkeit des Picker-Objekts steuern. |
Picker.dispose() | Beseitigt das Picker-Objekt. |
PickerBuilder
PickerBuilder wird zum Erstellen von Picker-Objekten verwendet. Sofern nicht anders angegeben, ist der folgende Rückgabetyp vom Typ PickerBuilder, sodass Sie einen Aufruf nach einem anderen verketten können. Informationen zur typischen Verwendung finden Sie im Google Picker-Codebeispiel.
PickerBuilder() | Konstruktor. |
PickerBuilder.addView( | Fügen Sie dem Navigationsbereich ein View hinzu. |
PickerBuilder.addViewGroup(ViewGroup) | Fügen Sie dem Navigationsbereich der obersten Ebene ein ViewGroup hinzu. |
PickerBuilder.build() | Erstellen Sie das Picker-Objekt. Das Picker-Objekt wird zurückgegeben. |
PickerBuilder.disableFeature(Feature) | Deaktivieren Sie eine Auswahlfunktion. |
PickerBuilder.enableFeature(Feature) | Auswahlfunktion aktivieren. |
PickerBuilder.getRelayUrl() | Ruft die für "gadgets.rpc" verwendete Relay-URL ab |
PickerBuilder.getTitle() | Rufen Sie den Dialogtitel ab. |
PickerBuilder.hideTitleBar() | Deaktiviert die Titelleiste. Rufen Sie setTitle auf, wenn der Titel nicht leer oder undefiniert ist. |
PickerBuilder.isFeatureEnabled(Feature) | Prüfen Sie, ob eine Auswahl Feature aktiviert ist. |
PickerBuilder.setAppId(string) | Legt die Google Drive App-ID fest, die erforderlich ist, damit die Anwendung über die Google Drive API auf die Dateien des Nutzers zugreifen kann. |
PickerBuilder.setCallback(method) | Legen Sie die Callback-Methode fest. Diese Methode wird aufgerufen, wenn der Nutzer Elemente auswählt oder den Vorgang abbricht. Die Callback-Methode empfängt ein einzelnes Callback-Objekt. Die Struktur des Callback-Objekts wird im JSON-Leitfaden beschrieben. |
PickerBuilder.setDeveloperKey(string) | Legt den Browser API-Schlüssel fest, den Sie in der Google API Console erhalten haben. Weitere Informationen dazu, wie Sie den Browser-API-Schlüssel erhalten, finden Sie im Entwicklerhandbuch. |
PickerBuilder.setDocument(document) | Legen Sie das Dokument fest. |
PickerBuilder.setLocale(string) | ISO 639-Sprachcode. Wenn die Sprache nicht unterstützt wird, wird „en-US“ verwendet. Diese Methode ist eine Alternative zum Festlegen des Gebietsschemas zum Zeitpunkt google.load(). Eine Liste der unterstützten Sprachen finden Sie im Entwicklerhandbuch. |
PickerBuilder.setMaxItems(number) | Legt die maximale Anzahl von Elementen fest, die ein Nutzer auswählen kann. |
PickerBuilder.setOAuthToken(string) | Legt ein OAuth-Token für die Authentifizierung des aktuellen Nutzers fest. Je nach Umfang des Tokens werden nur in bestimmten Ansichten Daten angezeigt. Gültige Bereiche sind Google Docs, Drive, Fotos und YouTube. |
PickerBuilder.setOrigin(string) | Legt den Ursprung des Google-Auswahl-Dialogfelds fest. Der Ursprung sollte auf den window.location.protocol + '//' + window.location.host der obersten Seite gesetzt werden, wenn Ihre Anwendung in einem iFrame ausgeführt wird. |
PickerBuilder.setRelayUrl(string) | Legen Sie die Relay-URL fest, die für Gadgets verwendet wird.rpc. |
PickerBuilder.setSelectableMimeTypes(string) | Legen Sie die Liste der auswählbaren MIME-Typen fest. Trennen Sie MIME-Typen durch Kommas, wenn mehr als ein Typ erforderlich ist. |
PickerBuilder.setSize() | Legen Sie die gewünschte Dialogfeldgröße fest. Das Dialogfeld wird automatisch zentriert. Es hat eine Mindestgröße von (566.350) und eine maximale Größe von (1.051.650). |
PickerBuilder.setTitle(string) | Legen Sie den Titel des Dialogfelds fest. |
PickerBuilder.toUri() | Gibt den von diesem Builder generierten URI zurück. |
ResourceId
ResourceId ist eine statische Klasse, die zum Generieren von Ressourcen-IDs verwendet wird, die für die Google Documents List API geeignet sind.
ResourceId.generate(Document) | Ordnet ein Dokumentobjekt einer Ressourcen-ID zu. |
Zurück zum Ansichtsmodus
View ist die abstrakte Basisklasse für die verschiedenen Ansichtsklassen wie DocsView.
View(ViewId) | Konstruktor. |
View.getId() | Gibt die ViewId für diese Ansicht zurück. |
View.setMimeTypes(string) | Legt die MIME-Typen fest, die in der Ansicht enthalten sind. Trennen Sie MIME-Typen durch Kommas, wenn mehr als ein Typ erforderlich ist. Wenn Sie keine MIME-Typen festlegen, werden alle Dateitypen angezeigt. |
View.setQuery(string) | Wenn du eine Suchanfrage eingibst, die Suchbegriffe enthält, musst du die Suchanfrage vorab mit diesen Begriffen ausfüllen. |
Gruppe anzeigen
ViewGroup ist eine visuelle Gruppierung von Ansichten. Das Stammelement der ViewGroup selbst muss ein View sein.
ViewGroup(View | ViewId) | Ein ViewGroup ist eine visuelle Gruppierung von Ansichten im Navigationsbereich. Das Stammelement von ViewGroup muss View sein. |
ViewGroup.addLabel(string) | ViewGroup ein Label hinzufügen. |
ViewGroup.addView(ViewId | View) | Fügen Sie ViewGroup eine Ansicht hinzu. Die View kann durch ein view-abgeleitetes Objekt oder einfach durch die ViewId dargestellt werden. |
ViewGroup.addViewGroup(ViewGroup) | Verschachtelt ein ViewGroup innerhalb des aktuellen ViewGroup. |
ID der Datenansicht
ViewId ist ein Aufzählungstyp und wird zum Erstellen von View- und ViewGroup-Objekten verwendet.
ViewId.DOCS | Alle Google Drive-Dokumenttypen |
ViewId.DOCS_IMAGES | Google Drive-Fotos |
ViewId.DOCS_IMAGES_AND_VIDEOS | Google Drive: Fotos und Videos |
ViewId.DOCS_VIDEOS | Google Drive-Videos |
ViewId.DOCUMENTS | Google Drive-Dokumente. |
ViewId.DRAWINGS | Google Drive-Zeichnungen |
ViewId.FOLDERS | Google Drive-Ordner. |
ViewId.FORMS | Google Drive-Formulare. |
ViewId.PDFS | In Google Drive gespeicherte PDF-Dateien. |
ViewId.PRESENTATIONS | Google Drive-Präsentationen |
ViewId.SPREADSHEETS | Google Drive-Tabellen: |
Callback-Typen
Die folgenden Aufzählungstypen sind in Callback-Daten enthalten, die von der Google Picker API zurückgegeben werden.
Aktion
Action ist ein Aufzählungstyp, der die vom Nutzer zum Schließen des Dialogfelds ausgeführte Aktion darstellt. Dieser Wert befindet sich in den Callback-Daten im Feld Response.ACTION.
Action.CANCEL | Der Nutzer hat das Dialogfeld für die Google-Auswahl abgebrochen. |
Action.PICKED | Der Nutzer hat mindestens ein Element ausgewählt. |
Dokument
Document ist ein Aufzählungstyp, mit dem Informationen zu einem bestimmten ausgewählten Element übermittelt werden. Es werden nur Felder zurückgegeben, die für das ausgewählte Element relevant sind. Dieser Wert befindet sich in den Callback-Daten im Feld Response.DOCUMENTS.
Document.DESCRIPTION | Eine vom Nutzer bereitgestellte Beschreibung des ausgewählten Elements. |
Document.DURATION | Die Dauer eines ausgewählten Videos. |
Document.EMBEDDABLE_URL | Eine URL für diesen Artikel, die zum Einbetten in eine Webseite geeignet ist. |
Document.ICON_URL | Eine URL zu einem Symbol für diesen Artikel. |
Document.ID | Die ID des ausgewählten Elements. |
Document.IS_NEW | Gibt „true“ zurück, wenn das ausgewählte Element gerade hochgeladen wurde. |
Document.LAST_EDITED_UTC | Der Zeitstempel, der angibt, wann dieses Element zuletzt bearbeitet wurde. |
Document.MIME_TYPE | Der MIME-Typ dieses Elements. |
Document.NAME | Der Name dieses Elements. |
Document.NUM_CHILDREN | Die Anzahl der in diesem Element enthaltenen untergeordneten Elemente. Zum Beispiel die Anzahl der Dateien im ausgewählten Ordner. |
Document.PARENT_ID | Die übergeordnete ID dieses Elements. Zum Beispiel der Ordner, der diese Datei enthält. |
Document.SERVICE_ID | Eine ServiceId, die den Dienst beschreibt, aus dem dieses Element ausgewählt wurde. |
Document.THUMBNAILS | Ein Thumbnail-Array, das die Attribute eines Fotos oder Videos beschreibt. Wenn die ausgewählten Elemente zu Google Drive gehören, werden keine Miniaturansichten zurückgegeben. |
Document.TYPE | Die Type des ausgewählten Elements. |
Document.URL | Eine URL zu diesem Artikel. |
Antwort
Response ist ein Aufzählungstyp, der verwendet wird, um Informationen zu den ausgewählten Elementen des Nutzers zu vermitteln.
Response.ACTION | Ein Typ Action, der die Aktion darstellt, die der Nutzer zum Schließen des Dialogfelds ausgeführt hat. |
Response.DOCUMENTS | Ein Array mit Document, die vom Nutzer ausgewählt wurden. |
Response.PARENTS | Die IDs der übergeordneten Ordner für die ausgewählten Elemente. (z. B. IDs der übergeordneten Ordner, deren Dateien ausgewählt wurden) |
Response.VIEW | Der View, aus dem der Nutzer diese Elemente ausgewählt hat. |
Dienst-ID
ServiceId ist ein Aufzählungstyp, mit dem der Dienst beschrieben wird, aus dem das Element ausgewählt wurde. Dieser Wert befindet sich im Feld Document.SERVICE_ID der ausgewählten Document.
ServiceId.DOCS | In Google Drive. |
thumbnail
Thumbnail ist ein Aufzählungstyp, der verwendet wird, um Informationen zu einem ausgewählten Foto oder Video zu vermitteln. Diesen Wert finden Sie im Feld Document.THUMBNAILS einer ausgewählten Document.
Thumbnail.HEIGHT | Die Höhe des Fotos oder Videos in Pixeln. |
Thumbnail.WIDTH | Die Breite des Fotos oder Videos in Pixeln. |
Thumbnail.URL | Eine URL zum ausgewählten Foto oder Video. |
Typ
Type ist ein Aufzählungstyp, mit dem das ausgewählte Element kategorisiert wird. Diesen Wert finden Sie im Feld Document.TYPE einer ausgewählten Document.
Type.DOCUMENT | Das Element ist ein Dokument. |
Type.PHOTO | Der Artikel ist ein Foto. |
Type.VIDEO | Das Element ist ein Video. |