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

Вы можете использовать API Merchant Notifications для получения push-уведомлений об изменениях в данных о продукте. Например, если вы подписаны на уведомления об изменении статуса продукта, вы можете получать уведомления в режиме реального времени, когда продукт будет отклонен. Вы можете подписаться на уведомления для любого из ваших субсчетов или других связанных счетов .

В этом руководстве приведены примеры того, как управлять уведомлениями об изменении статуса продукта. Вы можете использовать эти примеры для управления уведомлениями о других событиях, изменяя значение поля registeredEvent в своих запросах. Полный список типов событий см. в справочнике Merchant Notifications API .

Подписаться

Для получения уведомлений вам нужен callBackUri . Ваш callback URI должен соответствовать следующим требованиям:

  • Должен быть общедоступный HTTPS-адрес с действительным SSL-сертификатом, подписанным центром сертификации.
  • Необходимо принимать HTTP-запросы POST с заголовком Content-Type и значением application/json .
  • Необходимо вернуть один из следующих кодов ответа, чтобы подтвердить получение уведомления.
    • 102
    • 200
    • 201
    • 202
    • 204

Вы можете использовать один и тот же URI обратного вызова для нескольких подписок. Мы рекомендуем использовать уникальный URI обратного вызова для каждой расширенной учетной записи и для каждого типа события, чтобы минимизировать нагрузку push-запросов на один URI.

Ниже приведен пример запроса на подписку на уведомления об изменении статуса товара для определенного торгового счета.

POST https://merchantapi.googleapis.com/notifications/v1/accounts/MERCHANT_ID/notificationsubscriptions/

{
  "registeredEvent": "PRODUCT_STATUS_CHANGE",
  "targetAccount": "accounts/TARGETMERCHANT_ID",
  "callBackUri": "https://example.com"
}

Заменить следующее:

  • MERCHANT_ID : уникальный идентификатор счета, на который должны приходить уведомления.
  • TARGETMERCHANT_ID : уникальный идентификатор учетной записи, о которой вы хотите получать уведомления.

Если ваша учетная запись Merchant Center является отдельной учетной записью без связанных учетных записей и вы хотите получать уведомления для своей учетной записи, замените обе эти переменные на идентификатор своей учетной записи.

Успешные вызовы возвращают name вашей подписки, включая идентификатор подписки:

{
  "name":"accounts/MERCHANT_ID/notificationsubscriptions/subscriptionId",
  "registeredEvent": "PRODUCT_STATUS_CHANGE",
  "targetAccount": "accounts/TARGETMERCHANT_ID",
  "callBackUri": "https://example.com"
}

Вы можете использовать это name для GET и DELETE отдельных подписок.

Вы можете подписаться на уведомления об изменении статуса продукта для всех связанных учетных записей, включив в свой запрос "allManagedAccounts": true вместо targetAccount :

POST https://merchantapi.googleapis.com/notifications/v1/accounts/MERCHANT_ID/notificationsubscriptions/

{
  "registeredEvent": "PRODUCT_STATUS_CHANGE",
  "allManagedAccounts": true,
  "callBackUri": "https://example.com"
}

Чтобы обновить существующую подписку, используйте PATCH с update_mask чтобы указать поля, которые вы хотите обновить, и новые значения в теле JSON:

PATCH https://merchantapi.googleapis.com/notifications/v1/accounts/MERCHANT_ID/notificationsubscriptions/SUBSCRIPTION_ID?update_mask=callBackUri

{
  "​callBackUri": "https://my-own-personal-domain.com"
}

Расшифровать уведомления

После создания подписки вы получаете уведомления на указанный callBackUri в следующем формате:

{"message":{"data":"{base64_encoded_string}"}}

Данные уведомления закодированы. Вы можете декодировать данные в читаемый текстовый формат для использования в вашей реализации. Вот пример контроллера Spring Boot, который вы можете использовать для обработки закодированных данных:

@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/TARGETMERCHANT_ID",
  "managingAccount": "accounts/MERCHANT_ID",
  "resourceType": "PRODUCT",
  "attribute": "STATUS",
  "changes": [{
    "oldValue": "approved",
    "newValue": "disapproved",
    "regionCode": "US",
    "reportingContext": "SHOPPING_ADS"
  }, {
    "oldValue": "approved",
    "newValue": "disapproved",
    "regionCode": "JP",
    "reportingContext": "SHOPPING_ADS"
  },{
    "oldValue": "approved",
    "newValue": "disapproved",
    "regionCode": "GE",
    "reportingContext": "SHOPPING_ADS"
  }],
  "resourceId": "ONLINE~en~US~1234",
  "resource": "accounts/TARGETMERCHANT_ID/products/ONLINE~en~US~1234",
  "expirationTime": "2024-10-22T02:43:47.461464Z",
  "eventTime": "2024-03-21T02:43:47.461464Z"
}

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

Поле expirationTime не будет существовать, если продукт был удален.

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

Для события изменения статуса продукта поля oldValue и newValue будут иметь одно из следующих значений: ( approved , pending , disapproved , ``).

Поле eventTime содержит время создания самого события. Если вы хотите упорядочить сообщения, вам следует полагаться на значение в этом поле, а не на порядок получения сообщений.

Для получения более подробной информации следуйте формату ProductStatusChangeMessage .

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

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

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

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

{
  "account": "accounts/1234",
  "managingAccount": "accounts/5678",
  "resourceType": "PRODUCT",
  "attribute": "STATUS",
  "changes": [{
    "oldValue": "approved",
    "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",
  "eventTime": "2024-03-21T02:43:47.461464Z"
}
Назад
Control access to your account
Далее
Enable automatic improvements