Skip to content

GMBPlaceActionsApi.md

Latest commit

 

History

History
313 lines (226 loc) · 11.2 KB

GMBPlaceActionsApi.md

File metadata and controls

313 lines (226 loc) · 11.2 KB

Zernio::GMBPlaceActionsApi

All URIs are relative to https://zernio.com/api

Method HTTP request Description
create_google_business_place_action POST /v1/accounts/{accountId}/gmb-place-actions Create action link
delete_google_business_place_action DELETE /v1/accounts/{accountId}/gmb-place-actions Delete action link
list_google_business_place_actions GET /v1/accounts/{accountId}/gmb-place-actions List action links
update_google_business_place_action PATCH /v1/accounts/{accountId}/gmb-place-actions Update action link

create_google_business_place_action

create_google_business_place_action(account_id, create_google_business_place_action_request, opts)

Create action link

Creates a place action link for a location. Available action types: APPOINTMENT, ONLINE_APPOINTMENT, DINING_RESERVATION, FOOD_ORDERING, FOOD_DELIVERY, FOOD_TAKEOUT, SHOP_ONLINE.

Examples

require 'time'
require 'zernio-sdk'
# setup authorization
Zernio.configure do |config|
  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Zernio::GMBPlaceActionsApi.new
account_id = 'account_id_example' # String | 
create_google_business_place_action_request = Zernio::CreateGoogleBusinessPlaceActionRequest.new({uri: 'uri_example', place_action_type: 'APPOINTMENT'}) # CreateGoogleBusinessPlaceActionRequest | 
opts = {
  location_id: 'location_id_example' # String | Override which location to target. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
}

begin
  # Create action link
  result = api_instance.create_google_business_place_action(account_id, create_google_business_place_action_request, opts)
  p result
rescue Zernio::ApiError => e
  puts "Error when calling GMBPlaceActionsApi->create_google_business_place_action: #{e}"
end

Using the create_google_business_place_action_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_google_business_place_action_with_http_info(account_id, create_google_business_place_action_request, opts)

begin
  # Create action link
  data, status_code, headers = api_instance.create_google_business_place_action_with_http_info(account_id, create_google_business_place_action_request, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CreateGoogleBusinessPlaceAction200Response>
rescue Zernio::ApiError => e
  puts "Error when calling GMBPlaceActionsApi->create_google_business_place_action_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
account_id String
create_google_business_place_action_request CreateGoogleBusinessPlaceActionRequest
location_id String Override which location to target. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs. [optional]

Return type

CreateGoogleBusinessPlaceAction200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

delete_google_business_place_action

delete_google_business_place_action(account_id, name, opts)

Delete action link

Deletes a place action link (e.g. booking or ordering URL) from a GBP location.

Examples

require 'time'
require 'zernio-sdk'
# setup authorization
Zernio.configure do |config|
  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Zernio::GMBPlaceActionsApi.new
account_id = 'account_id_example' # String | 
name = 'name_example' # String | The resource name of the place action link (e.g. locations/123/placeActionLinks/456)
opts = {
  location_id: 'location_id_example' # String | Override which location to target. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
}

begin
  # Delete action link
  result = api_instance.delete_google_business_place_action(account_id, name, opts)
  p result
rescue Zernio::ApiError => e
  puts "Error when calling GMBPlaceActionsApi->delete_google_business_place_action: #{e}"
end

Using the delete_google_business_place_action_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> delete_google_business_place_action_with_http_info(account_id, name, opts)

begin
  # Delete action link
  data, status_code, headers = api_instance.delete_google_business_place_action_with_http_info(account_id, name, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DeleteGoogleBusinessPlaceAction200Response>
rescue Zernio::ApiError => e
  puts "Error when calling GMBPlaceActionsApi->delete_google_business_place_action_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
account_id String
name String The resource name of the place action link (e.g. locations/123/placeActionLinks/456)
location_id String Override which location to target. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs. [optional]

Return type

DeleteGoogleBusinessPlaceAction200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

list_google_business_place_actions

list_google_business_place_actions(account_id, opts)

List action links

Lists place action links for a Google Business Profile location. Place actions are the booking, ordering, and reservation buttons that appear on your listing.

Examples

require 'time'
require 'zernio-sdk'
# setup authorization
Zernio.configure do |config|
  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Zernio::GMBPlaceActionsApi.new
account_id = 'account_id_example' # String | 
opts = {
  location_id: 'location_id_example', # String | Override which location to query. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs.
  page_size: 56, # Integer | 
  page_token: 'page_token_example' # String | 
}

begin
  # List action links
  result = api_instance.list_google_business_place_actions(account_id, opts)
  p result
rescue Zernio::ApiError => e
  puts "Error when calling GMBPlaceActionsApi->list_google_business_place_actions: #{e}"
end

Using the list_google_business_place_actions_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> list_google_business_place_actions_with_http_info(account_id, opts)

begin
  # List action links
  data, status_code, headers = api_instance.list_google_business_place_actions_with_http_info(account_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ListGoogleBusinessPlaceActions200Response>
rescue Zernio::ApiError => e
  puts "Error when calling GMBPlaceActionsApi->list_google_business_place_actions_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
account_id String
location_id String Override which location to query. If omitted, uses the account's selected location. Use GET /gmb-locations to list valid IDs. [optional]
page_size Integer [optional][default to 100]
page_token String [optional]

Return type

ListGoogleBusinessPlaceActions200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

update_google_business_place_action

update_google_business_place_action(account_id, update_google_business_place_action_request, opts)

Update action link

Updates a place action link (change URL or action type). Only the fields included in the request body will be updated.

Examples

require 'time'
require 'zernio-sdk'
# setup authorization
Zernio.configure do |config|
  # Configure Bearer authorization (JWT): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Zernio::GMBPlaceActionsApi.new
account_id = 'account_id_example' # String | 
update_google_business_place_action_request = Zernio::UpdateGoogleBusinessPlaceActionRequest.new({name: 'name_example'}) # UpdateGoogleBusinessPlaceActionRequest | 
opts = {
  location_id: 'location_id_example' # String | Override which location to target. If omitted, uses the account's selected location.
}

begin
  # Update action link
  result = api_instance.update_google_business_place_action(account_id, update_google_business_place_action_request, opts)
  p result
rescue Zernio::ApiError => e
  puts "Error when calling GMBPlaceActionsApi->update_google_business_place_action: #{e}"
end

Using the update_google_business_place_action_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> update_google_business_place_action_with_http_info(account_id, update_google_business_place_action_request, opts)

begin
  # Update action link
  data, status_code, headers = api_instance.update_google_business_place_action_with_http_info(account_id, update_google_business_place_action_request, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <UpdateGoogleBusinessPlaceAction200Response>
rescue Zernio::ApiError => e
  puts "Error when calling GMBPlaceActionsApi->update_google_business_place_action_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
account_id String
update_google_business_place_action_request UpdateGoogleBusinessPlaceActionRequest
location_id String Override which location to target. If omitted, uses the account's selected location. [optional]

Return type

UpdateGoogleBusinessPlaceAction200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json