Partager via

Service de formulaire d’inscription

Le service de formulaires d’inscription vous permet de télécharger les formulaires d’inscription exigés par certains États pour la publicité politique achetée par des comités de dépenses indépendants. Les créatifs ne serviront pas dans le New Jersey ou l’État de New York tant que le formulaire n’est pas chargé et associé à l’ordre d’insertion approprié.

Remarque

  • PUTet DELETEne sont pas pris en charge pour ce service. Au lieu de modifier un formulaire existant, vous devez charger un nouveau formulaire, puis associer le nouveau formulaire à l’ordre d’insertion.
  • Vous devez enregistrer le file-location spécifié dans la réponse au formulaire chargé afin de pouvoir associer le formulaire à l’ordre d’insertion approprié. Il n’existe aucun moyen de récupérer ces informations ultérieurement. Si vous n’avez pas enregistré l’emplacement du fichier et que vous devez toujours associer le formulaire à un ordre d’insertion, vous devez charger un nouveau formulaire.

API REST

HTTP, méthode Endpoint Description
POST https://api.appnexus.com/registration-form/upload-F uploadFile=@<local_path/local_file_name.pdf
où local_path/local_file_name.pdf est le chemin et le nom du fichier à charger.
Si vous n’avez pas accès à votre chemin d’accès de fichier local, car vous appelez l’API à partir d’un navigateur, vous devez créer un FormData objet avec le nom uploadFile de la variable et le charger.
Si vous utilisez JavaScript pour créer un objet FormData, par exemple, le code doit ressembler à ceci.		 Chargez un nouveau formulaire d’inscription.
GET https://api.appnexus.com/registration-form?member_id=MEMBER_ID Afficher tous les formulaires d’inscription d’un membre.
GET https://api.appnexus.com/registration-form?file_path=FILE_PATH/FILE_NAME.PDF Afficher un formulaire d’inscription.
Pour afficher un formulaire d’inscription, vous devez connaître l’emplacement dans lequel le fichier a été chargé. Entrez simplement l’URL dans un navigateur ou effectuez un GET sur l’URL.

FormData Objet

savePoliticalFormFile: async (uploadFile) => {
const formData = new FormData();
formData.append('uploadFile', uploadFile);
const response = await
httpPostMultiPart(`${API_URL}/registration-forms/upload`, formData);
return response['location'];
},

Champs JSON

Champ Type Description
member_id int ID du membre.
Obligatoire sur :POST
file_path int Emplacement vers lequel le fichier est chargé. Cette valeur est retournée dans la réponse et ne peut pas être spécifiée lors du chargement du fichier.

Exemples

Charger un formulaire d’inscription et associer le formulaire à un ordre d’insertion

Charger un formulaire d’inscription

Dans cet exemple, NYS_Registration_Form_My_Favorite_Candidate.pdf est le formulaire de divulgation de l’État de New York pour l’achat d’annonces par le comité indépendant des dépenses.

curl -b cookies -X POST https://api.appnexus.com/registration-form/upload -F uploadFile=@/users/myname/NYS_Registration_Form_My_Favorite_Candidate.pdf>

La réponse inclut les éléments suivants :

{
    "file-path": "https://cleversafe03.appnexus.net/s3/political-ads-forms/p/958/20191010/fd241b14-1620-4e16-99d7-d57b19078649/A01055Registration20180907111141.PDF"
}

Associer le formulaire à un ordre d’insertion

Dans cet exemple, l’ordre d’insertion utilisé pour les publicités politiques est 5432.

cat io-registration-form.json
{
 
  "insertion-order": {
    "registration-forms": [
      {
        "file-path": "https://cleversafe03.appnexus.net/s3/political-ads-forms/p/958/20191010/fd241b14-1620-4e16-99d7-d57b19078649/A01055Registration20180907111141.PDF"
      }
    ]
  }
}
 
curl -b cookies -X PUT https://api.appnexus.com/insertion-order?id=5432

Afficher un formulaire chargé

GET https://api.appnexus.com/registration-form?file_path=https://cleversafe03.appnexus.net/s3/political-ads-
forms/p/958/20191010/fd241b14-1620-4e16-99d7-d57b19078649/A01055Registration20180907111141.PDF

Service d’ordre d’insertion

  • Last updated on