Metadata examples

Booking template

BOOKING_TEMPLATE_CREATED

{}

Campaign

CAMPAIGN_CREATED

{}

CAMPAIGN_DELIVERY_REPORT_CREATED

{
    "resourceId": 1,
    "date": "2050-01-01",
    "bookingApiCampaignId": 2,
    "impressions": 10000,
    "clicks": 20,
    "conversions": 0,
    "remainingBudget": 0,
    "viewedImpressions": 9000,
    "viewedMeasuredImpressions": 9500
}

CAMPAIGN_DELIVERY_REPORT_UPDATED

{
    "resourceId": 1,
    "date": "2050-01-01",
    "bookingApiCampaignId": 2,
    "impressions": 5000,
    "clicks": 10,
    "conversions": 0,
    "remainingBudget": "0",
    "viewedImpressions": 3500,
    "viewedMeasuredImpressions": 4500,
    "impsMasterCreative": 4000,
    "changes": {
        "impressions": {
            "from": 3000,
            "to": 5000
        },
        "clicks": {
            "from": 5,
            "to": 10
        },
        "viewedImpressions": {
            "from": 2000,
            "to": 3500
        },
        "impsMasterCreative": {
            "from": 2500,
            "to": 4000
        },
        "viewedMeasuredImpressions": {
            "from": 2700,
            "to": 4500
        }
    }
}

CAMPAIGN_ORDER_STATUS_CHANGED

{
    "id": 1,
    "name": "Campaign name",
    "from": "Value before",
    "to": "Value after"
}

CAMPAIGN_SYNCHRONIZATION_CHANGELOG

{
    "changelogId": 1,
    "entityName": "targetingRule",
    "entityId": 2,
    "status": "REPLICATED",
    "message": "Updated Line Item 3 with Profile 4",
    "X-Request-Id": "ROSE-NO-POL-CRM-a1b2c3d4-a1b2-c3d4-e5f6-a1b2c3d4e5f6",
    "reservationsCount": 10
}

CAMPAIGN_SYNCHRONIZATION_ERROR

{
    "message": "Could not synchronize campaign, the campaign is empty.",
    "resource": null,
    "requestContent": null,
    "X-Request-Id": null,
    "reservationsCount": 0
}

CAMPAIGN_SYNCHRONIZATION_FINISHED

{
    "insertionOrderId": 1,
    "campaignIds": "{\"campaignId\":2}, {\"campaignId\":3}",
    "reservationsCount": 2
}

CAMPAIGN_SYNCHRONIZATION_INITIALIZED

{
    "reservationsCount": 1
}

CAMPAIGN_SYNCHRONIZATION_INITIALIZED_AUTOMATICALLY

{
    "reservationsCount": 1
}

CAMPAIGN_SYNCHRONIZATION_REMOVE_RESOURCE

{
    "resourceId": 1,
    "resourceName": "campaign",
    "reservationsCount": 2
}

CAMPAIGN_SYNCHRONIZATION_REMOVE_RESOURCE_ERROR

{
    "resourceId": 1,
    "resourceName": "campaign",
    "error": "API call error",
    "reservationsCount": 0
}

CAMPAIGN_SYNCHRONIZATION_SELECTED_INITIALIZED

{
    "itemsToSync": "[{\"bookingApiTargetId\":\"1\"},{\"bookingApiTargetId\":\"2\"}]",
    "reservationsCount": 2
}

CAMPAIGN_SYNCHRONIZATION_WARNING

{
    "message": "Not able to book correctly. Campaign is not targeting any inventory in AppNexus.",
    "context": "{\"campaign\":\"Campaign name\"}",
    "X-Request-Id": "ROSE-NO-POL-CRM-a1b2c3d4-a1b2-c3d4-e5f6-a1b2c3d4e5f6",
    "reservationsCount": 1
}

CAMPAIGN_UPDATED

{
    "changes": {
        "<propertyName>": {
            "from": "Value before",
            "to": "Value after"
        }
    }
}

COMPENSATED_CAMPAIGN

{
    "campaign": {
        "id": 1,
        "name": "Campaign name"
    }
}

COMPENSATION_CAMPAIGN

{
    "campaign": {
        "id": 1,
        "name": "Campaign name"
    }
}

Customer

CUSTOMER_SYNCHRONIZATION_CHANGELOG

{
    "changelogId": 1,
    "entityName": "advertiser",
    "entityId": 2,
    "status": "REPLICATED",
    "message": "3",
    "X-Request-Id": "ROSE-NO-POL-CRM-a1b2c3d4-a1b2-c3d4-e5f6-a1b2c3d4e5f6"
}

Email

EMAIL_SENT

{
    "subject": "Email subject",
    "receivers": "receiver@email.com"
}

Reservation

INVITATION_USER_CREATED

{
  "resourceId": 1,
  "user": {
    "email": "email@email.com",
    "firstName": "TestName",
    "lastName": "TestLastName",
    "activated": false,
    "gdprConsentEnabled":true,
    "restrictedCustomers": [
      {
        "id": 1,
        "altId": "SNO_1234"
      }
    ]
  }
}

RESERVATION_CREATED

{
    "isOverbook": false,
    "capacity": 100000000,
    "availability": 100000000,
    "campaign": {
        "id": 1,
        "name": "Campaign name"
    },
    "reservation": {
        "id": 2,
        "name": "Reservation name",
        "expirationDate": "2050-01-10",
        "startDate": "2050-01-01",
        "endDate": "2020-02-01",
        "goal": 5,
        "totalPrice": 500,
        "discountedPrice": 500
    },
    "bookingApi": {
        "bookingApiCampaignId": null,
        "bookingApiTargetId": null
    }
}

RESERVATION_DELETED

{
    "campaign": {
        "id": 1,
        "name": "Campaign name"
    },
    "reservation": {
        "id": 2,
        "name": "Reservation name"
    },
    "bookingApi": {
        "bookingApiCampaignId": 3,
        "bookingApiTargetId": 4
    }
}

RESERVATION_DONE

{
    "campaign": {
        "id": 1,
        "name": "Campaign name"
    },
    "reservation": {
        "id": 2,
        "name": "Reservation name"
    },
    "bookingApi": {
        "bookingApiCampaignId": 3,
        "bookingApiTargetId": 4
    }
}

RESERVATION_UNDONE

{
    "campaign": {
        "id": 1,
        "name": "Campaign name"
    },
    "reservation": {
        "id": 2,
        "name": "Reservation name"
    },
    "bookingApi": {
        "bookingApiCampaignId": 3,
        "bookingApiTargetId": 4
    }
}

RESERVATION_EXTENDED

{
    "campaign": {
        "id": 1,
        "name": "Campaign name"
    },
    "reservation": {
        "id": 2,
        "name": "Reservation name",
        "expirationDate": "2050-01-01"
    },
    "bookingApi": {
        "bookingApiCampaignId": 3,
        "bookingApiTargetId": 4
    }
}

RESERVATION_EXTENDED_BY_ADMIN

{
    "campaign": {
        "id": 1,
        "name": "Campaign name"
    },
    "reservation": {
        "id": 2,
        "name": "Reservation name",
        "expirationDate": "2050-01-01"
    },
    "bookingApi": {
        "bookingApiCampaignId": 3,
        "bookingApiTargetId": 4
    }
}

RESERVATION_FINISHED

{
    "campaign": {
        "id": 1,
        "name": "Campaign name"
    },
    "reservation": {
        "id": 2,
        "name": "Reservation name"
    },
    "bookingApi": {
        "bookingApiCampaignId": 3,
        "bookingApiTargetId": 4
    }
}

RESERVATION_GUARANTEED_CREDIT_CARD_STOP

{
   "campaign":{
      "id":1,
      "name":"Campaign name"
   },
   "reservation":{
      "id":2,
      "name":"Reservation name"
   },
   "bookingApi":{
      "bookingApiCampaignId":3,
      "bookingApiTargetId":4
   },
   "changes":{
      "stopDelivery":{
         "from":false,
         "to":true
      }
   }
}

RESERVATION_NON_GUARANTEED_CREDIT_CARD_STOP

{
   "campaign":{
      "id":1,
      "name":"Campaign name"
   },
   "reservation":{
      "id":2,
      "name":"Reservation name"
   },
   "bookingApi":{
      "bookingApiCampaignId":3,
      "bookingApiTargetId":4
   },
  "changes":{
    "stopDelivery":{
      "from":false,
      "to":true
    },
    "endDate":{
      "from":{
        "date": "2023-11-25 00:00:00.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "to":{
        "date": "2023-11-24 23:59:00.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      }
    },
    "endTime":{
      "from":{
        "date": "1970-01-01 12:34:00.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      },
      "to":{
        "date": "1970-01-01 23:59:00.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      }
    }
  }
}

RESERVATION_ORDER_STATUS_CHANGED

{
    "id": 1,
    "name": "Campaign name",
    "from": "Value before",
    "to": "Value after",
    "reservationId": 2
}

RESERVATION_IN_PROGRESS

{
    "campaign": {
        "id": 1,
        "name": "Campaign name"
    },
    "reservation": {
        "id": 2,
        "name": "Reservation name"
    },
    "bookingApi": {
        "bookingApiCampaignId": 3,
        "bookingApiTargetId": 4
    }
}

RESERVATION_INVOICED

{
    "reservation": {
        "id": 2,
        "name": "Reservation name"
    },
    "name": 1,
    "changes": {
        "status": {
            "from": "sold_invoiced",
            "to": "invoiced"
        }
    }
}

RESERVATION_ITEM_CREATED

{
    "startDate": "2050-01-01T00:00:00+00:00",
    "name": "Placement name - 2050-01-01",
    "bookingIds": "3",
    "reservationItem": {
        "id": 2
    },
    "campaign": {
        "id": 1,
        "name": "Campaign name"
    },
    "placement": {
        "id": 6,
        "name": "Placement name"
    },
    "bookingApi": {
        "bookingApiCampaignId": 4,
        "bookingApiTargetId": 5
    }
}

RESERVATION_ITEM_DONE

{
    "startDate": "2050-01-01T00:00:00+00:00",
    "name": "Placement name - 2050-01-01",
    "bookingIds": "3",
    "reservationItem": {
        "id": 2
    },
    "campaign": {
        "id": 1,
        "name": "Campaign name"
    },
    "placement": {
        "id": 4,
        "name": "Placement name"
    }
}

RESERVATION_ITEM_INVOICED

{
    "reservationItem": {
        "id": 2
    },
    "name": 1,
    "changes": {
        "status": {
            "from": "sold",
            "to": "invoiced"
        }
    }
}

RESERVATION_ITEM_SOLD

{
    "startDate": "2050-01-01T00:00:00+00:00",
    "name": "Placement name - 2050-01-01",
    "bookingIds": "3",
    "reservationItem": {
        "id": 2
    },
    "campaign": {
        "id": 1,
        "name": "Campaign name"
    },
    "placement": {
        "id": 4,
        "name": "Placement name"
    },
    "bookingApi": {
        "bookingApiCampaignId": null,
        "bookingApiTargetId": null
    }
}

RESERVATION_ITEM_UNDONE

{
    "startDate": "2050-01-01T00:00:00+00:00",
    "name": "Placement name - 2050-01-01",
    "bookingIds": "3",
    "reservationItem": {
        "id": 2
    },
    "campaign": {
        "id": 1,
        "name": "Campaign name"
    },
    "placement": {
        "id": 4,
        "name": "Placement name"
    }
}

RESERVATION_LIVE

{
    "campaign": {
        "id": 1,
        "name": "Campaign name"
    },
    "reservation": {
        "id": 2,
        "name": "Reservation name"
    },
    "bookingApi": {
        "bookingApiCampaignId": 3,
        "bookingApiTargetId": 4
    }
}

RESERVATION_MOVE_FROM

{
    "fromCampaign": {
        "id": 2,
        "name": "Campaign name A"
    },
    "reservation": {
        "id": 3,
        "name": "Reservation name"
    },
    "campaign": {
        "id": 1,
        "name": "Campaign name B"
    },
    "bookingApi": {
        "bookingApiCampaignId": 4,
        "bookingApiTargetId": 5
    }
}

RESERVATION_MOVE_TO

{
    "toCampaign": {
        "id": 1,
        "name": "Campaign name B"
    },
    "reservation": {
        "id": 3,
        "name": "Reservation name"
    },
    "campaign": {
        "id": 2,
        "name": "Campaign name A"
    },
    "bookingApi": {
        "bookingApiCampaignId": 4,
        "bookingApiTargetId": 5
    }
}

RESERVATION_OPEN

{
    "campaign": {
        "id": 1,
        "name": "Campaign name"
    },
    "reservation": {
        "id": 2,
        "name": "Reservation name"
    },
    "bookingApi": {
        "bookingApiCampaignId": 3,
        "bookingApiTargetId": 4
    }
}

RESERVATION_SOLD

{
    "campaign": {
        "id": 1,
        "name": "Campaign name"
    },
    "reservation": {
        "id": 2,
        "name": "Reservation name"
    },
    "bookingApi": {
        "bookingApiCampaignId": 3,
        "bookingApiTargetId": 4
    }
}

RESERVATION_STOP

{
   "campaign":{
      "id":1,
      "name":"Campaign name"
   },
   "reservation":{
      "id":2,
      "name":"Reservation name"
   },
   "bookingApi":{
      "bookingApiCampaignId":3,
      "bookingApiTargetId":4
   },
   "changes":{
      "stopDelivery":{
         "from":false,
         "to":true
      },
      "totalPrice":{
         "from":"100.500",
         "to":90
      },
      "discountedPrice":{
         "from":"100.500",
         "to":90
      },
      "delete_items":{
         "from":"5,6,7",
         "to":null
      }
   }
}

RESERVATION_CPC_STOP

{
   "campaign":{
      "id":1,
      "name":"Campaign name"
   },
   "reservation":{
      "id":2,
      "name":"Reservation name"
   },
   "bookingApi":{
      "bookingApiCampaignId":3,
      "bookingApiTargetId":4
   },
   "changes":{
      "stopDelivery":{
         "from":false,
         "to":true
      },
      "endDate":{
         "from":{
           "date": "2023-11-25 00:00:00.000000",
           "timezone_type": 3,
           "timezone": "UTC"
         },
         "to":{
           "date": "2023-11-24 23:59:00.000000",
           "timezone_type": 3,
           "timezone": "UTC"
         }
      },
      "endTime":{
         "from":{
           "date": "1970-01-01 12:34:00.000000",
           "timezone_type": 3,
           "timezone": "UTC"
         },
         "to":{
           "date": "1970-01-01 23:59:00.000000",
           "timezone_type": 3,
           "timezone": "UTC"
         }
      }
   }
}

RESERVATION_PROLONGED

{
  "campaign":{
    "id":1,
    "name":"Campaign name"
  },
  "reservation":{
    "id":2,
    "name":"Reservation name"
  },
  "bookingApi":{
    "bookingApiCampaignId":3,
    "bookingApiTargetId":4
  },
  "changes":{
    "endDate":{
      "from":{
        "date":"2023-03-24 00:00:00.000000",
        "timezone_type":3,
        "timezone":"UTC"
      },
      "to":{
        "date":"2023-04-23 00:00:00.000000",
        "timezone_type":3,
        "timezone":"UTC"
      }
    },
    "budget":{
      "from":"310000.000",
      "to":"610000.000"
    },
    "totalPrice":{
      "from":"310000.000",
      "to":610000
    },
    "discountedPrice":{
      "from":"310000.000",
      "to":610000
    },
    "goal":{
      "from":31000,
      "to":61000
    }
  }
}

RESERVATION_UPDATE

{
    "capacity": 2000000000,
    "availability": 1000000000,
    "campaign": {
        "id": 1,
        "name": "Campaign name"
    },
    "reservation": {
        "id": 2,
        "name": "Reservation name"
    },
    "bookingApi": {
        "bookingApiCampaignId": 3,
        "bookingApiTargetId": 4
    },
    "changes": {
        "<propertyName>": {
            "from": "Value before",
            "to": "Value after"
        }
    }
}

RESERVATION_UPDATE_DISCOUNT

{
    "campaign": {
        "id": 1,
        "name": "Campaign name"
    },
    "reservation": {
        "id": 2,
        "name": "Reservation name",
        "discountedPrice": 10000
    },
    "bookingApi": {
        "bookingApiCampaignId": 3,
        "bookingApiTargetId": 4
    }
}

SELF_SERVE_USER_CREATED

{
  "resourceId": 1,
  "user": {
    "email": "email@email.com",
    "firstName": "TestName",
    "lastName": "TestLastName",
    "activated": false,
    "gdprConsentEnabled":true
  }
}

SELF_SERVE_USER_LOGGED_IN

{
  "resourceId": 1,
  "email": "email@email.com"
}

SELF_SERVE_USER_UPDATED

{
  "user": {
    "email": "email@email.com",
    "firstName": "TestName2",
    "lastName": "TestLastName2",
    "activated": false,
    "gdprConsentEnabled": true,
    "restrictedCustomers": [
      {
        "id": 1,
        "altId": "SNO_1234"
      }
    ],
    "reseller": {
      "id": 1,
      "altId": "SNO_4321"
    }
  },
  "changes": {
    "displayName": {
      "from": "TestLastName,TestName",
      "to": "TestLastName2, TestName2"
    },
    "firstName": {
      "from": "TestName",
      "to": "TestName2"
    },
    "lastName": {
      "from": "TestLastName",
      "to": "TestLastName2"
    },
    "userWebsite": {
      "from": "",
      "to": "userWebsite"
    },
    "phoneNumber": {
      "from": "",
      "to": "phoneNumber"
    },
    "orgNumber": {
      "from": "orgNumber",
      "to": "orgNumber2"
    },
    "companyName": {
      "from": "companyName",
      "to": "companyName2"
    }
  },
  "resourceId": 1
}

SELF_SERVE_USER_DELETED

{
  "resourceId": 1
}