Ketch

使用说明

Integrate Ketch into the workflow. Retrieve and update consent preferences, manage subscription topics and controls, and submit data subject rights requests for access, deletion, correction, or processing restriction.

工具

`ketch_get_consent`

Retrieve consent status for a data subject. Returns the current consent preferences for each configured purpose.

输入

参数	类型	必填	描述
`organizationCode`	string	是	Ketch organization code
`propertyCode`	string	是	Digital property code defined in Ketch
`environmentCode`	string	是	Environment code defined in Ketch (e.g., "production")
`jurisdictionCode`	string	否	Jurisdiction code (e.g., "gdpr", "ccpa")
`identities`	json	是	Identity map (e.g., {"email": "user@example.com"})
`purposes`	json	否	Optional purposes to filter the consent query

输出

参数	类型	描述
`purposes`	object	Map of purpose codes to consent status and legal basis
↳ `allowed`	string	Consent status for the purpose: "granted" or "denied"
↳ `legalBasisCode`	string	Legal basis code (e.g., "consent_optin", "consent_optout", "disclosure", "other")
`vendors`	object	Map of vendor consent statuses

`ketch_set_consent`

Update consent preferences for a data subject. Sets the consent status for specified purposes with the appropriate legal basis.

输入

参数	类型	必填	描述
`organizationCode`	string	是	Ketch organization code
`propertyCode`	string	是	Digital property code defined in Ketch
`environmentCode`	string	是	Environment code defined in Ketch (e.g., "production")
`jurisdictionCode`	string	否	Jurisdiction code (e.g., "gdpr", "ccpa")
`identities`	json	是	Identity map (e.g., {"email": "user@example.com"})
`purposes`	json	是	Map of purpose codes to consent settings (e.g., {"analytics": {"allowed": "granted", "legalBasisCode": "consent_optin"}})
`collectedAt`	number	否	UNIX timestamp when consent was collected (defaults to current time)

输出

参数	类型	描述
`purposes`	object	Updated consent status map of purpose codes to consent settings
↳ `allowed`	string	Consent status for the purpose: "granted" or "denied"
↳ `legalBasisCode`	string	Legal basis code (e.g., "consent_optin", "consent_optout", "disclosure", "other")

`ketch_get_subscriptions`

Retrieve subscription preferences for a data subject. Returns the current subscription topic and control statuses.

输入

参数	类型	必填	描述
`organizationCode`	string	是	Ketch organization code
`propertyCode`	string	是	Digital property code defined in Ketch
`environmentCode`	string	是	Environment code defined in Ketch (e.g., "production")
`identities`	json	是	Identity map (e.g., {"email": "user@example.com"})

输出

参数	类型	描述
`topics`	object	Map of topic codes to contact method settings (e.g., {"newsletter": {"email": {"status": "granted"}}})
`controls`	object	Map of control codes to settings (e.g., {"global_unsubscribe": {"status": "denied"}})

`ketch_set_subscriptions`

Update subscription preferences for a data subject. Sets topic and control statuses for email, SMS, and other contact methods.

输入

参数	类型	必填	描述
`organizationCode`	string	是	Ketch organization code
`propertyCode`	string	是	Digital property code defined in Ketch
`environmentCode`	string	是	Environment code defined in Ketch (e.g., "production")
`identities`	json	是	Identity map (e.g., {"email": "user@example.com"})
`topics`	json	否	Map of topic codes to contact method settings (e.g., {"newsletter": {"email": {"status": "granted"}, "sms": {"status": "denied"}}})
`controls`	json	否	Map of control codes to settings (e.g., {"global_unsubscribe": {"status": "denied"}})

输出

参数	类型	描述
`success`	boolean	Whether the subscription preferences were updated

`ketch_invoke_right`

Submit a data subject rights request (e.g., access, delete, correct, restrict processing). Initiates a privacy rights workflow in Ketch.

输入

参数	类型	必填	描述
`organizationCode`	string	是	Ketch organization code
`propertyCode`	string	是	Digital property code defined in Ketch
`environmentCode`	string	是	Environment code defined in Ketch (e.g., "production")
`jurisdictionCode`	string	是	Jurisdiction code (e.g., "gdpr", "ccpa")
`rightCode`	string	是	Privacy right code to invoke (e.g., "access", "delete", "correct", "restrict_processing")
`identities`	json	是	Identity map (e.g., {"email": "user@example.com"})
`userData`	json	否	Optional data subject information (e.g., {"email": "user@example.com", "firstName": "John", "lastName": "Doe"})

输出

参数	类型	描述
`success`	boolean	Whether the rights request was submitted
`message`	string	Response message from Ketch

Ketch

On this page