3DVista Query Parameters
Query Parameters are also known as 3DVista Deeplinks
Definition & Usage
The industry standard naming convention for deeplinks is Query Parameters.
3DVista Query Parameters are attributes and values that can be added at the end of a tour URL published with 3DVista. They can be triggered with either a question mark (?) or a hashtag (#). Multiple attributes can be combined using the ampersand (&).
Example
A query parameter example using the question mark with multiple attributes combined:
?media-index=3&trigger-overlay-name=hotspot5&show-components-tags=employees
Attributes
Opening Media
Media can be:
- panorama
- 360 video
- photo album
- floorplan
playlist number
Hotspots within media
All the attributes below require the related media as well. So ?trigger-overlay-name=hotspot_A won't work. And ?media=1&trigger-overlay-name=hotspot_A will work.
hover
Camera views within media
Rotate the camera view within media. A hashtag is recommended to use for fluid movements without reloading of the tour. The camera movement to that view is fast and can't be changed in speed.
Skin Components
Misc
Custom Query Parameters
You can also create your own query parameters.
Use external data inside 3DVista
One of the great use cases for this, is that before visitors enter your Virtual Tour, they enter a form with their first name. Once they submit the form, the first name can be send over to the 3DVista tour using ?first-name=Ronald with a GET request to make this happen dynamically. And use this custom query parameter to greet the visitor using a Skin title in the 3DVista skin with some custom javascript.
Send data from 3DVista elsewere
You can also create custom query parameters within the Virtual Tour and send those outside 3DVista. For example having a
E-learning use case
Let's say we're building a Virtual Tour for a client that requires its employees to go through a 3DVista e-learning with 3 modules. Some employees only need to complete 1 module, others 2 and others all 3.
What the client needs to know is: who completed which module?
For keeping this use case simple, we trust the employees to fill in honestly their own details.
We built a form, ask employees for their employee number. We sent the form data with a GET request to the 3DVista tour, so that it shows up as ?employee=12345. With some custom code we can save that in 3DVista as the employee goes through a module.
Inside 3DVista we've created a webframe 1 by 1 px to send data to. Once an employee finishes a module, we trigger a webhook with n8n, make or zapier, such as:
https://webhook.360creators.com/webhook/b4955b33-5560-583a-9979-0009fx2f3275
with two custom query parameters. One is the employee number and the other is the module number like:
https://webhook.360creators.com/webhook/b4955b33-5560-583a-9979-0009fx2f3275?employee=12345&module=2
Then from the automation software we can use these variables in any other type of tool that has an API, such as Baserow, Nocodb or Airtable. And from there we give a list to the client to see who finished what.