Получайте push-уведомления об изменениях данных вашей учетной записи

Вы можете использовать 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",
  "managingAccount": "accounts/merchantId",
  "resourceType": "PRODUCT",
  "attribute": "STATUS",
  "changes": [{
    "oldValue": "eligible",
    "newValue": "disapproved",
    "regionCode": "US",
    "reportingContext": "SHOPPING_ADS"
  }, {
    "oldValue": "eligible",
    "newValue": "disapproved",
    "regionCode": "JP",
    "reportingContext": "SHOPPING_ADS"
  },{
    "oldValue": "eligible",
    "newValue": "disapproved",
    "regionCode": "GE",
    "reportingContext": "SHOPPING_ADS"
  }],
  "resourceId": "ONLINE~en~US~1234",
  "resource": "accounts/targetMerchantId/products/ONLINE~en~US~1234",
  "expirationTime": "2024-10-22T02:43:47.461464Z"
}

Если в уведомлении нет поля oldValue , в вашу учетную запись добавлен новый товар. Если поле newValue отсутствует, товар был удален из вашей учетной записи.

Поле reportingContext поддерживает только ( SHOPPING_ADS , LOCAL_INVENTORY_ADS , YOUTUBE_SHOPPING , YOUTUBE_CHECKOUT ) из значения перечисления ReportingContextEnum .

Проверьте свою реализацию

Вот пример уведомления, которое вы можете использовать для проверки URI обратного вызова и декодирования:

curl --header "Content-Type: application/json" --header "Accept: text/plain" --request POST --data '{"message":{"data":
"ewogICJhY2NvdW50IjogImFjY291bnRzLzEyMzQiLAogICJtYW5hZ2luZ0FjY291bnQiOiAiYWNjb3VudHMvNTY3OCIsCiAgInJlc291cmNlVHlwZSI6ICJQUk9EVUNUIiwKICAiYXR0cmlidXRlIjogIlNUQVRVUyIsCiAgImNoYW5nZXMiOiBbewogICAgIm9sZFZhbHVlIjogImVsaWdpYmxlIiwKICAgICJyZWdpb25Db2RlIjogIlVTIiwKICAgICJyZXBvcnRpbmdDb250ZXh0IjogIlNIT1BQSU5HX0FEUyIKICB9XSwKICAicmVzb3VyY2VJZCI6ICJPTkxJTkV+ZW5+VVN+MDAwMDAwMDAwMDAwIiwKICAicmVzb3VyY2UiOiAiYWNjb3VudHMvMTIzNC9wcm9kdWN0cy9PTkxJTkV+ZW5+VVN+MDAwMDAwMDAwMDAwIiwKICAiZXhwaXJhdGlvblRpbWUiOiAiMjAyNC0xMC0yMlQwMjo0Mzo0Ny40NjE0NjRaIgp9"}}' https://{callBackUri}

В ответ на этот вызов ваш URI обратного вызова должен вернуть код успешного ответа . Раскодированное сообщение должно иметь следующее значение:

{
  "account": "accounts/1234",
  "managingAccount": "accounts/5678",
  "resourceType": "PRODUCT",
  "attribute": "STATUS",
  "changes": [{
    "oldValue": "eligible",
    "regionCode": "US",
    "reportingContext": "SHOPPING_ADS"
  }],
  "resourceId": "ONLINE~en~US~000000000000",
  "resource": "accounts/1234/products/ONLINE~en~US~000000000000",
  "expirationTime": "2024-10-22T02:43:47.461464Z"
}