ターゲティング条件

GET accounts/:account_id/targeting_criteria¶

現在のアカウントの行項目に関連付けられている一部またはすべてのターゲティング条件の詳細を取得します。

リソースURL¶

https://ads-api.x.com/10/accounts/:account_id/targeting_criteria

パラメーター¶

リクエストの例¶

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/targeting_criteria?line_item_ids=8u94t

応答の例¶

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t",
      "line_item_ids": [
        "8u94t"
      ]
    }
  },
  "next_cursor": null,
  "data": [
    {
      "line_item_id": "8u94t",
      "name": "Custom audience targeting",
      "id": "dpl3a6",
      "operator_type": "EQ",
      "created_at": "2017-05-26T03:29:35Z",
      "targeting_value": "249yj",
      "updated_at": "2017-05-26T03:29:35Z",
      "deleted": false,
      "targeting_type": "CUSTOM_AUDIENCE"
    }
  ]
}

GET accounts/:account_id/targeting_criteria/:targeting_criterion_id¶

現在のアカウントに関連付けられている特定のターゲティング条件を取得します。

リソースURL¶

https://ads-api.x.com/10/accounts/:account_id/targeting_criteria/:targeting_criterion_id

パラメーター¶

リクエストの例¶

GET https://ads-api.x.com/10/accounts/18ce54d4x5t/targeting_criteria/eijd4y

応答の例¶

{
  "request": {
    "params": {
      "targeting_criterion_id": "eijd4y",
      "account_id": "18ce54d4x5t"
    }
  },
  "data": {
    "line_item_id": "619jl",
    "name": "🤖",
    "id": "eijd4y",
    "created_at": "2017-07-06T16:51:04Z",
    "targeting_value": "🤖",
    "updated_at": "2017-07-06T16:51:04Z",
    "deleted": false,
    "targeting_type": "BROAD_KEYWORD"
  }
}

POST accounts/:account_id/targeting_criteria¶

特定のターゲティングタイプのtargeting_valueについては、「ターゲティングオプション」ページを参照してください。最新のターゲティングタイプの値を操作できるよう、すべてのデータを週に1回更新することをお勧めします。値と利用可能なターゲティング条件は随時変更されます。大部分が頻繁に変更されるわけではありませんが、一部が変更されます。これらの値が変更されないという保証はありません。

BROAD_KEYWORD、EXACT_KEYWORD、PHRASE_KEYWORD、UNORDERED_KEYWORDのターゲティングタイプは、targeting_valueで指定するキーワードと合わせて使用します。NEに設定されたoperator_typeのリクエストパラメーターを使用してキーワードを除外します。各タイプの詳細の説明については、ターゲティングキーワードのタイプを参照してください。

注: 行項目につき1つの年齢層のみターゲティングできます。

注: カスタムオーディエンスをターゲティングするには、そのオーディエンスがターゲット可能である必要があります。つまり、targerableとtrueが同じである必要があります。

注: ターゲティングタイプTV_SHOWを使用する場合、TV_SHOWターゲティングを設定する前に行項目に少なくとも1つのLOCATIONターゲティング条件があり、すべてのLOCATIONが、ターゲティングされるTV_SHOWと同じロケール内にある必要があります。

リソースURL¶

https://ads-api.x.com/10/accounts/:account_id/targeting_criteria

パラメーター¶

リクエストの例¶

POST https://ads-api.x.com/10/accounts/18ce54d4x5t/targeting_criteria?line_item_id=619jl&targeting_type=BROAD_KEYWORD&targeting_value=technology

応答の例¶

{
  "data": {
    "line_item_id": "619jl",
    "name": "technology",
    "id": "fbyjlr",
    "created_at": "2017-09-06T07:31:21Z",
    "targeting_value": "technology",
    "updated_at": "2017-09-06T07:31:21Z",
    "deleted": false,
    "targeting_type": "BROAD_KEYWORD"
  },
  "request": {
    "params": {
      "line_item_id": "619jl",
      "targeting_type": "BROAD_KEYWORD",
      "targeting_value": "technology",
      "account_id": "18ce54d4x5t"
    }
  }
}

POST batch/accounts/:account_id/targeting_criteria¶

1回のリクエストで新しいターゲティング条件をバッチ作成できます。

バッチリクエスト

• 現在の最大バッチサイズは500です。
• すべてのパラメーターはリクエストボディで送信され、application/jsonのContent-Typeが必須です。
• バッチリクエストはグループ単位で失敗または成功となります。エラーの場合も、成功の場合も、API応答には、最初のリクエストの項目の順序が保持されます。

バッチ応答

バッチAPIの応答は、項目のコレクションを順番どおりに返します。その点を除くと、バッチAPIの構造は、対応する単一項目のエンドポイントと同じです。

バッチエラー

• リクエストレベルのエラー（最大バッチサイズの超過など）は、errorsオブジェクトの応答に表示されます。
• 項目レベルのエラー（必須ターゲティング条件パラメーターの不足など）は、operation_errorsオブジェクトの応答に表示されます。

リソースURL¶

https://ads-api.x.com/10/batch/accounts/:account_id/targeting_criteria

パラメーター¶

リクエストの例¶

POST https://ads-api.x.com/10/batch/accounts/18ce54d4x5t/targeting_criteria

[
  {
    "operation_type":"Create",
    "params":{
      "line_item_id":"6f9an",
      "targeting_type":"LOCATION",
      "targeting_value":"5122804691e5fecc"
    }
  },
  {
    "operation_type":"Delete",
    "params":{
      "targeting_criterion_id":"al2rua"
    }
  }
]

応答の例¶

{
  "data_type": "targeting_criterion",
  "data": [
    {
      "line_item_id": "6f9an",
      "name": "San Francisco-Oakland-San Jose CA, US",
      "id": "al7vt2",
      "location_type": "CITY",
      "operator_type": "EQ",
      "created_at": "2016-11-11T22:59:50Z",
      "targeting_value": "5122804691e5fecc",
      "updated_at": "2016-11-11T22:59:50Z",
      "deleted": false,
      "targeting_type": "LOCATION"
    },
    {
      "line_item_id": "6keuo",
      "name": "accounts",
      "id": "al2rua",
      "operator_type": "EQ",
      "created_at": "2016-11-11T17:50:19Z",
      "targeting_value": "accounts",
      "updated_at": "2016-11-11T22:59:50Z",
      "deleted": true,
      "targeting_type": "BROAD_KEYWORD"
    }
  ],
  "request": [
    {
      "params": {
        "line_item_id": "6f9an",
        "targeting_type": "LOCATION",
        "targeting_value": "5122804691e5fecc",
        "account_id": "18ce54d4x5t"
      },
      "operation_type": "Create"
    },
    {
      "params": {
        "targeting_criterion_id": "al2rua",
        "account_id": "18ce54d4x5t"
      },
      "operation_type": "Delete"
    }
  ]
}

DELETE accounts/:account_id/targeting_criteria/:targeting_criterion_id¶

現在のアカウントに属する、指定したターゲティング条件を削除します。

リソースURL¶

https://ads-api.x.com/10/accounts/:account_id/targeting_criteria/:targeting_criterion_id

パラメーター¶

リクエストの例¶

DELETE https://ads-api.x.com/10/accounts/18ce54d4x5t/targeting_criteria/dpl3a6

応答の例¶

{
  "data": {
    "line_item_id": "8u94t",
    "name": "Custom audience targeting",
    "id": "dpl3a6",
    "created_at": "2017-05-26T03:29:35Z",
    "targeting_value": "249yj",
    "updated_at": "2017-08-30T18:38:58Z",
    "deleted": true,
    "targeting_type": "CUSTOM_AUDIENCE"
  },
  "request": {
    "params": {
      "targeting_criterion_id": "dpl3a6",
      "account_id": "18ce54d4x5t"
    }
  }
}