Package google.shopping.css.v1

Index

AccountLabelsService

Manages Merchant Center and CSS accounts labels.

CreateAccountLabel

rpc CreateAccountLabel(CreateAccountLabelRequest) returns (AccountLabel)

Creates a new label, not assigned to any account.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
DeleteAccountLabel

rpc DeleteAccountLabel(DeleteAccountLabelRequest) returns (Empty)

Deletes a label and removes it from all accounts to which it was assigned.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
ListAccountLabels

rpc ListAccountLabels(ListAccountLabelsRequest) returns (ListAccountLabelsResponse)

Lists the labels owned by an account.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
UpdateAccountLabel

rpc UpdateAccountLabel(UpdateAccountLabelRequest) returns (AccountLabel)

Updates a label.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

AccountsService

Service for managing CSS/MC account information.

GetAccount

rpc GetAccount(GetAccountRequest) returns (Account)

Retrieves a single CSS/MC account by ID.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
ListChildAccounts

rpc ListChildAccounts(ListChildAccountsRequest) returns (ListChildAccountsResponse)

Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
UpdateLabels

rpc UpdateLabels(UpdateAccountLabelsRequest) returns (Account)

Updates labels assigned to CSS/MC accounts by a CSS domain.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

CssProductInputsService

Service to use CssProductInput resource. This service helps to insert/update/delete CSS Products.

DeleteCssProductInput

rpc DeleteCssProductInput(DeleteCssProductInputRequest) returns (Empty)

Deletes a CSS Product input from your CSS Center account.

After a delete it may take several minutes until the input is no longer available.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
InsertCssProductInput

rpc InsertCssProductInput(InsertCssProductInputRequest) returns (CssProductInput)

Uploads a CssProductInput to your CSS Center account. If an input with the same contentLanguage, identity, feedLabel and feedId already exists, this method replaces that entry.

After inserting, updating, or deleting a CSS Product input, it may take several minutes before the processed CSS Product can be retrieved.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
UpdateCssProductInput

rpc UpdateCssProductInput(UpdateCssProductInputRequest) returns (CssProductInput)

Updates the existing Css Product input in your CSS Center account.

After inserting, updating, or deleting a CSS Product input, it may take several minutes before the processed Css Product can be retrieved.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

CssProductsService

Service for doing get and list on Css Products(a.k.a Aggregate Offers internally).

GetCssProduct

rpc GetCssProduct(GetCssProductRequest) returns (CssProduct)

Retrieves the processed CSS Product from your CSS Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.
ListCssProducts

rpc ListCssProducts(ListCssProductsRequest) returns (ListCssProductsResponse)

Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested.

After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

QuotaService

Service to get method call quota information per CSS API method.

ListQuotaGroups

rpc ListQuotaGroups(ListQuotaGroupsRequest) returns (ListQuotaGroupsResponse)

Lists the daily call quota and usage per group for your CSS Center account.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.

Account

Information about CSS/MC account.

Fields
name

string

The label resource name. Format: accounts/{account}
full_name

string

Output only. Immutable. The CSS/MC account's full name.
label_ids[]

int64

Manually created label IDs assigned to the CSS/MC account by a CSS parent account.
automatic_label_ids[]

int64

Automatically created label IDs assigned to the MC account by CSS Center.
account_type

AccountType

Output only. The type of this account.
display_name

string

The CSS/MC account's short display name.
homepage_uri

string

Output only. Immutable. The CSS/MC account's homepage.
parent

string

The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account. Note: For MC sub-accounts, this is also the CSS domain that is the parent resource of the MCA account, since we are effectively flattening the hierarchy."

AccountType

The account type.

Enums
ACCOUNT_TYPE_UNSPECIFIED Unknown account type.
CSS_GROUP CSS group account.
CSS_DOMAIN CSS domain account.
MC_PRIMARY_CSS_MCA MC Primary CSS MCA account.
MC_CSS_MCA MC CSS MCA account.
MC_MARKETPLACE_MCA MC Marketplace MCA account.
MC_OTHER_MCA MC Other MCA account.
MC_STANDALONE MC Standalone account.
MC_MCA_SUBACCOUNT MC MCA sub-account.

AccountLabel

Label assigned by CSS domain or CSS group to one of its sub-accounts.

Fields
name

string

Identifier. The resource name of the label. Format: accounts/{account}/labels/{label}
label_id

int64

Output only. The ID of the label.
account_id

int64

Output only. The ID of account this label belongs to.
label_type

LabelType

Output only. The type of this label.
display_name

string

The display name of this label.
description

string

The description of this label.

LabelType

The label type.

Enums
LABEL_TYPE_UNSPECIFIED Unknown label type.
MANUAL Indicates that the label was created manually.
AUTOMATIC Indicates that the label was created automatically by CSS Center.

Attributes

Attributes for CSS Product.

Fields
low_price

Price

Low Price of the CSS Product.
high_price

Price

High Price of the CSS Product.
headline_offer_price

Price

Headline Price of the CSS Product.
headline_offer_shipping_price

Price

Headline Price of the CSS Product.
product_types[]

string

Categories of the item (formatted as in products data specification).
size_types[]

string

The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)).
product_details[]

ProductDetail

Technical specification or additional product details.
product_weight

ProductWeight

The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
product_length

ProductDimension

The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
product_width

ProductDimension

The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
product_height

ProductDimension

The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
product_highlights[]

string

Bullet points describing the most relevant highlights of a product.
certifications[]

Certification

A list of certificates claimed by the CSS for the given product.
expiration_date

Timestamp

Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future. Note: It may take 2+ days from the expiration date for the item to actually get deleted.
included_destinations[]

string

The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in excludedDestinations.
excluded_destinations[]

string

The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
headline_offer_installment

HeadlineOfferInstallment

Number and amount of installments to pay for an item.
headline_offer_subscription_cost

HeadlineOfferSubscriptionCost

Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
cpp_ads_redirect

string

Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
number_of_offers

int64

The number of CSS Products.
headline_offer_condition

string

Condition of the headline offer.
title

string

Title of the item.
description

string

Description of the item.
brand

string

Product Related Attributes.[14-36] Brand of the item.
mpn

string

Manufacturer Part Number (MPN) of the item.
gtin

string

Global Trade Item Number (GTIN) of the item.
google_product_category

string

Google's category of the item (see Google product taxonomy). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
adult

bool

Set to true if the item is targeted towards adults.
multipack

int64

The number of identical products in a merchant-defined multipack.
is_bundle

bool

Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
age_group

string

Target age group of the item.
color

string

Color of the item.
gender

string

Target gender of the item.
material

string

The material of which the item is made.
pattern

string

The item's pattern (e.g. polka dots).
size

string

Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same itemGroupId value (see [https://support.google.com/merchants/answer/6324492](size definition)).
size_system

string

System in which the size is specified. Recommended for apparel items.
item_group_id

string

Shared identifier for all variants of the same product.
pause

string

Publication of this item will be temporarily paused.
custom_label_0

string

Custom label 0 for custom grouping of items in a Shopping campaign.
custom_label_1

string

Custom label 1 for custom grouping of items in a Shopping campaign.
custom_label_2

string

Custom label 2 for custom grouping of items in a Shopping campaign.
custom_label_3

string

Custom label 3 for custom grouping of items in a Shopping campaign.
custom_label_4

string

Custom label 4 for custom grouping of items in a Shopping campaign.

Certification

The certification for the product. Use the this attribute to describe certifications, such as energy efficiency ratings, associated with a product.

Fields
name

string

The name of the certification. At this time, the most common value is "EPREL", which represents energy efficiency certifications in the EU European Registry for Energy Labeling (EPREL) database.
authority

string

The authority or certification body responsible for issuing the certification. At this time, the most common value is "EC" or “European_Commission” for energy labels in the EU.
code

string

The code of the certification. For example, for the EPREL certificate with the link https://eprel.ec.europa.eu/screen/product/dishwashers2019/123456 the code is 123456. The code is required for European Energy Labels.

CreateAccountLabelRequest

Request message for the 'CreateAccountLanel' method.

Fields
parent

string

Required. The parent account. Format: accounts/{account}
account_label

AccountLabel

Required. The label to create.

CssProduct

The processed CSS Product.

Fields
name

string

The name of the CSS Product. Format: "accounts/{account}/cssProducts/{css_product}"
raw_provided_id

string

Output only. Your unique raw identifier for the product.
content_language

string

Output only. The two-letter ISO 639-1 language code for the product.
feed_label

string

Output only. The feed label for the product.
attributes

Attributes

Output only. A list of product attributes.
custom_attributes[]

CustomAttribute

Output only. A list of custom (CSS-provided) attributes. It can also be used to submit 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.
css_product_status

CssProductStatus

Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.

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.

Fields
name

string

Identifier. The name of the CSS Product input. Format: accounts/{account}/cssProductInputs/{css_product_input}, where the last section css_product_input consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123
final_name

string

Output only. The name of the processed CSS Product. Format: accounts/{account}/cssProducts/{css_product} "
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
(deprecated)

Timestamp

DEPRECATED. Use expiration_date instead. 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

Attributes

A list of CSS Product attributes.
custom_attributes[]

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: { "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.

CssProductStatus

The status of the Css Product, data validation issues, that is, information about the Css Product computed asynchronously.

Fields
destination_statuses[]

DestinationStatus

The intended destinations for the product.
item_level_issues[]

ItemLevelIssue

A list of all issues associated with the product.
creation_date

Timestamp

Date on which the item has been created, in ISO 8601 format.
last_update_date

Timestamp

Date on which the item has been last updated, in ISO 8601 format.
google_expiration_date

Timestamp

Date on which the item expires, in ISO 8601 format.

DestinationStatus

The destination status of the product status.

Fields
destination

string

The name of the destination
approved_countries[]

string

List of country codes (ISO 3166-1 alpha-2) where the CSS Product is approved.
pending_countries[]

string

List of country codes (ISO 3166-1 alpha-2) where the CSS Product is pending approval.
disapproved_countries[]

string

List of country codes (ISO 3166-1 alpha-2) where the CSS Product is disapproved.

ItemLevelIssue

The ItemLevelIssue of the product status.

Fields
code

string

The error code of the issue.
servability

string

How this issue affects serving of the CSS Product.
resolution

string

Whether the issue can be resolved by the merchant.
attribute

string

The attribute's name, if the issue is caused by a single attribute.
destination

string

The destination the issue applies to.
description

string

A short issue description in English.
detail

string

A detailed issue description in English.
documentation

string

The URL of a web page to help with resolving this issue.
applicable_countries[]

string

List of country codes (ISO 3166-1 alpha-2) where issue applies to the CSS Product.

DeleteAccountLabelRequest

Request message for the 'DeleteAccountLabel' method.

Fields
name

string

Required. The name of the label to delete. Format: accounts/{account}/labels/{label}

DeleteCssProductInputRequest

Request message for the DeleteCssProductInput method.

Fields
name

string

Required. The name of the CSS product input resource to delete. Format: accounts/{account}/cssProductInputs/{css_product_input}, where the last section css_product_input consists of 3 parts: contentLanguage~feedLabel~offerId. Example: accounts/123/cssProductInputs/de~DE~rawProvidedId123
supplemental_feed_id

int64

The Content API Supplemental Feed ID. The field must not be set if the action applies to a primary feed. If the field is set, then product action applies to a supplemental feed instead of primary Content API feed.

GetAccountRequest

The request message for the GetAccount method.

Fields
name

string

Required. The name of the managed CSS/MC account. Format: accounts/{account}
parent

string

Optional. Only required when retrieving MC account information. The CSS domain that is the parent resource of the MC account. Format: accounts/{account}

GetCssProductRequest

The request message for the GetCssProduct method.

Fields
name

string

Required. The name of the CSS product to retrieve.

HeadlineOfferInstallment

A message that represents installment.

Fields
months

int64

The number of installments the buyer has to pay.
amount

Price

The amount the buyer has to pay per month.
downpayment

Price

The up-front down payment amount the buyer has to pay.

HeadlineOfferSubscriptionCost

The SubscriptionCost of the product.

Fields
period

SubscriptionPeriod

The type of subscription period. Supported values are: * "month" * "year"
period_length

int64

The number of subscription periods the buyer has to pay.
amount

Price

The amount the buyer has to pay per subscription period.

InsertCssProductInputRequest

Request message for the InsertCssProductInput method.

Fields
parent

string

Required. The account where this CSS Product will be inserted. Format: accounts/{account}
css_product_input

CssProductInput

Required. The CSS Product Input to insert.
feed_id
(deprecated)

int64

Optional. DEPRECATED. Feed id is not required for CSS Products. The primary or supplemental feed id. If CSS Product already exists and feed id provided is different, then the CSS Product will be moved to a new feed. Note: For now, CSSs do not need to provide feed ids as we create feeds on the fly. We do not have supplemental feed support for CSS Products yet.

ListAccountLabelsRequest

Request message for the ListAccountLabels method.

Fields
parent

string

Required. The parent account. Format: accounts/{account}
page_size

int32

The maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
page_token

string

A page token, received from a previous ListAccountLabels call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListAccountLabels must match the call that provided the page token.

ListAccountLabelsResponse

Response message for the ListAccountLabels method.

Fields
account_labels[]

AccountLabel

The labels from the specified account.
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListChildAccountsRequest

The request message for the ListChildAccounts method.

Fields
parent

string

Required. The parent account. Must be a CSS group or domain. Format: accounts/{account}
page_size

int32

Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 50 accounts will be returned. The maximum value is 100; values above 100 will be coerced to 100.
page_token

string

Optional. A page token, received from a previous ListChildAccounts call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListChildAccounts must match the call that provided the page token.
label_id

int64

If set, only the MC accounts with the given label ID will be returned.
full_name

string

If set, only the MC accounts with the given name (case sensitive) will be returned.

ListChildAccountsResponse

Response message for the ListChildAccounts method.

Fields
accounts[]

Account

The CSS/MC accounts returned for the specified CSS parent account.
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListCssProductsRequest

Request message for the ListCssProducts method.

Fields
parent

string

Required. The account/domain to list processed CSS Products for. Format: accounts/{account}
page_size

int32

The maximum number of CSS Products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of CSS products will be returned.
page_token

string

A page token, received from a previous ListCssProducts call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListCssProducts must match the call that provided the page token.

ListCssProductsResponse

Response message for the ListCssProducts method.

Fields
css_products[]

CssProduct

The processed CSS products from the specified account. These are your processed CSS products after applying rules and supplemental feeds.
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListQuotaGroupsRequest

Request message for the ListQuotaGroups method.

Fields
parent

string

Required. The CSS account that owns the collection of method quotas and resources. In most cases, this is the CSS domain. Format: accounts/{account}
page_size

int32

Optional. The maximum number of quotas to return in the response, used for paging. Defaults to 500; values above 1000 will be coerced to 1000.
page_token

string

Optional. Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.

ListQuotaGroupsResponse

Response message for the ListMethodGroups method.

Fields
quota_groups[]

QuotaGroup

The methods, current quota usage and limits per each group. The quota is shared between all methods in the group. The groups are sorted in descending order based on quota_usage.
next_page_token

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

MethodDetails

The method details per method in the CSS API.

Fields
method

string

Output only. The name of the method for example cssproductsservice.listcssproducts.
version

string

Output only. The API version that the method belongs to.
subapi

string

Output only. The sub-API that the method belongs to. In the CSS API, this is always css.
path

string

Output only. The path for the method such as v1/cssproductsservice.listcssproducts.

ProductDetail

The product details.

Fields
section_name

string

The section header used to group a set of product details.
attribute_name

string

The name of the product detail.
attribute_value

string

The value of the product detail.

ProductDimension

The dimension of the product.

Fields
value

double

Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
unit

string

Required. The dimension units. Acceptable values are: * "in" * "cm"

ProductWeight

The weight of the product.

Fields
value

double

Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
unit

string

Required. The weight unit. Acceptable values are: * "g" * "kg" * "oz" * "lb"

QuotaGroup

The group information for methods in the CSS API. The quota is shared between all methods in the group. Even if none of the methods within the group have usage the information for the group is returned.

Fields
name

string

Identifier. The resource name of the quota group. Format: accounts/{account}/quotas/{group} Example: accounts/12345678/quotas/css-products-insert Note: The {group} part is not guaranteed to follow a specific pattern.
quota_usage

int64

Output only. The current quota usage, meaning the number of calls already made on a given day to the methods in the group. The daily quota limits reset at at 12:00 PM midday UTC.
quota_limit

int64

Output only. The maximum number of calls allowed per day for the group.
quota_minute_limit

int64

Output only. The maximum number of calls allowed per minute for the group.
method_details[]

MethodDetails

Output only. List of all methods group quota applies to.

SubscriptionPeriod

The subscription period of the product.

Enums
SUBSCRIPTION_PERIOD_UNSPECIFIED Indicates that the subscription period is unspecified.
MONTH Indicates that the subscription period is month.
YEAR Indicates that the subscription period is year.

UpdateAccountLabelRequest

Request message for the UpdateAccountLabel method.

Fields
account_label

AccountLabel

Required. The updated label. All fields must be provided.

UpdateAccountLabelsRequest

The request message for the UpdateLabels method.

Fields
name

string

Required. The label resource name. Format: accounts/{account}
label_ids[]

int64

The list of label IDs to overwrite the existing account label IDs. If the list is empty, all currently assigned label IDs will be deleted.
parent

string

Optional. Only required when updating MC account labels. The CSS domain that is the parent resource of the MC account. Format: accounts/{account}

UpdateCssProductInputRequest

Request message for the UpdateCssProductInput method.

Fields
css_product_input

CssProductInput

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

FieldMask

The list of CSS 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 CSS 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 CSS product replacement is not supported.