Variables
OrderTrackingSignal_ShippingInfo_ShippingState_name, OrderTrackingSignal_ShippingInfo_ShippingState_value
var (
OrderTrackingSignal_ShippingInfo_ShippingState_name = map[int32]string{
0: "SHIPPING_STATE_UNSPECIFIED",
1: "SHIPPED",
2: "DELIVERED",
}
OrderTrackingSignal_ShippingInfo_ShippingState_value = map[string]int32{
"SHIPPING_STATE_UNSPECIFIED": 0,
"SHIPPED": 1,
"DELIVERED": 2,
}
)Enum value maps for OrderTrackingSignal_ShippingInfo_ShippingState.
File_google_shopping_merchant_ordertracking_v1_order_tracking_signals_proto
var File_google_shopping_merchant_ordertracking_v1_order_tracking_signals_proto protoreflect.FileDescriptorFunctions
func RegisterOrderTrackingSignalsServiceServer
func RegisterOrderTrackingSignalsServiceServer(s *grpc.Server, srv OrderTrackingSignalsServiceServer)CreateOrderTrackingSignalRequest
type CreateOrderTrackingSignalRequest struct {
// Required. The account of the business for which the order signal is
// created. Format: accounts/{account}
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Output only. The ID that uniquely identifies this order tracking signal.
OrderTrackingSignalId string `protobuf:"bytes,2,opt,name=order_tracking_signal_id,json=orderTrackingSignalId,proto3" json:"order_tracking_signal_id,omitempty"`
// Required. The order signal to be created.
OrderTrackingSignal *OrderTrackingSignal `protobuf:"bytes,3,opt,name=order_tracking_signal,json=orderTrackingSignal,proto3" json:"order_tracking_signal,omitempty"`
// contains filtered or unexported fields
}Signals only can be created but not updated. Businesses need to call this API only when the order is completely shipped. Creates new order signal.
func (*CreateOrderTrackingSignalRequest) Descriptor
func (*CreateOrderTrackingSignalRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateOrderTrackingSignalRequest.ProtoReflect.Descriptor instead.
func (*CreateOrderTrackingSignalRequest) GetOrderTrackingSignal
func (x *CreateOrderTrackingSignalRequest) GetOrderTrackingSignal() *OrderTrackingSignalfunc (*CreateOrderTrackingSignalRequest) GetOrderTrackingSignalId
func (x *CreateOrderTrackingSignalRequest) GetOrderTrackingSignalId() stringfunc (*CreateOrderTrackingSignalRequest) GetParent
func (x *CreateOrderTrackingSignalRequest) GetParent() stringfunc (*CreateOrderTrackingSignalRequest) ProtoMessage
func (*CreateOrderTrackingSignalRequest) ProtoMessage()func (*CreateOrderTrackingSignalRequest) ProtoReflect
func (x *CreateOrderTrackingSignalRequest) ProtoReflect() protoreflect.Messagefunc (*CreateOrderTrackingSignalRequest) Reset
func (x *CreateOrderTrackingSignalRequest) Reset()func (*CreateOrderTrackingSignalRequest) String
func (x *CreateOrderTrackingSignalRequest) String() stringOrderTrackingSignal
type OrderTrackingSignal struct {
// Output only. The ID that uniquely identifies this order tracking signal.
OrderTrackingSignalId int64 `protobuf:"varint,11,opt,name=order_tracking_signal_id,json=orderTrackingSignalId,proto3" json:"order_tracking_signal_id,omitempty"`
// Optional. The Google Merchant Center ID of this order tracking signal. This
// value is optional. If left unset, the caller's Merchant Center ID is used.
// You must request access in order to provide data on behalf of another
// business. For more information, see [Submitting Order Tracking
// Signals](/shopping-content/guides/order-tracking-signals).
MerchantId int64 `protobuf:"varint,12,opt,name=merchant_id,json=merchantId,proto3" json:"merchant_id,omitempty"`
// Required. The time when the order was created on the businesses side.
// Include the year and timezone string, if available.
OrderCreatedTime *datetime.DateTime `protobuf:"bytes,1,opt,name=order_created_time,json=orderCreatedTime,proto3" json:"order_created_time,omitempty"`
// Required. The ID of the order on the businesses side. This field will be
// hashed in returned OrderTrackingSignal creation response.
OrderId string `protobuf:"bytes,2,opt,name=order_id,json=orderId,proto3" json:"order_id,omitempty"`
// Required. The shipping information for the order.
ShippingInfo []*OrderTrackingSignal_ShippingInfo `protobuf:"bytes,3,rep,name=shipping_info,json=shippingInfo,proto3" json:"shipping_info,omitempty"`
// Required. Information about line items in the order.
LineItems []*OrderTrackingSignal_LineItemDetails `protobuf:"bytes,4,rep,name=line_items,json=lineItems,proto3" json:"line_items,omitempty"`
// Optional. The mapping of the line items to the shipment information.
ShipmentLineItemMapping []*OrderTrackingSignal_ShipmentLineItemMapping `protobuf:"bytes,5,rep,name=shipment_line_item_mapping,json=shipmentLineItemMapping,proto3" json:"shipment_line_item_mapping,omitempty"`
// Optional. The shipping fee of the order;
// this value should be set to zero in the case of free shipping.
CustomerShippingFee *typepb.Price `protobuf:"bytes,6,opt,name=customer_shipping_fee,json=customerShippingFee,proto3,oneof" json:"customer_shipping_fee,omitempty"`
// Optional. The delivery postal code, as a continuous string without spaces
// or dashes, for example "95016". This field will be anonymized in returned
// OrderTrackingSignal creation response.
DeliveryPostalCode string `protobuf:"bytes,9,opt,name=delivery_postal_code,json=deliveryPostalCode,proto3" json:"delivery_postal_code,omitempty"`
// Optional. The [CLDR territory code]
// (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for
// the shipping destination.
DeliveryRegionCode string `protobuf:"bytes,10,opt,name=delivery_region_code,json=deliveryRegionCode,proto3" json:"delivery_region_code,omitempty"`
// contains filtered or unexported fields
}Represents a business trade from which signals are extracted, such as shipping.
func (*OrderTrackingSignal) Descriptor
func (*OrderTrackingSignal) Descriptor() ([]byte, []int)Deprecated: Use OrderTrackingSignal.ProtoReflect.Descriptor instead.
func (*OrderTrackingSignal) GetCustomerShippingFee
func (x *OrderTrackingSignal) GetCustomerShippingFee() *typepb.Pricefunc (*OrderTrackingSignal) GetDeliveryPostalCode
func (x *OrderTrackingSignal) GetDeliveryPostalCode() stringfunc (*OrderTrackingSignal) GetDeliveryRegionCode
func (x *OrderTrackingSignal) GetDeliveryRegionCode() stringfunc (*OrderTrackingSignal) GetLineItems
func (x *OrderTrackingSignal) GetLineItems() []*OrderTrackingSignal_LineItemDetailsfunc (*OrderTrackingSignal) GetMerchantId
func (x *OrderTrackingSignal) GetMerchantId() int64func (*OrderTrackingSignal) GetOrderCreatedTime
func (x *OrderTrackingSignal) GetOrderCreatedTime() *datetime.DateTimefunc (*OrderTrackingSignal) GetOrderId
func (x *OrderTrackingSignal) GetOrderId() stringfunc (*OrderTrackingSignal) GetOrderTrackingSignalId
func (x *OrderTrackingSignal) GetOrderTrackingSignalId() int64func (*OrderTrackingSignal) GetShipmentLineItemMapping
func (x *OrderTrackingSignal) GetShipmentLineItemMapping() []*OrderTrackingSignal_ShipmentLineItemMappingfunc (*OrderTrackingSignal) GetShippingInfo
func (x *OrderTrackingSignal) GetShippingInfo() []*OrderTrackingSignal_ShippingInfofunc (*OrderTrackingSignal) ProtoMessage
func (*OrderTrackingSignal) ProtoMessage()func (*OrderTrackingSignal) ProtoReflect
func (x *OrderTrackingSignal) ProtoReflect() protoreflect.Messagefunc (*OrderTrackingSignal) Reset
func (x *OrderTrackingSignal) Reset()func (*OrderTrackingSignal) String
func (x *OrderTrackingSignal) String() stringOrderTrackingSignal_LineItemDetails
type OrderTrackingSignal_LineItemDetails struct {
// Required. The ID for this line item.
LineItemId string `protobuf:"bytes,1,opt,name=line_item_id,json=lineItemId,proto3" json:"line_item_id,omitempty"`
// Required. The Content API REST ID of the product, in the
// form channel:contentLanguage:targetCountry:offerId.
ProductId string `protobuf:"bytes,2,opt,name=product_id,json=productId,proto3" json:"product_id,omitempty"`
// Optional. The Global Trade Item Numbers.
Gtins []string `protobuf:"bytes,8,rep,name=gtins,proto3" json:"gtins,omitempty"`
// Optional. The manufacturer part number.
Mpn string `protobuf:"bytes,4,opt,name=mpn,proto3" json:"mpn,omitempty"`
// Optional. Plain text title of this product.
ProductTitle *string `protobuf:"bytes,5,opt,name=product_title,json=productTitle,proto3,oneof" json:"product_title,omitempty"`
// Optional. Brand of the product.
Brand *string `protobuf:"bytes,6,opt,name=brand,proto3,oneof" json:"brand,omitempty"`
// Required. The quantity of the line item in the order.
Quantity int64 `protobuf:"varint,7,opt,name=quantity,proto3" json:"quantity,omitempty"`
// contains filtered or unexported fields
}The line items of the order.
func (*OrderTrackingSignal_LineItemDetails) Descriptor
func (*OrderTrackingSignal_LineItemDetails) Descriptor() ([]byte, []int)Deprecated: Use OrderTrackingSignal_LineItemDetails.ProtoReflect.Descriptor instead.
func (*OrderTrackingSignal_LineItemDetails) GetBrand
func (x *OrderTrackingSignal_LineItemDetails) GetBrand() stringfunc (*OrderTrackingSignal_LineItemDetails) GetGtins
func (x *OrderTrackingSignal_LineItemDetails) GetGtins() []stringfunc (*OrderTrackingSignal_LineItemDetails) GetLineItemId
func (x *OrderTrackingSignal_LineItemDetails) GetLineItemId() stringfunc (*OrderTrackingSignal_LineItemDetails) GetMpn
func (x *OrderTrackingSignal_LineItemDetails) GetMpn() stringfunc (*OrderTrackingSignal_LineItemDetails) GetProductId
func (x *OrderTrackingSignal_LineItemDetails) GetProductId() stringfunc (*OrderTrackingSignal_LineItemDetails) GetProductTitle
func (x *OrderTrackingSignal_LineItemDetails) GetProductTitle() stringfunc (*OrderTrackingSignal_LineItemDetails) GetQuantity
func (x *OrderTrackingSignal_LineItemDetails) GetQuantity() int64func (*OrderTrackingSignal_LineItemDetails) ProtoMessage
func (*OrderTrackingSignal_LineItemDetails) ProtoMessage()func (*OrderTrackingSignal_LineItemDetails) ProtoReflect
func (x *OrderTrackingSignal_LineItemDetails) ProtoReflect() protoreflect.Messagefunc (*OrderTrackingSignal_LineItemDetails) Reset
func (x *OrderTrackingSignal_LineItemDetails) Reset()func (*OrderTrackingSignal_LineItemDetails) String
func (x *OrderTrackingSignal_LineItemDetails) String() stringOrderTrackingSignal_ShipmentLineItemMapping
type OrderTrackingSignal_ShipmentLineItemMapping struct {
// Required. The shipment ID. This field will be hashed in returned
// OrderTrackingSignal creation response.
ShipmentId string `protobuf:"bytes,1,opt,name=shipment_id,json=shipmentId,proto3" json:"shipment_id,omitempty"`
// Required. The line item ID.
LineItemId string `protobuf:"bytes,2,opt,name=line_item_id,json=lineItemId,proto3" json:"line_item_id,omitempty"`
// Required. The line item quantity in the shipment.
Quantity int64 `protobuf:"varint,3,opt,name=quantity,proto3" json:"quantity,omitempty"`
// contains filtered or unexported fields
}Represents how many items are in the shipment for the given shipment_id and line_item_id.
func (*OrderTrackingSignal_ShipmentLineItemMapping) Descriptor
func (*OrderTrackingSignal_ShipmentLineItemMapping) Descriptor() ([]byte, []int)Deprecated: Use OrderTrackingSignal_ShipmentLineItemMapping.ProtoReflect.Descriptor instead.
func (*OrderTrackingSignal_ShipmentLineItemMapping) GetLineItemId
func (x *OrderTrackingSignal_ShipmentLineItemMapping) GetLineItemId() stringfunc (*OrderTrackingSignal_ShipmentLineItemMapping) GetQuantity
func (x *OrderTrackingSignal_ShipmentLineItemMapping) GetQuantity() int64func (*OrderTrackingSignal_ShipmentLineItemMapping) GetShipmentId
func (x *OrderTrackingSignal_ShipmentLineItemMapping) GetShipmentId() stringfunc (*OrderTrackingSignal_ShipmentLineItemMapping) ProtoMessage
func (*OrderTrackingSignal_ShipmentLineItemMapping) ProtoMessage()func (*OrderTrackingSignal_ShipmentLineItemMapping) ProtoReflect
func (x *OrderTrackingSignal_ShipmentLineItemMapping) ProtoReflect() protoreflect.Messagefunc (*OrderTrackingSignal_ShipmentLineItemMapping) Reset
func (x *OrderTrackingSignal_ShipmentLineItemMapping) Reset()func (*OrderTrackingSignal_ShipmentLineItemMapping) String
func (x *OrderTrackingSignal_ShipmentLineItemMapping) String() stringOrderTrackingSignal_ShippingInfo
type OrderTrackingSignal_ShippingInfo struct {
// Required. The shipment ID. This field will be hashed in returned
// OrderTrackingSignal creation response.
ShipmentId string `protobuf:"bytes,1,opt,name=shipment_id,json=shipmentId,proto3" json:"shipment_id,omitempty"`
// Optional. The tracking ID of the shipment. This field is required if one
// of the following fields is absent: earliest_delivery_promise_time,
// latest_delivery_promise_time, and actual_delivery_time.
TrackingId string `protobuf:"bytes,2,opt,name=tracking_id,json=trackingId,proto3" json:"tracking_id,omitempty"`
// Optional. The name of the shipping carrier for the delivery. This field
// is required if one of the following fields is absent:
// earliest_delivery_promise_time, latest_delivery_promise_time,
// and actual_delivery_time.
Carrier string `protobuf:"bytes,3,opt,name=carrier,proto3" json:"carrier,omitempty"`
// Optional. The service type for fulfillment, such as GROUND, FIRST_CLASS,
// etc.
CarrierService string `protobuf:"bytes,4,opt,name=carrier_service,json=carrierService,proto3" json:"carrier_service,omitempty"`
// Optional. The time when the shipment was shipped.
// Include the year and timezone string, if available.
ShippedTime *datetime.DateTime `protobuf:"bytes,5,opt,name=shipped_time,json=shippedTime,proto3" json:"shipped_time,omitempty"`
// Optional. The earliest delivery promised time.
// Include the year and timezone string, if available.
// This field is required, if one of the following fields is absent:
// tracking_id or carrier_name.
EarliestDeliveryPromiseTime *datetime.DateTime `protobuf:"bytes,6,opt,name=earliest_delivery_promise_time,json=earliestDeliveryPromiseTime,proto3" json:"earliest_delivery_promise_time,omitempty"`
// Optional. The latest delivery promised time.
// Include the year and timezone string, if available.
// This field is required, if one of the following fields is absent:
// tracking_id or carrier_name.
LatestDeliveryPromiseTime *datetime.DateTime `protobuf:"bytes,7,opt,name=latest_delivery_promise_time,json=latestDeliveryPromiseTime,proto3" json:"latest_delivery_promise_time,omitempty"`
// Optional. The time when the shipment was actually delivered.
// Include the year and timezone string, if available.
// This field is required, if one of the following fields is absent:
// tracking_id or carrier_name.
ActualDeliveryTime *datetime.DateTime `protobuf:"bytes,8,opt,name=actual_delivery_time,json=actualDeliveryTime,proto3" json:"actual_delivery_time,omitempty"`
// Required. The status of the shipment.
ShippingStatus OrderTrackingSignal_ShippingInfo_ShippingState `protobuf:"varint,9,opt,name=shipping_status,json=shippingStatus,proto3,enum=google.shopping.merchant.ordertracking.v1.OrderTrackingSignal_ShippingInfo_ShippingState" json:"shipping_status,omitempty"`
// Required. The origin postal code, as a continuous string without spaces
// or dashes, for example "95016". This field will be anonymized in returned
// OrderTrackingSignal creation response.
OriginPostalCode string `protobuf:"bytes,10,opt,name=origin_postal_code,json=originPostalCode,proto3" json:"origin_postal_code,omitempty"`
// Required. The [CLDR territory code]
// (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for
// the shipping origin.
OriginRegionCode string `protobuf:"bytes,11,opt,name=origin_region_code,json=originRegionCode,proto3" json:"origin_region_code,omitempty"`
// contains filtered or unexported fields
}The shipping information for the order.
func (*OrderTrackingSignal_ShippingInfo) Descriptor
func (*OrderTrackingSignal_ShippingInfo) Descriptor() ([]byte, []int)Deprecated: Use OrderTrackingSignal_ShippingInfo.ProtoReflect.Descriptor instead.
func (*OrderTrackingSignal_ShippingInfo) GetActualDeliveryTime
func (x *OrderTrackingSignal_ShippingInfo) GetActualDeliveryTime() *datetime.DateTimefunc (*OrderTrackingSignal_ShippingInfo) GetCarrier
func (x *OrderTrackingSignal_ShippingInfo) GetCarrier() stringfunc (*OrderTrackingSignal_ShippingInfo) GetCarrierService
func (x *OrderTrackingSignal_ShippingInfo) GetCarrierService() stringfunc (*OrderTrackingSignal_ShippingInfo) GetEarliestDeliveryPromiseTime
func (x *OrderTrackingSignal_ShippingInfo) GetEarliestDeliveryPromiseTime() *datetime.DateTimefunc (*OrderTrackingSignal_ShippingInfo) GetLatestDeliveryPromiseTime
func (x *OrderTrackingSignal_ShippingInfo) GetLatestDeliveryPromiseTime() *datetime.DateTimefunc (*OrderTrackingSignal_ShippingInfo) GetOriginPostalCode
func (x *OrderTrackingSignal_ShippingInfo) GetOriginPostalCode() stringfunc (*OrderTrackingSignal_ShippingInfo) GetOriginRegionCode
func (x *OrderTrackingSignal_ShippingInfo) GetOriginRegionCode() stringfunc (*OrderTrackingSignal_ShippingInfo) GetShipmentId
func (x *OrderTrackingSignal_ShippingInfo) GetShipmentId() stringfunc (*OrderTrackingSignal_ShippingInfo) GetShippedTime
func (x *OrderTrackingSignal_ShippingInfo) GetShippedTime() *datetime.DateTimefunc (*OrderTrackingSignal_ShippingInfo) GetShippingStatus
func (x *OrderTrackingSignal_ShippingInfo) GetShippingStatus() OrderTrackingSignal_ShippingInfo_ShippingStatefunc (*OrderTrackingSignal_ShippingInfo) GetTrackingId
func (x *OrderTrackingSignal_ShippingInfo) GetTrackingId() stringfunc (*OrderTrackingSignal_ShippingInfo) ProtoMessage
func (*OrderTrackingSignal_ShippingInfo) ProtoMessage()func (*OrderTrackingSignal_ShippingInfo) ProtoReflect
func (x *OrderTrackingSignal_ShippingInfo) ProtoReflect() protoreflect.Messagefunc (*OrderTrackingSignal_ShippingInfo) Reset
func (x *OrderTrackingSignal_ShippingInfo) Reset()func (*OrderTrackingSignal_ShippingInfo) String
func (x *OrderTrackingSignal_ShippingInfo) String() stringOrderTrackingSignal_ShippingInfo_ShippingState
type OrderTrackingSignal_ShippingInfo_ShippingState int32The current status of the shipments.
OrderTrackingSignal_ShippingInfo_SHIPPING_STATE_UNSPECIFIED, OrderTrackingSignal_ShippingInfo_SHIPPED, OrderTrackingSignal_ShippingInfo_DELIVERED
const (
// The shipping status is not known to business.
OrderTrackingSignal_ShippingInfo_SHIPPING_STATE_UNSPECIFIED OrderTrackingSignal_ShippingInfo_ShippingState = 0
// All items are shipped.
OrderTrackingSignal_ShippingInfo_SHIPPED OrderTrackingSignal_ShippingInfo_ShippingState = 1
// The shipment is already delivered.
OrderTrackingSignal_ShippingInfo_DELIVERED OrderTrackingSignal_ShippingInfo_ShippingState = 2
)func (OrderTrackingSignal_ShippingInfo_ShippingState) Descriptor
func (OrderTrackingSignal_ShippingInfo_ShippingState) Descriptor() protoreflect.EnumDescriptorfunc (OrderTrackingSignal_ShippingInfo_ShippingState) Enum
func (x OrderTrackingSignal_ShippingInfo_ShippingState) Enum() *OrderTrackingSignal_ShippingInfo_ShippingStatefunc (OrderTrackingSignal_ShippingInfo_ShippingState) EnumDescriptor
func (OrderTrackingSignal_ShippingInfo_ShippingState) EnumDescriptor() ([]byte, []int)Deprecated: Use OrderTrackingSignal_ShippingInfo_ShippingState.Descriptor instead.
func (OrderTrackingSignal_ShippingInfo_ShippingState) Number
func (x OrderTrackingSignal_ShippingInfo_ShippingState) Number() protoreflect.EnumNumberfunc (OrderTrackingSignal_ShippingInfo_ShippingState) String
func (x OrderTrackingSignal_ShippingInfo_ShippingState) String() stringfunc (OrderTrackingSignal_ShippingInfo_ShippingState) Type
OrderTrackingSignalsServiceClient
type OrderTrackingSignalsServiceClient interface {
// Creates new order tracking signal.
CreateOrderTrackingSignal(ctx context.Context, in *CreateOrderTrackingSignalRequest, opts ...grpc.CallOption) (*OrderTrackingSignal, error)
}OrderTrackingSignalsServiceClient is the client API for OrderTrackingSignalsService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewOrderTrackingSignalsServiceClient
func NewOrderTrackingSignalsServiceClient(cc grpc.ClientConnInterface) OrderTrackingSignalsServiceClientOrderTrackingSignalsServiceServer
type OrderTrackingSignalsServiceServer interface {
// Creates new order tracking signal.
CreateOrderTrackingSignal(context.Context, *CreateOrderTrackingSignalRequest) (*OrderTrackingSignal, error)
}OrderTrackingSignalsServiceServer is the server API for OrderTrackingSignalsService service.
UnimplementedOrderTrackingSignalsServiceServer
type UnimplementedOrderTrackingSignalsServiceServer struct {
}UnimplementedOrderTrackingSignalsServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedOrderTrackingSignalsServiceServer) CreateOrderTrackingSignal
func (*UnimplementedOrderTrackingSignalsServiceServer) CreateOrderTrackingSignal(context.Context, *CreateOrderTrackingSignalRequest) (*OrderTrackingSignal, error)