Servicio de contrato de miembro

Artículo
05/18/2024

Nota:

Este servicio está disponible actualmente para un conjunto limitado de clientes y empleados de Microsoft.

El campo indica pricing_version dos tipos de términos de precios.

"2007.09.01": estos son los términos de precios "heredados".
"2013.01.02": estos son los términos de precios más recientes. La mayoría de los contratos de cliente negociados después de 2013 usarán estos nuevos términos de precios. El resultado de los nuevos términos de precios es que los clientes pagan una cuota de compra por el inventario de socios y plataformas, y que los clientes pagan un revshare de vendedor diferente para los compradores en la plataforma Xandr que para los compradores pujantes.

Nota:

Este servicio solo está disponible para los usuarios administradores de Xandr que tienen el is_sales_ops campo establecido en true. Tenga en cuenta que el is_sales_ops campo solo se puede establecer en true a través de una actualización directa de la base de datos. Entre los motivos válidos para establecer is_sales_ops el campo en producción se incluyen:

Es miembro del equipo de Operaciones de ventas y es su trabajo habitual crear y actualizar contratos.
Es ingeniero, administrador de productos o ingeniero de pruebas que necesita acceso para crear o actualizar contratos para su trabajo.
Quieres ver a Katharine, Jennifer Yang y Alison llorar. (Sí, en serio).
Si está en Servicios y necesita crear o actualizar contratos en sand, debe solicitar una escritura de base de datos directa para el usuario de sand, pero comprender que no tendrá la misma funcionalidad en producción.

Advertencia

En una PUT llamada, si solo incluye contratos específicos, se eliminarán los contratos no incluidos. Por lo tanto, es mejor incluir todos los contratos en PUT.

Nota:

Actualización y eliminación de contratos

La operación de ventas solo puede actualizar los siguientes campos para los contratos en curso: notes y end_date. En el caso de los contratos anteriores, solo puede actualizar .notes Para contratos futuros, puede actualizar todos los campos.
Tenga en cuenta que si clona un contrato cuyo pricing_type es , actualice pricing_type a y, a "2013.01.02"continuación, actualícelo una vez más a "2007.09.01", los mínimos se establecerán "2007.09.01"en cero.
La operación de ventas solo puede eliminar los contratos que se encuentren en el futuro.

API de REST

Métodos HTTP	Puntos	Descripciones
`GET`	`https://api.appnexus.com/member-contract?member_id=MEMBER_ID`	Visualización de todos los contratos de un miembro específico
`GET`	`https://api.appnexus.com/member-contract` (JSON del contrato)	Visualización de un contrato específico
`POST`	`https://api.appnexus.com/member-contract` (JSON del contrato)	Adición de un nuevo contrato
`PUT`	`https://api.appnexus.com/member-contract?id=CONTRACT_ID` (JSON del contrato)	Modificación de un contrato
`DELETE`	`https://api.appnexus.com/member-contract?id=CONTRACT_ID`	Eliminación de un contrato
`GET`	`https://api.appnexus.com/member-contract/meta`	Averigüe por qué campos puede filtrar y ordenar

Campos JSON

Hay una gran intersección entre los conjuntos de campos necesarios en función de si es pricing_version"2007.09.01" (marcado a continuación como OLD) o "2013.01.02" (marcado a continuación como NEW); solo los campos que difieren entre las versiones de precios se marcan como tales en la columna ¿Viejo o Nuevo?

Campo	Tipo	Description
`id`	Entero	Identificador del contrato. Obligatorio en: `PUT`/`DELETE`, en la cadena de consulta.
`member_id`	Entero	Identificador del miembro al que se aplica el contrato.
`last_activity`	Timestamp	Fecha de la última modificación de este contrato "object".
`start_date`	datetime	Fecha y hora en que comienzan los términos del contrato. Los nuevos contratos deben comenzar en el futuro y, normalmente, el primer día de un mes. Necesario activado: `POST`
`end_date`	datetime	Fecha y hora en que finalizan los términos del contrato. Esto siempre debería llegar al final de un mes. Necesario activado: `POST`
`auction_revshare`	float	Este campo no se usa.
`auction_minimum_cpm`	float	Este campo no se usa. Anteriormente, era la cantidad mínima que el comprador acepta pagar por la tarifa del servicio de subastas, la deducción del servicio de subastas o la tarifa de compensación directa. Antiguo o Nuevo: `OLD`
`ad_serving_cpm`	float	El precio de publicación de anuncios administrados que se cobra por las impresiones guardadas (por ejemplo: guardado, valor predeterminado, PSA). Esto no representa una cuota de servicio de anuncios del vendedor CPM, que aún no está implementada en el sistema.
`auditing_fee_per_creative`	float	La cuota de auditoría por creatividad.
`creative_size_minimum_bytes`	Entero	Tamaño por encima del cual una creatividad se considera demasiado grande. Al miembro se le cobra una cuota de sobreage creativo (en función del valor de `creative_size_fee_per_gb`) por servir a una creatividad de gran tamaño.
`creative_size_fee_per_gb`	float	Cuota que se cobra por gigabyte para una creatividad que supera el valor de `creative_size_minimum_bytes`.
`monthly_minimum_spend`	float	Este campo está mal etiquetado. Las tarifas mínimas mensuales que el miembro se compromete a pagar al mes. Antiguo o Nuevo: `OLD`
`clearing_revshare`	float	La tarifa plana sacada de los ingresos de compensación por Xandr. Los miembros pueden optar por facturarse como porcentaje en su lugar (consulte `clearing_revshare_pct` a continuación).
`auction_revshare_pct`	float	Porcentaje que se cobra a los vendedores cuando venden su inventario a otros miembros. Advertencia: Este campo corresponde al nuevo `auction_revshare_platform_pct` campo y la canalización de datos la usa para los cálculos que implican los ingresos de CPA/CPC. NO QUITE ESTE CAMPO A MENOS QUE SEPA LO QUE ESTÁ HACIENDO. Antiguo o Nuevo: `OLD` Valor predeterminado: `"0.00"`
`clearing_revshare_pct`	float	Porcentaje de deducción de compensación. Esto se cobra cuando el miembro compra a un vendedor externo o asociado.
`auction_maximum_cpm`	float	Cantidad máxima que el comprador acepta pagar por impresión. Por este motivo, la suma de las tarifas y deducciones del servicio de subastas del cliente no puede ser igual a su costo multimedia total multiplicado por su revshare de subasta a finales de mes.
`apply_min_cpm_to_clearing`	booleano	Este campo no se usa. Valor predeterminado: `False`
`auction_revshare_type`	enumeración	Tipo de participación de ingresos en subastas de compradores. Valores permitidos: - `"deduction"`: al comprador se le cobra una deducción del servicio de subastas. - `"fee"`: al comprador se le cobra una tarifa del servicio de subastas. Advertencia: Este campo corresponde al nuevo `auction_revshare_platform_inv_type` campo y la canalización de datos la usa para los cálculos que implican los ingresos de CPA/CPC. NO QUITE ESTE CAMPO A MENOS QUE SEPA LO QUE ESTÁ HACIENDO. Valor predeterminado: - `"fee"` Antiguo o Nuevo: `OLD`
`pricing_version`	enumeración	Versión de precios asociada a este contrato. Con los términos de precios de 2013, los clientes pagan una cuota de compra por el inventario de socios y plataformas, y los clientes pagan un revshare de vendedor diferente para los compradores de la plataforma Xandr que para los compradores de ofertas. Tenga en cuenta también que es aceptable usar los términos de precios de 2007 si así lo dicta el contrato. Valores permitidos: - `"2007.09.01"` - `"2013.01.02"` Obligatorio activado: `POST`
`seller_type`	enumeración	Tipo de vendedor. Valores permitidos: - `"platform"`: el miembro tiene un contrato firmado que permite a Xandr tomar una deducción del vendedor de las impresiones revendidas. - `"partner"`: El miembro no tiene un contrato firmado que permita a Xandr tomar una deducción del vendedor de las impresiones revendidas, por lo que a los miembros compradores se les cobra una Cuota o Deducción del Servicio de Subastas en su lugar. Valor predeterminado: `"platform"` Obligatorio activado: `POST`
`note`	string	Una nota opcional.
`data_siphon_fee`	Entero	Cargo mensual por recibir fuentes de distribución de datos de nivel de registro de Xandr.
`mapuid_fee`	float	Cargo mensual por usar el servicio de asignación de identificadores de usuario de Xandr. Valor predeterminado: `"0.00"`
`monthly_minimum_imps`	Entero	Número mínimo de impresiones que el miembro confirma para realizar transacciones al mes.
`waive_ad_serving_fees`	booleano	Este campo no se usa. Antiguo o Nuevo: `OLD`
`adx_auction_service_fee_pct`	float	Este campo no se usa. Anteriormente, era la tarifa del servicio de subastas que se cobraba cuando los clientes compradores compran inventario de Google Ad Manager. Google Ad Manager es un caso especial, ya que son miembros de Xandr (con una `bidder_id` de `2`) pero los clientes compradores pagan a Google Ad Manager directamente y no pagan Xandr por el costo de los medios.
`direct_clear_fee_pct`	float	Porcentaje de cuota clara directa. Esto se usa para la actividad en la que el miembro borra el costo de los medios directamente con el vendedor.
`contract_type`	enumeración	Este campo ya no se usa. En el pasado, fue utilizado por el equipo financiero para la generación de informes de ingresos. Los valores permitidos eran: - `"NIB"`: este acrónimo hace referencia a una oferta de productos anterior denominada "Red en un cuadro". - `"XIB"`: este acrónimo hace referencia a una oferta de productos anterior denominada "Exchange in a box". - `"RTBX"`: este acrónimo hace referencia a una oferta de productos anterior llamada "RTB Exchange". - `"MSFT"`: un contrato de Microsoft. - `"External"`: ... - `"Partner"`: ...
`creative_audit_fee`	float	Este campo no se usa. Use `auditing_fee_per_creative` en su lugar. Anteriormente, representaba las tarifas totales de auditoría creativa.
`creative_priority_fee_1`	float	Este campo no se usa. Es un marcador de posición para el desarrollo futuro.
`creative_priority_fee_2`	float	La tarifa de auditoría prioritaria por creatividad.
`imptracker_cpm`	float	Las tarifas que se cobran por registrar impresiones de terceros.
`clicktracker_cpc`	float	Las tarifas que se cobran por grabar clics de terceros.
`auto_renewal_term`	Entero	El término de renovación automática para el miembro, si dicho término existe en el contrato firmado. Actualmente, esto solo es un marcador de posición para el término; no hay lógica de facturación asociada a este campo.
`seller_serving_cpm`	float	La tarifa basada en CPM que se cobra por cada impresión revendida. Actualmente, esto solo es un marcador de posición para la cuota; no hay lógica de facturación asociada a este campo.
`monthly_spend_based_minimum`	float	El mínimo mensual basado en el gasto total del comprador (es decir, el costo de los medios) comprado en un mes determinado. Actualmente, esto solo es un marcador de posición; no hay lógica de facturación asociada a este campo. Nuevo o Antiguo: `OLD`
`seller_revshare_pct`	float	Porcentaje de deducción del vendedor. Esto se cobra cuando el miembro vende una impresión a otro miembro.
`seller_revshare_minimum`	booleano	El mínimo de revshare del vendedor se calcula tomando el mayor de (imps seen * seller auction request cpm) o (seller revshare). Valor predeterminado: `false` Nuevo o Antiguo: `OLD`
`secure_whitelabel_pixel_fee`	float	Cargo mensual por usar el servicio Secure White Label Pixel. Actualmente, esto solo es un marcador de posición para la cuota; no hay lógica de facturación asociada a este campo.
`monthly_minimum_requests`	Entero	Número mínimo de solicitudes al mes en función del número total de impresiones que Xandr ha registrado. Actualmente, este es solo un marcador de posición para el mínimo; no hay lógica de facturación asociada a este campo. Nuevo o Antiguo: `OLD`
`managed_hosted_video_cpm`	float	Se trata de un marcador de posición para el desarrollo futuro.
`cross_net_hosted_video_cpm`	float	Se trata de un marcador de posición para el desarrollo futuro.
`seller_auction_request_cpm`	float	Cantidad que un vendedor debe pagar cada vez que nos envía una solicitud de puja. Esto se cobra incluso si no hay ninguna oferta ganadora o ninguna oferta en absoluto.
`status`	enumeración	Solo lectura. Valores permitidos: - `"in_progress"`: el contrato está actualmente en vigor. - `"in_past"`: el contrato ha finalizado. - `"in_future"`: el contrato está establecido para comenzar en el futuro. Valor predeterminado: `"in_future"`
`member_name`	string	Nombre del miembro.
`member_is_billable`	booleano	Si el miembro es facturable. Valor predeterminado: `true`
`member_note`	string	Finance and Sales Ops lo usa para registrar términos de contrato personalizados u otros requisitos de factura. Valor predeterminado: `""`
`member_enable_budget_check`	booleano	Si este miembro tiene comprobaciones de seguridad en su lugar para evitar la suspensión excesiva involuntaria. Valor predeterminado: `true`
`monthly_service_fee_minimum_1`	float	El gasto mensual mínimo al que se ha comprometido el cliente. Esta tarifa incluye el seguimiento de impresiones y clics. Antiguo o Nuevo: `OLD`
`monthly_service_fee_minimum_2`	float	El gasto mensual mínimo al que se ha comprometido el cliente. Esta tarifa no incluye el seguimiento de impresiones y clics. Antiguo o Nuevo: `OLD`
`selling_enabled`	booleano	Si este miembro está habilitado para vender su inventario. Esto se aplica a las ventas administradas y entre redes. Valor predeterminado: `true`
`seller_console_buyer_revshare_pct`	float	Este porcentaje se cobra a los vendedores cuando venden a los compradores en la plataforma Xandr.<Br Nota: El valor de este campo se copia del campo `seller_revshare_pct`heredado . Obligatorio activado: `PUT`, al actualizar a la nueva pricing_version. Antiguo o Nuevo: `New`
`seller_bidder_buyer_revshare_pct`	float	Este porcentaje se cobra a los vendedores cuando venden a postores que no son de Xandr. Obligatorio en: `PUT`, al actualizar a la nueva `pricing_version`. Antiguo o Nuevo: `New`
`auction_revshare_partner_inv_pct`	float	Porcentaje que se cobra a los compradores de tipo `"partner"` cuando compran inventario a otros miembros. Valor predeterminado: `"0.00"` Antiguo o Nuevo: `New`
`auction_revshare_partner_inv_type`	string	La forma en que se define el porcentaje en `"auction_revshare_partner_inv_pct"` se usa para cobrar a los compradores asociados. Valores permitidos: - `"deduction"`: el porcentaje acordado se resta directamente de los ingresos de la subasta del comprador. - `"fee"`: el porcentaje se cobra como una cuota después de la subasta. Nota: Es posible que no establezca un `auction_revshare_partner_inv_type` que sea diferente de `auction_revshare_platform_inv_type`. Deben ser `"fee"` o `"deduction"`. Valor predeterminado: `"fee"` Antiguo o Nuevo: `New`
`auction_revshare_platform_inv_pct`	float	Porcentaje que se cobra a los compradores de tipo `"platform"` cuando compran inventario a otros miembros. Nota: El valor de este campo se copia del campo `auction_revshare_pct`. Valor predeterminado: `"0.00"` Antiguo o Nuevo: `New`
`auction_revshare_platform_inv_type`	string	La forma en que se define el porcentaje en `"auction_revshare_platform_inv_pct"` se usa para cobrar a los compradores de la plataforma. Valores permitidos: - `"deduction"`: el porcentaje acordado se resta directamente de los ingresos de la subasta del comprador. - `"fee"`: el porcentaje se cobra como una cuota después de la subasta. Nota: - El valor de este campo se copia del campo `auction_revshare_type`. - Es posible que no establezca un `auction_revshare_platform_inv_type` que sea diferente de `auction_revshare_partner_inv_type`. Deben ser `"fee"` o `"deduction"`. Valor predeterminado: `"fee"` Antiguo o Nuevo: `New`

Ejemplos

Create y ver un contrato heredado

$ cat update.json
{
  "member-contract": {
    "start_date": "2013-01-01 00:00:00",
    "end_date": "2013-06-30 23:59:59",
    "seller_type": "platform",
    "pricing_version": "2007.09.01",
  }
}

$ curl -b cookies -X POST -d @/tmp/legacy.json "http://68.67.148.153:16011/member-contract?member_id=1309"

{
    "response": {
        
        "": "",
        "num_elements": "",
        "start_element": "",
        "id": 3794,
        "count": "",
        "status": "OK"
    }
}

$ curl -b cookies "http://68.67.148.153:16011/member-contract?id=3794"
{
    "response": {
        
        "member-contract": {
            "member_note": "",
            "member_enable_budget_check": true,
            "member_is_billable": true,
            "member_name": "i8N6LZ6uN",
            "auction_revshare_platform_inv_type": "fee",
            "auction_revshare_platform_inv_pct": 0,
            "auction_revshare_partner_inv_type": "fee",
            "auction_revshare_partner_inv_pct": 0,
            "seller_bidder_buyer_revshare_pct": "",
            "seller_console_buyer_revshare_pct": "",
            "selling_enabled": true,
            "monthly_service_fee_minimum_2": "",
            "monthly_service_fee_minimum_1": "",
            "status": "in_future",
            "seller_auction_request_cpm": "",
            "cross_net_hosted_video_cpm": "",
            "managed_hosted_video_cpm": "",
            "monthly_minimum_requests": "",
            "secure_whitelabel_pixel_fee": 0,
            "seller_revshare_minimum": false,
            "seller_revshare_pct": "",
            "monthly_spend_based_minimum": "",
            "seller_serving_cpm": 0,
            "auto_renewal_term": "",
            "clicktracker_cpc": "",
            "imptracker_cpm": "",
            "creative_priority_fee_2": 25,
            "creative_priority_fee_1": 0,
            "creative_audit_fee": 0,
            "contract_type": "",
            "direct_clear_fee_pct": "",
            "adx_auction_service_fee_pct": "",
            "waive_ad_serving_fees": false,
            "monthly_minimum_imps": "",
            "mapuid_fee": 0,
            "data_siphon_fee": "",
            "note": "",
            "seller_type": "platform",
            "pricing_version": "2007.09.01",
            "auction_revshare_type": "fee",
            "apply_min_cpm_to_clearing": false,
            "auction_maximum_cpm": "",
            "clearing_revshare_pct": "",
            "auction_revshare_pct": "",
            "clearing_revshare": "",
            "monthly_minimum_spend": "",
            "creative_size_fee_per_gb": "",
            "creative_size_minimum_bytes": "",
            "auditing_fee_per_creative": "",
            "ad_serving_cpm": "",
            "auction_minimum_cpm": "",
            "auction_revshare": "",
            "end_date": "2013-06-30 23:59:59",
            "start_date": "2013-01-01 00:00:00",
            "last_activity": "2012-12-20 16:03:38",
            "member_id": 1309,
            "id": 3794
        },
        "num_elements": "",
        "start_element": "",
        "count": 1,
        "status": "OK"
    }
}

Create y ver un contrato con el actual`pricing_version`

$ cat update.json
{
  "member-contract": {
    "start_date": "2013-01-01 00:00:00",
    "end_date": "2013-06-30 23:59:59",
    "seller_type": "platform",
    "pricing_version": "2013.01.02",
    "auction_revshare_partner_inv_type": "fee",
    "auction_revshare_platform_inv_type": "fee"
  }
}

$ curl -b cookies -c cookies -X POST -d @update.json "https://api.appnexus.com/member-contract?member_id=1309"

{"response":{"status":"OK","count":null,"id":7543,"start_element":null,"num_elements":null,"":null,}}

$ curl -b cookies "http://68.67.148.153:16011/member-contract?member_id=4"
{
  "response": {
    "status": "OK",
    "count": 1,
    "start_element": null,
    "num_elements": null,
    "member-contracts": [
      {
        "id": 7543,
        "member_id": 4,
        "last_activity": "2012-12-07 18:30:12",
        "start_date": "2013-01-01 00:00:00",
        "end_date": "2013-06-30 23:59:59",
        "auction_revshare": null,
        "ad_serving_cpm": null,
        "auditing_fee_per_creative": null,
        "creative_size_minimum_bytes": null,
        "creative_size_fee_per_gb": null,
        "clearing_revshare": null,
        "clearing_revshare_pct": null,
        "auction_maximum_cpm": null,
        "apply_min_cpm_to_clearing": false,
        "pricing_version": "2013.01.02",
        "seller_type": "platform",
        "note": null,
        "data_siphon_fee": null,
        "mapuid_fee": "0.00",
        "waive_ad_serving_fees": false,
        "adx_auction_service_fee_pct": null,
        "direct_clear_fee_pct": null,
        "contract_type": null,
        "creative_audit_fee": "0.00",
        "creative_priority_fee_1": "0.00",
        "creative_priority_fee_2": "25.00",
        "imptracker_cpm": null,
        "clicktracker_cpc": null,
        "auto_renewal_term": null,
        "seller_serving_cpm": "0.0000",
        "secure_whitelabel_pixel_fee": "0.00",
        "managed_hosted_video_cpm": null,
        "cross_net_hosted_video_cpm": null,
        "seller_auction_request_cpm": null,
        "status": "in_future",
        "selling_enabled": true,
        "seller_console_buyer_revshare_pct": null,
        "seller_bidder_buyer_revshare_pct": null,
        "auction_revshare_partner_inv_pct": "0.00",
        "auction_revshare_partner_inv_type": "fee",
        "auction_revshare_platform_inv_pct": "0.00",
        "auction_revshare_platform_inv_type": "fee",
        "member_name": "6Ax3NT0ST",
        "member_is_billable": true,
        "member_enable_budget_check": true
      }
    ]
  }
  }

Compartir a través de

Servicio de contrato de miembro

API de REST

Campos JSON

Ejemplos

Create y ver un contrato heredado

Create y ver un contrato con el actual`pricing_version`

Recursos adicionales

Compartir a través de

Servicio de contrato de miembro

API de REST

Campos JSON

Ejemplos

Create y ver un contrato heredado

Create y ver un contrato con el actualpricing_version

Recursos adicionales

Create y ver un contrato con el actual`pricing_version`