Управление целевыми профилями

Статья
08/25/2023

Используйте эти методы в API рекламных акций Microsoft Store, чтобы выбрать пользователей, географии и типы инвентаризации, предназначенные для каждой линии доставки в рекламной рекламной кампании. Целевые профили можно создавать и повторно использовать в нескольких строках доставки.

Дополнительные сведения о связи между профилями целевых и рекламными кампаниями, линиями доставки и творческими решениями см. в статье "Запуск рекламных кампаний с помощью служб Microsoft Store".

Необходимые компоненты

Чтобы использовать эти методы, сначала необходимо выполнить следующие действия:

Если вы этого еще не сделали, выполните все предварительные требования для API рекламных акций Microsoft Store.
Получите маркер доступа Azure AD для использования в заголовке запроса для этих методов. После получения маркера доступа у вас будет 60 минут, чтобы использовать его до истечения срока действия. После истечения срока действия маркера можно получить новый.

Запросить

Эти методы имеют следующие URI.

Тип метода	URI запроса	Description
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 в маркере> носителя<формы.
Идентификатор отслеживания	GUID	Необязательно. Идентификатор, отслеживающий поток вызовов.

Текст запроса

Для методов 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.

Поле	Тип	Описание	Только чтение	По умолчанию.	Требуется для POST
id	integer	Идентификатор целевого профиля.	Да		Нет
name	строка	Имя профиля целевого объекта.	No		Да
targetingType	строка	Одно из следующих значений: Автоматически. Укажите это значение, чтобы разрешить корпорации Майкрософт выбрать профиль целевого объекта на основе параметров приложения в Центре партнеров. Вручную. Укажите это значение для определения собственного целевого профиля.	No	Авто	Да
возраст	array	Одно или несколько целых чисел, определяющих возрастные диапазоны пользователей для целевого объекта. Полный список целых чисел см. в разделе "Возрастные значения " в этой статье.	No	null	No
пол	array	Одно или несколько целых чисел, определяющих полы пользователей для целевого объекта. Полный список целых чисел см . в разделе "Гендерные значения " в этой статье.	No	null	No
country	array	Одно или несколько целых чисел, определяющих коды стран для целевых пользователей. Полный список целых чисел см. в разделе "Значения кода страны" в этой статье.	No	null	No
osVersion	array	Одно или несколько целых чисел, определяющих версии ОС пользователей для целевого объекта. Полный список целых чисел см . в разделе "Значения версий ОС" в этой статье.	No	null	No
deviceType	array	Одно или несколько целых чисел, определяющих типы устройств пользователей для целевого объекта. Полный список целых чисел см. в разделе "Значения типа устройства" в этой статье.	No	null	No
supplyType	array	Одно или несколько целых чисел, определяющих тип инвентаризации, в котором будет отображаться реклама кампании. Полный список целых чисел см. в разделе "Значения типов ", приведенные в этой статье.	No	null	No

Возрастные значения

Поле возраста в объекте TargetingProfile содержит одно или несколько следующих целых чисел, определяющих диапазоны возрастов пользователей для целевого объекта.

Целочисленное значение для поля age	Соответствующий диапазон возрастов
651	От 13 до 17
652	От 18 до 24
653	От 25 до 34
654	От 35 до 49
655	50 и более поздних версий

Чтобы получить поддерживаемые значения для поля возраста программным способом, можно вызвать следующий метод GET. В заголовке Authorization передайте маркер доступа 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 содержит одно или несколько следующих целых чисел, определяющих полы пользователей для целевого объекта.

Целочисленное значение для поля пола	Соответствующий пол
700	Пол сотрудника
701	Женский

Чтобы получить поддерживаемые значения для поля пола программным способом, можно вызвать следующий метод GET. В заголовке Authorization передайте маркер доступа 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"
    }
  }
}

Значения версий ОС

Поле osVersion в объекте TargetingProfile содержит одно или несколько следующих целых чисел, определяющих версии ОС пользователей для целевого объекта.

Целочисленное значение для поля 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 Mobile
510	Windows 11

Чтобы получить поддерживаемые значения для поля osVersion программным способом, можно вызвать следующий метод GET. В заголовке Authorization передайте маркер доступа 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"
    }
  }
}

Значения типа устройства

Поле deviceType в объекте TargetingProfile содержит одно или несколько следующих целых чисел, определяющих типы устройств для целевых пользователей.

Целочисленное значение для поля deviceType	Соответствующий тип устройства	Description
710	Windows	Это представляет устройства под управлением классической версии Windows 11, Windows 10 или Windows 8.x.
711	Номер телефона	Это устройства под управлением Windows 10 Mobile, Windows Phone 8.x или Windows Phone 7.x.

Чтобы получить поддерживаемые значения для поля deviceType программным способом, можно вызвать следующий метод GET. В заголовке Authorization передайте маркер доступа 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"
    }
  }
}

Укажите значения типов

Поле supplyType в объекте TargetingProfile содержит одно или несколько следующих целых чисел, определяющих тип инвентаризации, в котором будут отображаться объявления кампании.

Целочисленное значение поля supplyType	Соответствующий тип предложения	Description
11470	Приложение	Это относится к объявлениям, которые отображаются только в приложениях.
11471	Юниверсал	Это относится к объявлениям, которые отображаются в приложениях, в Интернете и других поверхностях отображения.

Чтобы получить поддерживаемые значения для поля supplyType программным способом, можно вызвать следующий метод GET. В заголовке Authorization передайте маркер доступа 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 содержит одно или несколько следующих целых чисел, определяющих коды стран ISO 3166-1 alpha-2 для целевых пользователей.

Целочисленное значение для поля страны	Соответствующий код страны
1	US
2	AU
3	AT
4	BE
5	BR
6	Целостности и доступности
7	DK
8	FI
9	FR
10	DE
11	GR
12	HK
13	В
14	IE
15	IT
16	JP
17	LU
18	MX
19	NL
20	Новая Зеландия
21	Нет
22	PL
23	PT
24	ПЗ
25	ES
26	SE
27	CH
28	TW
29	ГБ
30	ЕЗ
31	CL
32	CO
33	CZ
34	HU
35	ZA
36	KR
37	CN
38	0
39	TR
40	5 тыс.
41	IL
42	Идентификатор
43	расчеты с клиентами
44	MY
45	PH
46	PE
47	UA
48	AE
49	TH
50	IQ
51	VN
52	CR
53	VE
54	Контроль качества
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	4 млн
73	AZ
74	BS
75	BD
76	BB
77	BY
81	80
82	BA
83	BW
87	KH
88	ТМ
94	CD
95	CI
96	CY
99	DO
100	EC
101	EG
102	SV
107	FJ
108	Общедоступная версия
110	GE
111	GH
114	GT
118	HT
119	HN
120	JM
121	JO
122	KE
124	KW
125	KG
126	ЛАТИНСКАЯ АМЕРИКА
127	LB
133	MK
135	MW
138	MT
141	MU
145	СООБ
146	MA
147	MZ
148	Неприменимо
150	NP
151	NI
153	NG
154	0 млн
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	MD
224	PS
225	RE
246	PR

Чтобы получить поддерживаемые значения для поля страны программным способом, можно вызвать следующий метод GET. В заголовке Authorization передайте маркер доступа 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"
    }
  }
}

Поделиться через

Управление целевыми профилями

Необходимые компоненты

Запросить

Верхний колонтитул

Текст запроса

Примеры запросов

Response

Целевой объект профиля

Возрастные значения

Гендерные значения

Значения версий ОС

Значения типа устройства

Укажите значения типов

Значения кода страны

Обратная связь

Дополнительные ресурсы

Поделиться через

Управление целевыми профилями

Необходимые компоненты

Запросить

Верхний колонтитул

Текст запроса

Примеры запросов

Response

Целевой объект профиля

Возрастные значения

Гендерные значения

Значения версий ОС

Значения типа устройства

Укажите значения типов

Значения кода страны

См. также

Обратная связь

Дополнительные ресурсы