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