consent_decisions
Creates, updates, deletes, gets or lists a consent_decisions resource.
Overview​
| Name | consent_decisions |
| Type | Resource |
| Id | ovh.me.consent_decisions |
Fields​
The following fields are returned by SELECT queries:
- get
successful operation
| Name | Datatype | Description |
|---|---|---|
campaign | string | Campaign name |
history | array | Consent decisions history for this campaign |
pixel | object | Optional pixel tracking consent |
type | string | Campaign type (OPTIN, OPTOUT) |
value | boolean | Current email consent value |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | campaign_name | Get decision value for a consent campaign | |
update | update | campaign_name | Update decision of a consent campaign |
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"}}) |
campaign_name | string | Campaign name (wire: campaignName) |
SELECT examples​
- get
Get decision value for a consent campaign
SELECT
campaign,
history,
pixel,
type,
value
FROM ovh.me.consent_decisions
WHERE campaign_name = '{{ campaign_name }}' -- required
;
UPDATE examples​
- update
Update decision of a consent campaign
UPDATE ovh.me.consent_decisions
SET
pixel = '{{ pixel }}',
value = {{ value }}
WHERE
campaign_name = '{{ campaign_name }}' --required;