Reference documentation and code samples for the Google Shopping Merchant Notifications V1 Client class NotificationSubscriptionHealthMetrics.
Represents a notification subscription health metrics.
Generated from protobuf message google.shopping.merchant.notifications.v1.NotificationSubscriptionHealthMetrics
Namespace
Google \ Shopping \ Merchant \ Notifications \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Output only. Identifier. 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. |
↳ acknowledged_messages_count |
int|string
The number of retained acknowledged messages for the last 24 hours |
↳ undelivered_messages_count |
int|string
The number of unacknowledged messages for the last 7 days, we will attempt to re-deliver the unacknowledged message later and once successfully delivered it will not be counted within unacknowledged messages (the number of unacknowledged messages should gradually decrease to zero once the issue is fixed). |
↳ oldest_unacknowledged_message_waiting_time |
int|string
The time since the oldest unacknowledged message was sent in seconds |
getName
Output only. Identifier. 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.
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Output only. Identifier. 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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAcknowledgedMessagesCount
The number of retained acknowledged messages for the last 24 hours
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setAcknowledgedMessagesCount
The number of retained acknowledged messages for the last 24 hours
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUndeliveredMessagesCount
The number of unacknowledged messages for the last 7 days, we will attempt to re-deliver the unacknowledged message later and once successfully delivered it will not be counted within unacknowledged messages (the number of unacknowledged messages should gradually decrease to zero once the issue is fixed).
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setUndeliveredMessagesCount
The number of unacknowledged messages for the last 7 days, we will attempt to re-deliver the unacknowledged message later and once successfully delivered it will not be counted within unacknowledged messages (the number of unacknowledged messages should gradually decrease to zero once the issue is fixed).
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOldestUnacknowledgedMessageWaitingTime
The time since the oldest unacknowledged message was sent in seconds
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setOldestUnacknowledgedMessageWaitingTime
The time since the oldest unacknowledged message was sent in seconds
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|