def track_completed_refund(sender, refund=None, **kwargs): # pylint: disable=unused-argument
"""Emit a tracking event when a refund is completed."""
if not (is_segment_configured() and refund.total_credit_excl_tax > 0):
return
user_tracking_id, lms_client_id, lms_ip = parse_tracking_context(
refund.user)
refund.order.site.siteconfiguration.segment_client.track(
user_tracking_id,
'Order Refunded',
{
'orderId':
refund.order.number,
'products': [{
'id': line.order_line.partner_sku,
'quantity': line.quantity,
} for line in refund.lines.all()],
},
context={
'ip': lms_ip,
'Google Analytics': {
'clientId': lms_client_id
}
},
)
def track_completed_order(sender, order=None, **kwargs): # pylint: disable=unused-argument
"""Emit a tracking event when an order is placed."""
if not (is_segment_configured() and order.total_excl_tax > 0):
return
user_tracking_id, lms_client_id = parse_tracking_context(order.user)
analytics.track(
user_tracking_id,
'Completed Order',
{
'orderId': order.number,
'total': str(order.total_excl_tax),
'currency': order.currency,
'products': [
{
# For backwards-compatibility with older events the `sku` field is (ab)used to
# store the product's `certificate_type`, while the `id` field holds the product's
# SKU. Marketing is aware that this approach will not scale once we start selling
# products other than courses, and will need to change in the future.
'id': line.partner_sku,
'sku': mode_for_seat(line.product),
'name': line.product.course.id,
'price': str(line.line_price_excl_tax),
'quantity': line.quantity,
'category': line.product.get_product_class().name,
} for line in order.lines.all()
],
},
context={
'Google Analytics': {
'clientId': lms_client_id
}
},
)
def track_completed_order(sender, order=None, **kwargs): # pylint: disable=unused-argument
"""Emit a tracking event when an order is placed."""
if not (is_segment_configured() and order.total_excl_tax > 0):
return
user_tracking_id, lms_client_id = parse_tracking_context(order.user)
analytics.track(
user_tracking_id,
"Completed Order",
{
"orderId": order.number,
"total": str(order.total_excl_tax),
"currency": order.currency,
"products": [
{
# For backwards-compatibility with older events the `sku` field is (ab)used to
# store the product's `certificate_type`, while the `id` field holds the product's
# SKU. Marketing is aware that this approach will not scale once we start selling
# products other than courses, and will need to change in the future.
"id": line.partner_sku,
"sku": line.product.attr.certificate_type,
"name": line.product.title,
"price": str(line.line_price_excl_tax),
"quantity": line.quantity,
"category": line.product.get_product_class().name,
}
for line in order.lines.all()
],
},
context={"Google Analytics": {"clientId": lms_client_id}},
)
def track_completed_refund(sender, refund=None, **kwargs): # pylint: disable=unused-argument
"""Emit a tracking event when a refund is completed."""
if not (is_segment_configured() and refund.total_credit_excl_tax > 0):
return
user_tracking_id, lms_client_id, lms_ip = parse_tracking_context(
refund.user)
# Ecommerce transaction reversal, performed by emitting an event which is the inverse of an
# order completion event emitted previously.
# See: https://support.google.com/analytics/answer/1037443?hl=en
refund.order.site.siteconfiguration.segment_client.track(
user_tracking_id,
'Completed Order',
{
'orderId':
refund.order.number,
'total':
'-{}'.format(refund.total_credit_excl_tax),
'currency':
refund.currency,
'products': [
{
# For backwards-compatibility with older events the `sku` field is (ab)used to
# store the product's `certificate_type`, while the `id` field holds the product's
# SKU. Marketing is aware that this approach will not scale once we start selling
# products other than courses, and will need to change in the future.
'id': line.order_line.partner_sku,
'sku': mode_for_seat(line.order_line.product),
'name': line.order_line.product.course.id,
'price': str(line.line_credit_excl_tax),
'quantity': -1 * line.quantity,
'category':
line.order_line.product.get_product_class().name,
} for line in refund.lines.all()
],
},
context={
'ip': lms_ip,
'Google Analytics': {
'clientId': lms_client_id
}
},
)
def track_completed_order(sender, order=None, **kwargs): # pylint: disable=unused-argument
"""Emit a tracking event when an order is placed."""
if not (is_segment_configured() and order.total_excl_tax > 0):
return
user_tracking_id, lms_client_id, lms_ip = parse_tracking_context(
order.user)
order.site.siteconfiguration.segment_client.track(
user_tracking_id,
'Completed Order',
{
'orderId':
order.number,
'total':
str(order.total_excl_tax),
'currency':
order.currency,
'products': [
{
# For backwards-compatibility with older events the `sku` field is (ab)used to
# store the product's `certificate_type`, while the `id` field holds the product's
# SKU. Marketing is aware that this approach will not scale once we start selling
# products other than courses, and will need to change in the future.
'id': line.partner_sku,
'sku': mode_for_seat(line.product),
'name': line.product.course.id,
'price': str(line.line_price_excl_tax),
'quantity': line.quantity,
'category': line.product.get_product_class().name,
} for line in order.lines.all()
],
},
context={
'ip': lms_ip,
'Google Analytics': {
'clientId': lms_client_id
}
},
)
def track_completed_refund(sender, refund=None, **kwargs): # pylint: disable=unused-argument
"""Emit a tracking event when a refund is completed."""
if not (is_segment_configured() and refund.total_credit_excl_tax > 0):
return
user_tracking_id, lms_client_id, lms_ip = parse_tracking_context(refund.user)
# Ecommerce transaction reversal, performed by emitting an event which is the inverse of an
# order completion event emitted previously.
# See: https://support.google.com/analytics/answer/1037443?hl=en
refund.order.site.siteconfiguration.segment_client.track(
user_tracking_id,
'Completed Order',
{
'orderId': refund.order.number,
'total': '-{}'.format(refund.total_credit_excl_tax),
'currency': refund.currency,
'products': [
{
# For backwards-compatibility with older events the `sku` field is (ab)used to
# store the product's `certificate_type`, while the `id` field holds the product's
# SKU. Marketing is aware that this approach will not scale once we start selling
# products other than courses, and will need to change in the future.
'id': line.order_line.partner_sku,
'sku': mode_for_seat(line.order_line.product),
'name': line.order_line.product.course.id,
'price': str(line.line_credit_excl_tax),
'quantity': -1 * line.quantity,
'category': line.order_line.product.get_product_class().name,
} for line in refund.lines.all()
],
},
context={
'ip': lms_ip,
'Google Analytics': {
'clientId': lms_client_id
}
},
)