Google Shopping Merchant Products V1beta Client - Class UpdateProductInputRequest (0.4.0)

Reference documentation and code samples for the Google Shopping Merchant Products V1beta Client class UpdateProductInputRequest.

Request message for the UpdateProductInput method.

The product (primary input) must exist for the update to succeed. If the update is for a primary product input, the existing primary product input must be from the same data source.

Generated from protobuf message google.shopping.merchant.products.v1beta.UpdateProductInputRequest

Namespace

Google \ Shopping \ Merchant \ Products \ V1beta

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ product_input ProductInput

Required. The product input resource to update. Information you submit will be applied to the processed product as well.
↳ update_mask Google\Protobuf\FieldMask

Optional. The list of product attributes to be updated. If the update mask is omitted, then it is treated as implied field mask equivalent to all fields that are populated (have a non-empty value). Attributes specified in the update mask without a value specified in the body will be deleted from the product. Update mask can only be specified for top level fields in attributes and custom attributes. To specify the update mask for custom attributes you need to add the custom_attribute. prefix. Providing special "*" value for full product replacement is not supported.
↳ data_source string

Required. The primary or supplemental product data source where data_source name identifies the product input to be updated. Only API data sources are supported. Format: accounts/{account}/dataSources/{datasource}.

getProductInput

Required. The product input resource to update. Information you submit will be applied to the processed product as well.

Returns
Type Description
ProductInput|null

hasProductInput

clearProductInput

setProductInput

Required. The product input resource to update. Information you submit will be applied to the processed product as well.

Parameter
Name Description
var ProductInput
Returns
Type Description
$this

getUpdateMask

Optional. The list of product attributes to be updated.

If the update mask is omitted, then it is treated as implied field mask equivalent to all fields that are populated (have a non-empty value). Attributes specified in the update mask without a value specified in the body will be deleted from the product. Update mask can only be specified for top level fields in attributes and custom attributes. To specify the update mask for custom attributes you need to add the custom_attribute. prefix. Providing special "*" value for full product replacement is not supported.

Returns
Type Description
Google\Protobuf\FieldMask|null

hasUpdateMask

clearUpdateMask

setUpdateMask

Optional. The list of product attributes to be updated.

If the update mask is omitted, then it is treated as implied field mask equivalent to all fields that are populated (have a non-empty value). Attributes specified in the update mask without a value specified in the body will be deleted from the product. Update mask can only be specified for top level fields in attributes and custom attributes. To specify the update mask for custom attributes you need to add the custom_attribute. prefix. Providing special "*" value for full product replacement is not supported.

Parameter
Name Description
var Google\Protobuf\FieldMask
Returns
Type Description
$this

getDataSource

Required. The primary or supplemental product data source where data_source name identifies the product input to be updated.

Only API data sources are supported. Format: accounts/{account}/dataSources/{datasource}.

Returns
Type Description
string

setDataSource

Required. The primary or supplemental product data source where data_source name identifies the product input to be updated.

Only API data sources are supported. Format: accounts/{account}/dataSources/{datasource}.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
productInput ProductInput

Required. The product input resource to update. Information you submit will be applied to the processed product as well.
updateMask Google\Protobuf\FieldMask

Optional. The list of product attributes to be updated.

If the update mask is omitted, then it is treated as implied field mask equivalent to all fields that are populated (have a non-empty value).

Attributes specified in the update mask without a value specified in the body will be deleted from the product.

Update mask can only be specified for top level fields in attributes and custom attributes.

To specify the update mask for custom attributes you need to add the custom_attribute. prefix.

Providing special "*" value for full product replacement is not supported.
Returns
Type Description
UpdateProductInputRequest