ターゲティングオプション
GET targeting_criteria/app_store_categories¶
プロモ商品で利用可能なアプリストアカテゴリーベースのターゲティング条件を取得します。アプリストアカテゴリーは、iOS App StoreとGoogle Playストアでのみ利用できます。
インストール済みアプリカテゴリーのターゲティングを使用すると、インストール済みまたは興味関心を示しているアプリのカテゴリーに基づいてユーザーをターゲティングできます。
リソースURL¶
https://ads-api.x.com/10/targeting_criteria/app_store_categories
パラメーター¶
名前 | 説明 |
---|---|
q 任意 |
ターゲティング条件の範囲を設定するための任意のクエリ。このパラメーターを省略すると、すべてを取得します。 タイプ: 文字列 例: |
os_type 任意 |
特定のアプリストアで結果の範囲を設定します。 タイプ: 列挙 使用可能な値: |
リクエストの例¶
GET https://ads-api.x.com/10/targeting_criteria/app_store_categories?q=music&os_type=IOS
応答の例¶
{
"data": [
{
"name": "Games: Music",
"targeting_type": "APP_STORE_CATEGORY",
"targeting_value": "qouq",
"os_type": "IOS"
},
{
"name": "Music",
"targeting_type": "APP_STORE_CATEGORY",
"targeting_value": "qov2",
"os_type": "IOS"
}
],
"request": {
"params": {
"q": "music",
"os_type": "IOS"
}
}
}
GET targeting_criteria/conversations¶
プロモ商品で利用可能な会話ベースのターゲティング条件を取得します。
リソースURL¶
https://ads-api.x.com/10/targeting_criteria/conversations
パラメーター¶
名前 | 説明 |
---|---|
conversation_type 任意 |
範囲を特定の会話タイプに設定するための任意のクエリ。 タイプ: 列挙 使用可能な値: |
count 任意 |
個別のリクエストごとに試行および取得するレコード数を指定します。 タイプ: 整数 デフォルト: 200 最小、最大: 1 、1000 |
cursor 任意 |
結果の次のページを取得するためのカーソルを指定します。詳細については、「ページネーション」を参照してください。 タイプ: 文字列 例: |
リクエストの例¶
GET https://ads-api.x.com/10/targeting_criteria/conversations?count=2
応答の例¶
{
"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¶
プロモ商品で利用可能な端末ベースのターゲティング条件を取得します。端末ターゲティングはプロモツイートで利用できます。
リソースURL¶
https://ads-api.x.com/10/targeting_criteria/devices
パラメーター¶
名前 | 説明 |
---|---|
count 任意 |
個別のリクエストごとに試行および取得するレコード数を指定します。 タイプ: 整数 デフォルト: 200 最小、最大: 1 、1000 |
q 任意 |
ターゲティング条件の範囲を設定するための任意のクエリ。このパラメーターを省略すると、すべてを取得します。 タイプ: 文字列 例: |
リクエストの例¶
GET https://ads-api.x.com/10/targeting_criteria/devices?count=2&q=iphone
応答の例¶
{
"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¶
プロモ商品で利用可能なイベントベースのターゲティング条件を取得します。ターゲティングできるイベントは行項目あたり1つのみです。
注: 多くの場合、イベントはタイムゾーンをまたいで存在し、複数のタイムゾーンを対象にすると、イベント時間の算出が複雑になることがあります。これを簡単にするために、このエンドポイントの全イベントのstart_time
とend_time
の値は、イベントのロケールやタイムゾーンに関係なく、UTC±00:00の形式で表されます。イベントのstart_time
とend_time
の値をクエリして操作する際には、この設計に注意する必要があります。たとえば、米国の独立記念日はUTC±00:00のstart_time=2017-07-04T00:00:00Z
とend_time=2017-07-05T00:00:00Z
として表されるため、米国内の複数のタイムゾーンにまたがった場合でも、この休日により問題が発生することはありません。
リソースURL¶
https://ads-api.x.com/10/targeting_criteria/events
パラメーター¶
名前 | 説明 |
---|---|
event_types 必須 |
範囲を特定のイベントタイプに設定するための任意のクエリ。 タイプ: 列挙 使用可能な値: |
count 任意 |
個別のリクエストごとに試行および取得するレコード数を指定します。 タイプ: 整数 デフォルト: 200 最小、最大: 1 、1000 |
country_codes 任意 |
ターゲティング条件の検索範囲を特定の国に設定するための任意のクエリ。2文字のISO国コードを使用。このパラメーターを特定しない場合、すべてのイベントが返されます。 タイプ: 文字列 |
cursor 任意 |
結果の次のページを取得するためのカーソルを指定します。詳細については、「ページネーション」を参照してください。 タイプ: 文字列 例: |
end_time 任意 |
キャンペーンの終了時間(ISO 8601で表したもの)。 タイプ: 文字列 例: |
start_time 任意 |
行項目の配信が開始される時間。ISO 8601で表されます。 注: デフォルト値は、現在の時間になります。 タイプ: 文字列 例: |
リクエストの例¶
GET https://ads-api.x.com/10/targeting_criteria/events?count=1
応答の例¶
{
"request": {
"params": {
"count": 1
}
},
"data_type": "events",
"data": [
{
"reach": {
"total_reach": null
},
"name": "New Year's",
"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¶
プロモ商品で利用可能な興味関心ベースのターゲティング条件を取得します。興味関心が頻繁に変更されることはありませんが、週に1回以上はこのリストを更新することをお勧めします。
リソースURL¶
https://ads-api.x.com/10/targeting_criteria/interests
パラメーター¶
名前 | 説明 |
---|---|
count 任意 |
個別のリクエストごとに試行および取得するレコード数を指定します。 タイプ: 整数 デフォルト: 200 最小、最大: 1 、1000 |
cursor 任意 |
結果の次のページを取得するためのカーソルを指定します。詳細については、「ページネーション」を参照してください。 タイプ: 文字列 例: |
q 任意 |
ターゲティング条件の範囲を設定するための任意のクエリ。このパラメーターを省略すると、すべてを取得します。 タイプ: 文字列 例: |
リクエストの例¶
GET https://ads-api.x.com/10/targeting_criteria/interests?q=books
応答の例¶
{
"data": [
{
"name": "Books and literature/Biographies and memoirs",
"targeting_type": "INTEREST",
"targeting_value": "1001"
}
],
"request": {
"params": {
"q": "books",
"count": 1
}
},
"next_cursor": "6by4n4"
}
GET targeting_criteria/languages¶
ターゲティングに使用できる言語を取得します。
リソースURL¶
https://ads-api.x.com/10/targeting_criteria/languages
パラメーター¶
名前 | 説明 |
---|---|
count 任意 |
個別のリクエストごとに試行および取得するレコード数を指定します。 タイプ: 整数 デフォルト: 200 最小、最大: 1 、1000 |
cursor 任意 |
結果の次のページを取得するためのカーソルを指定します。詳細については、「ページネーション」を参照してください。 タイプ: 文字列 例: |
q 任意 |
ターゲティング条件の範囲を設定するための任意のクエリ。このパラメーターを省略すると、すべてを取得します。 タイプ: 文字列 例: |
リクエストの例¶
GET https://ads-api.x.com/10/targeting_criteria/languages?q=english
応答の例¶
{
"data": [
{
"name": "English",
"targeting_type": "LANGUAGE",
"targeting_value": "en"
}
],
"request": {
"params": {
"q": "english"
}
},
"next_cursor": null
}
GET targeting_criteria/locations¶
プロモ商品で利用可能な地域ベースのターゲティング条件を取得します。地域ターゲティングは、国レベル、州/省レベル、市レベル、郵便番号レベルのプロモアカウントとプロモツイートで利用できます。郵便番号レベルでアナリティクスを取得する場合は、郵便番号ターゲティングを使用する必要があります。
注: サンフランシスコやニューヨークなど、ターゲティング可能な特定の都市を取得するには、CITIES
列挙子をlocation_type
リクエストパラメーターと併用します。
指定マーケット地域(DMA)をターゲティングするには、METROS
列挙子を使用します。
リソースURL¶
https://ads-api.x.com/10/targeting_criteria/locations
パラメーター¶
名前 | 説明 |
---|---|
count 任意 |
個別のリクエストごとに試行および取得するレコード数を指定します。 タイプ: 整数 デフォルト: 200 最小、最大: 1 、1000 |
country_code 任意 |
ターゲティング条件の検索範囲を特定の国に設定するための任意のクエリ。2文字のISO国コードを使用。このパラメーターを省略すると、すべての国の結果を取得します。 タイプ: 文字列 例: |
cursor 任意 |
結果の次のページを取得するためのカーソルを指定します。詳細については、「ページネーション」を参照してください。 タイプ: 文字列 例: |
location_type 任意 |
特定の種類の地域で結果の範囲を設定します。 タイプ: 列挙 使用可能な値: |
q 任意 |
ターゲティング条件検索の範囲を設定するための任意のクエリ。このパラメーターを省略すると、すべての結果を取得します。 タイプ: 文字列 例: |
リクエストの例¶
GET https://ads-api.x.com/10/targeting_criteria/locations?location_type=CITIES&q=los angeles
応答の例¶
{
"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¶
プロモ商品で利用可能なネットワークオペレーターベースのターゲティング条件を取得します。
このエンドポイントを使用すると、AT&T、Verizon、Sprint、T-Mobileなど、ターゲティング可能な通信事業者を複数の国で検索できます。
リソースURL¶
https://ads-api.x.com/10/targeting_criteria/network_operators
パラメーター¶
名前 | 説明 |
---|---|
count 任意 |
個別のリクエストごとに試行および取得するレコード数を指定します。 タイプ: 整数 デフォルト: 200 最小、最大: 1 、1000 |
country_code 任意 |
ターゲティング条件の検索範囲を特定の国に設定するための任意のクエリ。2文字のISO国コードを使用。このパラメーターを指定しない場合は、米国のパートナーオーディエンスのみが返されます。 タイプ: 文字列 デフォルト: |
cursor 任意 |
結果の次のページを取得するためのカーソルを指定します。詳細については、「ページネーション」を参照してください。 タイプ: 文字列 例: |
q 任意 |
ターゲティング条件検索の範囲を設定するための任意のクエリ。このパラメーターを省略すると、すべての結果を取得します。 タイプ: 文字列 例: |
リクエストの例¶
GET https://ads-api.x.com/10/targeting_criteria/network_operators?count=5&country_code=US
応答の例¶
{
"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バージョンベースのターゲティング条件を取得します。プラットフォームバージョンのターゲティングは、プロモアカウントおよびプロモツイートで利用できます。これにより、Android 8.0やiOS 10.0など、モバイルオペレーティングシステムバージョンのポイントリリースまでのターゲティングが可能になります。
リソースURL¶
https://ads-api.x.com/10/targeting_criteria/platform_versions
パラメーター¶
名前 | 説明 |
---|---|
q 任意 |
ターゲティング条件検索の範囲を設定するための任意のクエリ。このパラメーターを省略すると、すべての結果を取得します。 タイプ: 文字列 例: |
リクエストの例¶
GET https://ads-api.x.com/10/targeting_criteria/platform_versions
応答の例¶
{
"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¶
プロモ商品で利用可能なプラットフォームベースのターゲティング条件を取得します。
リソースURL¶
https://ads-api.x.com/10/targeting_criteria/platforms
パラメーター¶
名前 | 説明 |
---|---|
count 任意 |
個別のリクエストごとに試行および取得するレコード数を指定します。 タイプ: 整数 デフォルト: 200 最小、最大: 1 、1000 |
q 任意 |
ターゲティング条件検索の範囲を設定するための任意のクエリ。このパラメーターを省略すると、すべての結果を取得します。 タイプ: 文字列 例: |
lang 任意 |
ISO-639-1言語コードを使用します。このパラメーターを渡すと、応答で追加のlocalized_name属性が返されます。 タイプ: 整数、文字列 例: |
リクエストの例¶
GET https://ads-api.x.com/10/targeting_criteria/platforms
応答の例¶
{
"data": [
{
"name": "iOS",
"targeting_type": "PLATFORM",
"targeting_value": "0"
},
{
"name": "Android",
"targeting_type": "PLATFORM",
"targeting_value": "1"
},
{
"name": "BlackBerry phones and tablets",
"targeting_type": "PLATFORM",
"targeting_value": "2"
},
{
"name": "Mobile web on other devices",
"targeting_type": "PLATFORM",
"targeting_value": "3"
},
{
"name": "Desktop and laptop computers",
"targeting_type": "PLATFORM",
"targeting_value": "4"
}
],
"request": {
"params": {}
}
}
GET targeting_criteria/tv_markets¶
テレビ番組をターゲティングできる、利用可能なテレビマーケットを取得します。GET targeting_criteria/tv_showsエンドポイントのクエリに使用できるマーケットを、ロケールごとに返します。
リソースURL¶
https://ads-api.x.com/10/targeting_criteria/tv_markets
パラメーター¶
なし
リクエストの例¶
GET https://ads-api.x.com/10/targeting_criteria/tv_markets
応答の例¶
{
"data": [
{
"name": "France",
"country_code": "FR",
"locale": "fr-FR"
},
{
"name": "Chile",
"country_code": "CL",
"locale": "es-CL"
},
{
"name": "Germany",
"country_code": "DE",
"locale": "de-DE"
},
{
"name": "Netherlands",
"country_code": "NL",
"locale": "nl-NL"
},
{
"name": "United States",
"country_code": "US",
"locale": "en-US"
},
{
"name": "Venezuela",
"country_code": "VE",
"locale": "es-VE"
},
{
"name": "Brazil",
"country_code": "BR",
"locale": "pt-BR"
},
{
"name": "Mexico",
"country_code": "MX",
"locale": "es-MX"
},
{
"name": "Colombia",
"country_code": "CO",
"locale": "es-CO"
},
{
"name": "United Kingdom",
"country_code": "GB",
"locale": "en-GB"
},
{
"name": "Argentina",
"country_code": "AR",
"locale": "es-AR"
},
{
"name": "Japan",
"country_code": "JP",
"locale": "ja-JP"
},
{
"name": "Canada",
"country_code": "CA",
"locale": "en-CA"
},
{
"name": "Spain",
"country_code": "ES",
"locale": "es-ES"
},
{
"name": "Italy",
"country_code": "IT",
"locale": "it-IT"
},
{
"name": "United States - Hispanic",
"country_code": "US",
"locale": "es-US"
},
{
"name": "Ireland",
"country_code": "IE",
"locale": "en-IE"
}
],
"request": {
"params": {}
}
}
GET targeting_criteria/tv_shows¶
プロモ商品で利用可能なテレビ番組ベースのターゲティング条件を取得します。テレビ番組ターゲティングは、特定のマーケットのプロモツイートで利用できます。利用できるマーケットについては、GET targeting_criteria/tv_marketsエンドポイントを参照してください。
注: ユーザー数が1,000人未満のオーディエンスは、estimated_users
の値1000
で表示されます。
注: テレビチャンネルとジャンルのターゲティングオプションはサポートされなくなりました。
リソースURL¶
https://ads-api.x.com/10/targeting_criteria/tv_shows
パラメーター¶
名前 | 説明 |
---|---|
locale 必須 |
tv_market_localeを指定して、利用可能なテレビ番組をクエリするための必須パラメーター。テレビマーケットは、GET targeting_criteria/tv_marketsから返される タイプ: 文字列 例: |
count 任意 |
個別のリクエストごとに試行および取得するレコード数を指定します。 タイプ: 整数 デフォルト: 50 最小、最大: 1 、50 |
cursor 任意 |
結果の次のページを取得するためのカーソルを指定します。詳細については、「ページネーション」を参照してください。 タイプ: 文字列 例: |
q 任意 |
ターゲティング条件検索の範囲を設定するための任意のクエリ。このパラメーターを省略すると、すべての結果を取得します。 タイプ: 文字列 例: |
リクエストの例¶
GET https://ads-api.x.com/10/targeting_criteria/tv_shows?locale=en-US&q=news&count=1
応答の例¶
{
"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"
}
}
}