Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: geoTargetConstants

Resource: GeoTargetConstant

A geo target constant.

JSON representation
{
  "resourceName": string,
  "status": enum (GeoTargetConstantStatus),
  "id": string,
  "name": string,
  "countryCode": string,
  "targetType": string,
  "canonicalName": string,
  "parentGeoTarget": string
}
Fields
resourceName

string

Output only. The resource name of the geo target constant. Geo target constant resource names have the form:

geoTargetConstants/{geo_target_constant_id}

status

enum (GeoTargetConstantStatus)

Output only. Geo target constant status.

id

string (int64 format)

Output only. The ID of the geo target constant.

name

string

Output only. Geo target constant English name.

countryCode

string

Output only. The ISO-3166-1 alpha-2 country code that is associated with the target.

targetType

string

Output only. Geo target constant target type.

canonicalName

string

Output only. The fully qualified English name, consisting of the target's name and that of its parent and country.

parentGeoTarget

string

Output only. The resource name of the parent geo target constant. Geo target constant resource names have the form:

geoTargetConstants/{parent_geo_target_constant_id}

GeoTargetConstantStatus

The possible statuses of a geo target constant.

Enums
UNSPECIFIED No value has been specified.
UNKNOWN

The received value is not known in this version.

This is a response-only value.

ENABLED The geo target constant is valid.
REMOVAL_PLANNED The geo target constant is obsolete and will be removed.

Methods

get

Returns the requested geo target constant in full detail.

suggest

Returns GeoTargetConstant suggestions by location name or by resource name.