Documentation

Google_Service_Proximitybeacon_Resource_Beacons extends Google_Service_Resource
in package

The "beacons" collection of methods.

Typical usage is: $proximitybeaconService = new Google_Service_Proximitybeacon(...); $beacons = $proximitybeaconService->beacons;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
activate()  : Google_Service_Proximitybeacon_ProximitybeaconEmpty
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).
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
deactivate()  : Google_Service_Proximitybeacon_ProximitybeaconEmpty
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).
decommission()  : Google_Service_Proximitybeacon_ProximitybeaconEmpty
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.
delete()  : Google_Service_Proximitybeacon_ProximitybeaconEmpty
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.
get()  : Google_Service_Proximitybeacon_Beacon
Returns detailed information about the specified beacon.
listBeacons()  : Google_Service_Proximitybeacon_ListBeaconsResponse
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.
register()  : Google_Service_Proximitybeacon_Beacon
Registers a previously unregistered beacon given its `advertisedId`. These IDs are unique within the system. An ID can be registered only once.
update()  : Google_Service_Proximitybeacon_Beacon
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.
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

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).

public activate(string $beaconName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Proximitybeacon_ProximitybeaconEmpty

Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project. (beacons.activate)

Parameters
$beaconName : string

Beacon that should be activated. 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-UID, 4 for Eddystone-EID, 1 for iBeacon, or 5 for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string 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. Optional.

Return values
Google_Service_Proximitybeacon_ProximitybeaconEmpty —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

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).

public deactivate(string $beaconName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Proximitybeacon_ProximitybeaconEmpty

Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project. (beacons.deactivate)

Parameters
$beaconName : string

Beacon that should be deactivated. 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-UID, 4 for Eddystone-EID, 1 for iBeacon, or 5 for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string 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. Optional.

Return values
Google_Service_Proximitybeacon_ProximitybeaconEmpty —

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.

public decommission(string $beaconName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Proximitybeacon_ProximitybeaconEmpty

Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project. (beacons.decommission)

Parameters
$beaconName : string

Beacon that should be decommissioned. 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-UID, 4 for Eddystone-EID, 1 for iBeacon, or 5 for AltBeacon. For Eddystone-EID beacons, you may use either the current EID of the beacon's "stable" UID. Required.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string 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. Optional.

Return values
Google_Service_Proximitybeacon_ProximitybeaconEmpty —

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.

public delete(string $beaconName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Proximitybeacon_ProximitybeaconEmpty

Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project. (beacons.delete)

Parameters
$beaconName : string

Beacon that should be deleted. 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-UID, 4 for Eddystone-EID, 1 for iBeacon, or 5 for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string projectId The project id of the beacon to delete. If not provided, the project that is making the request is used. Optional.

Return values
Google_Service_Proximitybeacon_ProximitybeaconEmpty —

get()

Returns detailed information about the specified beacon.

public get(string $beaconName[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Proximitybeacon_Beacon

Authenticate using an OAuth access token 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. (beacons.get)

Parameters
$beaconName : string

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-UID, 4 for Eddystone-EID, 1 for iBeacon, or 5 for AltBeacon. For Eddystone-EID beacons, you may use either the current EID or the beacon's "stable" UID. Required.

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string 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. Optional.

Return values
Google_Service_Proximitybeacon_Beacon —

listBeacons()

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.

public listBeacons([array<string|int, mixed> $optParams = array() ]) : Google_Service_Proximitybeacon_ListBeaconsResponse

Authenticate using an OAuth access token from a signed-in user with viewer, Is owner or Can edit permissions in the Google Developers Console project. (beacons.listBeacons)

Parameters
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string pageToken A pagination token obtained from a previous request to list beacons.

opt_param

string q Filter query string that supports the following field filters:

  • description:"" 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:** 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: 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:"" For example: place_id:"ChIJVSZzVR8FdkgRXGmmm6SslKw=" Returns beacons explicitly registered at the given place, expressed as a Place ID obtained from Google Places API. 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[<|>|<=|>=] 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: lng: radius: 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:"=" 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:"" 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:"" 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:1000

opt_param

int pageSize The maximum number of records to return for this request, up to a server-defined upper limit.

opt_param

string projectId The project id to list beacons under. If not present then the project credential that made the request is used as the project. Optional.

Return values
Google_Service_Proximitybeacon_ListBeaconsResponse —

register()

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

public register(Google_Service_Proximitybeacon_Beacon $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Proximitybeacon_Beacon

Authenticate using an OAuth access token from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project. (beacons.register)

Parameters
$postBody : Google_Service_Proximitybeacon_Beacon
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string 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. Optional.

Return values
Google_Service_Proximitybeacon_Beacon —

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.

public update(string $beaconName, Google_Service_Proximitybeacon_Beacon $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Proximitybeacon_Beacon

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 from a signed-in user with Is owner or Can edit permissions in the Google Developers Console project. (beacons.update)

Parameters
$beaconName : string

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.

$postBody : Google_Service_Proximitybeacon_Beacon
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string 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. Optional.

Return values
Google_Service_Proximitybeacon_Beacon —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results