OfferFile::create | TUNE Dev Hub

Jump to: POST Response Notes | API Call Builder

Create an offer file. Depending on the file type, this method may require a file be uploaded when called.

See Creative File Upload Script for a PHP script that handles uploading a file to your network.

= Required Parameter

Name

Type

Description

data

Object

Offer File model object data propertiesShow Supported Parameters

The following parameters are supported by this object.

Name	Type	Description
account_id	Nullable Integer	ID of Affiliate object for Offer Files having an "interface" of "affiliate"; Advertiser ID for if "interface" is "advertiser"; NULL for Network-owned Offer Files
code	Nullable String	HTML code. Required for Offer Files with the types: "email creative", "text ad", and "html ad".
created	Datetime	The date the Offer File was created
display	String	The display name for this file. Takes the name of the uploaded file if not set on create.
expiration_date	Nullable Datetime	The expiration date of the Offer File in UTC.
filename	String	The name of the file that was uploaded, optionally passed in. Applicable to Offer Files with the types: "file", "image banner", "flash banner", "offer thumbnail", "hidden". Will be an empty string for types not accompanied by a file. Only the following file extensions are supported: "jpg", "jpeg", "gif", "png", "swf", "zip", "txt", "doc", "docx", "pdf", "rtf".
flash_vars	Nullable String	Applicable only for Offer Files with "type" of "flash banner"
height	Nullable Integer	Height in pixels. Required for Offer Files with the types: "image banner", "flash banner", "offer thumbnail", and "html ad". Determined automatically for most image files, but if "type" is "flash banner" it must be explicitly provided.
interface	String	Identifies the owner of this Offer File. The Network, Advertisers, and the Affiliate can all create Offer Files.
is_private	Boolean	Whether this Offer File should be visible to Affiliates. Applicable only when "interface" is set to "network".
modified	Datetime	The last date the Offer File was updated
offer_id	Integer	The ID of the Offer to which this Offer File is associated
size	Integer	The size of the uploaded file in bytes, recorded at the time of upload. For OfferFile objects not referencing an uploaded file, this value is 0.
status	String	The status of the Offer File
thumbnail	Nullable String	The URL of a thumbnail image. Thumbnails are auto-generated on upload for most Offer Files of type "image banner" or where the uploaded file is one of: "gif", "jpg", "jpeg", "png".
type	String	The type of Offer File. For more information on each type, see: help.tune.com/hasoffers/creative-files-overview/.
url	Nullable String	The URL for the uploaded XML file Important: Uses only for XML creatives
width	Nullable Integer	Width in pixels. Required for offer files with the types "image banner", "flash banner", "offer thumbnail", and "html ad". Determined automatically for most image files, but if "type" is "flash banner" it must be explicitly provided.

Show Supported Parameters

return_object

Boolean

If true, returns affected object; defaults to true

POST Response Notes

Returns the ID of the newly created offer file as an integer or returns the newly created offer file model object as an array if return_object is "true".

API Call Builder

Javascript is required to use the API Call Builder.