Nota
El acceso a esta página requiere autorización. Puede intentar iniciar sesión o cambiar directorios.
El acceso a esta página requiere autorización. Puede intentar cambiar los directorios.
Usa estos métodos en API de promociones de Microsoft Store para crear, editar y obtener campañas publicitarias promocionales para tu aplicación. Cada campaña que cree con este método solo se puede asociar a una aplicación.
Nota También puedes crear y administrar campañas publicitarias mediante el Centro de socios, y se puede acceder a las campañas que creas mediante programación en el Centro de socios. Para obtener más información sobre cómo administrar campañas publicitarias en el Centro de partners, consulta Crear una campaña publicitaria para tu aplicación.
Cuando usas estos métodos para crear o actualizar una campaña, normalmente también llamas a uno o varios de los siguientes métodos para administrar las líneas de entrega, los perfiles de segmentación, y los creativos que están asociados a la campaña. Para obtener más información sobre la relación entre campañas, líneas de entrega, perfiles de destino y creativos, consulta Ejecutar campañas publicitarias con los servicios de Microsoft Store.
- Administrar líneas de entrega para campañas publicitarias
- Administrar perfiles de destino para campañas publicitarias
- Administrar creativos para campañas publicitarias
Prerrequisitos
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.
Nota Como parte de los requisitos previos, asegúrese de que usted cree al menos una campaña publicitaria de pago en el Centro de Partners y que incluya al menos un instrumento de pago para la campaña publicitaria en el Centro de Partners. Las líneas de entrega de las campañas publicitarias que cree con esta API facturarán automáticamente el instrumento de pago predeterminado elegido en la página de campañas publicitarias en el Centro de Partners.
Obtener un token de acceso de Azure AD para usar en el encabezado de solicitud para los siguientes métodos. Después de obtener 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.
Cabecera
| Cabecera | Tipo | Descripción |
|---|---|---|
| Autorización | cuerda / cadena | Obligatorio. El token de acceso de Azure AD en la forma Bearer<token>. |
| Id. de seguimiento | Identificador Único Global (GUID) | Opcional. Identificador que realiza un seguimiento del flujo de llamadas. |
Parámetros
El método GET para consultar campañas publicitarias admite los siguientes parámetros de consulta opcionales.
| Nombre | Tipo | Descripción |
|---|---|---|
| saltarse | Int | Número de filas que se van a omitir en la consulta. Use este parámetro para paginar a través de conjuntos de datos. Por ejemplo, fetch=10 y skip=0 recupera las primeras 10 filas de datos, top=10 y skip=10 recupera las siguientes 10 filas de datos, etc. |
| traer | Int | Número de filas de datos que se van a devolver en la solicitud. |
| configurarColumnaDeOrdenaciónCampaña | cuerda / cadena | Ordena los Campaign objetos en el cuerpo de la respuesta por el campo especificado. La sintaxis es CampaignSetSortColumn=field, donde el campo parámetro puede ser una de las siguientes cadenas:
El valor predeterminado es createdDateTime. |
| esDescendente | Booleano | Ordena los objetos de la campaña en el cuerpo de la respuesta en orden descendente o ascendente. |
| ID de producto de tienda | cuerda / cadena | Usa este valor para devolver solo las campañas publicitarias asociadas a la aplicación con el identificador de Tienda especificado . Un ejemplo de id. de la Tienda para un producto es 9nblggh42cfd. |
| etiqueta | cuerda / cadena | Utilice este valor para devolver solo las campañas publicitarias que incluyen la etiqueta especificada en el objeto de Campaña . |
Cuerpo de la solicitud
Los métodos POST y PUT requieren un cuerpo de solicitud JSON que contenga los campos obligatorios de un objeto Campaign de y cualquier campo adicional que desee establecer o cambiar.
Solicitudes de ejemplo
En el ejemplo siguiente se muestra cómo llamar al método POST para crear una campaña publicitaria.
POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign HTTP/1.1
Authorization: Bearer <your access token>
{
"name": "Contoso App Campaign",
"storeProductId": "9nblggh42cfd",
"configuredStatus": "Active",
"objective": "DriveInstalls",
"type": "Community"
}
En el ejemplo siguiente se muestra cómo llamar al método GET para recuperar una campaña publicitaria específica.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign/31043481 HTTP/1.1
Authorization: Bearer <your access token>
En el ejemplo siguiente se muestra cómo llamar al método GET para consultar un conjunto de campañas publicitarias, ordenadas por la fecha de creación.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/campaign?storeProductId=9nblggh42cfd&fetch=100&skip=0&campaignSetSortColumn=createdDateTime HTTP/1.1
Authorization: Bearer <your access token>
Respuesta
Estos métodos devuelven un cuerpo de respuesta JSON con uno o varios objetos Campaign, según el método al que llamó. En el ejemplo siguiente se muestra un cuerpo de respuesta para el método GET para una campaña específica.
{
"Data": {
"id": 31043481,
"name": "Contoso App Campaign",
"createdDate": "2017-01-17T10:12:15Z",
"storeProductId": "9nblggh42cfd",
"configuredStatus": "Active",
"effectiveStatus": "Active",
"effectiveStatusReasons": [
"{\"ValidationStatusReasons\":null}"
],
"labels": [],
"objective": "DriveInstalls",
"type": "Paid",
"lines": [
{
"id": 31043476,
"name": "Contoso App Campaign - Paid Line"
}
]
}
}
Objeto de campaña
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.