Merchant API v1beta - Package cloud.google.com/go/shopping/merchant/promotions/apiv1beta (v0.9.0)

Package promotions 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.go.dev/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.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := promotions.NewClient(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.go.dev/cloud.google.com/go#hdr-Client_Options
c, err := promotions.NewClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &promotionspb.GetPromotionRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/shopping/merchant/promotions/apiv1beta/promotionspb#GetPromotionRequest.
}
resp, err := c.GetPromotion(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Use of Context

The ctx passed to NewClient 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.

Functions

func DefaultAuthScopes 

func DefaultAuthScopes() []string

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

CallOptions

type CallOptions struct {
	InsertPromotion []gax.CallOption
	GetPromotion    []gax.CallOption
	ListPromotions  []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

Client

type Client struct {

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

Client 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 promotions for products.

func NewClient 

func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

NewClient creates a new promotions 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 promotions for products.

Example

package main

import (
	"context"

	promotions "cloud.google.com/go/shopping/merchant/promotions/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.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := promotions.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func NewRESTClient 

func NewRESTClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)

NewRESTClient creates a new promotions service rest client.

Service to manage promotions for products.

Example

package main

import (
	"context"

	promotions "cloud.google.com/go/shopping/merchant/promotions/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.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := promotions.NewRESTClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*Client) Close 

func (c *Client) Close() error

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

func (*Client) Connection (deprecated)

func (c *Client) 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 (*Client) GetPromotion 

func (c *Client) GetPromotion(ctx context.Context, req *promotionspb.GetPromotionRequest, opts ...gax.CallOption) (*promotionspb.Promotion, error)

GetPromotion retrieves the promotion from your Merchant Center account.

After inserting or updating a promotion input, it may take several minutes before the updated promotion can be retrieved.

Example

package main

import (
	"context"

	promotions "cloud.google.com/go/shopping/merchant/promotions/apiv1beta"
	promotionspb "cloud.google.com/go/shopping/merchant/promotions/apiv1beta/promotionspb"
)

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.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := promotions.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &promotionspb.GetPromotionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/shopping/merchant/promotions/apiv1beta/promotionspb#GetPromotionRequest.
	}
	resp, err := c.GetPromotion(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) InsertPromotion 

func (c *Client) InsertPromotion(ctx context.Context, req *promotionspb.InsertPromotionRequest, opts ...gax.CallOption) (*promotionspb.Promotion, error)

InsertPromotion inserts a promotion for your Merchant Center account. If the promotion already exists, then it updates the promotion instead.

Example

package main

import (
	"context"

	promotions "cloud.google.com/go/shopping/merchant/promotions/apiv1beta"
	promotionspb "cloud.google.com/go/shopping/merchant/promotions/apiv1beta/promotionspb"
)

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.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := promotions.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &promotionspb.InsertPromotionRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/shopping/merchant/promotions/apiv1beta/promotionspb#InsertPromotionRequest.
	}
	resp, err := c.InsertPromotion(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*Client) ListPromotions 

func (c *Client) ListPromotions(ctx context.Context, req *promotionspb.ListPromotionsRequest, opts ...gax.CallOption) *PromotionIterator

ListPromotions lists the promotions in your Merchant Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested.

After inserting or updating a promotion, it may take several minutes before the updated processed promotion can be retrieved.

Examples

package main

import (
	"context"

	promotions "cloud.google.com/go/shopping/merchant/promotions/apiv1beta"
	promotionspb "cloud.google.com/go/shopping/merchant/promotions/apiv1beta/promotionspb"
	"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.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := promotions.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &promotionspb.ListPromotionsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/shopping/merchant/promotions/apiv1beta/promotionspb#ListPromotionsRequest.
	}
	it := c.ListPromotions(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.(*promotionspb.ListPromotionsResponse)
	}
}
all
package main

import (
	"context"

	promotions "cloud.google.com/go/shopping/merchant/promotions/apiv1beta"
	promotionspb "cloud.google.com/go/shopping/merchant/promotions/apiv1beta/promotionspb"
)

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.go.dev/cloud.google.com/go#hdr-Client_Options
	c, err := promotions.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &promotionspb.ListPromotionsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/shopping/merchant/promotions/apiv1beta/promotionspb#ListPromotionsRequest.
	}
	for resp, err := range c.ListPromotions(ctx, req).All() {
		if err != nil {
			// TODO: Handle error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

PromotionIterator

type PromotionIterator 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 []*promotionspb.Promotion, nextPageToken string, err error)
	// contains filtered or unexported fields
}

PromotionIterator manages a stream of *promotionspb.Promotion.

func (*PromotionIterator) All 

func (it *PromotionIterator) All() iter.Seq2[*promotionspb.Promotion, error]

All returns an iterator. If an error is returned by the iterator, the iterator will stop after that iteration.

func (*PromotionIterator) Next 

func (it *PromotionIterator) Next() (*promotionspb.Promotion, 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 (*PromotionIterator) PageInfo 

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

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