Method: lookupLandscape

  • The lookupLandscape method retrieves landscape data for a given geographical location.

  • The HTTP request is a POST request to https://agriculturalunderstanding.googleapis.com/v1:lookupLandscape.

  • The request body requires a locationSpecifier and optionally includes dataVersion, includeNonAgriculturalAreas, and captureDate.

  • The response body contains a landscape object which includes dataVersion and the landscape data as a GeoJSON string.

Lookup landscape data at a given geographical location.

HTTP request

POST https://agriculturalunderstanding.googleapis.com/v1:lookupLandscape

The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog

Request body

The request body contains data with the following structure:

JSON representation 
{
  "locationSpecifier": {
    object (LocationSpecifier)
  },
  "dataVersion": {
    object (DataVersion)
  },
  "includeNonAgriculturalAreas": boolean,
  "captureDate": {
    object (Date)
  }
}
Fields
locationSpecifier

object (LocationSpecifier)

Required. The location specifier of the landscape.
dataVersion

object (DataVersion)

Optional. The version of the data. If not specified, the latest version will be returned.
includeNonAgriculturalAreas

boolean

Optional. If true, non-agricultural areas (e.g. deserts, hills, cities, etc.) will be included in the response.
captureDate

object (Date)

Optional. If specified, only landscape data captured on this date will be returned.

Response body

Response message for v1.lookupLandscape method.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "landscape": {
    object (Landscape)
  }
}
Fields
landscape

object (Landscape)

The landscape data.

Landscape

Landscape data.

JSON representation 
{
  "dataVersion": {
    object (DataVersion)
  },
  "geojson": string
}
Fields
dataVersion

object (DataVersion)

The data version of the landscape.
geojson

string

The landscape data as a GeoJSON string.

The type of the object is FeatureCollection. See the Feature property for more details about the properties of Feature objects in the FeatureCollection.