ee.data.authenticateViaPrivateKey
Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
Konfiguriert die serverseitige Authentifizierung von EE API-Aufrufen über den Google APIs Node.js-Client. Die Authentifizierung mit privatem Schlüssel ist ausschließlich für serverseitige API-Aufrufe vorgesehen. Für browserbasierte Anwendungen verwenden Sie ee.data.authenticateViaOauth(). Bei der serverseitigen Authentifizierung ist keine Nutzerinteraktion (z. B. ein Authentifizierungs-Pop-up) erforderlich.
Diese oder eine andere Authentifizierungsmethode sollte vor ee.initialize() aufgerufen werden.
Das Autorisierungstoken wird nach Möglichkeit automatisch aktualisiert. Sie können davon ausgehen, dass alle asynchronen Aufrufe mit den entsprechenden Anmeldedaten gesendet werden. Bei synchronen Aufrufen sollten Sie jedoch mit ee.data.getAuthToken() nach einem Authentifizierungstoken suchen und ee.data.refreshAuthToken() manuell aufrufen, wenn keines vorhanden ist. Die Tokenaktualisierung ist ein asynchroner Vorgang und kann nicht im Hintergrund auf Anfrage vor synchronen Aufrufen ausgeführt werden.
| Nutzung | Ausgabe |
|---|
ee.data.authenticateViaPrivateKey(privateKey, success, error, extraScopes, suppressDefaultScopes) | |
| Argument | Typ | Details |
|---|
privateKey | AuthPrivateKey | JSON-Inhalt des privaten Schlüssels. |
success | Funktion (optional) | Die Funktion, die aufgerufen werden soll, wenn die Authentifizierung erfolgreich war. |
error | Funktion (optional) | Die Funktion, die aufgerufen werden soll, wenn die Authentifizierung fehlgeschlagen ist, und die Fehlermeldung. |
extraScopes | List<String>, optional | Zusätzliche OAuth-Bereiche, die angefordert werden sollen. |
suppressDefaultScopes | Boolesch, optional | Wenn „true“, werden nur die in „opt_extraScopes“ angegebenen Bereiche angefordert. Die Standardbereiche werden nur angefordert, wenn sie explizit in „opt_extraScopes“ angegeben sind. |
Sofern nicht anders angegeben, sind die Inhalte dieser Seite unter der Creative Commons Attribution 4.0 License und Codebeispiele unter der Apache 2.0 License lizenziert. Weitere Informationen finden Sie in den Websiterichtlinien von Google Developers. Java ist eine eingetragene Marke von Oracle und/oder seinen Partnern.
Zuletzt aktualisiert: 2025-07-26 (UTC).
[null,null,["Zuletzt aktualisiert: 2025-07-26 (UTC)."],[[["\u003cp\u003eEnables server-side authentication for Earth Engine API calls using a private key, suitable for non-browser environments.\u003c/p\u003e\n"],["\u003cp\u003eAuthentication happens automatically for asynchronous calls, but synchronous calls require manual token checks and refresh using \u003ccode\u003eee.data.getAuthToken()\u003c/code\u003e and \u003ccode\u003eee.data.refreshAuthToken()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eee.data.authenticateViaPrivateKey()\u003c/code\u003e function facilitates this authentication process, accepting the private key and optional success/error callbacks, extra scopes, and a flag to suppress default scopes.\u003c/p\u003e\n"]]],[],null,["# ee.data.authenticateViaPrivateKey\n\n\u003cbr /\u003e\n\nConfigures server-side authentication of EE API calls through the Google APIs Node.js Client. Private key authentication is strictly for server-side API calls: for browser-based applications, use ee.data.authenticateViaOauth(). No user interaction (e.g. authentication popup) is necessary when using server-side authentication.\n\n\u003cbr /\u003e\n\nThis or another authentication method should be called before ee.initialize().\n\nThe auth token will be refreshed automatically when possible. You can safely assume that all async calls will be sent with the appropriate credentials. For synchronous calls, however, you should check for an auth token with ee.data.getAuthToken() and call ee.data.refreshAuthToken() manually if there is none. The token refresh operation is asynchronous and cannot be performed behind-the-scenes, on demand, prior to synchronous calls.\n\n| Usage | Returns |\n|------------------------------------------------------------------------------------------------------------------------|---------|\n| `ee.data.authenticateViaPrivateKey(privateKey, `*success* `, `*error* `, `*extraScopes* `, `*suppressDefaultScopes*`)` | |\n\n| Argument | Type | Details |\n|-------------------------|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `privateKey` | AuthPrivateKey | JSON content of private key. |\n| `success` | Function, optional | The function to call if authentication succeeded. |\n| `error` | Function, optional | The function to call if authentication failed, passed the error message. |\n| `extraScopes` | List\\\u003cString\\\u003e, optional | Extra OAuth scopes to request. |\n| `suppressDefaultScopes` | Boolean, optional | When true, only scopes specified in opt_extraScopes are requested; the default scopes are not not requested unless explicitly specified in opt_extraScopes. |"]]
