blob: ed23f7ff7978cf3268a26eea6144434e1e8b31b4 [file] [log] [blame]
{
"revision": "20171011",
"documentationLink": "https://developers.google.com/manufacturers/",
"id": "manufacturers:v1",
"discoveryVersion": "v1",
"version_module": true,
"schemas": {
"Image": {
"description": "An image.",
"type": "object",
"properties": {
"imageUrl": {
"description": "The URL of the image. For crawled images, this is the provided URL. For\nuploaded images, this is a serving URL from Google if the image has been\nprocessed successfully.",
"type": "string"
},
"status": {
"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."
],
"enum": [
"STATUS_UNSPECIFIED",
"PENDING_PROCESSING",
"PENDING_CRAWL",
"OK",
"ROBOTED",
"XROBOTED",
"CRAWL_ERROR",
"PROCESSING_ERROR",
"DECODING_ERROR",
"TOO_BIG",
"CRAWL_SKIPPED",
"HOSTLOADED",
"HTTP_404"
],
"description": "The status of the image.\n@OutputOnly",
"type": "string"
},
"type": {
"description": "The type of the image, i.e., crawled or uploaded.\n@OutputOnly",
"type": "string",
"enumDescriptions": [
"Type is unspecified. Should not be used.",
"The image was crawled from a provided URL.",
"The image was uploaded."
],
"enum": [
"TYPE_UNSPECIFIED",
"CRAWLED",
"UPLOADED"
]
}
},
"id": "Image"
},
"Attributes": {
"id": "Attributes",
"description": "Attributes of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116.",
"type": "object",
"properties": {
"theme": {
"description": "The theme of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#theme.",
"type": "string"
},
"targetClientId": {
"description": "The target client id. Should only be used in the accounts of the data\npartners.",
"type": "string"
},
"pattern": {
"description": "The pattern of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#pattern.",
"type": "string"
},
"imageLink": {
"$ref": "Image",
"description": "The image of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#image."
},
"productType": {
"description": "The type or category of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#producttype.",
"items": {
"type": "string"
},
"type": "array"
},
"format": {
"description": "The format of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#format.",
"type": "string"
},
"additionalImageLink": {
"description": "The additional images of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#addlimage.",
"items": {
"$ref": "Image"
},
"type": "array"
},
"videoLink": {
"description": "The videos of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#video.",
"items": {
"type": "string"
},
"type": "array"
},
"color": {
"description": "The color of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#color.",
"type": "string"
},
"productName": {
"description": "The canonical name of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productname.",
"type": "string"
},
"sizeType": {
"description": "The size type of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#sizetype.",
"type": "string"
},
"suggestedRetailPrice": {
"$ref": "Price",
"description": "The suggested retail price (MSRP) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#price."
},
"featureDescription": {
"items": {
"$ref": "FeatureDescription"
},
"type": "array",
"description": "The rich format description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#featuredesc."
},
"size": {
"description": "The size of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#size.",
"type": "string"
},
"title": {
"description": "The title of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#title.",
"type": "string"
},
"count": {
"$ref": "Count",
"description": "The count of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#count."
},
"brand": {
"type": "string",
"description": "The brand name of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#brand."
},
"disclosureDate": {
"description": "The disclosure date of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#disclosure.",
"type": "string"
},
"material": {
"description": "The material of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#material.",
"type": "string"
},
"scent": {
"description": "The scent of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#scent.",
"type": "string"
},
"ageGroup": {
"description": "The target age group of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#agegroup.",
"type": "string"
},
"productDetail": {
"description": "The details of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.",
"items": {
"$ref": "ProductDetail"
},
"type": "array"
},
"flavor": {
"type": "string",
"description": "The flavor of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#flavor."
},
"mpn": {
"description": "The Manufacturer Part Number (MPN) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#mpn.",
"type": "string"
},
"productPageUrl": {
"description": "The URL of the detail page of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productpage.",
"type": "string"
},
"releaseDate": {
"description": "The release date of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#release.",
"type": "string"
},
"itemGroupId": {
"description": "The item group id of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#itemgroupid.",
"type": "string"
},
"gtin": {
"description": "The Global Trade Item Number (GTIN) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#gtin.",
"items": {
"type": "string"
},
"type": "array"
},
"productLine": {
"description": "The name of the group of products related to the product. For more\ninformation, see\nhttps://support.google.com/manufacturers/answer/6124116#productline.",
"type": "string"
},
"capacity": {
"$ref": "Capacity",
"description": "The capacity of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity."
},
"description": {
"description": "The description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#description.",
"type": "string"
},
"gender": {
"type": "string",
"description": "The target gender of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#gender."
},
"sizeSystem": {
"description": "The size system of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#sizesystem.",
"type": "string"
}
}
},
"Count": {
"description": "The number of products in a single package. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#count.",
"type": "object",
"properties": {
"unit": {
"description": "The unit in which these products are counted.",
"type": "string"
},
"value": {
"format": "int64",
"description": "The numeric value of the number of products in a package.",
"type": "string"
}
},
"id": "Count"
},
"Product": {
"id": "Product",
"description": "Product data.",
"type": "object",
"properties": {
"manuallyProvidedAttributes": {
"$ref": "Attributes",
"description": "Attributes of the product provided manually via the Manufacturer Center UI.\n@OutputOnly"
},
"targetCountry": {
"type": "string",
"description": "The target country of the product as a CLDR territory code (for example,\nUS).\n@OutputOnly"
},
"contentLanguage": {
"type": "string",
"description": "The content language of the product as a two-letter ISO 639-1 language code\n(for example, en).\n@OutputOnly"
},
"name": {
"description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly",
"type": "string"
},
"issues": {
"description": "A server-generated list of issues associated with the product.\n@OutputOnly",
"items": {
"$ref": "Issue"
},
"type": "array"
},
"manuallyDeletedAttributes": {
"description": "Names of the attributes of the product deleted manually via the\nManufacturer Center UI.\n@OutputOnly",
"items": {
"type": "string"
},
"type": "array"
},
"finalAttributes": {
"$ref": "Attributes",
"description": "Final attributes of the product. The final attributes are obtained by\noverriding the uploaded attributes with the manually provided and deleted\nattributes. Google systems only process, evaluate, review, and/or use final\nattributes.\n@OutputOnly"
},
"productId": {
"description": "The ID of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly",
"type": "string"
},
"uploadedAttributes": {
"$ref": "Attributes",
"description": "Attributes of the product uploaded via the Manufacturer Center API or via\nfeeds."
},
"parent": {
"description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.\n@OutputOnly",
"type": "string"
}
}
},
"Capacity": {
"description": "The capacity of a product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity.",
"type": "object",
"properties": {
"unit": {
"description": "The unit of the capacity, i.e., MB, GB, or TB.",
"type": "string"
},
"value": {
"format": "int64",
"description": "The numeric value of the capacity.",
"type": "string"
}
},
"id": "Capacity"
},
"ListProductsResponse": {
"type": "object",
"properties": {
"products": {
"description": "List of the products.",
"items": {
"$ref": "Product"
},
"type": "array"
},
"nextPageToken": {
"description": "The token for the retrieval of the next page of product statuses.",
"type": "string"
}
},
"id": "ListProductsResponse"
},
"ProductDetail": {
"description": "A product detail of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.",
"type": "object",
"properties": {
"sectionName": {
"description": "A short section name that can be reused between multiple product details.",
"type": "string"
},
"attributeName": {
"type": "string",
"description": "The name of the attribute."
},
"attributeValue": {
"description": "The value of the attribute.",
"type": "string"
}
},
"id": "ProductDetail"
},
"Issue": {
"description": "Product issue.",
"type": "object",
"properties": {
"type": {
"description": "The server-generated type of the issue, for example,\n“INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc.",
"type": "string"
},
"attribute": {
"type": "string",
"description": "If present, the attribute that triggered the issue. For more information\nabout attributes, see\nhttps://support.google.com/manufacturers/answer/6124116."
},
"timestamp": {
"format": "google-datetime",
"description": "The timestamp when this issue appeared.",
"type": "string"
},
"severity": {
"type": "string",
"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\nattribute that triggered it or one that will soon prevent the usage of\nthe whole item.",
"Info severity. The issue is one that doesn't require immediate attention.\nIt is, for example, used to communicate which attributes are still\npending review."
],
"enum": [
"SEVERITY_UNSPECIFIED",
"ERROR",
"WARNING",
"INFO"
],
"description": "The severity of the issue."
},
"description": {
"description": "Description of the issue.",
"type": "string"
}
},
"id": "Issue"
},
"FeatureDescription": {
"description": "A feature description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#featuredesc.",
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "A detailed description of the feature."
},
"image": {
"$ref": "Image",
"description": "An optional image describing the feature."
},
"headline": {
"description": "A short description of the feature.",
"type": "string"
}
},
"id": "FeatureDescription"
},
"Empty": {
"properties": {},
"id": "Empty",
"description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
"type": "object"
},
"Price": {
"id": "Price",
"description": "A price.",
"type": "object",
"properties": {
"currency": {
"description": "The currency in which the price is denoted.",
"type": "string"
},
"amount": {
"description": "The numeric value of the price.",
"type": "string"
}
}
}
},
"protocol": "rest",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"canonicalName": "Manufacturer Center",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/manufacturercenter": {
"description": "Manage your product listings for Google Manufacturer Center"
}
}
}
},
"rootUrl": "https://manufacturers.googleapis.com/",
"ownerDomain": "google.com",
"name": "manufacturers",
"batchPath": "batch",
"title": "Manufacturer Center API",
"ownerName": "Google",
"resources": {
"accounts": {
"resources": {
"products": {
"methods": {
"get": {
"description": "Gets the product from a Manufacturer Center account, including product\nissues.\n\nA recently updated product takes around 15 minutes to process. Changes are\nonly visible after it has been processed. While some issues may be\navailable once the product has been processed, other issues may take days\nto appear.",
"httpMethod": "GET",
"response": {
"$ref": "Product"
},
"parameterOrder": [
"parent",
"name"
],
"parameters": {
"name": {
"location": "path",
"description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.",
"type": "string",
"required": true,
"pattern": "^[^/]+$"
},
"parent": {
"description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
"type": "string",
"required": true,
"pattern": "^accounts/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/manufacturercenter"
],
"flatPath": "v1/accounts/{accountsId}/products/{productsId}",
"path": "v1/{+parent}/products/{+name}",
"id": "manufacturers.accounts.products.get"
},
"list": {
"response": {
"$ref": "ListProductsResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"parameters": {
"parent": {
"location": "path",
"description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
"type": "string",
"required": true,
"pattern": "^accounts/[^/]+$"
},
"pageToken": {
"description": "The token returned by the previous request.",
"type": "string",
"location": "query"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Maximum number of product statuses to return in the response, used for\npaging.",
"type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/manufacturercenter"
],
"flatPath": "v1/accounts/{accountsId}/products",
"id": "manufacturers.accounts.products.list",
"path": "v1/{+parent}/products",
"description": "Lists all the products in a Manufacturer Center account."
},
"update": {
"flatPath": "v1/accounts/{accountsId}/products/{productsId}",
"id": "manufacturers.accounts.products.update",
"path": "v1/{+parent}/products/{+name}",
"description": "Inserts or updates the product in a Manufacturer Center account.\n\nThe checks at upload time are minimal. All required attributes need to be\npresent for a product to be valid. Issues may show up later\nafter the API has accepted an update for a product and it is possible to\noverwrite an existing valid product with an invalid product. To detect\nthis, you should retrieve the product and check it for issues once the\nupdated version is available.\n\nInserted or updated products first need to be processed before they can be\nretrieved. Until then, new products will be unavailable, and retrieval\nof updated products will return the original state of the product.",
"request": {
"$ref": "Product"
},
"response": {
"$ref": "Product"
},
"parameterOrder": [
"parent",
"name"
],
"httpMethod": "PUT",
"parameters": {
"name": {
"description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.",
"type": "string",
"required": true,
"pattern": "^[^/]+$",
"location": "path"
},
"parent": {
"description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
"type": "string",
"required": true,
"pattern": "^accounts/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/manufacturercenter"
]
},
"delete": {
"description": "Deletes the product from a Manufacturer Center account.",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"parent",
"name"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/manufacturercenter"
],
"parameters": {
"parent": {
"pattern": "^accounts/[^/]+$",
"location": "path",
"description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.",
"type": "string",
"required": true
},
"name": {
"type": "string",
"required": true,
"pattern": "^[^/]+$",
"location": "path",
"description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id."
}
},
"flatPath": "v1/accounts/{accountsId}/products/{productsId}",
"id": "manufacturers.accounts.products.delete",
"path": "v1/{+parent}/products/{+name}"
}
}
}
}
}
},
"parameters": {
"uploadType": {
"location": "query",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string"
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
"$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
"type": "string"
},
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"alt": {
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"description": "Data format for response.",
"default": "json",
"enum": [
"json",
"media",
"proto"
],
"type": "string"
},
"access_token": {
"location": "query",
"description": "OAuth access token.",
"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"
},
"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.",
"type": "string",
"location": "query"
},
"pp": {
"description": "Pretty-print response.",
"default": "true",
"type": "boolean",
"location": "query"
},
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"prettyPrint": {
"location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean"
}
},
"version": "v1",
"baseUrl": "https://manufacturers.googleapis.com/",
"kind": "discovery#restDescription",
"description": "Public API for managing Manufacturer Center related data.",
"servicePath": "",
"basePath": ""
}