管理目标市场配置文件

项目
09/02/2023

使用 Microsoft Store 促销 API 中的这些方法来选择促销广告市场活动中每条投放渠道的目标用户、地理位置和库存类型。可以跨多条投放渠道创建和重复使用目标配置文件。

有关目标配置文件与广告市场活动、投放渠道和创意之间的关系的详细信息，请参阅使用 Microsoft Store 服务运行广告市场活动。

先决条件

若要使用这些方法，首先需要执行以下操作：

如果尚未开始操作，请先完成 Microsoft Store 促销 API 的所有先决条件。
获取 Azure AD 访问令牌，以供在这些方法的请求标头中使用。获取访问令牌后，在它到期前，你有 60 分钟的使用时间。该令牌到期后，可以获取新的令牌。

请求

这些方法具有以下 URI。

方法类型	请求 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 指定的定位配置文件。

标头	类型	说明
授权	字符串	必需。 Azure AD 访问令牌的格式为 Bearertoken<>。
跟踪 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
    ]
  }
}

定位配置文件对象

这些方法的请求和响应正文包含以下字段。这张表列出了 POST 方法请求正文中的哪些字段是只读字段（意味着不能在 PUT 方法中更改它们）以及哪些字段是必填字段。

字段	类型	说明	只读	默认	POST 必填字段
id	integer	定位配置文件的 ID。	是		否
name	string	定位配置文件的名称。	否		是
targetingType	string	以下值之一： Auto：指定此值可允许 Microsoft 根据合作伙伴中心里你的应用的设置选择目标配置文件。手动：指定此值以定义你自己的定位配置文件。	否	Auto	是
age	array	一个或多个整数，用于标识要定位的用户的年龄范围。有关整数的完整列表，请参阅本文中的年龄值。	否	Null	否
gender	array	一个或多个整数，用于标识要定位的用户的性别。有关整数的完整列表，请参阅本文中的性别值。	否	Null	否
country	array	一个或多个整数，用于标识要定位的用户的国家/地区代码。有关整数的完整列表，请参阅本文中的国家/地区代码值。	否	Null	否
osVersion	array	一个或多个整数，用于标识要定位的用户的操作系统版本。有关整数的完整列表，请参阅本文中的操作系统版本值。	否	Null	否
deviceType	array	一个或多个整数，用于标识要定位的用户的设备类型。有关整数的完整列表，请参阅本文中的设备类型值。	否	Null	否
supplyType	array	一个或多个整数，用于标识要在其中显示市场活动广告的库存类型。有关整数的完整列表，请参阅本文中的供应类型值。	否	Null	否

年龄值

TargetingProfile 对象中的 age 字段包含以下一个或多个整数，用于标识要定位的用户的年龄范围。

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 字段包含以下一个或多个整数，用于标识要定位的用户的性别。

gender 字段的整数值	对应的性别
700	男性
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"
    }
  }
}

操作系统版本值

TargetingProfile 对象中的 osVersion 字段包含以下一个或多个整数，用于标识要定位的用户的操作系统版本。

osVersion 字段的整数值	对应的操作系统版本
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 移动版
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 字段包含以下一个或多个整数，用于标识要定位的用户的设备类型。

deviceType 字段的整数值	对应的设备类型	说明
710	Windows	代表运行 Windows 11、Windows 10 或 Windows 8.x 桌面版的设备。
711	电话	代表运行 Windows 10 移动版、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 字段包含以下一个或多个整数，用于标识将在其中显示市场活动广告的库存类型。

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 国家/地区代码。

country 字段的整数值	对应的国家/地区代码
1	美国
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	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"
    }
  }
}

通过

管理目标市场配置文件

先决条件

请求

标头

请求正文

请求示例

响应

定位配置文件对象

年龄值

性别值

操作系统版本值

设备类型值

供应类型值

国家/地区代码值

反馈

其他资源

通过

管理目标市场配置文件

先决条件

请求

标头

请求正文

请求示例

响应

定位配置文件对象

年龄值

性别值

操作系统版本值

设备类型值

供应类型值

国家/地区代码值

相关主题

反馈

其他资源