openapi-directory/api/googleapis.com/manufacturers.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"name":"Google","url":"https://google.com"},"description":"Public API for managing Manufacturer Center related data.","title":"Manufacturer Center","version":"v1","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-apisguru-categories":["marketing"],"x-logo":{"url":"https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png"},"x-origin":[{"converter":{"url":"https://github.com/lucybot/api-spec-converter","version":"2.7.18"},"format":"google","url":"https://manufacturers.googleapis.com/$discovery/rest?version=v1","version":"v1"}],"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"manufacturers"},"externalDocs":{"url":"https://developers.google.com/manufacturers/"},"tags":[{"name":"accounts"}],"paths":{"/v1/{parent}/products":{"get":{"description":"Lists all the products in a Manufacturer Center account.","operationId":"manufacturers.accounts.products.list","parameters":[{"description":"The information to be included in the response. Only sections listed here\nwill be returned.","in":"query","name":"include","explode":true,"schema":{"type":"array","items":{"enum":["UNKNOWN","ATTRIBUTES","ISSUES","DESTINATION_STATUSES"],"type":"string"}}},{"description":"Maximum number of product statuses to return in the response, used for\npaging.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"The token returned by the previous request.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.","in":"path","name":"parent","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListProductsResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/manufacturercenter"]}],"tags":["accounts"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}]},"/v1/{parent}/products/{name}":{"delete":{"description":"Deletes the product from a Manufacturer Center account.","operationId":"manufacturers.accounts.products.delete","parameters":[{"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.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}},{"description":"Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.","in":"path","name":"parent","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Empty"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/manufacturercenter"]}],"tags":["accounts"]},"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.","operationId":"manufacturers.accounts.products.get","parameters":[{"description":"The information to be included in the response. Only sections listed here\nwill be returned.","in":"query","name":"include","explode":true,"schema":{"type":"array","items":{"enum":["UNKNOWN","ATTRIBUTES","ISSUES","DESTINATION_STATUSES"],"type":"string"}}},{"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.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}},{"description":"Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.","in":"path","name":"parent","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Product"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/manufacturercenter"]}],"tags":["accounts"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"put":{"description":"Inserts or updates the attributes of the product in a Manufacturer Center\naccount.\n\nCreates a product with the provided attributes. If the product already\nexists, then all attributes are replaced with the new ones. The checks at\nupload time are minimal. All required attributes need to be present for a\nproduct to be valid. Issues may show up later after the API has accepted a\nnew upload for a product and it is possible to overwrite an existing valid\nproduct with an invalid product. To detect this, you should retrieve the\nproduct and check it for issues once the new version is available.\n\nUploaded attributes first need to be processed before they can be\nretrieved. Until then, new products will be unavailable, and retrieval\nof previously uploaded products will return the original state of the\nproduct.","operationId":"manufacturers.accounts.products.update","parameters":[{"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.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}},{"description":"Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.","in":"path","name":"parent","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Attributes"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Empty"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/manufacturercenter"]}],"tags":["accounts"]}}},"servers":[{"url":"https://manufacturers.googleapis.com/"}],"components":{"parameters":{"access_token":{"description":"OAuth access token.","in":"query","name":"access_token","schema":{"type":"string"}},"alt":{"description":"Data format for response.","in":"query","name":"alt","schema":{"type":"string","enum":["json","media","proto"],"default":"json"}},"callback":{"description":"JSONP","in":"query","name":"callback","schema":{"type":"string"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"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.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean","default":true}},"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.","in":"query","name":"quotaUser","schema":{"type":"string"}},"uploadType":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","in":"query","name":"uploadType","schema":{"type":"string"}},"upload_protocol":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","in":"query","name":"upload_protocol","schema":{"type":"string"}},"_.xgafv":{"description":"V1 error format.","in":"query","name":"$.xgafv","schema":{"type":"string","enum":["1","2"]}}},"securitySchemes":{"Oauth2":{"description":"Oauth 2.0 authentication","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://accounts.google.com/o/oauth2/auth","scopes":{"https://www.googleapis.com/auth/manufacturercenter":"Manage your product listings for Google Manufacturer Center"}}}}},"schemas":{"Attributes":{"description":"Attributes of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116.","properties":{"additionalImageLink":{"description":"The additional images of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#addlimage.","items":{"$ref":"#/components/schemas/Image"},"type":"array"},"ageGroup":{"description":"The target age group of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#agegroup.","type":"string"},"brand":{"description":"The brand name of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#brand.","type":"string"},"capacity":{"$ref":"#/components/schemas/Capacity"},"color":{"description":"The color of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#color.","type":"string"},"count":{"$ref":"#/components/schemas/Count"},"description":{"description":"The description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#description.","type":"string"},"disclosureDate":{"description":"The disclosure date of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#disclosure.","type":"string"},"excludedDestination":{"description":"A list of excluded destinations.","items":{"type":"string"},"type":"array"},"featureDescription":{"description":"The rich format description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#featuredesc.","items":{"$ref":"#/components/schemas/FeatureDescription"},"type":"array"},"flavor":{"description":"The flavor of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#flavor.","type":"string"},"format":{"description":"The format of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#format.","type":"string"},"gender":{"description":"The target gender of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#gender.","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"},"imageLink":{"$ref":"#/components/schemas/Image"},"includedDestination":{"description":"A list of included destinations.","items":{"type":"string"},"type":"array"},"itemGroupId":{"description":"The item group id of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#itemgroupid.","type":"string"},"material":{"description":"The material of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#material.","type":"string"},"mpn":{"description":"The Manufacturer Part Number (MPN) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#mpn.","type":"string"},"pattern":{"description":"The pattern of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#pattern.","type":"string"},"productDetail":{"description":"The details of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.","items":{"$ref":"#/components/schemas/ProductDetail"},"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"},"productName":{"description":"The canonical name of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productname.","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"},"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"},"releaseDate":{"description":"The release date of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#release.","type":"string"},"scent":{"description":"The scent of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#scent.","type":"string"},"size":{"description":"The size of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#size.","type":"string"},"sizeSystem":{"description":"The size system of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#sizesystem.","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":"#/components/schemas/Price"},"targetClientId":{"description":"The target client id. Should only be used in the accounts of the data\npartners.","type":"string"},"theme":{"description":"The theme of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#theme.","type":"string"},"title":{"description":"The title of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#title.","type":"string"},"videoLink":{"description":"The videos of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#video.","items":{"type":"string"},"type":"array"}},"type":"object"},"Capacity":{"description":"The capacity of a product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity.","properties":{"unit":{"description":"The unit of the capacity, i.e., MB, GB, or TB.","type":"string"},"value":{"description":"The numeric value of the capacity.","format":"int64","type":"string"}},"type":"object"},"Count":{"description":"The number of products in a single package. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#count.","properties":{"unit":{"description":"The unit in which these products are counted.","type":"string"},"value":{"description":"The numeric value of the number of products in a package.","format":"int64","type":"string"}},"type":"object"},"DestinationStatus":{"description":"The destination status.","properties":{"destination":{"description":"The name of the destination.","type":"string"},"status":{"description":"The status of the destination.","enum":["UNKNOWN","ACTIVE","PENDING","DISAPPROVED"],"type":"string"}},"type":"object"},"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 `{}`.","properties":{},"type":"object"},"FeatureDescription":{"description":"A feature description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#featuredesc.","properties":{"headline":{"description":"A short description of the feature.","type":"string"},"image":{"$ref":"#/components/schemas/Image"},"text":{"description":"A detailed description of the feature.","type":"string"}},"type":"object"},"Image":{"description":"An image.","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":{"description":"The status of the image.\n@OutputOnly","enum":["STATUS_UNSPECIFIED","PENDING_PROCESSING","PENDING_CRAWL","OK","ROBOTED","XROBOTED","CRAWL_ERROR","PROCESSING_ERROR","DECODING_ERROR","TOO_BIG","CRAWL_SKIPPED","HOSTLOADED","HTTP_404"],"type":"string"},"type":{"description":"The type of the image, i.e., crawled or uploaded.\n@OutputOnly","enum":["TYPE_UNSPECIFIED","CRAWLED","UPLOADED"],"type":"string"}},"type":"object"},"Issue":{"description":"Product issue.","properties":{"attribute":{"description":"If present, the attribute that triggered the issue. For more information\nabout attributes, see\nhttps://support.google.com/manufacturers/answer/6124116.","type":"string"},"description":{"description":"Longer description of the issue focused on how to resolve it.","type":"string"},"destination":{"description":"The destination this issue applies to.","type":"string"},"resolution":{"description":"What needs to happen to resolve the issue.","enum":["RESOLUTION_UNSPECIFIED","USER_ACTION","PENDING_PROCESSING"],"type":"string"},"severity":{"description":"The severity of the issue.","enum":["SEVERITY_UNSPECIFIED","ERROR","WARNING","INFO"],"type":"string"},"timestamp":{"description":"The timestamp when this issue appeared.","format":"google-datetime","type":"string"},"title":{"description":"Short title describing the nature of the issue.","type":"string"},"type":{"description":"The server-generated type of the issue, for example,\n“INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc.","type":"string"}},"type":"object"},"ListProductsResponse":{"properties":{"nextPageToken":{"description":"The token for the retrieval of the next page of product statuses.","type":"string"},"products":{"description":"List of the products.","items":{"$ref":"#/components/schemas/Product"},"type":"array"}},"type":"object"},"Price":{"description":"A price.","properties":{"amount":{"description":"The numeric value of the price.","type":"string"},"currency":{"description":"The currency in which the price is denoted.","type":"string"}},"type":"object"},"Product":{"description":"Product data.","properties":{"attributes":{"$ref":"#/components/schemas/Attributes"},"contentLanguage":{"description":"The content language of the product as a two-letter ISO 639-1 language code\n(for example, en).","type":"string"},"destinationStatuses":{"description":"The status of the destinations.","items":{"$ref":"#/components/schemas/DestinationStatus"},"type":"array"},"issues":{"description":"A server-generated list of issues associated with the product.","items":{"$ref":"#/components/schemas/Issue"},"type":"array"},"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"},"parent":{"description":"Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.","type":"string"},"productId":{"description":"The ID of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#id.","type":"string"},"targetCountry":{"description":"The target country of the product as a CLDR territory code (for example,\nUS).","type":"string"}},"type":"object"},"ProductDetail":{"description":"A product detail of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.","properties":{"attributeName":{"description":"The name of the attribute.","type":"string"},"attributeValue":{"description":"The value of the attribute.","type":"string"},"sectionName":{"description":"A short section name that can be reused between multiple product details.","type":"string"}},"type":"object"}}}}