notifications

package
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 1, 2024 License: Apache-2.0 Imports: 21 Imported by: 0

Documentation

Overview

Package notifications is an auto-generated package for the Merchant API.

Programmatically manage your Merchant Center accounts. 

NOTE: This package is in beta. It is not stable, and may be subject to changes.

General documentation

For information that is relevant for all client libraries please reference https://pkg.golang.ir/cloud.google.com/go#pkg-overview. Some information on this page includes:

Example usage

To get started with this package, create a client. 

ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
//   https://pkg.golang.ir/cloud.google.com/go#hdr-Client_Options
c, err := notifications.NewNotificationsApiClient(ctx)
if err != nil {
	// TODO: Handle error.
}
defer c.Close()

The client will use your default application credentials. Clients should be reused instead of created as needed. The methods of Client are safe for concurrent use by multiple goroutines. The returned client must be Closed when it is done being used.

Using the Client

The following is an example of making an API call with the newly created client. 

ctx := context.Background()
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in:
//   https://pkg.golang.ir/cloud.google.com/go#hdr-Client_Options
c, err := notifications.NewNotificationsApiClient(ctx)
if err != nil {
	// TODO: Handle error.
}
defer c.Close()

req := &notificationspb.CreateNotificationSubscriptionRequest{
	// TODO: Fill request struct fields.
	// See https://pkg.golang.ir/cloud.google.com/go/shopping/merchant/notifications/apiv1beta/notificationspb#CreateNotificationSubscriptionRequest.
}
resp, err := c.CreateNotificationSubscription(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Use of Context

The ctx passed to NewNotificationsApiClient is used for authentication requests and for creating the underlying connection, but is not used for subsequent calls. Individual methods on the client use the ctx given to them.

To close the open connection, use the Close() method.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultAuthScopes 

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

Types

type NotificationSubscriptionIterator 

type NotificationSubscriptionIterator struct {

	// Response is the raw response for the current page.
	// It must be cast to the RPC response type.
	// Calling Next() or InternalFetch() updates this value.
	Response interface{}

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*notificationspb.NotificationSubscription, nextPageToken string, err error)
	// contains filtered or unexported fields
}

NotificationSubscriptionIterator manages a stream of *notificationspb.NotificationSubscription.

func (*NotificationSubscriptionIterator) Next 

func (it *NotificationSubscriptionIterator) Next() (*notificationspb.NotificationSubscription, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*NotificationSubscriptionIterator) PageInfo 

func (it *NotificationSubscriptionIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type NotificationsApiCallOptions 

type NotificationsApiCallOptions struct {
	GetNotificationSubscription    []gax.CallOption
	CreateNotificationSubscription []gax.CallOption
	UpdateNotificationSubscription []gax.CallOption
	DeleteNotificationSubscription []gax.CallOption
	ListNotificationSubscriptions  []gax.CallOption
}

NotificationsApiCallOptions contains the retry settings for each method of NotificationsApiClient.

type NotificationsApiClient 

type NotificationsApiClient struct {

	// The call options for this service.
	CallOptions *NotificationsApiCallOptions
	// contains filtered or unexported fields
}

NotificationsApiClient is a client for interacting with Merchant API. Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

Service to manage notification subscriptions for merchants

func NewNotificationsApiClient 

func NewNotificationsApiClient(ctx context.Context, opts ...option.ClientOption) (*NotificationsApiClient, error)

NewNotificationsApiClient creates a new notifications api service client based on gRPC. The returned client must be Closed when it is done being used to clean up its underlying connections.

Service to manage notification subscriptions for merchants

Example 
package main

import (
	"context"

	notifications "cloud.google.com/go/shopping/merchant/notifications/apiv1beta"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.golang.ir/cloud.google.com/go#hdr-Client_Options
	c, err := notifications.NewNotificationsApiClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

Output:

func NewNotificationsApiRESTClient 

func NewNotificationsApiRESTClient(ctx context.Context, opts ...option.ClientOption) (*NotificationsApiClient, error)

NewNotificationsApiRESTClient creates a new notifications api service rest client.

Service to manage notification subscriptions for merchants

Example 
package main

import (
	"context"

	notifications "cloud.google.com/go/shopping/merchant/notifications/apiv1beta"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.golang.ir/cloud.google.com/go#hdr-Client_Options
	c, err := notifications.NewNotificationsApiRESTClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

Output:

func (*NotificationsApiClient) Close 

func (c *NotificationsApiClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*NotificationsApiClient) Connection deprecated 

func (c *NotificationsApiClient) Connection() *grpc.ClientConn

Connection returns a connection to the API service.

Deprecated: Connections are now pooled so this method does not always return the same resource.

func (*NotificationsApiClient) CreateNotificationSubscription 

func (c *NotificationsApiClient) CreateNotificationSubscription(ctx context.Context, req *notificationspb.CreateNotificationSubscriptionRequest, opts ...gax.CallOption) (*notificationspb.NotificationSubscription, error)

CreateNotificationSubscription creates a notification subscription for a merchant. We will allow the following types of notification subscriptions to exist together (per merchant as a subscriber per event type):

Subscription for all managed accounts + subscription for self

Multiple “partial” subscriptions for managed accounts + subscription for self

we will not allow (per merchant as a subscriber per event type):

multiple self subscriptions.

multiple “all managed accounts” subscriptions.

all and partial subscriptions at the same time.

multiple partial subscriptions for the same target account

Example 
package main

import (
	"context"

	notifications "cloud.google.com/go/shopping/merchant/notifications/apiv1beta"
	notificationspb "cloud.google.com/go/shopping/merchant/notifications/apiv1beta/notificationspb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.golang.ir/cloud.google.com/go#hdr-Client_Options
	c, err := notifications.NewNotificationsApiClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &notificationspb.CreateNotificationSubscriptionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.golang.ir/cloud.google.com/go/shopping/merchant/notifications/apiv1beta/notificationspb#CreateNotificationSubscriptionRequest.
	}
	resp, err := c.CreateNotificationSubscription(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Output:

func (*NotificationsApiClient) DeleteNotificationSubscription 

func (c *NotificationsApiClient) DeleteNotificationSubscription(ctx context.Context, req *notificationspb.DeleteNotificationSubscriptionRequest, opts ...gax.CallOption) error

DeleteNotificationSubscription deletes a notification subscription for a merchant.

Example 
package main

import (
	"context"

	notifications "cloud.google.com/go/shopping/merchant/notifications/apiv1beta"
	notificationspb "cloud.google.com/go/shopping/merchant/notifications/apiv1beta/notificationspb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.golang.ir/cloud.google.com/go#hdr-Client_Options
	c, err := notifications.NewNotificationsApiClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &notificationspb.DeleteNotificationSubscriptionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.golang.ir/cloud.google.com/go/shopping/merchant/notifications/apiv1beta/notificationspb#DeleteNotificationSubscriptionRequest.
	}
	err = c.DeleteNotificationSubscription(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

Output:

func (*NotificationsApiClient) GetNotificationSubscription 

func (c *NotificationsApiClient) GetNotificationSubscription(ctx context.Context, req *notificationspb.GetNotificationSubscriptionRequest, opts ...gax.CallOption) (*notificationspb.NotificationSubscription, error)

GetNotificationSubscription gets notification subscriptions for an account.

Example 
package main

import (
	"context"

	notifications "cloud.google.com/go/shopping/merchant/notifications/apiv1beta"
	notificationspb "cloud.google.com/go/shopping/merchant/notifications/apiv1beta/notificationspb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.golang.ir/cloud.google.com/go#hdr-Client_Options
	c, err := notifications.NewNotificationsApiClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &notificationspb.GetNotificationSubscriptionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.golang.ir/cloud.google.com/go/shopping/merchant/notifications/apiv1beta/notificationspb#GetNotificationSubscriptionRequest.
	}
	resp, err := c.GetNotificationSubscription(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Output:

func (*NotificationsApiClient) ListNotificationSubscriptions 

func (c *NotificationsApiClient) ListNotificationSubscriptions(ctx context.Context, req *notificationspb.ListNotificationSubscriptionsRequest, opts ...gax.CallOption) *NotificationSubscriptionIterator

ListNotificationSubscriptions gets all the notification subscriptions for a merchant.

Example 
package main

import (
	"context"

	notifications "cloud.google.com/go/shopping/merchant/notifications/apiv1beta"
	notificationspb "cloud.google.com/go/shopping/merchant/notifications/apiv1beta/notificationspb"
	"google.golang.org/api/iterator"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.golang.ir/cloud.google.com/go#hdr-Client_Options
	c, err := notifications.NewNotificationsApiClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &notificationspb.ListNotificationSubscriptionsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.golang.ir/cloud.google.com/go/shopping/merchant/notifications/apiv1beta/notificationspb#ListNotificationSubscriptionsRequest.
	}
	it := c.ListNotificationSubscriptions(ctx, req)
	for {
		resp, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp

		// If you need to access the underlying RPC response,
		// you can do so by casting the `Response` as below.
		// Otherwise, remove this line. Only populated after
		// first call to Next(). Not safe for concurrent access.
		_ = it.Response.(*notificationspb.ListNotificationSubscriptionsResponse)
	}
}

Output:

func (*NotificationsApiClient) UpdateNotificationSubscription 

func (c *NotificationsApiClient) UpdateNotificationSubscription(ctx context.Context, req *notificationspb.UpdateNotificationSubscriptionRequest, opts ...gax.CallOption) (*notificationspb.NotificationSubscription, error)

UpdateNotificationSubscription updates an existing notification subscription for a merchant.

Example 
package main

import (
	"context"

	notifications "cloud.google.com/go/shopping/merchant/notifications/apiv1beta"
	notificationspb "cloud.google.com/go/shopping/merchant/notifications/apiv1beta/notificationspb"
)

func main() {
	ctx := context.Background()
	// This snippet has been automatically generated and should be regarded as a code template only.
	// It will require modifications to work:
	// - It may require correct/in-range values for request initialization.
	// - It may require specifying regional endpoints when creating the service client as shown in:
	//   https://pkg.golang.ir/cloud.google.com/go#hdr-Client_Options
	c, err := notifications.NewNotificationsApiClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &notificationspb.UpdateNotificationSubscriptionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.golang.ir/cloud.google.com/go/shopping/merchant/notifications/apiv1beta/notificationspb#UpdateNotificationSubscriptionRequest.
	}
	resp, err := c.UpdateNotificationSubscription(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

Output:

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.