Anúncio: todos os projetos não comerciais registrados para usar o Earth Engine antes de
15 de abril de 2025 precisam
verificar a qualificação não comercial para manter o acesso ao Earth Engine.
Method: projects.assets.getPixels
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Busca pixels de um recurso de imagem. Esse método personalizado permite que o autor da chamada solicite um bloco arbitrário de pixels de uma imagem, especificando opcionalmente as bandas e a projeção do mapa. Os dados mascarados ou ausentes serão codificados como zeros.
As solicitações são limitadas a 48 MB de dados descompactados por solicitação, calculados como o produto das dimensões da solicitação em pixels, o número de bandas de imagem solicitadas e o número de bytes por pixel para cada banda. As solicitações também são limitadas a no máximo 32K pixels em cada dimensão e no máximo 1.024 bandas. As solicitações que excederem esses limites resultarão em um código de erro 400 (BAD_REQUEST).
Se bem-sucedido, o corpo da resposta conterá os dados de pixel solicitados na codificação especificada no campo fileFormat
da solicitação.
Solicitação HTTP
POST https://earthengine.googleapis.com/v1alpha/{name=projects/*/assets/**}:getPixels
O URL usa a sintaxe de transcodificação gRPC.
Parâmetros de caminho
Parâmetros |
name |
string
Obrigatório. O nome do recurso de imagem de onde os pixels serão extraídos. name tem o formato "projects/*/assets/**" (por exemplo, "projects/earthengine-legacy/assets/users/[USER]/[ASSET]"). Todos os recursos de propriedade do usuário estão no projeto "earthengine-legacy" (por exemplo, "projects/earthengine-legacy/assets/users/foo/bar"). Todos os outros recursos estão no projeto "earthengine-public" (por exemplo, "projects/earthengine-public/assets/LANDSAT").
A autorização requer a seguinte permissão do IAM no recurso especificado name :
|
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Campos |
fileFormat |
enum (ImageFileFormat )
O formato do arquivo de saída em que os valores de pixel serão retornados.
|
grid |
object (PixelGrid )
Parâmetros que descrevem a grade de pixels em que os dados serão buscados. O padrão é a grade de pixels nativa dos dados.
|
region |
object (Struct format)
Se presente, a região dos dados a serem retornados, especificada como um objeto de geometria GeoJSON (consulte RFC 7946). Como a imagem retornada é sempre retangular, a caixa delimitadora da geometria especificada no sistema de coordenadas de saída será usada. Se grid.dimensions também for especificado, a grade será redimensionada para o tamanho solicitado.
|
bandIds[] |
string
Se presente, especifica um conjunto específico de bandas para extrair pixels. As bandas são identificadas por ID, conforme indicado pelo campo id de um proto de ImageBand.
|
visualizationOptions |
object (VisualizationOptions )
Se presente, um conjunto de opções de visualização a serem aplicadas para produzir uma visualização RGB de 8 bits dos dados, em vez de retornar os dados brutos.
|
workloadTag |
string
Tag fornecida pelo usuário para acompanhar esse cálculo.
|
Corpo da resposta
Se for bem-sucedida, a resposta será uma resposta HTTP genérica que tem o formato definido pelo método.
Escopos de autorização
Requer um dos seguintes escopos do OAuth:
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
Para mais informações, consulte OAuth 2.0 Overview.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-25 UTC.
[null,null,["Última atualização 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)."]]