Google Shopping Merchant Order Tracking V1beta Client - Class OrderTrackingSignal (0.1.1)

Reference documentation and code samples for the Google Shopping Merchant Order Tracking V1beta Client class OrderTrackingSignal.

Represents a business trade from which signals are extracted, such as shipping.

Generated from protobuf message google.shopping.merchant.ordertracking.v1beta.OrderTrackingSignal

Namespace

Google \ Shopping \ Merchant \ OrderTracking \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ order_tracking_signal_id`	`int\|string` Output only. The ID that uniquely identifies this order tracking signal.
`↳ merchant_id`	`int\|string` 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.
`↳ order_created_time`	`Google\Type\DateTime` Required. The time when the order was created on the businesses side. Include the year and timezone string, if available.
`↳ order_id`	`string` Required. The ID of the order on the businesses side. This field will be hashed in returned OrderTrackingSignal creation response.
`↳ shipping_info`	`array<OrderTrackingSignal\ShippingInfo>` Required. The shipping information for the order.
`↳ line_items`	`array<OrderTrackingSignal\LineItemDetails>` Required. Information about line items in the order.
`↳ shipment_line_item_mapping`	`array<OrderTrackingSignal\ShipmentLineItemMapping>` Optional. The mapping of the line items to the shipment information.
`↳ customer_shipping_fee`	`Google\Shopping\Type\Price` Optional. The shipping fee of the order; this value should be set to zero in the case of free shipping.
`↳ delivery_postal_code`	`string` 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.
`↳ delivery_region_code`	`string` Optional. The CLDR territory code for the shipping destination.

getOrderTrackingSignalId

Output only. The ID that uniquely identifies this order tracking signal.

Returns
Type	Description
`int\|string`

setOrderTrackingSignalId

Output only. The ID that uniquely identifies this order tracking signal.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getMerchantId

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.

Returns
Type	Description
`int\|string`

setMerchantId

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.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getOrderCreatedTime

Required. The time when the order was created on the businesses side.

Include the year and timezone string, if available.

Returns
Type	Description
`Google\Type\DateTime\|null`

hasOrderCreatedTime

clearOrderCreatedTime

setOrderCreatedTime

Required. The time when the order was created on the businesses side.

Include the year and timezone string, if available.

Parameter
Name	Description
`var`	`Google\Type\DateTime`

Returns
Type	Description
`$this`

getOrderId

Required. The ID of the order on the businesses side. This field will be hashed in returned OrderTrackingSignal creation response.

Returns
Type	Description
`string`

setOrderId

Required. The ID of the order on the businesses side. This field will be hashed in returned OrderTrackingSignal creation response.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getShippingInfo

Required. The shipping information for the order.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setShippingInfo

Required. The shipping information for the order.

Parameter
Name	Description
`var`	`array<OrderTrackingSignal\ShippingInfo>`

Returns
Type	Description
`$this`

getLineItems

Required. Information about line items in the order.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setLineItems

Required. Information about line items in the order.

Parameter
Name	Description
`var`	`array<OrderTrackingSignal\LineItemDetails>`

Returns
Type	Description
`$this`

getShipmentLineItemMapping

Optional. The mapping of the line items to the shipment information.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setShipmentLineItemMapping