次の方法で共有


ターゲット プロファイルの管理

Microsoft Store プロモーション API でこれらのメソッドを使用して、プロモーション広告キャンペーンの各配信ラインのターゲットとするユーザー、地域、在庫タイプを選択します。 ターゲット プロファイルを作成し、複数の配信ラインにわたって再利用できます。

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

前提条件

これらのメソッドを使うには、最初に次の作業を行う必要があります。

  • Microsoft Store プロモーション API に関するすべての前提条件を満たします (前提条件がまだ満たされていない場合)。
  • これらのメソッドの要求ヘッダーで使う Azure AD アクセス トークンを取得します。 アクセス トークンを取得した後、アクセス トークンを使用できるのは、その有効期限が切れるまでの 60 分間です。 トークンの有効期限が切れたら新しいトークンを取得できます。

要求

これらのメソッドでは、次の URL が使用されます。

メソッドの型 要求 URI 説明
POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile 新しいターゲット プロファイルを作成します。
PUT https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile/{targetingProfileId} targetingProfileId で指定されたターゲット プロファイルを編集します。
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile/{targetingProfileId} targetingProfileId で指定されたターゲット プロファイルを取得します。
ヘッダー 説明
承認 string 必須。 Bearer<トークン> という形式の 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>

Response

これらのメソッドは、作成、更新、または取得されたターゲット プロファイルに関する情報を含むターゲット プロファイル オブジェクトを含む 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 メソッドの要求本文で必須のフィールドを示しています。

フィールド タイプ 説明 読み取り専用 Default POST に必須かどうか
ID 整数 (integer) ターゲット プロファイルの ID。 はい いいえ
name string ターゲット プロファイルの名前。 いいえ はい
targetingType string 次のいずれかの値です。
  • Auto: パートナー センターでのアプリの設定に基づいて Microsoft がターゲット プロファイルを選択できるようにする場合は、この値を指定します。
  • 手動: この値を指定して、独自のターゲット プロファイルを定義します。
いいえ Auto はい
年齢 array 対象とするユーザーの年齢範囲を識別する 1 つ以上の整数。 整数の完全な一覧については、この記事の「年齢の値」を参照してください。 いいえ null いいえ
性別 array 対象とするユーザーの性別を識別する 1 つ以上の整数。 整数の完全な一覧については、この記事の「性別の値」を参照してください。 いいえ null いいえ
country array 対象とするユーザーの国番号を識別する 1 つ以上の整数。 整数の完全な一覧については、この記事の「国番号の値」を参照してください。 いいえ null いいえ
osVersion array 対象とするユーザーの OS バージョンを識別する 1 つ以上の整数。 整数の完全な一覧については、この記事の「OS バージョンの値」を参照してください。 いいえ null いいえ
deviceType array 対象とするユーザーのデバイスの種類を識別する 1 つ以上の整数。 整数の完全な一覧については、この記事の「デバイスの種類の値」を参照してください。 いいえ null いいえ
supplyType array キャンペーンの広告が表示される在庫の種類を識別する 1 つ以上の整数。 整数の完全な一覧については、この記事の「供給の種類の値」を参照してください。 いいえ null いいえ

年齢の値

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

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

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

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 つ以上含まれています。

gender フィールドの整数値 対応する性別
700 Male
701 Female

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

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 Windows 11

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

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 つ以上含まれています。

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

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

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 ヘッダーでは、Bearer<トークン> の形式で Azure AD アクセス トークンを渡します。

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 つ以上含まれています。

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 使用不可
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 HR
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

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

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"
    }
  }
}