Digital Platform API - 広告プロファイル サービス

ネットワークでは、パブリッシャーのページで実行できるブランドとクリエイティブの種類を定義するために、"広告承認プロファイル" を作成する必要がある場合があります。 Ad Profile Service を使用すると、メンバー レベルまたはパブリッシャー レベルで広告承認プロファイルを作成できます。 パブリッシャー レベルで作成するには、発行元 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
        }
      ]
      ...