# Google Shopping Merchant Products V1 Client - Class UpdateProductInputRequest (1.6.0)

1.6.0 (latest) 1.5.0 1.4.1 1.3.1 1.2.0 1.1.0 1.0.0 0.7.0 0.6.1 0.5.0 0.4.0 0.3.0 0.2.1 0.1.1 Reference documentation and code samples for the Google Shopping Merchant Products V1 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.v1.UpdateProductInputRequest`

## Namespace

Google \\ Shopping \\ Merchant \\ Products \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ product_input` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-products/latest/V1.ProductInput` Required. The product input resource to update. Information you submit will be applied to the processed product as well. The `name` field within this resource identifies the product input to be updated. |
| `↳ update_mask` | `https://protobuf.dev/reference/php/api-docs/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}`. For example, `accounts/123456/dataSources/104628`. |

### getProductInput

Required. The product input resource to update. Information you submit will
be applied to the processed product as well. The `name` field within this
resource identifies the product input to be updated.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-products/latest/V1.ProductInput|null` |   |

### hasProductInput

### clearProductInput

### setProductInput

Required. The product input resource to update. Information you submit will
be applied to the processed product as well. The `name` field within this
resource identifies the product input to be updated.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-products/latest/V1.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** |
| `https://protobuf.dev/reference/php/api-docs/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` | `https://protobuf.dev/reference/php/api-docs/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}`. For example,
`accounts/123456/dataSources/104628`.

| **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}`. For example,
`accounts/123456/dataSources/104628`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### static::build

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `productInput` | `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-products/latest/V1.ProductInput` Required. The product input resource to update. Information you submit will be applied to the processed product as well. The `name` field within this resource identifies the product input to be updated. |
| `updateMask` | `https://protobuf.dev/reference/php/api-docs/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** |
| `https://docs.cloud.google.com/php/docs/reference/shopping-merchant-products/latest/V1.UpdateProductInputRequest` |   |