Class: Google::Apis::ProximitybeaconV1beta1::ProximitybeaconService

Inherits:
Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/proximitybeacon_v1beta1/service.rb

Overview

Google Proximity Beacon API

Registers, manages, indexes, and searches beacons.

Examples:

require 'google/apis/proximitybeacon_v1beta1'

Proximitybeacon = Google::Apis::ProximitybeaconV1beta1 # Alias the module
service = Proximitybeacon::ProximitybeaconService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ ProximitybeaconService

Returns a new instance of ProximitybeaconService



45
46
47
48
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 45

def initialize
  super('https://proximitybeacon.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



43
44
45
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 43

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



38
39
40
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 38

def quota_user
  @quota_user
end

Instance Method Details

#activate_beacon(beacon_name, project_id: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ProximitybeaconV1beta1::Empty

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

Parameters:

  • beacon_name (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.

  • project_id (String) —

    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.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



600
601
602
603
604
605
606
607
608
609
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 600

def activate_beacon(beacon_name, project_id: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+beaconName}:activate', options)
  command.response_representation = Google::Apis::ProximitybeaconV1beta1::Empty::Representation
  command.response_class = Google::Apis::ProximitybeaconV1beta1::Empty
  command.params['beaconName'] = beacon_name unless beacon_name.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#batch_beacon_attachment_delete(beacon_name, project_id: nil, namespaced_type: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ProximitybeaconV1beta1::DeleteAttachmentsResponse

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

Parameters:

  • beacon_name (String) —

    The beacon whose attachments 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.

  • project_id (String) —

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

  • namespaced_type (String) —

    Specifies the namespace and type of attachments to delete in namespace/type format. Accepts */* to specify "all types in all namespaces". Optional.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



823
824
825
826
827
828
829
830
831
832
833
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 823

def batch_beacon_attachment_delete(beacon_name, project_id: nil, namespaced_type: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+beaconName}/attachments:batchDelete', options)
  command.response_representation = Google::Apis::ProximitybeaconV1beta1::DeleteAttachmentsResponse::Representation
  command.response_class = Google::Apis::ProximitybeaconV1beta1::DeleteAttachmentsResponse
  command.params['beaconName'] = beacon_name unless beacon_name.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['namespacedType'] = namespaced_type unless namespaced_type.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#create_beacon_attachment(beacon_name, beacon_attachment_object = nil, project_id: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ProximitybeaconV1beta1::BeaconAttachment

Associates the given data with the specified beacon. Attachment data must contain two parts:

  • A namespaced type.
  • The actual attachment data itself.

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

Parameters:

  • beacon_name (String) —

    Beacon on which the attachment should be created. 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.

  • beacon_attachment_object (Google::Apis::ProximitybeaconV1beta1::BeaconAttachment) (defaults to: nil)
  • project_id (String) —

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

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



763
764
765
766
767
768
769
770
771
772
773
774
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 763

def create_beacon_attachment(beacon_name, beacon_attachment_object = nil, project_id: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+beaconName}/attachments', options)
  command.request_representation = Google::Apis::ProximitybeaconV1beta1::BeaconAttachment::Representation
  command.request_object = beacon_attachment_object
  command.response_representation = Google::Apis::ProximitybeaconV1beta1::BeaconAttachment::Representation
  command.response_class = Google::Apis::ProximitybeaconV1beta1::BeaconAttachment
  command.params['beaconName'] = beacon_name unless beacon_name.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#deactivate_beacon(beacon_name, project_id: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ProximitybeaconV1beta1::Empty

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

Parameters:

  • beacon_name (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.

  • project_id (String) —

    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.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



400
401
402
403
404
405
406
407
408
409
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 400

def deactivate_beacon(beacon_name, project_id: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+beaconName}:deactivate', options)
  command.response_representation = Google::Apis::ProximitybeaconV1beta1::Empty::Representation
  command.response_class = Google::Apis::ProximitybeaconV1beta1::Empty
  command.params['beaconName'] = beacon_name unless beacon_name.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#decommission_beacon(beacon_name, project_id: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ProximitybeaconV1beta1::Empty

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

Parameters:

  • beacon_name (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.

  • project_id (String) —

    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.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



304
305
306
307
308
309
310
311
312
313
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 304

def decommission_beacon(beacon_name, project_id: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/{+beaconName}:decommission', options)
  command.response_representation = Google::Apis::ProximitybeaconV1beta1::Empty::Representation
  command.response_class = Google::Apis::ProximitybeaconV1beta1::Empty
  command.params['beaconName'] = beacon_name unless beacon_name.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#delete_beacon(beacon_name, project_id: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ProximitybeaconV1beta1::Empty

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

Parameters:

  • beacon_name (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.

  • project_id (String) —

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

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



351
352
353
354
355
356
357
358
359
360
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 351

def delete_beacon(beacon_name, project_id: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta1/{+beaconName}', options)
  command.response_representation = Google::Apis::ProximitybeaconV1beta1::Empty::Representation
  command.response_class = Google::Apis::ProximitybeaconV1beta1::Empty
  command.params['beaconName'] = beacon_name unless beacon_name.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#delete_beacon_attachment(attachment_name, project_id: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ProximitybeaconV1beta1::Empty

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

Parameters:

  • attachment_name (String) —

    The attachment name (attachmentName) of the attachment to remove. For example: beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738. For Eddystone-EID beacons, the beacon ID portion (3!893737abc9) may be the beacon's current EID, or its "stable" Eddystone-UID. Required.

  • project_id (String) —

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

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



648
649
650
651
652
653
654
655
656
657
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 648

def delete_beacon_attachment(attachment_name, project_id: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:delete, 'v1beta1/{+attachmentName}', options)
  command.response_representation = Google::Apis::ProximitybeaconV1beta1::Empty::Representation
  command.response_class = Google::Apis::ProximitybeaconV1beta1::Empty
  command.params['attachmentName'] = attachment_name unless attachment_name.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_beacon(beacon_name, project_id: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ProximitybeaconV1beta1::Beacon

Returns detailed information about the specified 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.

Parameters:

  • beacon_name (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.

  • project_id (String) —

    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.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



201
202
203
204
205
206
207
208
209
210
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 201

def get_beacon(beacon_name, project_id: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+beaconName}', options)
  command.response_representation = Google::Apis::ProximitybeaconV1beta1::Beacon::Representation
  command.response_class = Google::Apis::ProximitybeaconV1beta1::Beacon
  command.params['beaconName'] = beacon_name unless beacon_name.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#get_eidparams(quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ProximitybeaconV1beta1::EphemeralIdRegistrationParams

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.

Parameters:

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



152
153
154
155
156
157
158
159
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 152

def get_eidparams(quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/eidparams', options)
  command.response_representation = Google::Apis::ProximitybeaconV1beta1::EphemeralIdRegistrationParams::Representation
  command.response_class = Google::Apis::ProximitybeaconV1beta1::EphemeralIdRegistrationParams
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#getforobserved_beaconinfo(get_info_for_observed_beacons_request_object = nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ProximitybeaconV1beta1::GetInfoForObservedBeaconsResponse

Given one or more beacon observations, returns any beacon information and attachments accessible to your application. Authorize by using the API key for the application.

Parameters:

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



911
912
913
914
915
916
917
918
919
920
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 911

def getforobserved_beaconinfo(get_info_for_observed_beacons_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/beaconinfo:getforobserved', options)
  command.request_representation = Google::Apis::ProximitybeaconV1beta1::GetInfoForObservedBeaconsRequest::Representation
  command.request_object = get_info_for_observed_beacons_request_object
  command.response_representation = Google::Apis::ProximitybeaconV1beta1::GetInfoForObservedBeaconsResponse::Representation
  command.response_class = Google::Apis::ProximitybeaconV1beta1::GetInfoForObservedBeaconsResponse
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_beacon_attachments(beacon_name, project_id: nil, namespaced_type: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ProximitybeaconV1beta1::ListBeaconAttachmentsResponse

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

Parameters:

  • beacon_name (String) —

    Beacon whose attachments should be fetched. 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.

  • project_id (String) —

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

  • namespaced_type (String) —

    Specifies the namespace and type of attachment to include in response in namespace/type format. Accepts */* to specify "all types in all namespaces".

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



705
706
707
708
709
710
711
712
713
714
715
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 705

def list_beacon_attachments(beacon_name, project_id: nil, namespaced_type: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+beaconName}/attachments', options)
  command.response_representation = Google::Apis::ProximitybeaconV1beta1::ListBeaconAttachmentsResponse::Representation
  command.response_class = Google::Apis::ProximitybeaconV1beta1::ListBeaconAttachmentsResponse
  command.params['beaconName'] = beacon_name unless beacon_name.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['namespacedType'] = namespaced_type unless namespaced_type.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_beacon_diagnostics(beacon_name, page_token: nil, page_size: nil, alert_filter: nil, project_id: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ProximitybeaconV1beta1::ListDiagnosticsResponse

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

Parameters:

  • beacon_name (String) —

    Beacon that the diagnostics are for.

  • page_token (String) —

    Requests results that occur after the page_token, obtained from the response to a previous request. Optional.

  • page_size (Fixnum) —

    Specifies the maximum number of results to return. Defaults to

    1. Maximum 1000. Optional.
  • alert_filter (String) —

    Requests only beacons that have the given alert. For example, to find beacons that have low batteries use alert_filter=LOW_BATTERY.

  • project_id (String) —

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

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



874
875
876
877
878
879
880
881
882
883
884
885
886
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 874

def list_beacon_diagnostics(beacon_name, page_token: nil, page_size: nil, alert_filter: nil, project_id: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/{+beaconName}/diagnostics', options)
  command.response_representation = Google::Apis::ProximitybeaconV1beta1::ListDiagnosticsResponse::Representation
  command.response_class = Google::Apis::ProximitybeaconV1beta1::ListDiagnosticsResponse
  command.params['beaconName'] = beacon_name unless beacon_name.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['alertFilter'] = alert_filter unless alert_filter.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_beacons(page_token: nil, q: nil, page_size: nil, project_id: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ProximitybeaconV1beta1::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. 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.

Parameters:

  • page_token (String) —

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

  • q (String) —

    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. 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:1000
  • page_size (Fixnum) —

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

  • project_id (String) —

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

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 508

def list_beacons(page_token: nil, q: nil, page_size: nil, project_id: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/beacons', options)
  command.response_representation = Google::Apis::ProximitybeaconV1beta1::ListBeaconsResponse::Representation
  command.response_class = Google::Apis::ProximitybeaconV1beta1::ListBeaconsResponse
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['q'] = q unless q.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#list_namespaces(project_id: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ProximitybeaconV1beta1::ListNamespacesResponse

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

Parameters:

  • project_id (String) —

    The project id to list namespaces under. Optional.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



118
119
120
121
122
123
124
125
126
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 118

def list_namespaces(project_id: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:get, 'v1beta1/namespaces', options)
  command.response_representation = Google::Apis::ProximitybeaconV1beta1::ListNamespacesResponse::Representation
  command.response_class = Google::Apis::ProximitybeaconV1beta1::ListNamespacesResponse
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#register_beacon(beacon_object = nil, project_id: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ProximitybeaconV1beta1::Beacon

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

Parameters:

  • beacon_object (Google::Apis::ProximitybeaconV1beta1::Beacon) (defaults to: nil)
  • project_id (String) —

    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.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



550
551
552
553
554
555
556
557
558
559
560
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 550

def register_beacon(beacon_object = nil, project_id: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:post, 'v1beta1/beacons:register', options)
  command.request_representation = Google::Apis::ProximitybeaconV1beta1::Beacon::Representation
  command.request_object = beacon_object
  command.response_representation = Google::Apis::ProximitybeaconV1beta1::Beacon::Representation
  command.response_class = Google::Apis::ProximitybeaconV1beta1::Beacon
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#update_beacon(beacon_name, beacon_object = nil, project_id: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ProximitybeaconV1beta1::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. 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.

Parameters:

  • beacon_name (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.

  • beacon_object (Google::Apis::ProximitybeaconV1beta1::Beacon) (defaults to: nil)
  • project_id (String) —

    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.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 253

def update_beacon(beacon_name, beacon_object = nil, project_id: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v1beta1/{+beaconName}', options)
  command.request_representation = Google::Apis::ProximitybeaconV1beta1::Beacon::Representation
  command.request_object = beacon_object
  command.response_representation = Google::Apis::ProximitybeaconV1beta1::Beacon::Representation
  command.response_class = Google::Apis::ProximitybeaconV1beta1::Beacon
  command.params['beaconName'] = beacon_name unless beacon_name.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end

#update_namespace(namespace_name, namespace_object = nil, project_id: nil, quota_user: nil, fields: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::ProximitybeaconV1beta1::Namespace

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

Parameters:

  • namespace_name (String) —

    Resource name of this namespace. Namespaces names have the format: namespaces/namespace.

  • namespace_object (Google::Apis::ProximitybeaconV1beta1::Namespace) (defaults to: nil)
  • project_id (String) —

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

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'generated/google/apis/proximitybeacon_v1beta1/service.rb', line 78

def update_namespace(namespace_name, namespace_object = nil, project_id: nil, quota_user: nil, fields: nil, options: nil, &block)
  command =  make_simple_command(:put, 'v1beta1/{+namespaceName}', options)
  command.request_representation = Google::Apis::ProximitybeaconV1beta1::Namespace::Representation
  command.request_object = namespace_object
  command.response_representation = Google::Apis::ProximitybeaconV1beta1::Namespace::Representation
  command.response_class = Google::Apis::ProximitybeaconV1beta1::Namespace
  command.params['namespaceName'] = namespace_name unless namespace_name.nil?
  command.query['projectId'] = project_id unless project_id.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['fields'] = fields unless fields.nil?
  execute_or_queue_command(command, &block)
end