広告主サービス
広告主サービスを使用すると、ネットワークは Xandr と対話する広告主を追加、変更、表示できます。 直接マーケティング担当者は、広告主が 1 人 (それ自体) しかないため、広告主サービスを使用することはめったにありません。
REST API
HTTP メソッド | エンドポイント | 説明 |
---|---|---|
GET |
https://api.appnexus.com/advertiser |
すべての広告主を表示します。 |
GET |
https://api.appnexus.com/advertiser?id=ADVERTISER_ID |
特定の広告主を表示します。 |
GET |
https://api.appnexus.com/advertiser?code=ADVERTISER_CODE |
特定の広告主を表示します。 |
GET |
https://api.appnexus.com/advertiser?id=1,2,3 |
コンマ区切りのリストを使用して、複数の広告主を ID で表示します。 |
GET |
https://api.appnexus.com/advertiser?search=SEARCH_TERM |
特定の文字を含む ID または名前を持つ広告主向けのSearch。 |
GET |
https://api.appnexus.com/advertiser/meta |
フィルター処理および並べ替えの対象となるフィールドを確認します。 |
POST |
https://api.appnexus.com/advertiser |
新しい広告主を追加します。 |
PUT |
https://api.appnexus.com/advertiser?id=ADVERTISER_ID |
既存の広告主を変更します。 |
PUT |
https://api.appnexus.com/advertiser?code=ADVERTISER_CODE |
既存の広告主を変更します。 |
DELETE |
https://api.appnexus.com/advertiser?id=ADVERTISER_ID |
広告主を削除します。 注: 広告主を削除すると、すべての子挿入注文、広告申込情報、キャンペーン、クリエイティブ、コンバージョン ピクセル、セグメントが削除されます。 削除は永続的であり、元に戻すことはできません。 削除されたオブジェクトは引き続きレポートで使用できますが、広告申込情報の収益予算、コスト予算、キャンペーンのターゲット設定など、特定の設定が表示されなくなります。 |
JSON フィールド
フィールド | 種類 | 説明 |
---|---|---|
allow_safety_pacing |
ブール値 | 管理のみ。 の場合 true 、1 分あたりの支出は、生涯予算の最大 1% と 1 日の予算の 5% に制限されます。 |
audience_size_check_state |
列挙 | 対象ユーザー サイズ検証チェックの状態。 Yield Analytics が提供する外部サービスを使用して、対象ユーザーのサイズが Netflix の取引で定義された広告申込情報のターゲット設定の基準を満たしていることを確認します。 使用可能な値: - passed - failed - in_progress - unchecked メモ: このフィールドは、ネットフリックスの取引で定義された行項目に対してのみ表示されます。 |
audience_size_check_last_run |
timestamp | 対象ユーザーサイズの検証チェックが最後に実行された時刻のタイムスタンプ。これは、状態が または failed にpassed 変更されたときです。メモ: このフィールドは、ネットフリックスの取引で定義された行項目に対してのみ表示されます。 |
billing_address1 |
string (100) | 参考までに。 |
billing_address2 |
string (100) | 参考までに。 |
billing_city |
string (100) | 参考までに。 |
billing_country |
string (100) | 参考までに。 |
billing_internal_user |
配列 | 参考までに。 これは、この広告主で働くユーザー (文字列) の一覧です。 |
billing_name |
string (50) | 参考までに。 値は最大 50 文字です。 |
billing_phone |
string (20) | 参考までに。 |
billing_state |
string (100) | 参考までに。 |
billing_zip |
string (25) | 参考までに。 |
code |
string (100) | 広告主のカスタム コード。 Xandr は一意の ID を割り当てますが、広告主は独自の ID システムを使用できます。 "code" または Xandr 割り当て ID が他のサービスのフィールドに許可されます。 |
legal_entity_name |
string (255) | 広告の代わりに表示され、広告主の広告のコストをカバーする法人を表します。 このフィールドは、欧州連合 デジタル サービス法 (DSA) に準拠するために、入札応答で使用されます。 |
competitive_brands |
配列 | ブランド ID の配列。 この配列のブランドに関連付けられているクリエイティブは、オークションで一緒に /mtj 提供されることはありません。 競合ブランドの典型的な例は、コーラとペプシです。 システム内のブランドの詳細については、 ブランド サービスに関するページを参照してください。 |
competitive_categories |
配列 | カテゴリ ID の配列。 この配列のカテゴリに関連付けられているクリエイティブは、オークション (たとえば、 "Dating" や "Education" など) で一緒に/mtj 配信されることはありません。 クリエイティブ (およびブランド) に適用されるカテゴリの詳細については、 カテゴリ サービスに関するページを参照してください。 |
control_pct |
double | この広告主のコントロール グループ内のユーザーの割合。 これは、 と 1 の間0 の数値で表す必要があります。 これらのユーザーには、他のクリエイティブの効果を測定するためにコントロール クリエイティブが表示されます。 詳細については、UI ドキュメントの 「Test and Control Targeting (Standard Line Item)」 を参照してください。 |
daily_budget |
double | 広告主の 1 日の予算。 (以下を参照)。lifetime_budget |
daily_budget_imps |
int | 広告主の 1 日あたりのインプレッション予算。 (以下を参照)。lifetime_budget |
default_brand |
object | 既定のブランドに関する情報。 詳細については、以下の 「既定のブランド 」を参照してください。 既定値: null |
default_brand_id |
int | この広告主のすべてのクリエイティブの既定のブランドの内部 ID。 各クリエイティブのブランドは、監査プロセス中にチェックされます。 |
default_category |
object | この機能は現時点では機能していません。 今後の開発で使用される予定です。 |
default_currency |
string (3) | 広告主に使用される既定の通貨。 これは、読み取り専用 通貨サービスから取得できる 3 文字のコードになります。 概念の詳細については、UI ドキュメントの 「通貨サポート 」を参照してください。 注: ベスト プラクティスとして、可能な限り最適な現地通貨エクスペリエンスを実現するために、通貨を請求通貨に合わせます。 既定値: メンバーの既定の通貨 |
enable_pacing |
ブール値 | の場合 true 、1 日の間にこの広告主の支出のペースが調整されます。 |
enable_political_io_by_default |
ブール値 | 使用可能な値: 0 または 1 。に設定されている場合、UI を true 使用してこの広告主に対して作成された挿入注文では、既定で政治的広告が有効になります。 これは、API を使用して作成された挿入順序には影響しません。既定値: 1 (true) |
id |
int | 広告主の ID。 読み取り専用 必須: PUT 既定値: 自動インクリメントされた数値 |
is_malicious |
ブール値 | 管理のみ。 の場合 true 、広告主の状態は非アクティブに設定されます。 Xandr 管理者は、ユーザーを悪意のあるランディング ページに true 誘導すると判断された広告主に対して、このフィールドを に設定します。 Xandr 管理者がフィールドを に戻すまで、ユーザーは広告主の状態を is_malicious アクティブに false 戻すことはできません。既定値: false |
is_mediated |
ブール値 | 管理のみ。 の場合 true 、広告主は UI に表示されません。 Xandr 管理者は、広告主が仲介入札に関連付けられている場合に、このフィールドを に true 設定できます。既定値: false |
is_running_political_ads |
ブール値 | 使用可能な値: 0 または 1 。この広告主が政治広告を行うかどうかを宣言します (選挙、投票イニシアチブ、または政治的候補者に関連する広告として定義米国)。 既存の広告主が政治広告を有効にした挿入注文を既に持っている場合は、 に false 設定is_running_political_ads することはできません。既定値: 0 (false) |
labels |
配列 | 広告主に適用されるオプションのラベル。 現在、広告主は次の 3 つのラベルを利用できます。 - "Salesperson" - "Account Manager" - "Advertiser Type" . 詳細については、以下の 「ラベル 」を参照してください。注: Network Analytics レポートを使用して、広告主のラベルに関するレポートを作成できます。 たとえば、"Salesperson" ラベルを使用して各広告主を担当する営業担当者の名前を指定する場合、フィルター処理された "salesperson_for_advertiser" Network Analytics レポートを実行して、特定の営業担当者が担当またはグループ化する "salesperson_for_advertiser" 広告主に焦点を当てて営業担当者のパフォーマンスをランク付けできます。 |
last_modified |
timestamp | この広告主が最後に変更された時刻のタイムスタンプ。 |
lifetime_budget |
double | すべての予算パラメーターは、広告主レベルだけでなく、キャンペーンやメディアの購入レベルでも設定できます。 広告主レベルの予算は、広告主のすべてのトラフィックに適用されます。 これはドル (メディア コスト) の予算です。 |
lifetime_budget_imps |
int | 広告主の生涯インプレッション予算。 (上記を参照)。lifetime_budget |
name |
string (255) | 広告主の名前。 必須: POST |
object_stats |
object | 広告主の合計、アクティブ、非アクティブな挿入注文、広告申込情報、キャンペーン、クリエイティブの数、および特定の監査ステータスを持つクリエイティブの数。 このオブジェクトを応答に含めるには GET 、クエリ文字列を渡します object_stats=true 。読み取り専用。 |
partner_fees |
配列 | この広告主に適用されるパートナー料金の配列。 パートナー料金サービスを使用して、パートナー料金を作成、添付、表示、または削除できます。 |
profile_id |
int | 広告主、広告申込情報、キャンペーン、クリエイティブ の各レベルでオプション profile_id を設定できます。 プロファイルは、インベントリを対象とする一般的なルールのセットです。 広告主レベルで設定されたプロファイルは、広告主のすべてのトラフィックに適用されるため、このプロファイルを非常に広く保つ必要があります。 広告呼び出しは、任意のレベルですべてのプロファイル ターゲットを渡す必要があります。 詳細については、 プロファイル サービス を参照してください。 |
remarketing_segment_id |
int | セグメントは、レポートとフィルター処理のみを目的として "リマーケティング" としてマークされます。 UI でセグメントをリマーケティングとしてマークすると、ここに表示されます。 または、ここでセグメント ID を追加すると、レポート目的でリマーケティングとしてマークされます。 |
state |
列挙 | 広告主の状態。 使用可能な値: "active" または "inactive" 。既定値: "active" |
stats |
object | オブジェクトは stats 非推奨になりました (2016 年 10 月 17 日現在)。 代わりに Report Service を使用して統計情報を取得します。 |
timezone |
列挙 | 広告主のタイムゾーン。 詳細と受け入れられる値については、「 API タイムゾーン 」を参照してください。 広告主のタイムゾーンを子オブジェクトに "トリクルダウン" させる方法の詳細については、以下 の「依存オブジェクトのタイムゾーン 」を参照してください。 既定値: "EST5EDT" 、またはメンバーのタイム ゾーン。 |
thirdparty_pixels |
配列 | 広告主に関連付けられているサード パーティ製ピクセルの配列。 これらのピクセルは、 サードパーティのピクセル サービス を使用してこの広告主が所有するすべてのクリエイティブに自動的にアタッチすることも、 クリエイティブ サービスを使用してクリエイティブ レベルで個別にアタッチすることもできます。 読み取り専用。 既定値: null |
time_format |
列挙 | UI に表示される時刻を表示する形式。 使用可能な値: "12-hour" または "24-hour" 。既定値: "12-hour" |
use_insertion_orders |
ブール値 | の場合 true 、広告申込情報のコレクションを含む挿入注文の使用がこの広告主に対して有効になります。 このフィールドが に設定されている場合、挿入オーダーを "false" 作成することはできません。 詳細については、 挿入注文サービス を参照してください。注意: 既存の明細 この設定を有効にする前にこのフィールドを に true 設定し、既に明細を作成している場合、それらの明細は支出を停止します。 これらの明細に引き続き支出を許可するには、( 挿入指図サービスを使用して) 挿入オーダを作成し、その明細を挿入指図に関連付けます ( 明細サービスを使用)。 新しく作成されたすべての明細には、挿入順序が必要です。注: 広告主に関連する挿入注文がある場合、の値 "use_insertion_orders" を に false 更新することはできません。既定値: true |
サード パーティ製ピクセル
配列には thirdparty_pixels
、次の表のフィールドが含まれています。 これらのフィールドは読み取り専用です。 サードパーティのピクセルを更新または作成したり、広告主が所有するすべてのクリエイティブにサードパーティのピクセルをアタッチしたりするには、 サードパーティの Pixel サービスを使用します。 個々のクリエイティブにサードパーティのピクセルをアタッチするには、 Creative Service を使用します。
フィールド | 種類 | 説明 |
---|---|---|
active |
ブール値 | ピクセルの現在の状態 (true = active )。読み取り専用。 |
audit_statu s |
string | ピクセルの監査状態。 読み取り専用。 |
id |
int | ピクセルの ID。 読み取り専用。 |
name |
string | ピクセルの完全な名前。 読み取り専用。 |
統計
オブジェクトは stats
非推奨になりました (2016 年 10 月 17 日現在)。 代わりに Report Service を使用して統計情報を取得します。
ラベル
読み取り専用 ラベル サービス を使用すると、広告主、広告掲載オーダー、広告申込情報、キャンペーン、パブリッシャーの可能なすべてのラベルを表示できます。 このサービスを使用すると、オブジェクトに既に適用されているラベルを表示できます。
フィールド | 型 (長さ) | 説明 |
---|---|---|
id |
int | ラベルの ID。 使用可能な値:1 (Salesperson)3 (アカウント マネージャー)12 (広告主の種類)。 |
name |
列挙 | ラベルの名前。 使用可能な値: - "Salesperson" - "Account Manager" - "Advertiser Type" .読み取り専用。 |
value |
string (100) | ラベルに割り当てられた値。 たとえば、ラベルの "Salesperson" 場合は、 などの "Michael Sellers" 名前を指定できます。 |
改ページ
次のフィールドを使用して、特定の数のオブジェクトを要求できます。
"count": 8,
"start_element": null,
"num_elements": null
フィールド | 種類 | 説明 |
---|---|---|
count |
int | このサービス内のオブジェクトの数はいくつですか? たとえば、8 人の広告主です。 |
num_elements |
int | 返す要素の数はいくつですか? たとえば、オブジェクト # 4 から開始し、3 つのオブジェクト、または # 4、5、6 を返します。 |
start_element |
int | カウントを開始する数値。 |
既定のブランド
フィールド | 種類 | 説明 |
---|---|---|
category_id |
int | ブランドのカテゴリの ID。 |
id |
int | ブランドの ID。 |
name |
string | ブランドの名前。 |
依存オブジェクトのタイムゾーン
広告主のタイムゾーンを変更する場合は、子オブジェクト (キャンペーン、広告申込情報、クリエイティブ) に変更を "トリクルダウン" するかどうかを選択できます。 これを行うには、要求中に URL のクエリ文字列を渡 set_child_timezone=true
して、タイムゾーンを作成または更新する必要があります。
以下に例を示します。
$ curl -b cookies -X PUT -d @advertiser 'https://api.appnexus.com
/advertiser?id=111&set_child_timezone=true'
- の場合
true
、すべての子オブジェクトのタイムゾーンが広告主のタイムゾーンに設定されます。 下位レベルのオブジェクト (挿入注文、広告申込情報、キャンペーンなど) のタイムゾーン設定は、広告主のタイムゾーンでオーバーライドされることに注意してください。 - の場合
false
、タイムゾーンは広告主にのみ設定されます。
例
広告主を追加する
$ cat advertiser.json
{
"advertiser":
{
"name":"Advertiser B",
"legal_entity_name":"Toyota UK",
"state":"active"
}
}
$ curl -b cookies -c cookies -X POST --data-binary @advertiser.json 'https://api.appnexus.com/advertiser'
{
"response":{
"status":"OK",
"id":51
}
}
広告主を更新する
$ cat advertiser_update
{
"advertiser":
{
"name":"Advertiser B",
"legal_entity_name":"Toyota UK",
"state":"active",
"code":"PSS"
}
}
$ curl -b cookies -c cookies -X PUT --data-binary @advertiser_update 'https://api.appnexus.com/advertiser?id=51'
{
"response":{
"status":"OK",
"id":492
}
}
すべての広告主を表示する
$ curl -b cookies -c cookies 'https://api.appnexus.com/advertiser'
{
"response": {
"status": "OK",
"advertisers": [
{
"id": 51,
"code": null,
"name": "Advertiser B",
"legal_entity_name":"Toyota France",
"state": "active",
"default_brand_id": 0,
"remarketing_segment_id": null,
"lifetime_budget": null,
"lifetime_budget_imps": null,
"daily_budget": null,
"daily_budget_imps": null,
"enable_pacing": true,
"profile_id": null,
"thirdparty_pixels": [
{
"id":145,
"name":"sample pixel",
"audit_status":"pending",
"active":true
},
{
"id":314,
"name":"another sample pixel",
"audit_status":"pending",
"active":true
}
],
"control_pct": 0,
"timezone": "EST5EDT",
"last_modified": "2010-08-03 23:07:02",
"stats": null,
"billing_internal_user": null,
"billing_address1": "123 Happy Street",
"billing_address2": "",
"billing_city": "New York",
"billing_state": "NY",
"billing_country": "US",
"billing_zip": "10011",
"default_category": null,
"default_currency": "USD",
"labels": null,
"use_insertion_orders": false,
"time_format": "12-hour",
"default_brand": null,
"is_malicious": false
},
{
"id": 493,
"code": null,
"name": "Cheese Club",
"legal_entity_name":"Toyota Germany",
"state": "active",
"default_brand_id": 0,
"remarketing_segment_id": 11111,
"lifetime_budget": null,
"lifetime_budget_imps": null,
"daily_budget": null,
"daily_budget_imps": null,
"enable_pacing": true,
"profile_id": null,
"thirdparty_pixels":null,
"control_pct": 0,
"timezone": "EST5EDT",
"last_modified": "2010-09-15 21:02:37",
"stats": null,
"billing_internal_user": null,
"billing_address1": null,
"billing_address2": null,
"billing_city": null,
"billing_state": null,
"billing_country": null,
"billing_zip": null,
"default_category": null,
"default_currency": "USD",
"labels": null,
"use_insertion_orders": false,
"time_format": "12-hour",
"default_brand": null,
"is_malicious": false
}
],
"count": 5,
"start_element": null,
"num_elements": null,
"dbg_info": {
...
}
}
}
特定の広告主を表示する
$ curl -b cookies -c cookies 'https://api.appnexus.com/advertiser?id=51'
{
"response":{
"status":"OK",
"count":1,
"start_element":0,
"num_elements":100,
"advertiser":{
"id":51,
"code":null,
"name":"Advertiser A",
"legal_entity_name":"Toyota UK",
"state":"active",
"default_brand_id":0,
"remarketing_segment_id":null,
"profile_id":null,
"control_pct":0,
"timezone":"EST5EDT",
"last_modified":"2010-05-06 20:21:56",
"member_id":79,
"billing_name":null,
"billing_phone":null,
"billing_address1":null,
"billing_address2":null,
"billing_city":null,
"billing_state":null,
"billing_country":null,
"billing_zip":null,
"default_currency":"USD",
"use_insertion_orders":false,
"time_format":"12-hour",
"is_malicious":false,
"billing_internal_user":null,
"default_category":null,
"default_brand":null,
"labels":null,
"competitive_brands":null,
"competitive_categories":null,
"lifetime_budget":null,
"lifetime_budget_imps":null,
"daily_budget":null,
"daily_budget_imps":null,
"enable_pacing":null,
"lifetime_pacing":null,
"lifetime_pacing_span":null,
"allow_safety_pacing":null,
"stats":null
}
}
}