REST Resource: projects.locations.sites

Resource: Site

A physical site where hardware will be installed.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "organizationContact": {
    object (OrganizationContact)
  },
  "googleMapsPinUri": string,
  "accessTimes": [
    {
      object (TimePeriod)
    }
  ],
  "notes": string,
  "customerSiteId": string
}
Fields
name

string

Identifier. Name of the site. Format: projects/{project}/locations/{location}/sites/{site}
displayName

string

Optional. Display name of this Site.
description

string

Optional. Description of this Site.
createTime

string (Timestamp format)

Output only. Time when this site 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 site was last 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".
labels

map (key: string, value: string)

Optional. Labels associated with this site as key value pairs. For more information about labels, see Create and manage labels.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
organizationContact

object (OrganizationContact)

Required. Contact information for this site.
googleMapsPinUri

string

Optional. A URL to the Google Maps address location of the site. An example value is https://goo.gl/maps/xxxxxxxxx.
accessTimes[]

object (TimePeriod)

Optional. The time periods when the site is accessible. If this field is empty, the site is accessible at all times.

This field is used by Google to schedule the initial installation as well as any later hardware maintenance. You may update this at any time. For example, if the initial installation is requested during off-hours but maintenance should be performed during regular business hours, you should update the access times after initial installation is complete.
notes

string

Optional. Any additional notes for this Site. Please include information about: - security or access restrictions - any regulations affecting the technicians visiting the site - any special process or approval required to move the equipment - whether a representative will be available during site visits
customerSiteId

string

Optional. Customer defined identifier for this Site. This can be used to identify the site in the customer's own systems.

Methods

create

 Creates a new site in a given project and location.

delete

 Deletes a site.

get

 Gets details of a site.

list

 Lists sites in a given project and location.

patch

 Updates the parameters of a site.