Gets a feature tile by its tile resource name.

Required Scalar Argument

  • <name> (string)
    • Required. Resource name of the tile. The tile resource name is prefixed by its collection ID tiles/ followed by the resource ID, which encodes the tile's global x and y coordinates and zoom level as @,,z. For example, tiles/@1,2,3z.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional Method Properties

You may set the following properties to further configure the call. Please note that -p is followed by one or more key-value-pairs, and is called like this -p k1=v1 k2=v2 even though the listing below repeats the -p for completeness.

  • -p always-include-building-footprints=boolean

    • Flag indicating whether the returned tile will always contain 2.5D footprints for structures. If enabled_modeled_volumes is set, this will mean that structures will have both their 3D models and 2.5D footprints returned.

  • -p client-info-api-client=string

    • API client name and version. For example, the SDK calling the API. The exact format is up to the client.

  • -p client-info-application-id=string

    • Application ID, such as the package name on Android and the bundle identifier on iOS platforms.

  • -p client-info-application-version=string

    • Application version number, such as "1.2.3". The exact format is application-dependent.

  • -p client-info-device-model=string

    • Device model as reported by the device. The exact format is platform-dependent.

  • -p client-info-operating-system=string

    • Operating system name and version as reported by the OS. For example, "Mac OS X 10.10.4". The exact format is platform-dependent.

  • -p client-info-platform=string

    • Platform where the application is running.

  • -p client-info-user-id=string

    • Required. A client-generated user ID. The ID should be generated and persisted during the first user session or whenever a pre-existing ID is not found. The exact format is up to the client. This must be non-empty in a GetFeatureTileRequest (whether via the header or GetFeatureTileRequest.client_info).

  • -p client-tile-version-id=string

    • Optional version id identifying the tile that is already in the client's cache. This field should be populated with the most recent version_id value returned by the API for the requested tile. If the version id is empty the server always returns a newly rendered tile. If it is provided the server checks if the tile contents would be identical to one that's already on the client, and if so, returns a stripped-down response tile with STATUS_OK_DATA_UNCHANGED instead.

  • -p enable-detailed-highway-types=boolean

    • Flag indicating whether detailed highway types should be returned. If this is set, the CONTROLLED_ACCESS_HIGHWAY type may be returned. If not, then these highways will have the generic HIGHWAY type. This exists for backwards compatibility reasons.

  • -p enable-feature-names=boolean

    • Flag indicating whether human-readable names should be returned for features. If this is set, the display_name field on the feature will be filled out.

  • -p enable-modeled-volumes=boolean

    • Flag indicating whether 3D building models should be enabled. If this is set structures will be returned as 3D modeled volumes rather than 2.5D extruded areas where possible.

  • -p enable-political-features=boolean

    • Flag indicating whether political features should be returned.

  • -p enable-private-roads=boolean

    • Flag indicating whether the returned tile will contain road features that are marked private. Private roads are indicated by the Feature.segment_info.road_info.is_private field.

  • -p enable-unclipped-buildings=boolean

    • Flag indicating whether unclipped buildings should be returned. If this is set, building render ops will extend beyond the tile boundary. Buildings will only be returned on the tile that contains their centroid.

  • -p language-code=string

    • Required. The BCP-47 language code corresponding to the language in which the name was requested, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

  • -p region-code=string

    • Required. The Unicode country/region code (CLDR) of the location from which the request is coming from, such as "US" and "419". For more information, see http://www.unicode.org/reports/tr35/#unicode_region_subtag.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p $-xgafv=string

    • V1 error format.

  • -p access-token=string

    • OAuth access token.

  • -p alt=string

    • Data format for response.

  • -p callback=string

    • JSONP

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • -p upload-type=string

    • Legacy upload protocol for media (e.g. "media", "multipart").

  • -p upload-protocol=string

    • Upload protocol for media (e.g. "raw", "multipart").