Merchant Notifications API を使用して、変更のプッシュ通知を受け取ることができます。 関連付けられていますたとえば 商品ステータスの変更や 通知機能を利用すれば、商品が不承認となったときにリアルタイムで通知を受け取ることができます。 スペースでは、 サブアカウント、またはその他のリンクされたアカウント できます。
このガイドでは、商品ステータスの通知を管理する方法の例を紹介します
できます。これらの例を使って、Google Chat で設定された他の
リクエストの registeredEvent
フィールドの値を変更する。完全な
Merchant Notifications API をご覧ください。
参照をご覧ください。
登録
通知を受け取るには、callBackUri
が必要です。コールバック URI は、
次の要件を満たす必要があります。
- 有効な SSL 証明書を持つ、一般公開されている HTTPS アドレスである必要があります。 証明書ファイルを作成できます。
Content-Type
ヘッダーを含む HTTPPOST
リクエストを受け入れる必要があります。application/json
の値。- 次のいずれかのレスポンス コードを返して、
通知を受け取る
102
200
201
202
204
複数のサブスクリプションで同じコールバック URI を使用できます。Google Cloud コンソールの 高度な構成ごとに固有のコールバック URI を イベントタイプごとに 単一の URI への push リクエストの負荷を最小限に抑える
商品ステータスの変更に関する通知に登録するリクエストの例を以下に示します
特定の販売アカウントについてのみ
確認できます対象のアカウントの販売者 ID を
通知をリクエスト 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"
}
既存のサブスクリプションを更新するには、update_mask
で PATCH
を使用して、
更新するフィールドと、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"
実装をテストする
コールバック 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"