Use this endpoint to upload different types of campaign files. You can upload images for banners and banner X in jpeg, jpg, png, gif, PDF, or SVG formats. You may also upload content standard PDF files and content standard display logos. Ensure that logo files are in jpeg, jpg, or png format. New version available: Upload a campaign file - v4 is now available with enhanced features.
File upload guidelines
- File size limit: The maximum supported file size is 4 MB.
- Supported banner file types: The API currently accepts the following file formats: PNG, JPEG, and JPG.
- Supported banner X file types: The API currently accepts the following file formats: PNG, JPEG, JPG, SVG, and GIF.
- Supported content standard display logo file types: The API currently accepts the following file formats: JPEG, JPG, and PNG.
- Image dimension: Image dimensions aren't currently validated against the retailer's content standard. Ensure that they meet the defined content standards. This enhancement is planned for upcoming releases.
- Handling multiple files: If multiple files are submitted in a single request, only the first file will be processed while the remaining files will be ignored.
- Banner: For the
Campaign_File_Type_Banner_Image, providing a slot ID, and content standard ID is mandatory.- Banner X: For the
Campaign_File_Type_Banner_X_Image, providingimageSlotTypeis mandatory.
File upload URL
When uploading your creative asset file, ensure you provide a complete absolute path to the file. If you are copying example test code from the documentation to use in your environment, be sure to update the file location before executing the command. For example:
curl --request POST
--url 'https://.test.com/v3/campaign-file-upload?contentStandardId=test1&imageSlotType=IMAGE_SLOT_TYPE_UNSPECIFIED&campaignFileType=CAMPAIGN_FILE_TYPE_BANNER_IMAGE'
--header 'accept: application/json'
--header 'Authorization: Bearer '
--header 'content-type: multipart/form-data'
--form "file=@/Users/test/downloads/apple.png"