メソッド:PUT /api/v1/advertiser/campaign/{id}
説明: 作成した広告キャンペーンは、HilltopAdsアカウントのAPIを通じて更新することができます。
この方法はポップアンダー モバイルおよびポップアンダー デスクトップフォーマットでのみ利用可能です。
パラメータ:
名称 | 記述 | 例 | コメント |
key | HilltopAdsアカウントのAPIセクションで生成できる固有のAPIキー | nXzgO3Bc | これはリクエストの必須パラメータである。 |
campaignID | 更新される広告キャンペーンのID
| 123456 | 広告キャンペーンのIDは1つだけ指定できます。 これはリクエストの必須パラメータである。 |
format | キャンペーンで更新される広告フォーマット | ポップアンダー・モバイル | 指定できる広告フォーマットは1つだけです。 これはリクエストの必須パラメータである。 |
rate | 1000インプレッションの価格(CPM)。 | 1.53 | すべての価格(レート)は通貨なしでリクエストで指定されますが、結果ではUSDで設定されます。 これはリクエストの必須パラメータである。 |
capTotal | インプレッション回数の上限。このパラメータは、広告が表示される回数を示します。 | 2 | 指定できる数字は1つだけ。 |
capResetAfter | インプレッション回数の上限。このパラメータは、広告を表示する期間を示します。 | 12 | 指定できる数字は1つだけ。 |
capForCampaign | インプレッション頻度の上限。このパラメータは、ルールがキャンペーンとバナーのどちらに適用されるかを示す。 | キャンペーン | Popunderフォーマットでは、キャンペーンのみ指定できます。 |
channels | 広告の更新が必要なセグメントとトラフィック・カテゴリー。 | 主流/非主流 高いアクティビティ 主流/非主流 中流活動 主流/非主流 低活性 | 複数のアクティビティ・セグメントを指定する場合は、カンマで区切ってください。ただし、指定できるトラフィック・カテゴリーは、主流または非主流のいずれか1つだけです。 これはリクエストの必須パラメータである。 |
type | 広告キャンペーンの種類 | CPM、CPC | 現在、CPMキャンペーンタイプしか指定できませんのでご注意ください。 これはリクエストの必須パラメータである。 |
name | 広告キャンペーンの名称。 | ポップアンダー_API | キャンペーン名は一意でなければならず、すでに作成されたキャンペーン名と重複してはなりません。 これはリクエストの必須パラメータである。 |
url | トラフィックを送信する必要があるURLリンクを提供する。 | 指定できるリンクは1つだけです。 これはリクエストの必須パラメータである。 | |
active | 更新されたキャンペーンのステータスを指定:true - ON、false - OFF | 真、偽 | キャンペーンステータスをTrue(ON)に指定した場合、キャンペーンはモデレーションの後のみアクティブになります。 |
targeting | 広告キャンペーンに必要なターゲティング設定 | ジオ ブラウザ os 装置 モバイルキャリア イプレンジ 転覆 アプリ | これらのパラメータはオブジェクトとして渡される。それぞれの新しいターゲティング・パラメーターはコンマで指定される。 |
リクエストの例
id123456で作成された広告キャンペーンの以下のパラメータを更新する。
レート - 2.53ドルへ
表示頻度- キャンペーンの場合、24時間に1回まで
URL - https://mywebsit2.com
リンクに「&」記号が含まれている場合は、URLエンコード形式にエンコードする必要がありますのでご注意ください。
例えば
https://mywebsite.com/?token={{ctoken}}&zone={{zone_id}}
として指定しなければならない。
https%3A%2F%2Fmywebsite.com%2F%3Ftoken%3D%26zone%3D
リンクをエンコード形式にエンコードするには、ツールを使います。
以下の形式でリクエストを書く必要がある。
curl -X PUT --data '{"rate":「2.53", "capTotal": "1", "capResetAfter":「24", "capForCampaign":「キャンペーン", "url":"https%3A%2F%2Fmywebsite.com%2F%3Ftoken%3D%26zone%3D"}' https://hilltopads.com/api/v1/advertiser/campaign/123456?key=nXzgO3Bc