Documentation Index
Fetch the complete documentation index at: https://generaltranslation.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
次の例では、twurl を使用して App とユーザーのインストール、設定、認可が完了していることを前提としています。twurl は cURL と同様のコマンドラインツールで、X OAuth 認証を適切に処理します。twurl は Ads API(および REST API)の機能を迅速にテストおよびデバッグするのに最適なツールです。リクエストおよびレスポンスの全ヘッダーを確認するには、-t を使用して呼び出しをトレースします。これは cURL の -v オプションとほぼ同等です。
この例では、Dynamic Product Ads (DPA) キャンペーンを作成します。
アカウント id を取得します。
twurl -H ads-api.x.com /12/accounts/
{
"request": {
"params": {}
},
"data": [
{
"name": "Test account for @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
}
funding instrument の id を取得します。
前のコマンドで取得した account id を使って、GET accounts/:account_id/funding_instruments API を呼び出します。
twurl -H ads-api.x.com /12/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
}
キャンペーンを作成して、ファンディングインストゥルメントに関連付けます。
キャンペーンの開始日時と予算を指定します。
- 必須フィールド: ファンディングインストゥルメント、キャンペーン名、予算(合計/日次)、開始日時、Ads アカウントID
twurl -H ads-api.x.com -d "funding_instrument_id={FUNDING_INSTRUMENT_ID}&name={CAMPAIGN_NAME}&total_budget_amount_local_micro={TOTAL_BUDGET}&daily_budget_amount_local_micro={DAILY_BUDGET}&start_time={START_TIME}" /12/accounts/{ADS_ACCOUNT_ID}/campaigns | jq
ステップ 2: Sales objective のラインアイテムを作成する
キャンペーンに関連付けられたラインアイテムを作成します。
- 必須フィールド: campaign id(ステップ 1 で取得)、product type、placements、objective、goal、entity status、primary web event tag、catalog id、product set id、creative_source、ads_account_id
- catalog_id と product_set_id は Shopping Manager で確認できます
- creative_source は常に DYNAMIC_PRODUCT_CREATIVE に設定します
- objective は常に WEBSITE_CLICKS に設定します
- goal は常に WEBSITE_CONVERSIONS に設定します
twurl -H ads-api.x.com -d "campaign_id={CAMPAIGN_ID}&product_type={product_type}&placements={PLACEMENTS}&objective=WEBSITE_CLICKS&goal=WEBSITE_CONVERSIONS&entity_status={entity_status}&primary_web_event_tag={WEB_EVENT_TAG}&catalog_id={catalog_id}&product_set_id={product_set_id}&creative_source=DYNAMIC_PRODUCT_CREATIVE" /12/accounts/{ADS_ACCOUNT_ID}/line_items | jq
- このステップが完了すると、キャンペーンは X の広告マネージャーで確認できるようになります。
DPA カードを作成します。
- 必須パラメータ: 広告アカウント ID と URL
- URL は https://twitter.com から始まっている必要があります。以下の例のように、その後に任意の UTM パラメータを付与できます:
https://twitter.com?utm_source=%7B%7Bsite_source%7D%7D
- オプションで、
creative_type に次のいずれかの値を指定することでカードの形式を選択できます: “CAROUSEL”, “SINGLE”, “COLLECTION”。指定しない場合、カードはカルーセルカードとして作成されます。
twurl -X POST -H ads-api.twitter.com -A "Content-Type: application/json" "/12/accounts/{ADS_ACCOUNT_ID}/dynamic_product_cards" -d '{"url": "{URL}", "creative_type": "{CREATIVE_TYPE}"}' | jq
ポストを作成します。
- 必須パラメータ: 広告アカウント ID、ユーザー ID、カード URI(ステップ3で取得したもの)、テキスト、name、dynamic_product_ad
- dynamic_product_ad は常に true に設定してください
twurl -X POST -H "https://ads-api.twitter.com" "/12/accounts/{ADS_ACCOUNT_ID}/tweet?as_user_id={USER_ID}1&card_uri=card%3A%2F%2F{CARD_URI}&text={POST_TEXT}&name={POST_NAME}%201&dynamic_product_ad=true" | jq
ポストをラインアイテムに関連付けます。
- 必須パラメータ: Ads アカウント id、ラインアイテム id(ステップ2で取得)、ツイート id(ステップ4の id_str)
twurl -X POST -H "https://ads-api.twitter.com" "/12/accounts/{ADS_ACCOUNT_ID}/promoted_tweets?line_item_id={line_item_id}&tweet_ids={tweet_id}" | jq
広告主がUI上でカードを確認したい場合にも、表示されます。