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

Version 0.11.0

• 0.12.1 (latest)
• 0.12.0
• 0.11.1
• 0.10.0
• 0.9.2
• 0.8.7
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.2
• 0.2.2

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Package products 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:

• Authentication and Authorization
• Timeouts and Cancellation
• Testing against Client Libraries
• Debugging Client Libraries
• Inspecting errors

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 := products.NewProductInputsClient(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 := products.NewProductInputsClient(ctx)
if err != nil {
    // TODO: Handle error.
}
defer c.Close()

req := &productspb.DeleteProductInputRequest{
    // TODO: Fill request struct fields.
    // See https://pkg.go.dev/cloud.google.com/go/shopping/merchant/products/apiv1beta/productspb#DeleteProductInputRequest.
}
err = c.DeleteProductInput(ctx, req)
if err != nil {
    // TODO: Handle error.
}

Use of Context

The ctx passed to NewProductInputsClient 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 {
	GetProduct   []gax.CallOption
	ListProducts []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 use Product resource. This service works for products with online channel only.

func NewClient

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

NewClient creates a new products 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 use Product resource. This service works for products with online channel only.

Example

package main

import (
	"context"

	products "cloud.google.com/go/shopping/merchant/products/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 := products.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 products service rest client.

Service to use Product resource. This service works for products with online channel only.

Example

package main

import (
	"context"

	products "cloud.google.com/go/shopping/merchant/products/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 := products.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) GetProduct

func (c *Client) GetProduct(ctx context.Context, req *productspb.GetProductRequest, opts ...gax.CallOption) (*productspb.Product, error)

GetProduct retrieves the processed product from your Merchant Center account.

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

Example

package main

import (
	"context"

	products "cloud.google.com/go/shopping/merchant/products/apiv1beta"
	productspb "cloud.google.com/go/shopping/merchant/products/apiv1beta/productspb"
)

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 := products.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

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

func (*Client) ListProducts

func (c *Client) ListProducts(ctx context.Context, req *productspb.ListProductsRequest, opts ...gax.CallOption) *ProductIterator

ListProducts lists the processed products 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, updating, or deleting a product input, it may take several minutes before the updated processed product can be retrieved.

Examples

package main

import (
	"context"

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

	req := &productspb.ListProductsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/shopping/merchant/products/apiv1beta/productspb#ListProductsRequest.
	}
	it := c.ListProducts(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.(*productspb.ListProductsResponse)
	}
}

all

package main

import (
	"context"

	products "cloud.google.com/go/shopping/merchant/products/apiv1beta"
	productspb "cloud.google.com/go/shopping/merchant/products/apiv1beta/productspb"
)

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 := products.NewClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

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

ProductInputsCallOptions

type ProductInputsCallOptions struct {
	InsertProductInput []gax.CallOption
	DeleteProductInput []gax.CallOption
}

ProductInputsCallOptions contains the retry settings for each method of ProductInputsClient.

ProductInputsClient

type ProductInputsClient struct {

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

ProductInputsClient 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 use ProductInput resource. This service works for products with online channel only.

func NewProductInputsClient

func NewProductInputsClient(ctx context.Context, opts ...option.ClientOption) (*ProductInputsClient, error)

NewProductInputsClient creates a new product inputs 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 use ProductInput resource. This service works for products with online channel only.

Example

package main

import (
	"context"

	products "cloud.google.com/go/shopping/merchant/products/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 := products.NewProductInputsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func NewProductInputsRESTClient

func NewProductInputsRESTClient(ctx context.Context, opts ...option.ClientOption) (*ProductInputsClient, error)

NewProductInputsRESTClient creates a new product inputs service rest client.

Service to use ProductInput resource. This service works for products with online channel only.

Example

package main

import (
	"context"

	products "cloud.google.com/go/shopping/merchant/products/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 := products.NewProductInputsRESTClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	// TODO: Use client.
	_ = c
}

func (*ProductInputsClient) Close

func (c *ProductInputsClient) Close() error

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

func (*ProductInputsClient) Connection (deprecated)

func (c *ProductInputsClient) 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 (*ProductInputsClient) DeleteProductInput

func (c *ProductInputsClient) DeleteProductInput(ctx context.Context, req *productspb.DeleteProductInputRequest, opts ...gax.CallOption) error

DeleteProductInput deletes a product input from your Merchant Center account.

After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.

Example

package main

import (
	"context"

	products "cloud.google.com/go/shopping/merchant/products/apiv1beta"
	productspb "cloud.google.com/go/shopping/merchant/products/apiv1beta/productspb"
)

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 := products.NewProductInputsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

	req := &productspb.DeleteProductInputRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/shopping/merchant/products/apiv1beta/productspb#DeleteProductInputRequest.
	}
	err = c.DeleteProductInput(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
}

func (*ProductInputsClient) InsertProductInput

func (c *ProductInputsClient) InsertProductInput(ctx context.Context, req *productspb.InsertProductInputRequest, opts ...gax.CallOption) (*productspb.ProductInput, error)

InsertProductInput uploads a product input to your Merchant Center account. If an input with the same contentLanguage, offerId, and dataSource already exists, this method replaces that entry.

After inserting, updating, or deleting a product input, it may take several minutes before the processed product can be retrieved.

Example

package main

import (
	"context"

	products "cloud.google.com/go/shopping/merchant/products/apiv1beta"
	productspb "cloud.google.com/go/shopping/merchant/products/apiv1beta/productspb"
)

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 := products.NewProductInputsClient(ctx)
	if err != nil {
		// TODO: Handle error.
	}
	defer c.Close()

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

ProductIterator

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

ProductIterator manages a stream of *productspb.Product.

func (*ProductIterator) All

func (it *ProductIterator) All() iter.Seq2[*productspb.Product, error]

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

func (*ProductIterator) Next

func (it *ProductIterator) Next() (*productspb.Product, 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 (*ProductIterator) PageInfo

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

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