@tremorvideo/blink-cli

3.0.7 • Public • Published

@tremorvideo/blink-cli

definition of manifest.json

There should be only one MediaFile. However IAB VAST Standard does not prevent multiple MediaFile.

{
  "mediaFiles": [
    {
      "id": "CU-12345",
      "delivery": "progressive",
      "type": "application/javascript",
      "bitrate": 466,
      "width": 640,
      "height": 480,
      "maintainAspectRatio": true,
      "scalable": true,
      "apiFramework": "VPAID",
      "uri": "https://s.tremorvideodsp.com/SGAI12345/vpaid.js"
    }
  ],
  "videos": {
    "video-1": {
      "url": "https://s.tremorvideodsp.com/1.mp4",
      "type": "video/mp4",
      "duration": "15000"
    },
    "video-2": {
      "url": "https://s.tremorvideodsp.com/2.mp4",
      "type": "video/mp4",
      "duration": "15000"
    }
  },
  "mainVideo": "video-1",
  "tvCustomEvents": [
    {
      "name": "Click_Walgreens",
      "uri": true,
      "thirdPartyPixels": true
    },
    {
      "name": "Click_Video_Close",
      "uri": false,
      "thirdPartyPixels": true
    },
    {
      "name": "Slate_Opened",
      "uri": false,
      "thirdPartyPixels": true
    }
  ]
}

Output

<VAST xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="vast2.xsd" version="2.0.0">
  <Ad id="BC0">
    <InLine>
      <AdSystem>Tremor Video</AdSystem>
      <AdTitle>Tremor Video</AdTitle>
      <Impression>
        <![CDATA[https://s.tremorvideodsp.com/?e=impression]]>
      </Impression>
      <Creatives>
        <Creative>
          <Linear>
            <Duration>00:00:15</Duration>
            <AdParameters>
              <![CDATA[
                {
                  "geoInfo": {
                    "dma": "501",
                    "city": "new york",
                    "areaCode": "212",
                    "latitude": "40.75891",
                    "longitude": "73.97902",
                    "continent": "north america",
                    "countryCode": "us",
                    "stateCode": "95",
                    "postalCode": "10020"
                  },
                  "tvCustomEvents: [
                    {
                      "name": "Click_Walgreens",
                      "uri": "https://s.tremorvideodsp.com/1x1.png?r=wg",
                      "thirdPartyPixels": [
                        "https://s.tremorvideodsp.com/1x1.png?e=click_wg1",
                        "https://s.tremorvideodsp.com/1x1.png?e=click_wg2"
                      ]
                    },
                    {
                      "name": "Slate_Opened",
                      "thirdPartyPixels": [
                        "https://s.tremorvideodsp.com/1x1.png?e=open1"
                      ]
                    }
                  ]
                }
              ]]>
            </AdParameters>
            <TrackingEvents>
              <Tracking event="start">
                <![CDATA[https://s.tremorvideodsp.com/1x1.png?e=start]]>
              </Tracking>
              <Tracking event="midpoint">
                <![CDATA[https://s.tremorvideodsp.com/1x1.png?e=midpoint]]>
              </Tracking>
              <Tracking event="acceptInvitation">
                <![CDATA[https://s.tremorvideodsp.com/1x1.png?e=acceptInvitation]]>
              </Tracking>
            </TrackingEvents>
            <VideoClicks>
              <ClickThrough>
                <![CDATA[https://example.com]]>
              </ClickThrough>
              <ClickTracking>
                <![CDATA[https://s.tremorvideodsp.com/1x1.png?e=clicked]]>
              </ClickTracking>
            </VideoClicks>
            <MediaFiles>
              <MediaFile id="CU-12345" delivery="progressive" bitrate="466" width="640" height="480" type="application/javascript" maintainAspectRatio="true" scalable="true" apiFramework="VPAID">
                <![CDATA[https://s.tremorvideodsp.com/SGAI12345/vpaid.js]]>
              </MediaFile>
            <MediaFiles>
          </Linear>
        </Creative>
      </Creatives>
    </InLine>
  </Ad>
</VAST>

commands

  • blink init spr downloads an spr and runs blink prepare
  • blink prepare reads the blink.toml file to get the AdParameters, Videos and Events, then updates animate_template.html accordingly. An essential step before importing the template into Animate CC and publishing.
    --import opens the Animate CC application and runs a JSFL script import.jsfl the template.html --auto opens the Animate CC application and runs a JSFL script to custom.jsfl Many versions of custom.jsfl have been created by Automation to add specific Blink Components to specific Movie Clips.
  • blink build Essential step after publishing Animate CC creative. This one command runs these 4 commands:
    • blink validate
    • blink build-manifest
    • blink build-vpaid
    • blink copy
  • blink build-manifest generates a manifest.json file
  • blink build-vpaid concatenates all files loaded by script tags into a single dist/ad.js, and runs Babel to transpile ES6. Also adds sentry and sentryConfig.
  • blink copy copies these src subdirectories to dist: images, sounds, components, fonts, json. All .png files are compressed, unless the option --skip-compress-images is used
  • blink upload or (blink u) constructs vast2.xml and vast3.xml files from manifest.json, then uploads all files to S3 bucket trmr-animate-vpaid, and prints out to console links to Vast Inspector URLs using the CDN mapped URL to the S3 bucket. --uncompressed changes printed out Vast Inspector links to use URL of uncompressed ad.js
  • blink components downloads latest version of Blink Components to user's Animate CC Application Support directory
  • blink snippets downloads latest version of Blink Snippets and merges into user's Animate CC Application Support directory
  • blink info prints to console versions of Blink Tool Chain components used in Animate CC creative found in cwd Prints warning if starter-kit is not the latest production version
  • blink stats gives you statistics of the file sizes of projects assets in current directory
  • blink doctor Runs system diagnostics pertaining to Blink Tool Chain and recommends how to fix problems Lists versions of installed products
  • blink serve runs http server in current directory. Static files are also served from this directory. Default port is 3000 unless specfified with --port {number}

Readme

Keywords

none

Package Sidebar

Install

npm i @tremorvideo/blink-cli

Weekly Downloads

297

Version

3.0.7

License

MIT

Unpacked Size

962 kB

Total Files

79

Last publish

Collaborators

  • kahwee
  • tremorvideo