Merchant Notifications API를 사용하여 변경사항에 대한 푸시 알림을 받을 수 있습니다. 계정 데이터에 적용됩니다. 예를 들어 제품 상태 변경을 구독하는 경우 알림을 이용하면 제품이 비승인되었을 때 실시간으로 알림을 받을 수 있습니다. 알림을 구독하려면 하위 계정 또는 기타 연결된 계정 계정을 선택합니다.
이 가이드에서는 제품 상태에 대한 알림을 관리하는 방법의 예를 제공합니다.
있습니다. 이러한 예를 사용하여 다음을 기준으로 다른 이벤트의 알림을 관리할 수 있습니다.
요청의 registeredEvent
필드 값 변경 완전한
자세한 내용은 판매자 알림 API
참조
구독
알림을 받으려면 callBackUri
가 필요합니다. 콜백 URI는
다음 요구사항을 충족해야 합니다.
- 유효한 SSL 인증서가 있고 공개적으로 액세스할 수 있는 HTTPS 주소여야 합니다. 인증 기관에 의해 서명됨
Content-Type
헤더가 있는 HTTPPOST
요청을 수락해야 하며application/json
값입니다.- 다음 응답 코드 중 하나를 반환하여
알림을 받았습니다.
102
200
201
202
204
여러 구독에 동일한 콜백 URI를 사용할 수 있습니다. 이때 고급별 고유 콜백 URI를 이벤트 유형별로 단일 URI에 대한 푸시 요청의 부하를 최소화해야 합니다(SHOULD).
다음은 제품 상태 변경 알림 수신 요청 샘플입니다.
특정 판매자 계정에 적용됩니다 이
요청 URL에서 merchantId
로 알림을 수신합니다.
알림을 받을 계정의 판매자 ID입니다.
요청 본문에 targetMerchantId
를 포함합니다. 독립형 계정인 경우
연결된 계정이 없는 계정에서 알림을 받고 싶다고 가정해 보겠습니다.
두 경우 모두에서 판매자 ID를 사용해야 합니다.
POST https://merchantapi.googleapis.com/notifications/v1beta/accounts/merchantId/notificationsubscriptions/
{
"registeredEvent": "PRODUCT_STATUS_CHANGE",
"targetAccount": "accounts/targetMerchantId",
"callBackUri": "https://example.com"
}
호출이 성공하면
name
을(를) 위한
(구독 ID 포함):
{
"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}"}}
알림 데이터가 인코딩됩니다. 데이터를 읽을 수 있는 텍스트로 디코딩할 수 있습니다. 형식을 선택해야 합니다. 이것은 스프링 부트 컨트롤러 샘플입니다 사용할 수 있습니다.
@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"
알림에 old_value
필드가 없으면 새 제품이
이(가) 계정에 추가되었습니다. new_value
필드가 없으면 제품이 삭제된 것입니다.
삭제합니다.
reporting_context
필드는 열거형 값 ReportingContextEnum에서 (SHOPPING_ADS
, LOCAL_INVENTORY_ADS
, YOUTUBE_SHOPPING
)만 지원합니다.
구현 테스트
다음은 콜백 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"