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 Aufzählungstypen: die, die zum Erstellen und Konfigurieren der Google Auswahl verwendet werden, und die, die von der Google Auswahl zurückgegeben werden, sobald 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.
DocsUploadView
Verwenden Sie DocsUploadView, um Dokumente in Google Drive hochzuladen.
DocsUploadView() | Konstruktor. |
DocsUploadView.setIncludeFolders(boolean) | Der Nutzer kann einen Ordner in Google Drive für den Upload auswählen. |
DocsUploadView.setParent(string) | Legt das Upload-Ziel auf den angegebenen Ordner fest. Dadurch wird setIncludeFolders auf „false“ überschrieben. |
DocsView
DocsView ist eine abgeleitete Klasse von View, die für Google Drive-Ansichten verwendet werden kann.
DocsView(ViewId | undefined) | Konstruktor. Das 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 Dokumente angezeigt werden. |
DocsView.setOwnedByMe(boolean | undefined) | Dokumente werden danach gefiltert, 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 anfänglichen übergeordneten Ordner fest, der angezeigt werden soll. |
DocsView.setStarred(boolean) | Filtert die Dokumente danach, ob sie vom Nutzer markiert wurden. |
DocsViewMode
DocsViewMode ist ein Aufzählungstyp für die Anzeige von Daten in einer DocsView. Verwenden Sie diese Werte in Aufrufen von DocsView.setMode.
DocsViewMode.GRID | Dokumente in Miniaturansicht anzeigen |
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 | Bei der Anzeige von Elementen aus Google Drive nur Dokumente anzeigen, die dem Nutzer gehören. |
Feature.MULTISELECT_ENABLED | Der Nutzer kann mehr als ein Element auswählen. |
Feature.NAV_HIDDEN | Navigationsbereich ausblenden. Wenn der Navigationsbereich ausgeblendet ist, können Nutzer nur in der ersten Ansicht eine Auswahl treffen. |
Feature.SIMPLE_UPLOAD_ENABLED | Legt für Fotouploads fest, ob die Auswahl pro Foto (nicht 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 verwenden das PickerBuilder-Objekt.
Picker.isVisible() | Ruft einen booleschen Wert ab, der die aktuelle Auswahlsichtbarkeit angibt. |
Picker.setCallback(function(object)) | Geben Sie die Callback-Methode an, die immer dann aufgerufen wird, wenn der Nutzer ein Element ausgewählt oder den Vorgang abgebrochen hat. |
Picker.setRelayUrl(string) | Geben Sie eine Relais-URL an, um domainübergreifende Probleme zu umgehen. |
Picker.setVisible(boolean) | Steuern Sie die Sichtbarkeit des Auswahlobjekts. |
Picker.dispose() | Beseitigt das Auswahlobjekt. |
PickerBuilder
PickerBuilder wird zum Erstellen von Picker-Objekten verwendet. Sofern nicht anders angegeben, ist der Rückgabetyp der nachfolgenden Methoden vom Typ PickerBuilder, sodass Sie einen Aufruf nach dem anderen verketten können. Sehen Sie sich das Google Picker-Codebeispiel für die typische Verwendung an.
PickerBuilder() | Konstruktor. |
PickerBuilder.addView( | Fügen Sie im Navigationsbereich ein View hinzu. |
PickerBuilder.addViewGroup(ViewGroup) | Fügen Sie im Navigationsbereich auf oberster Ebene ein ViewGroup hinzu. |
PickerBuilder.build() | Erstellt das Auswahlobjekt. Das Picker-Objekt wird zurückgegeben. |
PickerBuilder.disableFeature(Feature) | Auswahlfunktion deaktivieren |
PickerBuilder.enableFeature(Feature) | Aktiviert eine Auswahlfunktion. |
PickerBuilder.getRelayUrl() | Ruft die Relais-URL ab, die für "gadgets.RPC" verwendet wird. |
PickerBuilder.getTitle() | Rufen Sie den Titel des Dialogfelds ab. |
PickerBuilder.hideTitleBar() | Titelleiste deaktivieren Rufen Sie zum Reaktivieren setTitle mit einem nicht leeren Titel auf oder geben Sie einen undefinierten Titel an. |
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 von Nutzern zugreifen kann. |
PickerBuilder.setCallback(method) | Legen Sie die Callback-Methode fest. Diese Methode wird aufgerufen, wenn der Nutzer Artikel 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, der über die Google API Console abgerufen wurde Weitere Informationen zum Abrufen des Browser API-Schlüssels finden Sie im Entwicklerhandbuch. |
PickerBuilder.setDocument(document) | Legen Sie das Dokument fest. |
PickerBuilder.setLocale(string) | ISO 639-Sprachcode. Wird die Sprache nicht unterstützt, wird „en-US“ verwendet. Diese Methode bietet eine Alternative zur Einstellung 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 und Drive. |
PickerBuilder.setOrigin(string) | Legt den Ursprung des Google Auswahl-Dialogfelds fest. Wenn deine App in einem iFrame ausgeführt wird, sollte der Ursprung auf den window.location.protocol + '//' + window.location.host der obersten Seite festgelegt werden. |
PickerBuilder.setRelayUrl(string) | Legt die Relais-URL fest, die für "gadgets.RPC" verwendet wird. |
PickerBuilder.setSelectableMimeTypes(string) | Legen Sie die Liste der auswählbaren MIME-Typen fest. Falls mehrere MIME-Typen erforderlich sind, trennen Sie diese durch Kommas. |
PickerBuilder.setSize() | Legen Sie die bevorzugte Größe des Dialogfelds fest. Das Dialogfeld wird automatisch zentriert. Sie hat eine Mindestgröße von 566.350 und eine Maximalgröß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 zum Generieren von Ressourcen-IDs, die für die Google Documents List API geeignet sind.
ResourceId.generate(Document) | Ordnen Sie ein Dokumentobjekt einer Ressourcen-ID zu. |
Ansehen
View ist die abstrakte Basisklasse für die verschiedenen Ansichtsklassen, z. B. DocsView.
View(ViewId) | Konstruktor. |
View.getId() | Gibt die ViewId für diese Ansicht zurück |
View.setMimeTypes(string) | Legt die in der Ansicht enthaltenen MIME-Typen fest. Falls mehrere MIME-Typen erforderlich sind, trennen Sie diese durch Kommas. Wenn Sie keine MIME-Typen festlegen, werden Dateien aller MIME-Typen in der Ansicht angezeigt. |
View.setQuery(string) | Bei Ansichten mit Suchanfragen sollten Sie die Suchanfrage mit diesen Begriffen ausfüllen. |
ViewGroup
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 selbst muss View sein. |
ViewGroup.addLabel(string) | Diesem ViewGroup ein Label hinzufügen. |
ViewGroup.addView(ViewId | View) | Fügen Sie dem ViewGroup eine Ansicht hinzu. Das View kann durch ein von view abgeleitetes Objekt oder einfach durch eine ViewId dargestellt werden. |
ViewGroup.addViewGroup(ViewGroup) | Verschachteln Sie ein ViewGroup im aktuellen ViewGroup. |
ViewId
ViewId ist ein Aufzählungstyp, der zum Erstellen der Objekte View und ViewGroup verwendet wird.
ViewId.DOCS | Alle Google Drive-Dokumenttypen |
ViewId.DOCS_IMAGES | Google Drive-Fotos. |
ViewId.DOCS_IMAGES_AND_VIDEOS | Fotos und Videos aus Google Drive. |
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 | PDF-Dateien, die in Google Drive gespeichert sind. |
ViewId.PRESENTATIONS | Google Drive-Präsentationen. |
ViewId.SPREADSHEETS | Google Drive-Tabellen. |
Rückruftypen
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 Aktion des Nutzers zum Schließen des Dialogfelds darstellt. Dieser Wert befindet sich in den Callback-Daten im Feld Response.ACTION.
Action.CANCEL | Der Nutzer hat 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 übertragen 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 dieses Element, die sich zum Einbetten auf einer Webseite eignet. |
Document.ICON_URL | Eine URL zu einem Symbol für dieses Element. |
Document.ID | Die ID für das ausgewählte Element. |
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 | Anzahl der in diesem Element enthaltenen untergeordneten Elemente. z. B. die Anzahl der Dateien im ausgewählten Ordner. |
Document.PARENT_ID | Die übergeordnete ID dieses Elements. z. B. den Ordner, der diese Datei enthält. |
Document.SERVICE_ID | Ein ServiceId, das den Service beschreibt, aus dem dieser Artikel ausgewählt wurde. |
Document.THUMBNAILS | Ein Array mit Thumbnail-Elementen, die die Attribute eines Fotos oder Videos beschreiben. Miniaturansichten werden nicht zurückgegeben, wenn die ausgewählten Elemente zu Google Drive gehören. |
Document.TYPE | Das Type des ausgewählten Elements. |
Document.URL | Eine URL zu diesem Artikel. |
Antwort
Response ist ein Aufzählungstyp, der Informationen zu den vom Nutzer ausgewählten Artikeln vermittelt.
Response.ACTION | Ein Action-Typ, der die Aktion des Nutzers zum Schließen des Dialogfelds darstellt. |
Response.DOCUMENTS | Ein Array mit Documents, das der Nutzer ausgewählt hat. |
Response.PARENTS | Die IDs der übergeordneten Ordner für die ausgewählten Elemente. Dazu zählen beispielsweise die IDs der übergeordneten Ordner, deren Dateien ausgewählt wurden. |
Response.VIEW | Das 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 Informationen zu einem ausgewählten Foto oder Video vermittelt. Dieser Wert befindet sich 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. Dieser Wert befindet sich im Feld Document.TYPE einer ausgewählten Document.
Type.DOCUMENT | Das Element ist ein Dokument. |
Type.PHOTO | Das Element ist ein Foto. |
Type.VIDEO | Das Element ist ein Video. |