consentmanager API SDK Android
API
Constructeur
Constructeur pour créer un objet CmpManager
Paramètres
| Nom | Type |
Description |
| contexte | Comportementale |
Le contexte de l'application |
| config | CMPConfig |
L'objet de configuration pour le consent manager |
| closeÉcouteur | OnCloseCallback |
Le rappel à invoquer lorsque la couche de consentement est fermée |
| openListener | OnOpenCallback |
Le rappel à invoquer lorsque la couche de consentement est ouverte |
| cmpNotOpenedCallback | SurCMPNotOpenedCallback |
Le rappel à invoquer lorsque la couche de consentement n'a pas pu être ouverte |
| onErrorCallback | OnErrorCallback |
Le rappel à invoquer lorsqu'une erreur |
openCustomLayer
Ouvre la couche de consentement personnalisée
Paramètres
| Nom | Type |
Description |
| activité | FragmentActivité |
L'instance d'activité où la couche de consentement doit être affichée |
| containerViewId | @IdRes Int |
L'ID de l'interface utilisateur du conteneur dans laquelle la couche de consentement doit être affichée |
Retour
Une fonction sans valeur de retour
Exemple
val activity = requireActivity()
val containerViewId = R.id.container
openCustomLayer(activity, containerViewId)
checkAndOpenConsentLayer
Vérifiez et ouvrez éventuellement la couche de consentement.
Paramètres
| Nom | Type |
Description |
| contexte | Comportementale |
L'objet de contexte de l'application. |
Exemple
val cmpManager = CmpManager()
cmpManager.checkAndOpenConsentLayer(context)
openCmpLayer
Renvoie si le but (id) a le droit de définir des cookies
Paramètres
| Nom | Type |
Description |
| contexte | Comportementale |
Le contexte de l'application |
| id | Chaîne |
L'identifiant du but Attention : L'ID d'objectif est le même que celui indiqué dans la liste d'objectifs et peut avoir un préfixe comme C |
| checkConsent | Boolean |
|
Retour
| Type | Description |
| Boolean | Un booléen indiquant si le fournisseur a le consentement pour définir des cookies. |
Exemple
val vendorID = "1234"
val checkConsent = true
val result = hasVendorConsent(context, vendorID, checkConsent)
if (result) {
// Vendor has the rights to set cookies
} else {
// Vendor does not have the rights to set cookies
}
hasVendorConsent
Renvoie si le fournisseur (id) a le droit de définir des cookies
Paramètres
| Nom | Type |
Description |
| id | Chaîne: |
L'identifiant du vendeur Attention : L'identifiant du fournisseur est le même que celui indiqué dans la liste des objectifs et peut avoir un préfixe tel que C |
Retour
| Type | Description |
| Boolean | Si le but a le consentement pour définir des cookies |
Exemple
val vendorId = "S123"
consentTool.hasVendor(vendorId)
a un but
Renvoie si le but (id) a le droit de définir des cookies
Paramètres
| Nom | Type |
Description |
| id | Chaîne: |
L'identifiant du but Attention : L'ID d'objectif est le même que celui indiqué dans la liste d'objectifs et peut avoir un préfixe comme C |
Retour
| Type | Description |
| Boolean | Si le but a le consentement pour définir des cookies |
Exemple
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
getVendorString
Renvoie si le but (id) a le droit de définir des cookies
Paramètres
| Nom | Type |
Description |
| id | Chaîne: |
L'identifiant du but Attention : L'ID d'objectif est le même que celui indiqué dans la liste d'objectifs et peut avoir un préfixe comme C |
Retour
| Type | Description |
| Boolean | Si le but a le consentement pour définir des cookies |
Exemple
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
getPurposeString
Renvoie la chaîne de buts, qui a été définie par consentmanager
Paramètres
aucun paramètre
Retour
| Type | Description |
| Chaîne |
La chaîne d'objectifs définie par consentmanager
|
Exemple
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
getPurposes
Renvoie la chaîne de buts, qui a été définie par consentmanager dans un objet Liste
Paramètres
| Nom | Type |
Description |
| id | Chaîne: |
L'identifiant du but Attention : L'ID d'objectif est le même que celui indiqué dans la liste d'objectifs et peut avoir un préfixe comme C |
Retour
| Type | Description |
| Boolean | Si le but a le consentement pour définir des cookies |
Exemple
val vendorId = "S123"
consentTool.hasPurpose(vendorId)
Ancien aperçu (à déterminer)
|
API |
Paramètres | Retour |
Description
|
|
openCmpConsentToolView( Contexte Contexte ) |
contexte: Le contexte de l'application | annuler | Affiche une vue modale avec la vue Web de consentement. Si la Conformité est acceptée ou rejetée, une fonction de clôture sera appelée. Vous pouvez remplacer cette fonction de fermeture par la vôtre. Par conséquent, implémentez OnCloseCallback et ajoutez-le en tant que paramètre. Interface utilisateur @apiNote -> exemple : Ouvrir la couche par action de bouton |
|
openCmpConsentToolView( Contexte contextuel, Rappel OnCloseCallback ) |
contexte: Le contexte de l'application
rappeler: Le OnCloseCallback qui doit être appelé lorsque la vue Web est fermée par action
|
annuler | Affiche une vue modale avec la vue Web de consentement. Si la Conformité est acceptée ou rejetée, une fonction de fermeture sera appelée. Vous pouvez remplacer cette fonction de fermeture par la vôtre. Pour cela, implémentez le OnCloseCallback et donnez-le à cette fonction. Cette méthode n'enverra plus de demande au serveur consentTool. Il utilisera le dernier état. Si vous souhaitez uniquement ouvrir à nouveau la vue de l'outil de consentement, si le serveur donne un statut de réponse == 1 utilisez la méthode checkAndProceedConsentUpdate @apiNote Interface utilisateur -> exemple : Ouvrir le calque par action de bouton |
|
setCloseCmpConsentToolViewListener( Rappel OnCloseCallback ) |
rappeler: Le OnCloseCallback qui doit être appelé lorsque la vue Web est fermée par action | annuler | Définit un écouteur. Si la Conformité est acceptée ou rejetée, cette fonction sera appelée. Vous pouvez remplacer cette fonction de fermeture par la vôtre. À cet effet, implémentez OnCloseCallback et ajoutez-le en tant que paramètre. |
|
setCustomCmpConsentToolViewAction( CustomOpenActionCallback customAction ) |
customAction : la customAction qui doit être appelée, en plus d'afficher le consentTool | annuler | Définit une action personnalisée sur une réponse du serveur. |
|
setErrorDialogCmpConsentToolViewListener( Rappel OnErrorDialogCallback ) |
rappeler: Le OnOpenCallback, qui doit être appelé, lorsque la vue sera ouverte. | annuler | Définit un écouteur. Si la vue de conformité est ouverte, cette fonction sera appelée. Vous pouvez remplacer cette fonction ouverte par la vôtre. Pour cela, implémentez OnOpenCallback et ajoutez-le en tant que paramètre. |
|
setNetworkErrorExceptionListener( Rappel OnNetworkExceptionCallback ) |
rappeler: Le OnErrorNetworkCallback qui doit être appelé. | annuler | Définit un écouteur qui est appelé, si une erreur réseau se produit. |
|
setOnCMPNotOpenedCallback( Rappel OnCMPNotOpenedCallback ) |
rappeler: L'action cmpNotOpenedCallback qui sera appelée | annuler | Définit une action lorsque le Consentlayer ne va pas s'ouvrir |
|
setOpenCmpConsentToolViewListener( Contexte contextuel, Bouton gdprBouton ) |
contexte: Puis Contexte de l'App bouton gdpr: Le bouton, le openCmpConsentToolViewListener doit être ajouté à |
annuler | Définit un écouteur sur le bouton donné. Si le bouton est cliqué, une vue modale sera affichée avec la vue Web de consentement. Si la Conformité est acceptée ou rejetée, une fonction de fermeture sera appelée. Vous pouvez remplacer cette fonction de fermeture par la vôtre. Pour cela, implémentez OnCloseCallback et ajoutez-le comme autre paramètre. Si le paramètre n'est pas défini, mais que setCloseCmpConsentToolViewListener a été utilisé pour ajouter un écouteur à l'événement de fermeture, celui-ci sera utilisé. |
|
setOpenCmpConsentToolViewListener( Contexte contextuel, Bouton gdprButton, Rappel OnCloseCallback ) |
contexte: Le contexte de l'application bouton gdpr: Le bouton, le openCmpConsentToolViewListener doit être ajouté à
rappeler: Le OnCloseCallback qui doit être appelé lorsque la vue Web est fermée par action |
annuler | Définit un écouteur sur le bouton donné. Si vous cliquez sur le bouton, une vue modale sera affichée avec la vue Web de consentement. Si la Conformité est acceptée ou rejetée, une fonction de clôture sera appelée. Vous pouvez remplacer cette fonction de fermeture par la vôtre. Par conséquent, implémentez OnCloseCallback et ajoutez-le comme dernier paramètre. |
|
setOpenCmpConsentToolViewListener( Rappel OnCloseCallback ) |
rappeler: Le OnCloseCallback qui doit être appelé lorsque la vue Web est fermée par action |
annuler | Définit un écouteur. Si la vue de conformité est ouverte, cette fonction sera appelée. Vous pouvez remplacer cette fonction ouverte par la vôtre. Pour cela, implémentez OnOpenCallback et ajoutez-le en tant que paramètre. |
|
setOpenPlaceHolderViewListener( Contexte contextuel, Bouton bouton, Fournisseur de cordes ) |
contexte: Le contexte de l'application bouton (dans la fenêtre de contrôle qui apparaît maintenant): Un bouton d'action pour créer la vue d'espace réservé vendeur: Le fournisseur qui est affecté à l'espace réservé |
annuler | Ouvre la vue d'espace réservé en cliquant sur le bouton pour le fournisseur attribué |
|
|
|||
|
appeléCeJour( contexte contextuel) |
contexte: Le contexte de l'application |
booléen: si le serveur a déjà été contacté ce jour | Renvoie si le serveur a déjà été contacté ce jour. |
|
clearAllValues(Contexte contextuel) |
contexte: Le contexte de l'application |
annuler | Réinitialise les données de consentement |
|
createPlaceholder( Contexte contextuel, CMPPlaceholderParams cmpPlaceholderParams, CmpPlaceholderEventListener cmpPlaceholderEventListener) |
contexte: Le contexte de l'application cmpPlaceholderParams : attribuer les paramètres d'espace réservé requis cmpPlaceholderEventListener: Interface EventListener pour les fonctions de processus personnalisées |
CmpPlaceholder & #XNUMX;: UIView de l'espace réservé | Crée une vue d'espace réservé pour le blocage de contenu dynamique |
|
exportCMPData(Contexte contextuel) |
contexte: Le contexte de l'application |
Chaîne: la chaîne de consentement | Une fonction d'exportation qui peut être appelée pour exporter la chaîne de consentement complète générée par un ConsentWebView et enregistrée dans les préférences partagées de cet appareil. |
|
getCalledLast (contexte contextuel) |
contexte: Le contexte de l'application |
Date: Date à laquelle le serveur a été appelé pour la dernière fois | Donne des informations sur la dernière date à laquelle le serveur a été contacté |
|
getConfig() |
|
CMPConfig: Objet CMPConfig |
Renvoie le CMPConfig qui est défini actuellement |
|
getGoogleACString() |
contexte: Le contexte de l'application |
Chaîne: chaîne de confidentialité américaine des fournisseurs qui a été définie consentmanager |
Renvoie la chaîne de confidentialité américaine, qui a été définie par consentmanager |
|
getInstance() |
|
CMPConsentTool: L'instant singleton initialisé du consentmanager |
Renvoie le CMPConsentTool. Si vous n'avez pas initialisé le CMPConsentTool avant, l'exception CMPConsentToolInitialisation sera levée. |
|
getInstanceUnsafe() |
|
CMPConsentTool: l'Instant singleton initialisé du consent Manager, ou nul. |
Renvoie le CMPConsentTool, ou null s'il n'a pas été initialisé. Cette méthode n'est pas sûre, car elle peut conduire à des exceptions de pointeur nul, mais si vous êtes sûr que ConsentTool a été initialisé auparavant, vous pouvez utiliser cette méthode, sans avoir besoin de détecter l'erreur. Nous vous recommandons de sauvegarder l'objet renvoyé de la méthode createInstant, d'utiliser les méthodes de la consentManager. |
|
getLastConsentString( contexte contextuel) |
contexte: Le contexte de l'application |
Chaîne: La dernière chaîne de consentement définie |
Renvoie le dernier consentement donné, présenté en base64 par consentManager |
|
getPurposes(Contexte contextuel) |
contexte: Le contexte de l'application |
Chaîne: La chaîne d'objectifs qui a été définie par consentmanager |
Renvoie la chaîne de buts, qui a été définie par consentmanager |
|
getUSPrivacyString (contexte contextuel) |
contexte: Le contexte de l'application |
Chaîne: La chaîne de confidentialité américaine des fournisseurs qui a été définie par consentmanager |
Renvoie la chaîne de confidentialité américaine, qui a été définie par consentmanager |
|
getVendorsString (contexte contextuel) |
contexte: Le contexte de l'application |
Chaîne: La chaîne de fournisseurs définie par consentmanager |
Renvoie la chaîne du fournisseur, qui a été définie par consentmanager |
|
hasPurposeConsent(contexte contextuel, Identifiant de chaîne, booléen isIABPurpose) |
contexte: le contexte de l'application id: L'identifiant du but estIABPonjet: Si l'objectif est défini par la norme IAB (V1/V2) |
booléen: Si le but a le consentement pour définir des cookies |
Renvoie, si le but (id) a le droit de définir des cookies. Attention: L'ID d'objectif est le même que celui indiqué dans la liste d'objectifs et peut avoir un préfixe tel que C |
|
hasVendorConsent( Contexte contextuel, Identifiant de chaîne, booléen isIABVendor) |
contexte: Le contexte de l'application id: L'identifiant du vendeur isIABVendor: si le fournisseur est défini par la norme IAB (V1/V2) |
booléen: Si le Vendeur a le Consentement à installer des cookies. |
Renvoie, si le vendeur (id) a le droit de définir des cookies
Attention : L'identifiant du fournisseur est le même que celui affiché dans la liste des fournisseurs et peut avoir un préfixe tel que C, S |
|
importCMPData( Contexte contextuel, Chaîne cmpData ) |
contexte: Le contexte de l'application cmpDonnées: La chaîne qui sera définie. La chaîne de consentement doit être transmise encodée en base64 |
booléen: Si l'importation a réussi, ou si des erreurs se produisent dans la chaîne |
Une méthode d'importation qui peut être appelée pour importer le ConsentString complet généré par un ConsentWebView dans les préférences partagées de cet appareil. |
|
besoinsAcceptation(Contexte contextuel) |
contexte: Le contexte de l'application |
booléen: si l'utilisateur doit donner son consentement |
Renvoie si l'utilisateur doit donner un consentement, parce qu'il ne l'a pas fait dans le passé, ou parce que le serveur de consentement a renvoyé, qu'un nouveau consentement est requis |
|
besoinsServeurUpdate(Contexte contextuel) |
contexte: Le contexte de l'application |
booléen: Si la consentmanager doit être mis à jour |
Si les CMPSettings doivent être mis à jour à partir du serveur, c'est qu'ils ne l'étaient pas à ce jour. |
|
|
|
|
|
