PRODUCT
Follow

Creative Assets

Creative assets are the building blocks used to create an ad. They are created by the creative shop and are stored and arranged in folders for easy management. The folders are organized in a hierarchical structure - parent folder followed by the dependent folders. Creative assets can include many different objects including images, videos, and HTML5 workspaces.

Ads

An ad is a collection of the creative contents, such as the creative files and their format (for example, floating ad or standard banner) as they appear in the placement. An advertisement is displayed to users in a browser and includes the ad’s name, banner size, format, and creative assets. Ads are used to promote a product, service, or company. They can appear in different ways, such as a banner on the page, an HTML5 or video file, or a pop-up video. Once the ad has been created, you can attach the ad to a placement.

Basic Flow

Note: Depending on the API user that was created for you, use one of the following URLs:
  • https://api.sizmek.com/rest/accounts
  • https://adapi.sizmek.com/rest/accounts
Confirm with your client success manager regarding the correct URL to use.

The following steps include a sample flow that demonstrate creating a simple banner ad, changing its name, and trafficking it.

  1. Upload a file to create an asset.
    1. User selects a specific image to create the banner asset:
      POST https://api.sizmek.com/rest/assets/files/-1   //-1 is the root folder
    2. Request is sent with a banner_image.jpg file.
    3. System creates a new asset and responds with the asset body representation.
  2. Update asset name with asset ID of 1234.
    1. User decides to change the asset name.
    2. User sends an update request with a new name attribute:
      PUT https://api.sizmek.com/rest/assets/1234
      {
          "entities": [{
              "type": "Asset",
              "id": 2173900124,
              "displayName": "bla12.webm",
              "folderId": -1
          }]
      }
    3. System updates the asset's metadata and returns asset body with updated data.
  3. Create an asset folder.
    1. User wants to create a folder in a specific folder.
    2. User creates a new asset folder with the new folder body:
      POST https://api.sizmek.com/rest/assets/folders
      
      "entities":
      [
          {
              "type": "AssetFolder",   // Must be set
              "folderType": 0,
              "name": "test123",
              "rootParentId": "1",
              "parentId": "1073754993" // ID of the parent folder
          }
      ]
      
    3. System creates a new folder and returns the new folder body representation and ID.
  4. Assign ad to a specific folder.
    1. User moves the asset ID 1234 into the dedicated folder:
      PUT https://api.sizmek.com/rest/assets
      {
          "entities": [{
              "type": "Asset",
              "id": 2073745686,
              "displayName": "bla1.webm",
              "folderId": 1073743182
          }]
      }
    2. System updates the asset's metadata according to the json content and returns the asset body with the new asset location.
  5. Create an ad.
    1. After the asset is created, user creates an ad based on the asset ID in the ad body.
      POST https://api.sizmek.com/rest/ads/
    2. System creates the new ad and returns the ad body with the ad ID.
  6. Assign to a campaign.
    1. User assigns the ad to a specific existing campaign Id 456:
      POST https://api.sizmek.com/rest/ads/assignMasterAd
      {
          "assignedEntityType": "Campaign",
          "entityIds": [1073741861],
          "adIds": [1073758741]
      }
    2. System assigns the master ad and returns the campaign body with the ad entity ID.
  7. Attach to a placement.
    1. User attaches the ad to a specific existing placement Id 7878:
      PUT https://api/sizmek.com/rest/deliveryGroups/attachAdsToPlacements
      
      {
          "entities": [{
              "type": "InBannerPlacement",
              "id": & lt;ENTER XXX HERE & gt;,
              "clientRefId": null,
              "relationsBag": {
                  "parents": {
                      "account": {
                          "id": & lt;ENTER XXX HERE & gt;,
                          "name": "!O"
                      },
                      "advertiser": {
                          "id": & lt;ENTER XXX HERE & gt;,
                          "name": "<ENTER XXX HERE>"
                      },
                      "brand": {
                          "id": & lt;ENTER XXX HERE & gt;,
                          "name": "<ENTER XXX HERE>"
                      },
                      "campaign": {
                          "id": & lt;ENTER XXX HERE & gt;,
                          "name": " java.util.Random@10092e9"
                      },
                      "site": {
                          "id": & lt;ENTER XXX HERE & gt;,
                          "name": "<ENTER XXX HERE>"
                      }
                  },
                  "children": {},
                  "creativeAccountContact": false
              },
              "uiPermissions": [],
              "version": null,
              "createdBy": & lt;ENTER XXX HERE & gt;,
              "createdByName": "QaAdminUser (QaAdminAccount)",
              "createdByAccount": & lt;ENTER XXX HERE & gt;,
              "createdByAccountName": "QaAdminAccount",
              "createdOn": & lt;ENTER XXX HERE & gt;,
              "lastUpdatedBy": & lt;ENTER XXX HERE & gt;,
              "lastUpdatedByName": "QaAdminUser (QaAdminAccount)",
              "lastUpdatedByAccount": & lt;ENTER XXX HERE & gt;,
              "lastUpdatedByAccountName": "QaAdminAccount",
              "lastUpdateOn": & lt;ENTER XXX HERE & gt;,
              "status": "New",
              "name": "test1",
              "campaignId": & lt;ENTER XXX HERE & gt;,
              "campaignName": null,
              "siteId": & lt;ENTER XXX HERE & gt;,
              "sectionId": null,
              "placementType": "IN_BANNER",
              "packageId": & lt;ENTER XXX HERE & gt;,
              "servingAndCostData": {
                  "mediaServingData": {
                      "units": 1000,
                      "hardStopMethod": "KEEP_SERVING_AS_USUAL",
                      "startDate": & lt;ENTER XXX HERE & gt;,
                      "endDate": & lt;ENTER XXX HERE & gt;
                  },
                  "mediaCostData": {
                      "type": "MediaCost",
                      "costModel": "<ENTER XXX HERE&gt",
                      "rate": 1,
                      "orderedUnits": null,
                      "actionType": null,
                      "customInteraction": null,
                      "conversionId": null,
                      "interactionId": null,
                      "ignoreOverDelivery": true
                  },
                  "placementLevel": true
              },
              "adsToAttach": [{
                  "type": "StandardBannerAd",
                  "id": & lt;ENTER XXX HERE & gt;,
                  "clientRefId": null,
                  "relationsBag": null,
                  "version": null,
                  "createdBy": & lt;ENTER XXX HERE & gt;,
                  "createdByName": "<ENTER XXX HERE&gt",
                  "createdByAccount": null,
                  "createdByAccountName": null,
                  "createdOn": & lt;ENTER XXX HERE & amp;gt,
                  "lastUpdatedBy": & lt;ENTER XXX HERE & amp;gt,
                  "lastUpdatedByName": "<ENTER XXX HERE&gt",
                  "lastUpdatedByAccount": & lt;ENTER XXX HERE & amp;gt,
                  "lastUpdatedByAccountName": "<ENTER XXX HERE&gt",
                  "lastUpdateOn": & lt;ENTER XXX HERE & amp;gt,
                  "name": "<ENTER XXX HERE&gt",
                  "masterAdId": 0,
                  "changed": false,
                  "adStatus": "ASSIGNED",
                  "enabled": true,
                  "adFormat": "STANDARD_BANNER_AD",
                  "adFormatId": & lt;ENTER XXX HERE & amp;gt,
                  "adFormatName": "Standard Banner",
                  "accountId": & lt;ENTER XXX HERE & amp;gt,
                  "accountName": "<ENTER XXX HERE&gt",
                  "placementId": null,
                  "placementName": null,
                  "siteId": null,
                  "siteName": null,
                  "adAssignmentData": {
                      "type": "AdAssignmentData",
                      "accountId": & lt;ENTER XXX HERE & amp;gt,
                      "accountName": "<ENTER XXX HERE&gt",
                      "advertiserId": & lt;ENTER XXX HERE & amp;gt,
                      "advertiserName": "<ENTER XXX HERE&gt",
                      "brandId": & lt;ENTER XXX HERE & amp;gt,
                      "brandName": "<ENTER XXX HERE&gt",
                      "campaignId": & lt;ENTER XXX HERE & amp;gt,
                      "campaignName": " java.util.Random@10092e9"
                  },
                  "mainClickthrough": null,
                  "adURLs": null,
                  "pricingSize": 36347,
                  "overallSize": 36347,
                  "initialSize": 36347,
                  "width": 300,
                  "height": 250,
                  "dimensions": "300x250",
                  "templateScriptName": "StdBanner",
                  "urlTokens": null,
                  "minAudioVersion": 0,
                  "fourthPartyTag": "",
                  "adChoicesStatus": false,
                  "adChoicesLocation": null,
                  "qaStatus": "NOT_SUBMITTED",
                  "numberOfPlacementAds": 0,
                  "overallNumberOfPlacementAds": 0,
                  "servingMethod": null,
                  "analyticsData": null,
                  "analyticsSettings": null,
                  "customFields": null,
                  "massVersioning": false,
                  "usedAsTemplate": false,
                  "unSavedTemplateAd": false,
                  "adTemplateId": null,
                  "feedEnabled": null,
                  "feedStatus": null,
                  "defaultImage": {
                      "type": "AdAsset",
                      "id": & lt;ENTER XXX HERE & amp;gt,
                      "clientRefId": null,
                      "relationsBag": null,
                      "uiPermissions": null,
                      "version": null,
                      "assetId": & lt;ENTER XXX HERE & amp;gt,
                      "assetName": "QAPositiveImage",
                      "source": true,
                      "assetStatus": null,
                      "folderId": 0,
                      "size": 36347,
                      "duration": 0,
                      "bitRate": 0,
                      "width": 300,
                      "height": 250,
                      "mimeType": "image/jpeg",
                      "mediaType": "IMAGE",
                      "thumbnailUrl": "http://resources-dev-sizmdx.s3.amazonaws.com/UAT/source/QApositiveImage4416247125396226462_14231605605302316.jpg"
                  },
                  "defaultImageClickthrough": null,
                  "banner": null,
                  "minFlashVersion": 8,
                  "mxpVersion": null,
                  "osVersion": null,
                  "asVersion": null,
                  "flashIDE": null,
                  "variables": null,
                  "html5": null,
                  "tooltip": "updated ad",
                  "createdByHTML5Factory": false,
                  "downloadMode": "INSTANT",
                  "initialLoadAsset": "DEFAULT_IMAGE",
                  "adSmartVersionSchema": {
                      "type": "APIAdSmartVersionSchema",
                      "smartElements": []
                  },
                  "disableIncomplete": false,
                  "enableRetargeting": false,
                  "rotationType": "EvenDistribution",
                  "versionTargetingType": "TargetAudience",
                  "versionBasePath": "",
                  "advancedRetargeting": null,
                  "route": "ads",
                  "reqParams": null,
                  "fromServer": true,
                  "parentResource": null,
                  "restangularCollection": false,
                  "overallSizeParsed": "35.50 KB",
                  "isSelected": true
              }],
              "selectedContacts": null,
              "tagBuilderParams": {
                  "type": "TagBuilderParams",
                  "id": null,
                  "clientRefId": null,
                  "relationsBag": null,
                  "uiPermissions": null,
                  "version": null,
                  "placementId": null,
                  "builderTagTypes": [
                      "CREATE_IFRAME"
                  ],
                  "siteServing": {
                      "secureServingProtocol": "HTTP",
                      "lineIdToken": "1",
                      "customToken": "FALK",
                      "serverDomainName": "bs.serving-sys-int.com",
                      "cacheBustingToken": "+Ads_Timestamp+",
                      "publisherCustomParam": "<ENTER XXX HERE&gt",
                      "minZIndex": "1",
                      "impTracking": "<ENTER XXX HERE&gt",
                      "clickTracking": "<ENTER XXX HERE&gt",
                      "escapeNoScript": true,
                      "generateMultipleTags": true,
                      "generateIMGTag": false,
                      "firstPartyAdIdToken": "true",
                      "disableCookies": false,
                      "generateKeywords": false
                  },
                  "placementType": "IN_BANNER"
              },
              "servingEnabled": false,
              "analyticsData": null,
              "sectionName": null,
              "lastPublished": null,
              "adEnableBaseUrl": "",
              "placementMV": false,
              "testImpressions": 1000,
              "targetingValue": "",
              "disableCookies": false,
              "startTimeOfDay": 0,
              "endTimeOfDay": 0,
              "controlOverDelivery": false,
              "collectWebPage": false,
              "impressionForWholePlacement": -1,
              "flightTargetingInfo": "",
              "mobileApplicationAdEnabler": null,
              "supportMobileApplications": false,
              "pluId": 0,
              "placementAdCount": 0,
              "placementAttachmentData": {
                  "attachedToUntargeted": false,
                  "targetAudienceIds": []
              },
              "packageName": "PKG::test1",
              "actualStartDate": null,
              "allowHTML5DynamicExpansion": false,
              "brandTimeZone": "GMT_Minus_12",
              "customFields": null,
              "bannerSize": {
                  "type": "APIBannerSize",
                  "id": null,
                  "clientRefId": null,
                  "relationsBag": null,
                  "uiPermissions": null,
                  "version": null,
                  "width": 444,
                  "height": 444
              },
              "hardStop": false,
              "asyncMode": false,
              "bandwidth": false,
              "adBlocking": false,
              "supportMobileApplication": false,
              "attached": false,
              "dimensions": "444x444",
              "placementAdCounts": "0 Placement ads",
              "hardStopMethod": "Keep serving as usual",
              "isSelected": true
          }]
      }
      
    2. System attaches the master ad to a placement and creates a placement ad.
  8. Generate placement tag.
    1. User calls the placement tag method to generate a tag to send to the publisher:
      POST https://api.sizmek.com/rest/placements/generateTag
      {
          "entities": [{
              "type": "TagRequest",
              "campaignId": "1073741918",
              "placementsIds": [1073748282],
              "includeKeywordInTags": false,
              "supportMobileTokens": false,
              "builderTagTypes": []
          }]
      }
Was this article helpful?
0 out of 1 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk