Reference documentation and code samples for the Google Shopping Merchant Notifications V1beta Client class NotificationSubscription.
Represents a notification subscription owned by a Merchant account.
Generated from protobuf message google.shopping.merchant.notifications.v1beta.NotificationSubscription
Namespace
Google \ Shopping \ Merchant \ Notifications \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ all_managed_accounts |
bool
If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis. |
↳ target_account |
string
The |
↳ name |
string
Output only. The |
↳ registered_event |
int
The event that the merchant wants to be notified about. |
↳ call_back_uri |
string
URL to be used to push the notification to the merchant. |
getAllManagedAccounts
If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis.
| Returns | |
|---|---|
| Type | Description |
bool |
|
hasAllManagedAccounts
setAllManagedAccounts
If this value is true, the requesting account is notified of the specified event for all managed accounts (can be subaccounts or other linked accounts) including newly added accounts on a daily basis.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTargetAccount
The name of the account you want to receive notifications for.
Format: accounts/{account}
| Returns | |
|---|---|
| Type | Description |
string |
|
hasTargetAccount
setTargetAccount
The name of the account you want to receive notifications for.
Format: accounts/{account}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
Output only. The name of the notification configuration. Generated by the
Content API upon creation of a new NotificationSubscription. The
account represents the merchant ID of the merchant that owns the
configuration. Format:
accounts/{account}/notificationsubscriptions/{notification_subscription}
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Output only. The name of the notification configuration. Generated by the
Content API upon creation of a new NotificationSubscription. The
account represents the merchant ID of the merchant that owns the
configuration. Format:
accounts/{account}/notificationsubscriptions/{notification_subscription}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRegisteredEvent
The event that the merchant wants to be notified about.
| Returns | |
|---|---|
| Type | Description |
int |
|
setRegisteredEvent
The event that the merchant wants to be notified about.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCallBackUri
URL to be used to push the notification to the merchant.
| Returns | |
|---|---|
| Type | Description |
string |
|
setCallBackUri
URL to be used to push the notification to the merchant.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInterestedIn
| Returns | |
|---|---|
| Type | Description |
string |
|