Administrar perfiles objetivoManage targeting profiles

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 como destino de cada línea de entrega de una campaña de anuncios promocionales.Use these methods in the Microsoft Store promotions API to select the users, geographies and inventory types that you want to target for each delivery line in a promotional ad campaign. Los perfiles de destino se pueden crear y volver a usar en varias líneas de entrega.Targeting profiles can be created and reused across multiple delivery lines.

Para obtener más información sobre la relación entre los perfiles objetivo y las campañas de anuncios, las líneas de entrega y los creativos, consulta Ejecutar campañas de anuncios con los servicios de Microsoft Store.For more information about the relationship between targeting profiles and ad campaigns, delivery lines, and creatives, see Run ad campaigns using Microsoft Store services.

Requisitos previosPrerequisites

Para usar estos métodos, primero debes hacer lo siguiente:To use these methods, you need to first do the following:

  • Si aún no lo has hecho, completa todos los requisitos previos de la API de promociones de Microsoft Store.If you have not done so already, complete all the prerequisites for the Microsoft Store promotions API.
  • Obtén un token de acceso de Azure AD para usarlo en el encabezado de la solicitud para estos métodos.Obtain an Azure AD access token to use in the request header for these methods. Después de obtener un token de acceso, tienes 60 minutos para usarlo antes de que expire.After you obtain an access token, you have 60 minutes to use it before it expires. Si el token expira, puedes obtener uno nuevo.After the token expires, you can obtain a new one.

SolicitudRequest

Estos métodos tienen los siguientes URI.These methods have the following URIs.

Tipo de métodoMethod type URI de la solicitudRequest URI DescripciónDescription
POSTPOST https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile Crea un nuevo perfil de destino.Creates a new targeting profile.
PUTPUT https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile/{targetingProfileId} Edita el perfil de destino especificado por targetingProfileId.Edits the targeting profile specified by targetingProfileId.
GETGET https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile/{targetingProfileId} Obtiene el perfil de destino especificado por targetingProfileId.Gets the targeting profile specified by targetingProfileId.
EncabezadoHeader TipoType DescripciónDescription
AutorizaciónAuthorization stringstring Obligatorio.Required. El token de acceso de Azure AD en el formulario portador < token>.The Azure AD access token in the form Bearer <token>.
Id. de seguimientoTracking ID GUIDGUID Opcional.Optional. Un id. que realiza un seguimiento del flujo de llamadas.An ID that tracks the call flow.

Cuerpo de la solicitudRequest body

Los métodos POST y PUT necesitan un cuerpo de la solicitud JSON con los campos obligatorios de un objeto de perfil de destino y los campos adicionales que quieras establecer o cambiar.The POST and PUT methods require a JSON request body with the required fields of a Targeting profile object and any additional fields you want to set or change.

Ejemplos de solicitudRequest examples

En el siguiente ejemplo se muestra cómo llamar al método POST para crear un perfil de destino.The following example demonstrates how to call the POST method to create a targeting profile.

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 siguiente ejemplo se muestra cómo llamar al método GET para recuperar un perfil de destino.The following example demonstrates how to call the GET method to retrieve a targeting profile.

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

RespuestaResponse

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ó.These methods return a JSON response body with a Targeting profile object that contains information about the targeting profile that was created, updated, or retrieved. En el siguiente ejemplo se muestra un cuerpo de respuesta para estos métodos.The following example demonstrates a response body for these methods.

{
  "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 destinoTargeting profile object

Los cuerpos de solicitud y respuesta para estos métodos contienen los siguientes campos.The request and response bodies for these methods contain the following fields. En esta tabla se muestran los campos que son de solo lectura (es decir, no se pueden cambiar en el método PUT) y los campos que son obligatorios en el cuerpo de la solicitud para el método POST.This table shows which fields are read-only (meaning that they cannot be changed in the PUT method) and which fields are required in the request body for the POST method.

CampoField TipoType DescripciónDescription Solo lecturaRead only PredeterminadoDefault Obligatorio para POSTRequired for POST
idid número enterointeger El id. del perfil de destino.The ID of the targeting profile. Yes NoNo
namename stringstring El nombre del perfil de destino.The name of the targeting profile. NoNo Yes
targetingTypetargetingType stringstring Uno de los siguientes valores:One of the following values:
  • Automático: Especifique este valor para permitir a Microsoft elegir el perfil de destino basándose en la configuración de la aplicación en el centro de partners.Auto: Specify this value to allow Microsoft to choose the targeting profile based on the settings for your app in Partner Center.
  • Manual: Especifique este valor para definir su propio perfil de destino.Manual: Specify this value to define your own targeting profile.
NoNo AutomáticoAuto Yes
ageage arrayarray Uno o más enteros que identifican los intervalos de edad de los usuarios de destino.One or more integers that identify the age ranges of the users to target. Para obtener una lista completa de enteros, consulta valores de edad en este artículo.For a complete list of integers, see Age values in this article. NoNo nulonull NoNo
gendergender arrayarray Uno o más enteros que identifican el sexo de los usuarios de destino.One or more integers that identify the genders of the users to target. Para obtener una lista completa de enteros, consulta valores de sexo en este artículo.For a complete list of integers, see Gender values in this article. NoNo nulonull NoNo
countrycountry arrayarray Uno o más enteros que identifican los códigos de país de los usuarios de destino.One or more integers that identify the country codes of the users to target. Para obtener una lista completa de enteros, consulta valores de códigos de país en este artículo.For a complete list of integers, see Country code values in this article. NoNo nulonull NoNo
osVersionosVersion arrayarray Uno o más enteros que identifican las versiones de los sistemas operativos de los usuarios de destino.One or more integers that identify the OS versions of the users to target. Para obtener una lista completa de enteros, consulta valores de versión de sistema operativo en este artículo.For a complete list of integers, see OS version values in this article. NoNo nulonull NoNo
deviceTypedeviceType arrayarray Uno o más enteros que identifican los tipos de dispositivos de los usuarios de destino.One or more integers that identify the device types of the users to target. Para obtener una lista completa de enteros, consulta valores de tipo de dispositivo en este artículo.For a complete list of integers, see Device type values in this article. NoNo nulonull NoNo
supplyTypesupplyType arrayarray Uno o más enteros que identifican el tipo de inventario en el que se mostrarán los anuncios de la campaña.One or more integers that identify the type of inventory where the campaign's ads will be shown. Para obtener una lista completa de enteros, consulta valores de tipo de suministro en este artículo.For a complete list of integers, see Supply type values in this article. NoNo nulonull NoNo

Valores de edadAge values

El campo age del objeto TargetingProfile contiene uno o varios de los siguientes enteros que identifican los intervalos de edad de los usuarios de destino.The age field in the TargetingProfile object contains one or more of the following integers that identify the age ranges of the users to target.

Valor entero del campo ageInteger value for age field Intervalo de edad correspondienteCorresponding age range
651651 13 a 1713 to 17
652652 18 a 2418 to 24
653653 25 a 3425 to 34
654654 35 a 4935 to 49
655655 50 o más50 and above

Para obtener los valores que admite el campo age mediante programación, puedes llamar al siguiente método GET.To get the supported values for the age field programmatically, you can call the following GET method. Para el Authorization encabezado, pase el token de acceso de Azure AD en el formulario portador < token>.For the Authorization header, pass your Azure AD access token in the form Bearer <token>.

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

En el siguiente ejemplo se muestra el cuerpo de la respuesta para este método.The following example shows the response body for this method.

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

Valores de sexoGender values

El campo gender del objeto TargetingProfile contiene uno o varios de los siguientes enteros que identifican los sexos de los usuarios de destino.The gender field in the TargetingProfile object contains one or more of the following integers that identify the genders of the users to target.

Valor entero para el campo genderInteger value for gender field Sexo correspondienteCorresponding gender
700700 HombreMale
701701 MujerFemale

Para obtener los valores que admite el campo gender mediante programación, puedes llamar al siguiente método GET.To get the supported values for the gender field programmatically, you can call the following GET method. Para el Authorization encabezado, pase el token de acceso de Azure AD en el formulario portador < token>.For the Authorization header, pass your Azure AD access token in the form Bearer <token>.

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

En el siguiente ejemplo se muestra el cuerpo de la respuesta para este método.The following example shows the response body for this method.

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

Valores de versión de sistema operativoOS version values

El campo osVersion del objeto TargetingProfile contiene uno o varios de los siguientes enteros que identifican las versiones del sistema operativo de los usuarios de destino.The osVersion field in the TargetingProfile object contains one or more of the following integers that identify the OS versions of the users to target.

Valor entero para el campo osVersionInteger value for osVersion field Versión del sistema operativo correspondienteCorresponding OS version
500500 Windows Phone 7Windows Phone 7
501501 Windows Phone 7.1Windows Phone 7.1
502502 Windows Phone 7.5Windows Phone 7.5
503503 Windows Phone 7.8Windows Phone 7.8
504504 Windows Phone 8.0Windows Phone 8.0
505505 Windows Phone 8.1Windows Phone 8.1
506506 Windows 8.0Windows 8.0
507507 Windows 8.1Windows 8.1
508508 Windows 10Windows 10
509509 Windows 10 MobileWindows 10 Mobile

Para obtener los valores que admite el campo osVersion mediante programación, puedes llamar al siguiente método GET.To get the supported values for the osVersion field programmatically, you can call the following GET method. Para el Authorization encabezado, pase el token de acceso de Azure AD en el formulario portador < token>.For the Authorization header, pass your Azure AD access token in the form Bearer <token>.

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

En el siguiente ejemplo se muestra el cuerpo de la respuesta para este método.The following example shows the response body for this method.

{
  "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 dispositivoDevice type values

El campo deviceType del objeto TargetingProfile contiene uno o varios de los siguientes enteros que identifican los tipos de dispositivos de los usuarios de destino.The deviceType field in the TargetingProfile object contains one or more of the following integers that identify the device types of the users to target.

Valor entero para el campo deviceTypeInteger value for deviceType field Tipo de dispositivo correspondienteCorresponding device type DescripciónDescription
710710 WindowsWindows Representa los dispositivos que ejecutan una versión de escritorio de Windows 10 o Windows 8.x.This represents devices running a desktop version of Windows 10 or Windows 8.x.
711711 TeléfonoPhone Representa los dispositivos que ejecutan Windows 10 Mobile, Windows Phone 8.x o Windows Phone 7.x.This represents devices running Windows 10 Mobile, Windows Phone 8.x, or Windows Phone 7.x.

Para obtener los valores que admite el campo deviceType mediante programación, puedes llamar al siguiente método GET.To get the supported values for the deviceType field programmatically, you can call the following GET method. Para el Authorization encabezado, pase el token de acceso de Azure AD en el formulario portador < token>.For the Authorization header, pass your Azure AD access token in the form Bearer <token>.

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

En el siguiente ejemplo se muestra el cuerpo de la respuesta para este método.The following example shows the response body for this method.

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

Valores de tipo de suministroSupply type values

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.The supplyType field in the TargetingProfile object contains one or more of the following integers that identify the type of inventory where the campaign's ads will be shown.

Valor entero para el campo supplyTypeInteger value for supplyType field Tipo de suministro correspondienteCorresponding supply type DescripciónDescription
1147011470 AplicaciónApp Hace referencia a los anuncios que aparecen solo en aplicaciones.This refers to ads that appear in apps only.
1147111471 UniversalUniversal Hace referencia a los anuncios que aparecen en aplicaciones, en Internet y en otras superficies de pantalla.This refers to ads that appear in apps, on the Web, and on and other display surfaces.

Para obtener los valores que admite el campo supplyType mediante programación, puedes llamar al siguiente método GET.To get the supported values for the supplyType field programmatically, you can call the following GET method. Para el Authorization encabezado, pase el token de acceso de Azure AD en el formulario portador < token>.For the Authorization header, pass your Azure AD access token in the form Bearer <token>.

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

En el siguiente ejemplo se muestra el cuerpo de la respuesta para este método.The following example shows the response body for this method.

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

Valores de código de paísCountry code values

El campo country del objeto TargetingProfile contiene uno o varios de los siguientes enteros que identifican los códigos de país ISO 3166-1 alpha-2 de los usuarios de destino.The country field in the TargetingProfile object contains one or more of the following integers that identify the ISO 3166-1 alpha-2 country codes of the users to target.

Valor entero para el campo countryInteger value for country field Código de país correspondienteCorresponding country code
11 EE. UU.US
22 AUAU
33 ATAT
44 BEBE
55 BRBR
66 CACA
77 DKDK
88 FIFI
99 FRFR
1010 DEDE
1111 GRGR
1212 HKHK
1313 ININ
1414 IEIE
1515 TIIT
1616 JPJP
1717 LULU
1818 MXMX
1919 NLNL
2020 NZNZ
2121 NONO
2222 PLPL
2323 PTPT
2424 SGSG
2525 ESES
2626 SESE
2727 CHCH
2828 TWTW
2929 GBGB
3030 RURU
3131 CLCL
3232 COCO
3333 CZCZ
3434 HUHU
3535 ZAZA
3636 KRKR
3737 CNCN
3838 RORO
3939 TRTR
4040 SKSK
4141 ILIL
4242 Id.ID
4343 ARAR
4444 MYMY
4545 PHPH
4646 PEPE
4747 UAUA
4848 AEAE
4949 THTH
5050 IQIQ
5151 VNVN
5252 CRCR
5353 VEVE
5454 QAQA
5555 SISI
5656 BGBG
5757 LTLT
5858 RSRS
5959 HRHR
6060 HRHR
6161 LVLV
6262 EEEE
6363 ISIS
6464 KZKZ
6565 SASA
6767 ALAL
6868 DZDZ
7070 AOAO
7272 AMAM
7373 AZAZ
7474 BSBS
7575 BDBD
7676 BBBB
7777 BYBY
8181 BOBO
8282 BABA
8383 BWBW
8787 KHKH
8888 CMCM
9494 CDCD
9595 CICI
9696 CYCY
9999 DODO
100100 ECEC
101101 EGEG
102102 SVSV
107107 FJFJ
108108 GAGA
110110 GEGE
111111 GHGH
114114 GTGT
118118 HTHT
119119 HNHN
120120 JMJM
121121 JOJO
122122 KEKE
124124 KWKW
125125 KGKG
126126 LALA
127127 LBLB
133133 MKMK
135135 MWMW
138138 MTMT
141141 MUMU
145145 MEME
146146 MAMA
147147 MZMZ
148148 N/ANA
150150 NPNP
151151 NINI
153153 NGNG
154154 OMOM
155155 PKPK
157157 PAPA
159159 PYPY
167167 SNSN
172172 LKLK
176176 TZTZ
180180 TTTT
181181 TNTN
184184 UGUG
185185 UYUY
186186 UZUZ
189189 ZMZM
190190 ZWZW
219219 MDMD
224224 PSPS
225225 RERE
246246 PRPR

Para obtener los valores que admite el campo country mediante programación, puedes llamar al siguiente método GET.To get the supported values for the country field programmatically, you can call the following GET method. Para el Authorization encabezado, pase el token de acceso de Azure AD en el formulario portador < token>.For the Authorization header, pass your Azure AD access token in the form Bearer <token>.

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

En el siguiente ejemplo se muestra el cuerpo de la respuesta para este método.The following example shows the response body for this method.

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