アドワイアーズ広告の新しい広告配信方法としてWebAPIを公開してます。
このWebAPIは行動ターゲティングやコンテンツ連動広告とは異なり、指定のキーワードに連動するキーワード連動広告となっております。
ご利用いただくにはメディアパートナーのアカウント登録が必要になります。登録、ご利用共に無料です。
WebAPI@アドワイアーズ広告はデベロッパー(開発者)向けのサービスとなっております。REST形式のため、開発言語は問いません。PHP、Perl、JSP(Java)、ASPやFlash、JavaScriptで開発できます。
WebAPI@アドワイアーズ広告を活用したサイトやウェブアプリ、ブログパーツを開発された方は、ぜひご連絡ください。
弊社サイトにて紹介させていただきます。
このWebAPIは、http通信によるREST形式のWebAPIです。
指定されたキーワードと連動した広告データをXMLで返します。
広告をクリックされるとサイト収益を受け取ることができます。
http://api.adwires.com/v01.php
| 名前 | 説明 | 値 | 必須 |
|---|---|---|---|
| mid | メディアパートナーID ※ログイン後に表示されるMから始まる9桁のID番号から英字Mを抜いた整数。 例:M00001452の場合、00001452を指定 |
整数 | ○ |
| chid | チャンネルID ※ログイン後、チャンネル一覧から取得できます。 |
文字列 | ○ |
| target |
0でPC向け広告 1でモバイル向け広告 ※指定がないとPC向け広告となります。 |
整数 | |
| limit | 取得件数 整数で1~10 | 整数 | |
| q |
キーワードはUTF8をurlencodeした文字列 ※urldecode時に40字以内 |
文字列 | ○ |
| test | 0で通常処理、1でテストモード ※テストモードの場合、広告データの取得はできますが、報酬の加算等はされません。テストの際は広告主様に迷惑をかけないように必ず1にしてください。 |
パラメータは、GETあるいはPOSTで指定します。文字コード入力はUTF-8のみ。出力はUTF-8固定となっています。
パラメータリクエスト例です。このURLをクリックするとXMLデータが返ってきます。
| 名前 | 説明 | 値 |
|---|---|---|
| resultset | 取得結果のすべてを含みます。 | |
| param | 入力されたパラメータのすべてを含みます。 | |
| mid | 入力されたメディアIDを返します。 | 整数 |
| chid | 入力されたチャンネルIDを返します。 | 文字列 |
| q | 入力されたキーワード文字列を返します。 | 文字列 |
| target | 入力された対象デバイスを返します。 | 整数 |
| mode | 入力された 検索モード を返します。 | 整数 |
| limit | 入力された取得件数を返します。 | 整数 |
| test | 入力されたテストモードを返します。 | 整数 |
| result | 取得された広告データを含みます。 | |
| title | 広告のタイトルを返します。 ※取得データのうちtitleは省略不可となっています。 |
文字列 |
| comment1 | 広告のコメント1を返します。 ※レイアウトの都合上やむをえない場合のみ省略可となっています。 |
文字列 |
| comment2 | 広告のコメント2を返します。 ※レイアウトの都合上やむをえない場合のみ省略可となっています。 |
文字列 |
| url | 広告の表示用URLを返します。 ※レイアウトの都合上やむをえない場合のみ省略可となっています。 |
文字列 |
| clickurl | 広告のリンク先URLを返します。 ※取得データのうちclickurlは省略不可となっています。 |
文字列 |
| 名前 | 説明 | 値 |
|---|---|---|
| resultset | 取得結果のすべてを含みます。 | |
| Error | エラー内容を含みます。 | 文字列 |
| Message | エラーメッセージを返します。 | 文字列 |
| エラー番号 | 説明 |
|---|---|
| E0010 | Invailed mid メディアIDが不正です。 |
| E0020 | Invailed chid チャンネルIDが不正です。 |
| E0030 | Invailed mid/chid メディアIDまたはチャンネルIDが不正です。 |
| E0040 | keywords are too long. キーワード文字列が長すぎます。 |
| W0100 | no matches 該当する広告が見つかりませんでした。 |
広告表示エリアの上下左右32ピクセル以内に文字サイズ9ピクセル以上。可視できる配色で「Ads by ADWIRES」のテキストリンクを表示してください。
<a href="http://www.adwires.com/">Ads by ADWIRES</a>
PHPで作成したスクリプトをこちらからダウンロードいただけます。
WebAPIによる開発のサンプルとしてご利用ください。
サンプルをダウンロードして拡張子をphpに変更すると実行できます。