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.

ProximityInfo

A Proximity criterion. The geo point and radius determine what geographical area is included. The address is a description of the geo point that does not affect ad serving.

There are two ways to create a proximity. First, by setting an address and radius. The geo point will be automatically computed. Second, by setting a geo point and radius. The address is an optional label that won't be validated.

JSON representation
{
  "geoPoint": {
    object (GeoPointInfo)
  },
  "radiusUnits": enum (ProximityRadiusUnits),
  "address": {
    object (AddressInfo)
  },
  "radius": number
}
Fields
geoPoint

object (GeoPointInfo)

Latitude and longitude.

radiusUnits

enum (ProximityRadiusUnits)

The unit of measurement of the radius. Default is KILOMETERS.

address

object (AddressInfo)

Full address.

radius

number

The radius of the proximity.

GeoPointInfo

Geo point for proximity criterion.

JSON representation
{
  "longitudeInMicroDegrees": integer,
  "latitudeInMicroDegrees": integer
}
Fields
longitudeInMicroDegrees

integer

Micro degrees for the longitude.

latitudeInMicroDegrees

integer

Micro degrees for the latitude.

ProximityRadiusUnits

The unit of radius distance in proximity (e.g. MILES)

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
MILES Miles
KILOMETERS Kilometers

AddressInfo

Address for proximity criterion.

JSON representation
{
  "postalCode": string,
  "provinceCode": string,
  "countryCode": string,
  "provinceName": string,
  "streetAddress": string,
  "streetAddress2": string,
  "cityName": string
}
Fields
postalCode

string

Postal code.

provinceCode

string

Province or state code.

countryCode

string

Country code.

provinceName

string

Province or state name.

streetAddress

string

Street address line 1.

streetAddress2

string

Street address line 2. This field is write-only. It is only used for calculating the longitude and latitude of an address when geoPoint is empty.

cityName

string

Name of the city.