Compartir a través de

Administrar líneas de entrega

Usa estos métodos en la API de promociones de Microsoft Store para crear una o varias líneas de entrega para comprar inventario y entregar tus anuncios para una campaña publicitaria promocional. Para cada línea de entrega, puedes establecer la segmentación, establecer el precio de la oferta y decidir cuánto quieres gastar estableciendo un presupuesto y vinculando a creativos que quieras usar.

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

Nota Para poder crear correctamente líneas de entrega para campañas publicitarias con esta API, primero debe crear una campaña publicitaria de pago mediante la página Campañas publicitarias en el Centro de sociosy debe agregar al menos un instrumento de pago en dicha página. Después de hacerlo, podrá crear correctamente líneas de entrega facturables para campañas publicitarias mediante esta API. Las campañas publicitarias que cree con la API facturarán automáticamente el instrumento de pago predeterminado elegido en la página campañas publicitarias en el Centro de Partners.

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 crear al menos una campaña publicitaria de pago en el Centro de Partners y que agregue al menos un instrumento de pago para la campaña publicitaria en el Centro de Partners. Las líneas de entrega que cree con esta API facturarán automáticamente el instrumento de pago predeterminado elegido en la página de campañas publicitarias de en el Centro de socios.

  • 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/line Crea una nueva línea de entrega.
PON https://manage.devcenter.microsoft.com/v1.0/my/promotion/line/{lineId} Edita la línea de entrega especificada por lineId.
OBTENER https://manage.devcenter.microsoft.com/v1.0/my/promotion/line/{lineId} Obtiene la línea de entrega especificada por lineId.
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

Los métodos POST y PUT requieren un cuerpo de solicitud JSON con los campos obligatorios de una línea de entrega objeto y los campos adicionales que desee establecer o cambiar.

Solicitudes de ejemplo

En el ejemplo siguiente se muestra cómo llamar al método POST para crear una línea de entrega.

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

{
    "name": "Contoso App Campaign - Paid Line",
    "configuredStatus": "Active",
    "startDateTime": "2017-01-19T12:09:34Z",
    "endDateTime": "2017-01-31T23:59:59Z",
    "bidAmount": 0.4,
    "dailyBudget": 20,
    "targetProfileId": {
        "id": 310021746
    },
    "creatives": [
        {
            "id": 106851
        }
    ],
    "campaignId": 31043481,
    "minMinutesPerImp ": 1
}

En el ejemplo siguiente se muestra cómo llamar al método GET para recuperar una línea de entrega.

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

Respuesta

Estos métodos devuelven un cuerpo de respuesta JSON con un objeto de línea de entrega que contiene información sobre la línea de entrega que se creó, actualizó o recuperó. En el ejemplo siguiente se muestra un cuerpo de respuesta para estos métodos.

{
    "Data": {
        "id": 31043476,
        "name": "Contoso App Campaign - Paid Line",
        "configuredStatus": "Active",
        "effectiveStatus": "Active",
        "effectiveStatusReasons": [
            "{\"ValidationStatusReasons\":null}"
        ],
        "startDateTime": "2017-01-19T12:09:34Z",
        "endDateTime": "2017-01-31T23:59:59Z",
        "createdDateTime": "2017-01-17T10:28:34Z",
        "bidType": "CPM",
        "bidAmount": 0.4,
        "dailyBudget": 20,
        "targetProfileId": {
            "id": 310021746
        },
        "creatives": [
            {
                "id": 106126
            }
        ],
        "campaignId": 31043481,
        "minMinutesPerImp ": 1,
        "pacingType ": "SpendEvenly",
        "currencyId ": 732
    }
}

Objeto de línea de entrega

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 los métodos POST o PUT.

Campo Tipo Descripción Solo para lectura Predeterminado Obligatorio para POST/PUT
identificación entero Identificador de la línea de entrega. Sí No
nombre cuerda / cadena Nombre de la línea de entrega. No PUBLICACIÓN
estadoConfigurado cuerda / cadena Uno de los siguientes valores que especifica el estado de la línea de entrega especificada por el desarrollador:
  • Activo
  • Inactivo
 No PUBLICACIÓN
effectiveStatus cuerda / cadena Uno de los siguientes valores que especifica el estado efectivo de la línea de entrega en función de la validación del sistema:
  • Activo
  • Inactivo
  • Procesando
  • Fallido
 Sí No
razones del estado efectivo arreglo Uno o varios de los siguientes valores que especifican el motivo del estado efectivo de la línea de entrega:
  • AdCreativesInactive
  • ValidaciónFallida
 Sí No
startDatetime cuerda / cadena Fecha y hora de inicio de la línea de entrega, en formato ISO 8601. Este valor no se puede cambiar si ya está en el pasado. No POST, PUT
endDatetime cuerda / cadena Fecha y hora de finalización de la línea de entrega, en formato ISO 8601. Este valor no se puede cambiar si ya está en el pasado. No POST, PUT
createdDatetime cuerda / cadena Fecha y hora en que se creó la línea de entrega, en formato ISO 8601. Sí No
tipo de oferta cuerda / cadena Se trata de un valor que especifica el tipo de puja de la línea de entrega. Actualmente, el único valor admitido es CPM. No Coste por Mil (CPM) No
monto de la oferta decimal Cantidad de oferta que se usará para pujar cualquier solicitud de anuncio. No Valor medio de CPM basado en los mercados de destino (este valor se revisa periódicamente). No
dailyBudget decimal Presupuesto diario para la línea de entrega. Se deben establecer dailyBudget o lifetimeBudget. No POST, PUT (si no se establece lifetimeBudget)
presupuesto vitalicio decimal El presupuesto de duración de la línea de entrega. Es necesario establecer lifetimeBudget* o dailyBudget. No POST, PUT (si dailyBudget no está configurado)
targetingProfileId objeto Es el objeto que identifica el perfil de destino que describe los usuarios, las zonas geográficas y los tipos de inventario que desea orientar para esta línea de entrega. Este objeto consta de un único id campo que especifica el identificador del perfil de destino. No No
creativos arreglo Uno o varios objetos que representan los creativos que están relacionados con la línea de distribución. Cada objeto de este campo consta de un único id campo que especifica el identificador de un creativo. No No
ID de campaña entero Identificador de la campaña publicitaria principal. No No
minMinutosPorImp entero Especifica el intervalo de tiempo mínimo (en minutos) entre dos impresiones mostradas al mismo usuario desde esta línea de entrega. No 4000 No
tipo de ritmo cuerda / cadena Uno de los siguientes valores que especifican el tipo de velocidad:
  • GastarEquitativamente
  • GastarTanRápidoComoSeaPosible
 No SpendEvenly No
identificadorDeMoneda entero Identificador de la moneda de la campaña. Sí Moneda de la cuenta de desarrollador (no es necesario especificar este campo en llamadas POST o PUT) No