proximitybeacon

package
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 24, 2019 License: BSD-3-Clause Imports: 14 Imported by: 0

Documentation

Overview

Package proximitybeacon provides access to the Proximity Beacon API.

For product documentation, see: https://developers.google.com/beacons/proximity/

Creating a client

Usage example: 

import "google.golang.org/api/proximitybeacon/v1beta1"
...
ctx := context.Background()
proximitybeaconService, err := proximitybeacon.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey: 

proximitybeaconService, err := proximitybeacon.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource: 

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
proximitybeaconService, err := proximitybeacon.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source 
const (
	// View and modify your beacons
	UserlocationBeaconRegistryScope = "https://www.googleapis.com/auth/userlocation.beacon.registry"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AdvertisedId 

type AdvertisedId struct {
	// Id: The actual beacon identifier, as broadcast by the beacon
	// hardware. Must
	// be
	// [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in
	// HTTP
	// requests, and will be so encoded (with padding) in responses. The
	// base64
	// encoding should be of the binary byte-stream and not any textual
	// (such as
	// hex) representation thereof.
	// Required.
	Id string `json:"id,omitempty"`

	// Type: Specifies the identifier type.
	// Required.
	//
	// Possible values:
	//   "TYPE_UNSPECIFIED" - Do not use this value.
	//   "EDDYSTONE" - Eddystone, an open beacon format that supports
	// Android and iOS
	// devices
	// https://github.com/google/eddystone/wiki/Beacon-Specification
	//   "IBEACON" - Apple iBeacon compatible beacon
	//   "ALTBEACON" - See http://altbeacon.org and/or
	// https://github.com/AltBeacon/spec.
	//   "EDDYSTONE_EID" - Eddystone Ephemeral ID
	Type string `json:"type,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Id") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Id") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AdvertisedId: Defines a unique identifier of a beacon as broadcast by the device.

func (*AdvertisedId) MarshalJSON 

func (s *AdvertisedId) MarshalJSON() ([]byte, error)

type AttachmentInfo 

type AttachmentInfo struct {
	// Data: An opaque data container for client-provided data.
	Data string `json:"data,omitempty"`

	// MaxDistanceMeters: The distance away from the beacon at which this
	// attachment should be
	// delivered to a mobile app.
	//
	// Setting this to a value greater than zero indicates that the app
	// should
	// behave as if the beacon is "seen" when the mobile device is less than
	// this
	// distance away from the beacon.
	//
	// Different attachments on the same beacon can have different max
	// distances.
	//
	// Note that even though this value is expressed with fractional
	// meter
	// precision, real-world behavior is likley to be much less precise than
	// one
	// meter, due to the nature of current Bluetooth radio
	// technology.
	//
	// Optional. When not set or zero, the attachment should be delivered at
	// the
	// beacon's outer limit of detection.
	MaxDistanceMeters float64 `json:"maxDistanceMeters,omitempty"`

	// NamespacedType: Specifies what kind of attachment this is. Tells a
	// client how to
	// interpret the `data` field. Format is <var>namespace/type</var>,
	// for
	// example <code>scrupulous-wombat-12345/welcome-message</code>
	NamespacedType string `json:"namespacedType,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Data") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Data") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

AttachmentInfo: A subset of attachment information served via the `beaconinfo.getforobserved` method, used when your users encounter your beacons.

func (*AttachmentInfo) MarshalJSON 

func (s *AttachmentInfo) MarshalJSON() ([]byte, error)

func (*AttachmentInfo) UnmarshalJSON 

func (s *AttachmentInfo) UnmarshalJSON(data []byte) error

type Beacon 

type Beacon struct {
	// AdvertisedId: The identifier of a beacon as advertised by it. This
	// field must be
	// populated when registering. It may be empty when updating a
	// beacon
	// record because it is ignored in updates.
	//
	// When registering a beacon that broadcasts Eddystone-EID, this
	// field
	// should contain a "stable" Eddystone-UID that identifies the beacon
	// and
	// links it to its attachments. The stable Eddystone-UID is only used
	// for
	// administering the beacon.
	AdvertisedId *AdvertisedId `json:"advertisedId,omitempty"`

	// BeaconName: Resource name of this beacon. A beacon name has the
	// format
	// "beacons/N!beaconId" where the beaconId is the base16 ID broadcast
	// by
	// the beacon and N is a code for the beacon's type. Possible values
	// are
	// `3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.
	//
	// This field must be left empty when registering. After reading a
	// beacon,
	// clients can use the name for future operations.
	BeaconName string `json:"beaconName,omitempty"`

	// Description: Free text used to identify and describe the beacon.
	// Maximum length 140
	// characters.
	// Optional.
	Description string `json:"description,omitempty"`

	// EphemeralIdRegistration: Write-only registration parameters for
	// beacons using Eddystone-EID
	// (remotely resolved ephemeral ID) format. This information will not
	// be
	// populated in API responses. When submitting this data, the
	// `advertised_id`
	// field must contain an ID of type Eddystone-UID. Any other ID type
	// will
	// result in an error.
	EphemeralIdRegistration *EphemeralIdRegistration `json:"ephemeralIdRegistration,omitempty"`

	// ExpectedStability: Expected location stability. This is set when the
	// beacon is registered or
	// updated, not automatically detected in any way.
	// Optional.
	//
	// Possible values:
	//   "STABILITY_UNSPECIFIED" - Do not use this value.
	//   "STABLE" - Not expected to move, for example a store's front door.
	//   "PORTABLE" - Usually stable but may move rarely, usually within a
	// single place,
	// for example a store display.
	//   "MOBILE" - Moves frequently, for example a personal item or food
	// truck.
	//   "ROVING" - Moves continuously in service, for example a bus or
	// train.
	ExpectedStability string `json:"expectedStability,omitempty"`

	// IndoorLevel: The indoor level information for this beacon, if known.
	// As returned by the
	// Google Maps API.
	// Optional.
	IndoorLevel *IndoorLevel `json:"indoorLevel,omitempty"`

	// LatLng: The location of the beacon, expressed as a latitude and
	// longitude pair.
	// This location is given when the beacon is registered or updated. It
	// does
	// not necessarily indicate the actual current location of the
	// beacon.
	// Optional.
	LatLng *LatLng `json:"latLng,omitempty"`

	// PlaceId: The [Google Places API](/places/place-id) Place ID of the
	// place where
	// the beacon is deployed. This is given when the beacon is registered
	// or
	// updated, not automatically detected in any way.
	// Optional.
	PlaceId string `json:"placeId,omitempty"`

	// Properties: Properties of the beacon device, for example battery type
	// or firmware
	// version.
	// Optional.
	Properties map[string]string `json:"properties,omitempty"`

	// ProvisioningKey: Some beacons may require a user to provide an
	// authorization key before
	// changing any of its configuration (e.g. broadcast frames, transmit
	// power).
	// This field provides a place to store and control access to that
	// key.
	// This field is populated in responses to `GET
	// /v1beta1/beacons/3!beaconId`
	// from users with write access to the given beacon. That is to say: If
	// the
	// user is authorized to write the beacon's confidential data in the
	// service,
	// the service considers them authorized to configure the beacon.
	// Note
	// that this key grants nothing on the service, only on the beacon
	// itself.
	ProvisioningKey string `json:"provisioningKey,omitempty"`

	// Status: Current status of the beacon.
	// Required.
	//
	// Possible values:
	//   "STATUS_UNSPECIFIED" - Do not use this value.
	//   "ACTIVE" - The "normal" in-use state of a beacon.
	//   "DECOMMISSIONED" - Beacon should no longer be used for any purpose.
	// This is irreversible.
	//   "INACTIVE" - The beacon should not be visible to mobile devices.
	// This is reversible.
	Status string `json:"status,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AdvertisedId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AdvertisedId") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Beacon: Details of a beacon device.

func (*Beacon) MarshalJSON 

func (s *Beacon) MarshalJSON() ([]byte, error)

type BeaconAttachment 

type BeaconAttachment struct {
	// AttachmentName: Resource name of this attachment. Attachment names
	// have the
	// format:
	// <code>beacons/<var>beacon_id</var>/attachments/<var>attachment
	// _id</var></code>.
	// Leave this empty on creation.
	AttachmentName string `json:"attachmentName,omitempty"`

	// CreationTimeMs: The UTC time when this attachment was created, in
	// milliseconds since the
	// UNIX epoch.
	CreationTimeMs string `json:"creationTimeMs,omitempty"`

	// Data: An opaque data container for client-provided data. Must
	// be
	// [base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in
	// HTTP
	// requests, and will be so encoded (with padding) in
	// responses.
	// Required.
	Data string `json:"data,omitempty"`

	// MaxDistanceMeters: The distance away from the beacon at which this
	// attachment should be
	// delivered to a mobile app.
	//
	// Setting this to a value greater than zero indicates that the app
	// should
	// behave as if the beacon is "seen" when the mobile device is less than
	// this
	// distance away from the beacon.
	//
	// Different attachments on the same beacon can have different max
	// distances.
	//
	// Note that even though this value is expressed with fractional
	// meter
	// precision, real-world behavior is likley to be much less precise than
	// one
	// meter, due to the nature of current Bluetooth radio
	// technology.
	//
	// Optional. When not set or zero, the attachment should be delivered at
	// the
	// beacon's outer limit of detection.
	//
	// Negative values are invalid and return an error.
	MaxDistanceMeters float64 `json:"maxDistanceMeters,omitempty"`

	// NamespacedType: Specifies what kind of attachment this is. Tells a
	// client how to
	// interpret the `data` field. Format is <var>namespace/type</var>.
	// Namespace
	// provides type separation between clients. Type describes the type
	// of
	// `data`, for use by the client when parsing the `data`
	// field.
	// Required.
	NamespacedType string `json:"namespacedType,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "AttachmentName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AttachmentName") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

BeaconAttachment: Project-specific data associated with a beacon.

func (*BeaconAttachment) MarshalJSON 

func (s *BeaconAttachment) MarshalJSON() ([]byte, error)

func (*BeaconAttachment) UnmarshalJSON 

func (s *BeaconAttachment) UnmarshalJSON(data []byte) error

type BeaconInfo 

type BeaconInfo struct {
	// AdvertisedId: The ID advertised by the beacon.
	AdvertisedId *AdvertisedId `json:"advertisedId,omitempty"`

	// Attachments: Attachments matching the type(s) requested.
	// May be empty if no attachment types were requested.
	Attachments []*AttachmentInfo `json:"attachments,omitempty"`

	// BeaconName: The name under which the beacon is registered.
	BeaconName string `json:"beaconName,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AdvertisedId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AdvertisedId") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BeaconInfo: A subset of beacon information served via the `beaconinfo.getforobserved` method, which you call when users of your app encounter your beacons.

func (*BeaconInfo) MarshalJSON 

func (s *BeaconInfo) MarshalJSON() ([]byte, error)

type BeaconinfoGetforobservedCall 

type BeaconinfoGetforobservedCall struct {
	// contains filtered or unexported fields
}

func (*BeaconinfoGetforobservedCall) Context 

func (c *BeaconinfoGetforobservedCall) Context(ctx context.Context) *BeaconinfoGetforobservedCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*BeaconinfoGetforobservedCall) Do 

func (c *BeaconinfoGetforobservedCall) Do(opts ...googleapi.CallOption) (*GetInfoForObservedBeaconsResponse, error)

Do executes the "proximitybeacon.beaconinfo.getforobserved" call. Exactly one of *GetInfoForObservedBeaconsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *GetInfoForObservedBeaconsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BeaconinfoGetforobservedCall) Fields 

func (c *BeaconinfoGetforobservedCall) Fields(s ...googleapi.Field) *BeaconinfoGetforobservedCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*BeaconinfoGetforobservedCall) Header 

func (c *BeaconinfoGetforobservedCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type BeaconinfoService 

type BeaconinfoService struct {
	// contains filtered or unexported fields
}

func NewBeaconinfoService 

func NewBeaconinfoService(s *Service) *BeaconinfoService

func (*BeaconinfoService) Getforobserved 

func (r *BeaconinfoService) Getforobserved(getinfoforobservedbeaconsrequest *GetInfoForObservedBeaconsRequest) *BeaconinfoGetforobservedCall

Getforobserved: Given one or more beacon observations, returns any beacon information and attachments accessible to your application. Authorize by using the [API key](https://developers.google.com/beacons/proximity/get-started#reque st_a_browser_api_key) for the application.

type BeaconsActivateCall 

type BeaconsActivateCall struct {
	// contains filtered or unexported fields
}

func (*BeaconsActivateCall) Context 

func (c *BeaconsActivateCall) Context(ctx context.Context) *BeaconsActivateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*BeaconsActivateCall) Do 

func (c *BeaconsActivateCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "proximitybeacon.beacons.activate" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BeaconsActivateCall) Fields 

func (c *BeaconsActivateCall) Fields(s ...googleapi.Field) *BeaconsActivateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*BeaconsActivateCall) Header 

func (c *BeaconsActivateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*BeaconsActivateCall) ProjectId 

func (c *BeaconsActivateCall) ProjectId(projectId string) *BeaconsActivateCall

ProjectId sets the optional parameter "projectId": The project id of the beacon to activate. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon.

type BeaconsAttachmentsBatchDeleteCall 

type BeaconsAttachmentsBatchDeleteCall struct {
	// contains filtered or unexported fields
}

func (*BeaconsAttachmentsBatchDeleteCall) Context 

func (c *BeaconsAttachmentsBatchDeleteCall) Context(ctx context.Context) *BeaconsAttachmentsBatchDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*BeaconsAttachmentsBatchDeleteCall) Do 

func (c *BeaconsAttachmentsBatchDeleteCall) Do(opts ...googleapi.CallOption) (*DeleteAttachmentsResponse, error)

Do executes the "proximitybeacon.beacons.attachments.batchDelete" call. Exactly one of *DeleteAttachmentsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *DeleteAttachmentsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BeaconsAttachmentsBatchDeleteCall) Fields 

func (c *BeaconsAttachmentsBatchDeleteCall) Fields(s ...googleapi.Field) *BeaconsAttachmentsBatchDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*BeaconsAttachmentsBatchDeleteCall) Header 

func (c *BeaconsAttachmentsBatchDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*BeaconsAttachmentsBatchDeleteCall) NamespacedType 

func (c *BeaconsAttachmentsBatchDeleteCall) NamespacedType(namespacedType string) *BeaconsAttachmentsBatchDeleteCall

NamespacedType sets the optional parameter "namespacedType": Specifies the namespace and type of attachments to delete in `namespace/type` format. Accepts `*/*` to specify "all types in all namespaces".

func (*BeaconsAttachmentsBatchDeleteCall) ProjectId 

func (c *BeaconsAttachmentsBatchDeleteCall) ProjectId(projectId string) *BeaconsAttachmentsBatchDeleteCall

ProjectId sets the optional parameter "projectId": The project id to delete beacon attachments under. This field can be used when "*" is specified to mean all attachment namespaces. Projects may have multiple attachments with multiple namespaces. If "*" is specified and the projectId string is empty, then the project making the request is used.

type BeaconsAttachmentsCreateCall 

type BeaconsAttachmentsCreateCall struct {
	// contains filtered or unexported fields
}

func (*BeaconsAttachmentsCreateCall) Context 

func (c *BeaconsAttachmentsCreateCall) Context(ctx context.Context) *BeaconsAttachmentsCreateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*BeaconsAttachmentsCreateCall) Do 

func (c *BeaconsAttachmentsCreateCall) Do(opts ...googleapi.CallOption) (*BeaconAttachment, error)

Do executes the "proximitybeacon.beacons.attachments.create" call. Exactly one of *BeaconAttachment or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *BeaconAttachment.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BeaconsAttachmentsCreateCall) Fields 

func (c *BeaconsAttachmentsCreateCall) Fields(s ...googleapi.Field) *BeaconsAttachmentsCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*BeaconsAttachmentsCreateCall) Header 

func (c *BeaconsAttachmentsCreateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*BeaconsAttachmentsCreateCall) ProjectId 

func (c *BeaconsAttachmentsCreateCall) ProjectId(projectId string) *BeaconsAttachmentsCreateCall

ProjectId sets the optional parameter "projectId": The project id of the project the attachment will belong to. If the project id is not specified then the project making the request is used.

type BeaconsAttachmentsDeleteCall 

type BeaconsAttachmentsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*BeaconsAttachmentsDeleteCall) Context 

func (c *BeaconsAttachmentsDeleteCall) Context(ctx context.Context) *BeaconsAttachmentsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*BeaconsAttachmentsDeleteCall) Do 

func (c *BeaconsAttachmentsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "proximitybeacon.beacons.attachments.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BeaconsAttachmentsDeleteCall) Fields 

func (c *BeaconsAttachmentsDeleteCall) Fields(s ...googleapi.Field) *BeaconsAttachmentsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*BeaconsAttachmentsDeleteCall) Header 

func (c *BeaconsAttachmentsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*BeaconsAttachmentsDeleteCall) ProjectId 

func (c *BeaconsAttachmentsDeleteCall) ProjectId(projectId string) *BeaconsAttachmentsDeleteCall

ProjectId sets the optional parameter "projectId": The project id of the attachment to delete. If not provided, the project that is making the request is used.

type BeaconsAttachmentsListCall 

type BeaconsAttachmentsListCall struct {
	// contains filtered or unexported fields
}

func (*BeaconsAttachmentsListCall) Context 

func (c *BeaconsAttachmentsListCall) Context(ctx context.Context) *BeaconsAttachmentsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*BeaconsAttachmentsListCall) Do 

func (c *BeaconsAttachmentsListCall) Do(opts ...googleapi.CallOption) (*ListBeaconAttachmentsResponse, error)

Do executes the "proximitybeacon.beacons.attachments.list" call. Exactly one of *ListBeaconAttachmentsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListBeaconAttachmentsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BeaconsAttachmentsListCall) Fields 

func (c *BeaconsAttachmentsListCall) Fields(s ...googleapi.Field) *BeaconsAttachmentsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*BeaconsAttachmentsListCall) Header 

func (c *BeaconsAttachmentsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*BeaconsAttachmentsListCall) IfNoneMatch 

func (c *BeaconsAttachmentsListCall) IfNoneMatch(entityTag string) *BeaconsAttachmentsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*BeaconsAttachmentsListCall) NamespacedType 

func (c *BeaconsAttachmentsListCall) NamespacedType(namespacedType string) *BeaconsAttachmentsListCall

NamespacedType sets the optional parameter "namespacedType": Specifies the namespace and type of attachment to include in response in <var>namespace/type</var> format. Accepts `*/*` to specify "all types in all namespaces".

func (*BeaconsAttachmentsListCall) ProjectId 

func (c *BeaconsAttachmentsListCall) ProjectId(projectId string) *BeaconsAttachmentsListCall

ProjectId sets the optional parameter "projectId": The project id to list beacon attachments under. This field can be used when "*" is specified to mean all attachment namespaces. Projects may have multiple attachments with multiple namespaces. If "*" is specified and the projectId string is empty, then the project making the request is used.

type BeaconsAttachmentsService 

type BeaconsAttachmentsService struct {
	// contains filtered or unexported fields
}

func NewBeaconsAttachmentsService 

func NewBeaconsAttachmentsService(s *Service) *BeaconsAttachmentsService

func (*BeaconsAttachmentsService) BatchDelete 

func (r *BeaconsAttachmentsService) BatchDelete(beaconName string) *BeaconsAttachmentsBatchDeleteCall

BatchDelete: Deletes multiple attachments on a given beacon. This operation is permanent and cannot be undone.

You can optionally specify `namespacedType` to choose which attachments should be deleted. If you do not specify `namespacedType`, all your attachments on the given beacon will be deleted. You also may explicitly specify `*/*` to delete all.

Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

func (*BeaconsAttachmentsService) Create 

func (r *BeaconsAttachmentsService) Create(beaconName string, beaconattachment *BeaconAttachment) *BeaconsAttachmentsCreateCall

Create: Associates the given data with the specified beacon. Attachment data must contain two parts: <ul> <li>A namespaced type.</li> <li>The actual attachment data itself.</li> </ul> The namespaced type consists of two parts, the namespace and the type. The namespace must be one of the values returned by the `namespaces` endpoint, while the type can be a string of any characters except for the forward slash (`/`) up to 100 characters in length.

Attachment data can be up to 1024 bytes long.

Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

func (*BeaconsAttachmentsService) Delete 

func (r *BeaconsAttachmentsService) Delete(attachmentName string) *BeaconsAttachmentsDeleteCall

Delete: Deletes the specified attachment for the given beacon. Each attachment has a unique attachment name (`attachmentName`) which is returned when you fetch the attachment data via this API. You specify this with the delete request to control which attachment is removed. This operation cannot be undone.

Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

func (*BeaconsAttachmentsService) List 

func (r *BeaconsAttachmentsService) List(beaconName string) *BeaconsAttachmentsListCall

List: Returns the attachments for the specified beacon that match the specified namespaced-type pattern.

To control which namespaced types are returned, you add the `namespacedType` query parameter to the request. You must either use `*/*`, to return all attachments, or the namespace must be one of the ones returned from the `namespaces` endpoint.

Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.

type BeaconsDeactivateCall 

type BeaconsDeactivateCall struct {
	// contains filtered or unexported fields
}

func (*BeaconsDeactivateCall) Context 

func (c *BeaconsDeactivateCall) Context(ctx context.Context) *BeaconsDeactivateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*BeaconsDeactivateCall) Do 

func (c *BeaconsDeactivateCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "proximitybeacon.beacons.deactivate" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BeaconsDeactivateCall) Fields 

func (c *BeaconsDeactivateCall) Fields(s ...googleapi.Field) *BeaconsDeactivateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*BeaconsDeactivateCall) Header 

func (c *BeaconsDeactivateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*BeaconsDeactivateCall) ProjectId 

func (c *BeaconsDeactivateCall) ProjectId(projectId string) *BeaconsDeactivateCall

ProjectId sets the optional parameter "projectId": The project id of the beacon to deactivate. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon.

type BeaconsDecommissionCall 

type BeaconsDecommissionCall struct {
	// contains filtered or unexported fields
}

func (*BeaconsDecommissionCall) Context 

func (c *BeaconsDecommissionCall) Context(ctx context.Context) *BeaconsDecommissionCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*BeaconsDecommissionCall) Do 

func (c *BeaconsDecommissionCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "proximitybeacon.beacons.decommission" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BeaconsDecommissionCall) Fields 

func (c *BeaconsDecommissionCall) Fields(s ...googleapi.Field) *BeaconsDecommissionCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*BeaconsDecommissionCall) Header 

func (c *BeaconsDecommissionCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*BeaconsDecommissionCall) ProjectId 

func (c *BeaconsDecommissionCall) ProjectId(projectId string) *BeaconsDecommissionCall

ProjectId sets the optional parameter "projectId": The project id of the beacon to decommission. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon.

type BeaconsDeleteCall 

type BeaconsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*BeaconsDeleteCall) Context 

func (c *BeaconsDeleteCall) Context(ctx context.Context) *BeaconsDeleteCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*BeaconsDeleteCall) Do 

func (c *BeaconsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, error)

Do executes the "proximitybeacon.beacons.delete" call. Exactly one of *Empty or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Empty.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BeaconsDeleteCall) Fields 

func (c *BeaconsDeleteCall) Fields(s ...googleapi.Field) *BeaconsDeleteCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*BeaconsDeleteCall) Header 

func (c *BeaconsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*BeaconsDeleteCall) ProjectId 

func (c *BeaconsDeleteCall) ProjectId(projectId string) *BeaconsDeleteCall

ProjectId sets the optional parameter "projectId": The project id of the beacon to delete. If not provided, the project that is making the request is used.

type BeaconsDiagnosticsListCall 

type BeaconsDiagnosticsListCall struct {
	// contains filtered or unexported fields
}

func (*BeaconsDiagnosticsListCall) AlertFilter 

func (c *BeaconsDiagnosticsListCall) AlertFilter(alertFilter string) *BeaconsDiagnosticsListCall

AlertFilter sets the optional parameter "alertFilter": Requests only beacons that have the given alert. For example, to find beacons that have low batteries use `alert_filter=LOW_BATTERY`.

Possible values: 

"ALERT_UNSPECIFIED"
"WRONG_LOCATION"
"LOW_BATTERY"
"LOW_ACTIVITY"

func (*BeaconsDiagnosticsListCall) Context 

func (c *BeaconsDiagnosticsListCall) Context(ctx context.Context) *BeaconsDiagnosticsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*BeaconsDiagnosticsListCall) Do 

func (c *BeaconsDiagnosticsListCall) Do(opts ...googleapi.CallOption) (*ListDiagnosticsResponse, error)

Do executes the "proximitybeacon.beacons.diagnostics.list" call. Exactly one of *ListDiagnosticsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListDiagnosticsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BeaconsDiagnosticsListCall) Fields 

func (c *BeaconsDiagnosticsListCall) Fields(s ...googleapi.Field) *BeaconsDiagnosticsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*BeaconsDiagnosticsListCall) Header 

func (c *BeaconsDiagnosticsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*BeaconsDiagnosticsListCall) IfNoneMatch 

func (c *BeaconsDiagnosticsListCall) IfNoneMatch(entityTag string) *BeaconsDiagnosticsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*BeaconsDiagnosticsListCall) PageSize 

func (c *BeaconsDiagnosticsListCall) PageSize(pageSize int64) *BeaconsDiagnosticsListCall

PageSize sets the optional parameter "pageSize": Specifies the maximum number of results to return. Defaults to 10. Maximum 1000.

func (*BeaconsDiagnosticsListCall) PageToken 

func (c *BeaconsDiagnosticsListCall) PageToken(pageToken string) *BeaconsDiagnosticsListCall

PageToken sets the optional parameter "pageToken": Requests results that occur after the `page_token`, obtained from the response to a previous request.

func (*BeaconsDiagnosticsListCall) Pages 

func (c *BeaconsDiagnosticsListCall) Pages(ctx context.Context, f func(*ListDiagnosticsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*BeaconsDiagnosticsListCall) ProjectId 

func (c *BeaconsDiagnosticsListCall) ProjectId(projectId string) *BeaconsDiagnosticsListCall

ProjectId sets the optional parameter "projectId": Requests only diagnostic records for the given project id. If not set, then the project making the request will be used for looking up diagnostic records.

type BeaconsDiagnosticsService 

type BeaconsDiagnosticsService struct {
	// contains filtered or unexported fields
}

func NewBeaconsDiagnosticsService 

func NewBeaconsDiagnosticsService(s *Service) *BeaconsDiagnosticsService

func (*BeaconsDiagnosticsService) List 

func (r *BeaconsDiagnosticsService) List(beaconName string) *BeaconsDiagnosticsListCall

List: List the diagnostics for a single beacon. You can also list diagnostics for all the beacons owned by your Google Developers Console project by using the beacon name `beacons/-`.

Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.

type BeaconsGetCall 

type BeaconsGetCall struct {
	// contains filtered or unexported fields
}

func (*BeaconsGetCall) Context 

func (c *BeaconsGetCall) Context(ctx context.Context) *BeaconsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*BeaconsGetCall) Do 

func (c *BeaconsGetCall) Do(opts ...googleapi.CallOption) (*Beacon, error)

Do executes the "proximitybeacon.beacons.get" call. Exactly one of *Beacon or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Beacon.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BeaconsGetCall) Fields 

func (c *BeaconsGetCall) Fields(s ...googleapi.Field) *BeaconsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*BeaconsGetCall) Header 

func (c *BeaconsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*BeaconsGetCall) IfNoneMatch 

func (c *BeaconsGetCall) IfNoneMatch(entityTag string) *BeaconsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*BeaconsGetCall) ProjectId 

func (c *BeaconsGetCall) ProjectId(projectId string) *BeaconsGetCall

ProjectId sets the optional parameter "projectId": The project id of the beacon to request. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon.

type BeaconsListCall 

type BeaconsListCall struct {
	// contains filtered or unexported fields
}

func (*BeaconsListCall) Context 

func (c *BeaconsListCall) Context(ctx context.Context) *BeaconsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*BeaconsListCall) Do 

func (c *BeaconsListCall) Do(opts ...googleapi.CallOption) (*ListBeaconsResponse, error)

Do executes the "proximitybeacon.beacons.list" call. Exactly one of *ListBeaconsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListBeaconsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BeaconsListCall) Fields 

func (c *BeaconsListCall) Fields(s ...googleapi.Field) *BeaconsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*BeaconsListCall) Header 

func (c *BeaconsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*BeaconsListCall) IfNoneMatch 

func (c *BeaconsListCall) IfNoneMatch(entityTag string) *BeaconsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*BeaconsListCall) PageSize 

func (c *BeaconsListCall) PageSize(pageSize int64) *BeaconsListCall

PageSize sets the optional parameter "pageSize": The maximum number of records to return for this request, up to a server-defined upper limit.

func (*BeaconsListCall) PageToken 

func (c *BeaconsListCall) PageToken(pageToken string) *BeaconsListCall

PageToken sets the optional parameter "pageToken": A pagination token obtained from a previous request to list beacons.

func (*BeaconsListCall) Pages 

func (c *BeaconsListCall) Pages(ctx context.Context, f func(*ListBeaconsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*BeaconsListCall) ProjectId 

func (c *BeaconsListCall) ProjectId(projectId string) *BeaconsListCall

ProjectId sets the optional parameter "projectId": The project id to list beacons under. If not present then the project credential that made the request is used as the project.

func (*BeaconsListCall) Q 

func (c *BeaconsListCall) Q(q string) *BeaconsListCall

Q sets the optional parameter "q": Filter query string that supports the following field filters:

  • **description:"<string>"** For example: **description:"Room 3"** Returns beacons whose description matches tokens in the string

"Room 3" 

(not necessarily that exact string).
The string must be double-quoted.
  • **status:`<enum>`** For example: **status:active** Returns beacons whose status matches the given value. Values must

be 

one of the Beacon.Status enum values (case insensitive). Accepts
multiple filters which will be combined with OR logic.
  • **stability:`<enum>`** For example: **stability:mobile** Returns beacons whose expected stability matches the given value. Values must be one of the Beacon.Stability enum values (case insensitive). Accepts multiple filters which will be combined with OR logic.
  • **place\_id:"<string>"** For example: **place\_id:"ChIJVSZzVR8FdkgRXGmmm6SslKw="** Returns beacons explicitly registered at the given place, expressed

as 

a Place ID obtained from [Google Places API](/places/place-id).

Does not 

match places inside the given place. Does not consider the

beacon's 

actual location (which may be different from its registered

place). 

Accepts multiple filters that will be combined with OR logic. The

place 

ID must be double-quoted.
  • **registration\_time`[<|>|<=|>=]<integer>`** For example: **registration\_time>=1433116800** Returns beacons whose registration time matches the given filter. Supports the operators: <, >, <=, and >=. Timestamp must be

expressed as 

an integer number of seconds since midnight January 1, 1970 UTC.

Accepts 

at most two filters that will be combined with AND logic, to

support 

"between" semantics. If more than two are supplied, the latter ones

are 

ignored.
  • **lat:`<double> lng:<double> radius:<integer>`** For example: **lat:51.1232343 lng:-1.093852 radius:1000** Returns beacons whose registered location is within the given

circle. 

When any of these fields are given, all are required. Latitude and
longitude must be decimal degrees between -90.0 and 90.0 and

between 

-180.0 and 180.0 respectively. Radius must be an integer number of
meters between 10 and 1,000,000 (1000 km).
  • **property:"<string>=<string>"** For example: **property:"battery-type=CR2032"** Returns beacons which have a property of the given name and value. Supports multiple filters which will be combined with OR logic. The entire name=value string must be double-quoted as one string.
  • **attachment\_type:"<string>"** For example: **attachment_type:"my-namespace/my-type"** Returns beacons having at least one attachment of the given

namespaced 

type. Supports "any within this namespace" via the partial

wildcard 

syntax: "my-namespace/*". Supports multiple filters which will be
combined with OR logic. The string must be double-quoted.
  • **indoor\_level:"<string>"** For example: **indoor\_level:"1"** Returns beacons which are located on the given indoor level.

Accepts 

multiple filters that will be combined with OR logic.

Multiple filters on the same field are combined with OR logic (except registration_time which is combined with AND logic). Multiple filters on different fields are combined with AND logic. Filters should be separated by spaces.

As with any HTTP query string parameter, the whole filter expression must be URL-encoded.

Example REST request: `GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:10 00`

type BeaconsRegisterCall 

type BeaconsRegisterCall struct {
	// contains filtered or unexported fields
}

func (*BeaconsRegisterCall) Context 

func (c *BeaconsRegisterCall) Context(ctx context.Context) *BeaconsRegisterCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*BeaconsRegisterCall) Do 

func (c *BeaconsRegisterCall) Do(opts ...googleapi.CallOption) (*Beacon, error)

Do executes the "proximitybeacon.beacons.register" call. Exactly one of *Beacon or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Beacon.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BeaconsRegisterCall) Fields 

func (c *BeaconsRegisterCall) Fields(s ...googleapi.Field) *BeaconsRegisterCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*BeaconsRegisterCall) Header 

func (c *BeaconsRegisterCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*BeaconsRegisterCall) ProjectId 

func (c *BeaconsRegisterCall) ProjectId(projectId string) *BeaconsRegisterCall

ProjectId sets the optional parameter "projectId": The project id of the project the beacon will be registered to. If the project id is not specified then the project making the request is used.

type BeaconsService 

type BeaconsService struct {
	Attachments *BeaconsAttachmentsService

	Diagnostics *BeaconsDiagnosticsService
	// contains filtered or unexported fields
}

func NewBeaconsService 

func NewBeaconsService(s *Service) *BeaconsService

func (*BeaconsService) Activate 

func (r *BeaconsService) Activate(beaconName string) *BeaconsActivateCall

Activate: Activates a beacon. A beacon that is active will return information and attachment data when queried via `beaconinfo.getforobserved`. Calling this method on an already active beacon will do nothing (but will return a successful response code).

Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

func (*BeaconsService) Deactivate 

func (r *BeaconsService) Deactivate(beaconName string) *BeaconsDeactivateCall

Deactivate: Deactivates a beacon. Once deactivated, the API will not return information nor attachment data for the beacon when queried via `beaconinfo.getforobserved`. Calling this method on an already inactive beacon will do nothing (but will return a successful response code).

Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

func (*BeaconsService) Decommission 

func (r *BeaconsService) Decommission(beaconName string) *BeaconsDecommissionCall

Decommission: Decommissions the specified beacon in the service. This beacon will no longer be returned from `beaconinfo.getforobserved`. This operation is permanent -- you will not be able to re-register a beacon with this ID again.

Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

func (*BeaconsService) Delete 

func (r *BeaconsService) Delete(beaconName string) *BeaconsDeleteCall

Delete: Deletes the specified beacon including all diagnostics data for the beacon as well as any attachments on the beacon (including those belonging to other projects). This operation cannot be undone.

Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

func (*BeaconsService) Get 

func (r *BeaconsService) Get(beaconName string) *BeaconsGetCall

Get: Returns detailed information about the specified beacon.

Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.

Requests may supply an Eddystone-EID beacon name in the form: `beacons/4!beaconId` where the `beaconId` is the base16 ephemeral ID broadcast by the beacon. The returned `Beacon` object will contain the beacon's stable Eddystone-UID. Clients not authorized to resolve the beacon's ephemeral Eddystone-EID broadcast will receive an error.

func (*BeaconsService) List 

func (r *BeaconsService) List() *BeaconsListCall

List: Searches the beacon registry for beacons that match the given search criteria. Only those beacons that the client has permission to list will be returned.

Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.

func (*BeaconsService) Register 

func (r *BeaconsService) Register(beacon *Beacon) *BeaconsRegisterCall

Register: Registers a previously unregistered beacon given its `advertisedId`. These IDs are unique within the system. An ID can be registered only once.

Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

func (*BeaconsService) Update 

func (r *BeaconsService) Update(beaconName string, beacon *Beacon) *BeaconsUpdateCall

Update: Updates the information about the specified beacon. **Any field that you do not populate in the submitted beacon will be permanently erased**, so you should follow the "read, modify, write" pattern to avoid inadvertently destroying data.

Changes to the beacon status via this method will be silently ignored. To update beacon status, use the separate methods on this API for activation, deactivation, and decommissioning. Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **Is owner** or **Can edit** permissions in the Google Developers Console project.

type BeaconsUpdateCall 

type BeaconsUpdateCall struct {
	// contains filtered or unexported fields
}

func (*BeaconsUpdateCall) Context 

func (c *BeaconsUpdateCall) Context(ctx context.Context) *BeaconsUpdateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*BeaconsUpdateCall) Do 

func (c *BeaconsUpdateCall) Do(opts ...googleapi.CallOption) (*Beacon, error)

Do executes the "proximitybeacon.beacons.update" call. Exactly one of *Beacon or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Beacon.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*BeaconsUpdateCall) Fields 

func (c *BeaconsUpdateCall) Fields(s ...googleapi.Field) *BeaconsUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*BeaconsUpdateCall) Header 

func (c *BeaconsUpdateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*BeaconsUpdateCall) ProjectId 

func (c *BeaconsUpdateCall) ProjectId(projectId string) *BeaconsUpdateCall

ProjectId sets the optional parameter "projectId": The project id of the beacon to update. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon.

type Date 

type Date struct {
	// Day: Day of month. Must be from 1 to 31 and valid for the year and
	// month, or 0
	// if specifying a year by itself or a year and month where the day is
	// not
	// significant.
	Day int64 `json:"day,omitempty"`

	// Month: Month of year. Must be from 1 to 12, or 0 if specifying a year
	// without a
	// month and day.
	Month int64 `json:"month,omitempty"`

	// Year: Year of date. Must be from 1 to 9999, or 0 if specifying a date
	// without
	// a year.
	Year int64 `json:"year,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Day") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Day") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Date: Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent:

* A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date

Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.

func (*Date) MarshalJSON 

func (s *Date) MarshalJSON() ([]byte, error)

type DeleteAttachmentsResponse 

type DeleteAttachmentsResponse struct {
	// NumDeleted: The number of attachments that were deleted.
	NumDeleted int64 `json:"numDeleted,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NumDeleted") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NumDeleted") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DeleteAttachmentsResponse: Response for a request to delete attachments.

func (*DeleteAttachmentsResponse) MarshalJSON 

func (s *DeleteAttachmentsResponse) MarshalJSON() ([]byte, error)

type Diagnostics 

type Diagnostics struct {
	// Alerts: An unordered list of Alerts that the beacon has.
	//
	// Possible values:
	//   "ALERT_UNSPECIFIED" - Invalid value. Should never appear.
	//   "WRONG_LOCATION" - The beacon has been reported far from its
	// expected location (the beacon's
	// lat_lng field if populated, otherwise, if the beacon's place_id field
	// is
	// present, the center of that place). This may indicate that the beacon
	// has
	// been moved. This signal is not 100% accurate, but indicates that
	// further
	// investigation is worthwhile.
	//   "LOW_BATTERY" - The battery level for the beacon is low enough
	// that, given the beacon's
	// current use, its battery will run out with in the next 60 days.
	// This
	// indicates that the battery should be replaced soon.
	//   "LOW_ACTIVITY" - The beacon has been reported at a very low rate or
	// not at all. This may
	// indicate that the beacon is broken or just that no one has gone near
	// the
	// beacon in recent days. If this status appears unexpectedly, the
	// beacon
	// owner should investigate further.
	Alerts []string `json:"alerts,omitempty"`

	// BeaconName: Resource name of the beacon. For Eddystone-EID beacons,
	// this may
	// be the beacon's current EID, or the beacon's "stable" Eddystone-UID.
	BeaconName string `json:"beaconName,omitempty"`

	// EstimatedLowBatteryDate: The date when the battery is expected to be
	// low. If the value is missing
	// then there is no estimate for when the battery will be low.
	// This value is only an estimate, not an exact date.
	EstimatedLowBatteryDate *Date `json:"estimatedLowBatteryDate,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Alerts") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Alerts") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Diagnostics: Diagnostics for a single beacon.

func (*Diagnostics) MarshalJSON 

func (s *Diagnostics) MarshalJSON() ([]byte, error)

type Empty 

type Empty struct {
	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`
}

Empty: A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: 

service Foo {
  rpc Bar(google.protobuf.Empty) returns

(google.protobuf.Empty); 

}

The JSON representation for `Empty` is empty JSON object `{}`.

type EphemeralIdRegistration 

type EphemeralIdRegistration struct {
	// BeaconEcdhPublicKey: The beacon's public key used for the Elliptic
	// curve Diffie-Hellman
	// key exchange. When this field is populated,
	// `service_ecdh_public_key`
	// must also be populated, and `beacon_identity_key` must not be.
	BeaconEcdhPublicKey string `json:"beaconEcdhPublicKey,omitempty"`

	// BeaconIdentityKey: The private key of the beacon. If this field is
	// populated,
	// `beacon_ecdh_public_key` and `service_ecdh_public_key` must not
	// be
	// populated.
	BeaconIdentityKey string `json:"beaconIdentityKey,omitempty"`

	// InitialClockValue: The initial clock value of the beacon. The
	// beacon's clock must have
	// begun counting at this value immediately prior to transmitting
	// this
	// value to the resolving service. Significant delay in transmitting
	// this
	// value to the service risks registration or resolution failures. If
	// a
	// value is not provided, the default is zero.
	InitialClockValue uint64 `json:"initialClockValue,omitempty,string"`

	// InitialEid: An initial ephemeral ID calculated using the clock value
	// submitted as
	// `initial_clock_value`, and the secret key generated by
	// the
	// Diffie-Hellman key exchange using `service_ecdh_public_key`
	// and
	// `service_ecdh_public_key`. This initial EID value will be used by
	// the
	// service to confirm that the key exchange process was successful.
	InitialEid string `json:"initialEid,omitempty"`

	// RotationPeriodExponent: Indicates the nominal period between each
	// rotation of the beacon's
	// ephemeral ID. "Nominal" because the beacon should randomize
	// the
	// actual interval. See [the spec
	// at
	// github](https://github.com/google/eddystone/tree/master/eddystone-e
	// id)
	// for details. This value corresponds to a power-of-two scaler on
	// the
	// beacon's clock: when the scaler value is K, the beacon will
	// begin
	// broadcasting a new ephemeral ID on average every 2^K seconds.
	RotationPeriodExponent int64 `json:"rotationPeriodExponent,omitempty"`

	// ServiceEcdhPublicKey: The service's public key used for the Elliptic
	// curve Diffie-Hellman
	// key exchange. When this field is populated,
	// `beacon_ecdh_public_key`
	// must also be populated, and `beacon_identity_key` must not be.
	ServiceEcdhPublicKey string `json:"serviceEcdhPublicKey,omitempty"`

	// ForceSendFields is a list of field names (e.g. "BeaconEcdhPublicKey")
	// to unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "BeaconEcdhPublicKey") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

EphemeralIdRegistration: Write-only registration parameters for beacons using Eddystone-EID format. Two ways of securely registering an Eddystone-EID beacon with the service are supported:

1. Perform an ECDH key exchange via this API, including a previous call 

to `GET /v1beta1/eidparams`. In this case the fields
`beacon_ecdh_public_key` and `service_ecdh_public_key` should be
populated and `beacon_identity_key` should not be populated. This
method ensures that only the two parties in the ECDH key exchange

can 

compute the identity key, which becomes a secret between them.
  1. Derive or obtain the beacon's identity key via other secure means (perhaps an ECDH key exchange between the beacon and a mobile

device 

or any other secure method), and then submit the resulting

identity key 

to the service. In this case `beacon_identity_key` field should

be 

populated, and neither of `beacon_ecdh_public_key` nor
`service_ecdh_public_key` fields should be. The security of this

method 

depends on how securely the parties involved (in particular the
bluetooth client) handle the identity key, and obviously on how
securely the identity key was generated.

See [the Eddystone specification](https://github.com/google/eddystone/tree/mast er/eddystone-eid) at GitHub.

func (*EphemeralIdRegistration) MarshalJSON 

func (s *EphemeralIdRegistration) MarshalJSON() ([]byte, error)

type EphemeralIdRegistrationParams 

type EphemeralIdRegistrationParams struct {
	// MaxRotationPeriodExponent: Indicates the maximum rotation period
	// supported by the service.
	// See EddystoneEidRegistration.rotation_period_exponent
	MaxRotationPeriodExponent int64 `json:"maxRotationPeriodExponent,omitempty"`

	// MinRotationPeriodExponent: Indicates the minimum rotation period
	// supported by the service.
	// See EddystoneEidRegistration.rotation_period_exponent
	MinRotationPeriodExponent int64 `json:"minRotationPeriodExponent,omitempty"`

	// ServiceEcdhPublicKey: The beacon service's public key for use by a
	// beacon to derive its
	// Identity Key using Elliptic Curve Diffie-Hellman key exchange.
	ServiceEcdhPublicKey string `json:"serviceEcdhPublicKey,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g.
	// "MaxRotationPeriodExponent") to unconditionally include in API
	// requests. By default, fields with empty values are omitted from API
	// requests. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g.
	// "MaxRotationPeriodExponent") to include in API requests with the JSON
	// null value. By default, fields with empty values are omitted from API
	// requests. However, any field with an empty value appearing in
	// NullFields will be sent to the server as null. It is an error if a
	// field in this list has a non-empty value. This may be used to include
	// null fields in Patch requests.
	NullFields []string `json:"-"`
}

EphemeralIdRegistrationParams: Information a client needs to provision and register beacons that broadcast Eddystone-EID format beacon IDs, using Elliptic curve Diffie-Hellman key exchange. See [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddysto ne-eid) at GitHub.

func (*EphemeralIdRegistrationParams) MarshalJSON 

func (s *EphemeralIdRegistrationParams) MarshalJSON() ([]byte, error)

type GetInfoForObservedBeaconsRequest 

type GetInfoForObservedBeaconsRequest struct {
	// NamespacedTypes: Specifies what kind of attachments to include in the
	// response.
	// When given, the response will include only attachments of the given
	// types.
	// When empty, no attachments will be returned. Must be in the
	// format
	// <var>namespace/type</var>. Accepts `*` to specify all types in
	// all namespaces owned by the client.
	// Optional.
	NamespacedTypes []string `json:"namespacedTypes,omitempty"`

	// Observations: The beacons that the client has encountered.
	// At least one must be given.
	Observations []*Observation `json:"observations,omitempty"`

	// ForceSendFields is a list of field names (e.g. "NamespacedTypes") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NamespacedTypes") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GetInfoForObservedBeaconsRequest: Request for beacon and attachment information about beacons that a mobile client has encountered "in the wild".

func (*GetInfoForObservedBeaconsRequest) MarshalJSON 

func (s *GetInfoForObservedBeaconsRequest) MarshalJSON() ([]byte, error)

type GetInfoForObservedBeaconsResponse 

type GetInfoForObservedBeaconsResponse struct {
	// Beacons: Public information about beacons.
	// May be empty if the request matched no beacons.
	Beacons []*BeaconInfo `json:"beacons,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Beacons") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Beacons") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GetInfoForObservedBeaconsResponse: Information about the requested beacons, optionally including attachment data.

func (*GetInfoForObservedBeaconsResponse) MarshalJSON 

func (s *GetInfoForObservedBeaconsResponse) MarshalJSON() ([]byte, error)

type IndoorLevel 

type IndoorLevel struct {
	// Name: The name of this level.
	Name string `json:"name,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Name") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Name") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

IndoorLevel: Indoor level, a human-readable string as returned by Google Maps APIs, useful to indicate which floor of a building a beacon is located on.

func (*IndoorLevel) MarshalJSON 

func (s *IndoorLevel) MarshalJSON() ([]byte, error)

type LatLng 

type LatLng struct {
	// Latitude: The latitude in degrees. It must be in the range [-90.0,
	// +90.0].
	Latitude float64 `json:"latitude,omitempty"`

	// Longitude: The longitude in degrees. It must be in the range [-180.0,
	// +180.0].
	Longitude float64 `json:"longitude,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Latitude") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Latitude") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

LatLng: An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 st andard</a>. Values must be within normalized ranges.

func (*LatLng) MarshalJSON 

func (s *LatLng) MarshalJSON() ([]byte, error)

func (*LatLng) UnmarshalJSON 

func (s *LatLng) UnmarshalJSON(data []byte) error

type ListBeaconAttachmentsResponse 

type ListBeaconAttachmentsResponse struct {
	// Attachments: The attachments that corresponded to the request params.
	Attachments []*BeaconAttachment `json:"attachments,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Attachments") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Attachments") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListBeaconAttachmentsResponse: Response to `ListBeaconAttachments` that contains the requested attachments.

func (*ListBeaconAttachmentsResponse) MarshalJSON 

func (s *ListBeaconAttachmentsResponse) MarshalJSON() ([]byte, error)

type ListBeaconsResponse 

type ListBeaconsResponse struct {
	// Beacons: The beacons that matched the search criteria.
	Beacons []*Beacon `json:"beacons,omitempty"`

	// NextPageToken: An opaque pagination token that the client may provide
	// in their next
	// request to retrieve the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// TotalCount: Estimate of the total number of beacons matched by the
	// query. Higher
	// values may be less accurate.
	TotalCount int64 `json:"totalCount,omitempty,string"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Beacons") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Beacons") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListBeaconsResponse: Response that contains list beacon results and pagination help.

func (*ListBeaconsResponse) MarshalJSON 

func (s *ListBeaconsResponse) MarshalJSON() ([]byte, error)

type ListDiagnosticsResponse 

type ListDiagnosticsResponse struct {
	// Diagnostics: The diagnostics matching the given request.
	Diagnostics []*Diagnostics `json:"diagnostics,omitempty"`

	// NextPageToken: Token that can be used for pagination. Returned only
	// if the
	// request matches more beacons than can be returned in this response.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Diagnostics") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Diagnostics") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListDiagnosticsResponse: Response that contains the requested diagnostics.

func (*ListDiagnosticsResponse) MarshalJSON 

func (s *ListDiagnosticsResponse) MarshalJSON() ([]byte, error)

type ListNamespacesResponse 

type ListNamespacesResponse struct {
	// Namespaces: The attachments that corresponded to the request params.
	Namespaces []*Namespace `json:"namespaces,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Namespaces") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Namespaces") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListNamespacesResponse: Response to ListNamespacesRequest that contains all the project's namespaces.

func (*ListNamespacesResponse) MarshalJSON 

func (s *ListNamespacesResponse) MarshalJSON() ([]byte, error)

type Namespace 

type Namespace struct {
	// NamespaceName: Resource name of this namespace. Namespaces names have
	// the format:
	// <code>namespaces/<var>namespace</var></code>.
	NamespaceName string `json:"namespaceName,omitempty"`

	// ServingVisibility: Specifies what clients may receive attachments
	// under this namespace
	// via `beaconinfo.getforobserved`.
	//
	// Possible values:
	//   "VISIBILITY_UNSPECIFIED" - Do not use this value.
	//   "UNLISTED" - Served only to the project that owns the namespace.
	//   "PUBLIC" - Any project can subscribe to attachments under the
	// namespace.
	ServingVisibility string `json:"servingVisibility,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "NamespaceName") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "NamespaceName") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Namespace: An attachment namespace defines read and write access for all the attachments created under it. Each namespace is globally unique, and owned by one project which is the only project that can create attachments under it.

func (*Namespace) MarshalJSON 

func (s *Namespace) MarshalJSON() ([]byte, error)

type NamespacesListCall 

type NamespacesListCall struct {
	// contains filtered or unexported fields
}

func (*NamespacesListCall) Context 

func (c *NamespacesListCall) Context(ctx context.Context) *NamespacesListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*NamespacesListCall) Do 

func (c *NamespacesListCall) Do(opts ...googleapi.CallOption) (*ListNamespacesResponse, error)

Do executes the "proximitybeacon.namespaces.list" call. Exactly one of *ListNamespacesResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListNamespacesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*NamespacesListCall) Fields 

func (c *NamespacesListCall) Fields(s ...googleapi.Field) *NamespacesListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*NamespacesListCall) Header 

func (c *NamespacesListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*NamespacesListCall) IfNoneMatch 

func (c *NamespacesListCall) IfNoneMatch(entityTag string) *NamespacesListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*NamespacesListCall) ProjectId 

func (c *NamespacesListCall) ProjectId(projectId string) *NamespacesListCall

ProjectId sets the optional parameter "projectId": The project id to list namespaces under.

type NamespacesService 

type NamespacesService struct {
	// contains filtered or unexported fields
}

func NewNamespacesService 

func NewNamespacesService(s *Service) *NamespacesService

func (*NamespacesService) List 

func (r *NamespacesService) List() *NamespacesListCall

List: Lists all attachment namespaces owned by your Google Developers Console project. Attachment data associated with a beacon must include a namespaced type, and the namespace must be owned by your project.

Authenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2) from a signed-in user with **viewer**, **Is owner** or **Can edit** permissions in the Google Developers Console project.

func (*NamespacesService) Update 

func (r *NamespacesService) Update(namespaceName string, namespace *Namespace) *NamespacesUpdateCall

Update: Updates the information about the specified namespace. Only the namespace visibility can be updated.

type NamespacesUpdateCall 

type NamespacesUpdateCall struct {
	// contains filtered or unexported fields
}

func (*NamespacesUpdateCall) Context 

func (c *NamespacesUpdateCall) Context(ctx context.Context) *NamespacesUpdateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*NamespacesUpdateCall) Do 

func (c *NamespacesUpdateCall) Do(opts ...googleapi.CallOption) (*Namespace, error)

Do executes the "proximitybeacon.namespaces.update" call. Exactly one of *Namespace or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Namespace.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*NamespacesUpdateCall) Fields 

func (c *NamespacesUpdateCall) Fields(s ...googleapi.Field) *NamespacesUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*NamespacesUpdateCall) Header 

func (c *NamespacesUpdateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*NamespacesUpdateCall) ProjectId 

func (c *NamespacesUpdateCall) ProjectId(projectId string) *NamespacesUpdateCall

ProjectId sets the optional parameter "projectId": The project id of the namespace to update. If the project id is not specified then the project making the request is used. The project id must match the project that owns the beacon.

type Observation 

type Observation struct {
	// AdvertisedId: The ID advertised by the beacon the client has
	// encountered.
	//
	// If the submitted `advertised_id` type is Eddystone-EID, then the
	// client
	// must be authorized to resolve the given beacon. Otherwise no data
	// will be
	// returned for that beacon.
	// Required.
	AdvertisedId *AdvertisedId `json:"advertisedId,omitempty"`

	// Telemetry: The array of telemetry bytes received from the beacon. The
	// server is
	// responsible for parsing it. This field may frequently be empty,
	// as
	// with a beacon that transmits telemetry only occasionally.
	Telemetry string `json:"telemetry,omitempty"`

	// TimestampMs: Time when the beacon was observed.
	TimestampMs string `json:"timestampMs,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AdvertisedId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AdvertisedId") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Observation: Represents one beacon observed once.

func (*Observation) MarshalJSON 

func (s *Observation) MarshalJSON() ([]byte, error)

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Beaconinfo *BeaconinfoService

	Beacons *BeaconsService

	Namespaces *NamespacesService

	V1beta1 *V1beta1Service
	// contains filtered or unexported fields
}

func New deprecated 

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService added in v0.3.0 

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type V1beta1GetEidparamsCall 

type V1beta1GetEidparamsCall struct {
	// contains filtered or unexported fields
}

func (*V1beta1GetEidparamsCall) Context 

func (c *V1beta1GetEidparamsCall) Context(ctx context.Context) *V1beta1GetEidparamsCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*V1beta1GetEidparamsCall) Do 

func (c *V1beta1GetEidparamsCall) Do(opts ...googleapi.CallOption) (*EphemeralIdRegistrationParams, error)

Do executes the "proximitybeacon.getEidparams" call. Exactly one of *EphemeralIdRegistrationParams or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *EphemeralIdRegistrationParams.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*V1beta1GetEidparamsCall) Fields 

func (c *V1beta1GetEidparamsCall) Fields(s ...googleapi.Field) *V1beta1GetEidparamsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*V1beta1GetEidparamsCall) Header 

func (c *V1beta1GetEidparamsCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*V1beta1GetEidparamsCall) IfNoneMatch 

func (c *V1beta1GetEidparamsCall) IfNoneMatch(entityTag string) *V1beta1GetEidparamsCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type V1beta1Service 

type V1beta1Service struct {
	// contains filtered or unexported fields
}

func NewV1beta1Service 

func NewV1beta1Service(s *Service) *V1beta1Service

func (*V1beta1Service) GetEidparams 

func (r *V1beta1Service) GetEidparams() *V1beta1GetEidparamsCall

GetEidparams: Gets the Proximity Beacon API's current public key and associated parameters used to initiate the Diffie-Hellman key exchange required to register a beacon that broadcasts the Eddystone-EID format. This key changes periodically; clients may cache it and re-use the same public key to provision and register multiple beacons. However, clients should be prepared to refresh this key when they encounter an error registering an Eddystone-EID beacon.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.