Compartir a través de

Administrar creativos

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, canales de entrega y perfiles de segmentación, 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.

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.
  • 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.

Tipo de método Solicitud de URI Descripción
PUBLICACIÓN https://manage.devcenter.microsoft.com/v1.0/my/promotion/creative Crea una nueva creatividad.
OBTENER 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.

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.

Cuerpo de la solicitud

El método POST requiere un cuerpo de la solicitud JSON que contiene los campos requeridos de un objeto Creative.

Solicitudes de ejemplo

En el ejemplo siguiente se muestra cómo llamar al método POST para crear un anuncio publicitario. En este ejemplo, el valor de del contenido se ha reducido 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 creativo que contiene información sobre el creativo que fue creado o recuperado. En el ejemplo siguiente se muestra un cuerpo de respuesta para estos métodos. En este ejemplo, el valor de del contenido se ha reducido 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"
    }
}

Objeto creativo

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 Descripción Solo para lectura Predeterminado Obligatorio para POST
identificación entero Identificador del creativo. Sí No
nombre cuerda / cadena Nombre del creativo. No Sí
contenido cuerda / cadena El contenido de la imagen creativa, en formato codificado en Base64.

Nota 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.		 No Sí
altura entero La cúspide de la creatividad. No Sí
Ancho entero Ancho de la pieza creativa. No Sí
URL de destino cuerda / cadena 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í
formato cuerda / cadena Formato de anuncio. Actualmente, el único valor admitido es Banner. No Estandarte No
atributos de imagen ImageAttributes Proporciona atributos para la creatividad. No Sí
ID de producto de tienda cuerda / cadena La de id. de la Tienda para 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 cuerda / cadena Uno de los siguientes valores: PNG o JPG. No Sí