Campaign management

機能

Postmanで実行 ❯

GET accounts/:account_id/features

この広告アカウントがアクセスを許可されている機能のコレクションを取得します。機能は内容を示す機能キーで表され、ベータ版またはその他の限定リリースで導入された場合にのみ、このエンドポイントで公開され、広告APIで利用可能になります。この条件を満たさない機能は、このエンドポイントで公開されません。

注: ベータリリースへのクライアントアクセスにおいてこのエンドポイントを目につきやすくすれば、広告APIエコシステムの開発をより効率的に行うことができます。API開発者は、広告主に代わって機能へのアクセスをリクエストすることはできません。これらのリクエストは、広告主が自分のTwitterアカウントマネージャーに対してのみ行うことができます。

リソースURL

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

パラメーター

名前 説明
account_id
必須

利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。

タイプ: 文字列

例: 18ce54d4x5t
feature_keys
任意

特定の機能キーのクエリを可能にする任意のパラメーター。リクエストには、カンマで区切った複数のキーを含めることができます。

注: このアカウントでアクセス可能な機能のみが応答に含まれます。

タイプ: 列挙

使用可能な値: CHARGE_FOR_GOOD_CLICK、CONVERSATION_CARD、DIRECT_MESSAGE_CARD、REACH_AND_FREQUENCY_ANALYTICS、REACH_FREQUENCY_CAP

リクエストの例

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

応答の例

{
  "request": {
    "params": {
      "account_id": "18ce54d4x5t"
    }
  },
  "data": [
    "CITY_TARGETING",
    "CONVERSATION_CARD",
    "PROMOTED_MEDIA_POLLS",
    "REACH_AND_FREQUENCY_ANALYTICS",
    "REACH_FREQUENCY_CAP",
    "UNIVERSAL_LOOKALIKE"
  ]
}

POST accounts/:account_id/features

サンドボックスのみ

サンドボックスアカウントに機能を追加します。

アカウントの機能の最新のリストは、GET accounts/:account_id/featuresエンドポイントから取得できます。

リソースURL

https://ads-api-sandbox.twitter.com/10/accounts/:account_id/features

パラメーター

名前 説明
account_id
必須

利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。

タイプ: 文字列

例: gq180y
feature_keys
必須

アカウントに追加するアカウントの機能で構成されるカンマ区切りのリスト。

タイプ: 列挙

使用可能な値: AGE_TARGETING、 ALLOW_SKIPPABLE_VIDEOS_FOR_PREROLL_VIEWS_OBJECTIVE、 AWARENESS_OBJECTIVE、 BRAND_TPN、CHARGE_FOR_GOOD_CLICK、CONVERSATION_CARD、CONVERSATION_CARD_FOUR_OPTIONS、CONVERSATION_CARD_UNLOCK、CPI_CHARGING、DIRECT_MESSAGE_CARD、DR_TAP、ENGAGER_RETARGETING、EVENT_TARGETING、INSTALLED_APP_CATEGORY_TARGETING、MOBILE_CONVERSION_TRANSACTION_VALUE、OPTIMIZED_ACTION_BIDDING、REACH_AND_FREQUENCY_ANALYTICS、REACH_FREQUENCY_CAP、VALIDATED_AGE_TARGETING、VIDEO_VIEWS_MIDROLL_OBJECTIVE、PREROLL_VIEWS_OBJECTIVE、VIDEO_APP_DOWNLOAD_CARD

リクエストの例

POST https://ads-api-sandbox.twitter.com/10/accounts/gq180y/features?feature_keys=VALIDATED_AGE_TARGETING

応答の例

{
  "request": {
    "params": {
      "account_id": "gq180y",
      "feature_keys": [
        "VALIDATED_AGE_TARGETING"
      ]
    }
  },
  "data": [
    "ALLOW_SKIPPABLE_VIDEOS_FOR_PREROLL_VIEWS_OBJECTIVE",
    "AWARENESS_OBJECTIVE",
    "CPI_CHARGING",
    "EVENT_TARGETING",
    "INSTALLED_APP_CATEGORY_TARGETING",
    "MOBILE_CONVERSION_TRANSACTION_VALUE",
    "OPTIMIZED_ACTION_BIDDING",
    "VALIDATED_AGE_TARGETING",
    "VIDEO_APP_DOWNLOAD_CARD"
  ]
}

DELETE accounts/:account_id/features

サンドボックスのみ

サンドボックスアカウントから機能を削除します。

アカウントの機能の最新のリストは、GET accounts/:account_id/featuresエンドポイントから取得できます。

リソースURL

https://ads-api-sandbox.twitter.com/10/accounts/:account_id/features

パラメーター

名前 説明
account_id
必須

利用するアカウントのID。リソースのパス内に表示され、通常、GET accountsを除くすべての広告主APIリクエストに必須のパラメーターです。指定するアカウントは、認証済みユーザーに関連付けられている必要があります。

タイプ: 文字列

例: gq180y
feature_keys
必須

アカウントから削除するアカウントの機能で構成されるカンマ区切りのリスト。

タイプ: 列挙

使用可能な値: AGE_TARGETING、 ALLOW_SKIPPABLE_VIDEOS_FOR_PREROLL_VIEWS_OBJECTIVE、 AWARENESS_OBJECTIVE、 BRAND_TPN、CHARGE_FOR_GOOD_CLICK、CONVERSATION_CARD、CONVERSATION_CARD_FOUR_OPTIONS、CONVERSATION_CARD_UNLOCK、CPI_CHARGING、DIRECT_MESSAGE_CARD、DR_TAP、ENGAGER_RETARGETING、EVENT_TARGETING、INSTALLED_APP_CATEGORY_TARGETING、MOBILE_CONVERSION_TRANSACTION_VALUE、OPTIMIZED_ACTION_BIDDING、REACH_AND_FREQUENCY_ANALYTICS、REACH_FREQUENCY_CAP、VALIDATED_AGE_TARGETING、VIDEO_VIEWS_MIDROLL_OBJECTIVE、PREROLL_VIEWS_OBJECTIVE、VIDEO_APP_DOWNLOAD_CARD

リクエストの例

DELETE https://ads-api-sandbox.twitter.com/10/accounts/gq180y/features?feature_keys=PREROLL_VIEWS_OBJECTIVE

応答の例

{
  "request": {
    "params": {
      "account_id": "gq180y",
      "feature_keys": [
        "PREROLL_VIEWS_OBJECTIVE"
      ]
    }
  },
  "data": [
    "CPI_CHARGING",
    "EVENT_TARGETING",
    "INSTALLED_APP_CATEGORY_TARGETING",
    "MOBILE_CONVERSION_TRANSACTION_VALUE",
    "OPTIMIZED_ACTION_BIDDING",
    "VIDEO_APP_DOWNLOAD_CARD"
  ]
}