uberall API Object Model
Before diving into the complete list of objects returned and used by the API below, it is generally useful to read our Overview to understand high-level concepts and use cases.
ActionsDataMultiLocation
type
Type
(ACTIONS_PHONE, ACTIONS_WEBSITE, ACTIONS_DRIVING_DIRECTIONS)
| ACTIONS_PHONE, |
ACTIONS_PHONE |
| ACTIONS_WEBSITE, |
ACTIONS_WEBSITE |
| ACTIONS_DRIVING_DIRECTIONS |
ACTIONS_DRIVING_DIRECTIONS |
ActionsDataSingleLocation
AttributeWrapper
value
The value of the attribute. The value depends on the valueType.
BOOL: "true" or "false"
Single URL:"http://uberall.com"
Multiple URLs: ["http://uberall.com", "https://menuari2.com"]
ENUM:"supportedValue1" or "supportedValue2"
REPEATED_ENUM:"supportedValue1,supportedValue2"
BOOL: "true" or "false"
Single URL:"http://uberall.com"
Multiple URLs: ["http://uberall.com", "https://menuari2.com"]
ENUM:"supportedValue1" or "supportedValue2"
REPEATED_ENUM:"supportedValue1,supportedValue2"
Attribution
AverageRatingMultiLocation
AverageRatingSingleLocation
BasicListing
addressDisplay
If set to false the address will not be published on the directories, this is useful for businesses that don't have customers come to them ( e.g. a plumber )
addressDisplayStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
addressExtraStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
attributesStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING
attributionStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
brandsStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
categoriesStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
cellphoneStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
cityStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
claimStatus
Claim status of the listing. One of CLAIMABLE, NOT_CLAIMABLE, CLAIMED_BY_US, CLAIMED_BY_OTHERS, CLAIMING_IN_PROGRESS, UNKNOWN
contentListsStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
countryStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
descriptionLongStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
descriptionShortStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
doctorCategoriesStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
emailStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
faxStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
flowStatus
The status of the current listing. One of SUBMISSION_NEEDED, WAITING_USER_ACTION, WAITING_DIRECTORY_ACTION, ALL_INFORMATION_SUBMITTED, NO_ACTION_NEEDED, NOT_SUPPORTED, INACTIVE, NEEDS_REVIEW, MANUALLY_DEACTIVATED, REMOVAL_REVIEW_NEEDED, REMOVAL_NEEDED, REMOVAL_SUBMITTED, REMOVED, DONT_REMOVE
imprintStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING
keywordsStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
languagesStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
latStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
legalIdentStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
lngStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
moreHours
The location's additional service hours, such as delivery, pickup, happy hours etc. Submitted to Google.
[MoreHours,...]
moreHoursStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
nameDescriptorStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
nameStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
npi
The National Provider Identifier (NPI) is a Health Insurance Portability and Accountability Act (HIPAA) Administrative Simplification Standard. The NPI is a unique identification number for covered health care providers.
npiStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
numberOfRatingsStatus
The sync status of this specific field. One of NOT_APPLICABLE or PRESENT
openingDateStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
openingHours
The location's opening hours: e.g.
[ {
"dayOfWeek": 1,
"closed": false,
"from1": "08:00",
"to1": "11:00"
},
{
"dayOfWeek": 2,
"closed": false,
"from1": "08:00",
"to1": "11:00",
"from2": "13:00",
"to2": "21:00"
},
{
"dayOfWeek": 3,
"closed": true
}
]
Please note that having more than 2 time periods for each day is not possible.
[OpeningHours,...]
openingHoursNotes
Additional info about opening hours: e.g. 'We never open on bank holidays' - max. 255 characters
openingHoursNotesStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
openingHoursStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
paymentOptionsStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
phoneStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
photosStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
provinceStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
serviceAreasStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
services
Services offered at the location. Do not use if Content Collections is enabled. Instead use the Service Item and Collection endpoints
[String,...]
servicesStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
socialPostStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
socialProfilesStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
specialOpeningHours
The location's special opening hours: e.g.
[ {
"date": "2017-06-29",
"closed": true
},
{
"date": "2017-06-30",
"from1": "11:00",
"to1": "14:00",
"from2": "16:00",
"to2": "20:00"
}
]
Please note that having more than 2 time periods for each day is not possible.
[SpecialOpeningHours,...]
specialOpeningHoursStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
streetAndNoStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
streetNoStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
streetStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
streetType
Required for Spain. One of ALAMEDA, AVENIDA, CALLE, CAMINO, CARRER, CARRETERA, GLORIETA, KALEA, PASAJE, PASEO, PLACA, PLAZA, RAMBLA, RONDA, RUA, SECTOR, TRAVESERA, TRAVESIA, URBANIZACION
streetTypeStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
syncStatus
The sync status of the listing. One of: IN_SYNC (location found on remote directory and in sync with reference data), NOT_IN_SYNC (location found on remote directory but differs from reference data), NOT_FOUND (location not found (yet) on remote directory), TECHNICAL_PROBLEMS (temporary problems when connecting with the directory), NOT_SUPPORTED (if the location is incompatible with the directory or if we cannot search on that directory), NO_ONLINE_LISTING (for the types where there is no listing that can be checked online, e.g. GARMIN), LINK_ONLY (for the types where we can only link a listing by not update it)
taxNumberStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
transactionLinksStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
videosStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
websiteStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
zipStatus
The sync status of this specific field. One of NOT_APPLICABLE, PRESENT, MISSING, MATCH, MISMATCH
BenchmarkDistribution
BrandDataPoint
flagged
Whether the datapoint has been flagged. The exact nature of the flagging depends on the directory, but can be e.g. "Report as SPAM"
threadActionDate
The date of the last interaction in that thread. When a review receives a new comment, the parent will update.
Business
businessSyncable
True if the business is allowed to start a sync. Only relevant for Businesses with more than 10 locations.
customFields
Custom fields allow for additional information to be added at the location level. All locations within the business will have the same list of custom fields.
[String,...]
effectiveDate
Date when the business automatically changes its product plan to the new product plan (defined by nextProductPlanId)
nextProductPlanId
ID of the next product plan applied for the business on the defined effectiveDate
BusinessStatistics
CallTrackingNumber
number
The call tracking number for the select directory -- must be different than the location's primary phone number.
CardsHomepageResponse
cards
Cards grouped by Pillar. Rotates per user.
"STAND_OUT": [
"ads",
"listings",
"google-impressions",
"google-indirect-search-queries",
"google-discovery-search-rank",
"google-direct-search-queries",
"google-direct-search-rank"
],
"ATTRACT": [
"profile-completeness",
"google-conversions",
"google-photos",
"google-conversions-lowest",
"interactions",
"storelocator",
"google-conversions-highest"
],
"DELIGHT": [
"average-rating",
"rating-split",
"reply-rate",
"reply-rate-split",
"facebook-posts",
"review-sentiment"
]
Category
ConflictingRuleResponse
ConnectFlowUserDetails
defaultForBusiness
This should indicate whether the connection in place has been produced by a business level connection
defaultForSalesPartner
This should indicate whether the connection in place has been produced by a salesPartner level connection
ConnectorFormat
ConnectorType
CHADEMO
The ChaoJi connector. The new generation charging connector, harmonized between CHAdeMO and GB/T. DC.
IEC_60309_2_single_16
IEC 60309-2 Industrial Connector single phase 16 amperes (usually blue)
IEC_60309_2_three_16
IEC 60309-2 Industrial Connector three phases 16 amperes (usually red)
IEC_60309_2_three_32
IEC 60309-2 Industrial Connector three phases 32 amperes (usually red)
IEC_60309_2_three_64
IEC 60309-2 Industrial Connector three phases 64 amperes (usually red)
ContentCollection
cuisineType
Only applicable to Menu content collections - indicates the cuisine the restaurant serves
type
Mandatory - the type of content collection. Values can be: MENU, PEOPLE, PRODUCTS, SERVICES, or CUSTOM
ContentList
itemIds
The list of item ids that should be included within this section of the Content Collection
[Long,...]
type
The type of content list. One of SERVICES, PRODUCTS, MENU, PEOPLE or CUSTOM. The type cannot be updated after creation.
ConversationCount
ConversionsInsightsMultiLocation
ConversionsInsightsSingleLocation
CurrentPreviousValue
CustomItem
CustomerFeedback
CustomerFeedbackByPeriod
averageRatingByPeriod
The average ratings of the incoming reviews in the given time periods of the total time span.
[TimeSeriesSegment,...]
CustomerFeedbackKeyword
aggregatedWords
Contains the list of similar words that have been aggregated to this CustomerFeedbackKeyword object
[String,...]
rating
The average rating of all Reviews that contained this keyword at least once
CustomerFeedbackKeywords
CustomerFeedbackKeywordsHomepageResponse
CustomerFeedbackMultiLocationHomepageResponse
CustomerFeedbackSingleLocationHomepageResponse
DashboardExportData
whitelabelIdentifier
Whitelabel identifier which will be used in the outline of the PDF report
DashboardExportInsightsDataResponse
DashboardLocation
DataPoint
comments
The list of comments of a Datapoint. Populated in the get, reply, approve and reject datapoint calls.
[DataPoint,...]
flagged
Whether the datapoint has been flagged. The exact nature of the flagging depends on the directory, but can be e.g. "Report as SPAM"
threadActionDate
The date of the last interaction in that thread. When a review receives a new comment, the parent will update.
DataPointFilter
dataPointTypes
The list of data point types (REVIEW or PHOTO) for which the dataPoints should be filtered
[DataPointType,...]
query
Any combination of words that should be checked in the dataPoints text, reply messages and author
ratings
The list of ratings (1, 2, 3, 4 or 5) for which the dataPoints should be filtered
[Integer,...]
DataPointTimeSeriesResponse
DataPointTimeSeriesValue
DatapointStatisticsResponse
DirectoriesDetailsCountry
DirectoryBrandPageResponse
businesses
list of all the business ( directory brands) from the external directory
DirectoryConnectInfo
userDetails
The information present for the account that has made this connection
DirectoryContactDetails
DirectoryDetails
DirectoryPageResponse
additionalInfo
Additional info for the page allowing you to distinguish between pages with same name
DoctorComData
EmailSettings
emailType
Type of email. Currently, the types of email supported are: DIGEST, ACTIVATION, START_VERIFICATION_GOOGLE, FINISH_VERIFICATION_GOOGLE, UNREAD_REVIEW_NOTIFICATION, PENDING_APPROVAL_REPLY_NOTIFICATION, SOCIAL_POST_PENDING_APPROVAL_NOTIFICATION, NEW_CHATS_NOTIFICATION, NEW_CONTACT_FORM_NOTIFICATION
frequency
Frequency of the emailType. The available frequencies by email type are: DIGEST: WEEKLY, MONTHLY or NEVER; ACTIVATION: ALWAYS or NEVER; START_VERIFICATION_GOOGLE: ALWAYS or NEVER; FINISH_VERIFICATION_GOOGLE: ALWAYS or NEVER; UNREAD_REVIEW_NOTIFICATION: ALWAYS or NEVER; PENDING_APPROVAL_REPLY_NOTIFICATION: DAILY, ALWAYS or NEVER.
EvConnector
format
Required -
Required - The format of the connector, whether it is a socket or a plug
identifier
Required -
Required - Identifier of the connector within the EVSE created by the CPO. Two connectors may have the same id as long as they do not belong to the same EVSE object.
powerType
Required -
Required - Connector Power Type. Values can be: AC_1_PHASE, AC_3_PHASE, DC
EvData
isChargingClosed
Indicates if the EVSEs can be used for charging outside the opening hours of the location. E.g. when the parking garage closes its barriers overnight, it will indicate if you still can charge till the next morning
EvLocationType
UNDERGROUND_GARAGE
Used when the EV Charging station is located in an Underground Garage
EvStatus
RESERVED
The EVSE/Connector is reserved for a particular EV driver and is unavailable for other drivers.
EvSupplyEquipment
evseId
Required - Unique id for the outside world. Compliant with “eMI3standard version V1.0”
parkingRestrictions
This value, if provided by CPO, represents the restriction to the parking spot for different purposes
[ParkingRestriction,...]
physicalReference
A number/string printed on the outside of the EVSE for visual identification
Event
FeaturesResponse
FeedItem
FiltersResponse
GoogleSearchResultsMultiLocation
GoogleSearchResultsSingleLocation
HeaderMultiLocationHomepageResponse
profileType
Profile type. Possible values: UC-H (low Stand Out, Attract and Delight scores), UC-V (high Stand Out score, low Attract and Delight scores), UR-H (low Stand Out and Attract score, high Delight score), UR-V (high Stand Out and Delight scores, low Attract score), AC-H (low Stand Out and Delight score, high Attract score), AC-V (high Stand Out and Attract scores, low Delight score)
HeaderSingleLocationHomepageResponse
profileType
Profile type. Possible values: UC-H (low Stand Out, Attract and Delight scores), UC-V (high Stand Out score, low Attract and Delight scores), UR-H (low Stand Out and Attract score, high Delight score), UR-V (high Stand Out and Delight scores, low Attract score), AC-H (low Stand Out and Delight score, high Attract score), AC-V (high Stand Out and Attract scores, low Delight score)
Image
ImpressionsInsightsMultiLocation
InboxResponse
status
Status indicating whether Inbox is active for the current location. One of ACTIVE INACTIVE
Insights
matchedLocationsCount
The number of locations matching the filter which the insights are returned for
metrics
Google:
(To be used to fetch historical data)
BUSINESS_IMPRESSIONS_DESKTOP_MAPS BUSINESS_IMPRESSIONS_DESKTOP_SEARCH BUSINESS_IMPRESSIONS_MOBILE_MAPS BUSINESS_IMPRESSIONS_MOBILE_SEARCH BUSINESS_CONVERSATIONS BUSINESS_DIRECTION_REQUESTS CALL_CLICKS WEBSITE_CLICKS BUSINESS_BOOKINGS BUSINESS_FOOD_ORDERS BUSINESS_FOOD_MENU_CLICKSDeprecated Google Metrics:
(To be used to fetch historical data)
QUERIES_DIRECT QUERIES_INDIRECT VIEWS_MAPS VIEWS_SEARCH ACTIONS_WEBSITE ACTIONS_PHONE ACTIONS_DRIVING_DIRECTIONS PHOTOS_VIEWS_MERCHANT PHOTOS_VIEWS_CUSTOMERS LOCAL_POST_VIEWS_SEARCH LOCAL_POST_ACTIONS_CALL_TO_ACTIONFacebook:
PAGE_IMPRESSIONS PAGE_CONSUMPTIONSBing:
CLICKS_DESKTOP_CORTANA_CALL CLICKS_DESKTOP_CORTANA_DIRECTIONS CLICKS_DESKTOP_CORTANA_PHOTOS CLICKS_DESKTOP_CORTANA_WEBSITE CLICKS_DESKTOP_MAPS_CALL CLICKS_DESKTOP_MAPS_DIRECTIONS CLICKS_DESKTOP_MAPS_PHOTOS CLICKS_DESKTOP_MAPS_WEBSITE CLICKS_DESKTOP_SEARCH_PAGE_CALL CLICKS_DESKTOP_SEARCH_PAGE_DIRECTIONS CLICKS_DESKTOP_SEARCH_PAGE_PHOTOS CLICKS_DESKTOP_SEARCH_PAGE_WEBSITE CLICKS_MOBILE_CORTANA_CALL CLICKS_MOBILE_CORTANA_DIRECTIONS CLICKS_MOBILE_CORTANA_PHOTOS CLICKS_MOBILE_CORTANA_WEBSITE CLICKS_MOBILE_MAPS_CALL CLICKS_MOBILE_MAPS_DIRECTIONS CLICKS_MOBILE_MAPS_PHOTOS CLICKS_MOBILE_MAPS_WEBSITE CLICKS_MOBILE_SEARCH_PAGE_CALL CLICKS_MOBILE_SEARCH_PAGE_DIRECTIONS CLICKS_MOBILE_SEARCH_PAGE_PHOTOS CLICKS_MOBILE_SEARCH_PAGE_WEBSITE IMPRESSIONS_DESKTOP_CORTANA IMPRESSIONS_DESKTOP_MAPS IMPRESSIONS_DESKTOP_SEARCH_PAGE IMPRESSIONS_MOBILE_CORTANA IMPRESSIONS_MOBILE_MAPS IMPRESSIONS_MOBILE_SEARCH_PAGEYelp:
NUM_CALLS NUM_DIRECTIONS_AND_MAP_VIEWS NUM_PAGE_VIEWS URL_CLICKS
InsightsBenchmarkDistribution
InsightsDataMultiLocationHomepageResponse
InsightsDataSingleLocationHomepageResponse
InteractionsHomepageResponse
Label
Listing
accountInfo
A map consisting of the name and pageId of the connected account if the listing is either Google or Facebook.
data
A map containing optional information about the listing, e.g. latestVisibilityIndex.
mandatoryFields
Mandatory fields for the specific Directory that are not set yet
[DirectoryField,...]
ListingDetails
directoryConnectInfo
The detailed information about the type of connection that exists for this listing
directoryContactDetails
Contact details of the publisher when the listing needs to be claimed
directorySpecificData
Directory specific data. e.g. Google publishing states which can be UNVERIFIED, DISABLED, SUSPENDED, DUPLICATE.
mandatoryFieldsMissing
Mandatory field missing on the location which prevents the data to be submitted to the publisher
[String,...]
ListingHealth
countListingsLinked
The number of listings which have been linked. These listings do not get updated.
countListingsSubmitted
The number of listings in successfully submitted. These listings don't have live sync checks.
ListingHealthMultiLocationHomepageResponse
ListingHealthSingleLocationHomepageResponse
ListingsDetailsResponse
Location
autoSync
When autosync is set to true, information changed for the location in Uberall will automatically be syncronized to all connected listings without the need to explicitly start a sync again after it's been started once.
businessId
ID of the business this location is linked to. Mandatory when creating a location. Sending a different ID than the current businessId when updating will lead to changing the business. This is only possible in case all connected accounts (Facebook, Google, …) are compatible.
callTrackingNumbers
Add call tracking numbers for distribution to Google, Facebook, and Bing. The call tracking numbers must be different from the location's primary phone number
[CallTrackingNumber,...]
categories
Required to start location sync - A list of category IDs describing the location
[Category,...]
cleansingComment
Cleansing comment by user, set only when cleansingStatus is INVALID_DATA.
Possible Values (ADDRESS_DETAILS_VERIFIED, NAME_ADDRESS_DETAILS_UPDATED, NON_CLOSURE_CONFIRMATION,)
cleansingInvalidDataReason
Output only. Invalid Cleansing Reason (eg. INCOMPLETE_ADDRESS,ADDRESS_ IS_PO_BOX,ADDRESS_ DOES_NOT_EXIST, LOCATION_IS_CLOSED, INFORMATION_IS_WRONG, LOCATION_IS_MOVED, NON_LATIN_CHARACTERS_ADDRESS, OTHER).
Guide on how to fix invalid data issues - http://ubr.al/fix_invalid_data
cleansingStatus
Output only. Current cleansing status for the location. Possible values: NOT_CLEANSED, PENDING, CLEANSED, INVALID_DATA
contentLists
The content list IDs (EVENTS, PRODUCTS, MENU, PEOPLE) describing the location
[Integer,...]
customFields
A Map for identifying the value input for a specific custom field name on the location. Custom fields are created at the business level.
"customFields": [
{
"name": "foo",
"value": "bar"
},
{
"name": "baz",
"value": "qux"
}
]
[Map,...]
dataPoints
Output only. Number of dataPoints (reviews, photos) left by users at this location
descriptionLong
A long description - up to 1000 characters, all characters must match this regexp:
[0-9\p{L}\(\)\[\] \?:;\/!\\,\.\-%\\&=\r\n\t_\*§²`´·"'\+¡¿@°€\^£$]
descriptionShort
A short description - up to 200 characters, all characters must match this regexp:
[0-9\p{L}\(\)\[\] \?:;\/!\\,\.\-%\\&=\r\n\t_\*§²`´·"'\+¡¿@°€£$]
doctorComData
Doctor.com specific data, such as doctorCategories, npi, credentials, university, hospitalAffiliations, insurancesAccepted. Formatted as such:
"doctorComData":{
"hospitalAffiliations":"Hospital Research Institute",
"doctorCategories":[
227
],
"credentials":"MD, NAME",
"npi":"1234567",
"university":"University name"
}
evData
A description of the EV Charging stations location. Used to help customers find the station more easily
listings
Output only. List of this location's online listings together with their sync status
[Listing,...]
missingMandatoryFields
Output only. Compile all the fields that are currently missing but mandatory for some directories. They have to be set in the Location object, so that the Listing can be created / updated on the respective platform. List of Strings, e.g. [NAME, ZIP, PHONE]
[DirectoryField,...]
moreHours
The location's additional service hours, such as delivery, pickup, happy hours etc. Submitted to Google. e.g.
[{
"type": "ONLINE_SERVICE_HOURS",
"hours": [{
"dayOfWeek": 1,
"from1": "09:00",
"to1": "18:00"
}, {
"dayOfWeek": 2,
"from1": "09:00",
"to1": "13:00"
}]
}, {
"type": "ACCESS",
"hours": [{
"dayOfWeek": 1,
"from1": "06:00",
"to1": "20:00"
}]
}]
[Map,...]
nameDescriptor
An addition to the location's name which gives specific info about the location's address (e.g. Mall level 2 OR Inside Departures). Sent only to FACEBOOK
openingHours
The location's opening hours: e.g.
[ {
"dayOfWeek": 1,
"closed": false,
"from1": "08:00",
"to1": "11:00"
},
{
"dayOfWeek": 2,
"closed": false,
"from1": "08:00",
"to1": "11:00",
"from2": "13:00",
"to2": "21:00"
},
{
"dayOfWeek": 3,
"closed": true
}
]
Please note that having more than 2 time periods for each day is not possible.
[OpeningHours,...]
openingHoursNotes
Additional info about opening hours: e.g. 'We never open on bank holidays' - max. 255 characters, all characters must match this regexp:
[0-9\p{L}\(\)\[\] \?:;\/!\\,\.\-%\\&\r\n\t_\*§²`´·"'\+¡¿@]
paymentOptions
The payment options accepted at the location (eg. cash, bank transfer, ...)
[String,...]
profileCompleteness
Output only. Number representing completeness of location data, up to 100
services
Services offered at the location. Do not use if Content Collections is enabled. Instead use the Service Item and Collection endpoints
[String,...]
socialProfiles
The profiles of the location on social and professional networks (FACEBOOK, FOURSQUARE, INSTAGRAM, LINKEDIN, PINTEREST, TWITTER, VIMEO, XING, YOUTUBE)
[SocialProfile,...]
specialOpeningHours
The location's special opening hours: e.g.
[ {
"date": "2017-06-29",
"closed": true
},
{
"date": "2017-06-30",
"from1": "11:00",
"to1": "14:00",
"from2": 16:00",
"to2": "20:00"
}
]
Please note that having more than 2 time periods for each day is not possible.
[SpecialOpeningHours,...]
status
The status of the location. One of:
- ACTIVE - will be synced and renewed
- INACTIVE - will not be synced anymore, claims of listings will be released where possible
- CANCELLED - will be synced, will not be renewed. Once endDate is reached, location will switch to INACTIVE
- CLOSED - location has shut down, we'll mark listings as permanently closed or remove listings from the internet where permanently closed status is not supported
streetType
Required for Spain. One of ALAMEDA, AVENIDA, CALLE, CAMINO, CARRER, CARRETERA, GLORIETA, KALEA, PASAJE, PASEO, PLACA, PLAZA, RAMBLA, RONDA, RUA, SECTOR, TRAVESERA, TRAVESIA, URBANIZACION
temporarilyClosed
Set a location to temporarily closed with the ability to set a re-open date. Temporarily closed is best used if a location will be closed for more than seven days. If less than seven days, use special hours to show the location is closed.
transactionLinks
Links that appear on some directories for specific types of customer actions, such as food ordering, appointment setting, and booking reservations. Only available for specific business categories.
[LocationTransactionLink,...]
utms
UTM parameter to be appended to the location's website. Codes can be sent to Google, Facebook, and Bing.
[UTM,...]
LocationDashboardResponse
LocationDashboardStatistics
LocationFeatureResponse
potentialFeatures
Features that are currently not available for this location, but can potentially be enabled.
[Feature,...]
LocationGroup
LocationGroupListResponse
LocationManagersCount
LocationPhoto
cropOffsetX
Horizontal pixel offset of the top-left corner of the cropped area [LANDSCAPE photo only]
cropOffsetY
Vertical pixel offset of the top-left corner of the cropped area [LANDSCAPE photo only]
type
Required - One of:
MAIN
LOGO
SQUARED_LOGO
DOCTOR_COM_PORTRAIT - Doctor.com clients only
LANDSCAPE - Updates Google Cover Photo
APPLE_LANDSCAPE
PHOTO
STOREFINDER_LOGO - Only for Uberall locator product
STOREFINDER_COVER - Only for Uberall locator product
FACEBOOK_LANDSCAPE - Facebook Cover Photo
EXTERIOR - Google's Exterior Photo tag - availability dependent on a location's business category
INTERIOR - Google's Interior Photo tag - availability dependent on a location's business category
FOOD_AND_DRINK - Google's Food and Drink Photo tag - availability dependent on a location's business category
MENU - Google's Menu Photo tag, which should only be photos of the menu - availability dependent on a location's business category
PRODUCT - Google's Product Photo tag - availability dependent on a location's business category
TEAMS - Google's Teams Photo tag - availability dependent on a location's business category
AT_WORK - Google's At Work Photo tag - availability dependent on a location's business category
COMMON_AREA - Google's Common Area Photo tag - availability dependent on a location's business category
ROOMS - Google's Rooms Photo tag - availability dependent on a location's business category
MAIN
LOGO
SQUARED_LOGO
DOCTOR_COM_PORTRAIT - Doctor.com clients only
LANDSCAPE - Updates Google Cover Photo
APPLE_LANDSCAPE
PHOTO
STOREFINDER_LOGO - Only for Uberall locator product
STOREFINDER_COVER - Only for Uberall locator product
FACEBOOK_LANDSCAPE - Facebook Cover Photo
EXTERIOR - Google's Exterior Photo tag - availability dependent on a location's business category
INTERIOR - Google's Interior Photo tag - availability dependent on a location's business category
FOOD_AND_DRINK - Google's Food and Drink Photo tag - availability dependent on a location's business category
MENU - Google's Menu Photo tag, which should only be photos of the menu - availability dependent on a location's business category
PRODUCT - Google's Product Photo tag - availability dependent on a location's business category
TEAMS - Google's Teams Photo tag - availability dependent on a location's business category
AT_WORK - Google's At Work Photo tag - availability dependent on a location's business category
COMMON_AREA - Google's Common Area Photo tag - availability dependent on a location's business category
ROOMS - Google's Rooms Photo tag - availability dependent on a location's business category
LocationPhotoResponse
cropOffsetX
Horizontal pixel offset of the top-left corner of the cropped area [LANDSCAPE photo only]
cropOffsetY
Vertical pixel offset of the top-left corner of the cropped area [LANDSCAPE photo only]
logo
A boolean indicating whether this photo is the location's logo. Maximum one logo per location
main
A boolean indicating whether this photo is the location's main photo. Maximum one per location
type
Required - One of:
MAIN
LOGO
SQUARED_LOGO
DOCTOR_COM_PORTRAIT - Doctor.com clients only
LANDSCAPE - Updates Google Cover Photo
APPLE_LANDSCAPE
PHOTO
STOREFINDER_LOGO - Only for Uberall locator product
STOREFINDER_COVER - Only for Uberall locator product
FACEBOOK_LANDSCAPE - Facebook Cover Photo
EXTERIOR - Google's Exterior Photo tag - availability dependent on a location's business category
INTERIOR - Google's Interior Photo tag - availability dependent on a location's business category
FOOD_AND_DRINK - Google's Food and Drink Photo tag - availability dependent on a location's business category
MENU - Google's Menu Photo tag, which should only be photos of the menu - availability dependent on a location's business category
PRODUCT - Google's Product Photo tag - availability dependent on a location's business category
TEAMS - Google's Teams Photo tag - availability dependent on a location's business category
AT_WORK - Google's At Work Photo tag - availability dependent on a location's business category
COMMON_AREA - Google's Common Area Photo tag - availability dependent on a location's business category
ROOMS - Google's Rooms Photo tag - availability dependent on a location's business category
MAIN
LOGO
SQUARED_LOGO
DOCTOR_COM_PORTRAIT - Doctor.com clients only
LANDSCAPE - Updates Google Cover Photo
APPLE_LANDSCAPE
PHOTO
STOREFINDER_LOGO - Only for Uberall locator product
STOREFINDER_COVER - Only for Uberall locator product
FACEBOOK_LANDSCAPE - Facebook Cover Photo
EXTERIOR - Google's Exterior Photo tag - availability dependent on a location's business category
INTERIOR - Google's Interior Photo tag - availability dependent on a location's business category
FOOD_AND_DRINK - Google's Food and Drink Photo tag - availability dependent on a location's business category
MENU - Google's Menu Photo tag, which should only be photos of the menu - availability dependent on a location's business category
PRODUCT - Google's Product Photo tag - availability dependent on a location's business category
TEAMS - Google's Teams Photo tag - availability dependent on a location's business category
AT_WORK - Google's At Work Photo tag - availability dependent on a location's business category
COMMON_AREA - Google's Common Area Photo tag - availability dependent on a location's business category
ROOMS - Google's Rooms Photo tag - availability dependent on a location's business category
LocationProfileCompleteness
completenessPerField
A map that contains for each Classification the fields and a corresponding boolean value if that field is filled or not.
currentClassification
The current classification of the Location - one of REQUIRED, BASIC, ADVANCED, BONUS or COMPLETE
LocationResponse
LocationSearchResult
addressDisplay
If set to false, directories are either not given address details or told not to display them. There are few directories where this is not possible, that hence might not receive data at all.
autoSync
When autosync is set to true, information changed for the location in Uberall will automatically be syncronized to all connected listings without the need to explicitly start a sync again after it's been started once.
hasFacebook
Boolean indicating whether the location has support Facebook included in its product plan
openingHours
The location's opening hours: e.g.
[ {
"dayOfWeek": 1,
"closed": false,
"from1": "08:00",
"to1": "11:00"
},
{
"dayOfWeek": 2,
"closed": false,
"from1": "08:00",
"to1": "11:00",
"from2": "13:00",
"to2": "21:00"
},
{
"dayOfWeek": 3,
"closed": true
}
]
Please note that having more than 2 time periods for each day is not possible.
[OpeningHours,...]
openingHoursNotes
Additional info about opening hours: e.g. 'We never open on bank holidays' - max. 255 characters
sortableData
A JSON indicating which parameters can be used when sorting a list of locations including this one
specialOpeningHours
The location's special opening hours: e.g.
[ {
"date": "2017-06-29",
"closed": true
},
{
"date": "2017-06-30",
"from1": "11:00",
"to1": "14:00",
"from2": "16:00",
"to2": "20:00"
}
]
Please note that having more than 2 time periods for each day is not possible.
[SpecialOpeningHours,...]
status
The status of the location. One of:
- ACTIVE - will be synced and renewed
- INACTIVE - will not be synced anymore, claims of listings will be released where possible
- CANCELLED - will be synced, will not be renewed. Once endDate is reached, location will switch to INACTIVE
- CLOSED - location has shut down, we'll mark listings as permanently closed or remove listings from the internet where permanently closed status is not supported
streetType
Required for Spain. One of ALAMEDA, AVENIDA, CALLE, CAMINO, CARRER, CARRETERA, GLORIETA, KALEA, PASAJE, PASEO, PLACA, PLAZA, RAMBLA, RONDA, RUA, SECTOR, TRAVESERA, TRAVESIA, URBANIZACION
LocationStatisticsResponse
LocationTask
priority
The priority of the task to be performed on the location. The value is from 1 to 90 and depends on the Task's type
type
The type of the task. The value could be on of [LISTING_FACEBOOK_CONNECTION_MISSING, LISTING_GOOGLE_CONNECTION_MISSING, LISTING_GOOGLE_VERIFICATION_MISSING, LISTING_GOOGLE_PIN_MISSING, LISTING_FIELDS_MISSING, DATAPOINT_UNREPLIED_RECENT, DATAPOINT_UNREAD, DATAPOINT_UNREPLIED_OLD, LOCATION_PROPERTIES_MISSING, LOCATION_ADD_PHOTOS, LOCATION_SOCIAL_POST_MISSING, LOCATION_RICH_DATA_MISSING, LOCATION_ADD_NEW_PHOTOS]
LocationTemporarilyClosed
reopenDate
Set a re-open date for a temporarily closed location. The location will re-open at 12:01am local time. Leave null if the re-open date is unknown.
temporarilyClosed
Required -
Locations must have either TRUE or FALSE for this field to indicate if they are temporarily closed (TRUE) or not (FALSE).
LocationTransactionLink
isPreferred
Indicates to Google which one url per transaction link type should be set as the preferred flow for customers. Not required, but it is recommended to always flag one url, even if there is only one, as preferred because Google may pull in urls from third party partners.
type
Required -
The specific customer action type - APPOINTMENT, ONLINE_APPOINTMENT, FOOD_ORDERING, FOOD_DELIVERY, FOOD_TAKEOUT, DINING_RESERVATION, SHOP_ONLINE
url
Required -
The deep-link to the page where the customer can facilitate the transaction. This should not be a homepage or location page unless the customer can make their request directly on that page. UTM parameters are not recommended and may be stripped by specific directories.
LodgingField
category
High-level grouping of Lodging Amenity types, such as SERVICES, TRANSPORTATION, FAMILIES, etc
externalId
The Google external id for each lodging amenity. Examples include: watercraftRental, turndownService, patio
LoggingEvent
type
The logging event type. One of LISTING_UPDATE, LISTING_SYNC_CHECK, LISTING_DATAPOINT_CHECK, LISTING_PUBLISHER_UPDATE, LISTING_BLACKLIST, LISTING_REVIEWED, LISTING_STATUS_CHANGE, LISTING_MANUAL, LISTING_SUPPRESS, LISTING_DELETE, LISTING_CANCEL, LISTING_FACEBOOK_PAGE_INVALIDATE, LISTING_FLAGGED, LISTING_LINK_CHANGE, LISTING_REMOVAL_SUPPRESS, LISTING_SUPPRESS_NOT_ALLOWED, LISTING_UPDATE_SPECIAL_OFFER, LISTING_REMOVAL_STATUS_CHECK, LOCATION_BILLING, LOCATION_SYNC_STARTED, LOCATION_PROFILE_CHANGED, LOCATION_SUBSCRIPTION_CHANGED, LOCATION_LISTING_ADDED, LOCATION_VISIBILITY_INDEX_CHANGED, LOCATION_STATUS_CHANGED, LOCATION_PRODUCT_PLAN_CHANGED, LOCATION_NORMALIZATION_STATUS_CHANGED, LOCATION_CREATED, LOCATION_DUPLICATE_LISTING_DETECTION, LOCATION_DUPLICATE_LISTING_CHECK, LOCATION_CHECKOUT, LOCATION_CHECKOUT_FREE, LOCATION_CHECKOUT_UPGRADE, LOCATION_CHECKOUT_SALESPARTNER, USER_PASSWORD_RESET, SALES_PARTNER_SIGNUP, SALES_PARTNER_APPROVAL, SALES_PARTNER_PASSWORD_RESET, SEARCH_DATA_RECHECK_LINK_SHARED, BUSINESS_COMMENT, BUSINESS_INVOICE_CREATED, BUSINESS_INVOICE_RENEWAL_SUCCESS, BUSINESS_INVOICE_RENEWAL_FAIL, BUSINESS_INVOICE_CREATED_FIRST_BASIC, BUSINESS_INVOICE_CREATED_FIRST_PREMIUM, BUSINESS_INVOICE_CREATED_UPGRADE_BASIC, BUSINESS_INVOICE_CREATED_UPGRADE_PREMIUM, BUSINESS_INVOICE_CREATED_ANOTHER_BASIC, BUSINESS_INVOICE_CREATED_ANOTHER_PREMIUM, BUSINESS_INVOICE_CREATED_RENEWAL, BUSINESS_DIRECTORY_ACCOUNT, BUSINESS_CSV_EXPORT, BUSINESS_UPDATE_PRICE, ADMIN_LOGIN_ALERT
LoginCommand
LoginResponse
LogoutResponse
MenuItem
dietaryRestrictions
Restrictive diet the menu item fits into (e.g. Vegetarian, Halal, etc.)
[String,...]
NextOpen
date
date when the location will be opened; for example "2018-11-16" (string) (this parameter is used only if closedNow true and neverOpens false)
dayOfWeek
day of week when the location will be opened; format like OpeningHours: 1 for Monday, 2 for Tuesday, etc (this parameter is used only if closedNow true and neverOpens false)
hour
defines at which time at the date "date" the location will be open; for example: "13:00" (this parameter is used only if closedNow true and neverOpens false)
neverOpens
true if the location will never open again; otherwise false (this parameter is used only if closedNow true)
OpeningHours
dayOfWeek
Required -
The weekday of an opening hours, e.g.: 1 for Monday, 2 for Tuesday, ...
fromX
A beginning of a period. One or multiple periods are supported per dayOfWeek, e.g.: "from1": "09:00", "from2": "15:00"
toX
An end of a period. One or multiple periods are supported per dayOfWeek, e.g.: "to1": "14:30", "to2": "17:00"
ParkingRestriction
Person
description
Description for the person: e.g. Responsible for the day-to-day operations of the store
PhotoContainer
PowerType
PricePerCountry
Product
ProductPlan
defaultPlan
True, if this is the default ProductPlan. A new created business will get this product plan, if not declared differently.
defaultPrice
Mandatory if countryPrices is not populated. Define a global price for the Product Plan that gets applied for all countries
ProductPlanCountryPriceResponse
ProductPlanResponse
defaultPlan
True, if this is the default ProductPlan. A new created business will get this product plan, if not declared differently.
ProfileCompleteness
ProfileCompletenessMultiLocationHomepageResponse
locationClassificationCounts
LocationClassificationCounts - Map with Classifications and the count of locations for each
"REQUIRED": 1, "BASIC": 1, "ADVANCED": 1, "BONUS": 1, "COMPLETE": 1
ProfileCompletenessSingleLocationHomepageResponse
ReplyRateMultiLocation
ResponseLocation
ResponseTemplate
ResponseValue
RuleResponse
canEdit
The current user can edit this rule when they have access to all businesses and locations that identify this rule
excludedLocations
List of location ids that do not identify this Auto Response Rule, even when they might belong to a business that does identify this rule
[ResponseLocation,...]
triggers
Triggers that apply to this Auto Response Rule, can be ONE_STAR, TWO_STAR, THREE_STAR, FOUR_STAR and/or FIVE_STAR
[String,...]
SalesPartner
aggregateInvoicesToParent
(only used for child SalesPartner) Indicates if the invoice for this SalesPartner should be aggregated to the parent invoice
canSeePrices
Indicates if the SalesPartner should be allowed to see price information for e.g. product plans
forceSso
If set to true, all users of this SalesPartner will only be allowed to log in our app via the SSO flow. Users cannot be created or updated directly - only via SSO. If set to false and "isSsoActive" is set, users can either log in via normal login or SSO
identifier
Identifier for SalesPartner, must be unique for child SalesPartner within parent SalesPartner
isSsoActive
If set to true this will activate the single sign-on flow for logging into our app. Note that all more details need to be set before it can be used.
preferredLanguage
Preferred language of the SalesPartner, for invoice purpose (either 'de' oder 'en')
resellerType
Applicable only for Sales Partner type = CUSTOM. Can be one of OEM_RESELLER or STANRAD_RESELLER. Depending on the selection, different reports in Advanced Analytics will be shown.
salesPartnerStatus
SalesPartner status of the SalesPartner (Be aware: Only sending 'INACTIVE' for child SalesPartner update is allowed)
whitelabelInformations
List of the sales partner's white-label information
[WhitelabelInformation,...]
whitelistedRedirectUrls
Domains that are allowed to be redirected to upon finalizing a directory connect flow
[String,...]
SalesPartnerResponse
identifier
Identifier for SalesPartner, must be unique for child SalesPartner within parent SalesPartner
SalesPartnerStatus
SearchData
SearchRanksMultiLocationHomepageResponse
SearchRanksSingleLocationHomepageResponse
ServiceArea
placeId
Required -
A unique place id , e.g. ChIJAVkDPzdOqEcRcDteW0YgIQQ, Place IDs uniquely identify a place in the Google Places database and on Google Maps. Please visit https://developers.google.com/places/place-id for more info
ServiceItem
category
Business category the service should be applied to - this is required when applying a Google structured service but not necessary for freeform services.
country
The country where the locations providing this service are located - this is required when applying a Google structured service but not necessary for freeform services.
googleService
The Google name for a structured service - this is required when applying a Google structured service but not necessary for freeform services.
SocialPost
businessIds
The list of businesses IDs as entered when creating/updating the Social Post.
[Long,...]
businessPageIds
The list of business page IDs as entered when creating/updating the Social Post
[Long,...]
callToAction
A callToAction type for a google "Special Info" (SocialPost.type=POST). Currently only supported for Google Posts. Possible values are [BOOK, ORDER, SHOP, LEARN_MORE, SIGN_UP]
couponCode
A couponCode for redeeming a "Special Offer" (SocialPost.type=OFFER). Currently only supported for Google Posts.
dateEnd
The ending date of the Social Post (type=OFFER). The post will be removed from the listings at that date. It also determines when a special offer should end.
dateStart
The starting date of EVENT and OFFER type Social Posts. It is used to indicate when an EVENT/OFFER will start. For API versions older than 20210804, it is used as publicationDate.
description
The description of the Social Post. For type QUESTION_AND_ANSWER this is going to be the answer.
directories
Required -
The list of directories as entered when creating/updating the Social Post.
[String,...]
excludedLocationIds
List of locationIds that should be excluded from the request. Can be used in combination with businessId when some locations should not be considered.
[Long,...]
firstComment
The first comment to be posted after a post creation. Only available for INSTAGRAM
listingPageIds
The list of listing page IDs as entered when creating/updating the Social Post.
[Long,...]
locationGroupIds
The list of location group IDs as entered when creating/updating the Social Post.
[Long,...]
publicationDate
Required -
The date on which the Social Post will be published. It is used to schedule posts in the future. Format: YYYY-MM-dd'T'HH:mm:ssXXXXX (Example: 2007-12-03T10:15:30+01:00)
status
The current status of the Social Post (scheduled, active, inactive, deleted, not_published, published, impossible)
termsAndConditions
Terms and Conditions for redeeming a "Special Offer" (SocialPost.type=OFFER). Currently only supported for Google Posts.
title
The title of the Social Post. For type QUESTION_AND_ANSWER this is going to be the question.
type
Required -
The type of the Social Post. POST, OFFER, QUESTION_AND_ANSWER, EVENT or ALERT.
url
A link for the Social Post. This is mandatory for a "Special Offer" and should point to a page concerning the offer.
SocialPostDirectoriesResponse
SocialPostDirectoryWarning
SocialPostMetrics
SocialPostMetricsHomepageResponse
SocialPostTemplate
callToAction
Social Post Call to Action Description (URL & Type)
description
The description of the Social Post Template. It is required if the template has no photos.
ownerId
The id of the user that owns the Social Post Template. (Only informational. If included in the request, it will be ignored.)
ownerName
The name of the user that owns the Social Post Template. (Only informational. If included in the request, it will be ignored.)
photos
The Social Post Template's photos. It should be a list containing BASE64 converted images or urls of photos from a previous Social Post. It is required if the template has no description.
[PhotoContainer,...]
type
The type of the Social Post Template. POST, OFFER or QUESTION_AND_ANSWER, EVENT or ALERT.
SocialPostTemplateCallToAction
SocialPostWarning
type
Type of the warning. For now, these are supported:
Google only: MISSING_CONNECTION, MISSING_VERIFICATION, CAN_NOT_POST_ON_GOOGLE
Facebook only: MISSING_CONNECTION
Other directories and warnings for whole locations: NEEDS_REVIEW
SocialProfile
SortableData
missingMandatoryFields
Output only. Compile all the fields that are currently missing but mandatory for some directories. They have to be set in the Location object, so that the Listing can be created / updated on the respective platform. List of Strings, e.g. [NAME, ZIP, PHONE]
[DirectoryField,...]
profileCompleteness
Output only. Number representing completeness of location data, up to 100
suggestionsForFieldsAvailable
Output Only. Boolean that indicates which locations have pending suggestions.
SpecialOpeningHours
fromX
A beginning of a period. Up to two periods are supported per date, e.g.: "from1": "09:00", "from2": "15:00"
toX
An end of a period. Up to two periods are supported per date, e.g.: "to1": "09:00", "to2": "15:00"
Statistic
countListingsSubmitted
Count of Listings where the latest information has been submitted successfully (however the publisher does not have an online verification)
StoreFinderEventsHomepageResponse
StoreFinderResponse
callToActions
A list of callToAction objects, each with a title and URL, formatted as
callToActions: [{ text: 'cta_text1', url: 'cta_url1' }, { text: 'cta_text2', url: 'cta_url2' }]
[CallToAction,...]
customItems
Custom, rich content related specifically to this location (such as company values)
[CustomItem,...]
googlePlaceId
A unique textual identifier to identify a place in the Google Places database and on Google Maps.
paymentOptions
The payment options accepted at the location (eg. cash, bank transfer, ...)
[String,...]
socialProfiles
The profiles of the location on social and professional networks (FACEBOOK, FOURSQUARE, INSTAGRAM, LINKEDIN, PINTEREST, TWITTER, VIMEO, XING, YOUTUBE)
[SocialProfile,...]
Suggestion
status
ACCEPTED, DECLINED or ACTIVE (if no decision was made for accepting/declining the suggestion)
SuggestionResponse
suggestionsForFields
Map containing fields and the suggested values from different directories.
[Map,...]
SuppressedDuplicates
TimeSeriesSegment
TodoItem
TodosHomepageResponse
TransactionLinkType
APPOINTMENT
URL where a user can book an in-person appointment. Multiple urls can be submitted.
DINING_RESERVATION
URL where a user can make a restaurant reservation. Multiple urls can be submitted.
FOOD_DELIVERY
URL where a user can order food for delivery. Multiple urls can be submitted.
FOOD_ORDERING
Deprecated Google field where online food ordering urls could be submitted. Use FOOD_DELIVERY and
FOOD_TAKEOUT instead.
FOOD_TAKEOUT
URL where a user can book place an online order for restaurant takeout. Multiple urls can be submitted.
ONLINE_APPOINTMENT
URL where a user can book an online appointment. Multiple urls can be submitted.
UTM
User
emailSettings
A list of EmailSettings for this user. Only one EmailSettings object per EmailType possible.
[EmailSettings,...]
features
A list of features this user can work with. Values:
ADS_READ ADS_WRITE ADVANCED_ANALYTICS AI_SUGGESTED_REPLIES APPLE_POSTING_WRITE AUTO_RESPONSE_WRITE BULK_UPDATES BUSINESS_LEVEL_CONNECT CAN_PAY_INVOICE CAN_SEE_HELP_SECTION CHAT_READ CHAT_WRITE CHATBOT_READ CHATBOT_WRITE DAM ENTERPRISE_ONBOARDING FIRST_PARTY_REVIEW_APPROVAL FORMS INBOX_2_0_BETA_READ INBOX_2_0_BETA_WRITE INBOX_APPROVAL INBOX_READ INBOX_WRITE INSTAGRAM_POSTING_WRITE LISTINGS_PAGE_NEW LISTINGS LIVE_CHAT LOCATION_GROUP LOCATION_READ LOCATION_SCHEDULED_UPDATES LOCATION_STATUS_CHANGE LOCATION_WRITE POSTING_APPROVAL POSTING_READ POSTING_WRITE PRICE_INFO RESPONSE_LIBRARY_READ RESPONSE_LIBRARY_WRITE REVIEW_GENERATION_CREATE REVIEW_GENERATION_SEND SINGLE_SIGN_ON SOCIAL_ADS SUPPRESSION TRACKING UPGRADE USER_OTHERS_EDIT USER_SELF_EDIT
[Feature,...]
featuresDetailed
Map containing the feature names and corresponding feature-specific parameters. "featuresDetailed" is supported for the features LOCATION_WRITE and ADVANCED_ANALYTICS.
For LOCATION_WRITE a list of fields that this user can update is expected.
For ADVANCED_ANALYTICS a list of dashboards the user has access to is expected.
For example:
"featuresDetailed": {
{
"featuresDetailed":{
"LOCATION_WRITE":[
"fax",
"openingHours",
"callTrackingNumbers",
"streetNo",
"openingHoursNotes",
"specialOpeningHours",
"street",
"languages",
"customFields",
"contentLists",
"photos",
"services",
"moreHours",
"descriptionLong",
"zip",
"lat",
"openingDate",
"email",
"addressDisplay",
"labels",
"taxNumber",
"city",
"cellphone",
"contentCollections",
"attributes",
"categories",
"imprint",
"phone",
"utms",
"addressExtra",
"keywords",
"legalIdent",
"lng",
"paymentOptions",
"descriptionShort",
"socialProfiles",
"identifier",
"website",
"country",
"province",
"name",
"videos",
"brands",
"serviceAreas"
],
"ADVANCED_ANALYTICS":[
"overview",
"listings-google",
"customer-feedback"
]
}
}
managedLocationsViaGroups
A list of all location IDs the user can manage because of assignment to certain group(s)
[Long,...]
password
Required -
The user's password. Only for POST requests. Don't use when creating a user with status INVITED!
preferredLanguage
Preferred language of a user. If not set, this will default to the language in context, e.g., location's for e-mails and browser language for our applications.
status
The status of the current user. One of CREATED, VERIFIED, UNVERIFIED, INVITED, INACTIVE, NO_LOGIN
whitelabelInformationIdentifier
Mandatory If there is more than one whitelabel for the sales partner
Parameter not provided: If there is only one whitelabel for the sales partner we default to it
Parameter not provided: If a child sales partner does not have whitelabels and the father has only one we default to the father whitelabel
UserMissingConnectionWarnings
connectedLocations
A Map with key as directory types and values the number of connected locations
[Map,...]
notConnectedLocations
A Map with key as directory types and values the number of not connected locations
[Map,...]
warnings
A Map with keys as missingConnection and missingPermission.
missingConnection is a Map with list of all connections missing connection.
missingPermission is a Map with the list of accounts connected, but missing a required permission for insights.
UserRole
ACCOUNT_MANAGER
User with second highest access level, e.g. multi-business managers, needs at least one managed business. ACCOUNT_MANAGERs are allowed to create, edit and delete locations, businesses and users with their own level or lower.
Role corresponds to Multi-Account Manager in the frontend.
Role corresponds to Multi-Account Manager in the frontend.
ADMIN
User with highest access level. ADMINs are allowed to create, edit and delete all locations, businesses and users.
Role corresponds to Admin role in the frontend.
Role corresponds to Admin role in the frontend.
BUSINESS_MANAGER
Needs at least one managed business. BUSINESS_MANAGERs are allowed to create, edit and delete locations in their businesses and users with their own level or lower. They are only allowed to edit and delete their businesses.
Role corresponds to Account Manager in the frontend.
Role corresponds to Account Manager in the frontend.
LOCATION_MANAGER
User with lowest access level, needs at least one managed location. LOCATION_MANAGERs are only allowed to edit their locations.
Rore corresponds to Location Manager in the frontend.
Rore corresponds to Location Manager in the frontend.
UserStatus
INACTIVE
User is currently inactive and cannot login, but could be set to active in the future
INVITED
Created user with no specified password. This user will receive an invitation email, built according to the user's and corresponding whitelabel information, in order to set her password.
NO_LOGIN
User cannot log into the app, but could still get notification mails e.g. DIGEST mail
Video
VisibilityIndex
Webhook
type
Event type the SalesPartner wants to receive push messages for via webhook functionality. For a list of all possible types use the GET /api/sales-partners/subscribable-event-types.
