Package Exports

@denimlabs/fb-position-validation

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@denimlabs/fb-position-validation) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

fb-position-validation

This package will validate against Denim objectives and facebook placment options

Getting Started

yarn add @denimlabs/fb-position-validation

import { validateAllRulesByObjective }  from '@denimlabs/fb-position-validation'


const positioning = {
  facebook_positions: [
    'feed',
    'video_feeds',
    'instant_article',
    'instream_video',
    'story'
  ],
  instagram_positions: ['stream'],
  audience_network_positions: ['classic', 'instream_video'],
  messenger_positions: ['messenger_home'],
  device_platforms = ['mobile','desktop],
  publisher_platforms = ['facebook', 'instagram', 'audience_network'],
}
const objective = 'Awareness'

validateAllRulesByObjective(objective, positioning)

//will throw error if not valid.

If you are only interested in what is valid for a particular objective you can do any of the three following:

  const validPositions = getValidPositionsForObjective(objective)
  const validDevicePlatforms = getValidDevicePlatformsForObjective(objective)
  const validPublisherPlatforms = getValidPublisherPlatformsForObjective(objective)

Running the tests

yarn test

Deployment

yarn publish

Built With

:love:

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Michael W. Clark - Initial work - MichaelWClark

License

(MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.