Вы можете использовать API уведомлений продавцов, чтобы получать push-уведомления об изменениях данных учетной записи. Например, если вы подписаны на уведомления об изменении статуса продукта, вы можете получать уведомления в режиме реального времени, когда продукт будет отклонен. Вы можете подписаться на уведомления для любой из ваших дочерних учетных записей или других связанных учетных записей .
В этом руководстве приведены примеры управления уведомлениями об изменении статуса продукта. Вы можете использовать эти примеры для управления уведомлениями о других событиях, изменяя значение поля registeredEvent в ваших запросах. Полный список типов событий см. в справочнике по API уведомлений продавцов .
Подписаться
Для получения уведомлений вам понадобится callBackUri . Ваш URI обратного вызова должен соответствовать следующим требованиям:
- Должен быть общедоступным адресом HTTPS с действительным сертификатом SSL, подписанным центром сертификации.
- Должен принимать запросы HTTP
POSTс заголовкомContent-Typeи значениемapplication/json. - Должен вернуть один из следующих кодов ответа, чтобы подтвердить получение уведомления.
-
102 -
200 -
201 -
202 -
204
-
Вы можете использовать один и тот же URI обратного вызова для нескольких подписок. Мы рекомендуем использовать уникальный URI обратного вызова для каждой расширенной учетной записи и для каждого типа события, чтобы минимизировать нагрузку push-запросов на один URI.
Ниже приведен пример запроса на подписку на уведомления об изменении статуса продукта для определенного аккаунта продавца. Используйте идентификатор продавца учетной записи, которая должна получать уведомления, в качестве merchantId в URL-адресе запроса, а идентификатор продавца учетной записи, для которого следует получать уведомления, в качестве targetMerchantId в теле запроса. Если ваша учетная запись является отдельной учетной записью без связанных учетных записей и вы хотите получать уведомления для своей собственной учетной записи, используйте свой собственный идентификатор продавца в обоих местах.
POST https://merchantapi.googleapis.com/notifications/v1beta/accounts/merchantId/notificationsubscriptions/
{
"registeredEvent": "PRODUCT_STATUS_CHANGE",
"targetAccount": "accounts/targetMerchantId",
"callBackUri": "https://example.com"
}
Успешные вызовы возвращают name вашей подписки, включая идентификатор подписки:
{
"name":"accounts/merchantId/notificationsubscriptions/subscriptionId",
"registeredEvent": "PRODUCT_STATUS_CHANGE",
"targetAccount": "accounts/targetMerchantId",
"callBackUri": "https://example.com"
}
Вы можете использовать это name для GET и DELETE отдельных подписок.
Вы можете подписаться на уведомления об изменении статуса продукта для всех связанных учетных записей, включив в запрос "allManagedAccounts": true вместо targetAccount :
POST https://merchantapi.googleapis.com/notifications/v1beta/accounts/merchantId/notificationsubscriptions/
{
"registeredEvent": "PRODUCT_STATUS_CHANGE",
"allManagedAccounts": true,
"callBackUri": "https://example.com"
}
Чтобы обновить существующую подписку, используйте PATCH с update_mask , чтобы указать поля, которые вы хотите обновить, и новые значения в теле JSON:
PATCH /notifications/v1beta/accounts/merchantId/notificationsubscriptions/subscriptionId?update_mask=callBackUri
{
"callBackUri": "https://my-own-personal-domain.com"
}
Раскодировать уведомления
После создания подписки вы получаете уведомления на указанный callBackUri в следующем формате:
{"message":{"data":"{base64_encoded_string}"}}
Данные уведомления закодированы. Вы можете декодировать данные в читаемый текстовый формат для использования в вашей реализации. Вот пример контроллера загрузки Spring, который вы можете использовать для обработки закодированных данных:
@RestController
public class ExampleController {
@RequestMapping(value = "/push",
method = RequestMethod.POST,
consumes = {"application/json"},
produces = {"text/plain"})
@ResponseStatus(HttpStatus.OK)
public void doStuff(@RequestBody String message) {
//wrapped message
JSONObject jsonObject = new JSONObject(message);
JSONObject jsonMessage = jsonObject.getJSONObject("message");
message = jsonMessage.getString("data");
byte[] decodedBytes = Base64.getDecoder().decode(message);
String decodedMessage = new String(decodedBytes);
// Implement your business logic here
}
}
Вот пример декодированной base64_encoded_string :
"account": "accounts/targetMerchantId"
"managing_account": "accounts/merchantId"
"resource_type": PRODUCT
"attribute": STATUS
"changes": {
"old_value": "eligible"
"new_value": "disapproved"
"region_code": "GE"
"reporting_context": SHOPPING_ADS
},
"changes" {
"old_value": "eligible"
"new_value": "disapproved"
"region_code": "JP"
"reporting_context": SHOPPING_ADS
},
changes {
"old_value": "eligible"
"new_value": "disapproved"
"region_code": "US"
"reporting_context": SHOPPING_ADS
}
resource_id: "ONLINE~en~US~1234"
resource: "accounts/targetMerchantId/products/ONLINE~en~US~1234"
Проверьте свою реализацию
Вот пример уведомления, которое вы можете использовать для проверки URI обратного вызова и декодирования:
curl --header "Content-Type: application/json" --header "Accept: text/plain" --request POST --data '{"message":{"data":
"ImFjY291bnQiOiAiYWNjb3VudHMvMTIzNCIKIm1hbmFnaW5nX2FjY291bnQiOiAiYWNjb3VudHMvNTY3OCIKInJlc291cmNlX3R5cGUiOiBQUk9EVUNUCiJhdHRyaWJ1dGUiOiBTVEFUVVMKImNoYW5nZXMiOiB7CiAgIm9sZF92YWx1ZSI6ICJlbGlnaWJsZSIKICAicmVnaW9uX2NvZGUiOiAiVVMiCiAgInJlcG9ydGluZ19jb250ZXh0IjogU0hPUFBJTkdfQURTCn0KInJlc291cmNlX2lkIjogIk9OTElORX5lbn5VU34wMDAwMDAwMDAwMDAiCiJyZXNvdXJjZSI6ICJhY2NvdW50cy8xMjM0L3Byb2R1Y3RzL09OTElORX5lbn5VU34wMDAwMDAwMDAwMDAi"}}' https://{callBackUri}
В ответ на этот вызов ваш URI обратного вызова должен вернуть код успешного ответа . Раскодированное сообщение должно иметь следующее значение:
"account": "accounts/1234"
"managing_account": "accounts/5678"
"resource_type": PRODUCT
"attribute": STATUS
"changes": {
"old_value": "eligible"
"region_code": "US"
"reporting_context": SHOPPING_ADS
}
"resource_id": "ONLINE~en~US~000000000000"
"resource": "accounts/1234/products/ONLINE~en~US~000000000000"