Créer une audience de ciblage par liste de clients

Créez une audience de ciblage par liste de clients en envoyant un CreateUserListRequest.

Créer le corps de la requête

Créez une UserList ressource. Voici les champs courants à définir.

displayName

Obligatoire : nom à afficher de la liste. Ce nom doit être unique parmi toutes les listes appartenant au compte.

description

Brève description de la liste.

integrationCode

ID de votre système.

membershipDuration

Durée pendant laquelle un membre de l'audience reste dans la liste après avoir été ajouté. La valeur doit correspondre à des jours entiers. Si elle n'est pas définie, la valeur maximale est utilisée par défaut.

Si vous utilisez JSON, calculez le nombre de secondes en multipliant le nombre de jours par 86400 (nombre de secondes par jour). Définissez ensuite la valeur sur le résultat de la multiplication, suivi de s. Par exemple, si vous souhaitez que la durée d'appartenance soit de 90 jours, utilisez la valeur 7776000s puisque 90 * 86400 = 7776000.

Si vous utilisez le format de tampon de protocole, utilisez la méthode pratique pour créer un Duration objet en fonction du nombre de jours, si une telle méthode existe. Par exemple, la protobuf-java-util bibliothèque pour Java dispose d'une fromDays() méthode pratique. Sinon, calculez le nombre de secondes en multipliant le nombre de jours par 86400 (nombre de secondes par jour), puis utilisez le résultat pour définir le champ seconds de l'objet Duration.

Champs obligatoires pour le ciblage par liste de clients

Le champ ingestedUserListInfo est obligatoire pour une audience de ciblage par liste de clients.

Voici les champs à définir dans le IngestedUserListInfo en fonction du type de données que vous souhaitez utiliser pour ajouter des membres d'audience à la liste.

Liste des coordonnées

Définissez les champs suivants si vous souhaitez utiliser des coordonnées (adresses e-mail hachées, numéros de téléphone ou adresses) pour définir les membres de votre audience :

uploadKeyTypes

Définissez une liste contenant le type de clé d'importation CONTACT_ID.

La liste uploadKeyTypes ne doit contenir qu'une seule entrée.

contactIdInfo

Définissez un ContactIdInfo message avec le dataSourceType défini sur la valeur appropriée de l'énumération DataSourceType.

Liste des ID mobiles

Définissez les champs suivants si vous souhaitez utiliser des ID mobiles pour définir les membres de votre audience :

uploadKeyTypes

Définissez une liste contenant le type de clé d'importation MOBILE_ID.

La liste uploadKeyTypes ne doit contenir qu'une seule entrée.

mobileIdInfo

Définissez un MobileIdInfo message :

• Définissez dataSourceType sur la valeur appropriée de l' DataSourceType énumération.

• Définissez keySpace sur IOS ou ANDROID.

• Définissez le appId sur la chaîne qui identifie de manière unique l'application mobile à partir de laquelle les données ont été collectées.

  • Pour iOS, la chaîne d'ID est la chaîne à neuf chiffres qui apparaît à la fin de l'URL de l'App Store. Par exemple, 476943146 pour l'application "Flood-It!" avec le lien App Store https://apps.apple.com/us/app/flood-it/id476943146.

  • Pour Android, la chaîne d'ID correspond au nom du package de l'application. Par exemple, com.labpixies.flood pour l'application "Flood-It!" avec le lien Google Play https://play.google.com/store/apps/details?id=com.labpixies.flood.

Créer la requête

Pour créer une audience de ciblage par liste de clients, créez une create requête pour la ressource UserList.

1. Définissez le champ parent sur le nom de ressource du compte. Le nom de ressource doit respecter le format accountTypes/{accountType}/accounts/{account_id}.

2. Utilisez le UserList que vous avez créé pour le corps de la requête.

3. Si vos identifiants ne concernent pas un compte Google qui est un utilisateur du parent, définissez les en-têtes comme décrit dans Configurer les destinations et les en-têtes.

Voici des exemples de requêtes au format JSON pour les différents types d'informations utilisateur. Chaque requête définit le membershipDuration sur 2592000s, où 2592000 correspond au nombre de secondes dans 30 jours. Cliquez sur le bouton Ouvrir dans l'explorateur d'API pour essayer une requête.

{
    "description": "Customer Match for contact info",
    "displayName": "Contact info audience",
    "ingestedUserListInfo": {
        "contactIdInfo": {
            "dataSourceType": "DATA_SOURCE_TYPE_FIRST_PARTY"
        },
        "uploadKeyTypes": [
            "CONTACT_ID"
        ]
    },
    "membershipDuration": "2592000s"
}

{
    "description": "Customer Match for mobile IDs",
    "displayName": "Mobile ID audience",
    "ingestedUserListInfo": {
        "mobileIdInfo": {
            "dataSourceType": "DATA_SOURCE_TYPE_FIRST_PARTY",
            "keySpace": "ANDROID",
            "appId": "com.labpixies.flood"
        },
        "uploadKeyTypes": [
            "MOBILE_ID"
        ]
    },
    "membershipDuration": "2592000s"
}

Envoyer la requête

Envoyez la requête et, si nécessaire, incluez les en-têtes de requête.

Si la requête aboutit, la réponse contient le créé UserList avec les id et name renseignés. Notez les valeurs de ces champs, car vous en aurez besoin dans les requêtes pour ajouter des membres d'audience à l'audience.

Si la requête échoue, examinez les erreurs pour déterminer la cause de l'échec, mettez à jour la requête et les en-têtes pour résoudre les problèmes, puis envoyez la requête et les en-têtes mis à jour.