From 9d9135336806c9eb42ae7560ececc64438397323 Mon Sep 17 00:00:00 2001 From: "saurabh.mehta" Date: Wed, 5 Jul 2023 12:11:14 +0530 Subject: [PATCH 1/5] Media changes --- apiary.apib | 334 ++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 325 insertions(+), 9 deletions(-) diff --git a/apiary.apib b/apiary.apib index f3013a8..06fb641 100644 --- a/apiary.apib +++ b/apiary.apib @@ -1612,6 +1612,33 @@ For example : } +## 2180 [/2180] + ++ Model (application/json) + + { + code: 2180, + message: "The recommended Image size for Google media image is 250 pixels wide and 250 pixels tall." + } + +## 2181 [/2181] + ++ Model (application/json) + + { + code: 2181, + message: "Supported video format is MP4 and OGG" + } + +## 2174 [/2174] + ++ Model (application/json) + + { + code: 2174, + message: "Unsupported media format" + } + # Group Business Create and maintain your business on Birdeye. @@ -1872,9 +1899,6 @@ Get Business API gets business information, including product features opted and + keywords: Dentists Atascadero CA, Other Dental Specialties Atascadero CA, Orthodontists Atascadero CA (string)- Keywords (Comma separated list of keywords; Max 10 keywords; used for SEO). + logoUrl: http://bzimages-prod.s3.amazonaws.com/669029760/Logo 180 X 121.png (string) - Logo Image (Dimension should be 60 x 60 px). + coverImageUrl: http://bzimages-prod.s3.amazonaws.com/669029760/California Foothills 951 X 351.jpg (string)- Cover Image (Dimension should be 995 x 316 px). - + image1URL: http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg (string) - Images for the business. - + image2URL: http://d2xt3xymj142xp.cloudfront.net/712586432/other/9fc3f2ba7c1b4dcea38ea76327c617f3.jpeg (string) - Images for the business. - + image3URL: http://d2xt3xymj142xp.cloudfront.net/712586432/other/77964cfead164cbf8f9c8dfd039269b0.jpeg (string) - Images for the business. + timezone: Pacific Standard Time (string)- Timezone of the business. + languages: English,Spanish (array)- Language. + isServiceAreaProvider: Yes (string) - To select whether the business is Service Area Business Type. Default value is : No. Possible values are: @@ -1931,9 +1955,6 @@ Get Business API gets business information, including product features opted and "services": "Beauty Salon, Hair Spa", "logoURL": "http://d3cnqzq0ivprch.cloudfront.net/prod/css/images/logo.jpg", "coverImageURL": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/spa.jpg", - "image1Url": "http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg", - "image2Url": "http://d2xt3xymj142xp.cloudfront.net/712586432/other/9fc3f2ba7c1b4dcea38ea76327c617f3.jpeg", - "image3Url": "http://d2xt3xymj142xp.cloudfront.net/712586432/other/77964cfead164cbf8f9c8dfd039269b0.jpeg", "timezone": "Pacific Standard Time", "isServiceAreaProvider": "Yes", "serviceAreas": [ @@ -2481,9 +2502,6 @@ Update Business API updates business information. "services": "Beauty Salon, Hair Spa", "logoUrl": "http://d3cnqzq0ivprch.cloudfront.net/prod/css/images/logo.jpg", "coverImageUrl": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/spa.jpg", - "image1Url": "http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg", - "image2Url": "http://d2xt3xymj142xp.cloudfront.net/712586432/other/9fc3f2ba7c1b4dcea38ea76327c617f3.jpeg", - "image3Url": "http://d2xt3xymj142xp.cloudfront.net/712586432/other/77964cfead164cbf8f9c8dfd039269b0.jpeg", "timezone": "Pacific Standard Time", "languages": [ "English", @@ -8453,6 +8471,304 @@ Update Survey Settings helps update the survey page appearance settings like Log [2096][] +# Group Business Media +Add, delete and manage business media. + +> __Supported Media Size__ +> - _Photo: JPG or PNG. 720 x 720px. 10KB min._ +> - _Video: 30 sec long. 720p or more upto 75MB._ + + +## Add Media [/resources/v1/business/{businessNumber}/upload/media] +API to upload the Business Media. + + +### Add Media [POST] + ++ Parameters + + + businessNumber: 123456789 (string, required) - Location Number of the business, in case of SMB it will be Business Number. + + ++ Request (application/json) + + + Headers + + Accept: application/json + api_key: [Required] Partner specific API key provided by Birdeye for data exchange. + + + + Attributes + + media (required, array) - List of media items to be uploaded. + + (object) + + url: https://images.pexels.com/photos/12128533/pexelsphoto12128533.jpeg (string, required) - Url of the media item. + + mediaCategory: PROFILE (string, required) - Category for the media item. Possible values are: + CATEGORY_UNSPECIFIED (PHOTO) + EXTERIOR (PHOTO, VIDEO) + INTERIOR (PHOTO, VIDEO) + PRODUCT (PHOTO) + AT_WORK (PHOTO) + FOOD_AND_DRINK (PHOTO, VIDEO) + MENU (PHOTO, VIDEO) + COMMON_AREA (PHOTO) + ROOMS (PHOTO) + TEAMS (PHOTO, VIDEO) + ADDITIONAL (PHOTO, VIDEO) + + description: Profile photo (string, required) - Description of the media. + + mediaFormat: PHOTO (string, required) - Format of the Media. Possible values are: + PHOTO + VIDEO + + + + + Body + + { + "media": [ + { + "url": "https://images.pexels.com/photos/12128533/pexels-photo-12128533.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=2", + "mediaCategory": "PROFILE", + "description": "Profile photo", + "mediaFormat": "PHOTO" + }, + { + "url": "https://images.pexels.com/photos/123123/pexels-photo-123123.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=2", + "mediaCategory": "ADDITIONAL", + "description": "Additional photo", + "mediaFormat": "PHOTO" + } + ] + } + ++ Response 200 + + + + Attributes + + media (required, array) - List of media items. + + (object) + + mediaId: 987654321123 (string) - Id of the media. + + url: https://images.pexels.com/photos/12128533/pexelsphoto12128533.jpeg (string) - Url of the media item. + + mediaCategory: PROFILE (string) - Category for the media item. + + description: Profile photo (string) - Description of the media. + + mediaFormat: PHOTO (string) - Format of the Media. + + + + Body + + { + "media": [ + { + "mediaId": "987654321123", + "url": "https://images.pexels.com/photos/12128533/pexels-photo-12128533.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=2", + "mediaCategory": "PROFILE", + "description": "Profile photo", + "mediaFormat": "PHOTO" + }, + { + "mediaId": "7654321123", + "url": "https://images.pexels.com/photos/123123/pexels-photo-123123.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=2", + "mediaCategory": "ADDITIONAL", + "description": "Additional photo", + "mediaFormat": "PHOTO" + } + ] + } + ++ Response 401 + + [1161][] + ++ Response 401 + + [1167][] + ++ Response 429 + + [89][] + ++ Response 400 + + [2174][] + ++ Response 400 + + [2180][] + ++ Response 400 + + [2181][] + + + +## Get Media [/resources/v1/business/{businessNumber}/media/get] +API to get the Business Media details. + +### Get Media [GET] + ++ Parameters + + + businessNumber: 123456789 (string, required) - Location Number of the business, in case of SMB it will be Business Number. + + ++ Request (application/json) + + + Headers + + Accept: application/json + api_key: [Required] Partner specific API key provided by Birdeye for data exchange. + + ++ Response 200 + + + + Attributes + + media (array) - List of media items of the business. + + (object) + + mediaId: 987654321123 (string) - Id of the media. + + url: https://images.pexels.com/photos/12128533/pexelsphoto12128533.jpeg (string) - Url of the media item. + + mediaCategory: TEAMS (string) - Category for the media item. + + description: Team photo (string) - Description of the media. + + mediaFormat: PHOTO (string) - Format of the Media. + + + + Body + + { + "media": [ + { + "mediaId": "987654321123", + "url": "https://video.test.com/video/12128533/pexels-video-12128533.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=2", + "mediaCategory": "TEAMS", + "description": "Team video", + "mediaFormat": "VIDEO" + }, + { + "mediaId": "7654321122", + "url": "https://images.pexels.com/photos/123123/pexels-photo-123123.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=2", + "mediaCategory": "ADDITIONAL", + "description": "Additional photo", + "mediaFormat": "PHOTO" + } + ] + } + ++ Response 401 + + [1161][] + ++ Response 401 + + [1167][] + ++ Response 429 + + [89][] + + +## Update Media [/resources/v1/business/{businessNumber}/update/media/{mediaId}] +API to update the Business Media. + +### Update Media [PUT] + ++ Parameters + + + businessNumber: 123456789 (string, required) - Location Number of the business, in case of SMB it will be Business Number. + + mediaId: 62185029212 (string, required) - Id of the media item. + + ++ Request (application/json) + + + Headers + + Accept: application/json + api_key: [Required] Partner specific API key provided by Birdeye for data exchange. + + + + Attributes + + mediaCategory: PROFILE (string, required) - Category for the media item. Possible values are: + CATEGORY_UNSPECIFIED + EXTERIOR + INTERIOR + PRODUCT + AT_WORK + FOOD_AND_DRINK + MENU + COMMON_AREA + ROOMS + TEAMS + ADDITIONAL + + + + + Body + + { + "mediaCategory": "FOOD_AND_DRINK" + } + ++ Response 200 + + ++ Response 401 + + [1161][] + ++ Response 401 + + [1167][] + ++ Response 429 + + [89][] + ++ Response 400 + + [2174][] + + +## Delete Media [/resources/v1/business/{businessNumber}/media/delete] +API to delete the Business Medias. + +### Delete Media [POST] + ++ Parameters + + + businessNumber: 123456789 (string, required) - Location Number of the business, in case of SMB it will be Business Number. + + ++ Request (application/json) + + + Headers + + Accept: application/json + api_key: [Required] Partner specific API key provided by Birdeye for data exchange. + + + + Attributes + + mediaIds: 123456,654321 (array, required) - List of Media Ids to be deleted. + + + + Body + + { + "mediaIds": ["987654321123","7654321123"] + } + ++ Response 200 + + ++ Response 401 + + [1161][] + ++ Response 401 + + [1167][] + ++ Response 429 + + [89][] + # Group Social Create and track Social posting for all channels. From 589521dd22c7b0056d817669a79d4d6004a82fdc Mon Sep 17 00:00:00 2001 From: "saurabh.mehta" Date: Wed, 5 Jul 2023 12:16:49 +0530 Subject: [PATCH 2/5] Media changes --- apiary.apib | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/apiary.apib b/apiary.apib index 06fb641..8f6ec09 100644 --- a/apiary.apib +++ b/apiary.apib @@ -2196,8 +2196,6 @@ Update Business API updates business information. Full width cover image, business info overlay Full width cover image, business info below Google map view, business info overlay - + galleryPhotos: http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg (string) - Images for the business. - + videoUrl: http://d2xt3xymj142xp.cloudfront.net/712586432/other/9fc3f2ba7c1b4dcea38ea76327c617f3.jpeg (string) - Video URL for business. Format: MP4, OGG, OGV. Size: Maximum 100MB. + covidInfo (object) - Provide covid related update in. + postDescription (string) - Post will be update on gmb & FB + covid19SupportLink (string) - Should be a valid covid19 support url @@ -2402,12 +2400,6 @@ Update Business API updates business information. "fbCoverOptOut": 1, "coverImageUrl": "http://d3cnqzq0ivprch.cloudfront.net/common/css/images/profile/spa.jpg", "coverBusinessInfoLayout": "In grid cover image, business info overlay", - "galleryPhotos": [ - "http://d2xt3xymj142xp.cloudfront.net/712586432/other/ab60b93831ba490383b9c59c0b4cf49d.jpeg", - "http://d2xt3xymj142xp.cloudfront.net/712586432/other/9fc3f2ba7c1b4dcea38ea76327c617f3.jpeg", - "http://d2xt3xymj142xp.cloudfront.net/712586432/other/77964cfead164cbf8f9c8dfd039269b0.jpeg" - ], - "videoUrl": "http://d2xt3xymj142xp.cloudfront.net/712586432/other/77964cfead164cbf8f9c8dfd039269b0.mp4", "covidInfo": { "postDescription": "", "covid19SupportLink": "", @@ -10901,6 +10893,7 @@ Add Business Integration Mapping adds locations to integrations and set them act # Group Change Logs +* 07/07/2023 - Added CRUD APIs for Business Media. * 06/30/2023 - Added support for service area based information in Get Business API and Update Business API. * 04/20/2023 - Added two new API under Listing module, Get Listings Insights and Get Listings Insights Datapoints. * 04/03/2023 - Added two new APIs under Social module, Post Social Schedule and Track Social Post. From 68219d1224af1b470c5e35fffec1232c224c838b Mon Sep 17 00:00:00 2001 From: "saurabh.mehta" Date: Wed, 5 Jul 2023 12:21:02 +0530 Subject: [PATCH 3/5] Media changes --- apiary.apib | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/apiary.apib b/apiary.apib index 8f6ec09..9546d3a 100644 --- a/apiary.apib +++ b/apiary.apib @@ -8479,7 +8479,7 @@ API to upload the Business Media. + Parameters - + businessNumber: 123456789 (string, required) - Location Number of the business, in case of SMB it will be Business Number. + + businessNumber: 123456789 (string, required) - Location Number, in case of SMB it will be Business Number. + Request (application/json) @@ -8599,7 +8599,7 @@ API to get the Business Media details. + Parameters - + businessNumber: 123456789 (string, required) - Location Number of the business, in case of SMB it will be Business Number. + + businessNumber: 123456789 (string, required) - Location Number, in case of SMB it will be Business Number. + Request (application/json) @@ -8664,7 +8664,7 @@ API to update the Business Media. + Parameters - + businessNumber: 123456789 (string, required) - Location Number of the business, in case of SMB it will be Business Number. + + businessNumber: 123456789 (string, required) - Location Number, in case of SMB it will be Business Number. + mediaId: 62185029212 (string, required) - Id of the media item. @@ -8725,7 +8725,7 @@ API to delete the Business Medias. + Parameters - + businessNumber: 123456789 (string, required) - Location Number of the business, in case of SMB it will be Business Number. + + businessNumber: 123456789 (string, required) - Location Number, in case of SMB it will be Business Number. + Request (application/json) From e18b016ac12e7e7a20bbbd84297c811fcbda519f Mon Sep 17 00:00:00 2001 From: "saurabh.mehta" Date: Wed, 5 Jul 2023 12:26:04 +0530 Subject: [PATCH 4/5] Media changes --- apiary.apib | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/apiary.apib b/apiary.apib index 9546d3a..74e1479 100644 --- a/apiary.apib +++ b/apiary.apib @@ -8677,18 +8677,18 @@ API to update the Business Media. + Attributes - + mediaCategory: PROFILE (string, required) - Category for the media item. Possible values are: - CATEGORY_UNSPECIFIED - EXTERIOR - INTERIOR - PRODUCT - AT_WORK - FOOD_AND_DRINK - MENU - COMMON_AREA - ROOMS - TEAMS - ADDITIONAL + + mediaCategory: FOOD_AND_DRINK (string, required) - Category for the media item. Possible values are: + CATEGORY_UNSPECIFIED + EXTERIOR + INTERIOR + PRODUCT + AT_WORK + FOOD_AND_DRINK + MENU + COMMON_AREA + ROOMS + TEAMS + ADDITIONAL From cb32dbeccb725d413f5ec72f3a1cf691efc84c0f Mon Sep 17 00:00:00 2001 From: "saurabh.mehta" Date: Tue, 25 Jul 2023 15:56:33 +0530 Subject: [PATCH 5/5] Added the media support --- apiary.apib | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/apiary.apib b/apiary.apib index 3efe2b6..297ab0a 100644 --- a/apiary.apib +++ b/apiary.apib @@ -1637,7 +1637,7 @@ For example : { code: 2181, - message: "Supported video format is MP4 and OGG" + message: "Supported video format is MP4." } ## 2174 [/2174] @@ -8536,7 +8536,7 @@ API to upload the Business Media. INTERIOR (PHOTO, VIDEO) TEAMS (PHOTO, VIDEO) ADDITIONAL (PHOTO, VIDEO) - + description: Teams photo (string, required) - Description of the media. + + description: Image of the team (string, required) - Description of the media. + mediaFormat: PHOTO (string, required) - Format of the Media. Possible values are: PHOTO VIDEO @@ -8550,13 +8550,13 @@ API to upload the Business Media. { "url": "https://images.pexels.com/photos/12128533/pexels-photo-12128533.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=2", "mediaCategory": "TEAMS", - "description": "Teams photo", + "description": "Image of the team", "mediaFormat": "PHOTO" }, { "url": "https://videos.pexels.com/video/123123/pexelsvideo-12323.mp4", "mediaCategory": "ADDITIONAL", - "description": "Additional photo", + "description": "Introductory video", "mediaFormat": "VIDEO" } ] @@ -8571,7 +8571,7 @@ API to upload the Business Media. + mediaId: 987654321123 (string) - Id of the media. + url: https://images.pexels.com/photos/12128533/pexelsphoto12128533.jpeg (string) - Url of the media item. + mediaCategory: TEAMS (string) - Category for the media item. - + description: Teams photo (string) - Description of the media. + + description: Image of the team (string) - Description of the media. + mediaFormat: PHOTO (string) - Format of the Media. @@ -8583,14 +8583,14 @@ API to upload the Business Media. "mediaId": "987654321123", "url": "https://images.pexels.com/photos/12128533/pexels-photo-12128533.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=2", "mediaCategory": "TEAMS", - "description": "Teams photo", + "description": "Image of the team", "mediaFormat": "PHOTO" }, { "mediaId": "7654321123", "url": "https://videos.pexels.com/video/123123/pexelsvideo-12323.mp4", "mediaCategory": "ADDITIONAL", - "description": "Additional photo", + "description": "Introductory video", "mediaFormat": "VIDEO" } ] @@ -8649,7 +8649,7 @@ API to get the Business Media details. + mediaId: 987654321123 (string) - Id of the media. + url: https://images.pexels.com/photos/12128533/pexelsphoto12128533.jpeg (string) - Url of the media item. + mediaCategory: TEAMS (string) - Category for the media item. - + description: Team photo (string) - Description of the media. + + description: Image of the team (string) - Description of the media. + mediaFormat: PHOTO (string) - Format of the Media. @@ -8661,14 +8661,14 @@ API to get the Business Media details. "mediaId": "987654321123", "url": "https://images.pexels.com/photos/12128533/pexels-photo-12128533.jpeg?auto=compress&cs=tinysrgb&w=1260&h=750&dpr=2", "mediaCategory": "TEAMS", - "description": "Teams photo", + "description": "Image of the team", "mediaFormat": "PHOTO" }, { "mediaId": "7654321122", "url": "https://videos.pexels.com/video/123123/pexelsvideo-12323.mp4", "mediaCategory": "ADDITIONAL", - "description": "Additional photo", + "description": "Introductory video", "mediaFormat": "VIDEO" } ]