メインコンテンツへスキップ

​
Advertiser API

このAPIスイートを利用して、X上のキャンペーンをプログラムでスケジューリングし、広告を管理できます。

​
何を宣伝できますか？

  • Promoted Ads は、より幅広いユーザー層にリーチしたい、または既存のフォロワーからのエンゲージメントを促進したい広告主が購入する通常の広告です。
  • 広告主が X 上での掲載に対して支払っている場合、Promoted Ads には「Promoted」と明確に表示されます。それ以外の点では、Promoted Ads は通常の広告と同様に機能し、repost、返信、like などが可能です。一般的な配信ルールが適用され、POST statuses/update を使用して作成されます。
  • 「Promoted-only」Tweet は、POST accounts/:account_id/tweet によって作成され、Promoted Tweets のキャンペーンで使用できますが、フォロワーには配信されず、パブリックタイムラインにも表示されません。特定のアカウントの promoted-only tweets の一覧を取得するには、GET accounts/:account_id/scoped_timeline を使用します。
  • プロモアカウントは「おすすめユーザー（Who to Follow）」の一部で、現在フォローしていないが興味を持つ可能性のあるアカウントを提案します。プロモアカウントは、ユーザーが楽しめる多様なアカウントの発見をさらに後押しします。
  • タイムライン向けのプロモアカウントでは、プロモツイートをプロモアカウントのキャンペーンに関連付け、ユーザーのタイムラインに表示します。
Promoted Trends は X Ads API では利用できません。

​
キャンペーンと広告グループ（ラインアイテム）

キャンペーンは広告の配信スケジュールと予算を定義します。広告主は日次予算および総予算を指定します。キャンペーンは特定の開始・終了時刻に設定することも、予算が消化されるまで継続的に配信することもできます。予算は広告アカウントの Funding Instruments のいずれかから拠出されます。キャンペーン識別子（:campaign_id）は、X Ads UI に表示される 10 進数の値を 36 進数で表したものです。 広告アカウントには、有効なキャンペーンは最大 200 件という上限があります。この上限は、広告主の X Account Manager に依頼することで手動で 4,000 件まで引き上げ可能です。キャンペーンは、終了時刻に達するか delete されるまで有効と見なされます。一時停止中のキャンペーンも、設定された終了時刻までは有効と見なされます。 ラインアイテムは、キャンペーンで定義された予算を消化します。ラインアイテムは、エンゲージメント単価の入札、プロモーション対象の Tweet またはアカウント、ターゲティングルールを統合します。

​
Analytics

X Ads API には、広告パフォーマンスの追跡と最適化のための一連の分析用 endpoint が用意されています。詳細は「Analytics」および「Analytics Best Practices」を参照してください。 課金メトリクスについては、data はイベント発生後3日間は確定しない場合があります。それまでは data は暫定値とみなしてください。最終的な課金対象数は、常に暫定値より少なくなります。課金対象数はスパムや関連する低品質トラフィックを補正した値です。時間に関するその他の考慮事項については「Timezones」を参照してください。

​
キャンペーンの作成 - 手順

次の例では、twurl を使用して App とユーザーのインストール、設定、認可を完了していることを前提とします。twurl は cURL に着想を得たコマンドラインツールで、X の OAuth 認証を適切に処理します。twurl は Ads API（および REST API）の機能を迅速にテストおよびデバッグするのに最適なツールです。リクエストとレスポンスのすべてのヘッダーを表示するには、-t を指定して呼び出しをトレースします。これは cURL の -v オプションにおおむね相当します。 この例では、キーワードでターゲティングする Promoted Ads キャンペーンを作成します。
  1. アカウントの id を取得します。
twurl -H ads-api.x.com /9/accounts/

{
  "request": {
    "params": {
    }
  },
  "data": [
    {
      "name": "@AdsAPI のテストアカウント",
      "timezone": "America/Los_Angeles",
      "timezone_switch_at": null,
      "id": "xxxxxx",
      "created_at": "2014-03-09T00:41:49Z",
      "salt": "f9f9d5a5f23075c618da5eb1d1a9df57",
      "updated_at": "2015-01-29T00:41:49Z",
      "approval_status": "ACCEPTED",
      "deleted": false
    }
  ],
  "data_type": "account",
  "total_count": 1,
  "next_cursor": null
}
  1. 資金手段のidを取得します。
前のコマンドで取得したアカウントidを使用して、GET accounts/:account_id/funding_instruments API を呼び出します。 
twurl -H ads-api.x.com /9/accounts/xxxxxx/funding_instruments

{
  "data": [
    {
      "cancelled": true,
      "created_at": "2014-03-09T00:41:49Z",
      "credit_limit_local_micro": null,
      "currency": "USD",
      "deleted": false,
      "description": null,
      "end_time": null,
      "funded_amount_local_micro": null,
      "id": "yyyy",
      "type": null,
      "updated_at": "2014-05-29T00:41:49Z"
    }
  ],
  "data_type": "funding_instrument",
  "next_cursor": null,
  "request": {
    "params": {
      "account_id": "xxxxxx"
    }
  },
  "total_count": 1
}
  1. キャンペーンを作成し、資金手段に関連付けます。
キャンペーンの開始時刻と予算を指定します。この例では、予算は 500、日次上限は500、日次上限は 50 とします。 
twurl -H ads-api.x.com -d "funding_instrument_id=yyyy&name=初回キャンペーン&total_budget_amount_local_micro=500000000&daily_budget_amount_local_micro=50000000" /9/accounts/xxxxxx/campaigns

{
  "data": {
    "created_at": "2015-02-09T00:00:00Z",
    "currency": "USD",
    "daily_budget_amount_local_micro": 50000000,
    "deleted": false,
    "end_time": null,
    "funding_instrument_id": "yyyy",
    "id": "92ph",
    "name": "初回キャンペーン",
    "entity_status": "PAUSED",
    "standard_delivery": true,
    "total_budget_amount_local_micro": 500000000,
    "updated_at": "2015-02-09T00:00:00Z"
  },
  "data_type": "campaign",
  "request": {
    "params": {
      "account_id": "xxxxxx",
      "daily_budget_amount_local_micro": 50000000,
      "funding_instrument_id": "yyyy",
      "name": "初回キャンペーン",
      "total_budget_amount_local_micro": 500000000
    }
  }
}
  1. キャンペーンに関連付けられたラインアイテムを作成します。
キャンペーンのidが取得できたので、それに関連付けるラインアイテムを作成します。ラインアイテムは、入札価格、ターゲティング、およびキャンペーンの実際のクリエイティブ要素を包含します。本ラインアイテムでは、$1.50の入札でtweetsをプロモーションします。 
twurl -H ads-api.x.com -d "campaign_id=XXXX&bid_amount_local_micro=1500000&product_type=PROMOTED_TWEETS&placements=ALL_ON_TWITTER&objective=ENGAGEMENTS&entity_status=PAUSED" /9/accounts/xxxxxxx/line_items

{
  "data_type": "line_item",
  "data": {
    "bid_type": "MAX",
    "name": "無題",
    "placements": [
      "ALL_ON_TWITTER"
    ],
    "bid_amount_local_micro": 1500000,
    "automatically_select_bid": false,
    "advertiser_domain": null,
    "primary_web_event_tag": null,
    "charge_by": "ENGAGEMENT",
    "product_type": "PROMOTED_TWEETS",
    "bid_unit": "ENGAGEMENT",
    "total_budget_amount_local_micro": null,
    "objective": "ENGAGEMENTS",
    "id": "azjx",
    "entity_status": "PAUSED",
    "optimization": "DEFAULT",
    "categories": [],
    "currency": "USD",
    "created_at": "2015-02-09T00:00:00Z",
    "updated_at": "2015-02-09T00:00:00Z",
    "include_sentiment": "POSITIVE_ONLY",
    "campaign_id": "92ph",
    "deleted": false
  },
  "request": {
    "params": {
      "placements": [
        "ALL_ON_TWITTER"
      ],
      "bid_amount_local_micro": 1500000,
      "product_type": "PROMOTED_TWEETS",
      "entity_status": "PAUSED",
      "account_id": "xxxxxxx",
      "campaign_id": "92ph"
    }
  }
}
  1. ラインアイテムに紐づくターゲティングプロファイルを作成します。
ラインアイテムを作成したので、ターゲティング条件を設定します。対象はサンフランシスコ湾岸地域で、フレーズキーワード「grumpy cat」です。これにはロケーションの id の参照（ルックアップ）と、targeting_criteria への POST リクエストを2回行う必要があります。 
twurl -H ads-api.x.com "/9/targeting_criteria/locations?location_type=CITIES&q=San Francisco"

{
  "data": [
    {
      "name": "San Francisco-Oakland-San Jose CA, US",
      "targeting_type": "LOCATION",
      "targeting_value": "5122804691e5fecc"
    }
  ],
  "data_type": "targeting_criterion",
  "request": {
    "params": {
      "location_type": "CITY",
      "q": "San Francisco"
    }
  }
}

twurl -H ads-api.x.com -X POST -d "line_item_id=yyyy&targeting_type=LOCATION&targeting_value=5122804691e5fecc" /9/accounts/xxxxxx/targeting_criteria

{
  "data": {
    "created_at": "2015-02-09T00:00:15Z",
    "deleted": false,
    "id": "2u3be",
    "line_item_id": "yyyy",
    "name": "サンフランシスコ・オークランド・サンノゼ CA, US",
    "targeting_type": "LOCATION",
    "targeting_value": "5122804691e5fecc",
    "updated_at": "2013-05-30T21:01:35Z"
  },
  "data_type": "targeting_criterion",
  "request": {
    "params": {
      "account_id": "xxxxxx",
      "line_item_id": "yyyy",
      "targeting_type": "LOCATION",
      "targeting_value": "5122804691e5fecc"
    }
  }
}

twurl -H ads-api.x.com -X POST -d "line_item_id=yyyy&targeting_type=PHRASE_KEYWORD&targeting_value=grumpy cat" /9/accounts/xxxxxx/targeting_criteria

{
  "data": {
    "created_at": "2015-02-09T00:00:20Z",
    "deleted": false,
    "id": "2u3bd",
    "line_item_id": "yyyy",
    "name": "grumpy cat",
    "targeting_type": "PHRASE_KEYWORD",
    "targeting_value": "grumpy cat",
    "updated_at": "2013-05-30T18:05:35Z"
  },
  "data_type": "targeting_criterion",
  "request": {
    "params": {
      "account_id": "xxxxxx",
      "line_item_id": "yyyy",
      "targeting_type": "PHRASE_KEYWORD",
      "targeting_value": "grumpy cat"
    }
  }
}
  1. 最後に、ラインアイテムの一時停止を解除します。
twurl -H ads-api.x.com -X PUT "/9/accounts/xxxxxx/line_items/yyyy/?entity_status=ACTIVE"

{
  "data_type": "line_item",
  "data": {
    "bid_type": "MAX",
    "name": "grumpy cat",
    "placements": [],
    "bid_amount_local_micro": 1500000,
    "automatically_select_bid": false,
    "advertiser_domain": null,
    "primary_web_event_tag": null,
    "charge_by": "ENGAGEMENT",
    "product_type": "PROMOTED_TWEETS",
    "bid_unit": "ENGAGEMENT",
    "total_budget_amount_local_micro": null,
    "objective": "ENGAGEMENTS",
    "id": "yyyy",
    "entity_status": "ACTIVE",
    "optimization": "DEFAULT",
    "categories": [],
    "currency": "USD",
    "作成日時": "2015-02-09T00:00:20Z",
    "updated_at": "2015-02-09T00:00:20Z",
    "include_sentiment": "POSITIVE_ONLY",
    "campaign_id": "dy1f",
    "deleted": false
  },
  "request": {
    "params": {
      "line_item_id": "yyyy",
      "entity_status": "ACTIVE",
      "account_id": "xxxxxx"
    }
  }
}
以上です。これで、タイムライン内の Promoted Tweets を対象とし、アクティブでターゲティング済み、かつ予算が設定されたキャンペーンが稼働中です。

​
目的別キャンペーン

目的別のキャンペーンと料金設定により、広告主はマーケティング目標に合致したアクションに対して支払うことができます。これを実現するため、ラインアイテムで適切な objective を設定してください。 ラインアイテムの書き込み endpoint で使用され、読み取り endpoint で返されるパラメータは objective です。このフィールドは現在、次の値を取ります:
  • APP_ENGAGEMENTS
  • APP_INSTALLS
  • FOLLOWERS
  • ENGAGEMENTS
  • REACH
  • VIDEO_VIEWS
  • PREROLL_VIEWS
  • WEBSITE_CLICKS
目的は、オークションにおけるキャンペーンの最適化方法や当該キャンペーンの課金方法に影響します。目的に基づく料金設定を提供しており、例えば APP_ENGAGEMENTS は CPAC、APP_INSTALLS は CPAC または CPI、WEBSITE_CLICKS は CPLC、FOLLOWERS は CPF、ENGAGEMENTS は CPE、REACH は CPM となります。 モバイルアプリプロモーションのキャンペーンには、APP_ENGAGEMENTS または APP_INSTALLS のいずれかの目的が必須です。 注: 異なる目的のラインアイテムを同一キャンペーンに含めることはできません。
Campaign objectiveAPI objectiveMedia in TweetsPricing model
アプリ再エンゲージメントAPP_ENGAGEMENTS画像または動画のアプリダウンロードカードが必須。CPAC
アプリインストールAPP_INSTALLS画像または動画のアプリダウンロードカードが必須。CPAC または CPI（charge_by を使用して設定）
リーチREACH制限なし。CPM
フォロワー獲得FOLLOWERSTweet は必須ではありませんが推奨です。Followers キャンペーンの Tweet にはメディアの制限はありませんが、テキストのみの Tweet を推奨します。詳細CPF
エンゲージメントENGAGEMENTS制限なし。CPE
動画再生数VIDEO_VIEWSVideo conversation card、動画、または GIF が必須。CPV または 3 秒/100% 視聴あたりのコスト
プリロール再生数PREROLL_VIEWS動画が必須。CPV または 3 秒/100% 視聴あたりのコスト
ウェブサイトクリックWEBSITE_CLICKSWebsite card を推奨（必須ではありません）。Tweet には website card かウェブサイトリンクのいずれか一方が必要です（両方は不可）。CPLC

​
資金手段

資金手段はキャンペーン予算の拠出元です。資金手段は X Ads API から作成できません。利用するには、クレジットラインの場合は X の広告主担当アカウントマネージャー、クレジットカードの場合は ads.x.com を通じて、事前に設定されている必要があります。 アカウント上のすべての funding_instruments の一覧を取得するには、GET accounts/:account_id/funding_instruments を参照してください。特定の資金手段の詳細については、GET accounts/:account_id/funding_instruments/:funding_instrument_id を参照してください。

​
資金提供インストルメントの属性

記述情報: account_id、資金提供インストルメントの id、資金提供インストルメントの type、description、および io_header（インサーションオーダーのヘッダーID）。単一の io_header が複数の資金提供インストルメントに関連付けられる場合がある点に注意してください。 資金提供可否: able_to_fund と reasons_not_able_to_fund。 時刻: created_at、updated_at、start_time、および end_time は文字列で表され、「%Y-%m-%dT%l:%M:%S%z」の形式でフォーマットされます。 ブール値のステータス: paused、deleted、および cancelled（true または false）。 財務: currency（ISO-4217 形式）、credit_limit_local_micro、credit_remaining_local_micro、および funded_amount_local_micro。通貨の値はマイクロ単位で表現されます。USD の場合、$5.50 は 5.50*1e6、すなわち 5,500,000 としてエンコードされます。「整数値」を表すには、すべての通貨でローカルのマイクロ値に 1e6（1_000_000）を乗じる必要があります。

​
属性の詳細

credit_limit_local_micro は CREDIT_CARD または CREDIT_LINE type の資金手段に対してのみ有効で、その手段のクレジット上限額を表します。 funded_amount_local_micro は INSERTION_ORDER type の資金手段に対してのみ有効で、割り当て予算を表します。 credit_remaining_local_micro は CREDIT_LINE および AGENCY_CREDIT_LINE type の資金手段に対して有効です。これは、その資金手段で既に使用された金額を差し引いた後の credit_limit_local_micro を表します。funded_amount_local_micro と使用額との差を表すものではありません。クレジット上限額と資金割当額は、当社が広告主と取り決めている資金提供方法や支出契約が異なるため、区別しています。

​
資金手段の種類

クレジットカード 通常は、（アカウントマネージャーのいない）セルフサーブの広告主が使用します。 クレジットライン インサーションオーダー（IO）の形式で提供され、アカウントマネージャーによって設定されます。 マルチハンドル クレジットライン 広告主は、このタイプのクレジットラインを使って複数のハンドルにまたがるキャンペーンに資金を割り当てられます。この機能は X のアカウントマネージャーが有効化し、複数の @handle を特定のクレジットラインに関連付けます。 たとえば、@NikeSB と @NikeFuel はどちらも @Nike のクレジットラインにアクセスできます。この資金手段は他と同様に利用可能です。funding_instrument endpoint に GET リクエストを送信して data を取得します。以下はサンプルレスポンスです（CREDIT_LINE の type に注目してください）。 
      GET https://ads-api.x.com/5/accounts/a0b1c3/funding_instruments

{
    "request": {
        "params": {
            "account_id": "a0b1c3"
        }
    },
    "data": [
        {
            "start_time": "2013-05-30T04:00:00Z",
            "description": "FakeNike - クレジットライン",
            "credit_limit_local_micro": 150000000000,
            "end_time": null,
            "cancelled": false,
            "id": "i1234",
            "paused": false,
            "account_id": "a0b1c3",
            "reasons_not_able_to_fund": [],
            "io_header": null,
            "currency": "USD",
            "funded_amount_local_micro": 0,
            "created_at": "2013-05-30T18:16:38Z",
            "type": "CREDIT_LINE",
            "able_to_fund": true,
            "updated_at": "2013-05-30T18:16:38Z",
            "credit_remaining_local_micro": 123661919751,
            "deleted": false,
        }
    ],
    "data_type": "funding_instrument",
    "total_count": 1,
    "next_cursor": null
}
この資金手段について特記すべき点は、type と、それに関連付けられたすべてのアカウントで利用可能であることだけです。もちろん、これを共有するすべてのアカウントにわたり、この資金手段で賄われるすべてのキャンペーンによって、残存クレジットは影響を受けます。特定のクレジットラインにどのアカウントが関連付けられているかの詳細は、API（および ads.x.com）からは取得できません。 Funding Instrument の列挙型についての詳細は、こちらを参照してください。

​
ターゲティング

ターゲティングは X Ads API の中核概念です。ターゲティングはラインアイテム単位で設定され、プレースメントによって利用可能なオプションが異なります。新しいターゲティング条件を設定するには POST accounts/:account_id/targeting_criteria を、既存の条件を更新するには PUT accounts/:account_id/targeting_criteria を使用します。 すべてのラインアイテムの一覧を取得するには GET accounts/:account_id/line_items を、特定のラインアイテムを取得するには GET accounts/:account_id/line_items/:line_item_id を使用します。

​
配置別のターゲティングオプション

Promoted Tweets および Promoted Accounts は、さまざまな配置で提供されています。Promoted Trends (PTr) は API 経由では利用できません。 利用可能な配置の組み合わせについては、GET line_items/placements endpoint を参照してください。各配置には異なるターゲティングオプションがあります。ロケーション、プラットフォーム、性別はすべての配置で利用可能です。その他のオプションは配置の type に応じて異なります。
  • X Search: 年齢ターゲティング、デバイス、イベント、性別、キーワードタイプ（すべて）、言語、ロケーション、ネットワークの有効化、通信事業者、プラットフォーム、プラットフォームバージョン、テーラードオーディエンス、Wi‑Fi のみ
  • X Timeline: 年齢ターゲティング、デバイス、イベント、Followers Of、Similar to Followers Of、性別、インタレスト、言語、ロケーション、ネットワークの有効化、通信事業者、非完全一致のキーワードタイプ、パートナーオーディエンスタイプ、プラットフォーム、プラットフォームバージョン、リターゲティングタイプ、テーラードオーディエンス、TV ターゲティングタイプ、Wi‑Fi のみ
  • X Profiles & Tweet Details: 年齢ターゲティング、デバイス、イベント、Followers Of、Similar to Followers Of、性別、インタレスト、言語、ロケーション、ネットワークの有効化、通信事業者、非完全一致のキーワードタイプ、パートナーオーディエンスタイプ、プラットフォーム、プラットフォームバージョン、リターゲティングタイプ、テーラードオーディエンス、TV ターゲティングタイプ、Wi‑Fi のみ

​
ターゲティングタイプの理解

年齢ターゲティング: 特定の年齢バケットに基づいてユーザーをターゲティングします。年齢バケットの列挙一覧は Enumerations ページにあります。 イベント: ターゲティングするイベントを指定します。ターゲティングに使用できるイベントは（ラインアイテムごとに）1件のみです。ターゲティング可能なイベントは GET targeting_criteria/events endpoint で確認できます。 性別: 男性 (1) または女性 (2) をターゲティングします。null のままにすると全員が対象になります。 Installed App Store Categories: このターゲティングタイプを使用すると、ユーザーがインストールした、または関心を示したアプリのカテゴリに基づいてターゲティングできます。詳しくは GET targeting_criteria/app_store_categories を参照してください。 興味関心: ユーザーを興味関心でターゲティングします。興味関心の一覧は GET targeting_criteria/interests から取得します。最大100件までターゲティングできます。 Followers Of: 現在のアカウントで完全にプロモート可能なユーザーのフォロワーをターゲティングします（注：現在、そのアカウントで完全にプロモート可能なユーザーはプライマリアカウントの保有者のみです）。プロモート可能なユーザーの一覧は GET accounts/:account_id/promotable_users で取得します。 Similar to Followers Of: 特定のユーザーのフォロワーと同じ興味関心を持つ人々をターゲティングします。最大で100件の Users を指定できます。 ロケーション: ターゲティングするロケーションを最大2,000件まで指定します。一覧は GET targeting_criteria/locations から取得します。特定の国をターゲティングする広告には追加要件があります。詳細は Country Targeting and Display Requirements を参照してください。 キーワード: キーワードターゲティングのオプションは掲載面のタイプごとに異なります。ターゲティングに使用できるキーワードは（ラインアイテムごとに）最大1000件です。オプションは「Keyword Types」のセクションを参照してください。 言語ターゲティング: 特定の言語を理解するユーザーをターゲティングします。 Mobile Network Operator Targeting: 広告主がモバイルキャリアに基づいてユーザーをターゲティングできるようにします。ターゲティングタイプ NETWORK_OPERATOR を使用し、GET targeting_criteria/network_operators から取得します。 New Mobile Device Targeting: デバイス経由で初めて X にアクセスした日付に基づいてユーザーにリーチします。ターゲティングタイプ NETWORK_ACTIVATION_DURATION を使用し、operator_type は「未満」の場合は LT、「以上」の場合は GTE を指定します。 Platforms、Platform Versions、Devices、および Wifi-Only: さまざまな軸でモバイルデバイスのターゲティングを可能にします。Platforms は、広いカテゴリの携帯電話を対象にできる高レベルのターゲティングタイプです。例として iOS や Android があります。Devices では、特定のモバイルデバイスのユーザーをターゲティングできます（例：iPhone 5s、Nexus 4、Samsung Galaxy Note）。Platform versions では、特定のモバイル OS のバージョンのユーザーをポイントリリースまで指定してターゲティングできます（例：iOS 7.1、Android 4.4）。Wifi-Only を使用すると、WiFi ネットワークでデバイスを使用しているユーザーのみをターゲティングできます。これを設定しない場合、キャリア回線および WiFi を使用しているユーザーが対象になります。
  • オーバーラップがない場合、ユーザーはプラットフォームとデバイスを同時にターゲティングできます。たとえば、プラットフォームとして Blackberry、デバイスとして iPad Air を同時にターゲティングできます。
  • ユーザーはデバイスと OS バージョンを同時にターゲティングできます。たとえば、iPad Air と iOS >= 7.0 をターゲティングできます。
  • ユーザーはデバイスよりも広いプラットフォームを同時にターゲティングできません。たとえば、iOS と iPad Air を同時にターゲティングすることはできません。
[Tailored Audiences]/x-ads-api/audiences: 承認済みの広告パートナーを通じてユーザーにリーチし、X上で顧客グループを精緻にターゲティングしてつながることができます。 TV Targeting TV Show Targeting: 特定のTV番組に関与している人々にリーチします。キャンペーンがアクティブな間は、TV_SHOW ターゲティングのtypeで継続的に配信するよう構成できます。利用可能なTV番組を確認するには、GET targeting_criteria/tv_markets と GET targeting_criteria/tv_shows のendpointを使用します。 Tweet Engager Retargeting Tweet engager retargetingは、広告主が、これまでにX上でプロモーションまたはオーガニックのTweetに露出した、もしくはエンゲージしたオーディエンスを、デバイスをまたいでターゲティングできるようにします。このターゲティングにより、広告主はX上で自社コンテンツを閲覧またはエンゲージした人々にフォローアップでき、後続のメッセージやオファーでさらなるエンゲージやコンバージョンが見込まれる層にアプローチできます。ユーザーは露出またはエンゲージメントから数分以内にターゲティング対象となり、エンゲージメントは最大90日間、露出は最大30日間、対象状態が維持されます。 Tweet Engagerのターゲティングtype:
  • ENGAGEMENT_TYPE は、ターゲティング値として IMPRESSION または ENGAGEMENT のいずれかを受け付けます。露出ユーザー（IMPRESSION）またはエンゲージユーザー（ENGAGEMENT）のどちらをターゲティングするかを指定します。
  • CAMPAIGN_ENGAGEMENT は、ターゲティング値としてキャンペーンIDを使用します。ENGAGEMENT_TYPE に応じて、そのキャンペーンにエンゲージした、または露出したユーザーが対象となります。
  • USER_ENGAGEMENT は、プロモーション対象のユーザーIDをターゲティング値として使用し、広告主のオーガニックコンテンツに露出またはエンゲージしたユーザー（ENGAGEMENT_TYPE に依存）を対象とします。これはAdsアカウントに関連付けられたプロモーション対象のユーザーIDである必要があります。
注: ENGAGEMENT_TYPE は、少なくとも1つの有効な CAMPAIGN_ENGAGEMENT または USER_ENGAGEMENT の値と併せて必須です。両方のtweet engagerターゲティングtypeを併用でき、1つのラインアイテムで複数のキャンペーンをターゲティングできます。 Video Viewer Targeting: Video viewer targetingは、Tweet engagerターゲティングを基に拡張され、以前にX上で動画の一部または全部を視聴したオーディエンスをターゲティングできるようにします。広告主はオーガニック動画、プロモーション動画、またはその両方を対象にできます。プロモーション動画は、Video Viewの目的やラインアイテムに限定されません。 Video Viewerのターゲティングtype:
  • VIDEO_VIEW 動画の再生をクリックした、または自動再生で3秒視聴したユーザー向け
  • VIDEO_VIEW_PARTIAL 動画を50%視聴したユーザー向け
  • VIDEO_VIEW_COMPLETE 動画を少なくとも95%視聴したユーザー向け
Tweet engagerターゲティングと同様に、ENGAGEMENT_TYPE を使用する場合は、ラインアイテムのターゲティング条件に次のいずれか、または両方を含める必要があります:
  • CAMPAIGN_ENGAGEMENT は、ターゲティング値としてキャンペーンIDを使用します。このキャンペーンで（ENGAGEMENT_TYPE に基づき）動画を視聴したユーザーが対象となります。
  • USER_ENGAGEMENT は、プロモーション対象のユーザーIDをターゲティング値として使用し、広告主のオーガニックコンテンツで（ENGAGEMENT_TYPE に基づき）動画を視聴したユーザーを対象とします。これはAdsアカウントに関連付けられたプロモーション対象のユーザーIDである必要があります。
Keyword Types 概念的な概要については、keyword targeting のサポートドキュメントをご覧ください。
  • Broad（デフォルト値）: 語順に関係なくすべての単語にマッチします。大文字/小文字、複数形、時制の違いには影響されません。可能な場合は自動的に拡張されます（例: “car repair” は “automobile fix” にもマッチ）。拡張せずにターゲティングするには、キーワードの前に「+」を付けます（例: “+boat +jet”）。「+」を付けないキーワードはBroad Matchがデフォルトになります。
  • Unordered（非推奨）: 語順に関係なくすべての単語にマッチします。大文字/小文字、複数形、時制の違いには影響されません。
  • Phrase: 指定したキーワード文字列に一致し、他のキーワードが含まれていても構いません。
  • Exact: 指定したキーワード文字列にのみ完全一致します。
  • Negative: 他の単語が含まれていても、query内のどこかにこれらすべてのキーワードが含まれる検索とのマッチを回避します。語順は問いません。
  • Negative Phrase: 他の単語が含まれていても、query内のどこかにこの正確なキーワード文字列が含まれる検索とのマッチを回避します。
  • Negative Exact: これらのキーワードに完全一致し、他の単語を含まない検索とのマッチを回避します。  
Emoji targeting 絵文字ターゲティングはキーワードターゲティング経由でサポートされています。絵文字ターゲティングを使用するには、その絵文字を表す Unicode コードポイント（例：「face with tears of joy」絵文字（😂）なら U+1F602、UTF-8 では xF0x9Fx98x82）をキーワードとして指定して作成します。対象となる絵文字は twemoji のリストで確認できます。特定の絵文字をターゲティングすると、そのすべてのバリエーションが対象になります。 必須/任意の別や各値の詳細の一覧については、PUT accounts/:account_id/targeting_criteria を参照してください。

​
ターゲティング条件の組み合わせ

キャンペーンのワークフロー更新 地域、性別、言語、デバイス/プラットフォームの条件で広くターゲティングするキャンペーンを作成します。広告主は、その幅広いターゲティングに加えて、追加のターゲティング条件（例: 興味関心、キーワード、フォロワー、テーラードオーディエンス、TV）を組み合わせることができます。ラインアイテムにターゲティング条件が指定されていない場合、そのラインアイテムは世界中のすべてのユーザーを対象とします。
「Primary」タイプその他のタイプ
フォロワー位置情報
テーラードオーディエンス性別
興味関心言語
キーワードデバイスとプラットフォーム
TV年齢
ターゲティング条件は、広告グループに対して次のように組み合わされます:
  • 「Primary」ターゲティングタイプは**∪**（論理和）で結合されます。
  • その他のターゲティングタイプはANDで結合されます。
  • 同一タイプ内はORで結合されます。
いくつかの例 概要: [(フォロワー) ∪ (テーラードオーディエンス) ∪ (興味関心) ∪ (キーワード)] AND (位置情報) AND (性別) AND (言語) AND (デバイスとプラットフォーム) 地域ターゲティングの例: キャンペーンの広告グループで次のターゲティングを行うとします:
  • 米国、イングランド、カナダにいるXのユーザー（位置情報）
  • 女性（性別）
  • テーラードオーディエンスのリストに基づく（「Primary」）
  • キーワード（「Primary」）
ターゲティング条件は次のとおりです: [US OR GB OR CA] AND [Female] AND [Tailored Audiences ∪ Keyword]

​
追加例

  • Gender と Geo を選択し、Primary は未選択: (Male) AND (US OR GB)
  • Gender、Geo、Interest を選択: (Female) AND (CA) AND (Computers OR Technology OR Startups)
  • Gender、Geo、Interest、Tailored Audiences、Keywords を選択: (Male) AND (GB) AND (Cars ∪ Tailored Audiences for CRM ∪ autocross)

​
予算ペーシング

広告主は、プロモーションされた Tweet およびアカウントキャンペーンで、1日の予算の消化スピードをこれまで以上に細かく管理できるようになりました。標準配信を有効（デフォルト）にすると、1日を通して均等な消化ペースが維持されます。 標準配信をオフにすると、1日の予算が尽きるまで、可能な限り速やかにインプレッションを配信し、エンゲージメントを獲得します。ターゲティングや競合状況によっては、日中の早い時間に上限に達する場合があります。これは加速配信と呼ばれます。 はじめに 標準配信はすべてのキャンペーンでデフォルトのオプションのため、オフにしない限り操作は不要です。キャンペーンの1日予算をできるだけ早く使い切りたい場合は、standard_delivery パラメータを false に設定して加速配信に切り替えてください（GET accounts/:account_id/campaigns を参照）。 注意事項
  • 「Day」は X の広告主アカウントのタイムゾーン（例: America/Los_Angeles）に準拠します。
  • 初期の結果では、標準配信により1日を通じた配信の一貫性が高まり、広告主の eCPE/CPF が改善されることが示唆されています。
予算とペーシングの詳細については、Bidding and Auctions FAQ を参照してください。

​
目標入札

キャンペーン管理

​
入札戦略

キャンペーン作成のワークフローを簡素化し、複数パラメータの組み合わせによる混乱を軽減するため、「入札戦略」という概念を導入しました。 従来（レガシーとしてマーク）のパラメータ組み合わせは、同等のgoalパラメータを設定することで再現できます。詳細はアナウンスのこちらをご参照ください。 例:
キャンペーンの目的レガシーX Ads API v10+
App Installsbid_type = AUTO

bid_unit = APP_INSTALLS

charge_by = APP_CLICKS		goal = APP_INSTALLS

bid_strategy = AUTO
Website Clicksbid_type = TARGET（注: 一部のキャンペーン目的では bid_unit は不要でした）bid_strategy = TARGET

​
ターゲット入札

ターゲット入札を使うと、支払いを希望する目標コストを指定でき、X Ads プラットフォームがパフォーマンス最大化のためにキャンペーンを最適化しつつ、その目標コスト付近またはそれ以下に収まるよう調整します。 この機能により、コストを管理しながら、リンクのクリック、リード、フォローなどの望ましいアクションを起こす可能性が高いユーザーに的確にリーチできます。キャンペーンの設定や最適化（入札オプションを含む）において、より柔軟な選択肢を求める広告主にとって強力な機能です。 互換性のあるキャンペーン目標のラインアイテムに対して、支払い希望の目標コストを指定できる新しい入札額の価格メカニズムを導入しました。広告プラットフォームは、指定した目標の±20%以内に平均コストを抑えるよう努めながら、より多くの成果を生み出すために動的に代理入札します。ラインアイテムの bid_strategy 設定に TARGET を指定すると、以下のような該当するキャンペーン目標でターゲット入札を有効化できます。
  • WEBSITE_CLICKS
  • WEBSITE_CONVERSIONS 
  • APP_INSTALLS 
  • APP_ENGAGEMENTS
  • REACH

​
国別のターゲティングと表示要件

キャンペーン管理 国ごとのターゲティングおよび表示要件は本ページに記載されています。これらの要件は、すべてのパートナーが遵守する必要があります。

​
ロシア

X’s Ads Policies では、ロシア語以外の言語によるロシア向け広告を禁止しています。ユーザーが配信対象としてロシアを明示的に指定した場合は、次の警告メッセージを表示する必要があります： ロシア向けの広告はロシア語で作成する必要があります。

​
パートナー管理の資金手段

オンボーディングフローでは、X アカウントに紐づく ads.x.com アカウントを設定します。このアカウントはパートナーが X Ads API を通じて管理でき、広告費はパートナーに請求されます。  

​
パートナーの初期セットアップ

新規の PMFI Ads API パートナーの初期セットアップは、必要情報の受け渡し完了から最大3週間かかる場合があります。プロセス開始のため、X の技術連絡先および当該パートナーとの統合を担当する X の窓口に、次の情報を共有してください。
  • パートナーは自社の PGP/GPG 公開鍵を共有する必要があります。 Ads API パートナーと X の間で共有シークレットキーを交換します。これはオンボーディングフロー中の data 検証に使用されます。
  • Ads API アクセスに使用する X App の app_id または consumer_secret 。 developer.x.com 上で X アカウントにログインしている場合は、app dashboard から既存の X App を表示・編集できます。新たに X App を作成する必要がある場合は、承認済みのデベロッパーアカウントが必要です。X では、本番+sandbox 用に1つの App と、任意で sandbox のみの App を1つ許可しています。X App は、企業がパートナーとして管理する X ハンドル上で作成する必要があります。  

​
広告主オンボーディングフロー

広告主のオンボーディングフローは、ウェブブラウザ上で次の手順で実行されます。
  1. ユーザーはパートナーのウェブサイトでオンボーディングフローを開始し、オンボードしたいハンドルを入力します。
  2. パートナーは署名付きペイロードを添えて、ユーザーを ads.x.com 上のURLへリダイレクトします。このペイロードには、パートナーの API の app_id、オンボード対象の X ハンドルに対応する X の user_id、コールバックURL、ならびに下記で説明するその他の fields が含まれます。
  3. ユーザーは標準の x.com のログインページを使用して ads.x.com にサインインするよう求められます。
  4. ユーザーがログインすると、オンボーディングプロセスが開始されます。このステップには、広告審査、アカウント検証、その他の確認が含まれます。
  5. すべてのオンボーディング作業が完了すると、ユーザーは X Ads API パートナーが提供したコールバックURLに、成功または失敗を示すペイロードとともにリダイレクトされます。これには 3-legged 認可プロセスが含まれます。  

​
オンボーディングリダイレクトのペイロード

リダイレクト先のURL: https://ads.x.com/link_managed_account リダイレクトURLは次のパラメータとともに呼び出されます:
NameTypeDescription
callback_urlURLエンコードされた文字列結果に関わらず、アカウントリンク処理が完了後、このURLにユーザーがリダイレクトされます。プロトコルの詳細は「パートナーリダイレクトURL」セクションを参照してください
client_app_idinteger管理パートナーを識別するための X API クライアント App の id
promotable_user_idinteger管理パートナーがプロモーションを管理する対象の @handle の X の user_id。ads.x.com にログインしてリンク処理を完了するユーザーと同一であることを確認するために使用されます
fi_descriptionURLエンコードされた文字列（最大255文字）資金管理（Funding Instrument）の名称。APIで Funding Instrument を取得した際、description フィールドに表示されます。funding_instrument の description が指定された場合、既存の funding_instrument は一時停止され、新しい管理パートナー用の Funding Instrument が設定されます（同名のものが既に存在する場合は変更は行われません）。
timezone文字列（Area/Location 形式）日次予算の適用日および課金の集計に使用されるタイムゾーン
currencyISO 4217 通貨コード入札の入力および課金請求に使用される通貨
countryISO 3166-1 alpha 2 国コードアカウントの請求先の国
signature下記の説明のとおり、URLエンコードおよび base64 エンコードされたバイナリコード共有シークレットと他のパラメータを組み合わせ、呼び出しの真正性およびパラメータの有効性を検証するための署名

​
コールバックURLのペイロード

基本のリダイレクトURLは、アカウントリンクリクエストの callback_url パラメータで指定します（上記参照）。ads.x.com によって追加されるパラメータは次のとおりです。
NameTypeDescription
statusstringOK アカウントが作成された、または既存の適格なアカウントが見つかった。

ACCOUNT_INELIGIBLE パートナー固有の要件を満たしていない場合 USER_MISMATCH ads.x.com にサインインした際に使用した X アカウントが、アカウントリンクリクエストの promotable_user_id と異なる場合 INCOMPLETE_SERVING_BILLING_INFO タイムゾーン、通貨、または国が指定されていない場合 INVALID_COUNTRY 無効な国が指定された場合 INVALID_CURRENCY 無効な通貨が指定された場合 INVALID_TIMEZONE 無効なタイムゾーンが指定された場合
account_idURL エンコード済み文字列連携されたアカウントの X 広告アカウントの id
funding_instrument_idURL エンコード済み文字列パートナー管理の有効なファンディングインストルメントの ID
signatureURL エンコード済み、base64 エンコード済みのバイナリコード（下記参照）共有シークレットと他のパラメータを組み合わせて呼び出しの正当性およびパラメータの有効性を検証する、Base64 エンコードの HMAC-SHA1 署名。コールバックURLがアカウントリンク処理の対象となった X の user_id に対してのみ有効となるよう、リクエストへ署名する際は共有シークレットに（& を用いて）X の user_id を付加します。
コールバックURLがアカウントリンク処理の対象となった X の user_id に対してのみ有効となるよう、リクエストへ署名する際は共有シークレットに（& を用いて）X の user_id を付加します。  

​
リクエストおよびコールバックURLへの署名

/link_managed_account へのリクエストとコールバックURLが有効であることを担保するため、リクエストは送信元で署名し、受信者が処理を行う前に受信者側で検証する必要があります。X と管理パートナー間で共有されるシークレットでリクエストに署名することで、各当事者は認可された相手から送信されたリクエストのみを受け入れることができます。 署名生成アルゴリズムは OAuth で使用されるものと類似しています。 次の手順で署名ベース文字列を作成します:
  • HTTP メソッドを大文字に変換し、この値をベース文字列とします。
  • ベース文字列に ‘&’ 文字を追加します。
  • URL（パラメータなし）をパーセントエンコードし、ベース文字列に追加します。
  • ベース文字列に ‘&’ 文字を追加します。
  • 次の手順で構築される、パーセントエンコード済みの query 文字列を追加します:
  • 署名対象となるすべてのキーと値をパーセントエンコードします。
  • パラメータ一覧をキーのアルファベット順にソートします。
  • 各キー/値ペア（パートナーのリダイレクトURL用の primary_promotable_user_id を含む）について:
  • キーをパーセントエンコードし、query 文字列に追加します。
  • ‘=’ 文字をベース文字列に追加します。
  • 値をパーセントエンコードし、query 文字列に追加します。
  • パーセントエンコードされた key=value のペアを ‘&’ 文字で区切ります。
  • 事前に交換した共有シークレットをキー、ベース文字列を値として HMAC-SHA1 アルゴリズムを用い、署名を生成します。
  • 前手順の出力を Base64 エンコードし、末尾の改行文字を削除してから、生成された署名をパーセントエンコードし、signature パラメータとして URL に追加します  

​
署名の例

リンクアカウントリクエストへの署名 GET リクエストを想定した署名対象の URL: https://ads.x.com/link_managed_account?callback_url=https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&client_app_id=12345&fi_description=some%20name&promotable_user_id=1 この URL には次のパラメータがあります: callback_url = https://managingpartner.com/link_account_callback client_app_id = 12345 fi_description = some name promotable_user_id = 1 HTTP メソッドとパラメータなしの URL から成るベース文字列は、手順 a - d の結果、次のようになります: GET https://ads.x.com/link_managed_account 手順 e のサブステップで生成される query 文字列は次のとおりです: callback_url=https://managingpartner.com/link_account_callback&client_app_id=12345&fi_description=some name&promotable_user_id=1 キーと値のペアはキー名でソートされている点に注意してください。 パーセントエンコードされた query 文字列は次のとおりです: callback_url%3Dhttps%253A%252F%252Fmanagingpartner.com%252Flink_account_callback%26client_app_id%3D12345%26fi_description%3Dsome%2520name%26promotable_user_id%3D1 手順 a - d と e を結合した完全なベース文字列は次のとおりです: GET https://ads.x.com/link_managed_account&callback_url%3Dhttps%253A%252F%252Fmanagingpartner.com%252Flink_account_callback%26client_app_id%3D12345%26fi_description%3Dsome%2520name%26promotable_user_id%3D1 hmac-sha1 アルゴリズムを使用し、キーとして「secret」という語でこれに署名します。結果は Base64 エンコードされ、末尾の「\n」を除いて示されます（手順 2 および 3）: KBxQMMSpKRrtg9aw3qxK4fTXvUc= この署名は、signature パラメータ（手順 4）としてパーセントエンコードしたうえで元の URL の末尾に追加します: https://ads.x.com/link_managed_account?callback_url=https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&client_app_id=12345&fi_description=some%20name&promotable_user_id=1&signature=KBxQMMSpKRrtg9aw3qxK4fTXvUc%3D パートナーのリダイレクト URL（アカウントリンクリクエストのコールバック）への署名 GET リクエストを想定した署名対象の URL: https://managingpartner.com/link_account_callback?status=OK&account_id=ABC&funding_instrument_id=DEF この URL には次のパラメータがあります: account_id = ABC, funding_instrument_id = DEF, status = OK HTTP メソッドとパラメータなしの URL から成るベース文字列は、手順 a - d の結果、次のようになります: GET https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&“ 手順 e のサブステップで生成される query 文字列は次のとおりです: account_id=ABC&funding_instrument_id=DEF&status=OK パーセントエンコードされた query 文字列は次のとおりです: account_id%3DABC%26funding_instrument_id%3DDEF%26status%3DOK 手順 a - d と e を結合した完全なベース文字列は次のとおりです: GET https%3A%2F%2Fmanagingpartner.com%2Flink_account_callback&account_id%3DABC%26funding_instrument_id%3DDEF%26status%3DOK hmac-sha1 アルゴリズムを使用し、キーとして「secret」と、元のリンクリクエストが行われた対象の X ユーザー id である 1（上記の promotable_user_id = 1）を組み合わせた「secret&1」でこれに署名します。 結果は Base64 エンコードされ、末尾の「\n」を除いて示されます（手順 2 および 3）: jDSHDkHJIFXpPLVxtA3a9d4bPjM= この署名は、その後パーセントエンコードしたうえで、署名パラメータ（ステップ4）として元のURLの末尾に追加されます： https://managingpartner.com/link_account_callback?&status=OK&account_id=ABC&funding_instrument_id=DEF&signature=jDSHDkHJIFXpPLVxtA3a9d4bPjM%3D

​
共有キーの使用／更新

署名アルゴリズムは、複数のキーで繰り返し使用できる必要があります。これにより、複数の共有キーを併用でき、共有キーを定期的にローテーション可能になります。  

​
partner_managed_funding_instrument の作成

fi_description パラメータが指定され、かつアカウント内に同名の既存の partner_managed_funding_instrument が存在しない場合は、新しい partner_managed_funding_instrument が作成され、既存のすべての partner_managed_funding_instrument は一時停止されます。 同名の partner_managed_funding_instrument が存在する場合は、新規作成は行われません。  

​
オンボーディングフローの再実行 / トークンの更新

API access token を紛失した場合は、オンボーディングフローを再実行できます。オンボーディングフローの実装では、ユーザーがログインしている必要があります。ユーザーが promotable_user_id と一致し、関連付けられた広告アカウントが見つかり、問題がなければ、ユーザーは callback url にリダイレクトされ、パートナーは OAuth フローを開始してaccess tokenを取得できます。  

​
リダイレクト不可のエラーフロー

アカウントリンク用の URL が無効なパラメータで呼び出された場合、OAuth フローで無効または期限切れのパラメータが指定されたときに表示されるページと同様のページがユーザーに表示されます。  

​
PMFI の継続的な更新

広告主のオンボーディングが完了すると、資金手段は、それを管理するパートナーのみが PUT accounts/:account_id/funding_instruments/:funding_instrument_id endpoint を使用して管理できます。

​
掲載面

X 広告は複数の場所に表示できます。これは line item の placements パラメータで設定します。指定可能な値は次のとおりです。
  • ALL_ON_TWITTER
  • PUBLISHER_NETWORK
  • TWITTER_PROFILE
  • TWITTER_SEARCH
  • TWITTER_TIMELINE
  • SPOTLIGHT
  • TREND
line item の product_type と objective によって、使用できる掲載面が決まります。GET line_items/placements endpoint を使用すると、各 product type に対して有効な掲載オプションを取得できます。 また、以下の表は有効な掲載面と objective の組み合わせを示します。
ObjectiveALL_ON_TWITTERTWITTER_PROFILETWITTER_SEARCHTWITTER_TIMELINE
APP_ENGAGEMENTS✔✔✔✔
APP_INSTALLS✔✔✔✔
REACH✔✔✔✔
FOLLOWERS✔✔✔✔
ENGAGEMENTS✔✔✔✔
VIDEO_VIEWS✔✔✔✔
PREROLL_VIEWS✔✔✔✔
WEBSITE_CLICKS✔✔✔✔
Note: TWITTER_PROFILE のみを掲載面として指定することはできません。 Note: TWITTER_SEARCH を利用するには keyword targeting が必要です。 Note: REACH objective には TWITTER_TIMELINE の掲載面を含める必要があります。ALL_ON_TWITTER、TWITTER_TIMELINE を含む任意の掲載面の組み合わせ、または TWITTER_TIMELINE 単独のいずれかを設定できます。

​
広告グループに関するFAQ

このドキュメントは、X の X Ads API における広告グループに関するよくある質問をまとめたものです。

​
広告グループとは何ですか？

広告グループは、X Ads API では line item と呼ばれ、キャンペーンの下位に位置し、特定のXユーザーの集合に対するターゲティングと入札に用いられます。広告主は、Tweet やメディア（例：In-stream 広告として配信する動画）を line item に関連付けることで、プロモーションを行います。

​
広告グループはどのように作成しますか？

広告グループは、同一のキャンペーンIDに対して POST accounts/:account_id/line_items を複数回呼び出し、各ラインアイテムに関連付けられた（場合によってはまったく異なる）ターゲティングや Tweet を維持することで作成します。1つのキャンペーンあたりのラインアイテム数は100件に制限され、1つの広告アカウントあたりの有効なキャンペーン数は200件に制限されています。すべてのキャンペーンを合算した場合、1つの広告アカウントあたりの有効なラインアイテム数は8,000件が上限です。

​
なぜ Ad Groups をサポートする必要があるのですか？

Ad Groups は、広告主がキャンペーンを整理・最適化・管理しやすくするための機能です。 Ad Groups の利点は、入札、予算、クリエイティブ、ターゲティングにわたる異なる戦略を比較・制御できる点にあります。複数の Promoted Tweets を単一のラインアイテムに関連付けると、オークションはそのグループ内で最適な Tweet を選び、その後、すべてのラインアイテムを対象にそのキャンペーンで最適な Tweet を選択します。単一の Tweet を持つ Ad Groups が複数ある場合は、各 Ad Group から予想されるパフォーマンスが高い Tweet が実質的に選ばれることになります。 Ad Groups を使うことで、広告主はターゲティングと入札をはるかに多くの組み合わせに分解でき、全般的にターゲティングを論理的なグループに整理できます。 特に X Ads API のツールでは、Ad Groups を前提としたきめ細かな最適化ルールを中心に設計でき、ラインアイテムとクリエイティブの組み合わせが大規模になる状況でも、手動編集では難しい最適化を実現できます。

​
広告グループのキャンペーンにおいて、ラインアイテムの予算はキャンペーン予算とどのような関係にありますか？

ラインアイテムの total_budget_amount_local_micro は、その親キャンペーンの総予算を超えることはできません。同様に、ラインアイテムの bid_amount_local_micro は、親キャンペーンの daily_budget_amount_local_micro または total_budget_amount_local_micro を超えてはなりません。これらの値を不適切に設定すると、キャンペーン全体が一時停止され、配信不可の状態になる可能性があります。 なお、キャンペーンの総予算が子のラインアイテムの予算合計を下回る場合もあります。ラインアイテム間の予算配分は、ターゲティング（ラインアイテム）の日々のパフォーマンスが X のリアルタイム性により日ごとに大きく変動し得るため、効果的な最適化と調整を行う目的で、X Ads API ツール側に一部委ねられています。

​
Ad Groupは単一のラインアイテムよりも成果が出ますか？

キャンペーンの成果は多くの要因に左右されますが、最終的にはTweetが決定的な要素になります。ラインアイテムは、特定のTweetがユーザーへの配信対象として考慮されるかどうかを左右する要因の一つとして扱われます。 同一のユーザー群をターゲティングするラインアイテムは、ユーザーが重複していると見なされます。ラインアイテム間のターゲティング重複を抑え、最も成果の高いユーザー群を明確に特定できるようにすることが推奨されるベストプラクティスです。

​
ガイド

​
Video Views Preroll Objective

以下のガイドでは、X Ads API で PREROLL_VIEWS キャンペーンを設定するための手順を説明します。一般的に、これらのキャンペーンは「Curated Categories」と「Content Categories」（Ads UI では「Standard Categories」と表記）という2種類に区分されます。  

​
必要なendpoint

​
手順

​
動画をアップロードする

動画のアップロードは次の2つの手順で行います。

​
動画メディアをアップロードする

まず、Chunked media upload endpoint を使用して、処理のために動画を X にアップロードします。最初の INIT では、この endpoint を使い media_category=amplify_video を必ず指定してください。動画はチャンク単位でアップロードします。STATUS が state として succeeded を返したら、次の手順に進めます。チャンク方式の endpoint を用いたメディアのアップロードの詳細は、Promoted Video Overview を参照してください。

​
広告アカウントに動画を追加する

STATUS コマンドで返される状態が succeeded になったら、その endpoint から返された media_key を使用して、POST accounts/:account_id/media_library endpoint を使って広告主のメディアライブラリに動画を追加します。 
POST https://ads-api.x.com/8/55w3kv/media\_library?media\_key=3_931236738554519552

{
 "request": {
   "params": {
     "account_id": "55w3kv",
     "media\_key": "3\_931236738554519552"
   }
 },
 "data": {
   "tweeted": false,
   "name": null,
   "file_name": null,
   "media\_url": "https://video.twimg.com/amplify\_video/1059840836186165250/vid/568x320/Gr2l1fB1X7xotKwC.mp4?tag=8",
   "media\_category": "AMPLIFY\_VIDEO",
   "media\_key": "3\_931236738554519552",
   "created_at": "2017-11-16T19:05:14Z",
   "media\_status": "TRANSCODE\_COMPLETED",
   "media_id": 931236738554519552,
   "media_type": "VIDEO",
   "updated_at": "2017-11-16T19:05:23Z",
   "deleted": false
 }
}

​
キャンペーンの設定

​
キャンペーンの作成

キャンペーンとラインアイテム/広告グループを作成します。ラインアイテムは、objective を VIDEO_VIEWS_PREROLL、product_type を MEDIA に設定して作成してください。さらに、categories パラメータも適切な広告主の業種カテゴリに設定する必要があります。 
POST https://ads-api.x.com/8/accounts/55w3kv/campaigns?name=test-curated-categories-api&funding\_instrument\_id=103hp9&start\_time=2021-02-10&entity\_status=PAUSED&daily\_budget\_amount\_local\_micro=55000000

{
  "request": {
    "params": {
      "name": "test-curated-categories-api",
      "start_time": "2021-02-10T00:00:00Z",
      "daily\_budget\_amount\_local\_micro": 55000000,
      "funding\_instrument\_id": "103hp9",
      "entity_status": "PAUSED",
      "account_id": "55w3kv"
    }
  },
  "data": {
    "name": "test-curated-categories-api",
    "start_time": "2021-02-10T00:00:00Z",
    "reasons\_not\_servable": \[
      "EXPIRED",
      "PAUSED\_BY\_ADVERTISER",
      "FUNDING_PROBLEM"
    \],
    "servable": false,
    "purchase\_order\_number": null,
    "effective_status": "PAUSED",
    "daily\_budget\_amount\_local\_micro": 55000000,
    "end_time": null,
    "funding\_instrument\_id": "103hp9",
    "duration\_in\_days": null,
    "standard_delivery": true,
    "total\_budget\_amount\_local\_micro": null,
    "id": "f2rp3",
    "entity_status": "PAUSED",
    "frequency_cap": null,
    "currency": "USD",
    "created_at": "2021-02-08T23:55:38Z",
    "updated_at": "2021-02-08T23:55:38Z",
    "deleted": false
  }
}

​
Line Item の作成

Line item には、GET content_categories endpoint で取得した適切な IAB カテゴリ一式を、categories パラメータに設定する必要があります。これらのコンテンツカテゴリは、それぞれ 1 つ以上の IAB カテゴリに対応します。 これらの値を使用するには、パートナーは適切なコンテンツカテゴリを選択し、レスポンスで返される iab_categories の全セットをそのまま使用して、line items endpoint の categories パラメータを設定する必要があります。iab_categories を部分的に適用した場合でも、そのグループ全体が line item に設定されます。例えば、 
GET https://ads-api.x.com/8/advertiser\_business\_categories

{
  "request": {
    "params": {}
  },
  "next_cursor": null,
  "data": \[
    {
      "id": "1jl",
      "name": "日用消費財",
      "iab_categories": \[
        "IAB9-26",
        "IAB9-18",
        "IAB9-29",
        "IAB9-1",
        "IAB9-8",
        "IAB9-22",
        "IAB6",
        "IAB9-5",
        "IAB9-12",
        "IAB9-11",
        "IAB9-23",
        "IAB9-14",
        "IAB4",
        "IAB9-25",
        "IAB9-17",
        "IAB23",
        "IAB9-24",
        "IAB9-13",
        "IAB16",
        "IAB9-4",
        "IAB9-9",
        "IAB9-20",
        "IAB22",
        "IAB9-28",
        "IAB9-27",
        "IAB9-16",
        "IAB9-31",
        "IAB9-3",
        "IAB9-19",
        "IAB10",
        "IAB9-2",
        "IAB9-6",
        "IAB9-21",
        "IAB9-10",
        "IAB9-15"
      \]
    },
    {
      "id": "1jm",
      "name": "ヘルスケア・製薬",
      "iab_categories": \[
        "IAB7"
      \]
    },
    {
      "id": "1jn",
      "name": "アルコール",
      "iab_categories": \[
        "IAB8-5",
        "IAB8-18"
      \]
    },
    {
      "id": "1jo",
      "name": "外食",
      "iab_categories": \[
        "IAB8-10",
        "IAB8-8",
        "IAB8-7",
        "IAB8-15",
        "IAB8-3",
        "IAB8-4",
        "IAB8-1",
        "IAB8-16",
        "IAB8-12",
        "IAB8-13",
        "IAB8-17",
        "IAB8-11",
        "IAB8-6",
        "IAB8-9",
        "IAB8-2",
        "IAB8-14"
      \]
    },
    {
      "id": "1jp",
      "name": "金融サービス",
      "iab_categories": \[
        "IAB3",
        "IAB13",
        "IAB21"
      \]
    },
    {
      "id": "1jq",
      "name": "小売",
      "iab_categories": \[
        "IAB18"
      \]
    },
    {
      "id": "1jr",
      "name": "旅行",
      "iab_categories": \[
        "IAB20"
      \]
    },
    {
      "id": "1js",
      "name": "ゲーム",
      "iab_categories": \[
        "IAB9-30"
      \]
    },
    {
      "id": "1jt",
      "name": "テクノロジー",
      "iab_categories": \[
        "IAB19-22",
        "IAB19-13",
        "IAB19-4",
        "IAB19-33",
        "IAB19-26",
        "IAB19-3",
        "IAB19-16",
        "IAB19-9",
        "IAB19-32",
        "IAB19-25",
        "IAB19-30",
        "IAB19-36",
        "IAB19-21",
        "IAB5",
        "IAB19-12",
        "IAB19-28",
        "IAB19-17",
        "IAB19-8",
        "IAB19-7",
        "IAB19-24",
        "IAB15",
        "IAB19-11",
        "IAB19-31",
        "IAB19-20",
        "IAB19-15",
        "IAB19-1",
        "IAB19-35",
        "IAB19-29",
        "IAB19-34",
        "IAB19-23",
        "IAB19-2",
        "IAB19-5",
        "IAB19-14",
        "IAB19-27",
        "IAB19-10",
        "IAB19-19"
      \]
    },
    {
      "id": "1ju",
      "name": "通信",
      "iab_categories": \[
        "IAB19-6",
        "IAB19-18"
      \]
    },
    {
      "id": "1jv",
      "name": "自動車",
      "iab_categories": \[
        "IAB2"
      \]
    },
    {
      "id": "1jw",
      "name": "メディア・エンターテインメント",
      "iab_categories": \[
        "IAB14-8",
        "IAB14-4",
        "IAB1-5",
        "IAB14-7",
        "IAB1-7",
        "IAB17",
        "IAB14-3",
        "IAB1-1",
        "IAB12",
        "IAB1-6",
        "IAB25-1",
        "IAB1-2",
        "IAB14-2",
        "IAB14-6",
        "IAB1-3",
        "IAB1-4",
        "IAB14-5"
      \]
    },
    {
      "id": "1jx",
      "name": "政治",
      "iab_categories": \[
        "IAB11-4"
      \]
    },
    {
      "id": "1jy",
      "name": "ギャンブル",
      "iab_categories": \[
        "IAB9-7"
      \]
    },
    {
      "id": "1jz",
      "name": "出会い・婚活",
      "iab_categories": \[
        "IAB14-1"
      \]
    },
    {
      "id": "1k0",
      "name": "非営利団体"
      "iab_categories": \[
        "IAB11-1",
        "IAB11-2",
        "IAB11-3",
        "IAB11-5"
      \]
    }
  \]
}
ここで、categories パラメータを「Science & Education」に設定するには、iab_categories の全セット、つまり "IAB5", "IAB15" をラインアイテムに対して次のように設定する必要があります。 
POST https://ads-api.x.com/8/accounts/55w3kv/line\_items?campaign\_id=f2rp3&bid\_amount\_local\_micro=5500000&name=curated-category-line-item&product\_type=MEDIA&placements=ALL\_ON\_TWITTER&objective=PREROLL_VIEWS&categories=IAB3,IAB13,IAB21

{
  "request": {
    "params": {
      "name": "curated-category-line-item",
      "placements": \[
        "ALL\_ON\_TWITTER"
      \],
      "bid\_amount\_local_micro": 5500000,
      "product_type": "MEDIA",
      "objective": "PREROLL_VIEWS",
      "account_id": "55w3kv",
      "categories": \[
        "IAB3",
        "IAB13",
        "IAB21"
      \],
      "campaign_id": "f2rp3"
    }
  },
  "data": {
    "bid_type": "MAX",
    "advertiser\_user\_id": 312226591,
    "name": "curated-category-line-item",
    "placements": \[
      "ALL\_ON\_TWITTER"
    \],
    "start_time": null,
    "bid\_amount\_local_micro": 5500000,
    "automatically\_select\_bid": false,
    "advertiser_domain": null,
    "target\_cpa\_local_micro": null,
    "raw_categories": \[
      "x",
      "5l",
      "9z"
    \],
    "primary\_web\_event_tag": null,
    "charge\_by": "VIEW\_3S_100PCT",
    "product\_type": "PROMOTED\_TWEETS",
    "end_time": null,
    "duration\_in\_days": null,
    "bid\_unit": "VIEW\_3S_100PCT",
    "total\_budget\_amount\_local\_micro": null,
    "objective": "PREROLL_VIEWS",
    "id": "iqwka",
    "entity_status": "ACTIVE",
    "automatic\_tweet\_promotion": null,
    "optimization": "DEFAULT",
    "frequency_cap": null,
    "android\_app\_store_identifier": null,
    "categories": \[
      "IAB3",
      "IAB13",
      "IAB21"
    \],
    "currency": "USD",
    "created_at": "2021-02-09T00:00:46Z",
    "tracking_tags": \[\],
    "ios\_app\_store_identifier": null,
    "amplify_config": {
      "auto_promote": true,
      "is_open": true
    },
    "updated_at": "2021-02-09T00:00:46Z",
    "campaign_id": "f2rp3",
    "creative_source": "MANUAL"
    "deleted": false
  }
}

​
パブリッシャーの選択

広告主は、以下で詳述する追加情報に基づき、Content Category か Curated Category のいずれかをターゲティングできます。 注: Line item は Curated Category または Content Category のいずれかをターゲットにできますが、両方を同時に指定することはできません。 

​
Curated Categories

Curated Categories は、広告主があらかじめ定義されたパブリッシャーのグループをターゲティングするための機能で、GET curated_categories endpoint から取得できます。これらのカテゴリは国別に用意されているため、カテゴリの country_code に基づいて、line item が適切な国をターゲティングしている必要があります。 これらのカテゴリを使用するには、以下の手順を記載の順序で実行する必要があります。
  1. line item は、Curated Category の country_code に基づき、該当する国をターゲティングしている必要があります
  2. POST line_item_curated_categories endpoint を使用して、line item を特定の curated_category_id に関連付ける必要があります。
注意: line item を curated category に関連付けると、denylist 可能なパブリッシャー数は 5 までに制限されます。特定のパブリッシャーを denylist するために使用される user_id の完全な一覧は、GET publishers endpoint から取得できます。さらに、1 つの line item は同時に 1 つを超える Curated Category をターゲティングすることはできません。 次の例は、curated category id: b0xt（米国でのみ利用可能）を、前の手順で作成した line item に関連付ける方法を示しています。 まず、line item のターゲティング条件を値 96683cc9126741d に設定します 
GET https://ads-api.x.com/8/targeting\_criteria/locations?country\_code=US&location_type=COUNTRIES

{
  "data": \[
    {
      "name": "アメリカ合衆国",
      "country_code": "US",
      "location_type": "COUNTRIES",
      "targeting_value": "96683cc9126741d1",
      "targeting_type": "LOCATION"
    }
  \],
  "request": {
    "params": {
      "location_type": "COUNTRIES",
      "country_code": "US"
    }
  },
  "next_cursor": null
}

POST https://ads-api.x.com/8/batch/accounts/55w3kv/targeting_criteria
\[
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwka",
      "targeting_type": "LOCATION",
      "targeting_value": "96683cc9126741d1",
      "operator_type": "EQ"
    }
  }
\]

{
  "data": \[
    {
      "line\_item\_id": "iqwka",
      "name": "アメリカ合衆国",
      "raw_negated": false,
      "raw\_targeting\_value": "2",
      "id": "rv9hmc",
      "raw\_targeting\_type": "GEO",
      "raw\_operator\_type": "EQUAL_TO",
      "location_type": "COUNTRIES",
      "operator_type": "EQ",
      "created_at": "2021-02-09T00:06:28Z",
      "targeting_value": "96683cc9126741d1",
      "updated_at": "2021-02-09T00:06:28Z",
      "deleted": false,
      "targeting_type": "LOCATION"
    }
  \],
  "request": \[
    {
      "params": {
        "line\_item\_id": "iqwka",
        "account_id": "55w3kv",
        "operator_type": "EQ",
        "targeting_value": "96683cc9126741d1",
        "targeting_type": "LOCATION"
      },
      "operation_type": "Create"
    }
  \]
}

POST https://ads-api.x.com/8/accounts/55w3kv/line\_item\_curated\_categories?line\_item\_id=iqwka&curated\_category_id=9ddrgesiap6o

{
  "request": {
    "params": {
      "curated\_category\_id": "9ddrgesiap6o",
      "line\_item\_id": "iqwka",
      "account_id": "55w3kv"
    }
  },
  "data": {
    "line\_item\_id": "iqwka",
    "curated\_category\_id": "9ddrgesiap6o",
    "id": "xq",
    "created_at": "2021-03-30T17:26:42Z",
    "updated_at": "2021-03-30T17:26:42Z",
    "deleted": false
  }
}

​
コンテンツカテゴリ

コンテンツカテゴリ（Standard Categories とも呼ばれます）は、GET curated_categories endpoint から取得できます。これらのカテゴリは、バッチターゲティング基準の endpoints を使用して、ラインアイテムでターゲティングできます。次の例では、特定のコンテンツカテゴリ id: sr（“News & Current Events” に対応）を選択し、ラインアイテムに適用する方法を示します。
Note: GET curated_categories のレスポンスに含まれる iab_categories のセット全体は、targeting criteria endpoint 経由でターゲティングする必要があります。そうしない場合は、検証エラーになります。 
GET https://ads-api.x.com/8/content_categories
{
      "name": "ニュース・時事",
      "id": "sr",
      "iab_categories": \[
        "IAB12",
        "IAB14"
      \],
      "publishers\_in\_last\_thirty\_days": 124,
      "videos\_monetized\_in\_last\_thirty_days": 5429
    }
}

POST https://ads-api.x.com/8/batch/accounts/55w3kv/targeting_criteria
\[
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwls",
      "targeting\_type": "IAB\_CATEGORY",
      "targeting_value": "IAB12",
      "operator_type": "EQ"
    }
  },
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwls",
      "targeting\_type": "IAB\_CATEGORY",
      "targeting_value": "IAB14",
      "operator_type": "EQ"
    }
  }
\]

{
  "data": \[
    {
      "line\_item\_id": "iqwls",
      "name": "ニュース",
      "raw_negated": false,
      "raw\_targeting\_value": "5h",
      "id": "saib9p",
      "raw\_targeting\_type": "IAB_CATEGORY",
      "raw\_operator\_type": "EQUAL_TO",
      "operator_type": "EQ",
      "created_at": "2021-03-30T17:35:50Z",
      "targeting_value": "IAB12",
      "updated_at": "2021-03-30T17:35:50Z",
      "deleted": false,
      "targeting\_type": "IAB\_CATEGORY"
    },
    {
      "line\_item\_id": "iqwls",
      "name": "社会",
      "raw_negated": false,
      "raw\_targeting\_value": "5y",
      "id": "saib9q",
      "raw\_targeting\_type": "IAB_CATEGORY",
      "raw\_operator\_type": "EQUAL_TO",
      "operator_type": "EQ",
      "created_at": "2021-03-30T17:35:50Z",
      "targeting_value": "IAB14",
      "updated_at": "2021-03-30T17:35:50Z",
      "deleted": false,
      "targeting\_type": "IAB\_CATEGORY"
    }
  \],
  "request": \[
    {
      "params": {
        "line\_item\_id": "iqwls",
        "account_id": "55w3kv",
        "operator_type": "EQ",
        "targeting_value": "IAB12",
        "targeting\_type": "IAB\_CATEGORY"
      },
      "operation_type": "Create"
    },
    {
      "params": {
        "line\_item\_id": "iqwls",
        "account_id": "55w3kv",
        "operator_type": "EQ",
        "targeting_value": "IAB14",
        "targeting\_type": "IAB\_CATEGORY"
      },
      "operation_type": "Create"
    }
  \]
}
アカウントメディア（動画）をラインアイテムに関連付ける
POST accounts/:account_id/media_creatives endpoint を使用して、動画を広告グループに関連付けます。 
POST https://ads-api.x.com/8/accounts/55w3kv/media_creatives
line\_item\_id=4bii5&account\_media\_id=knb

{
 "data":{
   "account\_media\_id":"74g",
   "approval_status":"ACCEPTED",
   "created_at":"2016-02-11T22:23:23Z",
   "deleted":false,
   "id":"qeq",
   "landing_url":null,
   "line\_item\_id":"4bii5",
   "serving_status":"ACTIVE",
   "updated_at":"2016-02-11T22:23:23Z"
 },
 "request":{
   "params":{
     "line\_item\_id":"4bii5",
     "account\_media\_id":"knb"
   }
 }
}

​
CTA とリンク先 URL を設定する

X の他の多くのキャンペーンと異なり、VIDEO_VIEWS_PREROLL の目的では Promoted Tweets や Cards は使用されません。代わりに、動画クリエイティブは広告グループ（line item）に関連付けられ、CTA 情報は preroll_call_to_action エンティティに関連付けられます。POST accounts/:account_id/preroll_call_to_action endpoint を使用すると、ボタンの CTA とリンク先 URL を設定できます。 
POST https://ads-api.x.com/8/accounts/55w3kv/preroll\_call\_to_action
line\_item\_id=4bii5&call\_to\_action=VISIT\_SITE&call\_to\_action\_url=https%3A%2F%2Fx.com%2FAdsAPI

{
 "data":{
   "id":"aaa111",
   "line\_item\_id":"4bii5",
   "call\_to\_action":"WATCH_NOW",
   "call\_to\_action_url":"https://x.com/AdsAPI",
   "created_at":"2016-02-11T22:23:23Z",
   "updated_at":"2016-02-11T22:23:23Z",
   "deleted":false
 },
 "request":{
   "params":{
     "line\_item\_id":"4bii5",
     "call\_to\_action":"VISIT_SITE",
     "call\_to\_action_url":"https://x.com/AdsAPI"
   }
 }
}

​
ターゲティング基準を設定する

プレロール動画広告で使用されるターゲティング基準は、バッチターゲティング基準 endpoint POST batch/accounts/:account_id/targeting_criteria でのみ利用できます。 広告を特定のユーザーの集合と組み合わせないよう除外するには、否定ターゲティングとして CONTENT_PUBLISHER_USER を使用します。除外するハンドルには、X の user_id または publisher_user_id を指定してください。 GET publishers endpoint を使用すると、Content Categories 用に除外する user_id の一覧を取得できます。GET curated_categories のレスポンスで返される publisher_user_id を使って、Curated Categories 用の同様の除外リストを取得できます。 注意: Curated Categories では最大 5 件の publisher_user_id、Content Categories では最大 50 件の user_id を除外できます。 
POST https://ads-api.x.com/8/batch/accounts/55w3kv/targeting_criteria
\[
  {
    "operation_type": "Create",
    "params": {
      "line\_item\_id": "iqwls",
      "targeting\_type": "CONTENT\_PUBLISHER_ID",
      "targeting_value": "1917731",
      "operator_type": "NE"
    }
  }
\]

{
  "data": \[
    {
      "line\_item\_id": "iqwka",
      "name": "realsaltlake",
      "raw_negated": true,
      "raw\_targeting\_value": "aajwo",
      "id": "sajk32",
      "raw\_targeting\_type": "CONTENT_PUBLISHER",
      "raw\_operator\_type": "EQUAL_TO",
      "operator_type": "NE",
      "created_at": "2021-03-30T18:02:32Z",
      "targeting_value": 17288520,
      "updated_at": "2021-03-30T18:02:32Z",
      "deleted": false,
      "targeting\_type": "CONTENT\_PUBLISHER_USER"
    }
  \],
  "request": \[
    {
      "params": {
        "line\_item\_id": "iqwka",
        "account_id": "55w3kv",
        "operator_type": "NE",
        "targeting_value": "17288520",
        "targeting\_type": "CONTENT\_PUBLISHER_USER"
      },
      "operation_type": "Create"
    }
  \]
}

​
キャンペーンの開始

キャンペーンの開始準備ができたら、PUT accounts/:account_id/campaigns/:id を使って一時停止を解除します。 PUT https://ads-api.x.com/8/accounts/55w3kv/campaigns/f2rp3? entity_status=ACTIVE 
{
  "request": {
    "params": {
      "campaign_id": "f2rp3",
      "account_id": "55w3kv"
    }
  },
  "data": {
    "name": "test-curated-categories-api",
    "start_time": "2021-02-10T00:00:00Z",
    "reasons\_not\_servable": \[
    \],
    "servable": false,
    "purchase\_order\_number": null,
    "effective_status": "ACTIVE",
    "daily\_budget\_amount\_local\_micro": 55000000,
    "end_time": null,
    "funding\_instrument\_id": "103hp9",
    "duration\_in\_days": null,
    "standard_delivery": true,
    "total\_budget\_amount\_local\_micro": null,
    "id": "f2rp3",
    "entity_status": "ACTIVE",
    "frequency_cap": null,
    "currency": "USD",
    "created_at": "2021-02-08T23:55:38Z",
    "updated_at": "2021-02-08T23:55:38Z",
    "deleted": false
  }
}

​
アナリティクス

VIDEO_VIEWS_PREROLL キャンペーンのアナリティクスは、当社の stats endpoint で利用できます。

​
タイムラインにおけるキーワードターゲティング

キーワードターゲティングは当社の Promoted Tweets 製品の基盤であり、キャンペーンのリーチを高めます。タイムラインでのキーワードターゲティングにより、プラットフォームはユーザーの直近の Tweet に含まれるキーワードに基づいて X のユーザーをターゲティングできます。たとえば、広告主が無秩序（順不同）のキーワード組み合わせ「plan + trip」をターゲットに設定しており、キャンペーンの配信期間中にあるユーザーが「I’m starting to plan my trip to Cabo, any suggestions?」と Tweet した場合、そのユーザーはほどなく広告主の Promoted Tweet を目にする可能性があります。

​
どのように機能しますか？

要点: API の観点では、この変更はきわめてシンプルです。Timeline の Promoted Tweets でキーワードをターゲティングできるようになりました。ラインアイテムでは targeting_type を unordered_keywords または phrase_keywords に設定するだけです。

​
クイックスタート ガイド

​
API リファレンス

​
アカウント

​
GET accounts

認証ユーザーがアクセスできる広告有効化済みアカウントの一部またはすべての詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts Parameters
NameDescription
account_ids
optional		カンマ区切りの識別子リストを指定して、レスポンスを対象のアカウントIDのみに絞り込みます。

Type: string

Example: 18ce54d4x5t
count
optional		リクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細はPaginationを参照してください。

Type: string

Example: 8x7v00oow
q
optional		name によるリソースの絞り込みに使用する任意の query。

Note: 大文字小文字を区別しない前方一致でマッチします。

Type: string

Min, Max length: 1, 255
sort_by
optional		サポートされる属性で昇順または降順にソートします。詳細はSortingを参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		レスポンスに total_count 属性を含めます。

Note: このパラメータと cursor は同時に使用できません。

Note: total_count を含むリクエストはレートリミットが低く、現在は15分あたり200です。

Type: boolean

Default: false
Possible values: true, false

​
リクエストの例

GET https://ads-api.x.com/12/accounts?account_ids=18ce54d4x5t
応答例 
       {
         "request": {
           "params": {
             "account_ids": [
               "18ce54d4x5t"
             ]
           }
         },
         "next_cursor": null,
         "data": [
           {
             "name": "API McTestface",
             "business_name": null,
             "timezone": "America/Los_Angeles",
             "timezone_switch_at": "2016-07-21T07:00:00Z",
             "id": "18ce54d4x5t",
             "作成日時": "2016-07-21T22:42:09Z",
             "updated_at": "2017-07-06T16:51:04Z",
             "business_id": null,
             "approval_status": "ACCEPTED",
             "deleted": false
           }
         ]
       }

​
GET accounts/:account_id

認証済みユーザーがアクセスできる特定のアカウントを取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須のパラメータです。

指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
with_deleted
optional		削除済みの結果をレスポンスに含めます。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t Example Response 
       {
         "request": {
           "params": {
             "account_id": "18ce54d4x5t"
           }
         },
         "data": {
           "name": "API McTestface",
           "business_name": null,
           "timezone": "America/Los_Angeles",
           "timezone_switch_at": "2016-07-21T07:00:00Z",
           "id": "18ce54d4x5t",
           "created_at": "2016-07-21T22:42:09Z",
           "updated_at": "2017-07-06T16:51:04Z",
           "industry_type": "TRAVEL",
           "business_id": null,
           "approval_status": "ACCEPTED",
           "deleted": false
         }
       }

​
POST accounts

注: SANDBOX 限定 サンドボックス環境で広告アカウントを作成します。 Resource URL https://ads-api-sandbox.x.com/12/accounts Parameters なし Example Request POST https://ads-api-sandbox.x.com/12/accounts Example Response 
       {
         "request": {
           "params": {}
         },
         "next_cursor": null,
         "data": [
           {
             "name": "サンドボックスアカウント",
             "business_name": null,
             "timezone": "America/Los_Angeles",
             "timezone_switch_at": null,
             "id": "gq12fh",
             "created_at": "2016-07-18T23:02:20Z",
             "updated_at": "2016-07-18T23:02:20Z",
             "business_id": null,
             "approval_status": "ACCEPTED",
             "deleted": false
           }
         ]
       }

​
PUT accounts/:account_id

アカウント名および/または業種を更新します。 Resource URL https://ads-api.x.com/12/accounts/:account_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須のパラメータです。
指定されたアカウントは、認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
name
optional		アカウント名。

Type: string

Example: API McTestface
industry_type
optional		アカウントに関連付けられている業種。

Type: string

Possible values: AGENCY, BUSINESS_TO_BUSINESS, ONLINE_SERVICES, EDUCATION, FINANCIAL, HEALTH, GOVERNMENT, MEDIA, MOBILE, RESTAURANT, RETAIL, TECHNOLOGY, TRAVEL, OTHER
Example Request PUT https://ads-api.x.com/12/accounts/18ce54d4x5t?name='API McTestface 2'&industry_type=TECHNOLOGY Example Response 
       {
         "request": {
           "params": {
             "account_id": "18ce54d4x5t"
             "name"": "API McTestface 2",
             "industry_type": "TECHNOLOGY"
           }
         },
         "data": {
           "name": "API McTestface 2",
           "business_name": null,
           "timezone": "America/Los_Angeles",
           "timezone_switch_at": "2016-07-21T07:00:00Z",
           "id": "18ce54d4x5t",
           "作成日時": "2016-07-21T22:42:09Z",
           "updated_at": "2017-07-06T16:51:04Z",
           "industry_type": "TECHNOLOGY",
           "business_id": null,
           "approval_status": "ACCEPTED",
           "deleted": false
         }
       }

​
DELETE accounts/:account_id

注意: SANDBOX 限定 サンドボックス環境で広告アカウントを削除します。 Resource URL https://ads-api-sandbox.x.com/12/accounts/:account_id Parameters
NameDescription
account_id
required		対象アカウントを識別するための ID。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで基本的に必須のパラメータです。

指定したアカウントは、認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
Example Request DELETE https://ads-api-sandbox.x.com/12/accounts/gq12fh Example Response 
       {
         "data": {
           "name": "サンドボックスアカウント",
           "timezone": "America/Los_Angeles",
           "timezone_switch_at": null,
           "id": "gq12fh",
           "created_at": "2016-07-18T23:02:20Z",
           "updated_at": "2017-08-23T18:21:10Z",
           "approval_status": "ACCEPTED",
           "deleted": true
         },
         "request": {
           "params": {
             "account_id": "gq12fh"
           }
         }
       }

​
アカウントのApp

Postman で開く ❯

​
GET account_apps

指定した広告アカウントに関連付けられているすべてのモバイルアプリの詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/account_apps Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須です。指定したアカウントは、認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
count
optional		リクエストごとに取得するレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
sort_by
optional		サポートされる属性で昇順または降順に並べ替えます。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		レスポンス属性 total_count を含めます。

Note: このパラメータと cursor は同時に使用できません。

Note: total_count を含むリクエストはレートリミットが低く、現在は15分あたり200に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_apps Example Response 
       {
         "request": {
           "params": {
             "account_ids": [
               "18ce54d4x5t"
             ]
           }
         },
         "next_cursor": null,
         "data": [
          {
            "app_store_identifier": "com.twitter.android",
            "conversion_tracking_enabled": false,
            "deep_link_pattern": "twitter://",
            "id": "4x",
            "created_at": "2019-06-20T22:36:16Z",
            "updated_at": "2021-10-19T20:05:29Z",
            "os_type": "Android",
            "deleted": false
          }
         ]
       }

​
アカウント履歴

​
GET accounts/:account_id/account_history

リクエストで指定された entity_id に対して行われた変更の概要を取得します。 Note: この endpoint は現在ベータ版で、許可リストへの登録が必要です。 Resource URL https://ads-api.x.com/12/accounts/:account_id/account_history Parameters
NameDescription
account_id
required		対象のアカウントを識別する ID。

Type: string

Example: 18ce54d4x5t
count
optional		1 回のリクエストで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
entity_type
required		取得対象のエンティティ種別。

Type: enum

Example: PROMOTED_TWEET
Possible values: CAMPAIGN, LINE_ITEM, PROMOTED_TWEET, TARGETING_CRITERIA, PROMOTED_ACCOUNT
entity_id
required		データを取得する特定のエンティティ。

Type: string

Example: 8u94t
start_time
required		取得対象の開始時刻。ISO 8601 で指定します。

Note: 分・秒が 0 のちょうどの時刻（1 時間単位）で指定する必要があります。

Type: string

Example: 2017-05-19T07:00:00Z
end_time
required		取得対象の終了時刻。ISO 8601 で指定します。

Note: 分・秒が 0 のちょうどの時刻（1 時間単位）で指定する必要があります。

Type: string

Example: 2017-05-26T07:00:00Z
user_id
optional		応答を特定のユーザーに限定します。

Type: long

Example: 3271358660
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/account_history?entity_type=CAMPAIGN&entity_id=fc3h5&count=1 Example Response 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "entity": "CAMPAIGN",
          "entity_id": "fc3h5",
          "count": 1
        }
      },
      "next_cursor": "1r2407sb4lc",
      "data": [
        {
          "change_by": {
            "user_id": "982978172",
            "platform": "API_OTHER"
          },
          "changes": {},
          "change_time": "2021-04-02T20:55:42Z",
          "entity_id": "fc3h5",
          "entity": "CAMPAIGN",
          "entity_data": {
            "name": "test_campaign",
            "start_time": "2021-04-02T18:59:11Z",
            "purchase_order_number": null,
            "daily_budget_amount_local_micro": 100000000,
            "end_time": null,
            "duration_in_days": null,
            "standard_delivery": true,
            "total_budget_amount_local_micro": 100000000,
            "entity_status": "ACTIVE",
            "frequency_cap": null,
            "created_at": "2021-04-02T20:55:42Z",
            "updated_at": "2021-04-02T20:55:42Z",
            "deleted": false
          },
          "change_type": "CREATE"
        }
      ]
    }

​
広告主の事業カテゴリ

​
GET advertiser_business_categories

パブリッシャーに対して広告主のブランドを説明するため、広告グループ（line_items）向けの有効な広告主ビジネスのcategoriesを取得します。 注: これらのカテゴリは、オブジェクティブがPREROLL_VIEWSのline_itemsにのみ適用され、ターゲティング条件で使用されるcontent_categoriesとは別物です。 各advertiser_business_categoriesはIAB Categoriesの集合を表します。PREROLL_VIEWSオブジェクティブで広告グループを作成する際は、1つまたは2つのadvertiser_business_categoriesを広告グループに設定する必要があります。これは、line item endpointでcategoriesリクエストパラメータの値として、このendpointで取得できる対応するiab_categoriesの集合を指定することで行えます。 詳細はVideo Views Preroll Objective Guideを参照してください。 Resource URL https://ads-api.x.com/12/advertiser_business_categories Parameters リクエストパラメータはありません Example Request GET https://ads-api.x.com/12/advertiser_business_categories Example Response 
{
      "request": {
        "params": {}
      },
      "next_cursor": null,
      "data": [
        {
          "id": "1jl",
          "name": "消費財",
          "iab_categories": [
            "IAB9-26",
            "IAB9-18",
            "IAB9-29",
            "IAB9-1",
            "IAB9-8",
            "IAB9-22",
            "IAB6",
            "IAB9-5",
            "IAB9-12",
            "IAB9-11",
            "IAB9-23",
            "IAB9-14",
            "IAB4",
            "IAB9-25",
            "IAB9-17",
            "IAB23",
            "IAB9-24",
            "IAB9-13",
            "IAB16",
            "IAB9-4",
            "IAB9-9",
            "IAB9-20",
            "IAB22",
            "IAB9-28",
            "IAB9-27",
            "IAB9-16",
            "IAB9-31",
            "IAB9-3",
            "IAB9-19",
            "IAB10",
            "IAB9-2",
            "IAB9-6",
            "IAB9-21",
            "IAB9-10",
            "IAB9-15"
          ]
        },
        {
          "id": "1jm",
          "name": "ヘルスケア・医薬品",
          "iab_categories": [
            "IAB7"
          ]
        },
        {
          "id": "1jn",
          "name": "アルコール",
          "iab_categories": [
            "IAB8-5",
            "IAB8-18"
          ]
        },
        {
          "id": "1jo",
          "name": "飲食",
          "iab_categories": [
            "IAB8-10",
            "IAB8-8",
            "IAB8-7",
            "IAB8-15",
            "IAB8-3",
            "IAB8-4",
            "IAB8-1",
            "IAB8-16",
            "IAB8-12",
            "IAB8-13",
            "IAB8-17",
            "IAB8-11",
            "IAB8-6",
            "IAB8-9",
            "IAB8-2",
            "IAB8-14"
          ]
        },
        {
          "id": "1jp",
          "name": "金融サービス",
          "iab_categories": [
            "IAB3",
            "IAB13",
            "IAB21"
          ]
        },
        {
          "id": "1jq",
          "name": "小売",
          "iab_categories": [
            "IAB18"
          ]
        },
        {
          "id": "1jr",
          "name": "旅行",
          "iab_categories": [
            "IAB20"
          ]
        },
        {
          "id": "1js",
          "name": "ゲーム",
          "iab_categories": [
            "IAB9-30"
          ]
        },
        {
          "id": "1jt",
          "name": "テクノロジー",
          "iab_categories": [
            "IAB19-22",
            "IAB19-13",
            "IAB19-4",
            "IAB19-33",
            "IAB19-26",
            "IAB19-3",
            "IAB19-16",
            "IAB19-9",
            "IAB19-32",
            "IAB19-25",
            "IAB19-30",
            "IAB19-36",
            "IAB19-21",
            "IAB5",
            "IAB19-12",
            "IAB19-28",
            "IAB19-17",
            "IAB19-8",
            "IAB19-7",
            "IAB19-24",
            "IAB15",
            "IAB19-11",
            "IAB19-31",
            "IAB19-20",
            "IAB19-15",
            "IAB19-1",
            "IAB19-35",
            "IAB19-29",
            "IAB19-34",
            "IAB19-23",
            "IAB19-2",
            "IAB19-5",
            "IAB19-14",
            "IAB19-27",
            "IAB19-10",
            "IAB19-19"
          ]
        },
        {
          "id": "1ju",
          "name": "通信",
          "iab_categories": [
            "IAB19-6",
            "IAB19-18"
          ]
        },
        {
          "id": "1jv",
          "name": "自動車",
          "iab_categories": [
            "IAB2"
          ]
        },
        {
          "id": "1jw",
          "name": "メディア・エンターテインメント",
          "iab_categories": [
            "IAB14-8",
            "IAB14-4",
            "IAB1-5",
            "IAB14-7",
            "IAB1-7",
            "IAB17",
            "IAB14-3",
            "IAB1-1",
            "IAB12",
            "IAB1-6",
            "IAB25-1",
            "IAB1-2",
            "IAB14-2",
            "IAB14-6",
            "IAB1-3",
            "IAB1-4",
            "IAB14-5"
          ]
        },
        {
          "id": "1jx",
          "name": "政治",
          "iab_categories": [
            "IAB11-4"
          ]
        },
        {
          "id": "1jy",
          "name": "ギャンブル",
          "iab_categories": [
            "IAB9-7"
          ]
        },
        {
          "id": "1jz",
          "name": "出会い系",
          "iab_categories": [
            "IAB14-1"
          ]
        },
        {
          "id": "1k0",
          "name": "非営利団体",
          "iab_categories": [
            "IAB11-1",
            "IAB11-2",
            "IAB11-3",
            "IAB11-5"
          ]
        }
      ]
    }

​
オーディエンス見積もり

POST accounts/:account_id/audience_estimate

​
キャンペーンの推定オーディエンス規模を算出します。

この endpoint は、ターゲティング条件オブジェクトのパラメータを含む JSON オブジェクトの配列を受け付けます。必須および任意のターゲティング条件パラメータの一覧は、POST accounts/:account_id/targeting_criteria endpoint に記載されています。リクエストは JSON 本文を含む HTTP POST とし、Content-Type: application/json ヘッダーを指定する必要があります。 注: 少なくとも 1 つの主要なターゲティング条件を指定する必要があります。主要なターゲティング条件の一覧は、campaigns targeting page に記載しています。 Resource URL https://ads-api.x.com/12/accounts/:account_id/audience_estimate Parameters
NameDescription
account_id
required		対象とするアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須です。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
targeting_criteria
required		ターゲティング条件オブジェクトのすべてのパラメータを含む JSON オブジェクト。必須/任意のターゲティング条件パラメータの一覧は、POST accounts/:account_id/targeting_criteria endpoint に記載されています。
operator_type
optional		ターゲティング条件間の関係を指定します。たとえば、否定ターゲティングを設定するには operator_type=NE を使用します。

Type: enum

Possible values: EQ, NE

Default: EQ
Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/audience_estimate 
    {
        "targeting_criteria": [
            {
                "targeting_type": "BROAD_KEYWORD",
                "targeting_value": "nba",
                "operator_type": "EQ"
            },
            {
                "targeting_type": "BROAD_KEYWORD",
                "targeting_value": "tech",
                "operator_type": "NE"
            },
            {
                "targeting_type": "LOCATION",
                "targeting_value": "96683cc9126741d1",
                "operator_type": "EQ"
            },
            {
                "targeting_type": "SIMILAR_TO_FOLLOWERS_OF_USER",
                "targeting_value": "14230524"
            },
            {
                "targeting_type": "SIMILAR_TO_FOLLOWERS_OF_USER",
                "targeting_value": "90420314"
            }
        ]
    }
レスポンス例 
    {
      "request": {
        "params": {
          "targeting_criteria": null,
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "audience_size": {
          "min": 38236294,
          "max": 42261167
        }
      }
    }

​
認証ユーザーアクセス

​
GET accounts/:account_id/authenticated_user_access

指定した広告アカウントに関して、現在認証されているユーザー（access_token）の権限を取得します。これらの権限は ads.x.com に表示される内容と一致します。 取り得る値は以下のとおりです：
  • ACCOUNT_ADMIN: キャンペーンの変更および統計の閲覧にフルアクセス。ユーザーの追加・削除や設定変更も可能
  • AD_MANAGER: キャンペーンの変更および統計の閲覧にフルアクセス。ただし、ユーザーの追加・削除や設定変更は不可
  • CREATIVE_MANAGER: クリエイティブの変更とプレビューの閲覧は可能。ただし、キャンペーンの作成・変更は不可
  • CAMPAIGN_ANALYST: キャンペーンおよび統計の閲覧は可能。ただし、キャンペーンの作成・変更は不可
  • ANALYST（ads.x.com 上では「Organic Analyst」）: オーガニック分析とオーディエンスインサイトの閲覧は可能。ただし、キャンペーンの作成・変更・閲覧は不可
  • PARTNER_AUDIENCE_MANAGER: データパートナーのオーディエンスの閲覧・変更に対する API 限定のアクセス。ただし、キャンペーン、クリエイティブ、その他のオーディエンス種別へのアクセスは不可。
さらに、TWEET_COMPOSER 権限は、認証済みユーザーが広告主に代わって nullcast（「Promoted-only」）の Tweet を作成できることを示します。これは ACCOUNT_ADMIN、AD_MANAGER、または CREATIVE_MANAGER アクセスを持つユーザーにのみ付与されます。 Resource URL https://ads-api.x.com/12/accounts/:account_id/authenticated_user_access Parameters なし Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/authenticated_user_access Example Response 
    {
      "data": {
        "user_id": "2417045708",
        "permissions": [
          "ACCOUNT_ADMIN",
          "TWEET_COMPOSER"
        ]
      },
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
入札ルール

​
GET bidding_rules

一部またはすべての通貨に対する入札ルールを取得します。レスポンスには、CPE（cost-per-engagement、エンゲージメントあたりのコスト）の最小額および最大額の入札が示されます。 これらの入札ルールはめったに変更されませんが、少なくとも月に一度は、これらのendpointから最新情報を取得するようシステムを更新することを推奨します。 Resource URL https://ads-api.x.com/12/bidding_rules Parameters
NameDescription
currency
optional		結果をフィルタリングするための通貨の種類を指定します。ISO-4217 で識別される、“USD” や “EUR” といった3文字の文字列です。すべての入札ルールを取得するにはこのパラメータを省略してください。

Type: string

Example: USD
Example Request GET https://ads-api.x.com/12/bidding_rules?currency=USD Example Response 
    {
      "request": {
        "params": {
          "currency": "USD"
        }
      },
      "data_type": "bidding_rule",
      "data": [
        {
          "currency": "USD",
          "minimum_cpe_bid_local_micro": 10000,
          "maximum_cpe_bid_local_micro": 1000000000,
          "minimum_denomination": 10000
        }
      ],
      "total_count": 1
    }

​
キャンペーン

​
GET accounts/:account_id/campaigns

現在のアカウントに関連付けられている一部またはすべてのキャンペーンの詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/campaigns Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
campaign_ids
optional		識別子のカンマ区切りリストを指定して、レスポンスを目的のキャンペーンのみに絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 8wku2
count
optional		リクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
funding_instrument_ids
optional		識別子のカンマ区切りリストを指定して、特定のファンディングインストゥルメント配下のキャンペーンのみにレスポンスを絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: lygyi
q
optional		name でリソースを絞り込むための任意の query。

Type: string

Min, Max length: 1, 255
sort_by
optional		サポートされる属性で昇順または降順に並べ替えます。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		リクエストに削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_draft
optional		リクエストに下書きキャンペーンの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		total_count レスポンス属性を含めます。

Note: このパラメータと cursor は排他的です。

Note: total_count を含むリクエストはレートリミットが低く、現在は 15 分あたり 200 に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?campaign_ids=8wku2 Example Response 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "campaign_ids": [
            "8wku2"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "name": "テスト",
          "budget_optimization": "CAMPAIGN",
          "reasons_not_servable": [
            "PAUSED_BY_ADVERTISER",
            "INCOMPLETE"
          ],
          "servable": false,
          "purchase_order_number": null,
          "effective_status": "UNKNOWN",
          "daily_budget_amount_local_micro": 10000000,
          "funding_instrument_id": "lygyi",
          "duration_in_days": null,
          "standard_delivery": false,
          "total_budget_amount_local_micro": null,
          "id": "8wku2",
          "entity_status": "PAUSED",
          "frequency_cap": null,
          "currency": "USD",
          "作成日時": "2022-06-03T21:38:07Z",
          "updated_at": "2022-06-03T21:38:07Z",
          "deleted": false
        }
      ]
    }

​
GET accounts/:account_id/campaigns/:campaign_id

現在のアカウントに関連付けられた特定のキャンペーンを取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id Parameters
NameDescription
account_id
required		利用しているアカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
campaign_id
required		リクエストで操作対象となるキャンペーンを参照する識別子。

Type: string

Example: 8wku2
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8wku2 Example Response 
    {
      "request": {
        "params": {
          "campaign_id": "8wku2",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "test",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [
          "PAUSED_BY_ADVERTISER",
          "INCOMPLETE"
        ],
        "servable": false,
        "purchase_order_number": null,
        "effective_status": "UNKNOWN",
        "daily_budget_amount_local_micro": 10000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "8wku2",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "created_at": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:38:07Z",
        "deleted": false
      }
    }

​
POST accounts/:account_id/campaigns

現在のアカウントに関連付けられた新規キャンペーンを作成します。 Note: 1アカウントあたりのアクティブなキャンペーン数のデフォルト上限は200です。ただし、非アクティブなキャンペーン数に制限はありません。この上限はアクティブなキャンペーン8,000まで引き上げ可能です。上限の引き上げには、広告主が自社のX Account Managerに申請する必要があります。 Resource URL https://ads-api.x.com/12/accounts/:account_id/campaigns Parameters
NameDescription
account_id
required		利用するアカウントの識別子。リソースのパス内に現れ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
funding_instrument_id
required		キャンペーンを作成する対象の資金手段の識別子。

Type: string

Example: lygyi
name
required		キャンペーン名。最大長: 255文字。

Type: string

Example: demo
budget_optimization
optional		適用する予算最適化の種類を選択します。

Type: enum

Default: CAMPAIGN
Possible values: CAMPAIGN, LINE_ITEM
daily_budget_amount_local_micro
sometimes required		キャンペーンに割り当てる1日あたりの予算額。指定した資金手段に関連付けられた通貨が使用されます。USDの場合、$5.50 は 5,500,000 と表されます。

Note: total_budget_amount_local_micro 以下である必要があり、ほとんどの資金手段タイプで必須です。

Type: long

Example: 5500000
entity_status
optional		キャンペーンのステータス。

Type: enum

Default: ACTIVE
Possible values: ACTIVE, DRAFT, PAUSED
purchase_order_number
optional		予約参照番号。請求書照合のために使用します。最大長: 50文字。

Type: string

Example: D00805843
standard_delivery
optional		標準配信または加速配信を有効にします。両者の違いは Budget Pacing を参照してください。budget_optimization が CAMPAIGN に設定されている場合のみ利用可能です。

Type: boolean

Default: true
Possible values: true, false
total_budget_amount_local_micro
optional		キャンペーンに割り当てる合計予算額。指定した資金手段に関連付けられた通貨が使用されます。USDの場合、$37.50 は 37,500,000 と表されます。

Type: long

Example: 37500000
Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns?funding_instrument_id=lygyi&name=demo&daily_budget_amount_local_micro=140000000&entity_status=PAUSED&budget_optimization=CAMPIAGN&standard_delivery=false Example Response 
    {
      "request": {
        "params": {
          "name": "demo",
          "budget_optimization": "CAMPAIGN",
          "daily_budget_amount_local_micro": 140000000,
          "funding_instrument_id": "lygyi",
          "standard_delivery": false,
          "entity_status": "PAUSED",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "demo",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [
          "PAUSED_BY_ADVERTISER",
          "INCOMPLETE"
        ],
        "servable": false,
        "purchase_order_number": null,
        "effective_status": "UNKNOWN",
        "daily_budget_amount_local_micro": 140000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "hwtbm",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "作成日時": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:38:07Z",
        "deleted": false
      }
    }

​
POST batch/accounts/:account_id/campaigns

単一のリクエストで新規キャンペーンを一括作成できます。 バッチリクエスト
  • 現在の最大バッチサイズは40です。
  • すべてのパラメータはリクエストボディで送信され、Content-Type は application/json が必須です。
  • バッチリクエストはグループとして成否が一括で決まり、エラー/成功いずれのAPIレスポンスでも初回リクエスト時の項目順が保持されます。
バッチレスポンス バッチAPIのレスポンスは順序付きの項目コレクションを返します。それ以外は、対応する単一項目のendpointと構造は同一です。 バッチエラー
  • リクエストレベルのエラー（例: 最大バッチサイズ超過）はレスポンスの errors オブジェクトに示されます。
  • 項目レベルのエラー（例: 必須のキャンペーンパラメータの不足）はレスポンスの operation_errors オブジェクトに示されます。
Resource URL https://ads-api.x.com/12/batch/accounts/:account_id/campaigns Parameters
NameDescription
operation_type
required		各項目で実行する操作の種類。

Type: enum

Possible values: Create, Delete, Update
params
required		キャンペーンオブジェクトのすべてのパラメータを含むJSONオブジェクト。必須/任意のキャンペーンパラメータ一覧はこちらを参照してください。
Example Request POST 'Content-Type: application/json' https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/campaigns 
    [
      {
        "operation_type":"Create",
        "params":{
          "name":"バッチキャンペーン",
          "funding_instrument_id":"lygyi",
          "daily_budget_amount_local_micro":140000000,
          "entity_status":"PAUSED",
          "budget_optimization":"CAMPAIGN"
        }
      }
    ]
応答例 
    {
      "data": [
        {
          "name": "バッチキャンペーン",
          "budget_optimization": "CAMPAIGN",
          "reasons_not_servable": [
            "PAUSED_BY_ADVERTISER",
            "INCOMPLETE"
          ],
          "servable": false,
          "purchase_order_number": null,
          "effective_status": "UNKNOWN",
          "daily_budget_amount_local_micro": 140000000,
          "funding_instrument_id": "lygyi",
          "duration_in_days": null,
          "standard_delivery": false,
          "total_budget_amount_local_micro": null,
          "id": "8yn7m",
          "entity_status": "PAUSED",
          "frequency_cap": null,
          "currency": "USD",
          "created_at": "2022-06-03T21:38:07Z",
          "updated_at": "2022-06-03T21:38:07Z",
          "deleted": false
        }
      ],
      "request": [
        {
          "params": {
            "name": "バッチキャンペーン",
            "funding_instrument_id": "lygyi",
            "daily_budget_amount_local_micro": 140000000,
            "entity_status": "PAUSED",
            "budget_optimization":"CAMPAIGN",
            "account_id": "18ce54d4x5t"
          },
          "operation_type": "Create"
        }
      ]
    }

​
PUT accounts/:account_id/campaigns/:campaign_id

現在のアカウントに関連付けられている指定のキャンペーンを更新します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id Parameters
NameDescription
account_id
required		利用対象のアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで原則として必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
campaign_id
required		本リクエストで操作するキャンペーンの参照子。

Type: string

Example: 8wku2
budget_optimization
optional		適用する予算最適化の種類を選択します。

Type: enum

Default: CAMPAIGN
Possible values: CAMPAIGN, LINE_ITEM
daily_budget_amount_local_micro
optional		キャンペーンに割り当てる1日あたりの予算額。指定した資金インスツルメントに紐づく通貨が使用されます。USD の場合、$5.50 は 5,500,000 で表されます。未指定の場合、キャンペーンは合計予算とフライト期間に基づき均等に消化されます。

Note: total_budget_amount_local_micro 以下である必要があります。

Type: long

Example: 5500000
entity_status
optional		キャンペーンのステータス。

Type: enum

Possible values: ACTIVE, PAUSED
name
optional		キャンペーン名。最大長: 255 文字。

Type: string

Example: demo
purchase_order_number
optional		受注（発注）参照番号。請求書照合を容易にするために使用します。最大長: 50 文字。

Type: string

Example: D00805843
standard_delivery
optional		標準配信または加速配信を有効にします。両者の詳細は Budget Pacing を参照してください。budget_optimization が CAMPAIGN に設定されている場合にのみ利用可能です。

Type: boolean

Default: true
Possible values: true, false
total_budget_amount_local_micro
optional		キャンペーンに割り当てる合計予算額。指定した資金インスツルメントに紐づく通貨が使用されます。USD の場合、$37.50 は 37,500,000 で表されます。

Type: long

Example: 140000000
Example Request PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8wku2?total_budget_amount_local_micro=140000000 Example Response 
    {
      "request": {
        "params": {
          "campaign_id": "8wku2",
          "daily_budget_amount_local_micro": 140000000,
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "テスト",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [
          "PAUSED_BY_ADVERTISER",
          "INCOMPLETE"
        ],
        "servable": false,
        "purchase_order_number": null,
        "effective_status": "UNKNOWN",
        "daily_budget_amount_local_micro": 140000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "8wku2",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "作成日時": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:53:54Z",
        "deleted": false
      }
    }

​
DELETE accounts/:account_id/campaigns/:campaign_id

現在のアカウントに属する指定のキャンペーンを削除します。 注意: キャンペーンの削除は取り消せません。以後、このリソースを削除しようとすると HTTP 404 が返されます。 Resource URL https://ads-api.x.com/12/accounts/:account_id/campaigns/:campaign_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定されたアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
campaign_id
required		このリクエストで操作対象となるキャンペーンを参照します。

Type: string

Example: 8yn7m
Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/campaigns/8yn7m Example Response 
    {
      "request": {
        "params": {
          "campaign_id": "8yn7m",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "test",
        "budget_optimization": "CAMPAIGN",
        "reasons_not_servable": [],
        "servable": null,
        "purchase_order_number": null,
        "effective_status": "RUNNING",
        "daily_budget_amount_local_micro": 140000000,
        "funding_instrument_id": "lygyi",
        "duration_in_days": null,
        "standard_delivery": false,
        "total_budget_amount_local_micro": null,
        "id": "8yn7m",
        "entity_status": "PAUSED",
        "frequency_cap": null,
        "currency": "USD",
        "created_at": "2022-06-03T21:38:07Z",
        "updated_at": "2022-06-03T21:56:35Z",
        "deleted": true
      }
    }

​
コンテンツ・カテゴリー

​
GET content_categories

ラインアイテムのtargeting_criteriaとして設定可能な有効なコンテンツcategoriesをリクエストします。 各content_categoryは、1つ以上のIAB Categoriesにマッピングされます。これを行うには、バッチtargeting_criteraendpointでtargeting_typeをIAB_CATEGORYに設定し、content_categoriesリクエストで返される対応するiab_categoriesのセットを含めます。これを行わない場合、バリデーションエラーになります。 これらのコンテンツカテゴリごとのパブリッシャーの詳細は、GET publishersendpointで取得できます。 詳細は、Video Views Pre-roll Objective Guideを参照してください。 Resource URL https://ads-api.x.com/12/content_categories Parameters リクエストパラメータはありません Example Request GET https://ads-api.x.com/12/content_categories Example Response 
{
      "request": {
        "params": {}
      },
      "next_cursor": null,
      "data": [
        {
          "name": "自動車（乗用車、トラック、レーシング）",
          "id": "ru",
          "iab_categories": [
            "IAB2"
          ],
          "publishers_in_last_thirty_days": 12,
          "videos_monetized_in_last_thirty_days": 316
        },
        {
          "name": "コメディ",
          "id": "sk",
          "iab_categories": [
            "IAB1-4"
          ],
          "publishers_in_last_thirty_days": 19,
          "videos_monetized_in_last_thirty_days": 174
        },
        {
          "name": "デジタルクリエイター",
          "id": "sl",
          "iab_categories": [
            "IAB25-1"
          ],
          "publishers_in_last_thirty_days": 110,
          "videos_monetized_in_last_thirty_days": 1257
        },
        {
          "name": "エンターテインメント・ポップカルチャー",
          "id": "sm",
          "iab_categories": [
            "IAB1-1",
            "IAB1-2",
            "IAB1-3",
            "IAB1-5"
          ],
          "publishers_in_last_thirty_days": 120,
          "videos_monetized_in_last_thirty_days": 3482
        },
        {
          "name": "金融・ビジネスニュース",
          "id": "sn",
          "iab_categories": [
            "IAB3",
            "IAB13",
            "IAB21"
          ],
          "publishers_in_last_thirty_days": 29,
          "videos_monetized_in_last_thirty_days": 1461
        },
        {
          "name": "食品・飲料",
          "id": "so",
          "iab_categories": [
            "IAB8-8",
            "IAB8-12",
            "IAB8-17",
            "IAB8-2",
            "IAB8-3",
            "IAB8-7",
            "IAB8-11",
            "IAB8-4",
            "IAB8-14",
            "IAB8-10",
            "IAB8-15",
            "IAB8-13",
            "IAB8-9",
            "IAB8-16",
            "IAB8-6",
            "IAB8-1"
          ],
          "publishers_in_last_thirty_days": 24,
          "videos_monetized_in_last_thirty_days": 516
        },
        {
          "name": "ライフスタイル（ファッション、旅行、ウェルネス）",
          "id": "sp",
          "iab_categories": [
            "IAB16",
            "IAB9-21",
            "IAB9-4",
            "IAB9-25",
            "IAB9-8",
            "IAB4",
            "IAB9-3",
            "IAB9-15",
            "IAB7",
            "IAB6",
            "IAB9-11",
            "IAB9-16",
            "IAB9-7",
            "IAB9-20",
            "IAB9-24",
            "IAB9-17",
            "IAB9-12",
            "IAB9-31",
            "IAB9-27",
            "IAB10",
            "IAB9-10",
            "IAB9-23",
            "IAB9-6",
            "IAB9-18",
            "IAB9-13",
            "IAB9-1",
            "IAB9-28",
            "IAB20",
            "IAB9-5",
            "IAB9-26",
            "IAB22",
            "IAB23",
            "IAB9-9",
            "IAB9-22",
            "IAB18",
            "IAB9-2",
            "IAB9-19",
            "IAB9-14",
            "IAB9-29"
          ],
          "publishers_in_last_thirty_days": 67,
          "videos_monetized_in_last_thirty_days": 2412
        },
        {
          "name": "音楽",
          "id": "sq",
          "iab_categories": [
            "IAB1-6"
          ],
          "publishers_in_last_thirty_days": 31,
          "videos_monetized_in_last_thirty_days": 518
        },
        {
          "name": "ニュース・時事問題",
          "id": "sr",
          "iab_categories": [
            "IAB12",
            "IAB14"
          ],
          "publishers_in_last_thirty_days": 125,
          "videos_monetized_in_last_thirty_days": 5507
        },
        {
          "name": "政治",
          "id": "s4",
          "iab_categories": [
            "IAB11"
          ],
          "publishers_in_last_thirty_days": 19,
          "videos_monetized_in_last_thirty_days": 1402
        },
        {
          "name": "科学・教育",
          "id": "ss",
          "iab_categories": [
            "IAB5",
            "IAB15"
          ],
          "publishers_in_last_thirty_days": 7,
          "videos_monetized_in_last_thirty_days": 132
        },
        {
          "name": "スポーツ",
          "id": "se",
          "iab_categories": [
            "IAB17"
          ],
          "publishers_in_last_thirty_days": 403,
          "videos_monetized_in_last_thirty_days": 18281
        },
        {
          "name": "テクノロジー",
          "id": "sg",
          "iab_categories": [
            "IAB19"
          ],
          "publishers_in_last_thirty_days": 13,
          "videos_monetized_in_last_thirty_days": 1089
        },
        {
          "name": "テレビ",
          "id": "sh",
          "iab_categories": [
            "IAB1-7"
          ],
          "publishers_in_last_thirty_days": 58,
          "videos_monetized_in_last_thirty_days": 1307
        },
        {
          "name": "eスポーツ・ビデオゲーム",
          "id": "s0",
          "iab_categories": [
            "IAB9-30"
          ],
          "publishers_in_last_thirty_days": 109,
          "videos_monetized_in_last_thirty_days": 1844
        }
      ],
      "total_count": 15
    }

​
厳選カテゴリ

​
GET accounts/:account_id/curated_categories

指定したcountry_codesに対して利用可能なCurated Categoriesの一覧を取得します。 各curated_categoryは、レスポンスのcountry_codesで示される特定の国でのみ利用可能です。 詳細はVideo Views Pre-roll Objective Guideを参照してください。 Resource URL https://ads-api.x.com/12/accounts/:account_id/curated_categories Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accountsを除くすべてのAdvertiser APIリクエストで原則必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
country_codes
required		2文字のISO国コードをカンマ区切りで指定して、レスポンスを対象国のみに絞り込みます。最大200件まで指定できます。

Type: string

Example: US
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細はPaginationを参照してください。

Type: string

Example: 8x7v00oow
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories?country_codes=US Example Response 
{
      "request": {
        "params": {
          "country_codes": [
            "US"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "name": "バスケットボール",
          "description": "大学チーム、プロチーム、そしてオンシーズンとオフシーズンのバスケットボール動画を共有するトップスポーツメディアアカウントを含む、日常のバスケットボールコンテンツの最高品質のものと併せて配信されます。",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "20265254",
            "378174762",
            "900368808",
            "18939563",
            "18371803",
            "18360370",
            "770658432928079872",
            "11026952",
            "37085464",
            "16212685",
            "57422635",
            "281669945",
            "7117962",
            "23065057",
            "41688179",
            "29779226",
            "900280416",
            "364460082",
            "902030382",
            "19409270",
            "19077044",
            "18139461",
            "14992591",
            "66753565",
            "667563",
            "16727749",
            "40941404",
            "18481113",
            "791598918",
            "16201775",
            "15900167",
            "45891626",
            "191894553",
            "2181233851",
            "34352904",
            "171483987",
            "454122399",
            "57415242",
            "19263978",
            "902089998",
            "423540866",
            "2715223320",
            "22185437",
            "17292143",
            "55590247",
            "66757066",
            "22642626",
            "41604618",
            "87275465",
            "22643259",
            "32414973",
            "73406718",
            "20346956",
            "413422891",
            "45412765",
            "19537303",
            "459511725",
            "30954864",
            "21308488",
            "18552281",
            "19924520",
            "24903350",
            "851142163",
            "26270913",
            "20444254",
            "26074296",
            "6395222",
            "15537451",
            "28672101",
            "38053254",
            "24925573",
            "19564719",
            "18164425",
            "22815383",
            "20196159"
          ],
          "id": "929wbl6ymlfk",
          "created_at": "2019-11-08T21:12:47Z",
          "updated_at": "2021-03-09T20:36:44Z",
          "videos_monetized_in_last_thirty_days": 2446
        },
        {
          "name": "ゲーミングパーソナリティ",
          "description": "オンラインゲーミング界で最も大きく愛されているデジタルクリエイターのリストから独占的に提供される、日常のゲーミングコンテンツの最高品質のものと併せて配信されます。",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "90779436",
            "268270621",
            "567167802",
            "246596682",
            "474919140",
            "284422688",
            "185909682",
            "4767225325",
            "2559865245",
            "186888760",
            "161418822",
            "141021153",
            "352881953",
            "1117931702",
            "146556805",
            "357294577",
            "234526497",
            "266687361",
            "214201922",
            "9451052",
            "2163885564",
            "2231422037",
            "116952434",
            "399909209",
            "15993650",
            "974356091193741312",
            "210839744",
            "2313002094",
            "159916388",
            "3258981481",
            "231992478",
            "182236262",
            "386884916",
            "22705686",
            "4140881832",
            "995979576",
            "2244953047",
            "311775629",
            "98821255",
            "2733210014",
            "2741078150"
          ],
          "id": "94ngssfrr01x",
          "created_at": "2019-12-02T20:45:12Z",
          "updated_at": "2021-03-09T20:18:13Z",
          "videos_monetized_in_last_thirty_days": 448
        },
        {
          "name": "野球",
          "description": "大学チーム、プロチーム、そして主要な野球報道を共有するトップスポーツメディアアカウントを含む、日常の野球コンテンツの最高品質のものと併せて配信されます。",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "22016177",
            "22798877",
            "52803520",
            "20710218",
            "423532170",
            "28603812",
            "41144996",
            "22819823",
            "39389304",
            "252273678",
            "123307490",
            "2319354187",
            "41488578",
            "37947138",
            "302066953",
            "159143990",
            "35006336",
            "53178109",
            "40918816",
            "39682297",
            "39397148",
            "39419180",
            "53197137",
            "52863923",
            "21407926",
            "31164229",
            "19607400",
            "39392910",
            "241544156",
            "43024351",
            "37837907",
            "165764237",
            "69117905",
            "87673496",
            "23043294",
            "52824038",
            "52861612",
            "33137450",
            "30008146",
            "39367703",
            "21436663",
            "188575356",
            "40931019",
            "41468683",
            "40927173",
            "172742915"
          ],
          "id": "9lav5usxfmdc",
          "created_at": "2020-05-18T20:20:27Z",
          "updated_at": "2021-03-09T20:37:46Z",
          "videos_monetized_in_last_thirty_days": 190
        },
        {
          "name": "eスポーツチーム",
          "description": "世界最高のeスポーツチームからのプログラムと併せて配信され、イベント内の報道と年間を通じたその他の補完的なプログラムの両方をカバーします。",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "759527448757215232",
            "61933836",
            "477213534",
            "907193396049182720",
            "895382891408089089",
            "862708050116976640",
            "115038550",
            "3182089458",
            "4131266472",
            "1145702070961496065",
            "2262070855",
            "920664872786059264",
            "1035653581683220481",
            "14229141",
            "1101275970995027968",
            "20734751",
            "1452520626",
            "720303639277928448",
            "2853641871",
            "912696400571486208",
            "874362688939413504",
            "286505380",
            "892808605170245632",
            "875087838613733376",
            "238431491",
            "867053221940011014",
            "964529942",
            "1172506293174710272",
            "535756639",
            "2255226817",
            "1100825469853696000",
            "1122713320086220803",
            "1124064709295128581",
            "899858978418642944",
            "864977592532688896",
            "864476897106898944",
            "862770685445361665",
            "257268592"
          ],
          "id": "9ys3jz3ktreo",
          "created_at": "2020-10-01T20:02:35Z",
          "updated_at": "2021-03-09T20:36:20Z",
          "videos_monetized_in_last_thirty_days": 169
        },
        {
          "name": "フットボール ",
          "description": "大学チーム、プロチーム、そしてオンシーズンとオフシーズンのフットボール動画を共有するトップスポーツメディアアカウントを含む、日常のフットボールコンテンツの最高品質のものと併せて配信されます。",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "21790466",
            "53103297",
            "23642374",
            "817416193854283776",
            "43403778",
            "24179879",
            "26813914",
            "36375662",
            "33587536",
            "180884045",
            "16332223",
            "27902825",
            "180503626",
            "44468807",
            "18336787",
            "818431566",
            "22146282",
            "31126587",
            "40358743",
            "35865630",
            "16347506",
            "72665816",
            "33583496",
            "389038362",
            "36155311",
            "227342532",
            "2151130166",
            "26791995",
            "44666348",
            "24109979",
            "31504542",
            "713143",
            "423536031",
            "25545388",
            "59471027",
            "706923475",
            "19383279",
            "8824902",
            "1655877529",
            "18734310",
            "240734425",
            "17076218",
            "47964412",
            "2802184770",
            "19426729",
            "56443153",
            "23508439",
            "25084916",
            "764347046",
            "19853312",
            "348590880"
          ],
          "id": "8tujg1lvi8sn",
          "created_at": "2019-08-15T20:48:51Z",
          "updated_at": "2021-03-09T20:34:13Z",
          "videos_monetized_in_last_thirty_days": 254
        },
        {
          "name": "男性向けカルチャー + ライフスタイル",
          "description": "フォロワープロファイルに基づいてキュレーションされたハンドルセットのコンテンツと併せて配信し、男性層の大部分にリーチできます。テクノロジー、ニュース、ライフスタイルコンテンツを共有するトップハンドルも含まれています。",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "17764377",
            "61933836",
            "28370738",
            "3224616765",
            "22819823",
            "18927441",
            "734826612684783616",
            "14372486",
            "7157132",
            "15764136",
            "590316679",
            "7302282",
            "895014043932540928",
            "7517222",
            "3489420013",
            "14063426",
            "72665816",
            "214201922",
            "14980903",
            "22199141",
            "21272440",
            "25319414",
            "119593082",
            "4760694445",
            "765905855195803648",
            "238431491",
            "22178780",
            "241544156",
            "25093616",
            "16877611",
            "22146985",
            "368703433",
            "14342661",
            "415605847",
            "2181233851",
            "890891",
            "15764001",
            "614754689",
            "18479513",
            "23508439",
            "348590880"
          ],
          "id": "8tujj1ep7t34",
          "created_at": "2019-08-15T20:49:47Z",
          "updated_at": "2021-03-09T20:39:00Z",
          "videos_monetized_in_last_thirty_days": 1330
        },
        {
          "name": "女性向けカルチャー + ライフスタイル",
          "description": "フォロワープロファイルに基づいてキュレーションされたハンドルセットのコンテンツと併せて配信し、女性層の大部分にリーチできます。ポップカルチャー、ニュース、ライフスタイルコンテンツを共有するトップハンドルも含まれています。",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "23482952",
            "20177423",
            "19074134",
            "15566901",
            "32469566",
            "19784831",
            "16145224",
            "16932962",
            "14934818",
            "29730065",
            "24190981",
            "30278532",
            "15846407",
            "24994219",
            "23993734",
            "40965341",
            "16312576",
            "75094638",
            "549673665",
            "18806753",
            "75306892",
            "1482663290",
            "31181674",
            "971407531972186112",
            "4020532937",
            "25087685",
            "22515362",
            "80943051",
            "19247844",
            "15279429",
            "16824090",
            "20710809",
            "979831113655996416",
            "32432308",
            "19472585",
            "25589776",
            "739963476370673665",
            "20188834",
            "926269727663673349"
          ],
          "id": "8tujl1p3yn0g",
          "created_at": "2019-08-15T20:50:24Z",
          "updated_at": "2021-03-09T20:17:53Z",
          "videos_monetized_in_last_thirty_days": 1365
        },
        {
          "name": "軽快",
          "description": "Xで一貫してポジティブで気分の良いコンテンツと会話を大量に生成してきたハンドルのリストと併せて配信します。",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "20177423",
            "22449367",
            "9695312",
            "19074134",
            "4805771380",
            "32469566",
            "1212860112047460352",
            "16402507",
            "16932962",
            "14934818",
            "17446621",
            "29730065",
            "15846407",
            "1604444052",
            "180066380",
            "16312576",
            "549673665",
            "18806753",
            "16211434",
            "545336345",
            "971407531972186112",
            "4020532937",
            "833612154",
            "22515362",
            "20710809",
            "32432308",
            "774311630",
            "3073349892",
            "926269727663673349"
          ],
          "id": "9fg8gmz96qdg",
          "created_at": "2020-03-20T19:37:44Z",
          "updated_at": "2021-03-09T19:57:40Z",
          "videos_monetized_in_last_thirty_days": 1395
        },
        {
          "name": "サッカー",
          "description": "大学チーム、プロチーム、主要なサッカー報道を共有するトップスポーツメディアハンドルを含む、日常的なサッカーコンテンツの最高のものと併せて配信します。",
          "country_codes": [
            "US"
          ],
          "publisher_user_ids": [
            "21677316",
            "20636347",
            "4704552148",
            "14573900",
            "22556296",
            "1415791555",
            "107146095",
            "17288520",
            "213474069",
            "17493398",
            "44990136",
            "452155423",
            "17744542",
            "16303450",
            "2841146601",
            "2413176055",
            "29739264",
            "38580532",
            "953476292913106945",
            "27092557",
            "86356439",
            "34613288",
            "3170659367",
            "119593082",
            "73412535",
            "627586654",
            "15891449",
            "23011345",
            "96951800",
            "15997022",
            "16960789",
            "21919642",
            "102965285",
            "17224076",
            "36432200",
            "1410055968"
          ],
          "id": "9ddrgesiap6o",
          "created_at": "2020-02-28T22:43:26Z",
          "updated_at": "2021-01-26T17:54:55Z",
          "videos_monetized_in_last_thirty_days": 421
        }
      ],
      "total_count": 9
    }

​
GET accounts/:account_id/curated_categories/:curated_category_id

特定のcurated_category_idの詳細を取得します。 各curated_categoryは、レスポンスのcountry_codesで指定された特定の国でのみ利用可能です。 Resource URL https://ads-api.x.com/12/accounts/:account_id/curated_categories/:curated_category_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accountsを除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定されたアカウントは、認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
curated_category_id
required		リクエストで操作対象となる Curated Category を指す参照。

Type: string

Example: 9ddrgesiap6o
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/curated_categories/9ddrgesiap6o Example Response 
    {
      "request": {
        "params": {
          "id": "9ddrgesiap6o",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "name": "サッカー",
        "description": "大学チーム、プロチーム、主要なサッカー報道を共有するトップスポーツメディアアカウントを含む、日々の最高品質のサッカーコンテンツと連携して配信されます。",
        "country_codes": [],
        "publisher_user_ids": [
          "21677316",
          "20636347",
          "4704552148",
          "14573900",
          "22556296",
          "1415791555",
          "107146095",
          "17288520",
          "213474069",
          "17493398",
          "44990136",
          "452155423",
          "17744542",
          "16303450",
          "2841146601",
          "2413176055",
          "29739264",
          "38580532",
          "953476292913106945",
          "27092557",
          "86356439",
          "34613288",
          "3170659367",
          "119593082",
          "73412535",
          "627586654",
          "15891449",
          "23011345",
          "96951800",
          "15997022",
          "16960789",
          "21919642",
          "102965285",
          "17224076",
          "36432200",
          "1410055968"
        ],
        "id": "9ddrgesiap6o",
        "created_at": "2020-02-28T22:43:26Z",
        "updated_at": "2021-01-26T17:54:55Z",
        "videos_monetized_in_last_thirty_days": 421
      }
    }

​
機能

​
GET accounts/:account_id/features

この広告アカウントで利用可能な付与済み機能の一覧を取得します。各機能は説明的な機能キーで示され、ベータ版またはその他の限定リリースとして導入され、かつ X Ads API で利用可能な場合にのみ、この endpoint で公開されます。これらの条件を満たさない機能は、この endpoint では公開されません。 注記: この endpoint は、ベータリリースに対するクライアントのアクセス状況の可視性を高め、X Ads API エコシステムの開発を支援するためのものです。API 開発者が広告主に代わって機能へのアクセスを要求することはできません。これらの要求は、広告主が自社の X アカウントマネージャーにのみ行うことができます。 Resource URL https://ads-api.x.com/12/accounts/:account_id/features Parameters
NameDescription
account_id
required		対象アカウントを識別するための識別子です。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定されたアカウントは認証済みユーザーに紐づいている必要があります。

Type: string

Example: 18ce54d4x5t
feature_keys
optional		特定の機能キーで検索するための任意パラメータです。複数のキーをカンマ区切りで指定できます。

注記: レスポンスには、このアカウントでアクセス可能な機能のみが含まれます。

Type: enum

Possible values: REACH_AND_FREQUENCY_ANALYTICS, REACH_FREQUENCY_CAP, WEBSITE_CLICKS_CPM_BILLING
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/features Example Response 
    {
      "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

SANDBOX のみ サンドボックスアカウントに機能を追加します。 最新のアカウント機能一覧は、GET accounts/:account_id/features endpoint から取得できます。 Resource URL https://ads-api-sandbox.x.com/12/accounts/:account_id/features Parameters
NameDescription
account_id
required		対象アカウントの識別子。resource のパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: gq180y
feature_keys
required		アカウントに追加するアカウント機能のカンマ区切りリスト。

Type: enum

Possible values: 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
Example Request POST https://ads-api-sandbox.x.com/12/accounts/gq180y/features?feature_keys=VALIDATED_AGE_TARGETING Example Response 
    {
      "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

SANDBOX のみ サンドボックスアカウントから機能を削除します。 最新のアカウント機能一覧は、GET accounts/:account_id/features endpoint で取得できます。 Resource URL https://ads-api-sandbox.x.com/12/accounts/:account_id/features Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: gq180y
feature_keys
required		アカウントから削除する機能のカンマ区切りリスト。

Type: enum

Possible values: 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
Example Request DELETE https://ads-api-sandbox.x.com/12/accounts/gq180y/features?feature_keys=PREROLL_VIEWS_OBJECTIVE Example Response 
    {
      "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"
      ]
    }

​
ファンディングインストゥルメント

​
GET accounts/:account_id/funding_instruments

現在のアカウントに関連付けられている一部またはすべての資金手段の詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/funding_instruments Parameters
NameDescription
account_id
required		レバレッジドアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
count
optional		個々のリクエストあたりで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
funding_instrument_ids
optional		識別子のカンマ区切りリストを指定して、レスポンスを目的の資金手段のみに絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: lygyi
sort_by
optional		サポートされる属性で昇順または降順に並べ替えます。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		レスポンス属性 total_count を含めます。

Note: このパラメータと cursor は相互排他です。

Note: total_count を含むリクエストはレートリミットが低く、現在は 15 分あたり 200 に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/funding_instruments Example Response 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "start_time": "2016-07-22T04:24:04Z",
          "description": "末尾0650のVisa",
          "credit_limit_local_micro": 200000000,
          "end_time": null,
          "id": "lygyi",
          "entity_status": "ACTIVE",
          "account_id": "18ce54d4x5t",
          "reasons_not_able_to_fund": [],
          "io_header": null,
          "currency": "USD",
          "funded_amount_local_micro": 645940000,
          "created_at": "2016-07-22T04:24:04Z",
          "type": "CREDIT_CARD",
          "able_to_fund": true,
          "updated_at": "2017-04-05T00:25:13Z",
          "credit_remaining_local_micro": null,
          "deleted": false
        }
      ]
    }

​
GET accounts/:account_id/funding_instruments/:funding_instrument_id

現在のアカウントに関連付けられている特定の資金手段を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/funding_instruments/:id Parameters
NameDescription
account_id
required		レバレッジドアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
funding_instrument_id
required		リクエストで操作対象となる資金手段への参照。

Type: string

Example: lygyi
with_deleted
optional		削除済みの結果をレスポンスに含めます。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/funding_instruments/lygyi Example Response 
    {
      "request": {
        "params": {
          "funding_instrument_id": "lygyi",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "start_time": "2016-07-22T04:24:04Z",
        "description": "末尾0650のVisa",
        "credit_limit_local_micro": 200000000,
        "end_time": null,
        "id": "lygyi",
        "entity_status": "ACTIVE",
        "account_id": "18ce54d4x5t",
        "reasons_not_able_to_fund": [],
        "io_header": null,
        "currency": "USD",
        "funded_amount_local_micro": 645940000,
        "created_at": "2016-07-22T04:24:04Z",
        "type": "CREDIT_CARD",
        "able_to_fund": true,
        "updated_at": "2017-04-05T00:25:13Z",
        "credit_remaining_local_micro": null,
        "deleted": false
      }
    }

​
POST accounts/:account_id/funding_instruments

SANDBOX のみ サンドボックス環境で資金手段を作成します。 サンドボックスの資金手段を使用しても、費用が発生するリスクはありません。 Resource URL https://ads-api-sandbox.x.com/12/accounts/:account_id/funding_instruments Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般に必須です。指定のアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: gq1844
currency
required		通貨（ISO-4217 形式）。

Type: string

Example: USD
start_time
required		資金手段が有効になり利用可能となる日時（ISO 8601 形式）。

Type: string

Example: 2017-05-19T07:00:00Z
type
required		作成する資金手段のタイプ。

Type: enum

Possible values: AGENCY_CREDIT_LINE, CREDIT_CARD, CREDIT_LINE, INSERTION_ORDER, PARTNER_MANAGED
end_time
sometimes required		資金手段が無効になる日時（ISO 8601 形式）。

Type: string

Example: 2017-05-26T07:00:00Z
credit_limit_local_micro
optional		この資金手段の利用可能な総与信枠。

Note: 一部の資金手段タイプにのみ適用されます。

Type: long

Example: 37500000
funded_amount_local_micro
optional		この資金手段に割り当てられた総予算額。

Note: 一部の資金手段タイプにのみ適用されます。

Type: long

Example: 37500000
Example Request POST https://ads-api-sandbox.x.com/12/accounts/gq1844/funding_instruments?currency=USD&start_time=2017-07-10T00:00:00Z&type=INSERTION_ORDER&end_time=2018-01-10T00:00:00Z&funded_amount_local_micro=140000000000 Example Response 
    {
      "data": {
        "start_time": "2017-07-10T00:00:00Z",
        "description": "（支払い方法がまだ設定されていません）",
        "credit_limit_local_micro": null,
        "end_time": "2018-01-10T00:00:00Z",
        "id": "hxtet",
        "entity_status": "ACTIVE",
        "account_id": "gq1844",
        "reasons_not_able_to_fund": [],
        "io_header": null,
        "currency": "USD",
        "funded_amount_local_micro": 140000000000,
        "created_at": "2017-09-09T05:23:28Z",
        "type": "INSERTION_ORDER",
        "able_to_fund": true,
        "updated_at": "2017-09-09T05:23:28Z",
        "credit_remaining_local_micro": null,
        "deleted": false
      },
      "request": {
        "params": {
          "start_time": "2017-07-10T00:00:00Z",
          "end_time": "2018-01-10T00:00:00Z",
          "account_id": "gq1844",
          "currency": "USD",
          "funded_amount_local_micro": 140000000000,
          "type": "INSERTION_ORDER"
        }
      }
    }

​
DELETE accounts/:account_id/funding_instruments/:funding_instrument_id

SANDBOX のみ サンドボックス環境で資金手段を削除します。 リソース URL https://ads-api-sandbox.x.com/12/accounts/:account_id/funding_instruments/:funding_instrument_id パラメータ
NameDescription
account_id
必須		レバレッジドアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: gq1844
funding_instrument_id
必須		このリクエストで操作する資金手段の参照。

Type: string

Example: hxt82
リクエスト例 DELETE https://ads-api-sandbox.x.com/12/accounts/gq1844/funding_instruments/hxt82 レスポンス例 
    {
      "data": {
        "start_time": "2017-08-30T19:23:47Z",
        "description": "（支払い方法がまだ設定されていません）",
        "credit_limit_local_micro": 500000000,
        "end_time": null,
        "id": "hxt82",
        "entity_status": "ACTIVE",
        "account_id": "gq1844",
        "reasons_not_able_to_fund": [
          "DELETED"
        ],
        "io_header": null,
        "currency": "USD",
        "funded_amount_local_micro": null,
        "created_at": "2017-08-30T19:23:47Z",
        "type": "CREDIT_CARD",
        "able_to_fund": false,
        "updated_at": "2017-09-09T02:08:30Z",
        "credit_remaining_local_micro": null,
        "deleted": true
      },
      "request": {
        "params": {
          "funding_instrument_id": "hxt82",
          "account_id": "gq1844"
        }
      }
    }

​
IAB カテゴリー

​
GET iab_categories

広告グループ（line_items）向けに有効なアプリのcategoriesを取得します。 Resource URL https://ads-api.x.com/12/iab_categories Parameters
NameDescription
count
optional		リクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページのカテゴリを取得するためのカーソルを指定します。詳細はPaginationを参照してください。

Type: string

Example: gc-ddf4a
with_total_count
optional		レスポンス属性total_countを含めます。

Note: このパラメータとcursorは同時指定できません。

Note: total_countを含むリクエストはレートリミットが低くなり、現在は15分あたり200に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/iab_categories?count=2 Example Response 
    {
      "data": [
        {
          "id": "IAB1",
          "parent_id": null,
          "name": "アート・エンターテインメント"
        },
        {
          "id": "IAB1-1",
          "parent_id": "IAB1",
          "name": "書籍・文学"
        }
      ],
      "next_cursor": "uxa8",
      "request": {
        "params": {
          "count": 2
        }
      }
    }

​
Line Items

​
GET accounts/:account_id/line_items

現在のアカウントに関連付けられている一部またはすべてのラインアイテムの詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/line_items Parameters
NameDescription
account_id
required		対象となるアカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
campaign_ids
optional		カンマ区切りの識別子リストを指定して、特定のキャンペーン配下のラインアイテムのみにレスポンスを絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 8gdx6
count
optional		各リクエストで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
funding_instrument_ids
optional		カンマ区切りの識別子リストを指定して、特定のファンディングインストゥルメント配下のラインアイテムのみにレスポンスを絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: lygyi
line_item_ids
optional		カンマ区切りの識別子リストを指定して、目的のラインアイテムのみにレスポンスを絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 8v7jo
q
optional		name による絞り込みのための任意の query。

Type: string

Min, Max length: 1, 255
sort_by
optional		サポートされる属性で昇順または降順にソートします。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		リクエストに削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_draft
optional		リクエストに下書きキャンペーンの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		total_count レスポンス属性を含めます。

Note: このパラメータと cursor は相互排他です。

Note: total_count を含むリクエストのレートリミットは低く、現在は 15 分あたり 200 に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items?line_item_ids=itttx Example Response 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "line_item_ids": [
            "itttx"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "advertiser_user_id": "756201191646691328",
          "name": "li-18",
          "placements": [
            "ALL_ON_TWITTER"
          ],
          "start_time": "2021-02-16T00:00:00Z",
          "bid_amount_local_micro": 320000,
          "advertiser_domain": null,
          "target_cpa_local_micro": null,
          "primary_web_event_tag": null,
          "goal": "ENGAGEMENT",
          "daily_budget_amount_local_micro": null,
          "product_type": "PROMOTED_TWEETS",
          "end_time": null,
          "funding_instrument_id": "lygyi",
          "bid_strategy": "MAX",
          "duration_in_days": null,
          "standard_delivery": null,
          "total_budget_amount_local_micro": null,
          "objective": "ENGAGEMENTS",
          "id": "itttx",
          "entity_status": "PAUSED",
          "automatic_tweet_promotion": null,
          "frequency_cap": null,
          "android_app_store_identifier": null,
          "categories": [],
          "currency": "USD",
          "pay_by": "ENGAGEMENT",
          "created_at": "2021-02-23T23:37:54Z",
          "ios_app_store_identifier": null,
          "updated_at": "2022-06-01T02:01:18Z",
          "campaign_id": "f4z6x",
          "creative_source": "MANUAL",
          "deleted": false
        }
      ]
    }

​
GET accounts/:account_id/line_items/:line_item_id

現在のアカウントに関連付けられた特定のラインアイテムを取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須のパラメータです。指定したアカウントは、認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_id
required		リクエストで操作するラインアイテムを指す参照。

Type: string

Example: 8v7jo
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/itttx Example Response 
    {
      "request": {
        "params": {
          "line_item_id": "itttx",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "advertiser_user_id": "756201191646691328",
        "name": "li-18",
        "placements": [
          "ALL_ON_TWITTER"
        ],
        "start_time": "2021-02-16T00:00:00Z",
        "bid_amount_local_micro": 320000,
        "advertiser_domain": null,
        "target_cpa_local_micro": null,
        "primary_web_event_tag": null,
        "goal": "ENGAGEMENT",
        "daily_budget_amount_local_micro": null,
        "product_type": "PROMOTED_TWEETS",
        "end_time": null,
        "funding_instrument_id": "lygyi",
        "bid_strategy": "MAX",
        "duration_in_days": null,
        "standard_delivery": null,
        "total_budget_amount_local_micro": null,
        "objective": "ENGAGEMENTS",
        "id": "itttx",
        "entity_status": "PAUSED",
        "automatic_tweet_promotion": null,
        "frequency_cap": null,
        "android_app_store_identifier": null,
        "categories": [],
        "currency": "USD",
        "pay_by": "ENGAGEMENT",
        "created_at": "2021-02-23T23:37:54Z",
        "ios_app_store_identifier": null,
        "updated_at": "2022-06-01T02:01:18Z",
        "campaign_id": "f4z6x",
        "creative_source": "MANUAL",
        "deleted": false
      }
    }

​
POST accounts/:account_id/line_items

現在のアカウントに属する指定キャンペーンに関連付けられたラインアイテムを作成します。 キャンペーン内のすべてのラインアイテムは、同一の product_type および objective である必要があります。 PROMOTED_ACCOUNT の product type を使用する場合、line_item に Tweet を関連付けると、標準の PROMOTED_ACCOUNT プレースメントに加えて、モバイルのタイムラインプレースメントが追加されます。 android_app_store_identifier または ios_app_store_identifier を設定すると、プロモーション対象のモバイルアプリに一致するターゲティング条件が自動的にそのラインアイテムに追加されます。たとえば、ios_app_store_identifier を渡すと、iOS に対する PLATFORM のターゲティング条件が追加されます。 注: 1つのキャンペーンあたりのラインアイテムは最大100個、全キャンペーン合計のアクティブなラインアイテムは最大256個までです。 Resource URL https://ads-api.x.com/12/accounts/:account_id/line_items Parameters
Name説明
account_id
required		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで基本的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
campaign_id
required		このラインアイテムを作成する対象のキャンペーンの識別子。

Type: string

Example: 8slvg
end_time
required		ラインアイテムの配信が停止する時刻（ISO 8601 形式）。

Type: string

Example: 2017-10-05T00:00:00Z
objective
required		このラインアイテムのキャンペーンの目的。

Type: enum

Possible values: APP_ENGAGEMENTS, APP_INSTALLS, REACH, FOLLOWERS, ENGAGEMENTS, VIDEO_VIEWS, PREROLL_VIEWS, WEBSITE_CLICKS
placements
required		このラインアイテムを表示する掲載面。カンマ区切りの掲載値リストを指定します。

Type: enum

Possible values: ALL_ON_TWITTER, PUBLISHER_NETWORK, TAP_BANNER, TAP_FULL, TAP_FULL_LANDSCAPE, TAP_NATIVE, TAP_MRECT,TWITTER_PROFILE, TWITTER_REPLIES, TWITTER_SEARCH, TWITTER_TIMELINE
product_type
required		このラインアイテムに含まれるプロモーション対象の種類。

Type: enum

Possible values: MEDIA, PROMOTED_ACCOUNT, PROMOTED_TWEETS
start_time
required		ラインアイテムの配信が開始する時刻（ISO 8601 形式）。

Type: string

Example: 2017-07-05T00:00:00Z
advertiser_domain
sometimes required		この広告主のウェブサイトのドメイン（プロトコル指定なし）。

注: ラインアイテムの掲載が PUBLISHER_NETWORK に設定されている場合は必須です。

Type: string

Example: x.com
android_app_store_identifier
sometimes required		プロモーションアプリ向けの Google App Store の識別子。

注: 目標が APP_INSTALLS または APP_ENGAGEMENTS の場合、android_app_store_identifier と ios_app_store_identifier のいずれか少なくとも一方の設定が必要です。

Type: string

Example: com.twitter.android
bid_amount_local_micro
sometimes required		このラインアイテムに関連付ける入札額。指定した資金手段に紐づく通貨が使用されます。USD の場合、$5.50 は 5500000 と表されます。

注: bid_strategy が MAX または TARGET の場合は必須です。

注: 0 より大きい値のみ受け付けます。

Type: long

Example: 5500000
categories
sometimes required		この広告主に関連する IAB カテゴリ。 GET iab_categories を参照してください。

注: ラインアイテムの掲載が PUBLISHER_NETWORK に設定されている場合は必須です。

Type: string

Example: IAB3-1
ios_app_store_identifier
sometimes required		プロモーションアプリ向けの Apple App Store の識別子の数値部分。

注: 目標が APP_INSTALLS または APP_ENGAGEMENTS の場合、android_app_store_identifier と ios_app_store_identifier のいずれか少なくとも一方の設定が必要です。

Type: string

Example: 333903271
primary_web_event_tag
sometimes required		プライマリ Web イベントタグの識別子。このラインアイテムに関連するキャンペーンのエンゲージメントをより正確に計測できます。

注: ラインアイテムの目標が WEBSITE_CONVERSIONS の場合は必須です。

Type: string

Example: nvo4z
advertiser_user_id
optional		PREROLL_VIEWS 広告をプロモーションするハンドルの X ユーザーの識別子。一部のクライアントアプリケーションのみこのパラメータを使用できます。

Type: string

Example: 312226591
audience_expansion
optional		既にターゲティングしているユーザーに類似したユーザーを対象にして、キャンペーンの到達範囲を拡大します。

注: 既定では拡大は適用されません。

Type: enum

Possible values: BROAD, DEFINED, EXPANDED
bid_strategy
optional		入札戦略。

AUTO は日次予算とキャンペーンのフライト期間に基づき、入札を自動最適化します。

MAX は許容される最大入札額を設定し、目標が REACH または FOLLOWERS の場合は利用できません。

TARGET は指定した bid_amount_local_micro に対し、日次の平均入札額が±20%以内となるよう試み、目標が REACH、FOLLOWERS、または WEBSITE_CLICKS の場合に利用できます。

注: AUTO の場合、bid_amount_local_micro は無視されます。

注: 既定値は目標に基づきます。

Type: enum

Possible values: AUTO, MAX, TARGET
duration_in_days
optional		frequency_cap を満たすまでの期間（日数）。

Type: int

Possible values: 1, 7, 30
entity_status
optional		ラインアイテムのステータス。

Type: enum

Default: ACTIVE
Possible values: ACTIVE, DRAFT, PAUSED
frequency_cap
optional		1 人のユーザーに配信可能な広告の最大回数。

注: REACH、ENGAGEMENTS、VIDEO_VIEWS、PREROLL_VIEWS の目標でのみサポートされます。

Type: int

Example: 5
goal
optional		このラインアイテムで使用する最適化設定。

APP_PURCHASES オプションは APP_INSTALL で利用可能です。APP_CLICKS と APP_INSTALLS オプションは APP_INSTALL および APP_ENGAGEMENTS の両方の目標で利用可能で、サポートされている MACT パートナー の利用が必要となる場合があります。

SITE_VISITS オプションは WEBSITE_CLICKS 目標でのみ利用可能です。

注: 既定値は目標に基づきます。

Type: enum

Possible values: APP_CLICKS, APP_INSTALLS, APP_PURCHASES,ENGAGEMENT, FOLLOWERS, LINK_CLICKS, MAX_REACH, PREROLL, PREROLL_STARTS, REACH_WITH_ENGAGEMENT, SITE_VISITS, VIDEO_VIEW, VIEW_3S_100PCT, VIEW_6S, VIEW_15S, WEBSITE_CONVERSIONS
name
optional		ラインアイテムの名前。

Type: string

Example: demo

Min, Max length: 1, 255
pay_by
optional		このラインアイテムの課金単位。この設定は、APP_INSTALLS 目的を使用するラインアイテムでのみ変更できます。

注記: 既定の pay_by は、キャンペーンの目的とラインアイテムの入札単位に基づいて自動設定されます。

APP_INSTALLS の目標は APP_CLICK と IMPRESSION の両方をサポートします。IMPRESSION が既定値です。

LINK_CLICKS の目標は LINK_CLICK と IMPRESSION の両方をサポートします。IMPRESSION が既定値ですが、bid_strategy を TARGET に設定する場合はサポートされません。

SITE_VISITS の目標は IMPRESSION の値をサポートします。

Type: enum

Possible values: APP_CLICK, IMPRESSION, LINK_CLICK
standard_delivery
optional		標準配信または加速配信を有効にします。標準配信と加速配信の詳細は Budget Pacing を参照してください。親キャンペーンで budget_optimization が LINE_ITEM に設定されている場合にのみ利用可能です。

Type: boolean

Default: true
Possible values: true, false
total_budget_amount_local_micro
optional		ラインアイテムに割り当てる合計予算額。指定された資金手段に紐づく通貨が使用されます。USD の場合、$37.50 は 37500000 と表されます。

Type: long

Example: 37500000
daily_budget_amount_local_micro
sometimes required		キャンペーンに割り当てる1日あたりの予算額。指定された資金手段に紐づく通貨が使用されます。USD の場合、$5.50 は 5500000 と表されます。未指定の場合、キャンペーンは合計予算とフライト期間に基づいて均等に消化します。親キャンペーンで budget_optimization が LINE_ITEM に設定されている場合にのみ利用可能です。

注記: これは total_budget_amount_local_micro 以下である必要があります。

Type: long

Example: 5500000
リクエスト例 POST https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items?campaign_id=hwtq0&objective=ENGAGEMENTS&product_type=PROMOTED_TWEETS&placements=ALL_ON_TWITTER&bid_amount_local_micro=3210000&entity_status=PAUSED&daily_budget_amount_local_micro=1000000&start_time=2022-06-15 レスポンス例 
    {
      "request": {
        "params": {
          "placements": [
            "ALL_ON_TWITTER"
          ],
          "start_time": "2022-06-15T00:00:00Z",
          "bid_amount_local_micro": 3210000,
          "daily_budget_amount_local_micro": 1000000,
          "product_type": "PROMOTED_TWEETS",
          "objective": "ENGAGEMENTS",
          "entity_status": "PAUSED",
          "account_id": "18ce54d4x5t",
          "campaign_id": "hwtq0"
        }
      },
      "data": {
        "advertiser_user_id": "756201191646691328",
        "name": null,
        "placements": [
          "ALL_ON_TWITTER"
        ],
        "start_time": "2022-06-15T00:00:00Z",
        "bid_amount_local_micro": 3210000,
        "advertiser_domain": null,
        "target_cpa_local_micro": null,
        "primary_web_event_tag": null,
        "goal": "ENGAGEMENT",
        "daily_budget_amount_local_micro": 1000000,
        "product_type": "PROMOTED_TWEETS",
        "end_time": null,
        "bid_strategy": "MAX",
        "duration_in_days": null,
        "standard_delivery": true,
        "total_budget_amount_local_micro": null,
        "objective": "ENGAGEMENTS",
        "id": "ml5vs",
        "entity_status": "PAUSED",
        "automatic_tweet_promotion": null,
        "frequency_cap": null,
        "android_app_store_identifier": null,
        "categories": [],
        "currency": "USD",
        "pay_by": "ENGAGEMENT",
        "created_at": "2022-06-03T23:47:20Z",
        "ios_app_store_identifier": null,
        "updated_at": "2022-06-03T23:47:20Z",
        "campaign_id": "hwtq0",
        "creative_source": "MANUAL",
        "deleted": false
      }
    }

​
POST batch/accounts/:account_id/line_items

単一のリクエストで新規のline itemsを一括作成できます。 一括リクエスト
  • 現在の最大バッチサイズは40です。
  • すべてのパラメータはリクエストボディで送信され、Content-Type は application/json が必須です。
  • バッチリクエストはグループとして成功または失敗し、エラー時・成功時いずれのAPIレスポンスでも初回リクエストのアイテム順序が保持されます。
一括レスポンス Batch APIのレスポンスは順序付きのアイテムコレクションを返します。その他は、対応する単一アイテムのendpointと構造は同一です。 一括エラー
  • リクエストレベルのエラー（例: 最大バッチサイズ超過）は、レスポンスの errors オブジェクト内に表示されます。
  • アイテムレベルのエラー（例: 必須のline itemパラメータの不足）は、レスポンスの operation_errors オブジェクト内に表示されます。
Resource URL https://ads-api.x.com/12/batch/accounts/:account_id/line_items Parameters
NameDescription
operation_type
required		各アイテムに対して実行される操作タイプ。

Type: enum

Possible values: Create, Delete, Update
params
required		line itemオブジェクトのすべてのパラメータを含むJSONオブジェクト。必須および任意のline itemパラメータの一覧はこちらを参照してください。
Example Request POST 'Content-Type: application/json' https://ads-api.x.com/12/batch/accounts/18ce54d4x5t/line_items 
    [
      {
        "operation_type":"Create",
        "params":{
          "campaign_id":"8yn7m",
          "objective":"ENGAGEMENTS",
          "product_type":"PROMOTED_TWEETS",
          "placements":"ALL_ON_TWITTER",
          "bid_amount_local_micro":3210000,
          "entity_status":"PAUSED"
        }
      }
    ]
応答例 
    {
      "data": [
        {
          "advertiser_user_id": "756201191646691328",
          "name": null,
          "placements": [
            "X 全体"
          ],
          "start_time": null,
          "bid_amount_local_micro": 3210000,
          "advertiser_domain": null,
          "target_cpa_local_micro": null,
          "primary_web_event_tag": null,
          "エンゲージメント",
          "daily_budget_amount_local_micro": null,
          "プロモーション済みTweet",
          "end_time": null,
          "funding_instrument_id": "lygyi",
          "bid_strategy": "MAX",
          "duration_in_days": null,
          "standard_delivery": null,
          "total_budget_amount_local_micro": null,
          "エンゲージメント",
          "id": "9cqi0",
          "一時停止中",
          "automatic_tweet_promotion": null,
          "frequency_cap": null,
          "android_app_store_identifier": null,
          "categories": [],
          "USD",
          "エンゲージメント",
          "created_at": "2017-07-07T17:42:20Z",
          "ios_app_store_identifier": null,
          "updated_at": "2017-07-07T17:42:20Z",
          "campaign_id": "8yn7m",
          "手動",
          "deleted": false
        }
      ],
      "request": [
        {
          "params": {
            "placements": [
              "X 全体"
            ],
            "bid_amount_local_micro": 3210000,
            "プロモーション済みTweet",
            "エンゲージメント",
            "一時停止中",
            "account_id": "18ce54d4x5t",
            "campaign_id": "8yn7m"
          },
          "作成"
        }
      ]
    }

​
PUT accounts/:account_id/line_items/:line_item_id

現在のアカウントに紐づく指定のラインアイテムを更新します。 リソース URL https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id パラメーター
Name説明
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須のパラメータです。指定したアカウントは、認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_id
required		リクエストで操作対象となるラインアイテムを参照します。

Type: string

Example: 8v7jo
advertiser_domain
optional		この広告主のウェブサイトのドメイン（プロトコル指定なし）。

Note: ラインアイテムのプレースメントが PUBLISHER_NETWORK に設定されている場合は必須。

Type: string

Example: x.com
advertiser_user_id
optional		PREROLL_VIEWS 広告を配信するハンドルの Twitter ユーザー識別子。特定のクライアントアプリケーションのみがこのパラメータを使用できます。

Type: string

Example: 312226591
android_app_store_identifier
optional		プロモーション対象アプリの Google Play ストア識別子。

Note: 目的が APP_INSTALLS または APP_ENGAGEMENTS の場合、android_app_store_identifier と ios_app_store_identifier のいずれか少なくとも一方の設定が必須です。

Type: string

Example: com.twitter.android
audience_expansion
optional		既にターゲティングしているユーザーに類似したユーザーを対象にすることで、キャンペーンのリーチを拡大します。

Type: enum

Possible values: BROAD, DEFINED, EXPANDED
bid_amount_local_micro
optional		このラインアイテムに関連付ける入札額。指定された資金手段に紐づく通貨が使用されます。USD の場合、$5.50 は 5,500,000 を表します。

Note: bid_strategy が MAX または TARGET の場合は必須。

Note: 0 より大きい値のみ受け付けます。

Type: long

Example: 140000
bid_strategy
optional		入札方式。

AUTO は日次予算とキャンペーンのフライト期間に基づいて自動的に入札を最適化します。

MAX は許容される最大入札額を設定し、目的が REACH または FOLLOWERS の場合は利用できません。

TARGET は指定した bid_amount_local_micro の ±20% 以内に日次の平均入札額が収まるように試み、目的が REACH または WEBSITE_CLICKS の場合に利用できます。

Note: AUTO を設定した場合、bid_amount_local_micro は無視されます。

Note: 目的に基づくデフォルトがあります。

Type: enum

Possible values: AUTO, MAX, TARGET
categories
optional		この広告主に関連する IAB カテゴリ。GET iab_categories を参照。

Note: ラインアイテムのプレースメントが PUBLISHER_NETWORK に設定されている場合は必須。

Type: string

Example: IAB3-1
duration_in_days
optional		frequency_cap を達成するまでの期間（日数）。

Type: int

Possible values: 1, 7, 30
entity_status
optional		ラインアイテムのステータス。

Type: enum

Possible values: ACTIVE, PAUSED
end_time
optional		ラインアイテムの配信が停止する時刻（ISO 8601 形式）。

Type: string

Example: 2017-10-05T00:00:00Z
frequency_cap
optional		1 人のユーザーに広告を配信できる最大回数。

Note: 目的が REACH、ENGAGEMENTS、VIDEO_VIEWS、PREROLL_VIEWS の場合のみサポートされます。

Type: int

Example: 5
goal
optional		このラインアイテムで使用する最適化設定。APP_PURCHASES オプションは APP_INSTALL で利用可能です。APP_CLICKS と APP_INSTALLS オプションは APP_INSTALL および APP_ENGAGEMENTS で利用可能で、サポート対象の MACT パートナー の利用が必要となる場合があります。

Note: 目的に基づくデフォルトがあります。

Type: enum

Possible values: APP_CLICKS, APP_INSTALLS, APP_PURCHASES, ENGAGEMENT, FOLLOWERS, LINK_CLICKS, MAX_REACH, PREROLL, PREROLL_STARTS, REACH_WITH_ENGAGEMENT, VIDEO_VIEW, VIEW_3S_100PCT, VIEW_6S, VIEW_15S, WEBSITE_CONVERSIONS
ios_app_store_identifier
optional		プロモーション対象アプリの Apple App Store 識別子の数値部分。

Note: 目的が APP_INSTALLS または APP_ENGAGEMENTS の場合、android_app_store_identifier と ios_app_store_identifier のいずれか少なくとも一方の設定が必須です。

Type: string

Example: 333903271
name
optional		ラインアイテムの名前。

Type: string

Example: demo
pay_by
optional		このラインアイテムの課金単位。この設定は、目的が APP_INSTALLS のラインアイテムでのみ変更できます。

Note: デフォルトの pay_by は、キャンペーンの目的とラインアイテムの入札単位に基づいて自動的に設定されます。

APP_INSTALLS のゴールは APP_CLICK と IMPRESSION の両方をサポートします。IMPRESSION がデフォルト値です。

LINK_CLICKS のゴールは LINK_CLICK と IMPRESSION の両方をサポートします。IMPRESSION はデフォルト値ですが、bid_strategy を TARGET に設定する場合はサポートされません。

SITE_VISITS のゴールは IMPRESSION をサポートします。

Type: enum

Possible values: APP_CLICK, IMPRESSION, LINK_CLICK
start_time
optional		ラインアイテムの配信が開始される時刻（ISO 8601 形式）。

Type: string

Example: 2017-07-05T00:00:00Z
total_budget_amount_local_micro
optional		ラインアイテムに割り当てる総予算額。指定された資金手段に紐づく通貨が使用されます。USD の場合、$37.50 は 37,500,000 を表します。

Type: long

Example: 37500000
daily_budget_amount_local_micro
optional		キャンペーンに割り当てる日次予算額。指定された資金手段に紐づく通貨が使用されます。USD の場合、$5.50 は 5,500,000 を表します。未指定の場合、キャンペーンは総予算とフライト期間に基づき均等に消化します。親キャンペーンで budget_optimization が LINE_ITEM に設定されている場合にのみ利用可能です。

Note: total_budget_amount_local_micro 以下である必要があります。

Type: long

Example: 5500000
リクエスト例 PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/9cqi0?bid_amount_local_micro=140000 レスポンス例 
    {
      "request": {
        "params": {
          "line_item_id": "9cqi0",
          "bid_amount_local_micro": 140000,
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "advertiser_user_id": "756201191646691328",
        "name": null,
        "placements": [
          "ALL_ON_TWITTER"
        ],
        "start_time": "2017-07-10T00:00:00Z",
        "bid_amount_local_micro": 140000,
        "advertiser_domain": null,
        "target_cpa_local_micro": null,
        "primary_web_event_tag": null,
        "goal": "ENGAGEMENT",
        "daily_budget_amount_local_micro": null,
        "product_type": "PROMOTED_TWEETS",
        "end_time": null,
        "bid_strategy": "MAX",
        "duration_in_days": null,
        "standard_delivery": null,
        "total_budget_amount_local_micro": null,
        "objective": "ENGAGEMENTS",
        "id": "9cqi0",
        "entity_status": "PAUSED",
        "automatic_tweet_promotion": null,
        "frequency_cap": null,
        "android_app_store_identifier": null,
        "categories": [],
        "currency": "USD",
        "pay_by": "ENGAGEMENT",
        "created_at": "2017-07-07T17:42:20Z",
        "ios_app_store_identifier": null,
        "updated_at": "2022-06-03T23:51:36Z",
        "campaign_id": "8yn7m",
        "creative_source": "MANUAL",
        "deleted": false
      }
    }

​
DELETE accounts/:account_id/line_items/:line_item_id

現在のアカウントに属する指定のラインアイテムを削除します。 Note: ラインアイテムの削除は取り消せません。以降、そのリソースを削除しようとすると HTTP 404 が返されます。 Note: ラインアイテムが削除されると、その子である promoted_tweets は、リクエストで with_deleted=true が指定されている場合にのみ、GET accounts/:account_id/promoted_tweets および GET accounts/:account_id/promoted_tweets/:promoted_tweet_id endpoint で返されます。なお、これらの promoted_tweets 自体は削除されません（レスポンスでは "deleted": false）。削除のカスケードは行いません。 Resource URL https://ads-api.x.com/12/accounts/:account_id/line_items/:line_item_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に現れ、GET accounts を除くすべての Advertiser API リクエストで、一般に必須パラメータです。指定されたアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_id
required		リクエストで操作するラインアイテムを参照します。

Type: string

Example: 9f2ix
Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/line_items/9f2ix Example Response 
    {
      "data": {
        "bid_strategy": "MAX",
        "advertiser_user_id": "756201191646691328",
        "name": "Untitled",
        "placements": [],
        "start_time": null,
        "bid_amount_local_micro": 100000,
        "advertiser_domain": null,
        "target_cpa_local_micro": null,
        "primary_web_event_tag": null,
        "pay_by": "ENGAGEMENT",
        "product_type": "PROMOTED_TWEETS",
        "end_time": "2017-07-21T00:00:00Z",
        "duration_in_days": 1,
        "total_budget_amount_local_micro": null,
        "objective": "ENGAGEMENTS",
        "id": "9f2ix",
        "entity_status": "ACTIVE",
        "goal": "ENGAGEMENT",
        "frequency_cap": 5,
        "categories": [],
        "currency": "USD"
        "created_at": "2017-07-14T00:01:50Z",
        "updated_at": "2017-08-09T07:41:08Z",
        "campaign_id": "90r8n",
        "creative_source": "MANUAL",
        "deleted": true
      },
      "request": {
        "params": {
          "line_item_id": "9f2ix",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
ラインアイテムの厳選カテゴリ

詳細な使い方は Video Views Pre-roll Objective Guide を参照してください

​
GET accounts/:account_id/line_item_curated_categories

現在のアカウントに関連付けられているラインアイテムのキュレーション済みカテゴリの詳細を、一部またはすべて取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories Parameters
NameDescription
account_id
required		利用対象のアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
count
optional		リクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
sort_by
optional		サポート対象の属性で、昇順または降順に並べ替えます。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		レスポンス属性 total_count を含めます。

Note: このパラメータと cursor は同時指定できません。

Note: total_count を含むリクエストはレートリミットが低く、現在は 15 分あたり 200 に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/abc1/line_item_curated_categories Example Response 
    {
      "request": {
        "params": {
          "account_id": "abc1"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "by5pw",
          "curated_category_id": "7op29tp2jzeo",
          "id": "1",
          "created_at": "2018-06-29T04:19:53Z",
          "updated_at": "2018-06-29T04:19:53Z",
          "deleted": false
        }
      ]
    }

​
GET accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

現在のアカウントに紐づく特定の Line Item Curated Category の詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id Parameters
NameDescription
account_id
required		利用するアカウントを識別するための ID。リソースパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_curated_category_id
required		リクエストで操作対象の Line Item Curated Category を指す参照 ID。

Type: string

Example: 43853bhii885
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/abc1/line_item_curated_categories/yav Example Response 
    {
      "request": {
        "params": {
          "line_item_curated_category_id": "yav",
          "account_id": "abc1"
        }
      },
      "data": {
        "line_item_id": "by5pw",
        "curated_category_id": "7op29tp2jzeo",
        "id": "yav",
        "created_at": "2018-06-29T04:19:53Z",
        "updated_at": "2018-06-29T04:19:53Z",
        "deleted": false
      }
    }

​
POST accounts/:account_id/line_item_curated_categories

指定したラインアイテムに curated category オブジェクトを関連付けます。 リソース URL https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories パラメータ
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に現れ、GET accounts を除くすべての Advertiser API リクエストで一般に必須のパラメータです。指定されたアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
curated_category_id
required		リクエストで操作対象の curated category エンティティへの参照。

Type: string

Example: 10miy
line_item_id
required		リクエストで操作対象のラインアイテムへの参照。

Type: string

Example: 8v7jo
リクエスト例 POST https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories?line_item_id=iqwka&curated_category_id=9ddrgesiap6o レスポンス例 
    {
      "request": {
        "params": {
          "curated_category_id": "9ddrgesiap6o",
          "line_item_id": "iqwka",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "iqwka",
        "curated_category_id": "9ddrgesiap6o",
        "id": "xq",
        "created_at": "2021-03-30T17:26:42Z",
        "updated_at": "2021-03-30T17:26:42Z",
        "deleted": false
      }
    }

​
PUT accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

指定したラインアイテムのキュレーテッドカテゴリを更新します。 リソース URL https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id パラメータ
NameDescription
account_id
必須		利用するアカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_curated_category_id
必須		リクエストで操作対象となるラインアイテムのキュレーテッドカテゴリを指す参照。

Type: string

Example: 1bzq3
curated_category_id
optional		リクエストで操作対象となるキュレーテッドカテゴリエンティティを指す参照。

Type: string

Example: 10miy
line_item_id
optional		リクエストで操作対象となるラインアイテムを指す参照。

Type: string

Example: 8v7jo
リクエスト例 PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories/xq?curated_category_id=8tujl1p3yn0g レスポンス例 
    {
      "request": {
        "params": {
          "line_item_curated_category_id": "xq",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "iqwka",
        "curated_category_id": "8tujl1p3yn0g",
        "id": "xq",
        "created_at": "2021-03-30T17:26:42Z",
        "updated_at": "2021-03-30T18:22:52Z",
        "deleted": true
      }
    }

​
DELETE accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id

指定したラインアイテムのキュレーテッドカテゴリを削除します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/line_item_curated_categories/:line_item_curated_category_id Parameters
NameDescription
account_id
required		対象アカウントを示す識別子です。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定されたアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_curated_category_id
required		リクエストで操作対象となるラインアイテムのキュレーテッドカテゴリを指す参照です。

Type: string

Example: 1bzq3
Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/line_item_curated_categories/xq Example Response 
    {
      "request": {
        "params": {
          "line_item_curated_category_id": "xq",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "iqwka",
        "curated_category_id": "9ddrgesiap6o",
        "id": "xq",
        "created_at": "2021-03-30T17:26:42Z",
        "updated_at": "2021-03-30T18:22:52Z",
        "deleted": true
      }
    }

​
Line Item の配置先

​
GET line_items/placements

有効な placement と product_type の組み合わせを取得します。 Resource URL https://ads-api.x.com/12/line_items/placements Parameters
NameDescription
product_type
optional		指定した product type に対して有効な placement のみにレスポンスを絞り込みます。

Type: enum

Possible values: MEDIA, PROMOTED_ACCOUNT, PROMOTED_TWEETS
Example Request GET https://ads-api.x.com/12/line_items/placements?product_type=PROMOTED_ACCOUNT Example Response 
    {
      "data": [
        {
          "product_type": "PROMOTED_ACCOUNT",
          "placements": [
            [
              "ALL_ON_TWITTER"
            ],
            [
              "TWITTER_TIMELINE"
            ]
          ]
        }
      ],
      "request": {
        "params": {
          "product_type": "PROMOTED_ACCOUNT"
        }
      }
    }

​
メディアクリエイティブ

​
GET accounts/:account_id/media_creatives

現在のアカウントに関連付けられている一部またはすべてのメディアクリエイティブの詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/media_creatives Parameters
NameDescription
account_id
required		対象アカウントの識別子。これはリソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
campaign_id
optional		指定したキャンペーンに関連付けられたメディアクリエイティブのみにレスポンスを絞り込みます。

Type: string

Example: 8gdx6
count
optional		リクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
line_item_ids
optional		識別子のカンマ区切りリストを指定して、指定したラインアイテムに関連付けられたメディアクリエイティブのみにレスポンスを絞り込みます。ID は最大 200 個まで指定できます。

Type: string

Example: 8v7jo
media_creative_ids
optional		識別子のカンマ区切りリストを指定して、目的のメディアクリエイティブのみにレスポンスを絞り込みます。ID は最大 200 個まで指定できます。

Type: string

Example: 1bzq3
sort_by
optional		サポートされている属性で昇順または降順にソートします。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果をレスポンスに含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		レスポンス属性 total_count を含めます。

Note: このパラメータと cursor は排他的です。

Note: total_count を含むリクエストはレートリミットが低く、現在は 15 分あたり 200 に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives?media_creative_ids=1bzq3 Example Response 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "media_creative_ids": [
            "1bzq3"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "8v7jo",
          "landing_url": "https://dev.x.com",
          "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
          "id": "1bzq3",
          "entity_status": "ACTIVE",
          "created_at": "2017-07-05T06:00:42Z",
          "account_media_id": "10miy",
          "updated_at": "2019-01-11T20:21:26Z",
          "approval_status": "ACCEPTED",
          "deleted": false
        }
      ]
    }

​
GET accounts/:account_id/media_creatives/:media_creative_id

現在のアカウントに関連付けられている特定のメディアクリエイティブの詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/media_creatives/:media_creative_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
media_creative_id
required		リクエストで操作対象とするメディアクリエイティブを参照する識別子。

Type: string

Example: 43853bhii885
with_deleted
optional		削除済みの結果を含めるかどうか。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives/1bzq3 Example Response 
    {
      "request": {
        "params": {
          "media_creative_id": "1bzq3",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8v7jo",
        "landing_url": "https://dev.x.com",
        "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
        "id": "1bzq3",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T06:00:42Z",
        "account_media_id": "10miy",
        "updated_at": "2019-01-11T20:21:26Z",
        "approval_status": "ACCEPTED",
        "deleted": false
      }
    }

​
POST accounts/:account_id/media_creatives

指定したラインアイテムに account media オブジェクトを関連付けます。 この endpoint を使用して、in-stream 広告（account media の creative_type が PREROLL の場合）や、Twitter Audience Platform 上の画像広告（BANNER や INTERSTITIAL など）をプロモーション配信します。 注記: Account Media リソースにメディアアセットを追加するには、POST accounts/:account_id/media_library endpoint を使用してください。 Resource URL https://ads-api.x.com/12/accounts/:account_id/media_creatives Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
account_media_id
required		リクエストで操作する account media エンティティへの参照。

Type: string

Example: 10miy
line_item_id
required		リクエストで操作するラインアイテムへの参照。

Type: string

Example: 8v7jo
landing_url
sometimes required		ユーザーを遷移させるウェブサイトの URL。これは TAP 画像（「display creatives」）でのみ使用してください。preroll アセットと併用した場合、この値は無視されます。preroll アセットに URL を関連付けるには、POST accounts/:account_id/preroll_call_to_actions endpoint を使用してください。

注記: ラインアイテムの objective が WEBSITE_CLICKS に設定されている場合は必須です。

Type: string

Example: https://blog.x.com/
Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives?line_item_id=8v7jo&account_media_id=10miy Example Response 
    {
      "request": {
        "params": {
          "line_item_id": "8v7jo",
          "account_media_id": "10miy",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8v7jo",
        "landing_url": "https://dev.x.com",
        "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
        "id": "1bzq3",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T06:00:42Z",
        "account_media_id": "10miy",
        "updated_at": "2019-01-11T20:21:26Z",
        "approval_status": "ACCEPTED",
        "deleted": false
      }
    }

​
DELETE accounts/:account_id/media_creatives/:media_creative_id

現在のアカウントに属する指定のメディアクリエイティブを削除します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/media_creatives/:media_creative_id Parameters
NameDescription
account_id
required		対象とするアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須です。指定のアカウントは、認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
media_creative_id
required		当該リクエストで操作対象となるメディアクリエイティブを参照する識別子。

Type: string

Example: 1bzq3
Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/media_creatives/1bzq3 Example Response 
    {
      "request": {
        "params": {
          "media_creative_id": "1bzq3",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8v7jo",
        "landing_url": "https://dev.x.com",
        "creative_type": "INTERSTITIAL_LANDSCAPE_TABLET",
        "id": "1bzq3",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T06:00:42Z",
        "account_media_id": "10miy",
        "updated_at": "2021-04-16T21:02:55Z",
        "approval_status": "ACCEPTED"
        "deleted": true
      }
    }

​
プロモアカウント

​
GET accounts/:account_id/promoted_accounts

現在のアカウント配下の1つ以上のラインアイテムに関連付けられた、対象またはすべてのプロモーテッドアカウントの詳細を取得します。 レスポンスで user_id によって識別されるユーザーアカウントのユーザーデータを取得するには、GET users/lookup を使用してください。 指定したラインアイテムのいずれもプロモーテッドアカウントを含むように設定されていない場合は、HTTP 400 が返されます。 Resource URL https://ads-api.x.com/12/accounts/:account_id/promoted_accounts Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に現れ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
count
optional		リクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次の結果ページを取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
line_item_ids
optional		識別子のカンマ区切りリストを指定して、指定したラインアイテムに関連付けられたプロモーテッドアカウントのみにレスポンスを絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 9bpb2
promoted_account_ids
optional		識別子のカンマ区切りリストを指定して、目的のプロモーテッドアカウントのみにレスポンスを絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 19pl2
sort_by
optional		サポート対象の属性で昇順または降順に並べ替えます。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果をレスポンスに含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		total_count レスポンス属性を含めます。

Note: このパラメータと cursor は相互排他です。

Note: total_count を含むリクエストはレートリミットが低く、現在は 15 分あたり 200 に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts?promoted_account_ids=19pl2 Example Response 
    {
      "request": {
        "params": {
          "promoted_account_ids": [
            "19pl2"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "9bpb2",
          "user_id": "756201191646691328",
          "id": "19pl2",
          "entity_status": "ACTIVE",
          "created_at": "2017-07-05T05:54:13Z",
          "updated_at": "2017-07-05T05:54:13Z",
          "approval_status": "ACCEPTED",
          "deleted": false
        }
      ]
    }

​
GET accounts/:account_id/promoted_accounts/:promoted_account_id

現在のアカウント配下のラインアイテムに関連付けられたアカウントへの特定の参照を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/promoted_accounts/:promoted_account_id Parameters
NameDescription
account_id
required		利用するアカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
promoted_account_id
required		リクエストで操作するプロモート対象アカウントを指す参照。

Type: string

Example: 19pl2
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2 Example Response 
    {
      "request": {
        "params": {
          "promoted_account_id": "19pl2",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "9bpb2",
        "user_id": "756201191646691328",
        "id": "19pl2",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T05:54:13Z",
        "updated_at": "2017-07-05T05:54:13Z",
        "approval_status": "ACCEPTED"
        "deleted": false
      }
    }

​
POST accounts/:account_id/promoted_accounts

指定したラインアイテムにアカウント（user_id）を関連付けます。 指定のラインアイテムがPromoted Accountsに対応する設定になっていない場合、HTTP 400 INCOMPATIBLE_LINE_ITEM エラーが返されます。指定のユーザーがプロモーション対象外の場合はHTTP 400が返され、いずれのユーザーもプロモートされません。指定のユーザーが既にプロモート済みの場合、このリクエストは無視されます。 Promoted Accountsの詳細は、campaign management ページを参照してください。 注: promoted accountsエンティティは更新（PUT）できません。 Resource URL https://ads-api.x.com/12/accounts/:account_id/promoted_accounts Parameters
NameDescription
account_id
required		利用するアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべてのAdvertiser APIリクエストで一般的に必須です。指定のアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_id
required		リクエストで操作対象のラインアイテムへの参照。

Type: string

Example: 9bpb2
user_id
required		リクエストで操作対象のユーザーへの参照。スクリーンネームからユーザーIDを取得するには、GET users/lookup を使用します。

Type: long

Example: 756201191646691328
Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts?line_item_id=9bpb2&user_id=756201191646691328 Example Response 
    {
      "data": {
        "line_item_id": "9bpb2",
        "user_id": "756201191646691328",
        "id": "19pl2",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T05:54:13Z",
        "updated_at": "2017-07-05T05:54:13Z",
        "approval_status": "ACCEPTED"
        "deleted": false
      },
      "request": {
        "params": {
          "user_id": "756201191646691328",
          "line_item_id": "9bpb2",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
DELETE accounts/:account_id/promoted_accounts/:promoted_account_id

指定したラインアイテムからアカウントの関連付けを解除します。 リソース URL https://ads-api.x.com/12/accounts/:account_id/promoted_accounts/:promoted_account_id パラメータ
NameDescription
account_id
必須		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
promoted_account_id
必須		ラインアイテムに関連付けられた Promoted Account のインスタンスを指す識別子。

Type: string

Example: 19pl2
リクエスト例 DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_accounts/19pl2 レスポンス例 
    {
      "data": {
        "line_item_id": "9bpb2",
        "user_id": "756201191646691328",
        "id": "19pl2",
        "entity_status": "ACTIVE",
        "created_at": "2017-07-05T05:54:13Z",
        "updated_at": "2017-08-23T18:53:15Z",
        "approval_status": "ACCEPTED"
        "deleted": true
      },
      "request": {
        "params": {
          "promoted_account_id": "19pl2",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
GET accounts/:account_id/promoted_tweets

現在のアカウントのラインアイテムに関連付けられた Tweet 参照を取得します。 GET accounts/:account_id/tweets endpoint を使用して Tweet オブジェクトを取得します。各 promoted_tweets オブジェクトの tweet_id 値を使用してください。 注記: 親ラインアイテムが削除されている場合、promoted_tweets はリクエストで with_deleted=true が指定されているときにのみ返されます。なお、これらの promoted_tweets 自体は実際には削除されていません（レスポンスでは "deleted": false）。 Resource URL https://ads-api.x.com/12/accounts/:account_id/promoted_tweets Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
count
optional		個々のリクエストで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳しくは Pagination を参照してください。

Type: string

Example: 8x7v00oow
line_item_ids
optional		カンマ区切りの識別子リストを指定して、特定のラインアイテムに関連付けられた Tweet のみにレスポンスを絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 96uzp
promoted_tweet_ids
optional		カンマ区切りの識別子リストを指定して、目的のプロモートされた Tweet のみにレスポンスを絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 1efwlo
sort_by
optional		サポート対象の属性で昇順または降順にソートします。詳しくは Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果をレスポンスに含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		レスポンスに total_count 属性を含めます。

注記: このパラメータと cursor は同時に使用できません。

注記: total_count を含むリクエストはレートリミットが低く、現在は 15 分あたり 200 に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets?promoted_tweet_ids=1efwlo Example Response 
    {
      "request": {
        "params": {
          "promoted_tweet_ids": [
            "1efwlo"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "96uzp",
          "id": "1efwlo",
          "entity_status": "ACTIVE",
          "created_at": "2017-06-29T05:06:57Z",
          "updated_at": "2017-06-29T05:08:46Z",
          "approval_status": "ACCEPTED",
          "tweet_id": "880290790664060928",
          "deleted": false
        }
      ]
    }

​
GET accounts/:account_id/promoted_tweets/:promoted_tweet_id

現在のアカウントにおけるラインアイテムに関連付けられた特定のTweet参照を取得します。 注意: 親ラインアイテムが削除されている場合、promoted_tweets はリクエストで with_deleted=true が指定されているときにのみ返されます。なお、これらの promoted_tweets 自体は実際には削除されていません（レスポンスでは "deleted": false ）。 Resource URL https://ads-api.x.com/12/accounts/:account_id/promoted_tweets/:promoted_tweet_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
promoted_tweet_id
required		本リクエストで操作対象となるプロモートTweetへの参照。

Type: string

Example: 1efwlo
with_deleted
optional		削除済みの結果を含めるかどうか。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets/1efwlo Example Response 
    {
      "request": {
        "params": {
          "promoted_tweet_id": "1efwlo",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "96uzp",
        "id": "1efwlo",
        "entity_status": "ACTIVE",
        "created_at": "2017-06-29T05:06:57Z",
        "updated_at": "2017-06-29T05:08:46Z",
        "approval_status": "ACCEPTED",
        "tweet_id": "880290790664060928",
        "deleted": false
      }
    }

​
POST accounts/:account_id/promoted_tweets

指定したラインアイテムに1つ以上のTweetを関連付けます。キャンペーンの目的によっては、すべてのTweetがプロモーションに適するとは限りません。詳細は Objective-based Campaigns を参照してください。 PROMOTED_ACCOUNT の製品タイプを使用する場合、line_item にTweetを関連付けると、標準の PROMOTED_ACCOUNT プレースメントに加えて、モバイルのタイムラインプレースメントが追加されます。 注意: プロモーテッドTweetエンティティを更新（PUT）することはできません。 Resource URL https://ads-api.x.com/12/accounts/:account_id/promoted_tweets Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_id
required		リクエストで操作対象のラインアイテムを参照します。

Type: string

Example: 8v7jo
tweet_ids
required		特定のTweetに対応する識別子のカンマ区切りリスト。最大50個のIDを指定できます。

Type: long

Example: 822333526255120384
Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets?line_item_id=8v7jo&tweet_ids=822333526255120384 Example Response 
    {
      "data": [
        {
          "line_item_id": "8v7jo",
          "id": "1e8i2k",
          "entity_status": "ACTIVE",
          "created_at": "2017-06-24T04:21:36Z",
          "updated_at": "2017-06-24T04:21:36Z",
          "approval_status": "ACCEPTED",
          "tweet_id": "822333526255120384",
          "deleted": false
        }
      ],
      "request": {
        "params": {
          "line_item_id": "8v7jo",
          "tweet_ids": [
            822333526255120384
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "total_count": 1
    }

​
DELETE accounts/:account_id/promoted_tweets/:promoted_tweet_id

指定したラインアイテムから Tweet の関連付けを解除します。 注記: 削除された promoted_tweets エンティティは ads.x.com の UI で「一時停止中」と表示されます。同様に、UI から「一時停止」すると、そのラインアイテムとの関連付けが解除されます。 Resource URL https://ads-api.x.com/12/accounts/:account_id/promoted_tweets/:promoted_tweet_id Parameters
NameDescription
account_id
required		利用対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
promoted_tweet_id
required		ラインアイテムに関連付けられた Promoted Tweet のインスタンスを指す識別子。対象の Tweet の tweet_id ではなく、GET accounts/:account_id/promoted_tweets のレスポンス項目に含まれる id フィールドから取得します。リソースのパスに含めて指定します。

Type: string

Example: 1gp8a5
Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/promoted_tweets/1gp8a5 Example Response 
    {
      "data": {
        "line_item_id": "9pl99",
        "id": "1gp8a5",
        "entity_status": "ACTIVE",
        "created_at": "2017-08-17T17:02:21Z",
        "updated_at": "2017-08-18T06:43:48Z",
        "approval_status": "ACCEPTED",
        "tweet_id": "844796297743757315",
        "deleted": true
      },
      "request": {
        "params": {
          "promoted_tweet_id": "1gp8a5",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
プロモーション対象ユーザー

​
GET accounts/:account_id/promotable_users

現在のアカウントに関連付けられているプロモート可能ユーザーの一部またはすべての詳細を取得します。 プロモート可能ユーザーの種類は FULL または RETWEETS_ONLY です。これは、そのアカウントでプロモーションできるコンテンツの種類を制御します。広告主が他ユーザーのコンテンツをプロモーションするには許可が必要であり、RETWEETS_ONLY のプロモート可能ユーザーとしてあなたのアカウントに追加してもらうために Twitter に連絡する必要があります。 権限が正しく設定されていれば、プロモーション用プロダクトの endpoint に対し、プロモートしたい Tweet の Tweet ID を直接参照するリクエストを行うことができます。公開済みの Tweet をプロモーションするには POST accounts/:account_id/promoted-tweets endpoint を、他の Twitter Ads アカウントの Scheduled Tweets をプロモーションするには POST accounts/:account_id/scheduled-promoted-tweets endpoint を使用できます。 対象の Tweet をリツイートする必要はありません。この方法で Tweet をプロモーションすると、返される tweet_id は提供した Tweet ID と異なります。内部的には、その Tweet は nullcast された Tweet としてリツイートされ、その後プロモーションされます。返される tweet_id はこの新しい Tweet を指します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/promotable_users Parameters
名前説明
account_id
required		利用するアカウントの識別子。リソースのパス内に現れ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
count
optional		各リクエストで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
promotable_user_ids
optional		識別子のカンマ区切りリストを指定して、レスポンスを目的のプロモート可能ユーザーのみに絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: l310s
sort_by
optional		サポートされている属性で昇順または降順にソートします。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果をレスポンスに含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		レスポンス属性 total_count を含めます。

Note: このパラメータと cursor は同時指定できません。

Note: total_count を含むリクエストはレートリミットが低く、現在は 15 分あたり 200 に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promotable_users?promotable_user_ids=l310s Example Response 
    {
      "request": {
        "params": {
          "promotable_user_ids": [
            "l310s"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "user_id": "756201191646691328",
          "id": "l310s",
          "created_at": "2016-07-21T22:42:09Z",
          "updated_at": "2016-07-21T22:42:09Z",
          "deleted": false,
          "promotable_user_type": "FULL"
        }
      ]
    }

​
GET accounts/:account_id/promotable_users/:promotable_user_id

現在のアカウントに関連付けられている特定のプロモーション対象ユーザーを取得します。 プロモーション対象ユーザーのタイプは FULL または RETWEETS_ONLY のいずれかです。これは、そのアカウントでプロモーション可能なコンテンツの種類を制御します。 広告主は、他のユーザーのコンテンツをプロモーションするための許可を取得する必要があります。権限が適切に設定されていれば、プロモーションしたい Tweet の Tweet ID を直接参照する、プロモーション用プロダクトの endpoint にリクエストできます。 対象の Tweet をリツイートする必要はありません。この方法で Tweet をプロモーションすると、返される tweet_id は指定した Tweet ID と異なります。内部的には、その Tweet は nullcast された Tweet としてリツイートされた後にプロモーションされます。返される tweet_id はこの新しい Tweet に対応します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/promotable_users/:promotable_user_id Parameters
NameDescription
account_id
required		参照されるアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定されたアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
promotable_user_id
optional		リクエストで操作対象としているプロモーション対象ユーザーへの参照。

Type: string

Example: l310s
with_deleted
optional		削除済みの結果をレスポンスに含めます。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/promotable_users/l310s Example Response 
    {
      "request": {
        "params": {
          "promotable_user_id": "l310s",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "user_id": "2417045708",
        "id": "l310s",
        "created_at": "2017-03-10T17:51:24Z",
        "updated_at": "2017-03-10T17:51:24Z",
        "deleted": false,
        "promotable_user_type": "RETWEETS_ONLY"
      }
    }

​
パブリッシャー

​
GET publishers

コンテンツカテゴリのパブリッシャーの詳細リストを取得します 詳細はVideo Views Preroll Objective Guideをご参照ください Resource URL https://ads-api.x.com/12/publishers Parameters リクエストパラメータはありません Example Request GET https://ads-api.x.com/12/publishers Example Response 
{
      "request": {
        "params": {}
      },
      "next_cursor": null,
      "data": [
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "PeoplesSports",
          "user_id": "1353868435021721602",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "JP"
          ],
          "username": "NewYork_Jack",
          "user_id": "1331177123436851206",
          "monetization_restricted": true,
          "content_category_ids": [
            "sk"
          ]
        },
        {
          "monetizable_country_codes": [
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "JP"
          ],
          "username": "twispatv",
          "user_id": "1331165719128461314",
          "monetization_restricted": true,
          "content_category_ids": [
            "sm"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "LAThieves",
          "user_id": "1316808678897455105",
          "monetization_restricted": true,
          "content_category_ids": [
            "s0"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "Quicktake_EE",
          "user_id": "1305900477427724290",
          "monetization_restricted": true,
          "content_category_ids": [
            "sr"
          ]
        },
        {
          "monetizable_country_codes": [
            "BR"
          ],
          "promotion_eligible_country_codes": [
            "BR"
          ],
          "username": "eufloribella",
          "user_id": "1300812459054436354",
          "monetization_restricted": true,
          "content_category_ids": [
            "sm"
          ]
        },
        {
          "monetizable_country_codes": [
            "EG"
          ],
          "promotion_eligible_country_codes": [
            "KW",
            "EG",
            "SA",
            "AE",
            "LB",
            "QA"
          ],
          "username": "Egypt2021EN",
          "user_id": "1296077573399678977",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "ClubShayShay",
          "user_id": "1283068366706454529",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "IN",
            "KW",
            "ID",
            "EG",
            "SG",
            "TH",
            "MY",
            "PH",
            "ES",
            "US",
            "AU",
            "SA",
            "AE",
            "LB",
            "GB",
            "FR",
            "KR",
            "BR",
            "MX",
            "QA",
            "CA",
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "KW",
            "EG",
            "SA",
            "AE",
            "LB",
            "QA"
          ],
          "username": "hiaahsanshow",
          "user_id": "1253421442143641601",
          "monetization_restricted": false,
          "content_category_ids": [
            "sh"
          ]
        },
        {
          "monetizable_country_codes": [
            "TH"
          ],
          "promotion_eligible_country_codes": [
            "TH"
          ],
          "username": "HoneKrasae",
          "user_id": "1240684293719904256",
          "monetization_restricted": true,
          "content_category_ids": [
            "sr"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "Sportskind",
          "user_id": "1232708694418300930",
          "monetization_restricted": true,
          "content_category_ids": [
            "se"
          ]
        },
        {
          "monetizable_country_codes": [
            "IN",
            "KW",
            "ID",
            "EG",
            "SG",
            "TH",
            "MY",
            "PH",
            "ES",
            "US",
            "AU",
            "SA",
            "AE",
            "LB",
            "GB",
            "FR",
            "KR",
            "BR",
            "MX",
            "QA",
            "CA",
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "KW",
            "EG",
            "SA",
            "AE",
            "LB",
            "QA"
          ],
          "username": "almeerathShow",
          "user_id": "1229410512762437633",
          "monetization_restricted": false,
          "content_category_ids": [
            "sh"
          ]
        },
        {
          "monetizable_country_codes": [
            "US"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "SeeYourVoiceFOX",
          "user_id": "1225490734653947904",
          "monetization_restricted": true,
          "content_category_ids": [
            "sh"
          ]
        },
        {
          "monetizable_country_codes": [
            "IN",
            "KW",
            "ID",
            "EG",
            "SG",
            "TH",
            "MY",
            "PH",
            "ES",
            "US",
            "AU",
            "SA",
            "AE",
            "LB",
            "GB",
            "FR",
            "KR",
            "BR",
            "MX",
            "QA",
            "CA",
            "JP"
          ],
          "promotion_eligible_country_codes": [
            "US"
          ],
          "username": "AUProSports",
          "user_id": "1219303449768185859",
          "monetization_restricted": false,
          "content_category_ids": [
            "se"
          ]
        }
      ]
    }

​
推奨事項

​
GET accounts/:account_id/recommendations

ステータス: クローズドベータ この広告アカウントに紐づくキャンペーン推奨を取得します。現在、資金手段（Funding Instrument）ごとに推奨は1件までに制限されています。 Resource URL https://ads-api.x.com/5/accounts/:account_id/recommendations Parameters
NameDescription
account_id
必須		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般に必須のパラメータです。指定したアカウントは、認証済みユーザーに関連付けられている必要があります。

Type: string

例: 18ce54d4x5t
Example Request GET https://ads-api.x.com/5/accounts/18ce54d4x5t/recommendations Example Response 
    "request": {
      "params": {
        "account_id": "18ce54d4x5t"
      }
    },
    "total_count": 1,
    "data": [
      {
        "funding_instrument_id": "gpvzb",
        "id": "62ce8zza1q0w",
        "account_id": "18ce54d4x5t",
        "status": "PENDING",
        "message": "テスト用の推奨"
        "created_at": "2016-11-14T23:07:54Z",
        "updated_at": "2016-11-14T23:07:54Z"
      }
    ]

​
GET accounts/:account_id/recommendations/:recommendation_id

ステータス: クローズドベータ この広告アカウントに関連付けられた特定のキャンペーン推奨を取得します。 キャンペーン推奨には、オブジェクトツリーとして表現されるキャンペーン構成に対して提案された変更一式が含まれます。レスポンスのツリーは Batch API の endpoint と連携して動作することを意図していますが、必要に応じて単一の更新 endpoint にマッピングすることもできます（作成は POST、更新は PUT、削除は DELETE）。 リソース URL https://ads-api.x.com/5/accounts/:account_id/recommendations/:recommendation_id パラメータ
NameDescription
account_id
必須		対象となるアカウントの識別子。リソースのパス内に現れ、GET accounts を除くすべての Advertiser API リクエストで一般に必須のパラメータです。指定されたアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
recommendation_id
必須		本リクエストで操作対象となる推奨の ID を参照します。

Type: string

Example: 62ce8zza1q0w
リクエスト例 GET https://ads-api.x.com/5/accounts/18ce54d4x5t/recommendations/62ce8zza1q0w レスポンス例 
{
    "request": {
      "params": {
        "recommendation_id": "62ce8zza1q0w",
        "account_id": "18ce54d4x5t"
      }
    },
    "data_type": "recommendations",
      "data": {
      "changes": [
        {
          "entity_type": "campaigns",
          "params": {
            "start_time": "2016-11-08T22:00:00Z",
            "daily_budget_amount_local_micro": 2200000,
            "end_time": "2016-11-16T07:59:00Z",
            "total_budget_amount_local_micro": 12000000,
            "id": "64m0d"
          },
          "operation_type": "Update",
          "dependent_entities": [
            {
              "entity_type": "line_items",
              "params": {
                "name": "推奨用キャンペーン",
                "placements": [
                  "TWITTER_TIMELINE"
                ],
                "bid_amount_local_micro": 1430000,
                "id": "6f5kq",
                "include_sentiment": "ALL"
              },
              "operation_type": "Update",
              "dependent_entities": [
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "id": "a8po6p"
                  },
                  "operation_type": null,
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "election results",
                    "targeting_value": "election results",
                    "targeting_type": "PHRASE_KEYWORD"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "id": "101ftp"
                  },
                  "operation_type": "Delete",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "男性",
                    "targeting_value": 1,
                    "targeting_type": "GENDER"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "San Francisco–Oakland–San Jose CA, US",
                    "targeting_value": "",
                    "targeting_type": "LOCATION"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "id": "101fto"
                  },
                  "operation_type": "Delete",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "line_item_id": "6f5kq",
                    "display_properties": [],
                    "paused": false,
                    "approval_status": "ACCEPTED",
                    "tweet_id": "91125952589766656"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "パートナーオーディエンスターゲティング",
                    "targeting_value": "v2cx",
                    "targeting_type": "NEGATIVE_BEHAVIOR"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "AGE_21_TO_34",
                    "targeting_value": "AGE_21_TO_34",
                    "targeting_type": "AGE"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "id": "a8po6o"
                  },
                  "operation_type": "Delete",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "line_item_id": "6f5kq",
                    "display_properties": [],
                    "paused": false,
                    "approval_status": "ACCEPTED",
                    "tweet_id": "991101965843460096"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "line_item_id": "6f5kq",
                    "display_properties": [],
                    "paused": false,
                    "approval_status": "ACCEPTED",
                    "tweet_id": "991127212156096516"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "debate",
                    "targeting_value": "debate",
                    "targeting_type": "NEGATIVE_PHRASE_KEYWORD"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "line_item_id": "6f5kq",
                    "name": "60004, IL, US",
                    "targeting_value": "",
                    "targeting_type": "LOCATION"
                  },
                  "operation_type": "Create",
                  "dependent_entities": []
                },
                {
                  "entity_type": "targeting_criteria",
                  "params": {
                    "id": "a8po6n"
                  },
                  "operation_type": null,
                  "dependent_entities": []
                },
                {
                  "entity_type": "promoted_tweets",
                  "params": {
                    "id": "101ftn"
                  },
                  "operation_type": null,
                  "dependent_entities": []
                }
              ]
            }
          ]
        }
      ],
      "funding_instrument_id": "gpvzb",
      "id": "62ce8zza1q0w",
      "account_id": "18ce54d4x5t",
      "status": "PENDING",
      "message": "テスト用の推奨"
      "created_at": "2016-11-14T23:07:54Z",
      "updated_at": "2016-11-14T23:07:54Z"
      }
    }

​
予約済みのプロモツイート

​
GET accounts/:account_id/scheduled_promoted_tweets

現在のアカウントに関連付けられている、予約されたプロモーション済みTweetの一部またはすべての詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
count
optional		個別のリクエストあたりで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
line_item_ids
optional		識別子をカンマ区切りで指定することで、特定のラインアイテムに関連付けられた予約済みTweetのみにレスポンスを絞り込みます。最大200個のIDを指定できます。

Type: string

Example: 8xdpe
scheduled_promoted_tweet_ids
optional		識別子をカンマ区切りで指定することで、目的の予約されたプロモーション済みTweetのみにレスポンスを絞り込みます。最大200個のIDを指定できます。

Type: string

Example: 1xboq
sort_by
optional		サポートされている属性で昇順または降順にソートします。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		レスポンス属性 total_count を含めます。

Note: このパラメータと cursor は同時指定できません。

Note: total_count を含むリクエストには、現在15分あたり200に設定されたより低いレートリミットが適用されます。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets?scheduled_promoted_tweet_ids=1xboq Example Response 
    {
      "request": {
        "params": {
          "scheduled_promoted_tweet_ids": [
            "1xboq"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "8xdpe",
          "id": "1xboq",
          "created_at": "2017-06-01T19:53:32Z",
          "updated_at": "2017-06-01T20:00:06Z",
          "scheduled_tweet_id": "870366669373194240",
          "tweet_id": "870369382207070208",
          "deleted": false
        }
      ]
    }

​
GET accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id

現在のアカウントに関連付けられた特定のスケジュール済みプロモーテッドTweetを取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id Parameters
NameDescription
account_id
required		利用するアカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
scheduled_promoted_tweet_id
required		リクエストで操作対象となるスケジュール済みプロモーテッドTweetの参照。

Type: string

Example: 1xboq
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xboq Example Response 
    {
      "request": {
        "params": {
          "scheduled_promoted_tweet_id": "1xboq",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "8xdpe",
        "id": "1xboq",
        "created_at": "2017-06-01T19:53:32Z",
        "updated_at": "2017-06-01T20:00:06Z",
        "scheduled_tweet_id": "870366669373194240",
        "tweet_id": "870369382207070208",
        "deleted": false
      }
    }

​
POST accounts/:account_id/scheduled_promoted_tweets

スケジュール済みの Tweet を指定したラインアイテムに関連付けます。 注記: スケジュール済みのプロモーション用 Tweet エンティティは更新（PUT）できません。 Resource URL https://ads-api.x.com/12/accounts/:account_id/scheduled_promoted_tweets Parameters
NameDescription
account_id
required		利用中のアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般に必須のパラメータです。指定されたアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_id
required		リクエストで操作対象のラインアイテムを参照します。

Type: string

Example: 8xdpe
scheduled_tweet_id
required		リクエストで操作対象のスケジュール済み Tweet を参照します。

Type: long

Example: 870358555227860992
Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets?line_item_id=8xdpe&scheduled_tweet_id=870358555227860992 Example Response 
    {
      "data": {
        "line_item_id": "8xdpe",
        "id": "1xtfl",
        "created_at": "2017-06-08T07:25:26Z",
        "updated_at": "2017-06-08T07:25:26Z",
        "scheduled_tweet_id": "870358555227860992",
        "tweet_id": null,
        "deleted": false
      },
      "request": {
        "params": {
          "line_item_id": "8xdpe",
          "scheduled_tweet_id": 870358555227860992,
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
DELETE accounts/:account_id/scheduled_promoted_tweets/:scheduled_promoted_tweet_id

指定したラインアイテムから、予約済みの Tweet の関連付けを解除します。 注記: scheduled_promoted_tweets は、予約済みの Tweet の scheduled_at 時刻より前にのみ DELETE できます。 Resource URL https://ads-api.x.com/12/accounts/:account_id/scheduled_tweets/:scheduled_tweet_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
scheduled_promoted_tweet_id
required		リクエストで操作する予約済みプロモート Tweet を参照します。これは GET accounts/:account_id/scheduled_promoted_tweets のレスポンスオブジェクトに含まれる id 属性です。

Type: string

Example: 1xtfl
Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/scheduled_promoted_tweets/1xtfl Example Response 
    {
      "data": {
        "line_item_id": "8xdpe",
        "id": "1xtfl",
        "created_at": "2017-06-08T07:25:26Z",
        "updated_at": "2017-06-15T05:14:12Z",
        "scheduled_tweet_id": "870358555227860992",
        "tweet_id": null,
        "deleted": true
      },
      "request": {
        "params": {
          "scheduled_promoted_tweet_id": "1xtfl",
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
ターゲティング条件

​
GET accounts/:account_id/targeting_criteria

現在のアカウントの配下にあるラインアイテムに関連付けられたターゲティング条件の一部またはすべての詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/targeting_criteria Parameters
NameDescription
account_id
required		利用するアカウントの識別子。リソースのパス内に現れ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_ids
required		識別子のカンマ区切りリストを指定して、指定したラインアイテム配下のターゲティング条件のみにレスポンスを絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 8u94t
count
optional		個々のリクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳しくは Pagination を参照してください。

Type: string

Example: 8x7v00oow
lang
optional		ISO-639-1 言語コード。指定すると、ローカライズ名が利用可能なオブジェクトについて、レスポンスに追加の localized_name 属性が返されます。

Type: string

Example: fr
sort_by
optional		サポートされている属性で昇順または降順にソートします。詳しくは Sorting を参照してください。

Type: string

Example: created_at-asc
targeting_criterion_ids
optional		識別子のカンマ区切りリストを指定して、目的のターゲティング条件のみにレスポンスを絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: dpl3a6
with_deleted
optional		削除済みの結果をレスポンスに含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		total_count レスポンス属性を含めます。

Note: このパラメータと cursor は相互排他です。

Note: total_count を含むリクエストはレートリミットが低く、現在は 15 分あたり 200 に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria?line_item_ids=8u94t Example Response 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "line_item_ids": [
            "8u94t"
          ]
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "8u94t",
          "name": "カスタムオーディエンスターゲティング",
          "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

現在のアカウントに紐づく特定のターゲティング条件を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/targeting_criteria/:targeting_criterion_id Parameters
NameDescription
account_id
required		対象となるアカウントの識別子。リソースのパスに含まれ、GET accounts を除くほぼすべての Advertiser API リクエストで必須です。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
targeting_criterion_id
required		このリクエストで操作対象となるターゲティング条件を指す参照。

Type: string

Example: eijd4y
lang
optional		ISO-639-1 の言語コード。指定すると、ローカライズ名があるオブジェクトについてはレスポンスに追加の localized_name 属性が返されます。

Type: string

Example: fr
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria/eijd4y Example Response 
    {
      "request": {
        "params": {
          "targeting_criterion_id": "eijd4y",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "619jl",
        "name": "🤖",
        "id": "eijd4y",
        "作成日時": "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は、Targeting Optionsページを参照してください。常に最新のターゲティングタイプ値を使用できるよう、すべてのデータを毎週更新することを推奨します。値および利用可能なターゲティング条件は適宜変更されます。大半は頻繁には変わりませんが、一部は変わることがあります。これらの値が変更されないことは保証できません。 targeting_valueで指定したキーワードを用いて、BROAD_KEYWORD、EXACT_KEYWORD、PHRASE_KEYWORD、またはUNORDERED_KEYWORDのターゲティングタイプを使用します。キーワードを除外するには、operator_typeリクエストパラメータをNEに設定します。各タイプの詳細はtargeting keyword typesを参照してください。 Note: 1つのラインアイテムにつきターゲットにできるAGEバケットは1つのみです。 Note: Custom Audienceをターゲットにするには、そのオーディエンスがターゲット可能である必要があります。つまり、targerableがtrueであることが_必須_です。 Note: ターゲティングタイプTV_SHOWを使用する場合、TV_SHOWターゲティングを設定する前に、そのラインアイテムに少なくとも1つのLOCATIONターゲティング条件が存在し、かつすべてのLOCATIONがターゲットとするTV_SHOWと同一のロケール内である必要があります。 Resource URL https://ads-api.x.com/12/accounts/:account_id/targeting_criteria Parameters
NameDescription
account_id
required		使用するアカウントの識別子。リソースのパス内に現れ、GET accountsを除くすべてのAdvertiser APIリクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_id
required		リクエストで操作対象となるラインアイテムへの参照。

Type: string

Example: 69ob
operator_type
required		ターゲティング条件が持つべき関係を指定します。たとえば、キーワードを除外するにはoperator_type=NEを使用します。

Type: enum

Possible values: EQ, NE, GTE, LT
targeting_type
required		このラインアイテムに適用するターゲティングのタイプ。

キーワード以外の可能な値: AGE、DEVICE、EVENT、CAMPAIGN_ENGAGEMENT、CAMPAIGN_ENGAGEMENT_LOOKALIKE、CONVERSATION、ENGAGEMENT_TYPE、FOLLOWERS_OF_USER、GENDER、INTEREST、LANGUAGE、LIVE_TV_EVENT、LOCATION、NETWORK_ACTIVATION_DURATION、NETWORK_OPERATOR、PLATFORM、PLATFORM_VERSION、SIMILAR_TO_FOLLOWERS_OF_USER、TV_SHOW、USER_ENGAGEMENT、USER_ENGAGEMENT_LOOKALIKE、WIFI_ONLY

Note: 1つのラインアイテムにつきターゲットにできるAGEバケットは1つのみです。

キーワードベースの可能な値: BROAD_KEYWORD、EXACT_KEYWORD、PHRASE_KEYWORD、UNORDERED_KEYWORD

Custom Audienceの可能な値: CUSTOM_AUDIENCE、CUSTOM_AUDIENCE_EXPANDED

インストール済みアプリのストアカテゴリの可能な値: APP_STORE_CATEGORY、APP_STORE_CATEGORY_LOOKALIKE

Twitter Audience Platform (TAP) のアプリ除外の可能な値: APP_LIST（operator_type=NEの場合のみ使用可）
targeting_value
required		選択したtargeting_typeに応じて、このターゲティングを適用するユーザー、関心、ロケーション、イベント、プラットフォーム、プラットフォームバージョン、デバイス、キーワードまたはフレーズ、性別、Custom Audience、アプリストアカテゴリ、またはアプリリストの除外を指定します。

Type: string

Example: 174958347
Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria?line_item_id=619jl&targeting_type=BROAD_KEYWORD&targeting_value=technology レスポンスの例 
    {
      "data": {
        "line_item_id": "619jl",
        "name": "technology",
        "id": "fbyjlr",
        "作成日時": "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

単一のリクエストで新規の Targeting Criteria を一括作成できます。 バッチリクエスト
  • 現在の最大バッチサイズは 500 です。
  • すべてのパラメータはリクエスト本文で送信され、Content-Type は application/json が必須です。
  • バッチリクエストはグループ単位で一括して成功または失敗し、エラー・成功いずれの API レスポンスでも初回リクエストの項目順序が保持されます。
バッチレスポンス バッチ API レスポンスは順序付きの項目コレクションを返します。それ以外は、対応する単一項目の endpoint と構造が同一です。 バッチエラー
  • リクエストレベルのエラー（例：最大バッチサイズ超過）は、レスポンスの errors オブジェクトで示されます。
  • アイテムレベルのエラー（例：必須の Targeting Criteria パラメータの欠落）は、レスポンスの operation_errors オブジェクトで示されます。
Resource URL https://ads-api.x.com/12/batch/accounts/:account_id/targeting_criteria Parameters
NameDescription
operation_type
required		各項目に対して実行する操作の種類。

Type: enum

Possible values: Create, Delete
params
required		ターゲティング基準オブジェクトのすべてのパラメータを含む JSON オブジェクト。必須および任意パラメータの一覧はこちらを参照してください。

また、この endpoint は特定の targeting_type 値と組み合わせて使用する operator_type パラメータをサポートします。このパラメータの取り得る値は、等しいを表す EQ、以上を表す GTE、未満を表す LT、等しくないを表す NE です。
Example Request POST https://ads-api.x.com/12/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

現在のアカウントに属する指定のターゲティング条件を削除します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/targeting_criteria/:targeting_criterion_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
targeting_criterion_id
required		当該リクエストで操作対象となるターゲティング条件を参照します。

Type: string

Example: dpl3a6
Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_criteria/dpl3a6 Example Response 
    {
      "data": {
        "line_item_id": "8u94t",
        "name": "カスタムオーディエンスターゲティング",
        "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"
        }
      }
    }

​
ターゲティングオプション

​
GET targeting_criteria/app_store_categories

Promoted Products向けに利用可能な、アプリストアのカテゴリに基づくターゲティング条件を確認します。アプリストアのカテゴリは、iOS App Store と Google Play ストアでのみ利用可能です。 インストール済みアプリのカテゴリターゲティングでは、ユーザーがインストールした、または興味関心を示したアプリのカテゴリに基づいてターゲティングできます。 Resource URL https://ads-api.x.com/12/targeting_criteria/app_store_categories Parameters
NameDescription
q
optional		ターゲティング条件の範囲を絞り込むための任意の query。すべてを取得する場合は、このパラメータを省略します。

Type: string

Example: music
os_type
optional		特定のアプリストアで結果を絞り込みます。

Type: enum

Possible values: ANDROID, IOS
Example Request GET https://ads-api.x.com/12/targeting_criteria/app_store_categories?q=music&os_type=IOS Example Response 
    {
      "data": [
        {
          "name": "ゲーム: 音楽",
          "targeting_type": "APP_STORE_CATEGORY",
          "targeting_value": "qouq",
          "os_type": "IOS"
        },
        {
          "name": "音楽",
          "targeting_type": "APP_STORE_CATEGORY",
          "targeting_value": "qov2",
          "os_type": "IOS"
        }
      ],
      "request": {
        "params": {
          "q": "音楽",
          "os_type": "IOS"
        }
      }
    }

​
GET targeting_criteria/conversations

Promoted Products 向けの会話ベースのターゲティング基準のうち、利用可能なものを取得します。 Resource URL https://ads-api.x.com/12/targeting_criteria/conversations Parameters
NameDescription
conversation_type
optional		特定の会話タイプに絞り込むための任意の query。

Type: enum

可能な値: ACTORS, ATHLETES, BOOK_GENRES, BOOKS, BRAND_CATEGORIES, BRANDS, CELEBRITIES, COACHES, DIGITAL_CREATORS, ENTERTAINMENT_BRANDS, ENTERTAINMENT_PERSONALITIES, FICTIONAL_CHARACTERS, JOURNALISTS, LIFESTYLES, MOVIE_GENRES, MOVIES, MUSIC_GENRES, MUSICIANS, NEWS_STORIES, NEWS, PERSONS, PLACES, PODCASTS, POLITICAL_AFFILIATIONS, POLITICIANS, PRODUCTS, RADIO_STATIONS, SPORTS_LEAGUES, SPORTS_PERSONALITIES, SPORTS_TEAMS, SPORTS, TRENDS, TV_SHOWS, VIDEO_GAME_PLATFORMS, VIDEO_GAME_PUBLISHERS, VIDEO_GAMES
count
optional		個々のリクエストごとに取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
Example Request GET https://ads-api.x.com/12/targeting_criteria/conversations?count=2 Example Response 
    {
      "request": {
        "params": {
          "count": 2
        }
      },
      "next_cursor": "1f7m7",
      "data": [
        {
          "targeting_type": "CONVERSATION",
          "targeting_value": "a1",
          "name": "NFL",
          "conversation_type": "SPORTS"
        },
        {
          "targeting_type": "CONVERSATION",
          "targeting_value": "a2",
          "name": "NBA",
          "conversation_type": "SPORTS"
        }
      ]
    }

​
GET targeting_criteria/devices

Promoted Products 向けに利用可能なデバイスベースのターゲティング基準を確認します。デバイスターゲティングは Promoted Tweets でも利用できます。 Resource URL https://ads-api.x.com/12/targeting_criteria/devices Parameters
NameDescription
count
optional		各リクエストで取得を試行するレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
q
optional		ターゲティング基準を絞り込むための任意の query。すべてを取得する場合は、このパラメータを省略します。

Type: string

Example: apple
Example Request GET https://ads-api.x.com/12/targeting_criteria/devices?count=2&q=iphone Example Response 
    {
      "data": [
        {
          "name": "iPhone 3GS",
          "manufacturer": "Apple",
          "os_type": "iOS",
          "targeting_value": "1q",
          "targeting_type": "DEVICE"
        },
        {
          "name": "iPhone 4",
          "manufacturer": "Apple",
          "os_type": "iOS",
          "targeting_value": "1r",
          "targeting_type": "DEVICE"
        }
      ],
      "request": {
        "params": {
          "q": "iphone",
          "count": 2
        }
      }
    }

​
GET targeting_criteria/events

Promoted Products 向けのイベントベースのターゲティング条件の一覧を取得します。1 つのラインアイテムにつき、ターゲットにできるイベントは 1 件のみです。 Note: イベントは複数のタイムゾーンにまたがることが多く、タイムゾーンをまたいだ観点でイベント時刻を扱う際に複雑さが生じます。これを簡素化するため、この endpoint のすべてのイベントの start_time と end_time は、イベントのロケールやタイムゾーンに関係なく UTC±00:00 で表現されます。イベントの start_time と end_time を query して操作する際には、この設計を考慮してください。例えば、米国の Independence Day は UTC±00:00 で start_time=2017-07-04T00:00:00Z および end_time=2017-07-05T00:00:00Z と表され、米国内でこの祝日が複数のタイムゾーンにまたがることによる問題を回避します。 Resource URL https://ads-api.x.com/12/targeting_criteria/events Parameters
NameDescription
event_types
required		特定のイベント種別に絞り込むための任意の query。

Type: enum

Possible values: CONFERENCE, HOLIDAY, MUSIC_AND_ENTERTAINMENT, OTHER, POLITICS, RECURRING, SPORTS
count
optional		各リクエストで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
country_codes
optional		2 文字の ISO 国コードで、特定の国にターゲティング条件の検索範囲を絞り込むための任意の query。このパラメータを指定しない場合、すべてのイベントが返されます。

Type: string
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
end_time
optional		キャンペーンの終了時刻。ISO 8601 で表現します。

Type: string

Example: 2017-10-05T00:00:00Z
start_time
optional		ラインアイテムの配信開始時刻。ISO 8601 で表現します。

Note: 既定値は現在時刻です。

Type: string

Example: 2017-07-05T00:00:00Z
Example Request GET https://ads-api.x.com/12/targeting_criteria/events?count=1 Example Response 
    {
      "request": {
        "params": {
          "count": 1
        }
      },
      "data_type": "events",
      "data": [
        {
          "reach": {
            "total_reach": null
          },
          "name": "お正月",
          "start_time": "2017-12-31T00:00:00Z",
          "top_users": [],
          "top_tweets": [],
          "top_hashtags": [],
          "gender_breakdown_percentage": {},
          "end_time": "2018-01-02T00:00:00Z",
          "country_code": null,
          "device_breakdown_percentage": {},
          "targeting_value": "1ex",
          "is_global": true,
          "event_type": "HOLIDAY",
          "country_breakdown_percentage": {}
        }
      ],
      "next_cursor": "uww0"
    }

​
GET targeting_criteria/interests

Promoted Products で利用可能な興味・関心に基づくターゲティング条件を確認します。興味・関心は頻繁には更新されませんが、この一覧は少なくとも週に一度の更新を推奨します。 Resource URL https://ads-api.x.com/12/targeting_criteria/interests Parameters
NameDescription
count
optional		各リクエストで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
q
optional		ターゲティング条件を絞り込むための任意の query。すべてを取得するにはこのパラメータを省略してください。

Type: string

Example: books
Example Request GET https://ads-api.x.com/12/targeting_criteria/interests?q=books Example Response 
    {
      "data": [
        {
          "name": "書籍・文学/自伝・回想録",
          "targeting_type": "INTEREST",
          "targeting_value": "1001"
        }
      ],
      "request": {
        "params": {
          "q": "books",
          "count": 1
        }
      },
      "next_cursor": "6by4n4"
    }

​
GET targeting_criteria/languages

ターゲティングに利用可能な言語を取得します。 Resource URL https://ads-api.x.com/12/targeting_criteria/languages Parameters
NameDescription
count
optional		各リクエストで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
q
optional		ターゲティング条件を絞り込むための任意の query。すべてを取得する場合は、このパラメータを省略してください。

Type: string

Example: english
Example Request GET https://ads-api.x.com/12/targeting_criteria/languages?q=english Example Response 
    {
      "data": [
        {
          "name": "英語",
          "targeting_type": "LANGUAGE",
          "targeting_value": "en"
        }
      ],
      "request": {
        "params": {
          "q": "english"
        }
      },
      "next_cursor": null
    }

​
GET targeting_criteria/locations

Promoted Products向けのロケーションベースのターゲティング条件を確認します。ジオターゲティングは、国、州/地域、都市、郵便番号の各レベルで、Promoted Accounts と Promoted Tweets に対して利用できます。郵便番号レベルの分析を取得する場合は、郵便番号ターゲティングを使用する必要があります。 Note: San Francisco や New York などの特定のターゲット可能な都市を取得するには、location_type リクエストパラメータと併せて CITIES 列挙を使用してください。 DMA（Designated Market Area、指定市場地域）をターゲティングするには、METROS 列挙を使用してください。 Resource URL https://ads-api.x.com/12/targeting_criteria/locations Parameters
NameDescription
count
optional		各リクエストで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
country_code
optional		2文字のISO国コードで、特定の国に検索範囲を絞り込む任意の query です。すべての国の結果を取得するには、このパラメータを省略します。

Type: string

Example: JP
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
location_type
optional		特定の種類のロケーションで結果を絞り込みます。COUNTRIES より細かなターゲティングは、すべてのロケーションで利用できるとは限りません。

Type: enum

Possible values: COUNTRIES, REGIONS, METROS, CITIES, POSTAL_CODES
q
optional		ターゲティング条件の検索範囲を絞り込む任意の query です。すべての結果を取得するには、このパラメータを省略します。

Type: string

Example: New York
Example Request GET https://ads-api.x.com/12/targeting_criteria/locations?location_type=CITIES&q=los angeles Example Response 
    {
      "data": [
        {
          "name": "Los Angeles, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "3b77caf94bfc81fe",
          "targeting_type": "LOCATION"
        },
        {
          "name": "East Los Angeles, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "67571a7baaa5906b",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Lake Los Angeles, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "ea9bfbd43c93400f",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Gatos, San Francisco-Oakland-San Jose CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "a2de7c70b82b0ca0",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Altos, Monterey-Salinas CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "6a4364ea6f987c10",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Banos, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "b1b6fc646de75904",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Alamitos, Los Angeles CA, CA, USA",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "0799ff0a3c1006e9",
          "targeting_type": "LOCATION"
        },
        {
          "name": "Los Angeles, US",
          "country_code": "US",
          "location_type": "CITIES",
          "targeting_value": "019940ae78c7b3bc",
          "targeting_type": "LOCATION"
        }
      ],
      "request": {
        "params": {
          "location_type": "CITIES",
          "q": "los angeles"
        }
      },
      "next_cursor": null
    }

​
GET targeting_criteria/network_operators

Promoted Products 向けに、利用可能な通信事業者ベースのターゲティング条件を確認します。 この endpoint により、AT&T、Verizon、Sprint、T-Mobile など、複数の国にわたるターゲティング可能な通信事業者を検索できます。 Resource URL https://ads-api.x.com/12/targeting_criteria/network_operators Parameters
NameDescription
count
optional		各リクエストで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
country_code
optional		2 文字の ISO 国コードで特定の国に絞ってターゲティング条件を検索するための任意の query です。このパラメータが指定されていない場合、米国のパートナーオーディエンスのみが返されます。

Type: string

Default: US
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
q
optional		ターゲティング条件の検索範囲を絞り込むための任意の query です。すべての結果を取得するには、このパラメータを省略してください。

Type: string

Examples: Airpeak
Example Request GET https://ads-api.x.com/12/targeting_criteria/network_operators?count=5&country_code=US Example Response 
    {
      "data": [
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Advantage",
          "targeting_value": "2l"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Aeris",
          "targeting_value": "1b"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Airadigm",
          "targeting_value": "2t"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Airlink PCS",
          "targeting_value": "14"
        },
        {
          "country_code": "US",
          "targeting_type": "NETWORK_OPERATOR",
          "name": "Airpeak",
          "targeting_value": "1i"
        }
      ],
      "request": {
        "params": {
          "country_code": "US",
          "count": 5
        }
      },
      "next_cursor": "o7x9iet1a5u608olj4"
    }

​
GET targeting_criteria/platform_versions

プロモーション用プロダクトで利用可能な、モバイルOSのバージョンに基づくターゲティング条件を確認します。プラットフォームバージョンによるターゲティングは、Promoted Accounts と Promoted Tweets で利用可能です。これにより、Android 8.0 や iOS 10.0 のように、モバイルオペレーティングシステムのポイントリリースまで細かく指定してターゲティングできます。 Resource URL https://ads-api.x.com/12/targeting_criteria/platform_versions Parameters
NameDescription
q
optional		ターゲティング条件の検索範囲を絞り込むための任意の query。すべての結果を取得するには、このパラメータを省略してください。

Type: string

Examples: jelly bean
Example Request GET https://ads-api.x.com/12/targeting_criteria/platform_versions Example Response 
    {
        "data": [
            {...},
            {
                "name": "Ice Cream Sandwich",
                "number": "4.0",
                "os_type": "Android",
                "targeting_type": "PLATFORM_VERSION",
                "targeting_value": "17"
            },
            {
                "name": "Jelly Bean",
                "number": "4.1",
                "os_type": "Android",
                "targeting_type": "PLATFORM_VERSION",
                "targeting_value": "18"
            },
            {...}
        ],
        "data_type": "targeting_criterion",
        "request": {
            "params": {}
        }
    }

​
GET targeting_criteria/platforms

Promoted Products 向けのプラットフォームベースのターゲティング基準を取得します。 Resource URL https://ads-api.x.com/12/targeting_criteria/platforms Parameters
NameDescription
count
optional		各リクエストで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
q
optional		ターゲティング基準の検索範囲を絞り込むための任意の query。すべての結果を取得するには、このパラメータを省略します。

Type: string

Examples: ios, blackberry
lang
optional		ISO-639-1 言語コードを使用します。指定した場合、レスポンスに localized_name 属性が追加で返されます。

Type: int, string

Example: fr
Example Request GET https://ads-api.x.com/12/targeting_criteria/platforms Example Response 
    {
      "data": [
        {
          "name": "iOS",
          "targeting_type": "PLATFORM",
          "targeting_value": "0"
        },
        {
          "name": "Android",
          "targeting_type": "PLATFORM",
          "targeting_value": "1"
        },
        {
          "name": "BlackBerry端末",
          "targeting_type": "PLATFORM",
          "targeting_value": "2"
        },
        {
          "name": "その他デバイスのモバイルWeb",
          "targeting_type": "PLATFORM",
          "targeting_value": "3"
        },
        {
          "name": "デスクトップ・ノートPC",
          "targeting_type": "PLATFORM",
          "targeting_value": "4"
        }
      ],
      "request": {
        "params": {}
      }
    }

​
GET targeting_criteria/tv_markets

TV番組をターゲティングできる利用可能なTVマーケットを取得します。ロケールごとのマーケットを返し、GET targeting_criteria/tv_shows endpoint への query に利用できます。 Resource URL https://ads-api.x.com/12/targeting_criteria/tv_markets Parameters なし Example Request GET https://ads-api.x.com/12/targeting_criteria/tv_markets Example Response 
    {
      "data": [
        {
          "name": "フランス",
          "country_code": "FR",
          "locale": "fr-FR"
        },
        {
          "name": "チリ",
          "country_code": "CL",
          "locale": "es-CL"
        },
        {
          "name": "ドイツ",
          "country_code": "DE",
          "locale": "de-DE"
        },
        {
          "name": "オランダ",
          "country_code": "NL",
          "locale": "nl-NL"
        },
        {
          "name": "アメリカ合衆国",
          "country_code": "US",
          "locale": "en-US"
        },
        {
          "name": "ベネズエラ",
          "country_code": "VE",
          "locale": "es-VE"
        },
        {
          "name": "ブラジル",
          "country_code": "BR",
          "locale": "pt-BR"
        },
        {
          "name": "メキシコ",
          "country_code": "MX",
          "locale": "es-MX"
        },
        {
          "name": "コロンビア",
          "country_code": "CO",
          "locale": "es-CO"
        },
        {
          "name": "イギリス",
          "country_code": "GB",
          "locale": "en-GB"
        },
        {
          "name": "アルゼンチン",
          "country_code": "AR",
          "locale": "es-AR"
        },
        {
          "name": "日本",
          "country_code": "JP",
          "locale": "ja-JP"
        },
        {
          "name": "カナダ",
          "country_code": "CA",
          "locale": "en-CA"
        },
        {
          "name": "スペイン",
          "country_code": "ES",
          "locale": "es-ES"
        },
        {
          "name": "イタリア",
          "country_code": "IT",
          "locale": "it-IT"
        },
        {
          "name": "アメリカ合衆国 - ヒスパニック系",
          "country_code": "US",
          "locale": "es-US"
        },
        {
          "name": "アイルランド",
          "country_code": "IE",
          "locale": "en-IE"
        }
      ],
      "request": {
        "params": {}
      }
    }

​
GET targeting_criteria/tv_shows

Promoted Products 向けに利用可能なテレビ番組ベースのターゲティング条件を確認します。テレビ番組ターゲティングは、一部の市場における Promoted Tweets で利用可能です。利用可能な市場については、GET targeting_criteria/tv_markets endpoint を参照してください。 Note: 1,000人未満のユーザーを含むオーディエンスは、estimated_users の値が 1000 と表示されます。 Note: テレビ局およびジャンルのターゲティングオプションはサポート対象外となりました。 Resource URL https://ads-api.x.com/12/targeting_criteria/tv_shows Parameters
NameDescription
locale
required		利用可能なテレビ番組を照会するための tv_market_locale を指定する必須パラメータです。テレビ市場は、GET targeting_criteria/tv_markets から返される locale に基づいて照会されます。

Type: string

Example: en-US
count
optional		個別のリクエストごとに取得を試行するレコード数を指定します。

Type: int

Default: 50
Min, Max: 1, 50
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
q
optional		ターゲティング条件の検索範囲を絞り込むための任意の query。すべての結果を取得するにはこのパラメータを省略します。

Type: string

Examples: ios, blackberry
Example Request GET https://ads-api.x.com/12/targeting_criteria/tv_shows?locale=en-US&q=news&count=1 Example Response 
    {
      "data": [
        {
          "name": "NewsWatch",
          "targeting_value": 10027243420,
          "genre": "PAID",
          "locales": [
            {
              "language": "en",
              "country": "US"
            }
          ]
        }
      ],
      "next_cursor": "c-22838-zdQDJrTxSvOYfQOhb2IlGQ",
      "request": {
        "params": {
          "locale": {
            "countryCode": "US",
            "languageCode": "en"
          },
          "count": 1,
          "q": "news"
        }
      }
    }

​
ターゲティングの提案

​
GET accounts/:account_id/targeting_suggestions

初期の選択内容を補完するためのキーワードまたはユーザーのターゲティング候補を最大50件取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/targeting_suggestions Parameters
NameDescription
account_id
required		対象となるアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般に必須のパラメータです。指定したアカウントは認証ユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
suggestion_type
required		返す候補の種類を指定します。

Type: enum

Possible values: KEYWORD, USER_ID
targeting_values
required		候補生成のシードとして使用するキーワードまたはユーザーIDのカンマ区切りの集合。

Note: これら2種類の候補は混在できません。

Example: 756201191646691328
count
optional		各リクエストで取得を試行するレコード数を指定します。

Type: int

Default: 30
Min, Max: 1, 50
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/targeting_suggestions?suggestion_type=KEYWORD&targeting_values=developers&count=2" Example Response 
    {
      "data": [
        {
          "suggestion_type": "KEYWORD",
          "suggestion_value": "devs"
        },
        {
          "suggestion_type": "KEYWORD",
          "suggestion_value": "software"
        }
      ],
      "request": {
        "params": {
          "suggestion_type": "KEYWORD",
          "targeting_values": [
            "developers"
          ],
          "count": 2,
          "account_id": "18ce54d4x5t"
        }
      }
    }

​
税金設定

​
GET accounts/:account_id/tax_settings

現在のアカウントに関連付けられている税務設定の詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/tax_settings Parameters
NameDescription
account_id
required		対象のアカウントを識別するための識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで基本的に必須のパラメータです。指定したアカウントは、認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings Example Response 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "tax_id": "GB896391250",
        "address_city": "London",
        "business_relationship": "SELF",
        "address_street1": "21 March St",
        "address_last_name": null,
        "address_company": "ABC, Inc.",
        "tax_category": "BUSINESS_WITH_VAT",
        "address_postal_code": "SW1A 1AA",
        "bill_to": "NOT_SET",
        "address_region": "London",
        "address_country": "GB",
        "address_first_name": null,
        "invoice_jurisdiction": "NOT_SET",
        "address_street2": null,
        "address_email": null
      }
    }

​
PUT accounts/:account_id/tax_settings

現在のアカウントの税務設定を更新します。 リソースURL https://ads-api.x.com/12/accounts/:account_id/tax_settings パラメータ
名前説明
account_id
必須		使用するアカウントの識別子。リソースのパス内に表示され、GET accountsを除くすべてのAdvertiser APIリクエストで一般的に必須のパラメータです。指定されたアカウントは認証されたユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
address_city
オプション		アカウント所有者の住所の市区町村。

Type: string

Example: San Francisco
address_country
オプション		アカウント所有者の住所の2文字の国コード。

Type: string

Example: US
address_email
オプション		アカウント所有者の住所に関連付けられたメールアドレス。

Type: string

Example: api@mctestface.com
address_first_name
オプション		アカウント所有者の住所の名。

Type: string

Example: API
address_last_name
オプション		アカウント所有者の住所の姓。

Type: string

Example: McTestface
address_name
オプション		アカウント所有者の住所の会社名。

Type: string

Example: ABC, Co.
address_postal_code
オプション		アカウント所有者の住所の郵便番号。

Type: string

Example: 94102
address_region
オプション		アカウント所有者の住所の地域。

Type: string

Example: California
address_street1
オプション		アカウント所有者の住所の番地。

Type: string

Example: 21 March St
address_street2
オプション		アカウント所有者の住所の番地2行目。

Type: string

Example: Suite 99
bill_to
オプション		請求対象のエンティティ。

Type: enum

Possible values: ADVERTISER, AGENCY
business_relationship
オプション		アカウントが広告主によって所有されているか、代理店によって所有されているか。

Type: enum

Possible values: AGENCY, SELF
client_address_city
オプション		広告主の住所の市区町村。

広告アカウントが代理店によって所有されている場合に設定します。

Type: string

Example: Toronto
client_address_country
オプション		広告主の住所の2文字の国コード。

広告アカウントが代理店によって所有されている場合に設定します。

Type: string

Example: CA
client_address_email
オプション		広告主の住所に関連付けられたメールアドレス。

広告アカウントが代理店によって所有されている場合に設定します。

Type: string

Example: ads@brand.com
client_address_first_name
オプション		広告主の住所の名。

広告アカウントが代理店によって所有されている場合に設定します。

Type: string

Example: Brand
client_address_last_name
オプション		広告主の住所の姓。

広告アカウントが代理店によって所有されている場合に設定します。

Type: string

Example: Advertiser
client_address_name
オプション		広告主の住所の会社名。

広告アカウントが代理店によって所有されている場合に設定します。

Type: string

Example: Brand, Inc.
client_address_postal_code
オプション		広告主の住所の郵便番号。

広告アカウントが代理店によって所有されている場合に設定します。

Type: string

Example: M5H 2N2
client_address_region
オプション		広告主の住所の地域。

広告アカウントが代理店によって所有されている場合に設定します。

Type: string

Example: Ontario
client_address_street1
オプション		広告主の住所の番地。

広告アカウントが代理店によって所有されている場合に設定します。

Type: string

Example: 280 Queen St W
client_address_street2
オプション		広告主の住所の番地2行目。

広告アカウントが代理店によって所有されている場合に設定します。

Type: string

Example: The 6
invoice_jurisdiction
オプション		請求書の管轄区域。

Type: enum

Possible values: LOI_SAPIN, NONE, NOT_SET
tax_category
オプション		課税が個人か事業者かどうか。

Type: enum

Possible values: BUSINESS_NO_VAT, BUSINESS_WITH_VAT, INDIVIDUAL
tax_exemption_id
オプション		VAT免税ID。

Type: string

Example: 12345
tax_id
オプション		VAT登録ID。

Type: string

Example: 67890
リクエスト例 PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tax_settings?address_name=ABC, Co. レスポンス例 
    {
      "request": {
        "params": {
          "account_id": "18ce54d4x5t",
          "address_name": "ABC Co."
        }
      },
      "data": {
        "tax_id": "GB896391250",
        "address_city": "London",
        "business_relationship": "SELF",
        "address_street1": "21 March St",
        "address_last_name": null,
        "address_company": "ABC, Co.",
        "tax_category": "BUSINESS_WITH_VAT",
        "address_postal_code": "SW1A 1AA",
        "bill_to": "NOT_SET",
        "address_region": "London",
        "address_country": "GB",
        "address_first_name": null,
        "invoice_jurisdiction": "NOT_SET",
        "address_street2": null,
        "address_email": null
      }
    }

​
トラッキングタグ

​
GET accounts/:account_id/tracking_tags

現在のアカウントに関連付けられている一部またはすべてのトラッキングタグの詳細を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/tracking_tags Parameters
NameDescription
account_id
required		対象となるアカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは、認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
count
optional		各リクエストで取得を試みるレコード数を指定します。

Type: int

Default: 200
Min, Max: 1, 1000
cursor
optional		次ページの結果を取得するためのカーソルを指定します。詳細は Pagination を参照してください。

Type: string

Example: 8x7v00oow
line_item_ids
optional		カンマ区切りの識別子リストを指定して、特定のラインアイテムに関連付けられたトラッキングタグのみにレスポンスを絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 96uzp
sort_by
optional		サポートされている属性で昇順または降順に並べ替えます。詳細は Sorting を参照してください。

Type: string

Example: created_at-asc
tracking_tag_ids
optional		カンマ区切りの識別子リストを指定して、対象のトラッキングタグのみにレスポンスを絞り込みます。最大 200 個の ID を指定できます。

Type: string

Example: 3m82
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
with_total_count
optional		レスポンスに total_count 属性を含めます。

Note: このパラメータと cursor は排他的です。

Note: total_count を含むリクエストはレートリミットが低く、現在は 15 分あたり 200 に設定されています。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags?tracking_tag_ids=3m82 Example Response 
    {
      "request": {
        "params": {
          "tracking_tag_ids": [
            "3m82"
          ],
          "account_id": "18ce54d4x5t"
        }
      },
      "next_cursor": null,
      "data": [
        {
          "line_item_id": "fdwcl",
          "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
          "tracking_tag_type": "IMPRESSION_TAG",
          "id": "3m82",
          "created_at": "2019-06-26T17:04:26Z",
          "updated_at": "2019-06-26T17:04:26Z",
          "deleted": false
        }
      ]
    }

​
GET accounts/:account_id/tracking_tags/:tracking_tag_id

現在のアカウントに関連付けられている特定のトラッキングタグを取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id Parameters
NameDescription
account_id
required		対象アカウントを示す識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで一般的に必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
tracking_tag_id
required		リクエストで操作するトラッキングタグを参照します。

Type: string

Example: 555j
with_deleted
optional		削除済みの結果を含めます。

Type: boolean

Default: false
Possible values: true, false
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/555j Example Response 
    {
      "request": {
        "params": {
          "with_deleted": true,
          "tracking_tag_id": "555j",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "72v2x",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N6344.2061500TWITTER-OFFICIAL/B23028778.279118262;dc_trk_aid=473354132;dc_trk_cid=119658253",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "555j",
        "作成日時": "2020-08-13T23:02:03Z",
        "updated_at": "2020-08-13T23:02:03Z",
        "deleted": false
      }
    }

​
POST accounts/:account_id/tracking_tags

指定したラインアイテムにトラッキングタグを関連付けます。 Resource URL https://ads-api.x.com/12/accounts/:account_id/tracking_tags Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパス内に含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
line_item_id
required		リクエストで操作対象となるラインアイテムを参照する ID。

Type: string

Example: 8v7jo
tracking_tag_type
required		トラッキングタグのタイプ。

Type: enum

Possible value: IMPRESSION_TAG, CLICK_TRACKER
tracking_tag_url
required		トラッキングパートナーが提供するトラッキングタグのURL。

Type: string

Example: https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309
Example Request POST https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags?line_item_id=fdwcl&tracking_tag_type=IMPRESSION_TAG&tracking_tag_url=https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309 Example Response 
    {
      "request": {
        "params": {
          "line_item_id": "fdwcl",
          "tracking_tag_type": "IMPRESSION_TAG",
          "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "fdwcl",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "3m82",
        "作成日時": "2019-06-26T17:04:26Z",
        "updated_at": "2019-06-26T17:04:26Z",
        "deleted": false
      }
    }

​
PUT accounts/:account_id/tracking_tags/:tracking_tag_id

指定したラインアイテムにトラッキングタグを関連付けます。 Resource URL https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで通常必須です。指定したアカウントは、認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
tracking_tag_url
required		トラッキングパートナーが提供するトラッキングタグのURL。

Type: string

Example: https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309
Example Request PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/3m82?tracking_tag_url=https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309 Example Response 
    {
      "request": {
        "params": {
          "tracking_tag_id": "3m82",
          "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "fdwcl",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N1234.2061500TWITTER-OFFICIAL/B9156151.125630439;dc_trk_aid=1355;dc_trk_cid=8675309",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "3m82",
        "created_at": "2019-06-26T17:04:26Z",
        "updated_at": "2022-01-26T17:04:26Z",
        "deleted": false
      }
    }

​
DELETE accounts/:account_id/tracking_tags/:tracking_tag_id

指定したラインアイテムからトラッキングタグの関連付けを解除します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/tracking_tags/:tracking_tag_id Parameters
NameDescription
account_id
required		対象アカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須のパラメータです。指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
tracking_tag_id
required		リクエストで操作するトラッキングタグを参照します。

Type: string

Example: 555j
Example Request DELETE https://ads-api.x.com/12/accounts/18ce54d4x5t/tracking_tags/555j Example Response 
    {
      "request": {
        "params": {
          "tracking_tag_id": "555j",
          "account_id": "18ce54d4x5t"
        }
      },
      "data": {
        "line_item_id": "72v2x",
        "tracking_tag_url": "https://ad.doubleclick.net/ddm/trackimp/N6344.2061500TWITTER-OFFICIAL/B23028778.279118262;dc_trk_aid=473354132;dc_trk_cid=119658253",
        "tracking_tag_type": "IMPRESSION_TAG",
        "id": "555j",
        "created_at": "2020-08-13T23:02:03Z",
        "updated_at": "2021-08-29T17:12:58Z",
        "deleted": true
      }
    }

​
ユーザー設定

(https://app.getpostman.com/run-collection/1d12b9fc623b8e149f87)

​
GET accounts/:account_id/user_settings/:user_id

ユーザー設定を取得します。 Resource URL https://ads-api.x.com/12/accounts/:account_id/user_settings/:user_id Parameters
NameDescription
account_id
required		対象となるアカウントの識別子。リソースのパスに含まれ、GET accounts を除くすべての Advertiser API リクエストで原則必須のパラメータです。
指定したアカウントは、認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
user_id
required		リクエストで操作対象となるユーザーを参照します。スクリーンネームからユーザー ID を取得するには GET users/lookup を使用します。

Type: long

Example: 756201191646691328
Example Request GET https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328 Example Response 
      {
        "request": {
          "params": {
            "account_id": "18ce54d4x5t",
            "user_id": "756201191646691328"
          }
        },
        "data": {
          "notification_email": "user@domain.com",
          "contact_phone": "",
          "contact_phone_extension": ""
        }
      }

​
PUT accounts/:account_id/user_settings/:user_id

ユーザー設定を更新します。ユーザーコンテキストが必要です。アカウント管理者はアクセスできません。 Resource URL https://ads-api.x.com/12/accounts/:account_id/user_settings/:user_id Parameters
NameDescription
account_id
required		利用するアカウントの識別子。リソースのパス内および GET accounts に表示されます。
指定したアカウントは認証済みユーザーに関連付けられている必要があります。

Type: string

Example: 18ce54d4x5t
user_id
required		このリクエストで操作対象となるユーザーを示す参照。スクリーン名からユーザーのIDを取得するには GET users/lookup を使用します。

Type: long

Example: 756201191646691328
notification_email
optional		アカウント通知に使用するメールアドレス。

Type: string

Example: user@domain.com
contact_phone
optional		連絡先の電話番号。

Type: string

Example: 202-555-0128
contact_phone_extension
optional		連絡先 contact_phone の内線番号。

Type: string

Example: 1234
Example Request PUT https://ads-api.x.com/12/accounts/18ce54d4x5t/user_settings/756201191646691328?notification_email='user@domain.com'&subscribe_email_types=ACCOUNT_PERFORMANCE,PERFORMANCE_IMPROVEMENT" Example Response 
      {
        "request": {
          "params": {
            "account_id": "18ce54d4x5t",
            "user_id": "756201191646691328"
            "notification_email": "user@domain.com",
            "subscribed_campaign_events": [
              "ACCOUNT_PERFORMANCE",
              "PERFORMANCE_IMPROVEMENT"
            ]
          }
        },
        "data": {
          "notification_email": "user@domain.com",
          "contact_phone": "",
          "Contact_phone_extension": ""
        }
      }
⌘I