Method: projects.assets.getPixels
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Récupère les pixels d'un composant Image. Cette méthode personnalisée permet à l'appelant de demander une tuile arbitraire de pixels à partir d'une image, en spécifiant éventuellement les bandes et la projection de la carte. Les données masquées ou manquantes seront encodées en tant que zéros.
Les requêtes sont limitées à 48 Mo de données non compressées par requête, calculées comme le produit des dimensions de la requête en pixels, du nombre de bandes d'image demandées et du nombre d'octets par pixel pour chaque bande. Les requêtes sont également limitées à 32 ko de pixels dans chaque dimension et à 1 024 bandes au maximum. Les requêtes qui dépassent ces limites génèrent un code d'erreur 400 (BAD_REQUEST).
Si la requête aboutit, le corps de la réponse contient les données de pixel demandées dans l'encodage spécifié dans le champ fileFormat de la requête.
Requête HTTP
POST https://earthengine.googleapis.com/v1alpha/{name=projects/*/assets/**}:getPixels
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
| Paramètres |
name |
string
Obligatoire. Nom du composant Image à partir duquel obtenir des pixels. name est au format "projects/*/assets/**" (par exemple, "projects/earthengine-legacy/assets/users/[USER]/[ASSET]"). Tous les composants appartenant à l'utilisateur sont inclus dans le projet "earthengine-legacy" (par exemple, "projects/earthengine-legacy/assets/users/foo/bar"). Tous les autres composants sont associés au projet "earthengine-public" (par exemple, "projects/earthengine-public/assets/LANDSAT").
L'autorisation IAM suivante est requise pour la ressource name indiquée :
|
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
| Champs |
fileFormat |
enum (ImageFileFormat)
Format de fichier de sortie dans lequel renvoyer les valeurs de pixel.
|
grid |
object (PixelGrid)
Paramètres décrivant la grille de pixels dans laquelle extraire les données. Par défaut, la grille de pixels native des données est utilisée.
|
region |
object (Struct format)
Si elle est présente, la région de données à renvoyer, spécifiée en tant qu'objet de géométrie GeoJSON (voir RFC 7946). Étant donné que l'image renvoyée est toujours rectangulaire, la boîte englobante de la géométrie donnée dans le système de coordonnées de sortie est effectivement utilisée. Si grid.dimensions est également spécifié, la grille sera finalement redimensionnée à la taille demandée.
|
bandIds[] |
string
Si présent, spécifie un ensemble spécifique de bandes à partir duquel obtenir des pixels. Les bandes sont identifiées par un ID, comme indiqué par le champ id d'un proto ImageBand.
|
visualizationOptions |
object (VisualizationOptions)
Si présent, ensemble d'options de visualisation à appliquer pour produire une visualisation RVB 8 bits des données, au lieu de renvoyer les données brutes.
|
workloadTag |
string
Balise fournie par l'utilisateur pour suivre ce calcul.
|
Corps de la réponse
Si la requête aboutit, la réponse est une réponse HTTP générique dont le format est défini par la méthode.
Champs d'application des autorisations
Nécessite l'un des champs d'application OAuth suivants :
https://www.googleapis.com/auth/earthengine
https://www.googleapis.com/auth/earthengine.readonly
https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/cloud-platform.read-only
Pour en savoir plus, consultez OAuth 2.0 Overview.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[null,null,["Dernière mise à jour le 2025/07/25 (UTC)."],[[["\u003cp\u003eFetches pixel data from Earth Engine image assets, allowing users to specify desired regions, bands, and output formats.\u003c/p\u003e\n"],["\u003cp\u003eRequests are limited to 48MB of uncompressed data, 32K pixels in each dimension, and 1024 bands; exceeding these limits will result in a 400 error.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful responses contain the requested pixel data in the specified file format, or an 8-bit RGB visualization if visualization options are provided.\u003c/p\u003e\n"],["\u003cp\u003eThe request must specify the image asset name and can optionally include parameters for the output format, pixel grid, region, bands, visualization options, and a workload tag for tracking.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires appropriate IAM permissions or one of the specified OAuth scopes, including 'earthengine', 'earthengine.readonly', 'cloud-platform', or 'cloud-platform.read-only'.\u003c/p\u003e\n"]]],[],null,["# Method: projects.assets.getPixels\n\nFetches pixels from an image asset. This custom method allows the caller to request an arbitrary tile of pixels from an image, optionally specifying the bands and map projection. Masked or missing data will be encoded as zeroes.\n\nRequests are limited to 48MB in uncompressed data per request, computed as the product of the request dimensions in pixels, the number of image bands requested, and the number of bytes per pixel for each band. Requests are also limited to at most 32K pixels in either dimension and at most 1024 bands. Requests exceeding these limits will result in an error code of 400 (BAD_REQUEST).\n\nIf successful, the response body contains the requested pixel data in the encoding specified in the `fileFormat` field of the request.\n\n### HTTP request\n\n`POST https://earthengine.googleapis.com/v1alpha/{name=projects/*/assets/**}:getPixels`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The name of the image asset from which to get pixels. `name` is of the format \"projects/\\*/assets/\\*\\*\" (e.g., \"projects/earthengine-legacy/assets/users/\\[USER\\]/\\[ASSET\\]\"). All user-owned assets are under the project \"earthengine-legacy\" (e.g., \"projects/earthengine-legacy/assets/users/foo/bar\"). All other assets are under the project \"earthengine-public\" (e.g., \"projects/earthengine-public/assets/LANDSAT\"). Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `earthengine.assets.get` |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"fileFormat\": enum (/earth-engine/reference/rest/v1alpha/ImageFileFormat), \"grid\": { object (/earth-engine/reference/rest/v1alpha/PixelGrid) }, \"region\": { object }, \"bandIds\": [ string ], \"visualizationOptions\": { object (/earth-engine/reference/rest/v1alpha/VisualizationOptions) }, \"workloadTag\": string } ``` |\n\n| Fields ||\n|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `fileFormat` | `enum (`[ImageFileFormat](/earth-engine/reference/rest/v1alpha/ImageFileFormat)`)` The output file format in which to return the pixel values. |\n| `grid` | `object (`[PixelGrid](/earth-engine/reference/rest/v1alpha/PixelGrid)`)` Parameters describing the pixel grid in which to fetch data. Defaults to the native pixel grid of the data. |\n| `region` | `object (`[Struct](https://protobuf.dev/reference/protobuf/google.protobuf/#struct)` format)` If present, the region of data to return, specified as a GeoJSON geometry object (see RFC 7946). Since the returned image is always rectangular, the bounding box of the given geometry in the output coordinate system will actually be used. If `grid.dimensions` is also specified then the grid will finally be rescaled to the requested size. |\n| `bandIds[]` | `string` If present, specifies a specific set of bands from which to get pixels. Bands are identified by id, as indicated by the `id` field of an ImageBand proto. |\n| `visualizationOptions` | `object (`[VisualizationOptions](/earth-engine/reference/rest/v1alpha/VisualizationOptions)`)` If present, a set of visualization options to apply to produce an 8-bit RGB visualization of the data, rather than returning the raw data. |\n| `workloadTag` | `string` User supplied tag to track this computation. |\n\n### Response body\n\nIf successful, the response is a generic HTTP response whose format is defined by the method.\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/earthengine`\n- `\n https://www.googleapis.com/auth/earthengine.readonly`\n- `\n https://www.googleapis.com/auth/cloud-platform`\n- `\n https://www.googleapis.com/auth/cloud-platform.read-only`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
