Compartir a través de

Administrar líneas de entrega

  • Artículo

Usa estos métodos en la API de promociones de Microsoft Store para crear una o más 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 destino y 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 debes crear una campaña publicitaria de pago con la página campañas de anuncios en el Centro de partners y debes agregar al menos un instrumento de pago en esta página. Después de hacerlo, podrá crear correctamente líneas de entrega facturables para campañas publicitarias mediante esta API. Las campañas de anuncios que cree con la API facturarán automáticamente el instrumento de pago predeterminado elegido en la página campañas de anuncios del Centro de partners.

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.

    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 de agregar 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 campañas de anuncios del Centro de partners.

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

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

Ejemplos de solicitud

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 Description Solo lectura Valor predeterminado Obligatorio para POST/PUT
id integer Identificador de la línea de entrega. Sí No
name string Nombre de la línea de entrega. No PUBLICAR
configuredStatus string Uno de los siguientes valores que especifica el estado de la línea de entrega especificada por el desarrollador:
  • Activas
  • Inactivo
 No PUBLICAR
effectiveStatus string 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:
  • Activas
  • Inactivo
  • Procesando
  • Con error
 Sí No
effectiveStatusReasons array Uno o varios de los siguientes valores que especifican el motivo del estado efectivo de la línea de entrega:
  • AdCreativesInactive
  • ValidationFailed
 Sí No
startDatetime string 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 string 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 string Fecha y hora en que se creó la línea de entrega, en formato ISO 8601. Sí No
bidType string Valor que especifica el tipo de puja de la línea de entrega. Actualmente, el único valor admitido es CPM. No CPM No
bidAmount 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. DailyBudget o lifetimeBudget deben establecerse. No POST, PUT (si lifetimeBudget no está establecido)
lifetimeBudget decimal El presupuesto de duración de la línea de entrega. Se debe establecer lifetimeBudget* o dailyBudget . No POST, PUT (si dailyBudget no está establecido)
targetingProfileId objeto En el objeto que identifica el perfil de destino que describe los usuarios, las zonas geográficas y los tipos de inventario que desea establecer como destino para esta línea de entrega. Este objeto consta de un único campo id que especifica el identificador del perfil de destino. No No
creativos array Uno o varios objetos que representan los creativos asociados a la línea de entrega. Cada objeto de este campo consta de un único campo id que especifica el identificador de un creativo. No No
campaignId integer Identificador de la campaña publicitaria primaria. No No
minMinutesPerImp integer 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
pacingType string Uno de los siguientes valores que especifican el tipo de velocidad:
  • SpendEvenly
  • SpendAsFastAsPossible
 No SpendEvenly No
currencyId integer 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