Gerenciar perfis de direcionamento

Artigo
09/07/2023

Use esses métodos na API de promoções da Microsoft Store para selecionar os usuários, áreas geográficas e tipos de inventário que você deseja direcionar para cada linha de entrega em uma campanha publicitária promocional. Perfis de direcionamento podem ser criados e reutilizados em várias linhas de entrega.

Para obter mais informações sobre a relação entre perfis de destino e campanhas publicitárias, linhas de entrega e ideias criativas, confira Executar campanhas publicitárias usando os serviços da Microsoft Store.

Pré-requisitos

Para usar esses métodos, primeiro você precisa fazer o seguinte:

Se você ainda não fez isso, conclua todos os pré-requisitos para a API de promoções da Microsoft Store.
Obtenha um token de acesso do Azure AD para usar no cabeçalho de solicitação para esses métodos. Após obter um token de acesso, você tem 60 minutos para usá-lo antes dele expirar. Depois que o token expirar, você poderá obter um novo.

Solicitação

Esses métodos têm as URIs a seguir.

Tipo de método	URI da solicitação	Descrição
POST	`https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile`	Cria um novo perfil de direcionamento.
PUT	`https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile/{targetingProfileId}`	Edita o perfil de direcionamento especificado por targetingProfileId.
GET	`https://manage.devcenter.microsoft.com/v1.0/my/promotion/targeting-profile/{targetingProfileId}`	Obtém o perfil de direcionamento especificado por targetingProfileId.

parâmetro	Tipo	Descrição
Autorização	string	Obrigatório. O token de acesso do Azure AD no Token<de portador> do formulário.
ID de rastreamento	GUID	Opcional. Uma ID que rastreia o fluxo de chamadas.

Corpo da solicitação

Os métodos POST e PUT exigem um corpo de solicitação JSON com os campos necessários de um objeto de perfil de direcionamento e quaisquer campos adicionais que você deseja definir ou alterar.

Exemplos de solicitação

O exemplo a seguir demonstra como chamar o método POST para criar um perfil de direcionamento.

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

O exemplo a seguir demonstra como chamar o método GET para recuperar um perfil de destino.

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

Resposta

Esses métodos retornam um corpo de resposta JSON com um objeto de Perfil de direcionamento que contém informações sobre o perfil de direcionamento que foi criado, atualizado ou recuperado. O exemplo a seguir demonstra um corpo de resposta para esses 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 direcionamento

Os corpos de solicitação e resposta para esses métodos contêm os campos a seguir. Esta tabela mostra quais campos são somente leitura (o que significa que eles não podem ser alterados no método PUT) e quais campos são necessários no corpo da solicitação para o método POST.

Campo	Type	Description	Somente leitura	Padrão	Necessário para POST
id	inteiro	A ID do perfil de destino.	Sim		Não
name	string	O nome do perfil de destino.	Não		Sim
targetingType	string	Um dos seguintes valores: Auto: especifique esse valor para permitir que a Microsoft escolha o perfil de direcionamento com base nas configurações do seu aplicativo no Partner Center. Manual: especifique esse valor para definir seu próprio perfil de direcionamento.	Não	Auto	Sim
age	array	Um ou mais inteiros que identificam as faixas etárias dos usuários a serem direcionados. Para obter uma lista completa de inteiros, confira os Valores de idade neste artigo.	Não	nulo	Não
gender	array	Um ou mais inteiros que identificam os gêneros dos usuários a serem direcionados. Para obter uma lista completa de inteiros, confira Valores de gênero neste artigo.	Não	nulo	Não
country	array	Um ou mais inteiros que identificam os códigos de país dos usuários a serem direcionados. Para obter uma lista completa de inteiros, confira Valores de código de país neste artigo.	Não	nulo	Não
osVersion	array	Um ou mais inteiros que identificam as versões do sistema operacional dos usuários a serem direcionados. Para obter uma lista completa de inteiros, confira os Valores de versão do sistema operacional neste artigo.	Não	nulo	Não
deviceType	array	Um ou mais inteiros que identificam os tipos de dispositivo dos usuários a serem direcionados. Para obter uma lista completa de inteiros, confira Valores de tipo de dispositivo neste artigo.	Não	nulo	Não
supplyType	array	Um ou mais inteiros que identificam o tipo de inventário em que os anúncios da campanha serão exibidos. Para obter uma lista completa de inteiros, confira Valores de tipo de fornecimento neste artigo.	Não	nulo	Não

Valores de idade

O campo de idade no objeto TargetingProfile contém um ou mais dos inteiros a seguir que identificam as faixas etárias dos usuários a serem direcionados.

Valor inteiro para o campo de idade	Faixa etária correspondente
651	13 a 17
652	18 a 24
653	25 a 34
654	35 a 49
655	50 ou mais

Para obter os valores com suporte para o campo de idade programaticamente, você pode chamar o método GET a seguir. Para o cabeçalho Authorization, passe o token de acesso do Azure AD no formulário Token<de portador>.

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

O exemplo a seguir mostra o corpo da resposta para esse método.

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

Valores de gênero

O campo de gênero no objeto TargetingProfile contém um ou mais dos inteiros a seguir que identificam os gêneros dos usuários a serem direcionados.

Valor inteiro para o campo de gênero	Gênero correspondente
700	Masculino
701	Feminino

Para obter os valores com suporte para o campo de gênero programaticamente, você pode chamar o método GET a seguir. Para o cabeçalho Authorization, passe o token de acesso do Azure AD no formulário Token<de portador>.

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

O exemplo a seguir mostra o corpo da resposta para esse método.

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

Valores de versão do sistema operacional

O campo osVersion no objeto TargetingProfile contém um ou mais dos inteiros a seguir que identificam as versões do sistema operacional dos usuários a serem direcionados.

Valor inteiro para o campo osVersion	Versão do sistema operacional correspondente
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 obter os valores com suporte para o campo osVersion programaticamente, você pode chamar o método GET a seguir. Para o cabeçalho Authorization, passe o token de acesso do Azure AD no formulário Token<de portador>.

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

O exemplo a seguir mostra o corpo da resposta para esse 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

O campo deviceType no objeto TargetingProfile contém um ou mais dos inteiros a seguir que identificam os tipos de dispositivo dos usuários a serem direcionados.

Valor inteiro para o campo deviceType	Tipo de dispositivo correspondente	Descrição
710	Windows	Isso representa dispositivos que executam uma versão da área de trabalho do Windows 11, Windows 10 ou Windows 8.x.
711	Telefone	Isso representa dispositivos que executam o Windows 10 Mobile, o Windows Phone 8.x ou o Windows Phone 7.x.

Para obter os valores com suporte para o campo deviceType programaticamente, você pode chamar o método GET a seguir. Para o cabeçalho Authorization, passe o token de acesso do Azure AD no formulário Token<de portador>.

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

O exemplo a seguir mostra o corpo da resposta para esse método.

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

Valores de tipo de fornecimento

O campo supplyType no objeto TargetingProfile contém um ou mais dos inteiros a seguir que identificam o tipo de inventário em que os anúncios da campanha serão mostrados.

Valor inteiro para o campo supplyType	Tipo de fornecimento correspondente	Descrição
11470	Aplicativo	Isso se refere a anúncios que aparecem somente em aplicativos.
11471	Universal	Isso se refere a anúncios que aparecem em aplicativos, na Web e em outras superfícies de exibição.

Para obter os valores com suporte para o campo supplyType programaticamente, você pode chamar o método GET a seguir. Para o cabeçalho Authorization, passe o token de acesso do Azure AD no formulário Token<de portador>.

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

O exemplo a seguir mostra o corpo da resposta para esse método.

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

Valores de código de país

O campo de país no objeto TargetingProfile contém um ou mais dos seguintes inteiros que identificam os códigos de país ISO 3166-1 alpha-2 dos usuários a serem direcionados.

Valor inteiro para o campo de país	Código do país correspondente
1	EUA
2	AU
3	AT
4	BE
5	BR
6	AC
7	DK
8	FI
9	FR
10	DE
11	GR
12	HK
13	IN
14	IE
15	TI
16	JP
17	LU
18	MX
19	NL
20	NZ
21	Não
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	P e R
55	SI
56	BG
57	LT
58	RS
59	RH
60	RH
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

Para obter os valores com suporte para o campo de país programaticamente, você pode chamar o método GET a seguir. Para o cabeçalho Authorization, passe o token de acesso do Azure AD no formulário Token<de portador>.

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

O exemplo a seguir mostra o corpo da resposta para esse 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"
    }
  }
}

Compartilhar via

Gerenciar perfis de direcionamento

Pré-requisitos

Solicitação

parâmetro

Corpo da solicitação

Exemplos de solicitação

Resposta

Objeto de perfil de direcionamento

Valores de idade

Valores de gênero

Valores de versão do sistema operacional

Valores de tipo de dispositivo

Valores de tipo de fornecimento

Valores de código de país

Comentários

Recursos adicionais

Compartilhar via

Gerenciar perfis de direcionamento

Pré-requisitos

Solicitação

parâmetro

Corpo da solicitação

Exemplos de solicitação

Resposta

Objeto de perfil de direcionamento

Valores de idade

Valores de gênero

Valores de versão do sistema operacional

Valores de tipo de dispositivo

Valores de tipo de fornecimento

Valores de código de país

Tópicos relacionados

Comentários

Recursos adicionais