Package google.shopping.merchant.notifications.v1beta

索引

NotificationsApiService

販売者向けの通知の登録を管理するサービス

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription)

販売者向けの通知サブスクリプションを作成します。次の種類の通知の登録を同時に使用できるようになりました（イベントの種類ごとに販売者ごとに登録者ごとに登録します）。1. すべての子アカウントのサブスクリプション + 自分自身のサブスクリプション 2. 管理対象アカウントの複数の「部分的」な定期購入 + 自分自身の定期購入

次のものは許可されません（販売者ごと、イベントの種類ごとに登録者）。1. 複数の自己登録。2. 複数の「すべての子アカウント」のサブスクリプション3. すべての定期購入と部分的な定期購入を同時にご利用いただけます。4. 同じ移行先アカウントに対する複数の部分的な定期購入

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/content

詳細については、OAuth 2.0 の概要をご覧ください。
DeleteNotificationSubscription

rpc DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest) returns (Empty)

販売者の通知サブスクリプションを削除します。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/content

詳細については、OAuth 2.0 の概要をご覧ください。
GetNotificationSubscription

rpc GetNotificationSubscription(GetNotificationSubscriptionRequest) returns (NotificationSubscription)

アカウントの通知の登録を取得します。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/content

詳細については、OAuth 2.0 の概要をご覧ください。
ListNotificationSubscriptions

rpc ListNotificationSubscriptions(ListNotificationSubscriptionsRequest) returns (ListNotificationSubscriptionsResponse)

販売者のすべての通知登録を取得します。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/content

詳細については、OAuth 2.0 の概要をご覧ください。
UpdateNotificationSubscription

rpc UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest) returns (NotificationSubscription)

販売者の既存の通知登録を更新します。

承認スコープ

次の OAuth スコープが必要です。

  • https://www.googleapis.com/auth/content

詳細については、OAuth 2.0 の概要をご覧ください。

属性

変更される、販売者に通知するリソースの属性を指定する列挙型。

列挙型
ATTRIBUTE_UNSPECIFIED 属性が指定されていません
STATUS 変更されたエンティティのステータス

CreateNotificationSubscriptionRequest

CreateNotificationSubscription メソッドに対するリクエスト メッセージ。

フィールド
parent

string

必須。新しい通知のサブスクリプションを所有する販売アカウント。形式: accounts/{account}
notification_subscription

NotificationSubscription

必須。作成する通知サブスクリプション。

DeleteNotificationSubscriptionRequest

DeleteNotificationSubscription メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。削除する通知サブスクリプションの名前。

GetNotificationSubscriptionRequest

GetNotificationSubscription メソッドに対するリクエスト メッセージ。

フィールド
name

string

必須。通知サブスクリプションの name。

ListNotificationSubscriptionsRequest

ListNotificationSubscription メソッドに対するリクエスト メッセージ。

フィールド
parent

string

必須。通知の定期購入を所有する販売アカウント。形式: accounts/{account}
page_size

int32

ページで返される通知登録の最大数。page_size のデフォルト値は 100 です。最大値は 200 です。200 を超える値は 200 に強制変換されます。
page_token

string

次のページを取得するためのトークン（指定されている場合）。他のすべてのパラメータは、ページトークンを提供した元の呼び出しと一致する必要があります。

ListNotificationSubscriptionsResponse

ListNotificationSubscription メソッドに対するレスポンス メッセージ。

フィールド
notification_subscriptions[]

NotificationSubscription

販売者がリクエストした通知の登録のリスト。
next_page_token

string

次のページを取得するために page_token として送信できるトークン。このフィールドを省略すると、後続のページはなくなります。

NotificationSubscription

販売アカウントが所有する通知サブスクリプションを表します。

フィールド
name

string

出力のみ。通知構成の name。新しい NotificationSubscription の作成時に Content API によって生成されます。account は、構成を所有する販売者の販売者 ID を表します。形式: accounts/{account}/notificationsubscriptions/{notification_subscription}
registered_event

NotificationEventType

販売者が通知を受け取るイベント。
call_back_uri

string

販売者に通知をプッシュする際に使用する URL。

共用体フィールド interested_in。

interested_in は次のいずれかになります。
all_managed_accounts

bool

この値が true の場合、新しく追加されたアカウントを含むすべての管理対象アカウント（サブアカウントまたは他のリンクされたアカウント）について、指定したイベントがリクエスト アカウントに毎日通知されます。
target_account

string

通知を受け取るアカウントの name。形式: accounts/{account}

NotificationEventType

販売者が通知を受け取るイベントタイプを表します。

列挙型
NOTIFICATION_EVENT_TYPE_UNSPECIFIED 通知イベントタイプが指定されていません。
PRODUCT_STATUS_CHANGE 商品のステータスの変更通知（商品が不承認になった場合など）。

ProductChange

商品に加えられた変更（以前の値、新しい値、地域コードとしての国コード、レポートのコンテキストを含む）。

フィールド
old_value

string

変更されたリソースまたは属性の古い値。
new_value

string

変更されたリソースまたは属性の新しい値。
region_code

string

変更が適用される国（該当する場合）
reporting_context

ReportingContextEnum

変更があったレポートのコンテキスト（該当する場合）

ProductStatusChangeMessage

商品のステータス変更イベントについて通知するために販売者が受信するメッセージ

フィールド
changes[]

ProductChange

商品に加えられた変更を説明するメッセージ
account

string

変更されたエンティティを所有する移行先アカウント。形式 : accounts/{merchant_id}
managing_account

string

販売者のアカウントを管理するアカウント。独立したアカウントの場合は、販売者 ID と同じでもかまいません。形式 : accounts/{service_provider_id}
resource_type

Resource

変更されたリソース。この場合、常に Product になります。
attribute

Attribute

変更されたリソースの属性。この場合、常に Status になります。
resource_id

string

商品 ID。
resource

string

商品名。形式: {product.name=accounts/{account}/products/{product}}

リソース

販売者に通知する変更の対象リソースを指定する列挙型。

列挙型
RESOURCE_UNSPECIFIED リソースの指定なし
PRODUCT リソースの種類 : product

UpdateNotificationSubscriptionRequest

UpdateNotificationSubscription メソッドに対するリクエスト メッセージ。

フィールド
notification_subscription

NotificationSubscription

必須。更新する必要がある通知サブスクリプションの新しいバージョン。
update_mask

FieldMask

更新するフィールドのリスト。