Importer des ID d'annonces dans des listes d'utilisateurs

Vous pouvez utiliser l'API Bulk Uploader pour ajouter et supprimer des identifiants d'annonce dans les listes d'utilisateurs Authorized Buyers à des fins de ciblage.

Voici un exemple d'URL d'API d'importation groupée HTTPS:

https://cm.g.doubleclick.net/upload?nid={GoogleNetworkId}

Le point de terminaison accepte les requêtes HTTPS POST.

La valeur de GoogleNetworkId doit être votre ID de réseau de mise en correspondance des cookies (NID), qui identifie de manière unique votre compte pour l'outil d'importation groupée et la mise en correspondance des cookies.

La charge utile de la requête HTTPS POST est un tampon de protocole encodé qui décrit les listes à modifier. Consultez le schéma du service de transfert groupé dans le fichier cookie-bulk-upload-proto.txt. La charge utile de chaque requête est limitée à 100 Ko.

Pour en savoir plus sur la compilation et l'utilisation de cookie-bulk-upload.proto pour sérialiser et analyser des messages, consultez le tutoriel correspondant au langage de votre choix.

Vous pouvez importer les types d'identifiants suivants:

  • ID utilisateur Google
  • ID fourni par le partenaire
  • IDFA iOS
  • Identifiant publicitaire Android
  • ID Roku
  • ID Amazon Fire TV
  • ID Xbox ou Microsoft

Importer des ID utilisateur Google

Les ID utilisateur Google sont des ID chiffrés du domaine doubleclick.net.

Pour importer un ID utilisateur Google:

  1. Configurez la mise en correspondance des cookies avec Google et hébergez la table des correspondances.
  2. Utilisez votre table des correspondances pour convertir vos ID utilisateur en ID utilisateur Google.
  3. Importez les ID utilisateur Google dans la liste d'utilisateurs.

Par exemple, si vous obtenez les informations suivantes lors de la mise en correspondance des cookies:

https://ad.network.com/pixel?google_gid=CAESEHIV8HXNp0pFdHgi2rElMfk&google_cver=1

Le paramètre google_gid correspond à l'ID utilisateur Google chiffré.

Pour l'ajouter à une liste d'utilisateurs, copiez-le dans le corps UpdateUsersDataRequest:

ops {
  user_id: "CAESEHIV8HXNp0pFdHgi2rElMfk"
  user_list_id: 111
  delete: false
  user_id_type: GOOGLE_USER_ID
}

Importer les ID fournis par le partenaire

Les ID fournis par les partenaires sont des ID associés à leur propre domaine. Pour importer un ID fourni par un partenaire:

  1. Configurez la mise en correspondance des cookies avec Google et autorisez Google à héberger votre table des correspondances.

  2. Importez les ID fournis par votre partenaire dans la liste des utilisateurs.

    Par exemple, si un ID utilisateur pour votre domaine est défini sur 123456, vous pouvez le renseigner avec la mise en correspondance des cookies dans la table des correspondances hébergée par Google. Votre balise de correspondance doit inclure une version Web encodée en base64 de l'ID attribué au paramètre google_hm, comme suit:

    https://cm.g.doubleclick.net/pixel?google_nid=cookie-monster&google_hm=MTIzNDU2&google_cm
    
  3. Vous pouvez ensuite importer l'ID fourni par le partenaire dans une liste d'utilisateurs à l'aide de UpdateUsersDataRequest:

    ops {
     user_id: "123456"
     user_list_id: 123
     delete: false
     user_id_type: PARTNER_PROVIDED_ID
    }
    
  4. Google traduit ensuite la liste d'utilisateurs des ID fournis par les partenaires en ID utilisateur Google, puis ajoute les ID à votre liste d'utilisateurs.

Importer l'IDFA ou les identifiants publicitaires Android

Vous pouvez également importer des ID d'appareils.

  1. Importez l'ID de l'appareil avec UpdateUsersDataRequest:

    ops {
     user_id: "2024D65F-EBBD-11FF-23AB-823FC255913A"
     user_list_id: 111
     delete: false
     user_id_type: IDFA
    }
    
  2. Google traduit ensuite la liste d'utilisateurs des ID d'appareil en ID utilisateur Google, puis ajoute les ID à votre liste d'utilisateurs.

Workflow

Tous les exemples de requêtes et de réponses dans l'outil de transfert groupé sont écrits au format texte. Vous devez les envoyer en tant que messages Protocol Buffer sérialisés au point de terminaison de l'API d'importation groupée.

Par exemple, pour importer un IDFA et un ID fourni par le partenaire dans la liste d'utilisateurs 123, créez un UpdateUsersDataRequest:

ops {
  user_id: "2024D65F-EBBD-11FF-23AB-823FC255913A"
  user_list_id: 123
  delete: false
  user_id_type: IDFA
}
ops {
  user_id: "1234567"
  user_list_id: 123
  delete: false
  user_id_type: PARTNER_PROVIDED_ID
}
# See warning before use. Requires affirmative end-user consent.
process_consent: true

Envoyez ensuite une requête HTTPS POST avec le message UpdateUsersDataRequest sérialisé en tant que charge utile.

Si toutes les opérations aboutissent, vous obtenez le code UpdateUsersDataResponse suivant:

status: NO_ERROR

Si certaines opérations ont abouti, la réponse inclut un UpdateUsersDataResponse avec une erreur pour chaque opération ayant échoué:

status: PARTIAL_SUCCESS
errors {
  user_id: "1234567"
  error_code: UNKNOWN_ID
  user_id_type: PARTNER_PROVIDED_ID
}

Si aucune des opérations n'a abouti, la réponse inclut un UpdateUsersDataResponse avec status défini sur BAD_COOKIE:

status: BAD_COOKIE

Exemple

Voici un exemple de script Python qui montre comment utiliser la bibliothèque générée par cookie-augmentation-upload.proto pour remplir une liste d'utilisateurs avec un ID donné à l'aide du service de transfert groupé:

  #!/usr/bin/python
#
# Copyright 2023 Google Inc. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""A sample demonstrating usage of the Authorized Buyers Bulk Upload service.

Successfully running this example will add the provided ID to the given user
list. To learn more about the bulk uploader service, see:
https://developers.google.com/authorized-buyers/rtb/bulk-uploader
"""


import argparse

import gen.cookie_bulk_upload_pb2

import requests


BULK_UPLOAD_ENDPOINT_TEMPLATE = 'https://cm.g.doubleclick.net/upload?nid=%s'


def main(account_nid, user_list_id, user_id, user_id_type):
    # Build the bulk upload request.
    update_request = gen.cookie_bulk_upload_pb2.UpdateUsersDataRequest()
    update_request.send_notifications = True

    ops = update_request.ops
    op = ops.add()
    op.user_list_id = user_list_id
    op.user_id = user_id
    op.user_id_type = user_id_type

    user_id_type_value = gen.cookie_bulk_upload_pb2.UserIdType.Name(
        user_id_type)

    print(f'For NID "{account_nid}", adding user ID "{user_id}" of type '
          f'"{user_id_type_value}" to user list ID "{user_list_id}"')

    # Execute the bulk upload request.
    response = requests.post(BULK_UPLOAD_ENDPOINT_TEMPLATE % account_nid,
                             data=update_request.SerializeToString())

    # Parse and display the response.
    update_response = gen.cookie_bulk_upload_pb2.UpdateUsersDataResponse()
    update_response.ParseFromString(response.content)

    print('Operation completed with the following:')
    print(f'\tHTTP Status code: {response.status_code}')
    status_value = gen.cookie_bulk_upload_pb2.ErrorCode.Name(
        update_response.status)
    print(f'\tUpdateUsersDataResponse.status: {status_value}')
    print(f'\tUpdateUsersDataResponse.errors: {update_response.errors}')
    print('\tUpdateUsersDataResponse.notifications: '
          f'{update_response.notifications}')
    n_status_value = gen.cookie_bulk_upload_pb2.NotificationStatus.Name(
        update_response.notification_status)
    print(f'\tUpdateUsersDataResponse.notification_status: {n_status_value}')


if __name__ == '__main__':
    parser = argparse.ArgumentParser(
        description=('A sample demonstrating usage of the Authorized Buyers '
                     'bulk uploader service.'))
    parser.add_argument('-n', '--account_nid',
                        required=True, help='The Account NID.')
    parser.add_argument('-u', '--user_id',
                        required=True, help='The User ID to be added.')
    parser.add_argument('-l', '--user_list_id', type=int, required=True,
                        help='The user list that the ID is being added to.')
    parser.add_argument('-t', '--user_id_type', type=int, required=True,
                        help=('The type of user ID being added. See '
                              '"UserIdType" enum for more details.'))
    args = parser.parse_args()

    main(args.account_nid, args.user_list_id, args.user_id, args.user_id_type)


Les partenaires qui utilisent l'API Bulk Upload doivent indiquer qu'ils disposent de la base juridique appropriée pour partager les données utilisateur avec Google à des fins d'importation groupée à l'aide du paramètre "process_consent". Cette exigence s'applique à toutes les requêtes d'importation groupée.

Pour les données utilisateur nécessitant le consentement de l'utilisateur final conformément aux Règles Google relatives au consentement de l'utilisateur dans l'UE (voir https://www.google.com/about/company/user-consent-policy/) ou par d'autres lois locales, les partenaires sont tenus d'obtenir le consentement de l'utilisateur final et d'indiquer qu'il a été obtenu en définissant process_consent=True.

Pour les données utilisateur qui ne sont pas soumises aux exigences de consentement des utilisateurs finaux, les partenaires doivent indiquer que leur consentement n'est pas requis en définissant process_consent=True.

Les requêtes pour lesquelles process_consent est manquant sont filtrées et renvoient l'erreur suivante:

status: MISSING_CONSENT_WILL_BE_DROPPED

Les requêtes pour lesquelles process_consent est défini sur false sont filtrées et renvoient l'erreur suivante:

status: MISSING_CONSENT