次の方法で共有

ターゲット プロファイルを管理する

Microsoft Store プロモーション API の以下の方法を使用して、プロモーション広告キャンペーンの各配信ラインを対象とするユーザー、地域、在庫の種類を選択します。 ターゲット プロファイルは、複数の配信ラインで作成および再利用できます。

ターゲット プロファイルと広告キャンペーン、配信ライン、クリエイティブの関係の詳細については、「Microsoft Store サービスを使用して広告キャンペーンを実行する」を参照してください。

[前提条件]

これらのメソッドを使用するには、まず次の操作を行う必要があります。

リクエスト

これらのメソッドには、次の URI があります。

メソッドの型 URI リクエスト 説明
投稿 https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile 新しいターゲット プロファイルを作成します。
配置する https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile/{targetingProfileId} 対象プロファイルをtargetingProfileId で指定された内容に編集します。
取得する https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile/{targetingProfileId} に指定された targetingProfileIdの対象プロファイルを取得します。
ヘッダ タイプ 説明
認証 ひも 必須。 Bearer<token> 形式の Azure AD アクセス トークン。
追跡 ID GUID（グローバルユニーク識別子） 任意。 呼び出しフローを追跡する ID。

リクエストの本文

POST メソッドと PUT メソッドには JSON 要求本文が必要であり、ターゲット プロファイルの必須フィールド オブジェクトと、設定または変更する追加フィールドが必要です。

リクエスト例

次の例では、POST メソッドを呼び出してターゲット プロファイルを作成する方法を示します。

POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile HTTP/1.1
Authorization: Bearer <your access token>

{
    "name": "Contoso App Campaign - Targeting Profile 1",
    "targetingType": "Manual",
    "age": [
      651,
      652],
    "gender": [
      700
    ],
    "country": [
      11,
      12
    ],
    "osVersion": [
      504
    ],
    "deviceType": [
      710
    ],
    "supplyType": [
      11470
    ]
}

次の例では、GET メソッドを呼び出してターゲット プロファイルを取得する方法を示します。

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile/310023951  HTTP/1.1
Authorization: Bearer <your access token>

[応答]

これらのメソッドは、作成、更新、または取得されたターゲット プロファイルに関する情報を含む ターゲット プロファイル オブジェクトを含む JSON 応答本文を返します。 次の例は、これらのメソッドの応答本文を示しています。

{
  "Data": {
    "id": 310021746,
    "name": "Contoso App Campaign - Targeting Profile 1",
    "targetingType": "Manual",
    "age": [
      651,
      652
    ],
    "gender": [
      700
    ],
    "country": [
      6,
      13,
      29
    ],
    "osVersion": [
      504,
      505,
      506,
      507,
      508
    ],
    "deviceType": [
      710,
      711
    ],
    "supplyType": [
      11470
    ]
  }
}

ターゲット用プロファイルオブジェクト

これらのメソッドの要求と応答の本文には、次のフィールドが含まれています。 次の表は、どのフィールドが読み取り専用か (つまり、PUT メソッドでは変更できません)、POST メソッドの要求本文で必要なフィールドを示しています。

フィールド タイプ 説明 読み取り専用 既定値 POST に必須
身分証明書 整数 (integer) ターゲット プロファイルの ID。 イエス いいえ
名前 ひも ターゲット プロファイルの名前。 いいえ イエス
ターゲティングタイプ ひも 次のいずれかの値を指定します。
  • 自動: この値を指定すると、Microsoft はパートナー センターのアプリの設定に基づいてターゲット プロファイルを選択できます。
  • 手動: この値を指定して、独自のターゲット プロファイルを定義します。
 いいえ 車 イエス
年齢 配列 対象となるユーザーの年齢範囲を識別する 1 つ以上の整数。 整数の完全な一覧については、この記事で Age 値 を参照してください。 いいえ 無効 いいえ
ジェンダー 配列 対象となるユーザーの性別を識別する 1 つ以上の整数。 整数の完全な一覧については、この記事で 性別の値を参照してください。 いいえ 無効 いいえ
国 配列 対象となるユーザーの国番号を識別する 1 つ以上の整数。 整数の完全な一覧については、この記事で 国コード値を参照してください。 いいえ 無効 いいえ
osVersion (英語) 配列 対象となるユーザーの OS バージョンを識別する 1 つ以上の整数。 整数の完全な一覧については、この記事で OS バージョンの値を参照してください。 いいえ 無効 いいえ
デバイスタイプ 配列 対象となるユーザーのデバイスの種類を識別する 1 つ以上の整数。 整数の完全な一覧については、この記事 デバイスの種類の値 を参照してください。 いいえ 無効 いいえ
供給タイプ 配列 キャンペーンの広告が表示される在庫の種類を識別する 1 つ以上の整数。 整数の完全な一覧については、この記事の 供給タイプ値 を参照してください。 いいえ 無効 いいえ

年齢の値

TargetingProfile オブジェクトの age フィールドには、対象となるユーザーの年齢範囲を識別する次の整数が 1 つ以上含まれています。

age フィールドの整数値 対応する年齢範囲
651 13 から 17
652 18 から 24
653 25 ~ 34
654 35 ~ 49
655 50 以上

age フィールドでサポートされている値をプログラムで取得するには、次の GET メソッドを呼び出します。 Authorization ヘッダーの場合は、Azure AD アクセス トークンを 形式の「Bearer<トークン>」として渡します。

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/reference/age
Authorization: Bearer <your access token>

次の例は、このメソッドの応答本文を示しています。

{
  "Data": {
    "Age": {
      "651": "Age13To17",
      "652": "Age18To24",
      "653": "Age25To34",
      "654": "Age35To49",
      "655": "Age50AndAbove"
    }
  }
}

ジェンダー値

TargetingProfile オブジェクトの gender フィールドには、ターゲットとするユーザーの性別を識別する次の整数が 1 つ以上含まれています。

性別 フィールドの整数値 対応する性別
七百 男性
701 女性

gender フィールドでサポートされている値をプログラムで取得するには、次の GET メソッドを呼び出します。 Authorization ヘッダーの場合は、Azure AD アクセス トークンを 形式の「Bearer<トークン>」として渡します。

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/reference/gender
Authorization: Bearer <your access token>

次の例は、このメソッドの応答本文を示しています。

{
  "Data": {
    "Gender": {
      "700": "Male",
      "701": "Female"
    }
  }
}

OS バージョンの値

TargetingProfile オブジェクトの osVersion フィールドには、ターゲットとするユーザーの OS バージョンを識別する次の整数が 1 つ以上含まれています。

osVersion フィールドの整数値 対応する OS バージョン
500 Windows Phone 7
501 Windows Phone 7.1
502 Windows Phone 7.5
503 Windows Phone 7.8
504 Windows Phone 8.0
505 Windows Phone 8.1
506 Windows 8.0
507 Windows 8.1
508 Windows 10
509 Windows 10 Mobile
510 ウィンドウズ11

osVersion フィールドでサポートされている値をプログラムで取得するには、次の GET メソッドを呼び出します。 Authorization ヘッダーの場合は、Azure AD アクセス トークンを 形式の「Bearer<トークン>」として渡します。

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/reference/osversion
Authorization: Bearer <your access token>

次の例は、このメソッドの応答本文を示しています。

{
  "Data": {
    "OsVersion": {
      "500": "WindowsPhone70",
      "501": "WindowsPhone71",
      "502": "WindowsPhone75",
      "503": "WindowsPhone78",
      "504": "WindowsPhone80",
      "505": "WindowsPhone81",
      "506": "Windows80",
      "507": "Windows81",
      "508": "Windows10",
      "509": "WindowsPhone10"
    }
  }
}

デバイスの種類の値

TargetingProfile オブジェクトの deviceType フィールドには、ターゲットとするユーザーのデバイスの種類を識別する次の整数が 1 つ以上含まれています。

デバイスタイプ フィールドの整数値 対応するデバイスの種類 説明
710 ウィンドウズ これは、Windows 11、Windows 10、または Windows 8.x のデスクトップ バージョンを実行しているデバイスを表します。
711 電話 これは、Windows 10 Mobile、Windows Phone 8.x、または Windows Phone 7.x を実行しているデバイスを表します。

deviceType フィールドでサポートされている値をプログラムで取得するには、次の GET メソッドを呼び出します。 Authorization ヘッダーの場合は、Azure AD アクセス トークンを 形式の「Bearer<トークン>」として渡します。

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/reference/devicetype
Authorization: Bearer <your access token>

次の例は、このメソッドの応答本文を示しています。

{
  "Data": {
    "DeviceType": {
      "710": "Windows",
      "711": "Phone"
    }
  }
}

型の値を提供する

TargetingProfile オブジェクトの supplyType フィールドには、キャンペーンの広告が表示される在庫の種類を識別する次の整数が 1 つ以上含まれています。

supplyType フィールド 整数値 対応する供給の種類 説明
11470 アプリ これは、アプリにのみ表示される広告を指します。
11471 普遍 これは、アプリ、Web、その他のディスプレイ サーフェスに表示される広告を指します。

supplyType フィールドでサポートされている値をプログラムで取得するには、次の GET メソッドを呼び出します。 Authorization ヘッダーの場合は、Azure AD アクセス トークンを 形式の「Bearer<トークン>」として渡します。

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/reference/supplytype
Authorization: Bearer <your access token>

次の例は、このメソッドの応答本文を示しています。

{
  "Data": {
    "SupplyType": {
      "11470": "App",
      "11471": "Universal"
    }
  }
}

国コードの値

TargetingProfile オブジェクトの country フィールドには、ターゲットとするユーザーの ISO 3166-1 alpha-2 国コードを識別する次の整数が 1 つ以上含まれています。

国の フィールドの整数値 対応する国コード
1 アメリカ
2 オーストラリア
3 で
4 である
5 ブラジル
6 カリフォルニア州
7 DK
8 FI
9 フランス
10 DE
11 GR
12 香港
13 で
14 インターネットエクスプローラー
15 情報技術
16 JP
十七 LU
18 MX
19 オランダ
20 ニュージーランド
21 (二十一) いいえ
22 損益
23 パートタイム
二十四 SG
二十五 ES
26 SE
二十七 CH
28 TW
二十九 GB
30 ロシア
31 CL（塩素）
32 一酸化炭素
33 CZ
34 胡
35 座
36 韓国
37 CN
三十八 RO
39 トルコ
40 SK
41 イリノイ州
42 身分証明書
43 拡張現実
44 私の
45 PH
46 PE
47 UA
48 AE
49 番目
50 知能指数
51 VN
52 CR
53 VE
54 品質保証
55 国際単位系 (SI)
56 BG
五十七 LT
58 RS
59 人事部
六十 人事部
61 LV
62 EE
63 です
64 KZ
65 SA (エスエー)
67 アル
68 DZ (アルジェリアの国コード)
70 アオ
72 午前
73 アリゾナ 州
74 理学士
75 BD
76 BB
77 によって
81 ボー
82 文学士
83 BW
87 KH
88 センチメートル
94 CD
95 CI
96 CY
九十九 する
100 EC
101 例えば
102 SV
107 FJ
108 ジョージア州 (GA)
110 GE
111 GH
114 GT
118 HT
119 HN
120 JM
121 ジョー
122 柯
124 kW
125 キログラム
126 ロサンゼルス
127 ポンド
133 エムケイ
135 MW
138 機械翻訳
141 ミュー
145 私
146 マサチューセッツ州
147 MZ
148 NA
150 NP
151 NI
153 いいえ
154 オーム
155 PK
157 お父さん
159 PY
167 SN
172 LK
176 TZ
180 TT
181 テネシー
184 UG
185 UY
186 UZ
189 ZM（ズーム）
190 ZW
219 医学博士
224 追伸
225 件名:
246 広報

country フィールドでサポートされている値をプログラムで取得するには、次の GET メソッドを呼び出します。 Authorization ヘッダーの場合は、Azure AD アクセス トークンを 形式の「Bearer<トークン>」として渡します。

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/reference/country
Authorization: Bearer <your access token>

次の例は、このメソッドの応答本文を示しています。

{
  "Data": {
    "Country": {
      "1": "US",
      "2": "AU",
      "3": "AT",
      "4": "BE",
      "5": "BR",
      "6": "CA",
      "7": "DK",
      "8": "FI",
      "9": "FR",
      "10": "DE",
      "11": "GR",
      "12": "HK",
      "13": "IN",
      "14": "IE",
      "15": "IT",
      "16": "JP",
      "17": "LU",
      "18": "MX",
      "19": "NL",
      "20": "NZ",
      "21": "NO",
      "22": "PL",
      "23": "PT",
      "24": "SG",
      "25": "ES",
      "26": "SE",
      "27": "CH",
      "28": "TW",
      "29": "GB",
      "30": "RU",
      "31": "CL",
      "32": "CO",
      "33": "CZ",
      "34": "HU",
      "35": "ZA",
      "36": "KR",
      "37": "CN",
      "38": "RO",
      "39": "TR",
      "40": "SK",
      "41": "IL",
      "42": "ID",
      "43": "AR",
      "44": "MY",
      "45": "PH",
      "46": "PE",
      "47": "UA",
      "48": "AE",
      "49": "TH",
      "50": "IQ",
      "51": "VN",
      "52": "CR",
      "53": "VE",
      "54": "QA",
      "55": "SI",
      "56": "BG",
      "57": "LT",
      "58": "RS",
      "59": "HR",
      "60": "BH",
      "61": "LV",
      "62": "EE",
      "63": "IS",
      "64": "KZ",
      "65": "SA",
      "67": "AL",
      "68": "DZ",
      "70": "AO",
      "72": "AM",
      "73": "AZ",
      "74": "BS",
      "75": "BD",
      "76": "BB",
      "77": "BY",
      "81": "BO",
      "82": "BA",
      "83": "BW",
      "87": "KH",
      "88": "CM",
      "94": "CD",
      "95": "CI",
      "96": "CY",
      "99": "DO",
      "100": "EC",
      "101": "EG",
      "102": "SV",
      "107": "FJ",
      "108": "GA",
      "110": "GE",
      "111": "GH",
      "114": "GT",
      "118": "HT",
      "119": "HN",
      "120": "JM",
      "121": "JO",
      "122": "KE",
      "124": "KW",
      "125": "KG",
      "126": "LA",
      "127": "LB",
      "133": "MK",
      "135": "MW",
      "138": "MT",
      "141": "MU",
      "145": "ME",
      "146": "MA",
      "147": "MZ",
      "148": "NA",
      "150": "NP",
      "151": "NI",
      "153": "NG",
      "154": "OM",
      "155": "PK",
      "157": "PA",
      "159": "PY",
      "167": "SN",
      "172": "LK",
      "176": "TZ",
      "180": "TT",
      "181": "TN",
      "184": "UG",
      "185": "UY",
      "186": "UZ",
      "189": "ZM",
      "190": "ZW",
      "219": "MD",
      "224": "PS",
      "225": "RE",
      "246": "PR"
    }
  }
}