Package google.shopping.merchant.notifications.v1beta

Indeks

NotificationsApiService

Usługa do zarządzania subskrypcjami powiadomień dla sprzedawców

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription)

Tworzy subskrypcję powiadomień dla firmy. W przypadku kont samodzielnych lub subkont firma może utworzyć subskrypcję dla siebie. W przypadku MCA firma może utworzyć subskrypcję dla wszystkich zarządzanych kont lub dla konkretnego subkonta.

Umożliwimy istnienie następujących typów subskrypcji powiadomień (na firmę jako subskrybenta na typ zdarzenia):

  1. Subskrypcja wszystkich zarządzanych kont + subskrypcja własnego konta.

  2. Wiele „częściowych” subskrypcji dla zarządzanych kont oraz subskrypcja dla siebie.

nie zezwalamy (na firmę jako subskrybenta na podstawie typu zdarzenia):

  1. wiele subskrypcji własnych.

  2. Wiele subskrypcji „wszystkie zarządzane konta”.

  3. subskrypcji „Wszystkie zarządzane konta” i subskrypcji częściowych w tym samym czasie.

  4. Wiele subskrypcji częściowych na tym samym koncie docelowym.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.
DeleteNotificationSubscription

rpc DeleteNotificationSubscription(DeleteNotificationSubscriptionRequest) returns (Empty)

Usuwa subskrypcję powiadomień dla sprzedawcy.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.
GetNotificationSubscription

rpc GetNotificationSubscription(GetNotificationSubscriptionRequest) returns (NotificationSubscription)

Pobiera subskrypcje powiadomień na koncie.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.
ListNotificationSubscriptions

rpc ListNotificationSubscriptions(ListNotificationSubscriptionsRequest) returns (ListNotificationSubscriptionsResponse)

Pobiera wszystkie subskrypcje powiadomień dla sprzedawcy.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.
UpdateNotificationSubscription

rpc UpdateNotificationSubscription(UpdateNotificationSubscriptionRequest) returns (NotificationSubscription)

Aktualizuje istniejącą subskrypcję powiadomień dla sprzedawcy.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w OAuth 2.0 Overview.

Atrybut

Wybrany element listy do określenia atrybutu zasobu, który ulega zmianie, aby powiadomić sprzedawcę.

Wartości w polu enum
ATTRIBUTE_UNSPECIFIED Atrybut nieokreślony
STATUS Stan zmienionego elementu

CreateNotificationSubscriptionRequest

Żądanie wiadomości dla metody CreateNotificationSubscription.

Pola
parent

string

Wymagane. Konto sprzedawcy, które jest właścicielem nowej subskrypcji powiadomień. Format: accounts/{account}
notification_subscription

NotificationSubscription

Wymagane. Subskrypcja powiadomień do utworzenia.

DeleteNotificationSubscriptionRequest

Komunikat o żądaniu dla metody DeleteNotificationSubscription.

Pola
name

string

Wymagane. Nazwa subskrypcji powiadomień, którą chcesz usunąć.

GetNotificationSubscriptionRequest

Komunikat żądania dla metody GetNotificationSubscription.

Pola
name

string

Wymagane. name subskrypcji powiadomienia.

ListNotificationSubscriptionsRequest

Żądanie wiadomości dla metody ListNotificationSubscription.

Pola
parent

string

Wymagane. Konto sprzedawcy, które jest właścicielem subskrypcji powiadomień. Format: accounts/{account}
page_size

int32

Maksymalna liczba subskrypcji powiadomień do zwrócenia na stronie. Wartością domyślną dla page_size jest 100. Maksymalna wartość to 200. Wartości powyżej 200 zostaną skonwertowane na 200.
page_token

string

token (jeśli został podany) do pobrania kolejnej strony. Wszystkie pozostałe parametry muszą być zgodne z pierwotnym wywołaniem, które dostarczyło token strony.

ListNotificationSubscriptionsResponse

wiadomość odpowiedzi dla metody ListNotificationSubscription;

Pola
notification_subscriptions[]

NotificationSubscription

Lista subskrypcji powiadomień, o które poprosił sprzedawca.
next_page_token

string

token, który może być wysyłany jako page_token w celu pobrania następnej strony. Jeśli pominiesz to pole, nie będzie kolejnych stron.

NotificationSubscription

Reprezentuje subskrypcję powiadomień należącą do konta sprzedawcy.

Pola
name

string

Tylko dane wyjściowe. name konfiguracji powiadomienia. Generowany przez Content API po utworzeniu nowej NotificationSubscription. Wartość account to identyfikator sprzedawcy, który jest właścicielem konfiguracji. Format: accounts/{account}/notificationsubscriptions/{notification_subscription}
registered_event

NotificationEventType

Zdarzenie, o którym sprzedawca chce otrzymywać powiadomienia.
call_back_uri

string

Adres URL, który ma być użyty do wysłania powiadomienia do sprzedawcy.

Pole unii interested_in.

interested_in może być tylko jednym z tych elementów:
all_managed_accounts

bool

Jeśli ta wartość jest ustawiona na „PRAWDA”, konto wysyłające żądanie otrzymuje codziennie powiadomienie o wybranym zdarzeniu na wszystkich zarządzanych kontach (mogą to być podrzędne konta lub inne połączone konta), w tym na nowo dodanych kontach.
target_account

string

name konta, o którym chcesz otrzymywać powiadomienia. Format: accounts/{account}

NotificationEventType

Reprezentuje typ zdarzenia, o którym sprzedawca chce otrzymywać powiadomienia.

Wartości w polu enum
NOTIFICATION_EVENT_TYPE_UNSPECIFIED Typ zdarzenia powiadomienia jest nieokreślony.
PRODUCT_STATUS_CHANGE powiadomienia o zmianach stanu produktu, np. gdy produkt zostanie odrzucony;

ProductChange

Zmiana, która nastąpiła w przypadku produktu, w tym jego stara i nowa wartość, kod kraju jako kod regionu i kontekst raportowania.

Pola
old_value

string

Stara wartość zmienionego zasobu lub atrybutu.
new_value

string

Nowa wartość zmienionego zasobu lub atrybutu.
region_code

string

Kraje, w których wprowadzono zmianę (w stosownych przypadkach)
reporting_context

ReportingContextEnum

Konteksty raportowania, w których wprowadzono zmianę (w stosownych przypadkach)

ProductStatusChangeMessage

Wiadomość, którą sprzedawca otrzyma, aby powiadomić o zmianie stanu produktu

Pola
changes[]

ProductChange

wiadomość opisująca zmianę wprowadzoną w produkcie;
account

string

Docelowe konto, które jest właścicielem zmienionego elementu. Format : accounts/{merchant_id}
managing_account

string

Konto, które zarządza kontem sprzedawcy. Może być takie samo jak identyfikator sprzedawcy, jeśli jest to konto samodzielne. Format : accounts/{service_provider_id}
resource_type

Resource

Zasób, który się zmienił. W tym przypadku będzie to zawsze Product.
attribute

Attribute

Atrybut zasobu, który się zmienił. W tym przypadku będzie to zawsze Status.
resource_id

string

Identyfikator produktu.
resource

string

Nazwa produktu. Format: {product.name=accounts/{account}/products/{product}}
expiration_time

Timestamp

Czas ważności produktu. To pole nie będzie ustawione, jeśli powiadomienie jest wysyłane w związku ze zdarzeniem usunięcia produktu.

Zasób

Enum do określenia zasobu, który jest zmieniany, aby powiadomić o tym sprzedawcę.

Wartości w polu enum
RESOURCE_UNSPECIFIED Nieokreślony zasób
PRODUCT Typ zasobu : produkt

UpdateNotificationSubscriptionRequest

Wiadomość z prośbą o zaktualizowanie metody UpdateNotificationSubscription.

Pola
notification_subscription

NotificationSubscription

Wymagane. Nowa wersja subskrypcji powiadomień, która powinna zostać zaktualizowana.
update_mask

FieldMask

Lista pól, które są aktualizowane.