v1

latestOpenAPI 3.0.22026-07-1319091298.3 KB

notices

Retrieve a notice configuration

Returns a single notice configuration

get/widgets/notices/configs/{id}

Path parameters

idstring required

The ID of the notice configuration to retrieve

Query parameters

Flag to indicate the response should be returned as an attachment (interpreted as true if present regardless of value)

Headers

v'1' | '2'

Header to indicate Notice-Config API version. 1: Legacy. 2: Multi-Regulation

Response

A NoticeConfig object

idstring required

The ID of the configuration

organization_idstring required

The ID of the organization that owns this configuration

notice_idstring required

The ID of the notice that this configuration belongs to

platformstring

Platform (web, amp, mobile, or television) that this notice is running on

defaultboolean

Whether the notice should be used when no other notice is available and matching the target. If default is set to true, targets must be empty.

targetsstring[]

custom_jsonobject

Custom JSON that will be merged into the final SDK configuration for GDPR

configobject

Configuration of the notice

full_atpboolean

Whether the notice uses the ATP vendors selected by Didomi (false) or if it uses the client's ATP vendor selection (true)

text_modestring

Whether the notice is using a custom or an approved text. Possible values: approved, custom.

text_idstring

ID of an approved notice text if this notice is configured for using an approved text in "text_mode"

template_idstring

The ID of the notice template associated with this notice. "null" if this notice does not use configuration from a template.

enable_ignore_consent_beforeboolean

Whether the consent must be recollected after a certain date.

ignore_consent_beforestring

The date after which consent must be recollected if "enable_ignore_consent_before" is set to true.

negative_action'button' | 'link'

What negative action should be displayed in the notice: Disagree to all ("button"), Continue without agreeing ("link") or no negative action (null)

negative_action_linkboolean

Whether negative action should be a link or not.

negative_action_link_format'text' | 'cross'

What format of negative action link should be displayed in the notice: Link with te text Continue without agreeing or link with the X icon.

negative_action_buttonboolean

Whether negative action should be a button or not.

disagree_button_style'primary' | 'secondary'

The style of the Disagree button

countrystring

The country that the consent notice belongs to (two letter ISO code)

notice_deny_applies_to_liboolean

Do not keep legitimate interest enabled when the user disagrees in the notice

preferences_deny_applies_to_liboolean

Do not keep legitimate interest enabled when the user clicks on "Disagree to all" in the Preferences

consent_durationnumber

The duration that applies to collected consent. Consent is recollected after the expiration of the duration

consent_duration_unit'months' | 'days' | 'seconds'

The unit of the consent duration

denied_consent_durationnumber

The duration that applies to fully negative consent. Consent is recollected after the expiration of the duration

denied_consent_duration_unit'months' | 'days' | 'seconds'

The unit of the denied consent duration

denied_consent_duration_customboolean

Whether the duration for denied consent is different from the generic

cross_device_enabledboolean

Whether the cross device feature is enabled

cross_device_timeoutnumber

The timeout that applies to sync with consent notice

gcm_enabledboolean

Whether Google consent mode is enabled

gcm_tcf_enabledboolean

Whether the Google consent mode TCF integration is enabled

gcm_set_default_statusboolean

Whether to set the default status for analytics and ads

gcm_data_layer_namestring

Data layer name for Google consent mode

gcm_analytics_default_statusboolean

Default status for analytics in Google Consent Mode

gcm_ads_default_statusboolean

Default status for ads in Google Consent Mode

gcm_functionality_default_statusboolean

Default status for functionality of the website e.g. language settings in Google Consent Mode

gcm_personalization_default_statusboolean

Default status for personalization in Google Consent Mode

gcm_security_default_statusboolean

Default status for security in Google Consent Mode

gcm_ad_user_data_default_statusboolean

Default status for ad user data in Google Consent Mode

gcm_ad_personalization_default_statusboolean

Default status for ad personalization in Google Consent Mode

microsoft_enabledboolean

Whether Microsoft consent mode is enabled

microsoft_set_default_statusboolean

Whether to set the default status for ad storage in Microsoft Consent Mode

microsoft_ad_storage_default_statusboolean

Default status for ad storage in Microsoft Consent Mode

microsoft_enable_tcf_advertiser_consent_modeboolean

Whether to enable TCF advertiser consent mode in Microsoft Consent Mode

amazon_enabledboolean

Whether Amazon consent mode is enabled

amazon_set_default_statusboolean

Whether to set the default status for ads/user data in Amazon Consent Mode

amazon_ad_storage_default_statusboolean

Default status for ad storage in Amazon Consent Mode

amazon_ad_user_data_default_statusboolean

Default status for ad user data in Amazon Consent Mode

wordpress_enabledboolean

Whether WordPress consent mode is enabled

gcm_firebase_enabledboolean

Whether Firebase SDK is enabled for GCM third-party SDKs

gcm_airbridge_enabledboolean

Whether Airbridge SDK is enabled for GCM third-party SDKs

gcm_kochava_enabledboolean

Whether Kochava SDK is enabled for GCM third-party SDKs

gcm_branch_enabledboolean

Whether Branch SDK is enabled for GCM third-party SDKs

gcm_appsflyer_enabledboolean

Whether AppsFlyer SDK is enabled for GCM third-party SDKs

ctv_focus_on_agree_and_closeboolean

Whether the consent notice initial focus is on the Agree and Close button

secure_cookiesboolean

Whether SDKs should create secure cookies on HTTPS websites

gpp_enabledboolean

Whether GPP is enabled

gpp_mspa_signatoryboolean

Whether GPP MSPA signatory is enabled

gpp_mspa_mode'service_provider' | 'opt_out'

GPP MSPA mode (service provider or opt out)

gpp_mspa_generate_usnat_stringboolean

Whether to generate the US national string when MSPA is enabled

deployed_atstring

Date of deployment of this configuration

deployed_bystring

The ID of the user that deployed this configuration

deployed_by_typestring

The type of an ID (deployed_by) that deployed the notice

deployed_by_namestring

The name of the user that deployed this configuration

created_atstring date-time

Creation date of the configuration

updated_atstring date-time

Last update date of the configuration

versionnumber

Revision number of the configuration

notice_disabledboolean

Whether the notice is disabled

consent_string_partners_encodingstring

The encoding selected for the partners section in the didomi consent string: One of "bit_field_2_bits", "ranges_u16", "ranges_fibonacci"

consent_string_purposes_encodingstring

The encoding selected for the purposes section in the didomi consent string: One of "bit_field_2_bits", "ranges_u16", "ranges_fibonacci"

enable_web_viewboolean

Whether the web view is enabled

notice_active_elements_orderobject

The order of active elements in the notice

dismiss_button_enabledboolean

Whether the dismiss button (Agree & Close) is enabled

preferences_title_enabledboolean

Whether the title is enabled in the preferences view

preferences_cross_button_enabledboolean

Whether the cross button (top right) is enabled in the preferences view

preferences_view_all_partners_button_enabledboolean

Whether the view all partners button is enabled in the preferences view

preferences_active_elements_orderobject

The order of active elements (buttons) in the preferences view