Servicio de cuota de asociados

Artículo
05/17/2024

Nota:

Las tarifas de asociados son una mejora y un reemplazo de las tarifas de agente para los artículos de línea aumentadas (ALI).

Si necesita reservar una parte de su presupuesto para costos de terceros (costos que se deben a terceros que no sean el publicador), puede definir esta información con el servicio de tarifas de asociados. Las tarifas se pueden realizar en función de un CPM, un recurso compartido de costos o un recurso compartido de ingresos, y se pueden aplicar a varios anunciantes y artículos de línea, si lo desea. Un solo anunciante o artículo de línea puede tener varias tarifas aplicadas.

Las tarifas comunes para las que es posible que deba presupuestar son:

Tarifas de publicación de anuncios de anunciantes y tarifas de hospedaje creativo, que se cobran por entregar los recursos creativos de un artículo de línea.
Tarifas de datos que Xandr no borra como parte de Data Marketplace.
Tasas de informes posteriores a la puja: por ejemplo, usar un píxel para realizar un seguimiento de dónde se atienden las impresiones y, a continuación, auditar con carácter retroactivo cuántas transacciones infringieron los estándares de seguridad de la marca.
Acuerdos de recursos compartidos de ingresos con otros asociados de tecnología de anuncios.
Tarifas incrementales cobradas por un intermediario al anunciante, como una tarifa de servicio administrada o una cuota de consultoría.

API de REST

Http (método)	Endpoint	Description
`GET`	`https://api.appnexus.com/partner-fee?advertiser_id=ADVERTISER_ID`	Ver todas las tarifas de partner para un anunciante.
`GET`	`https://api.appnexus.com/partner-fee?id=PARTNER_FEE_ID`	Ver una cuota de partner específica.
`POST`	`https://api.appnexus.com/partner-fee`	Create una nueva cuota de partner.
`PUT`	`https://api.appnexus.com/partner-fee?id=PARTNER_FEE_ID`	Modificar una cuota de asociado.
`DELETE`	`https://api.appnexus.com/partner-fee?id=PARTNER_FEE_ID`	Eliminar una cuota de partner. Nota: Solo puede eliminar una tarifa que no se aplique a ningún artículo de línea.

Campos JSON

Campo	Tipo	Description
`advertisers`	Asignación	Los anunciantes para los que es elegible esta cuota. Este campo debe pasarse como una matriz de objeto con el formato siguiente: `[{'id':ADVERTISER_ID_1},{'id'}:ADVERTISER_ID_2}]`
`apply_to_deals`	bool	Determina si esta tarifa se aplica a las ofertas. Obligatorio activado: `POST` Valor predeterminado: `true`
`apply_to_managed`	bool	Determina si esta tarifa se aplica al inventario administrado. Obligatorio activado: `POST` Valor predeterminado: `true`
`apply_to_rtb`	bool	Determina si esta tarifa se aplica al inventario de RTB. Obligatorio activado: `POST` Valor predeterminado: `true`
`available_for_all_advertisers`	bool	Cuando `true`es , esta cuota es apta para aplicarse a todos los anunciantes para este miembro. Esto solo está disponible para los usuarios con acceso a nivel de miembro. Valor predeterminado: `false`
`description`	text	Opcional. Descripción proporcionada por el usuario de la tarifa.
`currency`	char(3)	Moneda en la que se calcula la cuota. - Si `partner_fee_payment_type_id` es cpm, se requiere un valor. - Si `partner_fee_payment_type_id` es `revshare`, este campo debe ser `null`. Use el Servicio de moneda para ver una lista de las monedas disponibles.
`id`	Entero	Identificador único de la tarifa. Obligatorio activado: `PUT` y `DELETE` Valor predeterminado: número generado automáticamente.
`name`	varchar(255)	Nombre de la cuota. Obligatorio activado: `POST`
`partner_fee_payment_type_id`	Entero	Determina el tipo de pago de esta cuota: - `"1"` para cpm. Si cpm está seleccionado, debe especificar la moneda con la moneda. - `"2"` para el uso compartido de ingresos. Obligatorio activado: `POST`
`partner_fee_basis_id`	Entero	Determina la base de la que se deriva una cuota porcentual. - `"1"` para el costo de medios netos. - `"2"` para el costo medio bruto (costo multimedia incluido BASC. - `"3"` para el costo de medios neto (costo multimedia sin BASC) + costos de datos. - `"4"` para el costo medio bruto (costo multimedia incluido BASC) + costos de datos. - `"5"` para los ingresos. Las tarifas de CPM solo se pueden establecer en `"5"` (ingresos). Obligatorio activado: `POST`
`partner_fee_type_id`	Entero	Define el tipo de cuota. Los valores admitidos son los siguientes: - `"1"` para la publicación de anuncios - `"2"` para el algoritmo - `"3"` para datos - `"4"` para la generación de informes - `"5"` para el servicio - `"6"` para la tecnología - `"7"` para la visualización - `"8"` para otros Obligatorio activado: `POST`
`partner_fee_vendor_id`	Entero	El identificador del proveedor que cobra la tarifa. Los valores admitidos son los siguientes: - `"1"` para Adloox - `"2"` para ComScore - `"3"` para DoubleClick - `"4"` para DoubleVerify - `"5"` para Evidon - `"6"` para flashtalking - `"7"` para Ghostery - `"8"` para GroovinAds - `"9"` para ciencia de anuncios integrales (IAS) - `"10"` para MOAT - `"11"` para el noveno decimal - `"12"` para Sizmek - `"13"` para TrustArc - `"14"` para el proveedor personalizado 1 - `"15"` para el proveedor personalizado 2 - `"16"` para el proveedor personalizado 3 - `"17"` para el proveedor personalizado 4 - `"18"` para el proveedor personalizado 5 Los proveedores personalizados aparecerán como proveedor personalizado 1, proveedor personalizado 2, etc. en los informes. Se recomienda incluir el nombre del asociado en el campo nombre de la cuota para facilitar la identificación. Obligatorio activado: `POST`
`required`	bool	Cuando `true`sea , esta cuota será necesaria y se aplicará a todos los nuevos artículos de línea para anunciantes elegibles. No se aplicará automáticamente de forma retroactiva a los elementos de línea existentes. Nota: No se puede quitar una cuota de un elemento de línea si `required` es `true`. Primero debe establecer en `requiredfalse` y, a continuación, quitar la cuota del artículo de línea. Valor predeterminado: `false`
`value`	decimal(15,5)	La tarifa que se está cobrando. - Si el tipo de pago es `cpm`, este valor estará en el definido `currency`. - Si el tipo de pago es ingresos compartidos, el valor debe ser una fracción entre `0` y `1`. Por ejemplo, un 0,1 especifica una cuota de revshare del 10 %. Obligatorio activado: `POST`

Ejemplos

Create una cuota de asociado

$ cat partner-fee.json

{
    "partner_fee": {
        "name" : "Test1",
        "apply_to_managed" : true,
        "apply_to_rtb" : true,
        "apply_to_deals" : true,
        "value" : .5,
        "partner_fee_vendor_id" : 3,
        "partner_fee_payment_type_id" : 2,
        "partner_fee_basis_id" : 2,
        "partner_fee_type_id" : 1,
        "required" : true,
        "advertisers" : [
            {
                "id" : 1
            }
        ]
    }
}

$curl -b cookie -X POST -d @partner-fee.json "https://api.appnexus.com/partner-fee"

{
    "response": {
        "status" : "OK",
        "id": 4401
    }
}

Ver los detalles de una cuota de partner

$ curl -b cookie "https://api.appnexus.com/partner-fee?id=4401"

{
    "response": {
        "status": "OK",
        "partner_fees": [
            {
                "name" : "Test1",
                "apply_to_managed" : true,
                "apply_to_rtb" : true,
                "apply_to_deals" : true,
                "currency" : null,
                "value" : .5,
                "partner_fee_vendor_id" : 3,
                "partner_fee_payment_type_id" : 2,
                "partner_fee_basis_id" : 2,
                "partner_fee_type_id" : 1,
                "required" : true,
                "advertisers" : [
                    {
                      "id" : 1
                    }
                ]
            }        
        ]
    }
}

$ curl -b cookie "https://api.appnexus.com/partner-fee?apply_to_managed=true&partner_fee_payment_type_id=2"

{
    "response": {
        "count": "2",
        "partner_fees": [
            {
                "id" : 4401,
                "name" : "Test1",
                "apply_to_managed" : true,
                "apply_to_rtb" : true,
                "apply_to_deals" : true,
                "value" : .1,
                "partner_fee_vendor_id" : 3,
                "partner_fee_payment_type_id" : 2,
                "partner_fee_basis_id" : 2,
                "partner_fee_type_id" : 1,
                "required" : true,
                "available_for_all_advertisers": true,
                "advertisers" : [
                ]
            },
            {
                "id" : 4402,
                "name" : "Test2",
                "apply_to_managed" : true,
                "apply_to_rtb" : false,
                "apply_to_deals" : false,
                "currency" : "null",
                "value" : .5,
                "partner_fee_vendor_id" : 14,
                "partner_fee_payment_type_id" : 2,
                "partner_fee_basis_id" : 2,
                "partner_fee_type_id" : 6,
                "required" : false,
                "available_for_all_advertiser" : true,
                "advertisers" : [
                ]
            } 
        ]
    }
}

Cambio del tipo de pago de una cuota de asociado

$ cat partner-fee.json

{
    "partner_fee": {
        "currency" : USD,
        "value" : 1.2,
        "partner_fee_payment_type_id" : 1,
        "partner_fee_basis_id": 5 
    }
}

$ curl -b cookie -X PUT -d @partner-fee.json "https://api.appnexus.com/partner-fee?id=4401"

{
    "response": {
        "status" : "OK",
        "id": 4401
    }
}

Aplicar una cuota de asociado a un artículo de línea

$ cat LI-update.json

{       
    "line-item": {
        "partner_fees": [
            {
                "id": 4401
            },
            { 
                "id": 4402
            }
        ]
    }
}

$ curl -b cookie -X PUT -d @LI-update.json "https://api.appnexus.com/line-item?id=2345432"

{
    "response": {
        "status" : "OK",
        "id": 2345432
    }
}

Eliminación de una cuota de un artículo de línea

$ curl -b cookie -x GET "https://api.appnexus.com/line-item?id=1234"

 {
    "line-item": {
        ...,
        "partner_fees": [
            {
                "id": 1
            },
            {
                "id": 2
            }, 
            {
                "id": 3
            }
        ],
        ...
    }
}


$ cat LI-update.json

{
    "line-item": {
        "partner_fees": [
            {
                "id": 1
            },
            {
                "id": 3
            } 
        ]
    }
}

$ curl -b cookie -X PUT "https://api.appnexus.com/line-item?id=1234"

{
    "line-item": {
        ...,
        "partner_fees": [
            {
                "id": 1
            },
            {
                "id": 3
            }
        ],
        ...
    }
}

$ curl -b cookie -x GET "https://api.appnexus.com/line-item?id=1234"

 {
    "line-item": {
        ...,
        "partner_fees": [
            {
                "id": 1
            }, 
            {
                "id": 3
            }
        ],
        ...
    }
}

Nota:

No se puede quitar una cuota de un elemento de línea si required es true. Primero debe establecer en requiredfalse y, a continuación, quitar la cuota del artículo de línea.

Quitar una cuota de un anunciante

$ curl -b cookie -x GET "https://api.appnexus.com/advertiser?id=5678"

 {
    "advertiser": {
        ...,
        "partner_fees": [
            {
                "id": 1
            },
            {
                "id": 2
            }, 
            {
                "id": 3
            }
        ],
        ...
    }
}



$ cat partner-fee-update.json

{
    "partner-fee": {
        "advertisers": [
            {
                "id": 5677
            },
            {
                "id": 5679
            }
        ]
    }
}

$ curl -b cookie -X PUT -d @partner-fee-update.json "https://api.appnexus.com/partner-fee?id=1"

{
    "response": {
        "status" : "OK",
        "id": 1
    }
}

No puedes quitar una cuota de un anunciante si la tarifa se aplica actualmente a cualquiera de los artículos de línea de ese anunciante. Primero debe quitar la cuota de cualquier artículo de línea y, a continuación, quitar la cuota del anunciante.

Compartir a través de

Servicio de cuota de asociados

API de REST

Campos JSON

Ejemplos

Create una cuota de asociado

Ver los detalles de una cuota de partner

Cambio del tipo de pago de una cuota de asociado

Aplicar una cuota de asociado a un artículo de línea

Eliminación de una cuota de un artículo de línea

Quitar una cuota de un anunciante

Recursos adicionales

Compartir a través de

Servicio de cuota de asociados

API de REST

Campos JSON

Ejemplos

Create una cuota de asociado

Ver los detalles de una cuota de partner

Visualización de las cuotas de asociados de distribución de ingresos para el inventario administrado

Cambio del tipo de pago de una cuota de asociado

Aplicar una cuota de asociado a un artículo de línea

Eliminación de una cuota de un artículo de línea

Quitar una cuota de un anunciante

Recursos adicionales