local_seo_locations

Creates, updates, deletes, gets or lists a local_seo_locations resource.

Overview

Name	local_seo_locations
Type	Resource
Id	ovh.hosting_web.local_seo_locations

Fields

The following fields are returned by SELECT queries:

get

successful operation

Name	Datatype	Description
id	integer	Location id
name	string	Name of the location
account_id	integer	Account id (wire: accountId)
task_id	integer	Running task associated to the location (wire: taskId)
address	string	Address of the location
country	string	Country of the location (FR)
creation_date	string (date-time)	Date of the installation of the location (wire: creationDate)
last_update	string (date-time)	Date of the last location's update (wire: lastUpdate)
offer	string	Local SEO offer for this location (normal)
status	string	Current status of the location (created, creating, deleting, updating)

list

Local SEO locations

Name	Datatype	Description
id	integer	Location id
name	string	Name of the location
account_id	integer	Account id (wire: accountId)
task_id	integer	Running task associated to the location (wire: taskId)
address	string	Address of the location
country	string	Country of the location (FR)
creation_date	string (date-time)	Date of the installation of the location (wire: creationDate)
last_update	string (date-time)	Date of the last location's update (wire: lastUpdate)
offer	string	Local SEO offer for this location (normal)
status	string	Current status of the location (created, creating, deleting, updating)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id, service_name		Get a local SEO location. Returns the name, address, country, offer and status of the location, with its creation and last update dates.
list	select	service_name	x_pagination_mode	List local SEO locations. Returns the IDs of the local SEO locations of the hosting. Each location is a business listed in online directories.
service_infos_update	exec	id, serviceName, renew		Update location renewal. Updates the renewal settings of the location: automatic renewal, renewal period and deletion at expiration.
terminate	exec	id, serviceName		Terminate a local SEO location. Requests the termination of the location. A link to confirm it is sent by email to the administrator contact.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
id	integer	Location id
serviceName	string	The internal name of your hosting
service_name	string	The internal name of your hosting (wire: serviceName)
x_pagination_mode	string	Sent as CachedObjectList-Pages by default so the list returns the full objects rather than their identifiers. (wire: X-Pagination-Mode)

SELECT examples

get

Get a local SEO location. Returns the name, address, country, offer and status of the location, with its creation and last update dates.

SELECT
id,
name,
account_id,
task_id,
address,
country,
creation_date,
last_update,
offer,
status
FROM ovh.hosting_web.local_seo_locations
WHERE id = '{{ id }}' -- required
AND service_name = '{{ service_name }}' -- required
;

list

List local SEO locations. Returns the IDs of the local SEO locations of the hosting. Each location is a business listed in online directories.

SELECT
id,
name,
account_id,
task_id,
address,
country,
creation_date,
last_update,
offer,
status
FROM ovh.hosting_web.local_seo_locations
WHERE service_name = '{{ service_name }}' -- required
AND x_pagination_mode = '{{ x_pagination_mode }}'
;

Lifecycle Methods

EXEC variables use wire (API) names.

service_infos_update

Update location renewal. Updates the renewal settings of the location: automatic renewal, renewal period and deletion at expiration.

EXEC ovh.hosting_web.local_seo_locations.service_infos_update 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required 
@@json=
'{
"renew": "{{ renew }}"
}'
;

terminate

Terminate a local SEO location. Requests the termination of the location. A link to confirm it is sent by email to the administrator contact.

EXEC ovh.hosting_web.local_seo_locations.terminate 
@id='{{ id }}' --required, 
@serviceName='{{ serviceName }}' --required
;