Merchant API v1 - Package cloud.google.com/go/shopping/merchant/quota/apiv1/quotapb (v1.11.0)

Constants

AccountLimitsService_GetAccountLimit_FullMethodName, AccountLimitsService_ListAccountLimits_FullMethodName

const (
	AccountLimitsService_GetAccountLimit_FullMethodName   = "/google.shopping.merchant.quota.v1.AccountLimitsService/GetAccountLimit"
	AccountLimitsService_ListAccountLimits_FullMethodName = "/google.shopping.merchant.quota.v1.AccountLimitsService/ListAccountLimits"
)

QuotaService_ListQuotaGroups_FullMethodName

const (
	QuotaService_ListQuotaGroups_FullMethodName = "/google.shopping.merchant.quota.v1.QuotaService/ListQuotaGroups"
)

Variables

ProductLimit_Scope_name, ProductLimit_Scope_value

var (
	ProductLimit_Scope_name = map[int32]string{
		0: "SCOPE_UNSPECIFIED",
		1: "ADS_NON_EEA",
		2: "ADS_EEA",
	}
	ProductLimit_Scope_value = map[string]int32{
		"SCOPE_UNSPECIFIED": 0,
		"ADS_NON_EEA":       1,
		"ADS_EEA":           2,
	}
)

Enum value maps for ProductLimit_Scope.

AccountLimitsService_ServiceDesc

var AccountLimitsService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.shopping.merchant.quota.v1.AccountLimitsService",
	HandlerType: (*AccountLimitsServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetAccountLimit",
			Handler:    _AccountLimitsService_GetAccountLimit_Handler,
		},
		{
			MethodName: "ListAccountLimits",
			Handler:    _AccountLimitsService_ListAccountLimits_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/shopping/merchant/quota/v1/accountlimits.proto",
}

AccountLimitsService_ServiceDesc is the grpc.ServiceDesc for AccountLimitsService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

File_google_shopping_merchant_quota_v1_accountlimits_proto

var File_google_shopping_merchant_quota_v1_accountlimits_proto protoreflect.FileDescriptor

File_google_shopping_merchant_quota_v1_quota_proto

var File_google_shopping_merchant_quota_v1_quota_proto protoreflect.FileDescriptor

QuotaService_ServiceDesc

var QuotaService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.shopping.merchant.quota.v1.QuotaService",
	HandlerType: (*QuotaServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListQuotaGroups",
			Handler:    _QuotaService_ListQuotaGroups_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/shopping/merchant/quota/v1/quota.proto",
}

QuotaService_ServiceDesc is the grpc.ServiceDesc for QuotaService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterAccountLimitsServiceServer

func RegisterAccountLimitsServiceServer(s grpc.ServiceRegistrar, srv AccountLimitsServiceServer)

func RegisterQuotaServiceServer

func RegisterQuotaServiceServer(s grpc.ServiceRegistrar, srv QuotaServiceServer)

AccountLimit

type AccountLimit struct {

	// The type of the limit.
	//
	// Types that are valid to be assigned to Type:
	//
	//	*AccountLimit_Products
	Type isAccountLimit_Type `protobuf_oneof:"type"`
	// Identifier. The limit part of the name will be a combination of the type
	// and the scope. For example: `accounts/123/limits/products~ADS_NON_EEA`
	//
	// Format: `accounts/{account}/limits/{limit}`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

A limit of a certain type that is applied to an account.

func (*AccountLimit) Descriptor

func (*AccountLimit) Descriptor() ([]byte, []int)

Deprecated: Use AccountLimit.ProtoReflect.Descriptor instead.

func (*AccountLimit) GetName

func (x *AccountLimit) GetName() string

func (*AccountLimit) GetProducts

func (x *AccountLimit) GetProducts() *ProductLimit

func (*AccountLimit) GetType

func (x *AccountLimit) GetType() isAccountLimit_Type

func (*AccountLimit) ProtoMessage

func (*AccountLimit) ProtoMessage()

func (*AccountLimit) ProtoReflect

func (x *AccountLimit) ProtoReflect() protoreflect.Message

func (*AccountLimit) Reset

func (x *AccountLimit) Reset()

func (*AccountLimit) String

func (x *AccountLimit) String() string

AccountLimit_Products

type AccountLimit_Products struct {
	// The limit for products.
	Products *ProductLimit `protobuf:"bytes,100,opt,name=products,proto3,oneof"`
}

AccountLimitsServiceClient

type AccountLimitsServiceClient interface {
	// Retrieves an account limit.
	GetAccountLimit(ctx context.Context, in *GetAccountLimitRequest, opts ...grpc.CallOption) (*AccountLimit, error)
	// Lists the limits of an account.
	ListAccountLimits(ctx context.Context, in *ListAccountLimitsRequest, opts ...grpc.CallOption) (*ListAccountLimitsResponse, error)
}

AccountLimitsServiceClient is the client API for AccountLimitsService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewAccountLimitsServiceClient

func NewAccountLimitsServiceClient(cc grpc.ClientConnInterface) AccountLimitsServiceClient

AccountLimitsServiceServer

type AccountLimitsServiceServer interface {
	// Retrieves an account limit.
	GetAccountLimit(context.Context, *GetAccountLimitRequest) (*AccountLimit, error)
	// Lists the limits of an account.
	ListAccountLimits(context.Context, *ListAccountLimitsRequest) (*ListAccountLimitsResponse, error)
}

AccountLimitsServiceServer is the server API for AccountLimitsService service. All implementations should embed UnimplementedAccountLimitsServiceServer for forward compatibility

GetAccountLimitRequest

type GetAccountLimitRequest struct {

	// Required. The name of the limit to retrieve.
	// Format: `accounts/{account}/limits/{limit}`
	// For example: `accounts/123/limits/products~ADS_NON_EEA`
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for the GetAccountLimit method.

func (*GetAccountLimitRequest) Descriptor

func (*GetAccountLimitRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetAccountLimitRequest.ProtoReflect.Descriptor instead.

func (*GetAccountLimitRequest) GetName

func (x *GetAccountLimitRequest) GetName() string

func (*GetAccountLimitRequest) ProtoMessage

func (*GetAccountLimitRequest) ProtoMessage()

func (*GetAccountLimitRequest) ProtoReflect

func (x *GetAccountLimitRequest) ProtoReflect() protoreflect.Message

func (*GetAccountLimitRequest) Reset

func (x *GetAccountLimitRequest) Reset()

func (*GetAccountLimitRequest) String

func (x *GetAccountLimitRequest) String() string

ListAccountLimitsRequest

type ListAccountLimitsRequest struct {

	// Required. The parent account.
	// Format: `accounts/{account}`
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of limits to return. The service may return
	// fewer than this value. If unspecified, at most 100 limits will be returned.
	// The maximum value is 100; values above 100 will be coerced to 100.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `ListAccountLimits` call.
	// Provide this to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to `ListAccountLimits` must
	// match the call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Required. A filter on the limit `type` is required, for example, `type =
	// "products"`.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Request message for the ListAccountLimits method.

func (*ListAccountLimitsRequest) Descriptor

func (*ListAccountLimitsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListAccountLimitsRequest.ProtoReflect.Descriptor instead.

func (*ListAccountLimitsRequest) GetFilter

func (x *ListAccountLimitsRequest) GetFilter() string

func (*ListAccountLimitsRequest) GetPageSize

func (x *ListAccountLimitsRequest) GetPageSize() int32

func (*ListAccountLimitsRequest) GetPageToken

func (x *ListAccountLimitsRequest) GetPageToken() string

func (*ListAccountLimitsRequest) GetParent

func (x *ListAccountLimitsRequest) GetParent() string

func (*ListAccountLimitsRequest) ProtoMessage

func (*ListAccountLimitsRequest) ProtoMessage()

func (*ListAccountLimitsRequest) ProtoReflect

func (x *ListAccountLimitsRequest) ProtoReflect() protoreflect.Message

func (*ListAccountLimitsRequest) Reset

func (x *ListAccountLimitsRequest) Reset()

func (*ListAccountLimitsRequest) String

func (x *ListAccountLimitsRequest) String() string

ListAccountLimitsResponse

type ListAccountLimitsResponse struct {

	// The limits for the given account.
	AccountLimits []*AccountLimit `protobuf:"bytes,1,rep,name=account_limits,json=accountLimits,proto3" json:"account_limits,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for the ListAccountLimits method.

func (*ListAccountLimitsResponse) Descriptor

func (*ListAccountLimitsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListAccountLimitsResponse.ProtoReflect.Descriptor instead.

func (*ListAccountLimitsResponse) GetAccountLimits

func (x *ListAccountLimitsResponse) GetAccountLimits() []*AccountLimit

func (*ListAccountLimitsResponse) GetNextPageToken

func (x *ListAccountLimitsResponse) GetNextPageToken() string

func (*ListAccountLimitsResponse) ProtoMessage

func (*ListAccountLimitsResponse) ProtoMessage()

func (*ListAccountLimitsResponse) ProtoReflect

func (*ListAccountLimitsResponse) Reset

func (x *ListAccountLimitsResponse) Reset()

func (*ListAccountLimitsResponse) String

func (x *ListAccountLimitsResponse) String() string

ListQuotaGroupsRequest

type ListQuotaGroupsRequest struct {

	// Required. The merchant account who owns the collection of method quotas
	// Format: accounts/{account}
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of quotas to return in the response, used
	// for paging. Defaults to 500; values above 1000 will be coerced to 1000.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. Token (if provided) to retrieve the subsequent page. All other
	// parameters must match the original call that provided the page token.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Request message for the ListQuotaGroups method.

func (*ListQuotaGroupsRequest) Descriptor

func (*ListQuotaGroupsRequest) Descriptor() ([]byte, []int)

Deprecated: Use ListQuotaGroupsRequest.ProtoReflect.Descriptor instead.

func (*ListQuotaGroupsRequest) GetPageSize

func (x *ListQuotaGroupsRequest) GetPageSize() int32

func (*ListQuotaGroupsRequest) GetPageToken

func (x *ListQuotaGroupsRequest) GetPageToken() string

func (*ListQuotaGroupsRequest) GetParent

func (x *ListQuotaGroupsRequest) GetParent() string

func (*ListQuotaGroupsRequest) ProtoMessage

func (*ListQuotaGroupsRequest) ProtoMessage()

func (*ListQuotaGroupsRequest) ProtoReflect

func (x *ListQuotaGroupsRequest) ProtoReflect() protoreflect.Message

func (*ListQuotaGroupsRequest) Reset

func (x *ListQuotaGroupsRequest) Reset()

func (*ListQuotaGroupsRequest) String

func (x *ListQuotaGroupsRequest) String() string

ListQuotaGroupsResponse

type ListQuotaGroupsResponse struct {

	// The methods, current quota usage and limits per each group. The quota is
	// shared between all methods in the group. The groups are sorted in
	// descending order based on
	// [quota_usage][google.shopping.merchant.quota.v1.QuotaGroup.quota_usage].
	QuotaGroups []*QuotaGroup `protobuf:"bytes,1,rep,name=quota_groups,json=quotaGroups,proto3" json:"quota_groups,omitempty"`
	// A token, which can be sent as `page_token` to retrieve the next page.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Response message for the ListMethodGroups method.

func (*ListQuotaGroupsResponse) Descriptor

func (*ListQuotaGroupsResponse) Descriptor() ([]byte, []int)

Deprecated: Use ListQuotaGroupsResponse.ProtoReflect.Descriptor instead.

func (*ListQuotaGroupsResponse) GetNextPageToken

func (x *ListQuotaGroupsResponse) GetNextPageToken() string

func (*ListQuotaGroupsResponse) GetQuotaGroups

func (x *ListQuotaGroupsResponse) GetQuotaGroups() []*QuotaGroup

func (*ListQuotaGroupsResponse) ProtoMessage

func (*ListQuotaGroupsResponse) ProtoMessage()

func (*ListQuotaGroupsResponse) ProtoReflect

func (x *ListQuotaGroupsResponse) ProtoReflect() protoreflect.Message

func (*ListQuotaGroupsResponse) Reset

func (x *ListQuotaGroupsResponse) Reset()

func (*ListQuotaGroupsResponse) String

func (x *ListQuotaGroupsResponse) String() string

MethodDetails

type MethodDetails struct {

	// Output only. The name of the method for example `products.list`.
	Method string `protobuf:"bytes,1,opt,name=method,proto3" json:"method,omitempty"`
	// Output only. The API version that the method belongs to.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// Output only. The sub-API that the method belongs to.
	Subapi string `protobuf:"bytes,3,opt,name=subapi,proto3" json:"subapi,omitempty"`
	// Output only. The path for the method such as
	// `products/v1/productInputs.insert`
	Path string `protobuf:"bytes,4,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

The method details per method in the Merchant API.

func (*MethodDetails) Descriptor

func (*MethodDetails) Descriptor() ([]byte, []int)

Deprecated: Use MethodDetails.ProtoReflect.Descriptor instead.

func (*MethodDetails) GetMethod

func (x *MethodDetails) GetMethod() string

func (*MethodDetails) GetPath

func (x *MethodDetails) GetPath() string

func (*MethodDetails) GetSubapi

func (x *MethodDetails) GetSubapi() string

func (*MethodDetails) GetVersion

func (x *MethodDetails) GetVersion() string

func (*MethodDetails) ProtoMessage

func (*MethodDetails) ProtoMessage()

func (*MethodDetails) ProtoReflect

func (x *MethodDetails) ProtoReflect() protoreflect.Message

func (*MethodDetails) Reset

func (x *MethodDetails) Reset()

func (*MethodDetails) String

func (x *MethodDetails) String() string

ProductLimit

type ProductLimit struct {

	// Required. The scope of the product limit.
	Scope ProductLimit_Scope `protobuf:"varint,1,opt,name=scope,proto3,enum=google.shopping.merchant.quota.v1.ProductLimit_Scope" json:"scope,omitempty"`
	// Required. The maximum number of products that are allowed in the account in
	// the given scope.
	Limit int64 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

The limit for products.

func (*ProductLimit) Descriptor

func (*ProductLimit) Descriptor() ([]byte, []int)

Deprecated: Use ProductLimit.ProtoReflect.Descriptor instead.

func (*ProductLimit) GetLimit

func (x *ProductLimit) GetLimit() int64

func (*ProductLimit) GetScope

func (x *ProductLimit) GetScope() ProductLimit_Scope

func (*ProductLimit) ProtoMessage

func (*ProductLimit) ProtoMessage()

func (*ProductLimit) ProtoReflect

func (x *ProductLimit) ProtoReflect() protoreflect.Message

func (*ProductLimit) Reset

func (x *ProductLimit) Reset()

func (*ProductLimit) String

func (x *ProductLimit) String() string

ProductLimit_Scope

type ProductLimit_Scope int32

The scope of the limit.

ProductLimit_SCOPE_UNSPECIFIED, ProductLimit_ADS_NON_EEA, ProductLimit_ADS_EEA

const (
	// Default value. Should not be used.
	ProductLimit_SCOPE_UNSPECIFIED ProductLimit_Scope = 0
	// Limit for products in non-EEA countries.
	ProductLimit_ADS_NON_EEA ProductLimit_Scope = 1
	// Limit for products in EEA countries.
	ProductLimit_ADS_EEA ProductLimit_Scope = 2
)

func (ProductLimit_Scope) Descriptor

func (ProductLimit_Scope) Enum

func (ProductLimit_Scope) EnumDescriptor

func (ProductLimit_Scope) EnumDescriptor() ([]byte, []int)

Deprecated: Use ProductLimit_Scope.Descriptor instead.

func (ProductLimit_Scope) Number

func (ProductLimit_Scope) String

func (x ProductLimit_Scope) String() string

func (ProductLimit_Scope) Type

QuotaGroup

type QuotaGroup struct {

	// Identifier. The resource name of the quota group.
	// Format: accounts/{account}/quotas/{group}
	// Note: There is no guarantee on the format of {group}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The current quota usage, meaning the number of calls already
	// made on a given day to the methods in the group. The daily quota limits
	// reset at at 12:00 PM midday UTC.
	QuotaUsage int64 `protobuf:"varint,2,opt,name=quota_usage,json=quotaUsage,proto3" json:"quota_usage,omitempty"`
	// Output only. The maximum number of calls allowed per day for the group.
	QuotaLimit int64 `protobuf:"varint,3,opt,name=quota_limit,json=quotaLimit,proto3" json:"quota_limit,omitempty"`
	// Output only. The maximum number of calls allowed per minute for the group.
	QuotaMinuteLimit int64 `protobuf:"varint,5,opt,name=quota_minute_limit,json=quotaMinuteLimit,proto3" json:"quota_minute_limit,omitempty"`
	// Output only. List of all methods group quota applies to.
	MethodDetails []*MethodDetails `protobuf:"bytes,4,rep,name=method_details,json=methodDetails,proto3" json:"method_details,omitempty"`
	// contains filtered or unexported fields
}

The group information for methods in the Merchant API. The quota is shared

between all methods in the group. Even if none of the methods within the
group have usage the information for the group is returned.

func (*QuotaGroup) Descriptor

func (*QuotaGroup) Descriptor() ([]byte, []int)

Deprecated: Use QuotaGroup.ProtoReflect.Descriptor instead.

func (*QuotaGroup) GetMethodDetails

func (x *QuotaGroup) GetMethodDetails() []*MethodDetails

func (*QuotaGroup) GetName

func (x *QuotaGroup) GetName() string

func (*QuotaGroup) GetQuotaLimit

func (x *QuotaGroup) GetQuotaLimit() int64

func (*QuotaGroup) GetQuotaMinuteLimit

func (x *QuotaGroup) GetQuotaMinuteLimit() int64

func (*QuotaGroup) GetQuotaUsage

func (x *QuotaGroup) GetQuotaUsage() int64

func (*QuotaGroup) ProtoMessage

func (*QuotaGroup) ProtoMessage()

func (*QuotaGroup) ProtoReflect

func (x *QuotaGroup) ProtoReflect() protoreflect.Message

func (*QuotaGroup) Reset

func (x *QuotaGroup) Reset()

func (*QuotaGroup) String

func (x *QuotaGroup) String() string

QuotaServiceClient

type QuotaServiceClient interface {
	// Lists the daily call quota and usage per group for your Merchant
	// Center account.
	ListQuotaGroups(ctx context.Context, in *ListQuotaGroupsRequest, opts ...grpc.CallOption) (*ListQuotaGroupsResponse, error)
}

QuotaServiceClient is the client API for QuotaService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewQuotaServiceClient

func NewQuotaServiceClient(cc grpc.ClientConnInterface) QuotaServiceClient

QuotaServiceServer

type QuotaServiceServer interface {
	// Lists the daily call quota and usage per group for your Merchant
	// Center account.
	ListQuotaGroups(context.Context, *ListQuotaGroupsRequest) (*ListQuotaGroupsResponse, error)
}

QuotaServiceServer is the server API for QuotaService service. All implementations should embed UnimplementedQuotaServiceServer for forward compatibility

UnimplementedAccountLimitsServiceServer

type UnimplementedAccountLimitsServiceServer struct {
}

UnimplementedAccountLimitsServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedAccountLimitsServiceServer) GetAccountLimit

func (UnimplementedAccountLimitsServiceServer) ListAccountLimits

UnimplementedQuotaServiceServer

type UnimplementedQuotaServiceServer struct {
}

UnimplementedQuotaServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedQuotaServiceServer) ListQuotaGroups

UnsafeAccountLimitsServiceServer

type UnsafeAccountLimitsServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeAccountLimitsServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AccountLimitsServiceServer will result in compilation errors.

UnsafeQuotaServiceServer

type UnsafeQuotaServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeQuotaServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to QuotaServiceServer will result in compilation errors.