All notable changes will be documented in this file. You can also access it here.
- WEB-1459 Internal change only, API isn't public to our customers
- DM-2458: For clients with Collections activated in any product plan, ServiceItems, location update endpoint (POST/PUT/GET /api/location/:id) now uses the following format:
"services": [{
"identifier": "identifier-analytics-215",
"id": 43574, // id is required to re use the same services instead of creating one again
"title": "Advanced Analytics",
"description": "Advanced Analytics Description",
"category": 5, // this is uberall category
"price": 5000, // results in 50,00 same as contentlist
"currency": "EUR",
"googleService": "gmb_related_service_id",
"translations": {
"de": { // german translations
"title": "german title",
"description": "german description"
}
}
}....]
Beginning on May 30, Uberall will no longer support backward compatibility to TLS version 1.0/1.1 via APIs. The change is being made for security reasons in concert with other technology partners such as, Google, Apple, Microsoft and Mozilla.
TLS (Transport Layer Security) is a security protocol first defined in 1999 for HTTPS to establish encryption channels over public networks. TLS 1.2 is the upgrade to 1.0/1.1 to address potential security weaknesses in 1.0/1.1. Uberall's technology, UI and APIs don't use TLS 1.0/1.1, and are all encrypted using the preferred protocol HTTPS/TLS 1.3. Uberall also continues to support TLS 1.2.
After May 30, API requests using the outdated security protocol TLS 1.0/1.1 will fail.
- LIS-1246: Introduces multiple UTM fields (Google, Facebook, Bing)
- websiteExtra merged with type = Google
- EE-1295: Social Post supports multiple CTAs
For SocialPost before it was:
{
...,
"callToAction": "LEARN_MORE",
"url": "https://www.uberall.com"
...
}
now it is
{
...,
"callToActions": [
{
"directory": "GOOGLE",
"type": "ORDER",
"url": "https://youtu.be/1shUmwihK74"
},
{
"directory": "FACEBOOK",
"type": "ORDER",
"url": "https://youtu.be/1shUmwihK74"
}
],
...
}
- WEB-780: Changes to the StoreFinder settings response
- Rename
googleAPIKey
tomapApiKey
- Remove
googleAPIVersion
- Rename
- LIS-1471: Social Post photos now have a description
- DM-364: Rename
location.futureOpeningDate
tolocation.openingDate
- DM-618: Make ContentObjects have a single image
- UB-35939: Use new ServiceItems structure
For ServiceItems, location update endpoint (POST/PUT/GET /api/location/:id) previously
"services": ["service1", "service2"]
now it is
"services": [{
"identifier": "identifier-analytics-215",
"id": 43574, // id is required to re use the same services instead of creating one again
"title": "Advanced Analytics",
"description": "Advanced Analytics Description",
"category": 5, // this is uberall category
"price": 5000, // results in 50,00 same as contentlist
"currency" : "EUR",
"googleService": "gmb_related_service_id",
"translations": {
"de": { // german translations
"title": "german title",
"description": "german description"
}
}
}....]
- UB-38806: Add translations to advanced filters at ApiStoreFinderController@filters response
- UB-36626: Returning all photos at ApiStoreFinderController@details response
- Add publicationDate param to api/socialposts endpoint. dateStart is now only compulsory for offers and events
- Support to single and multiple callToActions
- Remove openNow from LocationSearchResult when it is not calculated (everywhere except for StoreFinder)
- Deprecate field countFieldsInSync in GET api/dashboard/listing-health. Will always return 0.
- Add new field defaultFeatures to features endpoint GET /api/features
- Add minThreadActionDate and maxThreadActionDate for DataPoint Search GET /api/datapoints
- ContentList rewrite
- Added isStoreLocator flag to SocialPost. Posts created without this flag will by default have it set to true as it was before.
- Some categories were deprecated and merged into existing ones. Check GET /api/categories for finding available categories
- Limit max location entries without fieldMask to 50 for endpoint GET /api/locations
- User object
- INBOX feature is deprecated
- Replaced by INBOX_WRITE (= can see, filter and reply to reviews) and INBOX_READ (= cannot reply)
- ProductPlan Object
- Field "active" has been replaced by "status" (PENDING_APPROVAL, ACTIVE, INACTIVE)
- Location Profile Completeness
- Includes now the concept of classification, a location can be in 4 different completeness statues: REQUIRED, BASIC, ADVANCED, BONUS
- Each location field has now a classification that can be REQUIRED, BASIC, ADVANCED, BONUS, the sum of completed fields define the classification of the location object.
- Labels
- Are returned as objects and not as strings
- Non-admin users can now create public or adminOnly labels and use them to filter/search objects (locations, datapoints, socialposts)
GET /api/datapoints/filters/$id
Version | Field | Type | Nullable | Default | Description |
---|---|---|---|---|---|
old | onlyUnread | boolean | no | false | can only be used to find unread datapoints but not the opposite |
old | onlyUnreplied | boolean | no | false | can only be used to find unreplied datapoints but not the opposite |
new | isRead | boolean | yes | null | can be null, can be used to find read and unread datapoints |
new | hasReply | boolean | yes | null | can be null, can be used to find replied and unreplied datapoints |
new | hasText | boolean | yes | null | can be null, can be used to find reviews with and without text |
- Google "pageStatus" has been deprecated
- User Object
- New field featuresDetailed for LOCATION_WRITE user feature
- Suggestions
- have been removed from the Location object response and a new endpoint and a new SuggestionResponse object has been created
- User Object
- User feature LISTING has been deprecated and replaced by LOCATION_WRITE and LOCATION_READ
- New endpoint created to accept or decline suggestions: PUT /locations/$id/suggestions
- New field "status" added to SuggestionResponse
- New parameter "group" has been added to the endpoint POST /api/dashboardExports
- Limit page size to 1000 entries for endpoint GET /api/datapoints
class FooBar {
int f = 3;
}