Compartir a través de

Administrar creativos

  • Artículo

Usa estos métodos en la API de promociones de Microsoft Store para cargar tus propios creativos personalizados para usarlos en campañas publicitarias promocionales o obtener un creativo existente. Un creativo puede estar asociado a una o más líneas de entrega, incluso en campañas publicitarias, siempre que represente la misma aplicación.

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

Nota:

Al usar esta API para cargar su propia creatividad, el tamaño máximo permitido para su creatividad es de 40 KB. Si envía un archivo creativo mayor que este, esta API no devolverá un error, pero la campaña no se creará correctamente.

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/creative Crea una nueva creatividad.
GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative/{creativeId} Obtiene el creativo especificado por creativeId.

Nota:

Actualmente, esta API no admite un método PUT.

Encabezado Tipo Descripción
Autorización string 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 la solicitud

El método POST requiere un cuerpo de solicitud JSON con los campos obligatorios de un objeto Creative .

Ejemplos de solicitud

En el ejemplo siguiente se muestra cómo llamar al método POST para crear un creativo. En este ejemplo, el valor de contenido se ha abreviado para mayor brevedad.

POST https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative HTTP/1.1
Authorization: Bearer <your access token>

{
  "name": "Contoso App Campaign - Creative 1",
  "content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAgGB...other base64 data shortened for brevity...",
  "height": 80,
  "width": 480,
  "imageAttributes":
  {
    "imageExtension": "PNG"
  }
}

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

GET https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative/106851  HTTP/1.1
Authorization: Bearer <your access token>

Respuesta

Estos métodos devuelven un cuerpo de respuesta JSON con un objeto Creative que contiene información sobre el creativo que se creó o recuperó. En el ejemplo siguiente se muestra un cuerpo de respuesta para estos métodos. En este ejemplo, el valor de contenido se ha abreviado para mayor brevedad.

{
    "Data": {
        "id": 106126,
        "name": "Contoso App Campaign - Creative 2",
        "content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAAQABAAD/2wBDAAgGB...other base64 data shortened for brevity...",
        "height": 50,
        "width": 300,
        "format": "Banner",
        "imageAttributes":
        {
          "imageExtension": "PNG"
        },
        "storeProductId": "9nblggh42cfd"
    }
}

Creative (objeto)

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 creativo. Sí No
name string Nombre del creativo. No Sí
content string El contenido de la imagen creativa, en formato codificado en Base64.

Nota El tamaño máximo permitido para tu creatividad es de 40 KB. Si envía un archivo creativo mayor que este, esta API no devolverá un error, pero la campaña no se creará correctamente.		 No Sí
alto integer La altura de la creatividad. No Sí
width integer Ancho del creativo. No Sí
landingUrl string Si usa un servicio de seguimiento de campañas como AppsFlyer, Kochava, Tune o Vungle para medir el análisis de instalación de la aplicación, asigne la dirección URL de seguimiento en este campo cuando llame al método POST (si se especifica, este valor debe ser un URI válido). Si no usa un servicio de seguimiento de campañas, omita este valor cuando llame al método POST (en este caso, esta dirección URL se creará automáticamente). No Sí
format string Formato de anuncio. Actualmente, el único valor admitido es Banner. No Banner No
imageAttributes ImageAttributes Proporciona atributos para la creatividad. No Sí
storeProductId string El identificador de la Tienda de la aplicación a la que está asociada esta campaña publicitaria. Un ejemplo de id. de la Tienda para un producto es 9nblggh42cfd. No No

ImageAttributes (objeto)

Campo Tipo Descripción Solo lectura Valor predeterminado Obligatorio para POST
imageExtension string Uno de los siguientes valores: PNG o JPG. No Sí