Administrar perfiles objetivo

Artículo
09/02/2023

Usa estos métodos en la API de promociones de Microsoft Store para seleccionar los usuarios, las zonas geográficas y los tipos de inventario que quieres destinar para cada línea de entrega en una campaña publicitaria promocional. Los perfiles de destino se pueden crear y reutilizar en varias líneas de entrega.

Para obtener más información sobre la relación entre los perfiles de destino y las campañas publicitarias, las líneas de entrega y los creativos, consulta Ejecutar campañas publicitarias con los serviciosde Microsoft Store.

Requisitos previos

Para usar estos métodos, primero debe hacer lo siguiente:

Si aún no lo ha hecho, complete todos los requisitos previos para la API de promociones de Microsoft Store.
Obtenga un token de acceso a Azure AD para utilizarlo en el encabezado de solicitud de estos métodos. Una vez que haya obtenido un token de acceso, tiene 60 minutos para usarlo antes de que expire. Una vez que expire el token, puede obtener uno nuevo.

Solicitud

Estos métodos tienen los siguientes URI.

Tipo de método	URI de solicitud	Descripción
POST	`https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile`	Crea un nuevo perfil de destino.
PUT	`https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile/{targetingProfileId}`	Edita el perfil de destino especificado por targetingProfileId.
GET	`https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile/{targetingProfileId}`	Obtiene el perfil de destino especificado por targetingProfileId.

Encabezado	Tipo	Descripción
Autorización	cadena	Necesario. Token de acceso de Azure AD con el formato Token<de portador>.
Tracking ID	GUID	Opcional. Identificador que realiza un seguimiento del flujo de llamadas.

Cuerpo de solicitud

Los métodos POST y PUT requieren un cuerpo de solicitud JSON con los campos obligatorios de un objeto de perfil de destino y los campos adicionales que quiera establecer o cambiar.

Ejemplos de solicitud

En el ejemplo siguiente se muestra cómo llamar al método POST para crear un perfil de destino.

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

En el ejemplo siguiente se muestra cómo llamar al método GET para recuperar un perfil de destino.

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

Response

Estos métodos devuelven un cuerpo de respuesta JSON con un objeto de perfil de destino que contiene información sobre el perfil de destino que se creó, actualizó o recuperó. En el ejemplo siguiente se muestra un cuerpo de respuesta para estos métodos.

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

Objeto de perfil de destino

Los cuerpos de solicitud y respuesta de estos métodos contienen los campos siguientes. En esta tabla se muestran los campos que son de solo lectura (lo que significa que no se pueden cambiar en el método PUT) y qué campos son necesarios en el cuerpo de la solicitud para el método POST.

Campo	Tipo	Description	Solo lectura	Valor predeterminado	Obligatorio para POST
identificador	integer	Identificador del perfil de destino.	Sí		No
name	cadena	Nombre del perfil de destino.	No		Sí
targetingType	cadena	Uno de los siguientes valores: Automático: especifique este valor para permitir que Microsoft elija el perfil de destino en función de la configuración de la aplicación en el Centro de partners. Manual: especifique este valor para definir su propio perfil de destino.	No	Automático	Sí
age	array	Uno o varios enteros que identifican los intervalos de edad de los usuarios a los que se dirige. Para obtener una lista completa de enteros, vea Valores de edad en este artículo.	No	null	No
gender	array	Uno o varios enteros que identifican los géneros de los usuarios a los que dirigirse. Para obtener una lista completa de enteros, consulte Valores de género en este artículo.	No	null	No
country	array	Uno o varios enteros que identifican los códigos de país de los usuarios a los que dirigirse. Para obtener una lista completa de enteros, consulte Valores de código de país en este artículo.	No	null	No
osVersion	array	Uno o varios enteros que identifican las versiones del sistema operativo de los usuarios de destino. Para obtener una lista completa de enteros, consulte Valores de versión del sistema operativo en este artículo.	No	null	No
deviceType	array	Uno o varios enteros que identifican los tipos de dispositivo de los usuarios a los que se dirige. Para obtener una lista completa de enteros, consulte Valores de tipo de dispositivo en este artículo.	No	null	No
supplyType	array	Uno o varios enteros que identifican el tipo de inventario donde se mostrarán los anuncios de la campaña. Para obtener una lista completa de enteros, consulte Valores de tipo de suministro en este artículo.	No	null	No

Valores de edad

El campo edad del objeto TargetingProfile contiene uno o varios de los siguientes enteros que identifican los intervalos de edad de los usuarios a los que se dirige.

Valor entero para el campo age	Intervalo de edad correspondiente
651	13 a 17
652	18 a 24
653	25 a 34
654	35 a 49
655	50 y versiones posteriores

Para obtener los valores admitidos para el campo age mediante programación, puede llamar al siguiente método GET. Para el encabezado, pase el Authorization token de acceso de Azure AD en el formato Token< de portador>.

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

En el ejemplo siguiente se muestra el cuerpo de la respuesta para este método.

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

Valores de género

El campo de género del objeto TargetingProfile contiene uno o varios de los siguientes enteros que identifican los géneros de los usuarios a los que se dirige.

Valor entero para el campo de género	Género correspondiente
700	Masculino
701	Femenino

Para obtener los valores admitidos para el campo de género mediante programación, puede llamar al siguiente método GET. Para el encabezado, pase el Authorization token de acceso de Azure AD en el formato Token< de portador>.

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

En el ejemplo siguiente se muestra el cuerpo de la respuesta para este método.

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

Valores de versión del sistema operativo

El campo osVersion del objeto TargetingProfile contiene uno o varios de los siguientes enteros que identifican las versiones del sistema operativo de los usuarios a los que se dirige.

Valor entero para el campo osVersion	Versión correspondiente del sistema operativo
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

Para obtener los valores admitidos para el campo osVersion mediante programación, puede llamar al siguiente método GET. Para el encabezado, pase el Authorization token de acceso de Azure AD en el formato Token< de portador>.

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

En el ejemplo siguiente se muestra el cuerpo de la respuesta para este método.

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

Valores de tipo de dispositivo

El campo deviceType del objeto TargetingProfile contiene uno o varios de los siguientes enteros que identifican los tipos de dispositivo de los usuarios a los que se dirige.

Valor entero para el campo deviceType	Tipo de dispositivo correspondiente	Descripción
710	Windows	Esto representa los dispositivos que ejecutan una versión de escritorio de Windows 11, Windows 10 o Windows 8.x.
711	Teléfono	Esto representa los dispositivos que ejecutan Windows 10 Mobile, Windows Phone 8.x o Windows Phone 7.x.

Para obtener los valores admitidos para el campo deviceType mediante programación, puede llamar al siguiente método GET. Para el encabezado, pase el Authorization token de acceso de Azure AD en el formato Token< de portador>.

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

En el ejemplo siguiente se muestra el cuerpo de la respuesta para este método.

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

Valores de tipo de suministro

El campo supplyType del objeto TargetingProfile contiene uno o varios de los siguientes enteros que identifican el tipo de inventario en el que se mostrarán los anuncios de la campaña.

Valor entero para el campo supplyType	Tipo de suministro correspondiente	Descripción
11470	Aplicación	Esto hace referencia a anuncios que solo aparecen en aplicaciones.
11471	Universal	Esto hace referencia a anuncios que aparecen en aplicaciones, en la Web y en y otras superficies de visualización.

Para obtener los valores admitidos para el campo supplyType mediante programación, puede llamar al siguiente método GET. Para el encabezado, pase el Authorization token de acceso de Azure AD en el formato Token< de portador>.

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

En el ejemplo siguiente se muestra el cuerpo de la respuesta para este método.

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

Valores de código de país

El campo country del objeto TargetingProfile contiene uno o varios de los siguientes enteros que identifican los códigos de país alfa-2 ISO 3166-1 alfa-2 de los usuarios a los que dirigirse.

Valor entero para el campo de país	Código de país correspondiente
1	US
2	AU
3	AT
4	BE
5	BR
6	CA
7	DK
8	FI
9	VF
10	DE
11	GR
12	HK
13	IN
14	IE
15	TI
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	Identificador
43	AR
44	MY
45	PH
46	PE
47	UA
48	AE
49	TH
50	IQ
51	VN
52	CR
53	VE
54	Preguntas y respuestas
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	Los Ángeles
127	LB
133	MK
135	MW
138	MT
141	MU
145	ME
146	MA
147	MZ
148	N/D
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

Para obtener los valores admitidos para el campo de país mediante programación, puede llamar al siguiente método GET. Para el encabezado, pase el Authorization token de acceso de Azure AD en el formato Token< de portador>.

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

En el ejemplo siguiente se muestra el cuerpo de la respuesta para este método.

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

Administrar perfiles objetivo

Requisitos previos

Solicitud

Encabezado

Cuerpo de solicitud

Ejemplos de solicitud

Response

Objeto de perfil de destino

Valores de edad

Valores de género

Valores de versión del sistema operativo

Valores de tipo de dispositivo

Valores de tipo de suministro

Valores de código de país

Comentarios

Comentarios

Recursos adicionales

Administrar perfiles objetivo

Requisitos previos

Solicitud

Encabezado

Cuerpo de solicitud

Ejemplos de solicitud

Response

Objeto de perfil de destino

Valores de edad

Valores de género

Valores de versión del sistema operativo

Valores de tipo de dispositivo

Valores de tipo de suministro

Valores de código de país

Temas relacionados

Comentarios

Comentarios

Recursos adicionales