shortlist-digital/agreable-advert-plugin

适用于Croissant兼容网站的A tres agreable Adverts插件

3.0.3 2017-01-16 13:54 UTC

README

使用Herbert插件框架构建的WordPress插件,用于Croissant堆栈。

在Twig中使用

获取广告HTML

<!-- Twig function -->
{{ get_advert_html(post, 'horizontal', [{'pos': 'top'}]) }}

<!-- Outputs -->

<div data-module='AdvertSlot' data-advert-id='a876sd7f65sd76f'>
  <script type='application/json'>
    { ...advert object } 
  </script>
</div>

获取广告数据

<!-- Twig function -->
{{ get_advert_data(post, 'horizontal', [{'pos': 'top'}]) }}

<!-- Outputs -->
{
  'type': 'horizontal',
  'key-values': [{'pos': 'top'}],
  'devices': {
    'desktop': {
      'creative-sizes': [[970, 250], [728, 90]]
    }, 
    'tablet': {
      'creative-sizes': [[728, 90]]
    }, 
    'mobile': {
      'creative-sizes': [[320, 50]]
    }
  }
}

在PHP中使用

$advert_data = AgreableAdvertPlugin\Services\AdvertSlotGenerator::get_advert_data($post, 'horizontal', ['pos' => 'top']);
var_dump($advert_data);
// Outputs
{
  'type': 'horizontal',
  'key-values': [{'pos': 'top'}],
  'devices': {
    'desktop': {
      'creative-sizes': [[970, 250], [728, 90]]
    }, 
    'tablet': {
      'creative-sizes': [[728, 90]]
    }, 
    'mobile': {
      'creative-sizes': [[320, 50]]
    }
  }
}

API路由

获取单个广告,以HTML形式呈现,包括容器CSS和JS以加载(用于即时文章)

/advert/{post_id}/{post_type}/{key_values}
/advert/2074/horizontal/pos=top,another_key=value

广告类型

水平

  • 横幅 970x250
  • 横幅 728x90
  • 移动横幅
{
  'type': 'horizontal',
  'key-values': [{'pos': 'top|2'}],
  'devices': {
    'desktop': {
      'creative-sizes': [[970, 250], [728, 90]]
    }, 
    'tablet': {
      'creative-sizes': [[728, 90]]
    }, 
    'mobile': {
      'creative-sizes': [[320, 50]]
    }
  }
}

垂直

  • HPU 300x600
  • MPU 300x250
{
  'type': 'horizontal',
  'key-values': [{'pos': 'top|2'}],
  'devices': {
    'desktop': {
      'creative-sizes': [[300, 600], [300, 250]]
    }, 
    'tablet': {
      'creative-sizes': [[300, 600], [300, 250]]
    }, 
    'mobile': {
      'creative-sizes': [[300, 250]]
    }
  }
}

文章内

{
  'type': 'in-article (tbc)',
  'key-values': [{'pos': 'top|2'}],
  'devices': {
    'desktop': {
      'creative-sizes': [[300, 600], [300, 250]]
    }, 
    'tablet': {
      'creative-sizes': [[300, 600], [300, 250]]
    }, 
    'mobile': {
      'creative-sizes': [[300, 250]]
    }
  }
}

皮肤

{
  'type': 'skin',
  'key-values': [{'pos': 'skin', 'pos': 'l|r'}],
  'devices': {
    'desktop': {
      'creative-sizes': [[300, 900]]
    }
  }
}