From f612a0066b4ccf24103c6653e07f5a32c679ec0c Mon Sep 17 00:00:00 2001 From: Nitesh M Date: Wed, 23 Apr 2025 14:25:48 +0530 Subject: [PATCH 1/3] google suggestions apis --- apiary.apib | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) diff --git a/apiary.apib b/apiary.apib index 826937a..fe734b4 100644 --- a/apiary.apib +++ b/apiary.apib @@ -15727,6 +15727,82 @@ Google keyword: Top keywords searched for which your business is ranked. [2458][] +## Get Google Suggestions [/resources/v1/listing/googleSuggestions{?status}] + +Google Suggestions public APIs provide a way for businesses to review suggestions from Google and approve/reject them. + +### Get Google Suggestions [GET] + ++ Parameters + + status (optional, string) - Filter by status. Possible values: `Pending`, `Approved`, `Rejected`. If not passed, all suggestions are shown. + ++ Request (application/json) + + Headers + + api-key: [Required] Partner specific API key provided by Birdeye for data exchange. + businessId: 169744180007807 (number, required) - Business Number. + ++ Response 200 (application/json) + + { + "totalCount": 2, + "result": [ + { + "suggestionId": 2435345, + "locationName": "100 NY Street", + "suggestedAttributeName": "Phone Number", + "suggestedInput": "+1 34567899004", + "status": "Approved", + "lastActivity": "Date MMM DD YYYY format", + "lastActivityByName": "Michecl Smith", + "birdeyeValue": "+1 4667766545", + "suggestionReceivedDate": "", + "lastValueUpdatedOn": "", + "userComments": "Approved, effects All listings" + }, + { + "suggestionId": 2435345, + "locationName": "100 NY Street", + "suggestedAttributeName": "Category", + "suggestedInput": "E-commerce", + "birdeyeValue": "retail", + "status": "PENDING_REVIEW", + "lastActivity": "Date MMM DD YYYY format", + "lastActivityByName": "Michecl Smith", + "suggestionReceivedDate": "23/04/2024 14:34:00", + "lastValueUpdatedOn": "", + "userComments": null + } + ] + } + + +## Update Google Suggestions [/resources/v1/listing/update/GoogleSuggestions] + +API to approve or reject Google Suggestions by passing the suggestion IDs and an action. + +### Update Google Suggestions [POST] + ++ Request (application/json) + + Headers + + api-key: [Required] Partner specific API key provided by Birdeye for data exchange. + businessId: 169744180007807 (number, required) - Business Number. + + + Body + + { + "suggestionIds": [12345,56789], + "action": "approved" + } + ++ Response 200 (application/json) + + { + "code":200, + "message":"suggestion(s) processed successfully" + } + ## Deactivate Listing [/v1/listing/{businessNumber}/deactivate] Deactivate Listing API stops publishing any information on the given online directories/ listings sites (as per your plan/ package chosen). From 52436e50150051c47b10e4052daa87ff7eda6d0b Mon Sep 17 00:00:00 2001 From: Nitesh M Date: Wed, 23 Apr 2025 18:55:11 +0530 Subject: [PATCH 2/3] change --- apiary.apib | 91 +++++++++++++++++++++++++++++++++-------------------- 1 file changed, 57 insertions(+), 34 deletions(-) diff --git a/apiary.apib b/apiary.apib index fe734b4..356f6e3 100644 --- a/apiary.apib +++ b/apiary.apib @@ -15729,7 +15729,7 @@ Google keyword: Top keywords searched for which your business is ranked. ## Get Google Suggestions [/resources/v1/listing/googleSuggestions{?status}] -Google Suggestions public APIs provide a way for businesses to review suggestions from Google and approve/reject them. +Google Suggestions allow businesses to access, review, and manage suggestions by approving or rejecting them as needed ### Get Google Suggestions [GET] @@ -15742,44 +15742,63 @@ Google Suggestions public APIs provide a way for businesses to review suggestion api-key: [Required] Partner specific API key provided by Birdeye for data exchange. businessId: 169744180007807 (number, required) - Business Number. -+ Response 200 (application/json) ++ Response 200 + + + Attributes (object) + + totalCount: 2 (number) - Total number of Google Suggestions returned. + + result (array) - A list of suggestion objects. + + (object) + + suggestionId: 2435345 (number) - Unique identifier for the suggestion. + + locationName: 100 NY Street (string) - Name or address of the business location. + + suggestedAttributeName: Phone Number (string) - Attribute being suggested for update. + + suggestedInput: +1 34567899004 (string) - New value suggested for the attribute. + + birdeyeValue: +1 4667766545 (string) - Current value stored in the system. + + status: Approved (string) - Status of the suggestion. Possible values: `PENDING_REVIEW`, `Approved`, `Rejected`. + + lastActivity: Date MMM DD YYYY format (string) - Date of the most recent activity. + + lastActivityByName: Michecl Smith (string) - Name of the user who last acted on the suggestion. + + suggestionReceivedDate: 23/04/2024 14:34:00 (string) - Date and time when the suggestion was received. + + lastValueUpdatedOn: 23/04/2024 14:34:00 (string) - Date when the value was last updated, if applicable. + + userComments: Approved, effects All listings (string) - Comments added by the user. May be null. + + + Body + + { + "totalCount": 2, + "result": [ + { + "suggestionId": 2435345, + "locationName": "100 NY Street", + "suggestedAttributeName": "Phone Number", + "suggestedInput": "+1 34567899004", + "status": "Approved", + "lastActivity": "Date MMM DD YYYY format", + "lastActivityByName": "Michecl Smith", + "birdeyeValue": "+1 4667766545", + "suggestionReceivedDate": "", + "lastValueUpdatedOn": "", + "userComments": "Approved, effects All listings" + }, + { + "suggestionId": 2435345, + "locationName": "100 NY Street", + "suggestedAttributeName": "Category", + "suggestedInput": "E-commerce", + "birdeyeValue": "retail", + "status": "PENDING_REVIEW", + "lastActivity": "Date MMM DD YYYY format", + "lastActivityByName": "Michecl Smith", + "suggestionReceivedDate": "23/04/2024 14:34:00", + "lastValueUpdatedOn": "", + "userComments": null + } + ] + } - { - "totalCount": 2, - "result": [ - { - "suggestionId": 2435345, - "locationName": "100 NY Street", - "suggestedAttributeName": "Phone Number", - "suggestedInput": "+1 34567899004", - "status": "Approved", - "lastActivity": "Date MMM DD YYYY format", - "lastActivityByName": "Michecl Smith", - "birdeyeValue": "+1 4667766545", - "suggestionReceivedDate": "", - "lastValueUpdatedOn": "", - "userComments": "Approved, effects All listings" - }, - { - "suggestionId": 2435345, - "locationName": "100 NY Street", - "suggestedAttributeName": "Category", - "suggestedInput": "E-commerce", - "birdeyeValue": "retail", - "status": "PENDING_REVIEW", - "lastActivity": "Date MMM DD YYYY format", - "lastActivityByName": "Michecl Smith", - "suggestionReceivedDate": "23/04/2024 14:34:00", - "lastValueUpdatedOn": "", - "userComments": null - } - ] - } ## Update Google Suggestions [/resources/v1/listing/update/GoogleSuggestions] -API to approve or reject Google Suggestions by passing the suggestion IDs and an action. +API to approve or reject Google Suggestions by providing suggestion IDs and the corresponding action. ### Update Google Suggestions [POST] @@ -15789,6 +15808,10 @@ API to approve or reject Google Suggestions by passing the suggestion IDs and an api-key: [Required] Partner specific API key provided by Birdeye for data exchange. businessId: 169744180007807 (number, required) - Business Number. + + Attributes (object) + + suggestionIds: [12345, 56789] (array[number], required) - List of suggestion IDs to be approved or rejected. + + action: approved (string, required) - Action to be performed on the suggestions. Possible values: `approved`, `rejected`. + + Body { From 65ed5981a73d123de22b13781ac36ba3e6b9af80 Mon Sep 17 00:00:00 2001 From: Nitesh M Date: Mon, 28 Apr 2025 12:42:28 +0530 Subject: [PATCH 3/3] change --- apiary.apib | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/apiary.apib b/apiary.apib index 356f6e3..ad0f007 100644 --- a/apiary.apib +++ b/apiary.apib @@ -15748,17 +15748,17 @@ Google Suggestions allow businesses to access, review, and manage suggestions by + totalCount: 2 (number) - Total number of Google Suggestions returned. + result (array) - A list of suggestion objects. + (object) - + suggestionId: 2435345 (number) - Unique identifier for the suggestion. - + locationName: 100 NY Street (string) - Name or address of the business location. - + suggestedAttributeName: Phone Number (string) - Attribute being suggested for update. - + suggestedInput: +1 34567899004 (string) - New value suggested for the attribute. + + suggestionId: 2435345 (number) - Unique identifier for the suggestion (auto generated). + + locationName: 100 NY Street (string) - Name or alias of the location for which suggestion is received. + + suggestedAttributeName: Phone Number (string) - Field for which suggestion is received from google. + + suggestedInput: +1 34567899004 (string) - Suggested input/value from google for the above field. + birdeyeValue: +1 4667766545 (string) - Current value stored in the system. + status: Approved (string) - Status of the suggestion. Possible values: `PENDING_REVIEW`, `Approved`, `Rejected`. - + lastActivity: Date MMM DD YYYY format (string) - Date of the most recent activity. + + lastActivity: Date MMM DD YYYY format (string) - Date and time for any last action performed over the suggestion. + lastActivityByName: Michecl Smith (string) - Name of the user who last acted on the suggestion. - + suggestionReceivedDate: 23/04/2024 14:34:00 (string) - Date and time when the suggestion was received. - + lastValueUpdatedOn: 23/04/2024 14:34:00 (string) - Date when the value was last updated, if applicable. - + userComments: Approved, effects All listings (string) - Comments added by the user. May be null. + + suggestionReceivedDate: 23/04/2024 14:34:00 (string) - Initial Date and time when the suggestion was received from google. + + lastValueUpdatedOn: 23/04/2024 14:34:00 (string) - Date when any update or another suggestion received on top of the previous suggestion. + + userComments: Approved, effects All listings (string) - Comments added by the user while approving/rejecting the suggestion. + Body @@ -15809,8 +15809,8 @@ API to approve or reject Google Suggestions by providing suggestion IDs and the businessId: 169744180007807 (number, required) - Business Number. + Attributes (object) - + suggestionIds: [12345, 56789] (array[number], required) - List of suggestion IDs to be approved or rejected. - + action: approved (string, required) - Action to be performed on the suggestions. Possible values: `approved`, `rejected`. + + suggestionIds: [12345, 56789] (array[number], required) - List of suggestion IDs selected by user to be approved or rejected. + + action: approved (string, required) - user wants to approve or rejects these suggestions based on that value will be set. Possible values: `approved`, `rejected`. + Body