Package google.shopping.merchant.notifications.v1beta

색인

NotificationsApiService

판매자의 알림 구독을 관리하는 서비스

CreateNotificationSubscription

rpc CreateNotificationSubscription(CreateNotificationSubscriptionRequest) returns (NotificationSubscription)

비즈니스의 알림 구독을 만듭니다. 독립형 또는 하위 계정 계정의 경우 비즈니스에서 자체 구독을 만들 수 있습니다. MCA의 경우 비즈니스에서 모든 관리 계정 또는 특정 하위 계정에 대한 구독을 만들 수 있습니다.

다음 유형의 알림 구독이 함께 존재할 수 있습니다 (비즈니스별로 이벤트 유형별 구독자).

  1. 모든 관리 계정의 구독 + 본인 구독

  2. 관리 계정에 대한 여러 개의 '부분' 구독 + 본인 구독

다음은 허용되지 않습니다 (이벤트 유형별 구독자별 비즈니스 기준):

  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

페이지에서 반환할 최대 알림 구독 수입니다. 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

업데이트되는 필드 목록입니다.