inventoriespb

package
v1.11.0 Latest Latest
Warning

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

 Go to latest Published: May 7, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	LocalInventoryService_ListLocalInventories_FullMethodName = "/google.shopping.merchant.inventories.v1.LocalInventoryService/ListLocalInventories"
	LocalInventoryService_InsertLocalInventory_FullMethodName = "/google.shopping.merchant.inventories.v1.LocalInventoryService/InsertLocalInventory"
	LocalInventoryService_DeleteLocalInventory_FullMethodName = "/google.shopping.merchant.inventories.v1.LocalInventoryService/DeleteLocalInventory"
)
View Source 
const (
	RegionalInventoryService_ListRegionalInventories_FullMethodName = "/google.shopping.merchant.inventories.v1.RegionalInventoryService/ListRegionalInventories"
	RegionalInventoryService_InsertRegionalInventory_FullMethodName = "/google.shopping.merchant.inventories.v1.RegionalInventoryService/InsertRegionalInventory"
	RegionalInventoryService_DeleteRegionalInventory_FullMethodName = "/google.shopping.merchant.inventories.v1.RegionalInventoryService/DeleteRegionalInventory"
)

Variables

View Source 
var (
	LocalInventoryAttributes_Availability_name = map[int32]string{
		0: "LOCAL_INVENTORY_AVAILABILITY_UNSPECIFIED",
		1: "IN_STOCK",
		2: "LIMITED_AVAILABILITY",
		3: "ON_DISPLAY_TO_ORDER",
		4: "OUT_OF_STOCK",
	}
	LocalInventoryAttributes_Availability_value = map[string]int32{
		"LOCAL_INVENTORY_AVAILABILITY_UNSPECIFIED": 0,
		"IN_STOCK":             1,
		"LIMITED_AVAILABILITY": 2,
		"ON_DISPLAY_TO_ORDER":  3,
		"OUT_OF_STOCK":         4,
	}
)

Enum value maps for LocalInventoryAttributes_Availability.

View Source 
var (
	LocalInventoryAttributes_PickupMethod_name = map[int32]string{
		0: "PICKUP_METHOD_UNSPECIFIED",
		1: "BUY",
		2: "RESERVE",
		3: "SHIP_TO_STORE",
		4: "NOT_SUPPORTED",
	}
	LocalInventoryAttributes_PickupMethod_value = map[string]int32{
		"PICKUP_METHOD_UNSPECIFIED": 0,
		"BUY":                       1,
		"RESERVE":                   2,
		"SHIP_TO_STORE":             3,
		"NOT_SUPPORTED":             4,
	}
)

Enum value maps for LocalInventoryAttributes_PickupMethod.

View Source 
var (
	LocalInventoryAttributes_PickupSla_name = map[int32]string{
		0: "PICKUP_SLA_UNSPECIFIED",
		1: "SAME_DAY",
		2: "NEXT_DAY",
		3: "TWO_DAY",
		4: "THREE_DAY",
		5: "FOUR_DAY",
		6: "FIVE_DAY",
		7: "SIX_DAY",
		8: "SEVEN_DAY",
		9: "MULTI_WEEK",
	}
	LocalInventoryAttributes_PickupSla_value = map[string]int32{
		"PICKUP_SLA_UNSPECIFIED": 0,
		"SAME_DAY":               1,
		"NEXT_DAY":               2,
		"TWO_DAY":                3,
		"THREE_DAY":              4,
		"FOUR_DAY":               5,
		"FIVE_DAY":               6,
		"SIX_DAY":                7,
		"SEVEN_DAY":              8,
		"MULTI_WEEK":             9,
	}
)

Enum value maps for LocalInventoryAttributes_PickupSla.

View Source 
var (
	RegionalInventoryAttributes_Availability_name = map[int32]string{
		0: "REGIONAL_INVENTORY_AVAILABILITY_UNSPECIFIED",
		1: "IN_STOCK",
		2: "OUT_OF_STOCK",
	}
	RegionalInventoryAttributes_Availability_value = map[string]int32{
		"REGIONAL_INVENTORY_AVAILABILITY_UNSPECIFIED": 0,
		"IN_STOCK":     1,
		"OUT_OF_STOCK": 2,
	}
)

Enum value maps for RegionalInventoryAttributes_Availability.

View Source 
var File_google_shopping_merchant_inventories_v1_inventories_common_proto protoreflect.FileDescriptor
View Source 
var File_google_shopping_merchant_inventories_v1_localinventory_proto protoreflect.FileDescriptor
View Source 
var File_google_shopping_merchant_inventories_v1_regionalinventory_proto protoreflect.FileDescriptor
View Source 
var LocalInventoryService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.shopping.merchant.inventories.v1.LocalInventoryService",
	HandlerType: (*LocalInventoryServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListLocalInventories",
			Handler:    _LocalInventoryService_ListLocalInventories_Handler,
		},
		{
			MethodName: "InsertLocalInventory",
			Handler:    _LocalInventoryService_InsertLocalInventory_Handler,
		},
		{
			MethodName: "DeleteLocalInventory",
			Handler:    _LocalInventoryService_DeleteLocalInventory_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/shopping/merchant/inventories/v1/localinventory.proto",
}

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

View Source 
var RegionalInventoryService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.shopping.merchant.inventories.v1.RegionalInventoryService",
	HandlerType: (*RegionalInventoryServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListRegionalInventories",
			Handler:    _RegionalInventoryService_ListRegionalInventories_Handler,
		},
		{
			MethodName: "InsertRegionalInventory",
			Handler:    _RegionalInventoryService_InsertRegionalInventory_Handler,
		},
		{
			MethodName: "DeleteRegionalInventory",
			Handler:    _RegionalInventoryService_DeleteRegionalInventory_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/shopping/merchant/inventories/v1/regionalinventory.proto",
}

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

Functions

func RegisterLocalInventoryServiceServer 

func RegisterLocalInventoryServiceServer(s grpc.ServiceRegistrar, srv LocalInventoryServiceServer)

func RegisterRegionalInventoryServiceServer 

func RegisterRegionalInventoryServiceServer(s grpc.ServiceRegistrar, srv RegionalInventoryServiceServer)

Types

type DeleteLocalInventoryRequest 

type DeleteLocalInventoryRequest struct {

	// Required. The name of the local inventory for the given product to delete.
	// Format:
	// `accounts/{account}/products/{product}/localInventories/{store_code}`
	//
	// The `{product}` segment is a unique identifier for the product.
	// This identifier must be unique within a merchant account and generally
	// follows the structure: `content_language~feed_label~offer_id`. Example:
	// `en~US~sku123` For legacy local products, the structure is:
	// `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123`
	//
	// The format of the `{product}` segment in the URL is automatically detected
	// by the server, supporting two options:
	//
	//  1. **Encoded Format**: The `{product}` segment is an unpadded base64url
	//     encoded string (RFC 4648 Section 5). The decoded string must result
	//     in the `content_language~feed_label~offer_id` structure. This encoding
	//     MUST be used if any part of the product identifier (like `offer_id`)
	//     contains characters such as `/`, `%`, or `~`.
	//     *   Example: To represent the product ID `en~US~sku/123` for
	//     `store_code` "store123", the `{product}` segment must be the
	//     unpadded base64url encoding of this string, which is
	//     `ZW5-VVN-c2t1LzEyMw`. The full resource name for the local
	//     inventory would be
	//     `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123`.
	//
	//  2. **Plain Format**: The `{product}` segment is the tilde-separated string
	//     `content_language~feed_label~offer_id`. This format is suitable only
	//     when `content_language`, `feed_label`, and `offer_id` do not contain
	//     URL-problematic characters like `/`, `%`, or `~`.
	//
	// We recommend using the **Encoded Format** for all product IDs to ensure
	// correct parsing, especially those containing special characters. The
	// presence of tilde (`~`) characters in the `{product}` segment is used to
	// differentiate between the two formats.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for the `DeleteLocalInventory` method.

func (*DeleteLocalInventoryRequest) Descriptor deprecated 

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

Deprecated: Use DeleteLocalInventoryRequest.ProtoReflect.Descriptor instead.

func (*DeleteLocalInventoryRequest) GetName 

func (x *DeleteLocalInventoryRequest) GetName() string

func (*DeleteLocalInventoryRequest) ProtoMessage 

func (*DeleteLocalInventoryRequest) ProtoMessage()

func (*DeleteLocalInventoryRequest) ProtoReflect 

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

func (*DeleteLocalInventoryRequest) Reset 

func (x *DeleteLocalInventoryRequest) Reset()

func (*DeleteLocalInventoryRequest) String 

func (x *DeleteLocalInventoryRequest) String() string

type DeleteRegionalInventoryRequest 

type DeleteRegionalInventoryRequest struct {

	// Required. The name of the `RegionalInventory` resource to delete.
	// Format:
	// `accounts/{account}/products/{product}/regionalInventories/{region}`
	//
	// The `{product}` segment is a unique identifier for the product.
	// This identifier must be unique within a merchant account and generally
	// follows the structure: `content_language~feed_label~offer_id`. Example:
	// `en~US~sku123` For legacy local products, the structure is:
	// `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123`
	//
	// The format of the `{product}` segment in the URL is automatically detected
	// by the server, supporting two options:
	//
	//  1. **Encoded Format**: The `{product}` segment is an
	//     **unpadded base64url** encoded string (RFC 4648 Section 5). The
	//     decoded string
	//     must result in the `content_language~feed_label~offer_id` structure.
	//     This encoding MUST be used if any part of the product identifier (like
	//     `offer_id`) contains characters such as `/`, `%`, or `~`.
	//     *   Example: To represent the product ID `en~US~sku/123` for
	//     `region` "region123", the `{product}` segment must be the
	//     unpadded base64url encoding of this string, which is
	//     `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional
	//     inventory would be
	//     `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123`.
	//
	//  2. **Plain Format**: The `{product}` segment is the tilde-separated string
	//     `content_language~feed_label~offer_id`. This format is suitable only
	//     when `content_language`, `feed_label`, and `offer_id` do not contain
	//     URL-problematic characters like `/`, `%`, or `~`.
	//
	// We recommend using the **Encoded Format** for all product IDs to ensure
	// correct parsing, especially those containing special characters. The
	// presence of tilde (`~`) characters in the `{product}` segment is used to
	// differentiate between the two formats.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request message for the `DeleteRegionalInventory` method.

func (*DeleteRegionalInventoryRequest) Descriptor deprecated 

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

Deprecated: Use DeleteRegionalInventoryRequest.ProtoReflect.Descriptor instead.

func (*DeleteRegionalInventoryRequest) GetName 

func (x *DeleteRegionalInventoryRequest) GetName() string

func (*DeleteRegionalInventoryRequest) ProtoMessage 

func (*DeleteRegionalInventoryRequest) ProtoMessage()

func (*DeleteRegionalInventoryRequest) ProtoReflect 

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

func (*DeleteRegionalInventoryRequest) Reset 

func (x *DeleteRegionalInventoryRequest) Reset()

func (*DeleteRegionalInventoryRequest) String 

func (x *DeleteRegionalInventoryRequest) String() string

type InsertLocalInventoryRequest 

type InsertLocalInventoryRequest struct {

	// Required. The account and product where this inventory will be inserted.
	// Format: `accounts/{account}/products/{product}`
	//
	// The `{product}` segment is a unique identifier for the product.
	// This identifier must be unique within a merchant account and generally
	// follows the structure: `content_language~feed_label~offer_id`. Example:
	// `en~US~sku123` For legacy local products, the structure is:
	// `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123`
	//
	// The format of the `{product}` segment in the URL is automatically detected
	// by the server, supporting two options:
	//
	//  1. **Encoded Format**: The `{product}` segment is an unpadded base64url
	//     encoded string (RFC 4648 Section 5). The decoded string must result
	//     in the `content_language~feed_label~offer_id` structure. This encoding
	//     MUST be used if any part of the product identifier (like `offer_id`)
	//     contains characters such as `/`, `%`, or `~`.
	//     *   Example: To represent the product ID `en~US~sku/123`, the
	//     `{product}` segment must be the unpadded base64url encoding of this
	//     string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name
	//     for the product would be
	//     `accounts/123/products/ZW5-VVN-c2t1LzEyMw`.
	//
	//  2. **Plain Format**: The `{product}` segment is the tilde-separated string
	//     `content_language~feed_label~offer_id`. This format is suitable only
	//     when `content_language`, `feed_label`, and `offer_id` do not contain
	//     URL-problematic characters like `/`, `%`, or `~`.
	//
	// We recommend using the **Encoded Format** for all product IDs to ensure
	// correct parsing, especially those containing special characters. The
	// presence of tilde (`~`) characters in the `{product}` segment is used to
	// differentiate between the two formats.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Local inventory information of the product. If the product
	// already has a `LocalInventory` resource for the same `storeCode`, full
	// replacement of the `LocalInventory` resource is performed.
	LocalInventory *LocalInventory `protobuf:"bytes,2,opt,name=local_inventory,json=localInventory,proto3" json:"local_inventory,omitempty"`
	// contains filtered or unexported fields
}

Request message for the `InsertLocalInventory` method.

func (*InsertLocalInventoryRequest) Descriptor deprecated 

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

Deprecated: Use InsertLocalInventoryRequest.ProtoReflect.Descriptor instead.

func (*InsertLocalInventoryRequest) GetLocalInventory 

func (x *InsertLocalInventoryRequest) GetLocalInventory() *LocalInventory

func (*InsertLocalInventoryRequest) GetParent 

func (x *InsertLocalInventoryRequest) GetParent() string

func (*InsertLocalInventoryRequest) ProtoMessage 

func (*InsertLocalInventoryRequest) ProtoMessage()

func (*InsertLocalInventoryRequest) ProtoReflect 

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

func (*InsertLocalInventoryRequest) Reset 

func (x *InsertLocalInventoryRequest) Reset()

func (*InsertLocalInventoryRequest) String 

func (x *InsertLocalInventoryRequest) String() string

type InsertRegionalInventoryRequest 

type InsertRegionalInventoryRequest struct {

	// Required. The account and product where this inventory will be inserted.
	// Format: `accounts/{account}/products/{product}`
	//
	// The `{product}` segment is a unique identifier for the product.
	// This identifier must be unique within a merchant account and generally
	// follows the structure: `content_language~feed_label~offer_id`. Example:
	// `en~US~sku123` For legacy local products, the structure is:
	// `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123`
	//
	// The format of the `{product}` segment in the URL is automatically detected
	// by the server, supporting two options:
	//
	//  1. **Encoded Format**: The `{product}` segment is an
	//     **unpadded base64url** encoded string (RFC 4648 Section 5). The
	//     decoded string
	//     must result in the `content_language~feed_label~offer_id` structure.
	//     This encoding MUST be used if any part of the product identifier (like
	//     `offer_id`) contains characters such as `/`, `%`, or `~`.
	//     *   Example: To represent the product ID `en~US~sku/123`, the
	//     `{product}` segment must be the unpadded base64url encoding of this
	//     string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name
	//     for the product would be
	//     `accounts/123/products/ZW5-VVN-c2t1LzEyMw`.
	//
	//  2. **Plain Format**: The `{product}` segment is the tilde-separated string
	//     `content_language~feed_label~offer_id`. This format is suitable only
	//     when `content_language`, `feed_label`, and `offer_id` do not contain
	//     URL-problematic characters like `/`, `%`, or `~`.
	//
	// We recommend using the **Encoded Format** for all product IDs to ensure
	// correct parsing, especially those containing special characters. The
	// presence of tilde (`~`) characters in the `{product}` segment is used to
	// differentiate between the two formats.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Regional inventory information to add to the product. If the
	// product already has a `RegionalInventory` resource for the same `region`,
	// full replacement of the `RegionalInventory` resource is performed.
	RegionalInventory *RegionalInventory `protobuf:"bytes,2,opt,name=regional_inventory,json=regionalInventory,proto3" json:"regional_inventory,omitempty"`
	// contains filtered or unexported fields
}

Request message for the `InsertRegionalInventory` method.

func (*InsertRegionalInventoryRequest) Descriptor deprecated 

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

Deprecated: Use InsertRegionalInventoryRequest.ProtoReflect.Descriptor instead.

func (*InsertRegionalInventoryRequest) GetParent 

func (x *InsertRegionalInventoryRequest) GetParent() string

func (*InsertRegionalInventoryRequest) GetRegionalInventory 

func (x *InsertRegionalInventoryRequest) GetRegionalInventory() *RegionalInventory

func (*InsertRegionalInventoryRequest) ProtoMessage 

func (*InsertRegionalInventoryRequest) ProtoMessage()

func (*InsertRegionalInventoryRequest) ProtoReflect 

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

func (*InsertRegionalInventoryRequest) Reset 

func (x *InsertRegionalInventoryRequest) Reset()

func (*InsertRegionalInventoryRequest) String 

func (x *InsertRegionalInventoryRequest) String() string

type InventoryLoyaltyProgram added in v1.10.0 

type InventoryLoyaltyProgram struct {

	// The label of the loyalty program. This is an internal label that uniquely
	// identifies the relationship between a business entity and a loyalty
	// program entity. The label must be provided if there are multiple loyalty
	// programs available for the merchant, so that the system can associate
	// the assets below (for example, price and points) with the correct business.
	// The corresponding program must be linked to the Merchant Center account.
	ProgramLabel *string `protobuf:"bytes,1,opt,name=program_label,json=programLabel,proto3,oneof" json:"program_label,omitempty"`
	// The label of the tier within the loyalty program.
	// Must match one of the labels within the program.
	TierLabel *string `protobuf:"bytes,2,opt,name=tier_label,json=tierLabel,proto3,oneof" json:"tier_label,omitempty"`
	// The price for members of the given tier, that is, the instant discount
	// price. Must be smaller or equal to the regular price.
	Price *typepb.Price `protobuf:"bytes,3,opt,name=price,proto3,oneof" json:"price,omitempty"`
	// The cashback that can be used for future purchases.
	CashbackForFutureUse *typepb.Price `` /* 131-byte string literal not displayed */
	// The amount of loyalty points earned on a purchase.
	LoyaltyPoints *int64 `protobuf:"varint,5,opt,name=loyalty_points,json=loyaltyPoints,proto3,oneof" json:"loyalty_points,omitempty"`
	// A date range during which the item is eligible for member price. If not
	// specified, the member price is always applicable. The date range is
	// represented by a pair of ISO 8601 dates separated by a space,
	// comma, or slash.
	MemberPriceEffectiveInterval *interval.Interval `` /* 155-byte string literal not displayed */
	// The label of the shipping benefit. If the field has value, this offer has
	// loyalty shipping benefit. If the field value isn't provided, the item is
	// not eligible for loyalty shipping for the given loyalty tier.
	ShippingLabel *string `protobuf:"bytes,7,opt,name=shipping_label,json=shippingLabel,proto3,oneof" json:"shipping_label,omitempty"`
	// contains filtered or unexported fields
}

A message that represents loyalty program.

func (*InventoryLoyaltyProgram) Descriptor deprecated added in v1.10.0 

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

Deprecated: Use InventoryLoyaltyProgram.ProtoReflect.Descriptor instead.

func (*InventoryLoyaltyProgram) GetCashbackForFutureUse added in v1.10.0 

func (x *InventoryLoyaltyProgram) GetCashbackForFutureUse() *typepb.Price

func (*InventoryLoyaltyProgram) GetLoyaltyPoints added in v1.10.0 

func (x *InventoryLoyaltyProgram) GetLoyaltyPoints() int64

func (*InventoryLoyaltyProgram) GetMemberPriceEffectiveInterval added in v1.10.0 

func (x *InventoryLoyaltyProgram) GetMemberPriceEffectiveInterval() *interval.Interval

func (*InventoryLoyaltyProgram) GetPrice added in v1.10.0 

func (x *InventoryLoyaltyProgram) GetPrice() *typepb.Price

func (*InventoryLoyaltyProgram) GetProgramLabel added in v1.10.0 

func (x *InventoryLoyaltyProgram) GetProgramLabel() string

func (*InventoryLoyaltyProgram) GetShippingLabel added in v1.10.0 

func (x *InventoryLoyaltyProgram) GetShippingLabel() string

func (*InventoryLoyaltyProgram) GetTierLabel added in v1.10.0 

func (x *InventoryLoyaltyProgram) GetTierLabel() string

func (*InventoryLoyaltyProgram) ProtoMessage added in v1.10.0 

func (*InventoryLoyaltyProgram) ProtoMessage()

func (*InventoryLoyaltyProgram) ProtoReflect added in v1.10.0 

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

func (*InventoryLoyaltyProgram) Reset added in v1.10.0 

func (x *InventoryLoyaltyProgram) Reset()

func (*InventoryLoyaltyProgram) String added in v1.10.0 

func (x *InventoryLoyaltyProgram) String() string

type ListLocalInventoriesRequest 

type ListLocalInventoriesRequest struct {

	// Required. The `name` of the parent product to list local inventories for.
	// Format:
	// `accounts/{account}/products/{product}`
	//
	// The `{product}` segment is a unique identifier for the product.
	// This identifier must be unique within a merchant account and generally
	// follows the structure: `content_language~feed_label~offer_id`. Example:
	// `en~US~sku123` For legacy local products, the structure is:
	// `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123`
	//
	// The format of the `{product}` segment in the URL is automatically detected
	// by the server, supporting two options:
	//
	//  1. **Encoded Format**: The `{product}` segment is an unpadded base64url
	//     encoded string (RFC 4648 Section 5). The decoded string must result
	//     in the `content_language~feed_label~offer_id` structure. This encoding
	//     MUST be used if any part of the product identifier (like `offer_id`)
	//     contains characters such as `/`, `%`, or `~`.
	//     *   Example: To represent the product ID `en~US~sku/123`, the
	//     `{product}` segment must be the unpadded base64url encoding of this
	//     string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name
	//     for the product would be
	//     `accounts/123/products/ZW5-VVN-c2t1LzEyMw`.
	//
	//  2. **Plain Format**: The `{product}` segment is the tilde-separated string
	//     `content_language~feed_label~offer_id`. This format is suitable only
	//     when `content_language`, `feed_label`, and `offer_id` do not contain
	//     URL-problematic characters like `/`, `%`, or `~`.
	//
	// We recommend using the **Encoded Format** for all product IDs to ensure
	// correct parsing, especially those containing special characters. The
	// presence of tilde (`~`) characters in the `{product}` segment is used to
	// differentiate between the two formats.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of `LocalInventory` resources for the given
	// product to return. The service returns fewer than this value if the number
	// of inventories for the given product is less that than the `pageSize`. The
	// default value is 25000. The maximum value is 25000; If a value higher than
	// the maximum is specified, then the `pageSize` will default to the maximum
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `ListLocalInventories` call.
	// Provide the page token to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to `ListLocalInventories`
	// must match the call that provided the page token. The token returned as
	// [nextPageToken][google.shopping.merchant.inventories.v1.ListLocalInventoriesResponse.next_page_token]
	// in the response to the previous request.
	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 `ListLocalInventories` method.

func (*ListLocalInventoriesRequest) Descriptor deprecated 

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

Deprecated: Use ListLocalInventoriesRequest.ProtoReflect.Descriptor instead.

func (*ListLocalInventoriesRequest) GetPageSize 

func (x *ListLocalInventoriesRequest) GetPageSize() int32

func (*ListLocalInventoriesRequest) GetPageToken 

func (x *ListLocalInventoriesRequest) GetPageToken() string

func (*ListLocalInventoriesRequest) GetParent 

func (x *ListLocalInventoriesRequest) GetParent() string

func (*ListLocalInventoriesRequest) ProtoMessage 

func (*ListLocalInventoriesRequest) ProtoMessage()

func (*ListLocalInventoriesRequest) ProtoReflect 

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

func (*ListLocalInventoriesRequest) Reset 

func (x *ListLocalInventoriesRequest) Reset()

func (*ListLocalInventoriesRequest) String 

func (x *ListLocalInventoriesRequest) String() string

type ListLocalInventoriesResponse 

type ListLocalInventoriesResponse struct {

	// The `LocalInventory` resources for the given product from the specified
	// account.
	LocalInventories []*LocalInventory `protobuf:"bytes,1,rep,name=local_inventories,json=localInventories,proto3" json:"local_inventories,omitempty"`
	// A token, which can be sent as `pageToken` 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 `ListLocalInventories` method.

func (*ListLocalInventoriesResponse) Descriptor deprecated 

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

Deprecated: Use ListLocalInventoriesResponse.ProtoReflect.Descriptor instead.

func (*ListLocalInventoriesResponse) GetLocalInventories 

func (x *ListLocalInventoriesResponse) GetLocalInventories() []*LocalInventory

func (*ListLocalInventoriesResponse) GetNextPageToken 

func (x *ListLocalInventoriesResponse) GetNextPageToken() string

func (*ListLocalInventoriesResponse) ProtoMessage 

func (*ListLocalInventoriesResponse) ProtoMessage()

func (*ListLocalInventoriesResponse) ProtoReflect 

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

func (*ListLocalInventoriesResponse) Reset 

func (x *ListLocalInventoriesResponse) Reset()

func (*ListLocalInventoriesResponse) String 

func (x *ListLocalInventoriesResponse) String() string

type ListRegionalInventoriesRequest 

type ListRegionalInventoriesRequest struct {

	// Required. The `name` of the parent product to list `RegionalInventory`
	// resources for. Format: `accounts/{account}/products/{product}`
	//
	// The `{product}` segment is a unique identifier for the product.
	// This identifier must be unique within a merchant account and generally
	// follows the structure: `content_language~feed_label~offer_id`. Example:
	// `en~US~sku123` For legacy local products, the structure is:
	// `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123`
	//
	// The format of the `{product}` segment in the URL is automatically detected
	// by the server, supporting two options:
	//
	//  1. **Encoded Format**: The `{product}` segment is an
	//     **unpadded base64url** encoded string (RFC 4648 Section 5). The
	//     decoded string
	//     must result in the `content_language~feed_label~offer_id` structure.
	//     This encoding MUST be used if any part of the product identifier (like
	//     `offer_id`) contains characters such as `/`, `%`, or `~`.
	//     *   Example: To represent the product ID `en~US~sku/123`, the
	//     `{product}` segment must be the unpadded base64url encoding of this
	//     string, which is `ZW5-VVN-c2t1LzEyMw`. The full resource name
	//     for the product would be
	//     `accounts/123/products/ZW5-VVN-c2t1LzEyMw`.
	//
	//  2. **Plain Format**: The `{product}` segment is the tilde-separated string
	//     `content_language~feed_label~offer_id`. This format is suitable only
	//     when `content_language`, `feed_label`, and `offer_id` do not contain
	//     URL-problematic characters like `/`, `%`, or `~`.
	//
	// We recommend using the **Encoded Format** for all product IDs to ensure
	// correct parsing, especially those containing special characters. The
	// presence of tilde (`~`) characters in the `{product}` segment is used to
	// differentiate between the two formats.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// The maximum number of `RegionalInventory` resources for the given product
	// to return. The service returns fewer than this value if the number of
	// inventories for the given product is less that than the `pageSize`. The
	// default value is 25000. The maximum value is 100000; If a value higher than
	// the maximum is specified, then the `pageSize` will default to the maximum.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A page token, received from a previous `ListRegionalInventories` call.
	// Provide the page token to retrieve the subsequent page.
	//
	// When paginating, all other parameters provided to `ListRegionalInventories`
	// must match the call that provided the page token. The token returned as
	// [nextPageToken][google.shopping.merchant.inventories.v1.ListRegionalInventoriesResponse.next_page_token]
	// in the response to the previous request.
	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 `ListRegionalInventories` method.

func (*ListRegionalInventoriesRequest) Descriptor deprecated 

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

Deprecated: Use ListRegionalInventoriesRequest.ProtoReflect.Descriptor instead.

func (*ListRegionalInventoriesRequest) GetPageSize 

func (x *ListRegionalInventoriesRequest) GetPageSize() int32

func (*ListRegionalInventoriesRequest) GetPageToken 

func (x *ListRegionalInventoriesRequest) GetPageToken() string

func (*ListRegionalInventoriesRequest) GetParent 

func (x *ListRegionalInventoriesRequest) GetParent() string

func (*ListRegionalInventoriesRequest) ProtoMessage 

func (*ListRegionalInventoriesRequest) ProtoMessage()

func (*ListRegionalInventoriesRequest) ProtoReflect 

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

func (*ListRegionalInventoriesRequest) Reset 

func (x *ListRegionalInventoriesRequest) Reset()

func (*ListRegionalInventoriesRequest) String 

func (x *ListRegionalInventoriesRequest) String() string

type ListRegionalInventoriesResponse 

type ListRegionalInventoriesResponse struct {

	// The `RegionalInventory` resources for the given product from the specified
	// account.
	RegionalInventories []*RegionalInventory `protobuf:"bytes,1,rep,name=regional_inventories,json=regionalInventories,proto3" json:"regional_inventories,omitempty"`
	// A token, which can be sent as `pageToken` 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 `ListRegionalInventories` method.

func (*ListRegionalInventoriesResponse) Descriptor deprecated 

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

Deprecated: Use ListRegionalInventoriesResponse.ProtoReflect.Descriptor instead.

func (*ListRegionalInventoriesResponse) GetNextPageToken 

func (x *ListRegionalInventoriesResponse) GetNextPageToken() string

func (*ListRegionalInventoriesResponse) GetRegionalInventories 

func (x *ListRegionalInventoriesResponse) GetRegionalInventories() []*RegionalInventory

func (*ListRegionalInventoriesResponse) ProtoMessage 

func (*ListRegionalInventoriesResponse) ProtoMessage()

func (*ListRegionalInventoriesResponse) ProtoReflect 

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

func (*ListRegionalInventoriesResponse) Reset 

func (x *ListRegionalInventoriesResponse) Reset()

func (*ListRegionalInventoriesResponse) String 

func (x *ListRegionalInventoriesResponse) String() string

type LocalInventory 

type LocalInventory struct {

	// Output only. The name of the `LocalInventory` resource.
	// Format:
	// `accounts/{account}/products/{product}/localInventories/{store_code}`
	//
	// The `{product}` segment is a unique identifier for the product.
	// This identifier must be unique within a merchant account and generally
	// follows the structure: `content_language~feed_label~offer_id`. Example:
	// `en~US~sku123` For legacy local products, the structure is:
	// `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123`
	//
	// The format of the `{product}` segment in the URL is automatically detected
	// by the server, supporting two options:
	//
	//  1. **Encoded Format**: The `{product}` segment is an unpadded base64url
	//     encoded string (RFC 4648 Section 5). The decoded string must result
	//     in the `content_language~feed_label~offer_id` structure. This encoding
	//     MUST be used if any part of the product identifier (like `offer_id`)
	//     contains characters such as `/`, `%`, or `~`.
	//     *   Example: To represent the product ID `en~US~sku/123` for
	//     `store_code` "store123", the `{product}` segment must be the
	//     base64url encoding of this string, which is `ZW5-VVN-c2t1LzEyMw`.
	//     The full resource name for the local inventory would be
	//     `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123`.
	//
	//  2. **Plain Format**: The `{product}` segment is the tilde-separated string
	//     `content_language~feed_label~offer_id`. This format is suitable only
	//     when `content_language`, `feed_label`, and `offer_id` do not contain
	//     URL-problematic characters like `/`, `%`, or `~`.
	//
	// We recommend using the **Encoded Format** for all product IDs to ensure
	// correct parsing, especially those containing special characters. The
	// presence of tilde (`~`) characters in the `{product}` segment is used to
	// differentiate between the two formats.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The unpadded base64url encoded name of the `LocalInventory`
	// resource. Format:
	// `accounts/{account}/products/{product}/localInventories/{store_code}`
	// where the `{product}` segment is the unpadded base64url encoded value of
	// the identifier of the form `content_language~feed_label~offer_id`. Example:
	// `accounts/123/products/ZW5-VVN-c2t1LzEyMw/localInventories/store123` for
	// the decoded product ID `en~US~sku/123` and `store_code` "store123".
	// Can be used directly as input to the API methods that require the local
	// product identifier within the local inventory name to be encoded if it
	// contains special characters, for example
	// [`GetLocalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.localInventories/get).
	Base64EncodedName string `protobuf:"bytes,15,opt,name=base64_encoded_name,json=base64EncodedName,proto3" json:"base64_encoded_name,omitempty"`
	// Output only. The account that owns the product. This field will be ignored
	// if set by the client.
	Account int64 `protobuf:"varint,2,opt,name=account,proto3" json:"account,omitempty"`
	// Required. Immutable. Store code (the store ID from your Business Profile)
	// of the physical store the product is sold in. See the [Local product
	// inventory data
	// specification](https://support.google.com/merchants/answer/3061342) for
	// more information.
	StoreCode string `protobuf:"bytes,3,opt,name=store_code,json=storeCode,proto3" json:"store_code,omitempty"`
	// Optional. A list of local inventory attributes.
	LocalInventoryAttributes *LocalInventoryAttributes `` /* 136-byte string literal not displayed */
	// contains filtered or unexported fields
}

Local inventory information for the product. Represents in-store information for a specific product at the store specified by [`storeCode`][google.shopping.merchant.inventories.v1.LocalInventory.store_code]. For a list of all accepted attribute values, see the [local product inventory data specification](https://support.google.com/merchants/answer/3061342).

func (*LocalInventory) Descriptor deprecated 

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

Deprecated: Use LocalInventory.ProtoReflect.Descriptor instead.

func (*LocalInventory) GetAccount 

func (x *LocalInventory) GetAccount() int64

func (*LocalInventory) GetBase64EncodedName added in v1.10.0 

func (x *LocalInventory) GetBase64EncodedName() string

func (*LocalInventory) GetLocalInventoryAttributes 

func (x *LocalInventory) GetLocalInventoryAttributes() *LocalInventoryAttributes

func (*LocalInventory) GetName 

func (x *LocalInventory) GetName() string

func (*LocalInventory) GetStoreCode 

func (x *LocalInventory) GetStoreCode() string

func (*LocalInventory) ProtoMessage 

func (*LocalInventory) ProtoMessage()

func (*LocalInventory) ProtoReflect 

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

func (*LocalInventory) Reset 

func (x *LocalInventory) Reset()

func (*LocalInventory) String 

func (x *LocalInventory) String() string

type LocalInventoryAttributes 

type LocalInventoryAttributes struct {

	// Optional. Price of the product at this store.
	Price *typepb.Price `protobuf:"bytes,1,opt,name=price,proto3" json:"price,omitempty"`
	// Optional. Sale price of the product at this store. Mandatory if
	// [`salePriceEffectiveDate`][LocalInventory.sale_price_effective_date] is
	// defined.
	SalePrice *typepb.Price `protobuf:"bytes,2,opt,name=sale_price,json=salePrice,proto3" json:"sale_price,omitempty"`
	// Optional. The `TimePeriod` of the
	// sale at this store.
	SalePriceEffectiveDate *interval.Interval `` /* 131-byte string literal not displayed */
	// [Availability](https://support.google.com/merchants/answer/3061342) of the
	// product at this store.
	Availability *LocalInventoryAttributes_Availability `` /* 167-byte string literal not displayed */
	// Optional. Quantity of the product available at this store. Must be greater
	// than or equal to zero.
	Quantity *int64 `protobuf:"varint,5,opt,name=quantity,proto3,oneof" json:"quantity,omitempty"`
	// Optional. Supported [pickup
	// method](https://support.google.com/merchants/answer/3061342) for this
	// product. Unless the value is `"not supported"`, this field must be
	// submitted together with `pickupSla`.
	PickupMethod *LocalInventoryAttributes_PickupMethod `` /* 187-byte string literal not displayed */
	// Optional. Relative time period from the order date for an order for this
	// product, from this store, to be ready for pickup. Must be submitted with
	// `pickupMethod`. See more details
	// [here](https://support.google.com/merchants/answer/3061342).
	PickupSla *LocalInventoryAttributes_PickupSla `` /* 175-byte string literal not displayed */
	// Optional. Location of the product inside the store. Maximum length is 20
	// bytes.
	InstoreProductLocation *string `` /* 135-byte string literal not displayed */
	// Optional. An optional list of loyalty programs containing applicable
	// loyalty member prices for this product at this store.
	//
	// This field is used to show store-specific member prices on Local
	// Inventory Ads (LIA).
	//
	// To use this, the loyalty program must be configured in Google Merchant
	// Center. The benefits provided must match the merchant's website and be
	// clear to members. This is only applicable for merchants in supported
	// countries.
	//
	// See [Loyalty program](https://support.google.com/merchants/answer/12922446)
	// for details on supported countries and loyalty program configuration.
	// For local inventory specific details, see the [Local inventory data
	// specification](https://support.google.com/merchants/answer/3061342).
	LoyaltyPrograms []*InventoryLoyaltyProgram `protobuf:"bytes,10,rep,name=loyalty_programs,json=loyaltyPrograms,proto3" json:"loyalty_programs,omitempty"`
	// contains filtered or unexported fields
}

Local inventory attributes.

func (*LocalInventoryAttributes) Descriptor deprecated 

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

Deprecated: Use LocalInventoryAttributes.ProtoReflect.Descriptor instead.

func (*LocalInventoryAttributes) GetAvailability 

func (x *LocalInventoryAttributes) GetAvailability() LocalInventoryAttributes_Availability

func (*LocalInventoryAttributes) GetInstoreProductLocation 

func (x *LocalInventoryAttributes) GetInstoreProductLocation() string

func (*LocalInventoryAttributes) GetLoyaltyPrograms added in v1.10.0 

func (x *LocalInventoryAttributes) GetLoyaltyPrograms() []*InventoryLoyaltyProgram

func (*LocalInventoryAttributes) GetPickupMethod 

func (x *LocalInventoryAttributes) GetPickupMethod() LocalInventoryAttributes_PickupMethod

func (*LocalInventoryAttributes) GetPickupSla 

func (x *LocalInventoryAttributes) GetPickupSla() LocalInventoryAttributes_PickupSla

func (*LocalInventoryAttributes) GetPrice 

func (x *LocalInventoryAttributes) GetPrice() *typepb.Price

func (*LocalInventoryAttributes) GetQuantity 

func (x *LocalInventoryAttributes) GetQuantity() int64

func (*LocalInventoryAttributes) GetSalePrice 

func (x *LocalInventoryAttributes) GetSalePrice() *typepb.Price

func (*LocalInventoryAttributes) GetSalePriceEffectiveDate 

func (x *LocalInventoryAttributes) GetSalePriceEffectiveDate() *interval.Interval

func (*LocalInventoryAttributes) ProtoMessage 

func (*LocalInventoryAttributes) ProtoMessage()

func (*LocalInventoryAttributes) ProtoReflect 

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

func (*LocalInventoryAttributes) Reset 

func (x *LocalInventoryAttributes) Reset()

func (*LocalInventoryAttributes) String 

func (x *LocalInventoryAttributes) String() string

type LocalInventoryAttributes_Availability 

type LocalInventoryAttributes_Availability int32

[Availability](https://support.google.com/merchants/answer/3061342) of the product at this store. 

const (
	// Indicates that the availability is unspecified.
	LocalInventoryAttributes_LOCAL_INVENTORY_AVAILABILITY_UNSPECIFIED LocalInventoryAttributes_Availability = 0
	// Indicates that the product is in stock.
	LocalInventoryAttributes_IN_STOCK LocalInventoryAttributes_Availability = 1
	// Indicates that the product is out of stock.
	LocalInventoryAttributes_LIMITED_AVAILABILITY LocalInventoryAttributes_Availability = 2
	// Indicates that the product is on display to order.
	LocalInventoryAttributes_ON_DISPLAY_TO_ORDER LocalInventoryAttributes_Availability = 3
	// Indicates that the product is out of stock.
	LocalInventoryAttributes_OUT_OF_STOCK LocalInventoryAttributes_Availability = 4
)

func (LocalInventoryAttributes_Availability) Descriptor 

func (LocalInventoryAttributes_Availability) Descriptor() protoreflect.EnumDescriptor

func (LocalInventoryAttributes_Availability) Enum 

func (x LocalInventoryAttributes_Availability) Enum() *LocalInventoryAttributes_Availability

func (LocalInventoryAttributes_Availability) EnumDescriptor deprecated 

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

Deprecated: Use LocalInventoryAttributes_Availability.Descriptor instead.

func (LocalInventoryAttributes_Availability) Number 

func (x LocalInventoryAttributes_Availability) Number() protoreflect.EnumNumber

func (LocalInventoryAttributes_Availability) String 

func (x LocalInventoryAttributes_Availability) String() string

func (LocalInventoryAttributes_Availability) Type 

func (LocalInventoryAttributes_Availability) Type() protoreflect.EnumType

type LocalInventoryAttributes_PickupMethod 

type LocalInventoryAttributes_PickupMethod int32

Supported [pickup method](https://support.google.com/merchants/answer/3061342) for this product. Unless the value is `"not supported"`, this field must be submitted together with `pickupSla`. 

const (
	// Indicates that the pickup method is unspecified.
	LocalInventoryAttributes_PICKUP_METHOD_UNSPECIFIED LocalInventoryAttributes_PickupMethod = 0
	// Indicates that the pickup method is Buy.
	LocalInventoryAttributes_BUY LocalInventoryAttributes_PickupMethod = 1
	// Indicates that the pickup method is Reserve.
	LocalInventoryAttributes_RESERVE LocalInventoryAttributes_PickupMethod = 2
	// Indicates that the pickup method is Ship to store.
	LocalInventoryAttributes_SHIP_TO_STORE LocalInventoryAttributes_PickupMethod = 3
	// Indicates that the pickup method is not supported.
	LocalInventoryAttributes_NOT_SUPPORTED LocalInventoryAttributes_PickupMethod = 4
)

func (LocalInventoryAttributes_PickupMethod) Descriptor 

func (LocalInventoryAttributes_PickupMethod) Descriptor() protoreflect.EnumDescriptor

func (LocalInventoryAttributes_PickupMethod) Enum 

func (x LocalInventoryAttributes_PickupMethod) Enum() *LocalInventoryAttributes_PickupMethod

func (LocalInventoryAttributes_PickupMethod) EnumDescriptor deprecated 

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

Deprecated: Use LocalInventoryAttributes_PickupMethod.Descriptor instead.

func (LocalInventoryAttributes_PickupMethod) Number 

func (x LocalInventoryAttributes_PickupMethod) Number() protoreflect.EnumNumber

func (LocalInventoryAttributes_PickupMethod) String 

func (x LocalInventoryAttributes_PickupMethod) String() string

func (LocalInventoryAttributes_PickupMethod) Type 

func (LocalInventoryAttributes_PickupMethod) Type() protoreflect.EnumType

type LocalInventoryAttributes_PickupSla 

type LocalInventoryAttributes_PickupSla int32

Relative time period from the order date for an order for this product, from this store, to be ready for pickup. Must be submitted with `pickupMethod`. See more details [here](https://support.google.com/merchants/answer/3061342). 

const (
	// Indicates that the pickup SLA is unspecified.
	LocalInventoryAttributes_PICKUP_SLA_UNSPECIFIED LocalInventoryAttributes_PickupSla = 0
	// Indicates that the pickup SLA is same day.
	LocalInventoryAttributes_SAME_DAY LocalInventoryAttributes_PickupSla = 1
	// Indicates that the pickup SLA is next day.
	LocalInventoryAttributes_NEXT_DAY LocalInventoryAttributes_PickupSla = 2
	// Indicates that the pickup SLA is two days.
	LocalInventoryAttributes_TWO_DAY LocalInventoryAttributes_PickupSla = 3
	// Indicates that the pickup SLA is three days.
	LocalInventoryAttributes_THREE_DAY LocalInventoryAttributes_PickupSla = 4
	// Indicates that the pickup SLA is four days.
	LocalInventoryAttributes_FOUR_DAY LocalInventoryAttributes_PickupSla = 5
	// Indicates that the pickup SLA is five days.
	LocalInventoryAttributes_FIVE_DAY LocalInventoryAttributes_PickupSla = 6
	// Indicates that the pickup SLA is six days.
	LocalInventoryAttributes_SIX_DAY LocalInventoryAttributes_PickupSla = 7
	// Indicates that the pickup SLA is seven days.
	LocalInventoryAttributes_SEVEN_DAY LocalInventoryAttributes_PickupSla = 8
	// Indicates that the pickup SLA is multi-week.
	LocalInventoryAttributes_MULTI_WEEK LocalInventoryAttributes_PickupSla = 9
)

func (LocalInventoryAttributes_PickupSla) Descriptor 

func (LocalInventoryAttributes_PickupSla) Descriptor() protoreflect.EnumDescriptor

func (LocalInventoryAttributes_PickupSla) Enum 

func (x LocalInventoryAttributes_PickupSla) Enum() *LocalInventoryAttributes_PickupSla

func (LocalInventoryAttributes_PickupSla) EnumDescriptor deprecated 

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

Deprecated: Use LocalInventoryAttributes_PickupSla.Descriptor instead.

func (LocalInventoryAttributes_PickupSla) Number 

func (x LocalInventoryAttributes_PickupSla) Number() protoreflect.EnumNumber

func (LocalInventoryAttributes_PickupSla) String 

func (x LocalInventoryAttributes_PickupSla) String() string

func (LocalInventoryAttributes_PickupSla) Type 

func (LocalInventoryAttributes_PickupSla) Type() protoreflect.EnumType

type LocalInventoryServiceClient 

type LocalInventoryServiceClient interface {
	// Lists the `LocalInventory` resources for the given product in your merchant
	// account. The response might contain fewer items than specified by
	// `pageSize`. If `pageToken` was returned in previous request, it can be used
	// to obtain additional results.
	//
	// `LocalInventory` resources are listed per product for a given account.
	ListLocalInventories(ctx context.Context, in *ListLocalInventoriesRequest, opts ...grpc.CallOption) (*ListLocalInventoriesResponse, error)
	// Inserts a `LocalInventory` resource to a product in your merchant
	// account.
	//
	// Replaces the full `LocalInventory` resource if an entry with the same
	// [`storeCode`][google.shopping.merchant.inventories.v1.LocalInventory.store_code]
	// already exists for the product.
	//
	// It might take up to 30 minutes for the new or updated `LocalInventory`
	// resource to appear in products.
	InsertLocalInventory(ctx context.Context, in *InsertLocalInventoryRequest, opts ...grpc.CallOption) (*LocalInventory, error)
	// Deletes the specified `LocalInventory` from the given product in your
	// merchant account. It might take a up to an hour for the
	// `LocalInventory` to be deleted from the specific product.
	// Once you have received a successful delete response, wait for that
	// period before attempting a delete again.
	DeleteLocalInventory(ctx context.Context, in *DeleteLocalInventoryRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

LocalInventoryServiceClient is the client API for LocalInventoryService 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 NewLocalInventoryServiceClient 

func NewLocalInventoryServiceClient(cc grpc.ClientConnInterface) LocalInventoryServiceClient

type LocalInventoryServiceServer 

type LocalInventoryServiceServer interface {
	// Lists the `LocalInventory` resources for the given product in your merchant
	// account. The response might contain fewer items than specified by
	// `pageSize`. If `pageToken` was returned in previous request, it can be used
	// to obtain additional results.
	//
	// `LocalInventory` resources are listed per product for a given account.
	ListLocalInventories(context.Context, *ListLocalInventoriesRequest) (*ListLocalInventoriesResponse, error)
	// Inserts a `LocalInventory` resource to a product in your merchant
	// account.
	//
	// Replaces the full `LocalInventory` resource if an entry with the same
	// [`storeCode`][google.shopping.merchant.inventories.v1.LocalInventory.store_code]
	// already exists for the product.
	//
	// It might take up to 30 minutes for the new or updated `LocalInventory`
	// resource to appear in products.
	InsertLocalInventory(context.Context, *InsertLocalInventoryRequest) (*LocalInventory, error)
	// Deletes the specified `LocalInventory` from the given product in your
	// merchant account. It might take a up to an hour for the
	// `LocalInventory` to be deleted from the specific product.
	// Once you have received a successful delete response, wait for that
	// period before attempting a delete again.
	DeleteLocalInventory(context.Context, *DeleteLocalInventoryRequest) (*emptypb.Empty, error)
}

LocalInventoryServiceServer is the server API for LocalInventoryService service. All implementations should embed UnimplementedLocalInventoryServiceServer for forward compatibility

type RegionalInventory 

type RegionalInventory struct {

	// Output only. The name of the `RegionalInventory` resource.
	// Format:
	// `accounts/{account}/products/{product}/regionalInventories/{region}`
	//
	// The `{product}` segment is a unique identifier for the product.
	// This identifier must be unique within a merchant account and generally
	// follows the structure: `content_language~feed_label~offer_id`. Example:
	// `en~US~sku123` For legacy local products, the structure is:
	// `local~content_language~feed_label~offer_id`. Example: `local~en~US~sku123`
	//
	// The format of the `{product}` segment in the URL is automatically detected
	// by the server, supporting two options:
	//
	//  1. **Encoded Format**: The `{product}` segment is an
	//     **unpadded base64url** encoded string (RFC 4648 Section 5). The
	//     decoded string
	//     must result in the `content_language~feed_label~offer_id` structure.
	//     This encoding MUST be used if any part of the product identifier
	//     (like `offer_id`) contains characters such as `/`, `%`, or `~`.
	//     *   Example: To represent the product ID `en~US~sku/123` for
	//     `region` "region123", the `{product}` segment must be the
	//     unpadded base64url encoding of this string, which is
	//     `ZW5-VVN-c2t1LzEyMw`. The full resource name for the regional
	//     inventory would be
	//     `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123`.
	//
	//  2. **Plain Format**: The `{product}` segment is the tilde-separated string
	//     `content_language~feed_label~offer_id`. This format is suitable only
	//     when `content_language`, `feed_label`, and `offer_id` do not contain
	//     URL-problematic characters like `/`, `%`, or `~`.
	//
	// We recommend using the **Encoded Format** for all product IDs to ensure
	// correct parsing, especially those containing special characters. The
	// presence of tilde (`~`) characters in the `{product}` segment is used to
	// differentiate between the two formats.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The unpadded base64url encoded name of the `RegionalInventory`
	// resource. Format:
	// `accounts/{account}/products/{product}/regionalInventories/{region}`
	// where the `{product}` segment is the unpadded base64url encoded value of
	// the identifier of the form `content_language~feed_label~offer_id`. Example:
	// `accounts/123/products/ZW5-VVN-c2t1LzEyMw/regionalInventories/region123`
	// for the decoded product ID `en~US~sku/123` and `region` "region123".
	// Can be used directly as input to the API methods that require the product
	// identifier within the regional inventory name to be encoded if it contains
	// special characters, for example
	// [`GetRegionalInventory`](https://developers.google.com/merchant/api/reference/rest/inventories_v1/accounts.products.regionalInventories/get).
	Base64EncodedName string `protobuf:"bytes,10,opt,name=base64_encoded_name,json=base64EncodedName,proto3" json:"base64_encoded_name,omitempty"`
	// Output only. The account that owns the product. This field will be ignored
	// if set by the client.
	Account int64 `protobuf:"varint,2,opt,name=account,proto3" json:"account,omitempty"`
	// Required. Immutable. ID of the region for this
	// `RegionalInventory` resource. See the [Regional availability and
	// pricing](https://support.google.com/merchants/answer/9698880) for more
	// details.
	Region string `protobuf:"bytes,3,opt,name=region,proto3" json:"region,omitempty"`
	// Optional. A list of regional inventory attributes.
	RegionalInventoryAttributes *RegionalInventoryAttributes `` /* 144-byte string literal not displayed */
	// contains filtered or unexported fields
}

Regional inventory information for the product. Represents specific information like price and availability for a given product in a specific [`region`][google.shopping.merchant.inventories.v1.RegionalInventory.region]. For a list of all accepted attribute values, see the [regional product inventory data specification](https://support.google.com/merchants/answer/9698880).

func (*RegionalInventory) Descriptor deprecated 

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

Deprecated: Use RegionalInventory.ProtoReflect.Descriptor instead.

func (*RegionalInventory) GetAccount 

func (x *RegionalInventory) GetAccount() int64

func (*RegionalInventory) GetBase64EncodedName added in v1.10.0 

func (x *RegionalInventory) GetBase64EncodedName() string

func (*RegionalInventory) GetName 

func (x *RegionalInventory) GetName() string

func (*RegionalInventory) GetRegion 

func (x *RegionalInventory) GetRegion() string

func (*RegionalInventory) GetRegionalInventoryAttributes 

func (x *RegionalInventory) GetRegionalInventoryAttributes() *RegionalInventoryAttributes

func (*RegionalInventory) ProtoMessage 

func (*RegionalInventory) ProtoMessage()

func (*RegionalInventory) ProtoReflect 

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

func (*RegionalInventory) Reset 

func (x *RegionalInventory) Reset()

func (*RegionalInventory) String 

func (x *RegionalInventory) String() string

type RegionalInventoryAttributes 

type RegionalInventoryAttributes struct {

	// Optional. Price of the product in this region.
	Price *typepb.Price `protobuf:"bytes,1,opt,name=price,proto3" json:"price,omitempty"`
	// Optional. Sale price of the product in this region. Mandatory if
	// [`salePriceEffectiveDate`][RegionalInventory.sale_price_effective_date] is
	// defined.
	SalePrice *typepb.Price `protobuf:"bytes,2,opt,name=sale_price,json=salePrice,proto3" json:"sale_price,omitempty"`
	// Optional. The `TimePeriod` of the
	// sale price in this region.
	SalePriceEffectiveDate *interval.Interval `` /* 131-byte string literal not displayed */
	// Optional.
	// [Availability](https://support.google.com/merchants/answer/14644124) of the
	// product in this region.
	Availability *RegionalInventoryAttributes_Availability `` /* 170-byte string literal not displayed */
	// Optional. An optional list of loyalty programs containing applicable
	// loyalty member prices for this product in this region.
	//
	// This field is used to show region-specific member prices on Product
	// Listing Ads (PLA).
	//
	// To use this, the loyalty program must be configured in Google Merchant
	// Center, and the merchant must be using the Regional Availability and
	// Pricing (RAAP) feature. The benefits provided must match the merchant's
	// website and be clear to members. This is only applicable for merchants in
	// supported countries.
	//
	// See [Loyalty program](https://support.google.com/merchants/answer/12922446)
	// for details on supported countries and loyalty program configuration.
	// Also see [Regional availability and
	// pricing](https://support.google.com/merchants/answer/14644124) and [How to
	// set up regional member
	// pricing](https://support.google.com/merchants/answer/16388178) for more
	// information.
	LoyaltyPrograms []*InventoryLoyaltyProgram `protobuf:"bytes,5,rep,name=loyalty_programs,json=loyaltyPrograms,proto3" json:"loyalty_programs,omitempty"`
	// contains filtered or unexported fields
}

Regional inventory attributes.

func (*RegionalInventoryAttributes) Descriptor deprecated 

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

Deprecated: Use RegionalInventoryAttributes.ProtoReflect.Descriptor instead.

func (*RegionalInventoryAttributes) GetAvailability 

func (x *RegionalInventoryAttributes) GetAvailability() RegionalInventoryAttributes_Availability

func (*RegionalInventoryAttributes) GetLoyaltyPrograms added in v1.10.0 

func (x *RegionalInventoryAttributes) GetLoyaltyPrograms() []*InventoryLoyaltyProgram

func (*RegionalInventoryAttributes) GetPrice 

func (x *RegionalInventoryAttributes) GetPrice() *typepb.Price

func (*RegionalInventoryAttributes) GetSalePrice 

func (x *RegionalInventoryAttributes) GetSalePrice() *typepb.Price

func (*RegionalInventoryAttributes) GetSalePriceEffectiveDate 

func (x *RegionalInventoryAttributes) GetSalePriceEffectiveDate() *interval.Interval

func (*RegionalInventoryAttributes) ProtoMessage 

func (*RegionalInventoryAttributes) ProtoMessage()

func (*RegionalInventoryAttributes) ProtoReflect 

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

func (*RegionalInventoryAttributes) Reset 

func (x *RegionalInventoryAttributes) Reset()

func (*RegionalInventoryAttributes) String 

func (x *RegionalInventoryAttributes) String() string

type RegionalInventoryAttributes_Availability 

type RegionalInventoryAttributes_Availability int32

[Availability](https://support.google.com/merchants/answer/14644124) of the product in this region. 

const (
	// Indicates that the availability is unspecified.
	RegionalInventoryAttributes_REGIONAL_INVENTORY_AVAILABILITY_UNSPECIFIED RegionalInventoryAttributes_Availability = 0
	// Indicates that the product is in stock.
	RegionalInventoryAttributes_IN_STOCK RegionalInventoryAttributes_Availability = 1
	// Indicates that the product is out of stock.
	RegionalInventoryAttributes_OUT_OF_STOCK RegionalInventoryAttributes_Availability = 2
)

func (RegionalInventoryAttributes_Availability) Descriptor 

func (RegionalInventoryAttributes_Availability) Descriptor() protoreflect.EnumDescriptor

func (RegionalInventoryAttributes_Availability) Enum 

func (x RegionalInventoryAttributes_Availability) Enum() *RegionalInventoryAttributes_Availability

func (RegionalInventoryAttributes_Availability) EnumDescriptor deprecated 

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

Deprecated: Use RegionalInventoryAttributes_Availability.Descriptor instead.

func (RegionalInventoryAttributes_Availability) Number 

func (x RegionalInventoryAttributes_Availability) Number() protoreflect.EnumNumber

func (RegionalInventoryAttributes_Availability) String 

func (x RegionalInventoryAttributes_Availability) String() string

func (RegionalInventoryAttributes_Availability) Type 

func (RegionalInventoryAttributes_Availability) Type() protoreflect.EnumType

type RegionalInventoryServiceClient 

type RegionalInventoryServiceClient interface {
	// Lists the `RegionalInventory` resources for the given product in your
	// merchant account. The response might contain fewer items than specified by
	// `pageSize`.  If `pageToken` was returned in previous request, it can be
	// used to obtain additional results.
	//
	// `RegionalInventory` resources are listed per product for a given account.
	ListRegionalInventories(ctx context.Context, in *ListRegionalInventoriesRequest, opts ...grpc.CallOption) (*ListRegionalInventoriesResponse, error)
	// Inserts a `RegionalInventory` to a given product in your
	// merchant account.
	//
	// Replaces the full `RegionalInventory` resource if an entry with the same
	// [`region`][google.shopping.merchant.inventories.v1.RegionalInventory.region]
	// already exists for the product.
	//
	// It might take up to 30 minutes for the new or updated `RegionalInventory`
	// resource to appear in products.
	InsertRegionalInventory(ctx context.Context, in *InsertRegionalInventoryRequest, opts ...grpc.CallOption) (*RegionalInventory, error)
	// Deletes the specified `RegionalInventory` resource from the given product
	// in your merchant account.  It might take up to an hour for the
	// `RegionalInventory` to be deleted from the specific product.
	// Once you have received a successful delete response, wait for that
	// period before attempting a delete again.
	DeleteRegionalInventory(ctx context.Context, in *DeleteRegionalInventoryRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

RegionalInventoryServiceClient is the client API for RegionalInventoryService 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 NewRegionalInventoryServiceClient 

func NewRegionalInventoryServiceClient(cc grpc.ClientConnInterface) RegionalInventoryServiceClient

type RegionalInventoryServiceServer 

type RegionalInventoryServiceServer interface {
	// Lists the `RegionalInventory` resources for the given product in your
	// merchant account. The response might contain fewer items than specified by
	// `pageSize`.  If `pageToken` was returned in previous request, it can be
	// used to obtain additional results.
	//
	// `RegionalInventory` resources are listed per product for a given account.
	ListRegionalInventories(context.Context, *ListRegionalInventoriesRequest) (*ListRegionalInventoriesResponse, error)
	// Inserts a `RegionalInventory` to a given product in your
	// merchant account.
	//
	// Replaces the full `RegionalInventory` resource if an entry with the same
	// [`region`][google.shopping.merchant.inventories.v1.RegionalInventory.region]
	// already exists for the product.
	//
	// It might take up to 30 minutes for the new or updated `RegionalInventory`
	// resource to appear in products.
	InsertRegionalInventory(context.Context, *InsertRegionalInventoryRequest) (*RegionalInventory, error)
	// Deletes the specified `RegionalInventory` resource from the given product
	// in your merchant account.  It might take up to an hour for the
	// `RegionalInventory` to be deleted from the specific product.
	// Once you have received a successful delete response, wait for that
	// period before attempting a delete again.
	DeleteRegionalInventory(context.Context, *DeleteRegionalInventoryRequest) (*emptypb.Empty, error)
}

RegionalInventoryServiceServer is the server API for RegionalInventoryService service. All implementations should embed UnimplementedRegionalInventoryServiceServer for forward compatibility

type UnimplementedLocalInventoryServiceServer 

type UnimplementedLocalInventoryServiceServer struct {
}

UnimplementedLocalInventoryServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedLocalInventoryServiceServer) DeleteLocalInventory 

func (UnimplementedLocalInventoryServiceServer) DeleteLocalInventory(context.Context, *DeleteLocalInventoryRequest) (*emptypb.Empty, error)

func (UnimplementedLocalInventoryServiceServer) InsertLocalInventory 

func (UnimplementedLocalInventoryServiceServer) InsertLocalInventory(context.Context, *InsertLocalInventoryRequest) (*LocalInventory, error)

func (UnimplementedLocalInventoryServiceServer) ListLocalInventories 

func (UnimplementedLocalInventoryServiceServer) ListLocalInventories(context.Context, *ListLocalInventoriesRequest) (*ListLocalInventoriesResponse, error)

type UnimplementedRegionalInventoryServiceServer 

type UnimplementedRegionalInventoryServiceServer struct {
}

UnimplementedRegionalInventoryServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedRegionalInventoryServiceServer) DeleteRegionalInventory 

func (UnimplementedRegionalInventoryServiceServer) DeleteRegionalInventory(context.Context, *DeleteRegionalInventoryRequest) (*emptypb.Empty, error)

func (UnimplementedRegionalInventoryServiceServer) InsertRegionalInventory 

func (UnimplementedRegionalInventoryServiceServer) InsertRegionalInventory(context.Context, *InsertRegionalInventoryRequest) (*RegionalInventory, error)

func (UnimplementedRegionalInventoryServiceServer) ListRegionalInventories 

func (UnimplementedRegionalInventoryServiceServer) ListRegionalInventories(context.Context, *ListRegionalInventoriesRequest) (*ListRegionalInventoriesResponse, error)

type UnsafeLocalInventoryServiceServer added in v1.2.1 

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

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

type UnsafeRegionalInventoryServiceServer added in v1.2.1 

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

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

Source Files

View all Source files

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.