quota

package
v1.4.0 Latest Latest
Warning

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

 Go to latest Published: Dec 4, 2025 License: Apache-2.0 Imports: 26 Imported by: 0

Documentation

Overview

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

Programmatically manage your Merchant Center Accounts.

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. 

// go get cloud.google.com/go/shopping/merchant/quota/apiv1@latest
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 := quota.NewAccountLimitsClient(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, mentioned above. 

req := &quotapb.GetAccountLimitRequest{
	// TODO: Fill request struct fields.
	// See https://pkg.go.dev/cloud.google.com/go/shopping/merchant/quota/apiv1/quotapb#GetAccountLimitRequest.
}
resp, err := c.GetAccountLimit(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp

Use of Context

The ctx passed to NewAccountLimitsClient 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 AccountLimitIterator added in v1.4.0 

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

AccountLimitIterator manages a stream of *quotapb.AccountLimit.

func (*AccountLimitIterator) All added in v1.4.0 

func (it *AccountLimitIterator) All() iter.Seq2[*quotapb.AccountLimit, error]

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

func (*AccountLimitIterator) Next added in v1.4.0 

func (it *AccountLimitIterator) Next() (*quotapb.AccountLimit, 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 (*AccountLimitIterator) PageInfo added in v1.4.0 

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

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

type AccountLimitsCallOptions added in v1.4.0 

type AccountLimitsCallOptions struct {
	GetAccountLimit   []gax.CallOption
	ListAccountLimits []gax.CallOption
}

AccountLimitsCallOptions contains the retry settings for each method of AccountLimitsClient.

type AccountLimitsClient added in v1.4.0 

type AccountLimitsClient struct {

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

AccountLimitsClient 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 retrieve account limits.

func NewAccountLimitsClient added in v1.4.0 

func NewAccountLimitsClient(ctx context.Context, opts ...option.ClientOption) (*AccountLimitsClient, error)

NewAccountLimitsClient creates a new account limits 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 retrieve account limits.

Example 
package main

import (
	"context"

	quota "cloud.google.com/go/shopping/merchant/quota/apiv1"
)

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

	// TODO: Use client.
	_ = c
}

func NewAccountLimitsRESTClient added in v1.4.0 

func NewAccountLimitsRESTClient(ctx context.Context, opts ...option.ClientOption) (*AccountLimitsClient, error)

NewAccountLimitsRESTClient creates a new account limits service rest client.

Service to retrieve account limits.

Example 
package main

import (
	"context"

	quota "cloud.google.com/go/shopping/merchant/quota/apiv1"
)

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

	// TODO: Use client.
	_ = c
}

func (*AccountLimitsClient) Close added in v1.4.0 

func (c *AccountLimitsClient) Close() error

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

func (*AccountLimitsClient) Connection deprecated added in v1.4.0 

func (c *AccountLimitsClient) 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 (*AccountLimitsClient) GetAccountLimit added in v1.4.0 

func (c *AccountLimitsClient) GetAccountLimit(ctx context.Context, req *quotapb.GetAccountLimitRequest, opts ...gax.CallOption) (*quotapb.AccountLimit, error)

GetAccountLimit retrieves an account limit.

Example 
package main

import (
	"context"

	quota "cloud.google.com/go/shopping/merchant/quota/apiv1"
	quotapb "cloud.google.com/go/shopping/merchant/quota/apiv1/quotapb"
)

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

	req := &quotapb.GetAccountLimitRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/shopping/merchant/quota/apiv1/quotapb#GetAccountLimitRequest.
	}
	resp, err := c.GetAccountLimit(ctx, req)
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}

func (*AccountLimitsClient) ListAccountLimits added in v1.4.0 

func (c *AccountLimitsClient) ListAccountLimits(ctx context.Context, req *quotapb.ListAccountLimitsRequest, opts ...gax.CallOption) *AccountLimitIterator

ListAccountLimits lists the limits of an account.

Example 
package main

import (
	"context"

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

	req := &quotapb.ListAccountLimitsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/shopping/merchant/quota/apiv1/quotapb#ListAccountLimitsRequest.
	}
	it := c.ListAccountLimits(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.(*quotapb.ListAccountLimitsResponse)
	}
}
Example (All) 
package main

import (
	"context"

	quota "cloud.google.com/go/shopping/merchant/quota/apiv1"
	quotapb "cloud.google.com/go/shopping/merchant/quota/apiv1/quotapb"
)

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

	req := &quotapb.ListAccountLimitsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/shopping/merchant/quota/apiv1/quotapb#ListAccountLimitsRequest.
	}
	for resp, err := range c.ListAccountLimits(ctx, req).All() {
		if err != nil {
			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

type CallOptions 

type CallOptions struct {
	ListQuotaGroups []gax.CallOption
}

CallOptions contains the retry settings for each method of Client.

type 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 get method call quota information per Merchant API method.

func NewClient 

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

NewClient creates a new quota 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 get method call quota information per Merchant API method.

Example 
package main

import (
	"context"

	quota "cloud.google.com/go/shopping/merchant/quota/apiv1"
)

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 := quota.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 quota service rest client.

Service to get method call quota information per Merchant API method.

Example 
package main

import (
	"context"

	quota "cloud.google.com/go/shopping/merchant/quota/apiv1"
)

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 := quota.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) ListQuotaGroups 

func (c *Client) ListQuotaGroups(ctx context.Context, req *quotapb.ListQuotaGroupsRequest, opts ...gax.CallOption) *QuotaGroupIterator

ListQuotaGroups lists the daily call quota and usage per group for your Merchant Center account.

Example 
package main

import (
	"context"

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

	req := &quotapb.ListQuotaGroupsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/shopping/merchant/quota/apiv1/quotapb#ListQuotaGroupsRequest.
	}
	it := c.ListQuotaGroups(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.(*quotapb.ListQuotaGroupsResponse)
	}
}
Example (All) 
package main

import (
	"context"

	quota "cloud.google.com/go/shopping/merchant/quota/apiv1"
	quotapb "cloud.google.com/go/shopping/merchant/quota/apiv1/quotapb"
)

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

	req := &quotapb.ListQuotaGroupsRequest{
		// TODO: Fill request struct fields.
		// See https://pkg.go.dev/cloud.google.com/go/shopping/merchant/quota/apiv1/quotapb#ListQuotaGroupsRequest.
	}
	for resp, err := range c.ListQuotaGroups(ctx, req).All() {
		if err != nil {
			// TODO: Handle error and break/return/continue. Iteration will stop after any error.
		}
		// TODO: Use resp.
		_ = resp
	}
}

type QuotaGroupIterator 

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

QuotaGroupIterator manages a stream of *quotapb.QuotaGroup.

func (*QuotaGroupIterator) All 

func (it *QuotaGroupIterator) All() iter.Seq2[*quotapb.QuotaGroup, error]

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

func (*QuotaGroupIterator) Next 

func (it *QuotaGroupIterator) Next() (*quotapb.QuotaGroup, 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 (*QuotaGroupIterator) PageInfo 

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

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

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.