Servicio deal buyer setting

Artículo
07/05/2024

El Servicio de configuración de compradores de ofertas permite a los compradores proporcionar a las ofertas un alias interno para mayor claridad en la interfaz de usuario y asignar un estado a las ofertas para que los compradores tengan más control sobre las ofertas a las que se dirigen. Tenga en cuenta que esta configuración de la oferta solo está disponible para los compradores que las crearon y no son visibles para el vendedor de la oferta.

Nota:

Los compradores pueden usar Deal Buyer Access Saervice para ver las ofertas disponibles para ellos y el deal_targetscampo en el Servicio de perfil para dirigirse a ellas. Los vendedores pueden usar el Servicio de oferta para configurar y administrar ofertas.

API de REST

Http (método)	Endpoint	Description
`GET`	`https://api.appnexus.com/deal-buyer-setting`	Ver toda la configuración de la oferta.
`GET`	`https://api.appnexus.com/deal-buyer-setting?id=ID`	Ver una configuración de oferta específica.
`GET`	`https://api.appnexus.com/deal-buyer-setting?deal_id=DEAL_ID`	Vea la configuración de una oferta específica.
`GET`	`https://api.appnexus.com/deal-buyer-setting?id=1,2,3`	Vea la configuración de varias ofertas por identificador mediante una lista separada por comas.
`GET`	`https://api.appnexus.com/deal-buyer-setting/meta`	Averigüe por qué campos puede filtrar y ordenar.
`POST`	`https://api.appnexus.com/deal-buyer-setting`	Agregue la configuración de una oferta.
`PUT`	`https://api.appnexus.com/deal-buyer-setting?id=ID`	Modificar la configuración de una oferta.

Campos JSON

Campo	Tipo	Descripción
`acceptance_status`	string	Estado de la oferta: - `active` - `inactive` - `declined` - `pending` Nota: `pending` el estado no se permite en una `PUT` solicitud Valor predeterminado: el valor predeterminado de este campo depende del valor del `member.default_accept_deals` campo (consulte Servicio de miembros). Si `member.default_accept_deals` es `true`, el valor predeterminado de `acceptance_status` es `active`; si `member.default_accept_deals` es `false`, el valor predeterminado de `acceptance_status` es `pending`.
`buyer_bidder_id`	Entero	Id. del pujador del miembro. Para los compradores, siempre será `2`. Solo lectura Valor predeterminado: `null`
`buyer_member_id`	Entero	El identificador del miembro que puede comprar la oferta. Una oferta se configurará con un identificador de miembro del comprador o un código de asiento del comprador. Este es el identificador de miembro de Xandr. Solo lectura
`buyer_seat_code`	string	El código del asiento del comprador que puede comprar la oferta. Una oferta se configurará con un identificador de miembro del comprador o un código de asiento del comprador. Este es el identificador de miembro de Xandr. Solo lectura Valor predeterminado: `null`
`comments`	string (65534)	Aún no la usa la interfaz de usuario. Los comentarios personalizados que se van a mostrar en la interfaz de usuario para la oferta. Valor predeterminado: `null`
`deal_id`	Entero	Identificador de la oferta a la que se aplica la configuración. Obligatorio activado: `POST`
`deal_alias`	string (254)	Alias de la oferta, como aparecerá en la interfaz de usuario. Valor predeterminado: `null`
`id`	Entero	Identificador de la configuración de la oferta Obligatorio activado: `PUT` Valor predeterminado: número incrementado automáticamente.

Ejemplos

Agregar configuración de oferta

Si ya se ha creado un objeto deal-buyer-setting para la oferta, la solicitud POST devolverá el siguiente mensaje de error: "The buyer_member_id, deal_id combination was not unique." Para modificar esta opción deal-buyer-setting, primero realice una GEThttps://api.appnexus.com/deal-buyer-setting?deal_id=DEAL_ID solicitud para devolver el identificador de configuración del comprador de la oferta. A continuación, use el identificador de configuración del comprador de la oferta con una PUThttps://api.appnexus.com/deal-buyer-setting?id=ID solicitud para modificar la configuración del comprador de la oferta.

$ cat deal_settings.json
 
{
    "deal-buyer-setting": {
        "deal_id": 22896,
        "deal_alias": "This is an alias",
        "comments": "this is a comment on a deal",
        "acceptance_status": "active"
    }
}

$ curl -b cookies -c cookies -X POST -d @deal_settings.json 'https://api.appnexus.com/deal-buyer-setting'

{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "12005",
        "start_element": 0,
        "num_elements": 100,
        "deal-buyer-setting": {
            "id": 12005,
            "deal_id": 22896,
            "deal_alias": "This is an alias",
            "comments": "this is a comment on a deal",
            "buyer_member_id": 546,
            "acceptance_status": "active"
        }
    }
}

Modificar la configuración de la oferta

$ cat deal_settings_update.json
 
{
    "deal-buyer-setting": {
        "deal_alias": "new deal alias"
    }
}

$ curl -b cookies -c cookies -X PUT -d @deal_settings_update.json 'https://api.appnexus.com/deal-buyer-setting?id=11777'
 
{
    "response": {
        "status": "OK",
        "count": 1,
        "id": "11777",
        "start_element": 0,
        "num_elements": 100,
        "deal-buyer-setting": {
            "id": 11777,
            "deal_id": 560402,
            "deal_alias": "new deal alias",
            "comments": null,
            "buyer_member_id": 546,
            "acceptance_status": "active"
        }
    }
}

Ver toda la configuración de la oferta

$ curl -b cookies -c cookies 'https://api.appnexus.com/deal-buyer-setting'
 
{
    "response": {
        "status": "OK",
        "start_element": 0,
        "num_elements": 100,
        "deal-buyer-settings": [
            {
                "id": 9980,
                "deal_id": 558605,
                "deal_alias": null,
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            },
            {
                "id": 10950,
                "deal_id": 559575,
                "deal_alias": null,
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            },
            {
                "id": 11777,
                "deal_id": 560402,
                "deal_alias": "new deal alias",
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            }, 
            {
                "id": 1802,
                "deal_id": 550427,
                "deal_alias": null,
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            },
            {
                "id": 1937,
                "deal_id": 550562,
                "deal_alias": null,
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            }
        ]
    }
}

Ver la configuración de un identificador de configuración de oferta específico

$ curl -b cookies -c cookies 'https://api.appnexus.com/deal-buyer-setting?id=11777'

{
    "response": {
        "status": "OK",
        "start_element": 0,
        "num_elements": 100,
        "deal-buyer-settings": [
            {
                "id": 11777,
                "deal_id": 560402,
                "deal_alias": "new deal alias",
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            }
        ]
    }
}

Visualización de la configuración de un identificador de oferta específico

$ curl -b cookies -c cookies 'https://api.appnexus.com/deal-buyer-setting?deal_id=560402'

{
    "response": {
        "status": "OK",
        "start_element": 0,
        "num_elements": 100,
        "deal-buyer-settings": [
            {
                "id": 11777,
                "deal_id": 560402,
                "deal_alias": "new deal alias",
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            }
        ]
    }
}

Visualización de la configuración de varios identificadores de oferta

$ curl -b cookies -c cookies 'https://api.appnexus.com/deal-buyer-setting?deal_id=560402,559575,558605'

{
    "response": {
        "status": "OK",
        "start_element": 0,
        "num_elements": 100,
        "deal-buyer-settings": [
            {
                "id": 9980,
                "deal_id": 558605,
                "deal_alias": null,
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            },
            {
                "id": 10950,
                "deal_id": 559575,
                "deal_alias": null,
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            },
            {
                "id": 11777,
                "deal_id": 560402,
                "deal_alias": "deal alias",
                "comments": null,
                "buyer_member_id": 546,
                "acceptance_status": "active"
            }
        ]
    }
}

Compartir a través de