登録フォーム サービス
登録フォームサービスを使用すると、独立した支出委員会によって購入された政治的広告のために特定の州で必要な登録フォームをアップロードすることができます。 クリエイティブは、フォームがアップロードされ、適切な挿入順序に関連付けられるまで、ニュージャージー州またはニューヨーク州では配信されません。
注:
-
PUTおよびDELETEは、このサービスではサポートされていません。 既存のフォームを変更する代わりに、新しいフォームをアップロードしてから、新しいフォームを挿入順序に関連付ける必要があります。 - フォームを適切な挿入順序に関連付けることができるように、アップロードされたフォームへの応答で指定された
file-locationを記録する必要があります。 後でこの情報を取得する方法はありません。 ファイルの場所を記録せず、フォームを挿入順序に関連付ける必要がある場合は、新しいフォームをアップロードする必要があります。
REST API
| HTTP メソッド | エンドポイント | 説明 |
|---|---|---|
POST |
https://api.appnexus.com/registration-form/upload-F uploadFile=@<local_path/local_file_name.pdf ここで local_path/local_file_name.pdf は、アップロードするファイルのパスと名前です。ブラウザーから API を呼び出しているためにローカル ファイル パスにアクセスできない場合は、変数名 uploadFileを使用して FormData オブジェクトを作成してアップロードする必要があります。たとえば、JavaScript を使用して FormData オブジェクトを作成している場合、コード は次のようになります。 |
新しい登録フォームをアップロードします。 |
GET |
https://api.appnexus.com/registration-form?member_id=MEMBER_ID | メンバーのすべての登録フォームを表示します。 |
GET |
https://api.appnexus.com/registration-form?file_path=FILE_PATH/FILE_NAME.PDF | 登録フォームを表示します。 登録フォームを表示するには、ファイルがアップロードされた場所を把握している必要があります。 ブラウザーに URL を入力するか、URL に GET を実行するだけです。 |
FormData オブジェクト
savePoliticalFormFile: async (uploadFile) => {
const formData = new FormData();
formData.append('uploadFile', uploadFile);
const response = await
httpPostMultiPart(`${API_URL}/registration-forms/upload`, formData);
return response['location'];
},
JSON フィールド
| フィールド | 種類 | 説明 |
|---|---|---|
member_id |
int | メンバーの ID。 必須: POST |
file_path |
int | ファイルのアップロード先の場所。 これは応答で返され、ファイルをアップロードするときに指定することはできません。 |
例
登録フォームをアップロードし、フォームを挿入順序に関連付ける
登録フォームをアップロードする
この例では、 NYS_Registration_Form_My_Favorite_Candidate.pdf は、独立した支出委員会による広告購入のニューヨーク州開示フォームです。
curl -b cookies -X POST https://api.appnexus.com/registration-form/upload -F uploadFile=@/users/myname/NYS_Registration_Form_My_Favorite_Candidate.pdf>
応答には、次のものが含まれます。
{
"file-path": "https://cleversafe03.appnexus.net/s3/political-ads-forms/p/958/20191010/fd241b14-1620-4e16-99d7-d57b19078649/A01055Registration20180907111141.PDF"
}
フォームを挿入順序に関連付ける
この例では、政治広告に使用される挿入順序が 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
アップロードされたフォームを表示する
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