メインコンテンツへスキップ
Japanese ヘルプセンターのホームページ

Browsi Placement API

  • 更新

Browsi Placement API の実装は、導入に不可欠なステップです。 現在の広告プ枠を使用し、機械学習ソフトウェアに基づいて広告枠を最適化します。

1. コードをコピーして、ページの<head>要素内に挿入します。 このコードは、Implementationのセクションで挿入したBrowsiタグの後に挿入する必要があります。

<head>
  <meta charset="utf-8">
  <title>Hello World</title>
  <script 
    src="https://middycdn-a.akamaihd.net/bootstrap/bootstrap.js" 
    id="browsi-tag" 
    data-pubkey="Browsi" 
    data-sitekey="browsi" async>
  </script>
  <script>
    window.browsitag = window.browsitag || {};
    window.browsitag.cmd = window.browsitag.cmd || [];
  </script>
</head>

2. ページに有る既存の広告タグを置き換えます。サンプルはGoogle Publisher Tagの例です。

<body>
  <!-- replace this code -->
  <div id="banner-ad" style="width: 300px; height: 250px;">
    <script>
      googletag.cmd.push(function() {
      googletag.display('banner-ad');
      });
    </script>
  </div>
</body>

以下のように置き換えます。

<body>
  <div id="<DIV_ID>">
    <script>
      window.browsitag.cmd.push(() => {
       window.browsitag.display("<DIV_ID>", {
          sizes: [  {w:300,h:600},{w:300,h: 250},"fluid" ],
          keyValues: [  {key: 'browsi', value: 'true'}, {key: 'widget', value: 'top'} ],
          adUnit: "AD_UNIT",
          optimizeViewability: true ,
          positionTag: 'top' //can be also: 'bottom','in-content','adhesive','rail'
          refresh: {
          active: true ,
          refreshSeconds: SECONDS,
          }
        });
      });
    </script>
  </div>
</body>

 

API Parameters

divなど、＜＞で囲まれている各パラメータを適宜ご変更ください。利用できるパラメータやそれぞれの必須か否かは更に下の表をご参照ください。

パラメータ名
説明
形式
必須 or 任意
サンプル
div_id
PlacementごとにユニークなIDをご指定ください。APIでコールするエレメント名と一致する必要があります。
string
必須
"browsi_placement_1"
adUnit
広告リクエストを送るAdUnitを、publisher id を含んで入力ください。 先頭に”/”は含めないでください。空だったり誤ったUnitだと機能しませんのでご注意ください。
string
必須
adUnit: "1234456/browsi/ad/unit"
sizes
当該Placementにおけるサイズ 空の場合はBrowsiがページの設定を読み取り自動的にサイズを埋めます。 フォーマット- {w:XXX, h:XXX} (幅 x 高さ) サイズが'流動的'な場合には {w:0,h:0}と入力ください。
array of objects
必須
sizes: [
 {w:300,h:600},
 {w:300,h: 250},
 "fluid"
]
positionTag
配信される広告ユニットの位置を伝達します。以下から選択可能です。top, bottom, in-content(in-line), adhesive and rail.
string
必須
positionTag:'top'
パラメータ名
説明
形式
必須 or 任意
サンプル
keyValues
広告リクエスト時に送られるkey&valueです。Browsi Dashboard上から上書き可能です。
array of objects
任意
keyValues: [
 {key: 'browsi', value: 'true'}, 
 {key: 'widget', value: 'top'}
]
optimizeViewability
このPlacementにおけるAIによるViewability自動最適化機能をオン/オフを指定。何も設定しない場合（デフォルト）はfalseです。
boolean
任意
(オーバーライドできます)
optimizeViewability: true
refresh
インビュー時のリフレッシュ設定を格納するコンテナ。
object
任意
{}
refresh: active
インビュー時にリフレッシュするか否か。何も設定しない場合（デフォルト）はfalseです。
boolean
任意
refresh:{
   active: true
 }
refresh: refreshSeconds
自動リフレッシュの間隔
number
更新がアクティブな場合に必要
refresh:{
   refreshSeconds: 30
 }

関連記事