Capturar datos de monetización

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Apigee usa las variables de monetización para la valoración, el cálculo del reparto de ingresos y las analíticas. Si quieres que las analíticas de Apigee muestren la información de monetización. Si usas las variables de monetización, puedes mejorar las funciones de monetización de tus transacciones.

Variables de monetización

Los nombres de las variables de monetización están predefinidos y no puedes crear, editar ni eliminar variables. Puedes asignar variables de solicitud o de respuesta a las variables de monetización.

Si quieres anular las variables de monetización, puedes hacerlo capturándolas con la política DataCapture.

En esta tabla se describen las variables de monetización disponibles en Apigee:

Variable de monetización	Tipo de datos	Descripción
currency	Cadena	Especifica la moneda que se usará para calcular los ingresos de una transacción.
perUnitPriceMultiplier	Flotante	Especifica el factor (multiplicador) por el que se multiplica el coste por transacción. El coste por transacción se especifica en la sección de precios Comisiones basadas en el consumo del plan de tarifas. La multiplicación solo se realiza en una transacción si esta se puede monetizar. Una transacción se puede monetizar si se cumple alguna de las siguientes condiciones: Si la variable transactionSuccess es true. Si la variable transactionSuccess es NULL y la variable message.status.code es 2xx (éxito).
revShareGrossPrice	Flotante	Especifica los ingresos de la transacción para calcular la parte del desarrollador. Apigee calcula la parte del desarrollador solo si has habilitado la opción de compartir ingresos en tu plan de tarifas.
transactionSuccess	booleano	Especifica si la transacción se debe monetizar. Si la variable se define como true, la transacción se monetiza. Si la variable tiene el valor false, la transacción no se monetiza. Si no especifica esta variable, las transacciones se monetizarán en función del valor del código de estado HTTP disponible en la variable message.status.code. Si el código de estado HTTP de la respuesta es NULL o >=300, no se monetiza la transacción. En el resto de los códigos de estado, la transacción se monetiza. Nota: Si el valor de transactionSuccess es cualquier otro valor que no sea booleano, la política DataCapture evalúa la variable mint.tx_success_result como false.

Nota:

• Las variables de monetización no se ven en la página Admin > Data Collectors de Apigee.
• Las variables de monetización distinguen entre mayúsculas y minúsculas.
• Aparte de los nombres de variables que se indican en la tabla, no puede proporcionar ningún otro nombre para las variables de monetización.
• Las variables de monetización no se incluyen en la API organizations.datacollectors.list.

Ejemplos de asignación de valores

En los siguientes ejemplos se muestra cómo asignar valores a las variables de monetización:

currency

En el siguiente ejemplo, se asigna el valor del elemento JSON booking[0].currency de la respuesta a la variable currency:

<Capture>
  <Collect>
    <Source>response</Source>
    <JSONPayload>
      <JSONPath>booking[0].currency</JSONPath>
    </JSONPayload>
  </Collect>
  <DataCollector scope="monetization">currency</DataCollector>
</Capture>
    

perUnitPriceMultiplier

En el siguiente ejemplo, se asigna el valor del elemento JSON booking[0].factor de la respuesta a la variable perUnitPriceMultiplier:

<Capture>
  <Collect>
    <Source>response</Source>
    <JSONPayload>
      <JSONPath>booking[0].factor</JSONPath>
    </JSONPayload>
  </Collect>
  <DataCollector scope="monetization">perUnitPriceMultiplier</DataCollector>
</Capture>
    

revShareGrossPrice

En el siguiente ejemplo se asigna el valor de la variable minPrice del encabezado de respuesta a la variable revShareGrossPrice:

<Capture>
  <Collect>
    <Source>response</Source>
    <Header name="minPrice">
      <Pattern ignoreCase="true">{$}</Pattern>
    </Header>
  </Collect>
  <DataCollector scope="monetization">revShareGrossPrice</DataCollector>
</Capture>
    

transactionSuccess

En el siguiente ejemplo se asigna el valor de la variable bookingStatus del encabezado de respuesta a la variable transactionSuccess:

<Capture>
  <Collect>
    <Source>response</Source>
    <Header name="bookingStatus">
      <Pattern ignoreCase="true">{$}</Pattern>
    </Header>
  </Collect>
  <DataCollector scope="monetization">transactionSuccess</DataCollector>
</Capture>