Package google.shopping.merchant.notifications.v1beta

インデックス

NotificationsApiService

販売者の通知サブスクリプションを管理するサービス

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription)

ビジネスの通知サブスクリプションを作成します。スタンドアロン アカウントまたはサブアカウントの場合は、ビジネスが自身でサブスクリプションを作成できます。MCA の場合、ビジネスは、すべての管理対象アカウントまたは特定のサブアカウントのサブスクリプションを作成できます。

次の種類の通知サブスクリプションを同時に存在させることができます（イベントタイプごとにサブスクライバーとしてビジネスごとに）。

  1. 管理対象のすべてのアカウントのサブスクリプションと、自分のサブスクリプション。

  2. 管理対象アカウントの複数の「部分的な」定期購入と、自分自身の定期購入。

次のような行為は許可されません（イベントタイプごとに 1 つのビジネスが定期購読者として）。

  1. 複数の自己登録。

  2. 複数の「すべての管理対象アカウント」の定期購入。

  3. 「すべての管理対象アカウント」のサブスクリプションと部分的なサブスクリプションを同時に購入する。

  4. 同じターゲット アカウントに対する複数の部分サブスクリプション。

認可スコープ

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

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

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

rpc DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest) returns (Empty)

販売者の通知の定期購入を削除します。

認可スコープ

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

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

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

rpc GetNotificationSubscription(GetNotificationSubscriptionRequest) returns (NotificationSubscription)

アカウントの通知サブスクリプションを取得します。

認可スコープ

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

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

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

rpc ListNotificationSubscriptions(ListNotificationSubscriptionsRequest) returns (ListNotificationSubscriptionsResponse)

販売者のすべての通知サブスクリプションを取得します。

認可スコープ

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

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

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

rpc UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest) returns (NotificationSubscription)

販売者の既存の通知サブスクリプションを更新します。

認可スコープ

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

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

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

属性

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

列挙型
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

1 ページで返される通知サブスクリプションの最大数。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}}
expiration_time

Timestamp

商品の有効期限。商品の削除イベントに対して通知が送信された場合、このフィールドは設定されません。

リソース

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

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

UpdateNotificationSubscriptionRequest

UpdateNotificationSubscription メソッドのリクエスト メッセージ。

フィールド
notification_subscription

NotificationSubscription

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

FieldMask

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