REST Resource: verificationTokens

Resource: VerificationToken

A single attempt to get a business owner verified as owner of a particular business.

JSON representation
{
  "name": string,
  "claimStatus": enum(ClaimStatus),
  "businessLead": {
    object(BusinessLead)
  },
  "label": string,
  "programId": string,
  "createTime": string,
  "expireTime": string,
  "verificationCode": string
}
Fields
name

string

Unique resource name of the verification token. It must have the format of "verificationTokens/*". For example: "verificationTokens/123456789".

This value is assigned by the server.

claimStatus

enum(ClaimStatus)

Describes whether a verification token was claimed.

businessLead

object(BusinessLead)

The business information that this API received when this verification token was generated.

label

string

Optional. Label that groups a number of verification tokens together. This could e.g. be the name given to a batch of tokens such as "Outreach_2017-10".

programId

string (int64 format)

The program on behalf of which this operation was authorized.

createTime

string (Timestamp format)

The time at which this token was created. This is not updated after an [expiration window refresh][GenerateVerificationTokenRequest.allow_refresh_existing_token].

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

expireTime

string (Timestamp format)

The time at which this token will expire. This is updated after an [expiration window refresh][GenerateVerificationTokenRequest.allow_refresh_existing_token].

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

verificationCode

string

The verification code, e.g. "AAA-1BB-CC2". This can be used by the business owner to verify that they own the business by going to a prefilled URL in the following form:

https://g.co/pinverify/AAA1BBCC2

(where AAA1BBCC2 is the generated verificationCode without dashes).

ClaimStatus

Describes whether a verification token was claimed.

Enums
CLAIM_STATUS_UNSPECIFIED Not used.
PENDING_CLAIM The associated token has not yet been claimed.
CLAIMED The associated token has been claimed.

BusinessLead

Container that represents the business information that this API received when a verification token was generated.

JSON representation
{
  "location": {
    object(Location)
  }
}
Fields
location

object(Location)

The address and other details that describe how a business could look like on Google Maps.

Location

The address and other details that describe how a business could look like on Google Maps. All fields are optional, except locationName and address.region_code.

JSON representation
{
  "locationName": string,
  "address": {
    object(PostalAddress)
  },
  "primaryPhone": string,
  "websiteUrl": string,
  "primaryCategoryId": string
}
Fields
locationName

string

Required. Name that reflects the business's real-world name, as used on the storefront, website, and stationery, and as known to customers.

Avoid adding unnecessary information to this name (for example, prefer "Google" over "Google Inc. - Mountain View Corporate Headquarters"). Any additional information, when relevant, can be included in other fields of the location (for example, address, primaryCategoryId).

address

object(PostalAddress)

A precise, accurate address to describe the business location. PO boxes or mailboxes located at remote locations are not acceptable. You can specify a maximum of five addressLines values in the address.

All fields are optional, except regionCode.

primaryPhone

string

Optional. A phone number in E.164 format that connects to the individual business location as directly as possible. This should be a local phone number instead of a central, call center helpline number whenever possible.

Example: "+441234567890".

websiteUrl

string

Optional. A URL for the business. If possible, use a URL that represents this individual business location instead of a generic website/URL that represents all locations, or the brand.

Example: "https://www.example.com/foo/".

primaryCategoryId

string

Optional. The ID of the category that best describes what the business is (not what it does).

Examples of typical category IDs:

  • "gcid:restaurant"
  • "gcid:cafe"
  • "gcid:bar"
  • "gcid:grocery_store"
  • "gcid:supermarket"
  • "gcid:bakery"
  • "gcid:clothing_store"
  • "gcid:shoe_store"
  • "gcid:shopping_center"
  • "gcid:beauty_salon"
  • "gcid:hair_salon"
  • "gcid:pharmacy"
  • "gcid:bank"
  • "gcid:hotel"

When picking a category ID, please use this list or ask your contact person at Google. When in doubt or the category is unknown, please omit this field.

PostalAddress

Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains).

In typical usage an address would be created via user input or from importing existing data, depending on the type of process.

Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used.

For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478

JSON representation
{
  "revision": number,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Fields
revision

number

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision.

All new revisions must be backward compatible with old revisions.

regionCode

string

Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.

languageCode

string

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations.

If this value is not known, it should be omitted (rather than specifying a possibly incorrect default).

Examples: "zh-Hant", "ja", "ja-Latn", "en".

postalCode

string

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

sortingCode

string

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).

administrativeArea

string

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

locality

string

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines.

sublocality

string

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

addressLines[]

string

Unstructured address lines describing the lower levels of an address.

Because values in addressLines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language.

The minimum permitted structural representation of an address consists of a regionCode with all remaining information placed in the addressLines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved.

Creating an address only containing a regionCode and addressLines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

recipients[]

string

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.

organization

string

Optional. The name of the organization at the address.

Methods

generate

Generates or optionally refreshes a token for verifying any user as owner of a business.

get

Gets a previously generated verification token.