blob: c3465d44f9bce2d4c0ab8c53c9f1845548bb6ad6 [file]
{
"version": "v1",
"documentationLink": "https://developers.google.com/manufacturers/",
"canonicalName": "Manufacturer Center",
"kind": "discovery#restDescription",
"revision": "20200805",
"description": "Public API for managing Manufacturer Center related data.",
"servicePath": "",
"id": "manufacturers:v1",
"basePath": "",
"ownerDomain": "google.com",
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"ownerName": "Google",
"protocol": "rest",
"title": "Manufacturer Center API",
"name": "manufacturers",
"mtlsRootUrl": "https://manufacturers.mtls.googleapis.com/",
"rootUrl": "https://manufacturers.googleapis.com/",
"schemas": {
"DestinationStatus": {
"type": "object",
"description": "The destination status.",
"id": "DestinationStatus",
"properties": {
"status": {
"description": "The status of the destination.",
"type": "string",
"enumDescriptions": [
"Unspecified status, never used.",
"The product is used for this destination.",
"The decision is still pending.",
"The product is disapproved. Please look at the issues."
],
"enum": [
"UNKNOWN",
"ACTIVE",
"PENDING",
"DISAPPROVED"
]
},
"destination": {
"description": "The name of the destination.",
"type": "string"
}
}
},
"ListProductsResponse": {
"id": "ListProductsResponse",
"properties": {
"products": {
"items": {
"$ref": "Product"
},
"description": "List of the products.",
"type": "array"
},
"nextPageToken": {
"type": "string",
"description": "The token for the retrieval of the next page of product statuses."
}
},
"type": "object"
},
"FeatureDescription": {
"type": "object",
"id": "FeatureDescription",
"description": "A feature description of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#featuredesc.",
"properties": {
"headline": {
"description": "A short description of the feature.",
"type": "string"
},
"text": {
"type": "string",
"description": "A detailed description of the feature."
},
"image": {
"$ref": "Image",
"description": "An optional image describing the feature."
}
}
},
"ProductDetail": {
"properties": {
"sectionName": {
"type": "string",
"description": "A short section name that can be reused between multiple product details."
},
"attributeName": {
"type": "string",
"description": "The name of the attribute."
},
"attributeValue": {
"type": "string",
"description": "The value of the attribute."
}
},
"description": "A product detail of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productdetail.",
"id": "ProductDetail",
"type": "object"
},
"Issue": {
"description": "Product issue.",
"type": "object",
"properties": {
"type": {
"description": "The server-generated type of the issue, for example, “INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc.",
"type": "string"
},
"description": {
"type": "string",
"description": "Longer description of the issue focused on how to resolve it."
},
"title": {
"type": "string",
"description": "Short title describing the nature of the issue."
},
"attribute": {
"description": "If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116.",
"type": "string"
},
"timestamp": {
"description": "The timestamp when this issue appeared.",
"type": "string",
"format": "google-datetime"
},
"resolution": {
"type": "string",
"enum": [
"RESOLUTION_UNSPECIFIED",
"USER_ACTION",
"PENDING_PROCESSING"
],
"description": "What needs to happen to resolve the issue.",
"enumDescriptions": [
"Unspecified resolution, never used.",
"The user who provided the data must act in order to resolve the issue (for example by correcting some data).",
"The issue will be resolved automatically (for example image crawl or Google review). No action is required now. Resolution might lead to another issue (for example if crawl fails)."
]
},
"destination": {
"type": "string",
"description": "The destination this issue applies to."
},
"severity": {
"enum": [
"SEVERITY_UNSPECIFIED",
"ERROR",
"WARNING",
"INFO"
],
"enumDescriptions": [
"Unspecified severity, never used.",
"Error severity. The issue prevents the usage of the whole item.",
"Warning severity. The issue is either one that prevents the usage of the attribute that triggered it or one that will soon prevent the usage of the whole item.",
"Info severity. The issue is one that doesn't require immediate attention. It is, for example, used to communicate which attributes are still pending review."
],
"description": "The severity of the issue.",
"type": "string"
}
},
"id": "Issue"
},
"Empty": {
"id": "Empty",
"properties": {},
"type": "object",
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`."
},
"Attributes": {
"id": "Attributes",
"type": "object",
"properties": {
"disclosureDate": {
"type": "string",
"description": "The disclosure date of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#disclosure."
},
"productName": {
"type": "string",
"description": "The canonical name of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productname."
},
"includedDestination": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of included destinations."
},
"brand": {
"type": "string",
"description": "The brand name of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#brand."
},
"size": {
"description": "The size of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#size.",
"type": "string"
},
"gender": {
"type": "string",
"description": "The target gender of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#gender."
},
"productLine": {
"description": "The name of the group of products related to the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productline.",
"type": "string"
},
"itemGroupId": {
"description": "The item group id of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#itemgroupid.",
"type": "string"
},
"description": {
"description": "The description of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#description.",
"type": "string"
},
"ageGroup": {
"type": "string",
"description": "The target age group of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#agegroup."
},
"pattern": {
"description": "The pattern of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#pattern.",
"type": "string"
},
"sizeSystem": {
"description": "The size system of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#sizesystem.",
"type": "string"
},
"sizeType": {
"type": "string",
"description": "The size type of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#sizetype."
},
"productType": {
"items": {
"type": "string"
},
"description": "The type or category of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#producttype.",
"type": "array"
},
"flavor": {
"type": "string",
"description": "The flavor of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#flavor."
},
"productDetail": {
"type": "array",
"description": "The details of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productdetail.",
"items": {
"$ref": "ProductDetail"
}
},
"mpn": {
"type": "string",
"description": "The Manufacturer Part Number (MPN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#mpn."
},
"additionalImageLink": {
"items": {
"$ref": "Image"
},
"type": "array",
"description": "The additional images of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#addlimage."
},
"featureDescription": {
"type": "array",
"items": {
"$ref": "FeatureDescription"
},
"description": "The rich format description of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#featuredesc."
},
"targetClientId": {
"description": "The target client id. Should only be used in the accounts of the data partners.",
"type": "string"
},
"imageLink": {
"description": "The image of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#image.",
"$ref": "Image"
},
"material": {
"type": "string",
"description": "The material of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#material."
},
"releaseDate": {
"description": "The release date of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#release.",
"type": "string"
},
"videoLink": {
"description": "The videos of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#video.",
"items": {
"type": "string"
},
"type": "array"
},
"format": {
"type": "string",
"description": "The format of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#format."
},
"scent": {
"description": "The scent of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#scent.",
"type": "string"
},
"productPageUrl": {
"type": "string",
"description": "The URL of the detail page of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#productpage."
},
"color": {
"description": "The color of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#color.",
"type": "string"
},
"capacity": {
"description": "The capacity of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#capacity.",
"$ref": "Capacity"
},
"title": {
"description": "The title of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#title.",
"type": "string"
},
"richProductContent": {
"type": "array",
"items": {
"type": "string"
},
"description": "Rich product content. For more information, see https://support.google.com/manufacturers/answer/9389865"
},
"suggestedRetailPrice": {
"$ref": "Price",
"description": "The suggested retail price (MSRP) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#price."
},
"theme": {
"type": "string",
"description": "The theme of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#theme."
},
"excludedDestination": {
"description": "A list of excluded destinations.",
"type": "array",
"items": {
"type": "string"
}
},
"count": {
"$ref": "Count",
"description": "The count of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#count."
},
"gtin": {
"type": "array",
"items": {
"type": "string"
},
"description": "The Global Trade Item Number (GTIN) of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#gtin."
}
},
"description": "Attributes of the product. For more information, see https://support.google.com/manufacturers/answer/6124116."
},
"Count": {
"id": "Count",
"description": "The number of products in a single package. For more information, see https://support.google.com/manufacturers/answer/6124116#count.",
"properties": {
"unit": {
"type": "string",
"description": "The unit in which these products are counted."
},
"value": {
"description": "The numeric value of the number of products in a package.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"Product": {
"description": "Product data.",
"type": "object",
"id": "Product",
"properties": {
"contentLanguage": {
"type": "string",
"description": "The content language of the product as a two-letter ISO 639-1 language code (for example, en)."
},
"targetCountry": {
"description": "The target country of the product as a CLDR territory code (for example, US).",
"type": "string"
},
"issues": {
"items": {
"$ref": "Issue"
},
"type": "array",
"description": "A server-generated list of issues associated with the product."
},
"productId": {
"type": "string",
"description": "The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id."
},
"attributes": {
"description": "Attributes of the product uploaded to the Manufacturer Center. Manually edited attributes are taken into account.",
"$ref": "Attributes"
},
"name": {
"type": "string",
"description": "Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id."
},
"parent": {
"description": "Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.",
"type": "string"
},
"destinationStatuses": {
"items": {
"$ref": "DestinationStatus"
},
"description": "The status of the destinations.",
"type": "array"
}
}
},
"Image": {
"description": "An image.",
"id": "Image",
"properties": {
"imageUrl": {
"type": "string",
"description": "The URL of the image. For crawled images, this is the provided URL. For uploaded images, this is a serving URL from Google if the image has been processed successfully."
},
"status": {
"description": "The status of the image. @OutputOnly",
"enumDescriptions": [
"The image status is unspecified. Should not be used.",
"The image was uploaded and is being processed.",
"The image crawl is still pending.",
"The image was processed and it meets the requirements.",
"The image URL is protected by robots.txt file and cannot be crawled.",
"The image URL is protected by X-Robots-Tag and cannot be crawled.",
"There was an error while crawling the image.",
"The image cannot be processed.",
"The image cannot be decoded.",
"The image is too big.",
"The image was manually overridden and will not be crawled.",
"The image crawl was postponed to avoid overloading the host.",
"The image URL returned a \"404 Not Found\" error."
],
"type": "string",
"enum": [
"STATUS_UNSPECIFIED",
"PENDING_PROCESSING",
"PENDING_CRAWL",
"OK",
"ROBOTED",
"XROBOTED",
"CRAWL_ERROR",
"PROCESSING_ERROR",
"DECODING_ERROR",
"TOO_BIG",
"CRAWL_SKIPPED",
"HOSTLOADED",
"HTTP_404"
]
},
"type": {
"enum": [
"TYPE_UNSPECIFIED",
"CRAWLED",
"UPLOADED"
],
"enumDescriptions": [
"Type is unspecified. Should not be used.",
"The image was crawled from a provided URL.",
"The image was uploaded."
],
"type": "string",
"description": "The type of the image, i.e., crawled or uploaded. @OutputOnly"
}
},
"type": "object"
},
"Capacity": {
"type": "object",
"properties": {
"value": {
"format": "int64",
"description": "The numeric value of the capacity.",
"type": "string"
},
"unit": {
"description": "The unit of the capacity, i.e., MB, GB, or TB.",
"type": "string"
}
},
"description": "The capacity of a product. For more information, see https://support.google.com/manufacturers/answer/6124116#capacity.",
"id": "Capacity"
},
"Price": {
"description": "A price.",
"properties": {
"amount": {
"description": "The numeric value of the price.",
"type": "string"
},
"currency": {
"type": "string",
"description": "The currency in which the price is denoted."
}
},
"type": "object",
"id": "Price"
}
},
"version_module": true,
"discoveryVersion": "v1",
"parameters": {
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response.",
"location": "query"
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"access_token": {
"location": "query",
"type": "string",
"description": "OAuth access token."
},
"$.xgafv": {
"description": "V1 error format.",
"type": "string",
"location": "query",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
]
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
"prettyPrint": {
"description": "Returns response with indentations and line breaks.",
"location": "query",
"default": "true",
"type": "boolean"
},
"alt": {
"location": "query",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"default": "json",
"description": "Data format for response.",
"type": "string"
},
"callback": {
"location": "query",
"type": "string",
"description": "JSONP"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
}
},
"resources": {
"accounts": {
"resources": {
"products": {
"methods": {
"list": {
"path": "v1/{+parent}/products",
"scopes": [
"https://www.googleapis.com/auth/manufacturercenter"
],
"flatPath": "v1/accounts/{accountsId}/products",
"description": "Lists all the products in a Manufacturer Center account.",
"id": "manufacturers.accounts.products.list",
"parameters": {
"pageSize": {
"format": "int32",
"type": "integer",
"description": "Maximum number of product statuses to return in the response, used for paging.",
"location": "query"
},
"parent": {
"location": "path",
"type": "string",
"pattern": "^accounts/[^/]+$",
"description": "Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.",
"required": true
},
"pageToken": {
"type": "string",
"description": "The token returned by the previous request.",
"location": "query"
},
"include": {
"repeated": true,
"enumDescriptions": [
"Unknown, never used.",
"Include the attributes of the product.",
"Include the issues of the product.",
"Include the destination statuses of the product."
],
"location": "query",
"description": "The information to be included in the response. Only sections listed here will be returned.",
"enum": [
"UNKNOWN",
"ATTRIBUTES",
"ISSUES",
"DESTINATION_STATUSES"
],
"type": "string"
}
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"response": {
"$ref": "ListProductsResponse"
}
},
"delete": {
"id": "manufacturers.accounts.products.delete",
"description": "Deletes the product from a Manufacturer Center account.",
"parameterOrder": [
"parent",
"name"
],
"path": "v1/{+parent}/products/{+name}",
"scopes": [
"https://www.googleapis.com/auth/manufacturercenter"
],
"response": {
"$ref": "Empty"
},
"httpMethod": "DELETE",
"parameters": {
"parent": {
"description": "Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.",
"required": true,
"location": "path",
"type": "string",
"pattern": "^accounts/[^/]+$"
},
"name": {
"pattern": "^[^/]+$",
"required": true,
"type": "string",
"description": "Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id.",
"location": "path"
}
},
"flatPath": "v1/accounts/{accountsId}/products/{productsId}"
},
"update": {
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"parent",
"name"
],
"httpMethod": "PUT",
"id": "manufacturers.accounts.products.update",
"description": "Inserts or updates the attributes of the product in a Manufacturer Center account. Creates a product with the provided attributes. If the product already exists, then all attributes are replaced with the new ones. The checks at upload time are minimal. All required attributes need to be present for a product to be valid. Issues may show up later after the API has accepted a new upload for a product and it is possible to overwrite an existing valid product with an invalid product. To detect this, you should retrieve the product and check it for issues once the new version is available. Uploaded attributes first need to be processed before they can be retrieved. Until then, new products will be unavailable, and retrieval of previously uploaded products will return the original state of the product.",
"parameters": {
"parent": {
"type": "string",
"required": true,
"description": "Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.",
"pattern": "^accounts/[^/]+$",
"location": "path"
},
"name": {
"description": "Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id.",
"type": "string",
"required": true,
"pattern": "^[^/]+$",
"location": "path"
}
},
"request": {
"$ref": "Attributes"
},
"path": "v1/{+parent}/products/{+name}",
"flatPath": "v1/accounts/{accountsId}/products/{productsId}",
"scopes": [
"https://www.googleapis.com/auth/manufacturercenter"
]
},
"get": {
"description": "Gets the product from a Manufacturer Center account, including product issues. A recently updated product takes around 15 minutes to process. Changes are only visible after it has been processed. While some issues may be available once the product has been processed, other issues may take days to appear.",
"id": "manufacturers.accounts.products.get",
"httpMethod": "GET",
"flatPath": "v1/accounts/{accountsId}/products/{productsId}",
"parameterOrder": [
"parent",
"name"
],
"response": {
"$ref": "Product"
},
"path": "v1/{+parent}/products/{+name}",
"parameters": {
"include": {
"location": "query",
"type": "string",
"enum": [
"UNKNOWN",
"ATTRIBUTES",
"ISSUES",
"DESTINATION_STATUSES"
],
"repeated": true,
"enumDescriptions": [
"Unknown, never used.",
"Include the attributes of the product.",
"Include the issues of the product.",
"Include the destination statuses of the product."
],
"description": "The information to be included in the response. Only sections listed here will be returned."
},
"parent": {
"description": "Parent ID in the format `accounts/{account_id}`. `account_id` - The ID of the Manufacturer Center account.",
"location": "path",
"required": true,
"type": "string",
"pattern": "^accounts/[^/]+$"
},
"name": {
"location": "path",
"type": "string",
"description": "Name in the format `{target_country}:{content_language}:{product_id}`. `target_country` - The target country of the product as a CLDR territory code (for example, US). `content_language` - The content language of the product as a two-letter ISO 639-1 language code (for example, en). `product_id` - The ID of the product. For more information, see https://support.google.com/manufacturers/answer/6124116#id.",
"required": true,
"pattern": "^[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/manufacturercenter"
]
}
}
}
}
}
},
"baseUrl": "https://manufacturers.googleapis.com/",
"batchPath": "batch",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/manufacturercenter": {
"description": "Manage your product listings for Google Manufacturer Center"
}
}
}
}
}