REST Resource: accounts.regions

Resource: Region

A Region allows advertisers to target a specific geographic region, such as New York City. For example, companies provides their services in the New York City area can use a Region to run ads in the specified GeographicalRegion.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "state": enum (State),
  "title": string,
  "phone": string,
  "uri": string,
  "displayUri": string,
  "geographicalRegion": string,
  "additionalInfo": string
}
Fields
name

string

The resource name of the Region. Format: accounts/{account}/regions/{region}

createTime

string (Timestamp format)

Output only. Time when this region was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Output only. Time when this region was most recently updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

state

enum (State)

Required. Determines whether the Region is active. A Region that isn't active doesn't appear in advertising campaigns, even if explicitly included. Regions can only be created in the ACTIVE or PAUSED states. This field can only be changed with the state transition methods regions.activate and regions.pause, not regions.patch.

title

string

Required. Title of this Region. For details on how to format this data, see this help center article.

The maximum length is 30 characters.

phone

string

Phone number for this Region.

The maximum length is 20 characters.

uri

string

URI opened in a Waze driver's browser for this Region.

The maximum length is 500 characters.

displayUri

string

URI text shown to Waze drivers for this Region.

The maximum length is 500 characters.

geographicalRegion

string

Required. The resource name of the GeographicalRegion this Region describes. A search for available GeographicalRegions is provided by geographicalRegions.search.

additionalInfo

string

Additional Region information to show in the ad.

The maximum length is 70 characters.

State

Region state.

Enums
STATE_UNSPECIFIED State unspecified.
ACTIVE Region is active, so ads can be served for the region.
PAUSED Region is paused, so ads aren't served for the region.

Methods

activate

Activates a region.

create

Creates a new region.

get

Returns the requested region.

list

Lists the regions from an account, ordered by name.

patch

Updates an existing region.

pause

Pauses a region.