Reference documentation and code samples for the Google Shopping Css V1 Client class CssProductInput.
This resource represents input data you submit for a CSS Product, not the processed CSS Product that you see in CSS Center, in Shopping Ads, or across Google surfaces.
Generated from protobuf message google.shopping.css.v1.CssProductInput
Namespace
Google \ Shopping \ Css \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
The name of the CSS Product input. Format: |
↳ final_name |
string
Output only. The name of the processed CSS Product. Format: |
↳ raw_provided_id |
string
Required. Your unique identifier for the CSS Product. This is the same for the CSS Product input and processed CSS Product. We only allow ids with alphanumerics, underscores and dashes. See the products feed specification for details. |
↳ content_language |
string
Required. The two-letter ISO 639-1 language code for the CSS Product. |
↳ feed_label |
string
Required. The feed label for the CSS Product. Feed Label is synonymous to "target country" and hence should always be a valid region code. For example: 'DE' for Germany, 'FR' for France. |
↳ freshness_time |
Google\Protobuf\Timestamp
Represents the existing version (freshness) of the CSS Product, which can be used to preserve the right order when multiple updates are done at the same time. This field must not be set to the future time. If set, the update is prevented if a newer version of the item already exists in our system (that is the last update time of the existing CSS products is later than the freshness time set in the update). If the update happens, the last update time is then set to this freshness time. If not set, the update will not be prevented and the last update time will default to when this request was received by the CSS API. If the operation is prevented, the aborted exception will be thrown. |
↳ attributes |
Google\Shopping\Css\V1\Attributes
A list of CSS Product attributes. |
↳ custom_attributes |
array<Google\Shopping\Type\CustomAttribute>
A list of custom (CSS-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example: |
getName
The name of the CSS Product input.
Format:
accounts/{account}/cssProductInputs/{css_product_input}
| Returns | |
|---|---|
| Type | Description |
string | |
setName
The name of the CSS Product input.
Format:
accounts/{account}/cssProductInputs/{css_product_input}
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFinalName
Output only. The name of the processed CSS Product.
Format:
accounts/{account}/cssProducts/{css_product}
"
| Returns | |
|---|---|
| Type | Description |
string | |
setFinalName
Output only. The name of the processed CSS Product.
Format:
accounts/{account}/cssProducts/{css_product}
"
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRawProvidedId
Required. Your unique identifier for the CSS Product. This is the same for the CSS Product input and processed CSS Product. We only allow ids with alphanumerics, underscores and dashes. See the products feed specification for details.
| Returns | |
|---|---|
| Type | Description |
string | |
setRawProvidedId
Required. Your unique identifier for the CSS Product. This is the same for the CSS Product input and processed CSS Product. We only allow ids with alphanumerics, underscores and dashes. See the products feed specification for details.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getContentLanguage
Required. The two-letter ISO 639-1 language code for the CSS Product.
| Returns | |
|---|---|
| Type | Description |
string | |
setContentLanguage
Required. The two-letter ISO 639-1 language code for the CSS Product.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFeedLabel
Required. The feed label for the CSS Product.
Feed Label is synonymous to "target country" and hence should always be a valid region code. For example: 'DE' for Germany, 'FR' for France.
| Returns | |
|---|---|
| Type | Description |
string | |
setFeedLabel
Required. The feed label for the CSS Product.
Feed Label is synonymous to "target country" and hence should always be a valid region code. For example: 'DE' for Germany, 'FR' for France.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFreshnessTime
Represents the existing version (freshness) of the CSS Product, which can be used to preserve the right order when multiple updates are done at the same time.
This field must not be set to the future time. If set, the update is prevented if a newer version of the item already exists in our system (that is the last update time of the existing CSS products is later than the freshness time set in the update). If the update happens, the last update time is then set to this freshness time. If not set, the update will not be prevented and the last update time will default to when this request was received by the CSS API. If the operation is prevented, the aborted exception will be thrown.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasFreshnessTime
clearFreshnessTime
setFreshnessTime
Represents the existing version (freshness) of the CSS Product, which can be used to preserve the right order when multiple updates are done at the same time.
This field must not be set to the future time. If set, the update is prevented if a newer version of the item already exists in our system (that is the last update time of the existing CSS products is later than the freshness time set in the update). If the update happens, the last update time is then set to this freshness time. If not set, the update will not be prevented and the last update time will default to when this request was received by the CSS API. If the operation is prevented, the aborted exception will be thrown.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAttributes
A list of CSS Product attributes.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Css\V1\Attributes|null | |
hasAttributes
clearAttributes
setAttributes
A list of CSS Product attributes.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Css\V1\Attributes
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCustomAttributes
A list of custom (CSS-provided) attributes. It can also be used for
submitting any attribute of the feed specification in its generic
form (for example:
{ "name": "size type", "value": "regular" }).
This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setCustomAttributes
A list of custom (CSS-provided) attributes. It can also be used for
submitting any attribute of the feed specification in its generic
form (for example:
{ "name": "size type", "value": "regular" }).
This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Shopping\Type\CustomAttribute>
|
| Returns | |
|---|---|
| Type | Description |
$this | |