Package google.shopping.merchant.notifications.v1beta

Индекс

УведомленияApiService

Сервис для управления подписками на уведомления для продавцов

Создать подписку на уведомление

rpc CreateNotificationSubscription( CreateNotificationSubscriptionRequest ) returns ( NotificationSubscription )

Создает подписку на уведомления для бизнеса. Для отдельных учетных записей или дополнительных учетных записей компания может создать подписку для себя. Для MCA компания может создать подписку для всех управляемых учетных записей или для определенной дополнительной учетной записи.

Мы разрешим совместное существование следующих типов подписок на уведомления (для каждой компании как подписчика для каждого типа событий):

  1. Подписка на все управляемые аккаунты + подписка на себя.

  2. Несколько «частичных» подписок для управляемых аккаунтов + подписка для себя.

мы не разрешим (для каждой компании в качестве подписчика для каждого типа события):

  1. Несколько самостоятельных подписок.

  2. Несколько подписок «все управляемые учетные записи».

  3. Подписка «Все управляемые аккаунты» и частичные подписки одновременно.

  4. Несколько частичных подписок для одной целевой учетной записи.

Области авторизации

Требуется следующая область действия OAuth:

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

Для получения дополнительной информации см.OAuth 2.0 Overview .

Удалить подписку на уведомление

rpc DeleteNotificationSubscription( DeleteNotificationSubscriptionRequest ) returns ( Empty )

Удаляет подписку на уведомления для продавца.

Области авторизации

Требуется следующая область действия OAuth:

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

Для получения дополнительной информации см.OAuth 2.0 Overview .

Получить уведомление о подписке

rpc GetNotificationSubscription( GetNotificationSubscriptionRequest ) returns ( NotificationSubscription )

Получает подписки на уведомления для учетной записи.

Области авторизации

Требуется следующая область действия OAuth:

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

Для получения дополнительной информации см.OAuth 2.0 Overview .

Список уведомлений о подписках

rpc ListNotificationSubscriptions( ListNotificationSubscriptionsRequest ) returns ( ListNotificationSubscriptionsResponse )

Получает все подписки на уведомления для продавца.

Области авторизации

Требуется следующая область действия OAuth:

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

Для получения дополнительной информации см.OAuth 2.0 Overview .

Подписка на уведомление об обновлении

rpc UpdateNotificationSubscription( UpdateNotificationSubscriptionRequest ) returns ( NotificationSubscription )

Обновляет существующую подписку на уведомления для продавца.

Области авторизации

Требуется следующая область действия OAuth:

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

Для получения дополнительной информации см.OAuth 2.0 Overview .

Атрибут

Enum для указания атрибута в ресурсе, который изменяется, чтобы уведомить об этом продавца.

Перечисления
ATTRIBUTE_UNSPECIFIED Неопределенный атрибут
STATUS Статус измененной сущности

CreateNotificationSubscriptionRequest

Сообщение запроса для метода CreateNotificationSubscription.

Поля
parent

string

Необходимый. Учетная запись продавца, которому принадлежит новая подписка на уведомления. Формат: accounts/{account}

notification_ subscription

NotificationSubscription

Необходимый. Подписка на уведомления, которую необходимо создать.

Удалить уведомление о подписке

Сообщение запроса для метода DeleteNotificationSubscription.

Поля
name

string

Необходимый. Имя подписки на уведомления, которую необходимо удалить.

Получить уведомление о подписке

Сообщение запроса для метода GetNotificationSubscription.

Поля
name

string

Необходимый. name подписки на уведомления.

Список уведомлений о подпискахЗапрос

Сообщение запроса для метода 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 для получения следующей страницы. Если это поле опущено, последующие страницы отсутствуют.

УведомлениеПодписка

Представляет подписку на уведомления, принадлежащую учетной записи продавца.

Поля
name

string

Только вывод. name конфигурации уведомлений. Создается Content API при создании нового NotificationSubscription . account представляет собой идентификатор продавца, которому принадлежит конфигурация. Формат: accounts/{account}/notificationsubscriptions/{notification_subscription}

registered_ event

NotificationEventType

Событие, о котором продавец хочет получить уведомление.

call_ back_ uri

string

URL-адрес, который будет использоваться для отправки уведомления продавцу.

Поле объединения interested_in .

interested_in может быть только одним из следующих:

all_ managed_ accounts

bool

Если это значение истинно, запрашивающая учетная запись ежедневно уведомляется об указанном событии для всех управляемых учетных записей (это могут быть дочерние учетные записи или другие связанные учетные записи), включая вновь добавленные учетные записи.

target_ account

string

name учетной записи, для которой вы хотите получать уведомления. Формат: accounts/{account}

Тип уведомлениясобытия

Представляет тип события, уведомления о котором продавец хочет получать.

Перечисления
NOTIFICATION_EVENT_TYPE_UNSPECIFIED Тип события уведомлений не указан.
PRODUCT_STATUS_CHANGE Уведомление об изменении статуса продукта, например, когда продукт становится отклоненным.

Изменение продукта

Изменение, произошедшее с продуктом, включая старое значение, новое значение, код страны в качестве кода региона и контекст отчета.

Поля
old_ value

string

Старое значение измененного ресурса или атрибута.

new_ value

string

Новое значение измененного ресурса или атрибута.

region_ code

string

Страны, в которых произошли изменения (если применимо)

reporting_ context

ReportingContextEnum

Контексты отчетности, в которых произошли изменения (если применимо)

Статус продуктаИзменитьСообщение

Сообщение, которое получит продавец для уведомления о событии изменения статуса товара.

Поля
changes[]

ProductChange

Сообщение, описывающее изменение, произошедшее с продуктом.

account

string

Целевая учетная запись, которой принадлежит измененная сущность. Формат: accounts/{merchant_id}

managing_ account

string

Учетная запись, которая управляет учетной записью продавца. может совпадать с идентификатором продавца, если это отдельный аккаунт. Формат: accounts/{service_provider_id}

resource_ type

Resource

Измененный ресурс, в данном случае это всегда будет Product .

attribute

Attribute

Атрибут в ресурсе, который изменился, в данном случае это всегда будет Status .

resource_ id

string

Идентификатор продукта.

resource

string

Название продукта. Формат: {product.name=accounts/{account}/products/{product}}

expiration_ time

Timestamp

Срок годности продукта. Это поле не будет установлено, если уведомление будет отправлено об удалении продукта.

Ресурс

Перечисление, чтобы указать ресурс, который изменяется, о котором необходимо уведомить продавца.

Перечисления
RESOURCE_UNSPECIFIED Неуказанный ресурс
PRODUCT Тип ресурса: продукт

Запрос на подписку на уведомление об обновлении

Сообщение запроса для метода UpdateNotificationSubscription.

Поля
notification_ subscription

NotificationSubscription

Необходимый. Новая версия подписки на уведомления, которую необходимо обновить.

update_ mask

FieldMask

Список полей обновляется.