Możesz użyć interfejsu Merchant Notifications API, aby otrzymywać powiadomienia push o zmianach w danych produktów. Jeśli na przykład subskrybujesz powiadomienia o zmianie stanu produktu, możesz otrzymywać powiadomienia w czasie rzeczywistym, gdy produkt zostanie odrzucony. Możesz subskrybować powiadomienia dotyczące dowolnego z Twoich subkont lub innych połączonych kont.
W tym przewodniku znajdziesz przykłady zarządzania powiadomieniami o zmianach stanu produktu. Możesz użyć tych przykładów do zarządzania powiadomieniami o innych zdarzeniach, zmieniając wartość pola registeredEvent w swoich żądaniach. Pełną listę typów zdarzeń znajdziesz w przewodniku po interfejsie Merchant Notifications API.
Subskrybuj
Aby otrzymywać powiadomienia, musisz mieć callBackUri. Identyfikator URI wywołania zwrotnego musi spełniać te wymagania:
- Musi to być publicznie dostępny adres HTTPS z ważnym certyfikatem SSL podpisanym przez urząd certyfikacji.
- Musi akceptować żądania HTTP
POSTz nagłówkiemContent-Typei wartościąapplication/json. - Musi zwrócić jeden z tych kodów odpowiedzi, aby potwierdzić otrzymanie powiadomienia.
102200201202204
Możesz używać tego samego adresu URI wywołania zwrotnego w przypadku wielu subskrypcji. Zalecamy używanie unikalnego identyfikatora URI wywołania zwrotnego dla każdego konta zaawansowanego i każdego typu zdarzenia, aby zminimalizować obciążenie żądań push wysyłanych do jednego identyfikatora URI.
Oto przykładowa prośba o subskrypcję powiadomień o zmianach stanu produktu na określonym koncie sprzedawcy.
POST https://merchantapi.googleapis.com/notifications/v1/accounts/ACCOUNT_ID/notificationsubscriptions/
{
"registeredEvent": "PRODUCT_STATUS_CHANGE",
"targetAccount": "accounts/TARGETACCOUNT_ID",
"callBackUri": "https://example.com"
}
Zastąp następujące elementy:
- ACCOUNT_ID: unikalny identyfikator konta, na które mają być wysyłane powiadomienia.
- TARGETACCOUNT_ID: unikalny identyfikator konta, o którym chcesz otrzymywać powiadomienia.
Jeśli Twoje konto Merchant Center jest kontem samodzielnym bez połączonych kont i chcesz otrzymywać powiadomienia dotyczące własnego konta, zastąp obie te zmienne identyfikatorem konta.
Wywołania zakończone powodzeniem zwracają obiekt name dla Twojej subskrypcji, w tym identyfikator subskrypcji:
{
"name":"accounts/ACCOUNT_ID/notificationsubscriptions/subscriptionId",
"registeredEvent": "PRODUCT_STATUS_CHANGE",
"targetAccount": "accounts/TARGETACCOUNT_ID",
"callBackUri": "https://example.com"
}
Możesz użyć tego name, aby GET i DELETE poszczególne subskrypcje.
Możesz subskrybować powiadomienia o zmianach stanu usługi na wszystkich połączonych kontach, dodając w żądaniu znak "allManagedAccounts": true zamiast targetAccount:
POST https://merchantapi.googleapis.com/notifications/v1/accounts/ACCOUNT_ID/notificationsubscriptions/
{
"registeredEvent": "PRODUCT_STATUS_CHANGE",
"allManagedAccounts": true,
"callBackUri": "https://example.com"
}
Aby zaktualizować istniejącą subskrypcję, użyj metody PATCH z parametrem update_mask, aby określić pola, które chcesz zaktualizować, oraz nowe wartości w treści JSON:
PATCH https://merchantapi.googleapis.com/notifications/v1/accounts/ACCOUNT_ID/notificationsubscriptions/SUBSCRIPTION_ID?update_mask=callBackUri
{
"callBackUri": "https://my-own-personal-domain.com"
}
Dekodowanie powiadomień
Po utworzeniu subskrypcji będziesz otrzymywać powiadomienia w określonym formacie na adres callBackUri:
{"message":{"data":"{base64_encoded_string}"}}
Dane powiadomienia są zakodowane. Możesz zdekodować dane do czytelnego formatu tekstowego, aby użyć ich w implementacji. Oto przykładowy kontroler Spring Boot, którego możesz użyć do przetwarzania zakodowanych danych:
@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
}
}
Oto przykład zdekodowanego parametru base64_encoded_string:
{
"account": "accounts/TARGETACCOUNT_ID",
"managingAccount": "accounts/ACCOUNT_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/TARGETACCOUNT_ID/products/ONLINE~en~US~1234",
"expirationTime": "2024-10-22T02:43:47.461464Z",
"eventTime": "2024-03-21T02:43:47.461464Z"
}
Jeśli w powiadomieniu nie ma pola oldValue, oznacza to, że na Twoje konto dodano nowy produkt. Jeśli nie ma pola newValue, produkt został usunięty z Twojego konta.
Pole expirationTime nie będzie istniało, jeśli produkt został usunięty.
Pole reportingContext obsługuje tylko wartości (SHOPPING_ADS, LOCAL_INVENTORY_ADS, YOUTUBE_SHOPPING, YOUTUBE_CHECKOUT, YOUTUBE_AFFILIATE) z wartości wyliczeniowej ReportingContextEnum.
W przypadku zdarzenia zmiany stanu produktu pola oldValue i newValue będą miały jedną z tych wartości : (approved, pending, disapproved, ``).
Pole eventTime zawiera czas utworzenia samego zdarzenia. Jeśli chcesz uporządkować wiadomości, używaj wartości w tym polu, a nie kolejności otrzymywania wiadomości.
Więcej informacji znajdziesz w formacie ProductStatusChangeMessage.
Testowanie implementacji
Oto przykładowe powiadomienie, którego możesz użyć do przetestowania identyfikatora URI wywołania zwrotnego i dekodowania:
curl --header "Content-Type: application/json" --header "Accept: text/plain" --request POST --data '{"message":{"data":
"ewogICJhY2NvdW50IjogImFjY291bnRzLzEyMzQiLAogICJtYW5hZ2luZ0FjY291bnQiOiAiYWNjb3VudHMvNTY3OCIsCiAgInJlc291cmNlVHlwZSI6ICJQUk9EVUNUIiwKICAiYXR0cmlidXRlIjogIlNUQVRVUyIsCiAgImNoYW5nZXMiOiBbewogICAgIm9sZFZhbHVlIjogImFwcHJvdmVkIiwKICAgICJyZWdpb25Db2RlIjogIlVTIiwKICAgICJyZXBvcnRpbmdDb250ZXh0IjogIlNIT1BQSU5HX0FEUyIKICB9XSwKICAicmVzb3VyY2VJZCI6ICJPTkxJTkV+ZW5+VVN+MDAwMDAwMDAwMDAwIiwKICAicmVzb3VyY2UiOiAiYWNjb3VudHMvMTIzNC9wcm9kdWN0cy9PTkxJTkV+ZW5+VVN+MDAwMDAwMDAwMDAwIiwKICAiZXhwaXJhdGlvblRpbWUiOiAiMjAyNC0xMC0yMlQwMjo0Mzo0Ny40NjE0NjRaIiwKICAiZXZlbnRUaW1lIjogIjIwMjQtMDMtMjFUMDI6NDM6NDcuNDYxNDY0WiIKfQ=="}}' https://{callBackUri}
W odpowiedzi na to wywołanie identyfikator URI wywołania zwrotnego powinien zwrócić kod odpowiedzi oznaczający powodzenie. Odszyfrowana wiadomość powinna mieć taką wartość:
{
"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"
}