デジタル プラットフォーム API - 広告プロファイル サービス

ネットワークでは、パブリッシャーのページで実行できるブランドやクリエイティブの種類と実行できないブランドやクリエイティブの種類を定義するために、"広告承認プロファイル" を作成する場合があります。 広告プロファイル サービスを使用すると、メンバー レベルまたはパブリッシャー レベルで広告承認プロファイルを作成できます。 パブリッシャー レベルで作成するには、パブリッシャー ID を含めます。 パブリッシャー ID が含まれない場合、パブリッシャー ID はすべてのパブリッシャーで使用できるネットワークレベルのプロファイルになります。

広告プロファイルは、メンバー、ブランド、クリエイティブ、言語、技術属性、カテゴリ、広告サーバーなど、いくつかの要素で構成されます。 広告プロファイルを作成するときには、システム内の各クリエイティブを個別に承認または禁止できますが、ブランドまたはメンバー全体を承認または禁止することで時間を節約したい場合があります。

• メンバーは信頼される必要がある:その広告が常に受け入れられると信じる場合。 たとえば、ネットワーク A が質の高い広告を掲載することを "信頼" することで、各ネットワーク クリエイティブを監査する必要性を軽減できます。
• ブランドは信頼されるべきです: このブランドの広告はほとんどの場合受け入れられると信じる場合。 ただし、特定のクリエイティブは、"信頼できる" ブランドの一部であってもいつでも禁止することができます。 特定のクリエイティブが禁止されていない場合は、既定で実行されます。
• 禁止されるべきブランド: このブランドの広告は決して受け入れられないと思われる場合。 メンバーが禁止されていない限り、"禁止されている" ブランドが割り当てられた特定のクリエイティブを承認することは可能です。
• 既定のプロファイル (空白または ID を 0 に設定) では、他のメンバーからの監査されていない広告が禁止されます (つまり、クリエイティブの member_id が TinyTag の member_id 異なる場合)。

REST API

JSON フィールド

広告サーバー

入札者

ブランド

Categories

クリエイティブ

頻度の上限

言語

メンバー

シート数

技術的属性

例

新しい広告プロファイルの作成

これはかなり複雑なプロファイルです。 以下では、 cat コマンドを使用して広告プロファイル JSON ファイルの例を出力しました。

$ cat ad_profile
{
    "ad-profile": {
        "description": "Network Level ad profile",
        "member_id": 326,
        "brands": [
            {
                "id": "168",
                "status": "banned"
            },
            {
                "id": "255",
                "status": "banned"
            },
            {
                "id": "1072",
                "status": "trusted"
            },
            {
                "id": "1090",
                "status": "trusted"
            }
        ],
        "creatives": [
            {
                "id": "5",
                "approved": true
            }
        ],
        
        "bidders": [
            {
                "id": 2,
                "status": "trusted",
                "require_audit_type": "platform",
                "require_seller_audit_status": "always"
            },
            {
                "id": 5,
                "status": "banned"
            },
            {
                "id": 10,
                "status": "case-by-case",
                "require_audit_type": "platform_or_self",
                "require_seller_audit_status": "never"
            }
        ],
        "seats": [
          {
                "bidder_id": 2,
                "seat_code": "ABC123",
                "status": "trusted",
                "require_audit_type": "platform",
                "require_seller_audit_status": "always"
          },
          {
                "bidder_id": 5,
                "seat_code": "XYZ789",
                "status": "banned"
          }
        ],

        "notes": "This is a great ad profile",
        "default_language_status": "banned",
        "default_ad_server_status": "trusted",
        "default_category_status": "trusted",
        "default_technical_attribute_status": "trusted",
        "excluded_landing_page_urls": ["https://www.netflix.com","https://www.blockbuster.com"],
        "languages": [
            {
                "id": 1,
                "status": "trusted"
            }
        ],
        "ad_servers": null,
        "categories": [
            {
                "id": 41,
                "status": "banned"
            },
            {
                "id": 43,
                "status": "trusted"
            }
        ]
    }
}

既存の広告プロファイルを更新する

最初の例の広告プロファイル JSON を前提に、 categories 配列を更新して別の項目を含めたいとします。 実際のユース ケースでは、配列に 47 個のカテゴリが存在する可能性があります。 PUT のセマンティクスでは、配列に別のカテゴリを追加するには、既存の 47 個のカテゴリすべてと新しいカテゴリを渡す必要があります。

次の例に示すように、クエリ文字列パラメーターを append=true 要求に追加することで、この余分な作業を回避できます。 下位互換性の理由から、パラメーター append_only=true も機能します。

$ cat ad-profile-update.json
{
  "ad-profiles":
  [
    {
      "id": 984276,
      "categories" : [
        {
          "id" : 42,
          "status" : "banned"
        }
      ]
    }
  ]
}
$ curl -b cookies -X PUT -d '@/tmp/ad-profile-update.json' \
'https://api.appnexus.com/ad-profile?id=984276&member_id=1282&append=true'
{
   "response" : {
      "id" : 984276,
      "ad-profile" : {
         "id" : 984276,
         "description" : "Rich's Crazy Reseller - Network Ad Profile",
         "categories" : [
            {
               "id" : 41,
               "status" : "banned"
            },
            {
               "id" : 42,
               "status" : "banned"
            },
            {
               "id" : 43,
               "status" : "trusted"
            }
         ],
         // many other fields...
         "default_category_status" : "trusted"
      },
      "status" : "OK",
      "count" : 1,
      "start_element" : 0,
      "num_elements" : 100,
   }
}

広告プロフィールをメンバーに追加する

$ curl -b cookies -c cookies -X POST -d @ad_profile  "https://api.appnexus.com/ad-profile"
{
    "response": {
        "status": "OK",
        "id": "1317"
    }
}

広告プロファイルを表示する

$ curl -b cookies -c cookies "https://api.appnexus.com/ad-profile?id=1317"
{
  "response": {
    "status": "OK",
    "ad-profile": {
      "id": 1317,
      "state": "active",
      "description": "Network Level ad profile",
      "member_id": 326,
      "default_brand_status": "trusted",
      "members": null,
      "brands": [
        {
          "id": "168",
          "status": "banned"
        },
        {
          "id": "255",
          "status": "banned"
        },
        {
          "id": "1072",
          "status": "trusted"
        },
        {
          "id": "1090",
          "status": "trusted"
        }
      ],
      "creatives": [
        {
          "id": "5",
          "approved": true
        }
      ],
        
    "bidders": [
        {
          "id": 2,
          "status": "trusted",
          "block_unaudited_creatives": false,
          "allow_pending_creatives": false,
          "require_audit_type": "platform",
          "require_seller_audit_status": "always"
        },
        {
          "id": 5,
          "status": "banned",
          "block_unaudited_creatives": null,
          "allow_pending_creatives": null,
          "require_audit_type": null,
          "require_seller_audit_status": null
        }
      ],
      "seats": [
        {
          "seat_code": "ABC123",
          "bidder_id": 2,
          "status": "trusted",
          "block_unaudited_creatives": false,
          "allow_pending_creatives": false,
          "require_audit_type": "platform",
          "require_seller_audit_status": "always"
        },
        {
          "seat_code": "XYZ789",
          "bidder_id": 5,
          "status": "banned",
          "block_unaudited_creatives": null,
          "allow_pending_creatives": null,
          "require_audit_type": null,
          "require_seller_audit_status": null
        }
      ]

      "total_creative_count": 8369,
      "approved_creative_count": 1,
      "banned_creative_count": 8368,
      "creatives_approved_percent": 0.011948858883977,
      "creatives_unreviewed": 8367,
      "brands_unreviewed": null,
      "exclude_unaudited": true,
      "exclude_unaudited_direct": false,
      "notes": "This is a great ad profile.",
      "publisher_id": null,
      "last_modified": "2010-07-23 16:15:49",
      "default_language_status": "banned",
      "default_ad_server_status": "trusted",
      "default_category_status": "trusted",
      "excluded_landing_page_urls": ["https://www.netflix.com","https://www.blockbuster.com"],
      "default_technical_attribute_status": "trusted",
      "languages": [
        {
          "id": 1,
          "status": "trusted"
        }
      ],
      "ad_servers": null,
      "categories": [
        {
          "id": 41,
          "status": "banned"
        },
        {
          "id": 43,
          "status": "trusted"
        }
      ],
      "technical_attributes": null
    }
  }
}

クリエイティブ属性のフリークエンシー キャップの例

広告プロファイルに頻度の上限ルールを追加する

{{"frequency_caps"}} フィールドは最初に{{null}}されます。

$ curl -b cookies -c cookies -X GET "https://sand.api.appnexus.com/ad-profile?id=199943"
{
  "response": {
    "status": "OK",
    "ad-profile": {
      "id": 199943,
      "state": "active",
      "description": null,
      "member_id": 941,
      ...
      "frequency_caps": null
    }
}

頻度の上限ルールを追加する

$ cat add_freq_cap_rule.json
{
   "ad-profile": {
      "id": 199943,
      "frequency_caps": [
        {
          "max_day_imps": 5,
          "min_minutes_per_imp": 120,
          "technical_attributes": [ {"id":4},{"id":6} ],
          "categories": [ {"id":59},{"id":37} ]
        }
      ]
   }
}
$ curl -b cookies -c cookies -X PUT --data-binary @add_freq_cap_rule.json "https://sand.api.appnexus.com/ad-profile?id=199943"
{
  "response": {
    "status": "OK",
    "id": "199943"
  }
}

広告プロファイルに頻度の上限ルールが含まれるようになりました

$ curl -b cookies -c cookies -X GET "https://sand.api.appnexus.com/ad-profile?id=199943"
{
  "response": {
    "status": "OK",
    "ad-profile": {
      "id": 199943,
      "state": "active",
      "description": null,
      "member_id": 941,
      ...
      "frequency_caps": [
        {
          "id": 64,
          "max_session_imps": null,
          "max_day_imps": 5,
          "min_minutes_per_imp": 120,
          "member_id": 941,
          "technical_attributes": [
            {
              "id": 4,
              "name": "Video"
            },
            {
              "id": 6,
              "name": "Expandable"
            }
          ],
          "categories": [
            {
              "id": 37,
              "name": "Politics"
            },
            {
              "id": 59,
              "name": "Get Rich Quick"
            }
          ]
        }
      ]
      ...

頻度の上限ルールを変更する

{{ad-profile}} サービスで {{PUT}} コマンドを使用します。 フリークエンシー キャップの ID は、更新プログラムの JSON で指定する必要があります。 頻度の上限 ID が指定されていない場合、既存のルールは削除され、新しいルールが作成されます。

{code}
$ cat update_freq_cap_rule.json
{
   "ad-profile": {
      "id": 199943,
      "frequency_caps": [
        {
          "id": 64,
          "technical_attributes": [ {"id":4} ],
          "categories": [ ],
          "max_day_imps": 20
        }
      ]
   }
}
$ curl -b cookies -c cookies -X PUT --data-binary @update_freq_cap_rule.json "https://sand.api.appnexus.com/ad-profile?id=199943"
{
  "response": {
    "status": "OK",
    "id": "199943"
  }
}
{code}

広告プロファイルを確認して、更新されたルールを表示する

$ curl -b cookies -c cookies -X GET "https://sand.api.appnexus.com/ad-profile?id=199943"
{
  "response": {
    "status": "OK",
    "ad-profile": {
      "id": 199943,
      "state": "active",
      "description": null,
      "member_id": 941,
      ...
      "frequency_caps": [
        {
          "id": 64,
          "max_session_imps": null,
          "max_day_imps": 20,
          "min_minutes_per_imp": 120,
          "member_id": 941,
          "technical_attributes": [
            {
              "id": 4,
              "name": "Video"
            }
          ],
          "categories": null
        }
      ]
      ...