Api Model:OfferFile

From HasOffers

Required Parameters

  • id
    • Values: (int)
  • offer_id - Id of offer.
    • Values: (int)
  • display - Display name.
    • Values: (string)
  • interface - Type of account to attach offer file to as creator.
    • Values: advertiser, affiliate, network
  • account_id - Id of advertiser if type parameter is 'advertiser', Id of affiliate if type parameter is 'affiliate', or leave blank if 'type parameter is 'network'.
    • Values: (int)
  • type - 'hidden' files enable multiple files to be uploaded and used in a main offer file which is displayed to an affiliate.
    • Values: file, image banner, flash banner, email creative, offer thumbnail, text ad, html ad, hidden
  • filename - All types require a file to be uploaded except 'text ad' and 'html ad'.
    • Values: (string)
  • width - Width in pixels. Required for offer files with the type 'mage banner', 'flash banner', 'offer thumbnail', and 'html ad'.
    • Values: (int)
  • height - Height in pixels. Required for offer files with the type 'mage banner', 'flash banner', 'offer thumbnail', and 'html ad'.
    • Values: (int)
  • code - HTML code. Required for offer files with the type 'email creative', 'text ad', and 'html ad'.
    • Values: (string)

Other Optional Parameters

  • status - Default 'active'.
    • Values: active, pending, deleted
  • is_private - Limit offer files with the interface set to 'network' to only be accessible by the network and not visible to affiliates.
    • Values: 0, 1

Additional Return Parameters

Read only parameters return with each object.

  • created - Date / time object was created.
    • Values: (timestamp)
  • modified - Date / time object was last modified.
    • Values: (timestamp)
  • shared - Flag to determined whether the offer URL is from an offer the Offer Exchange.
    • Values: 0, 1
  • size - Size of file in bytes. Computed on file upload.
    • Values: (int)
  • url - Full URL to file.
    • Values: (string)
  • thumbnail - Full URL to image thumbnail. Only created and returned if type parameter is 'image banner'.
    • Values: (string)

 
Email this page to a friend or co-worker