{ "id": "merchantapi:reviews_v1alpha", "baseUrl": "https://merchantapi.googleapis.com/", "protocol": "rest", "mtlsRootUrl": "https://merchantapi.mtls.googleapis.com/", "parameters": { "callback": { "description": "JSONP", "location": "query", "type": "string" }, "alt": { "type": "string", "description": "Data format for response.", "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", "enum": [ "json", "media", "proto" ], "default": "json" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "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.", "location": "query", "type": "string" }, "oauth_token": { "type": "string", "location": "query", "description": "OAuth 2.0 token for the current user." }, "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" }, "fields": { "type": "string", "description": "Selector specifying which fields to include in a partial response.", "location": "query" }, "uploadType": { "location": "query", "type": "string", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "location": "query", "type": "boolean", "default": "true" }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "description": "V1 error format.", "type": "string", "location": "query", "enum": [ "1", "2" ] }, "access_token": { "description": "OAuth access token.", "location": "query", "type": "string" } }, "servicePath": "", "kind": "discovery#restDescription", "basePath": "", "ownerName": "Google", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/content": { "description": "Manage your product listings and accounts for Google Shopping" } } } }, "title": "Merchant API", "revision": "20261006", "fullyEncodeReservedExpansion": true, "version": "reviews_v1alpha", "version_module": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "discoveryVersion": "v1", "description": "Programmatically manage your Merchant Center Accounts.", "ownerDomain": "google.com", "name": "merchantapi", "documentationLink": "https://developers.google.com/merchant/api", "canonicalName": "Merchant", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CustomAttribute": { "type": "object", "description": "A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.", "id": "CustomAttribute", "properties": { "value": { "description": "The value of the attribute. If `value` is not empty, `group_values` must be empty.", "type": "string" }, "groupValues": { "description": "Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.", "type": "array", "items": { "$ref": "CustomAttribute" } }, "name": { "description": "The name of the attribute.", "type": "string" } } }, "ProductReview": { "properties": { "dataSource": { "readOnly": true, "type": "string", "description": "Output only. The primary data source of the product review." }, "productReviewId": { "description": "Required. The permanent, unique identifier for the product review in the publisher’s system.", "type": "string" }, "customAttributes": { "description": "Optional. A list of custom (merchant-provided) attributes.", "items": { "$ref": "CustomAttribute" }, "type": "array" }, "productReviewAttributes": { "$ref": "ProductReviewAttributes", "description": "Optional. A list of product review attributes." }, "productReviewStatus": { "$ref": "ProductReviewStatus", "readOnly": true, "description": "Output only. The status of a product review, data validation issues, that is, information about a product review computed asynchronously." }, "name": { "type": "string", "description": "Identifier. The name of the product review. Format: `\"{productreview.name=accounts/{account}/productReviews/{productReview}}\"`" } }, "description": "A review for a product. For more information, see [Introduction to Product Review Feeds](https://developers.google.com/product-review-feeds)", "id": "ProductReview", "type": "object" }, "Empty": { "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); }", "type": "object", "id": "Empty", "properties": {} }, "ProductReviewDestinationStatus": { "description": "The destination status of the product review status.", "properties": { "reportingContext": { "readOnly": true, "enumDescriptions": [ "Not specified.", "[Shopping ads](https://support.google.com/merchants/answer/6149970).", "Deprecated: Use `DEMAND_GEN_ADS` instead. [Discovery and Demand Gen ads](https://support.google.com/merchants/answer/13389785).", "[Demand Gen ads](https://support.google.com/merchants/answer/13389785).", "[Demand Gen ads on Discover surface](https://support.google.com/merchants/answer/13389785).", "[Video ads](https://support.google.com/google-ads/answer/6340491).", "[Display ads](https://support.google.com/merchants/answer/6069387).", "[Local inventory ads](https://support.google.com/merchants/answer/3271956).", "[Vehicle inventory ads](https://support.google.com/merchants/answer/11544533).", "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free product listings on UCP checkout](https://developers.google.com/merchant/ucp).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", "YouTube Checkout .", "Real Estate Rental Ads. ." ], "enum": [ "REPORTING_CONTEXT_ENUM_UNSPECIFIED", "SHOPPING_ADS", "DISCOVERY_ADS", "DEMAND_GEN_ADS", "DEMAND_GEN_ADS_DISCOVER_SURFACE", "VIDEO_ADS", "DISPLAY_ADS", "LOCAL_INVENTORY_ADS", "VEHICLE_INVENTORY_ADS", "FREE_LISTINGS", "FREE_LISTINGS_UCP_CHECKOUT", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", "YOUTUBE_CHECKOUT", "RENTAL_ADS" ], "description": "Output only. The name of the reporting context.", "type": "string", "enumDeprecated": [ false, false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ] } }, "id": "ProductReviewDestinationStatus", "type": "object" }, "MerchantReview": { "id": "MerchantReview", "properties": { "customAttributes": { "items": { "$ref": "CustomAttribute" }, "type": "array", "description": "Optional. A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the data 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 experimental attributes. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per product, with total size of 102.4kB. Underscores in custom attribute names are replaced by spaces upon insertion." }, "merchantReviewId": { "description": "Required. The user provided merchant review ID to uniquely identify the merchant review.", "type": "string" }, "name": { "type": "string", "description": "Identifier. The name of the merchant review. Format: `\"{merchantreview.name=accounts/{account}/merchantReviews/{merchantReview}}\"`" }, "merchantReviewStatus": { "description": "Output only. The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously.", "$ref": "MerchantReviewStatus", "readOnly": true }, "merchantReviewAttributes": { "$ref": "MerchantReviewAttributes", "description": "Optional. A list of merchant review attributes." }, "dataSource": { "description": "Output only. The primary data source of the merchant review.", "readOnly": true, "type": "string" } }, "description": "A review for a merchant. For more information, see [Introduction to Merchant Review Feeds](https://developers.google.com/merchant-review-feeds)", "type": "object" }, "ProductReviewAttributes": { "description": "Attributes.", "properties": { "aggregatorName": { "description": "Optional. The name of the aggregator of the product reviews. A publisher may use a reviews aggregator to manage reviews and provide the feeds. This element indicates the use of an aggregator and contains information about the aggregator.", "type": "string" }, "subclientName": { "description": "Optional. The name of the subclient of the product reviews. The subclient is an identifier of the product review source. It should be equivalent to the directory provided in the file data source path.", "type": "string" }, "collectionMethod": { "enum": [ "COLLECTION_METHOD_UNSPECIFIED", "UNSOLICITED", "POST_FULFILLMENT" ], "enumDescriptions": [ "Collection method unspecified.", "The user was not responding to a specific solicitation when they submitted the review.", "The user submitted the review in response to a solicitation after fulfillment of the user's order." ], "description": "Optional. The method used to collect the review.", "type": "string" }, "reviewLink": { "description": "Optional. The URI of the review landing page.", "$ref": "ReviewLink" }, "reviewCountry": { "type": "string", "description": "Optional. The country of the review defined by ISO 3166-1 Alpha-2 Country Code." }, "reviewerUsername": { "description": "Optional. The name of the reviewer of the product review.", "type": "string" }, "publisherName": { "type": "string", "description": "Optional. The name of the publisher of the product reviews. The information about the publisher, which may be a retailer, manufacturer, reviews service company, or any entity that publishes product reviews." }, "isIncentivizedReview": { "type": "boolean", "description": "Optional. Indicates whether the review is incentivized." }, "publisherFavicon": { "description": "Optional. A link to the company favicon of the publisher. The image dimensions should be favicon size: 16x16 pixels. The image format should be GIF, JPG or PNG.", "type": "string" }, "skus": { "description": "Optional. Contains SKUs (stock keeping units) associated with a product. Often this matches the product Offer Id in the product feed.", "type": "array", "items": { "type": "string" } }, "mpns": { "description": "Optional. Contains MPNs (manufacturer part numbers) associated with a product.", "items": { "type": "string" }, "type": "array" }, "isSpam": { "description": "Optional. Indicates whether the review is marked as spam in the publisher's system.", "type": "boolean" }, "isVerifiedPurchase": { "type": "boolean", "description": "Optional. Indicates whether the reviewer's purchase is verified." }, "brands": { "description": "Optional. Contains brand names associated with a product.", "items": { "type": "string" }, "type": "array" }, "reviewerImageLinks": { "type": "array", "description": "Optional. A URI to an image of the reviewed product created by the review author. The URI does not have to end with an image file extension.", "items": { "type": "string" } }, "transactionId": { "description": "Optional. A permanent, unique identifier for the transaction associated with the review in the publisher's system. This ID can be used to indicate that multiple reviews are associated with the same transaction.", "type": "string" }, "title": { "type": "string", "description": "Optional. The title of the review." }, "reviewLanguage": { "type": "string", "description": "Optional. The language of the review defined by BCP-47 language code." }, "reviewTime": { "description": "Required. The timestamp indicating when the review was written.", "type": "string", "format": "google-datetime" }, "pros": { "items": { "type": "string" }, "description": "Optional. Contains the advantages based on the opinion of the reviewer. Omit boilerplate text like \"pro:\" unless it was written by the reviewer.", "type": "array" }, "asins": { "type": "array", "items": { "type": "string" }, "description": "Optional. Contains ASINs (Amazon Standard Identification Numbers) associated with a product." }, "productLinks": { "type": "array", "description": "Optional. The URI of the product. This URI can have the same value as the `review_link` element, if the review URI and the product URI are the same.", "items": { "type": "string" } }, "cons": { "description": "Optional. Contains the disadvantages based on the opinion of the reviewer. Omit boilerplate text like \"con:\" unless it was written by the reviewer.", "type": "array", "items": { "type": "string" } }, "maxRating": { "description": "Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min attribute.", "format": "int64", "type": "string" }, "minRating": { "description": "Optional. Contains the ratings associated with the review. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.", "type": "string", "format": "int64" }, "reviewerIsAnonymous": { "type": "boolean", "description": "Optional. Set to true if the reviewer should remain anonymous." }, "productNames": { "description": "Optional. Descriptive name of a product.", "type": "array", "items": { "type": "string" } }, "gtins": { "description": "Optional. Contains GTINs (global trade item numbers) associated with a product. Sub-types of GTINs (e.g. UPC, EAN, ISBN, JAN) are supported.", "type": "array", "items": { "type": "string" } }, "reviewerId": { "description": "Optional. The author of the product review. A permanent, unique identifier for the author of the review in the publisher's system.", "type": "string" }, "rating": { "description": "Optional. The reviewer's overall rating of the product.", "type": "number", "format": "double" }, "content": { "description": "Optional. The content of the review. If empty, the content might still get populated from pros and cons.", "type": "string" } }, "id": "ProductReviewAttributes", "type": "object" }, "ListProductReviewsResponse": { "properties": { "productReviews": { "description": "The product review.", "items": { "$ref": "ProductReview" }, "type": "array" }, "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" } }, "type": "object", "id": "ListProductReviewsResponse", "description": "response message for the ListProductReviews method." }, "ProductChange": { "properties": { "oldValue": { "description": "The old value of the changed resource or attribute. If empty, it means that the product was created. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)", "type": "string" }, "reportingContext": { "description": "Reporting contexts that have the change (if applicable). Currently this field supports only (`SHOPPING_ADS`, `LOCAL_INVENTORY_ADS`, `YOUTUBE_SHOPPING`, `YOUTUBE_CHECKOUT`, `YOUTUBE_AFFILIATE`) from the enum value [ReportingContextEnum](/merchant/api/reference/rest/Shared.Types/ReportingContextEnum)", "enumDeprecated": [ false, false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "type": "string", "enum": [ "REPORTING_CONTEXT_ENUM_UNSPECIFIED", "SHOPPING_ADS", "DISCOVERY_ADS", "DEMAND_GEN_ADS", "DEMAND_GEN_ADS_DISCOVER_SURFACE", "VIDEO_ADS", "DISPLAY_ADS", "LOCAL_INVENTORY_ADS", "VEHICLE_INVENTORY_ADS", "FREE_LISTINGS", "FREE_LISTINGS_UCP_CHECKOUT", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", "YOUTUBE_CHECKOUT", "RENTAL_ADS" ], "enumDescriptions": [ "Not specified.", "[Shopping ads](https://support.google.com/merchants/answer/6149970).", "Deprecated: Use `DEMAND_GEN_ADS` instead. [Discovery and Demand Gen ads](https://support.google.com/merchants/answer/13389785).", "[Demand Gen ads](https://support.google.com/merchants/answer/13389785).", "[Demand Gen ads on Discover surface](https://support.google.com/merchants/answer/13389785).", "[Video ads](https://support.google.com/google-ads/answer/6340491).", "[Display ads](https://support.google.com/merchants/answer/6069387).", "[Local inventory ads](https://support.google.com/merchants/answer/3271956).", "[Vehicle inventory ads](https://support.google.com/merchants/answer/11544533).", "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free product listings on UCP checkout](https://developers.google.com/merchant/ucp).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", "YouTube Checkout .", "Real Estate Rental Ads. ." ] }, "regionCode": { "description": "Countries that have the change (if applicable). Represented in the ISO 3166 format.", "type": "string" }, "newValue": { "type": "string", "description": "The new value of the changed resource or attribute. If empty, it means that the product was deleted. Will have one of these values : (`approved`, `pending`, `disapproved`, ``)" } }, "description": "The change that happened to the product including old value, new value, country code as the region code and reporting context.", "type": "object", "id": "ProductChange" }, "ListMerchantReviewsResponse": { "type": "object", "properties": { "merchantReviews": { "items": { "$ref": "MerchantReview" }, "description": "The merchant review.", "type": "array" }, "nextPageToken": { "description": "The token to retrieve the next page of results.", "type": "string" } }, "id": "ListMerchantReviewsResponse", "description": "Response message for the `ListMerchantsReview` method." }, "ProductStatusChangeMessage": { "description": "The message that the merchant will receive to notify about product status change event", "id": "ProductStatusChangeMessage", "type": "object", "properties": { "eventTime": { "type": "string", "format": "google-datetime", "description": "The time at which the event was generated. If you want to order the notification messages you receive you should rely on this field not on the order of receiving the notifications." }, "resourceId": { "description": "The product id.", "type": "string" }, "changes": { "description": "A message to describe the change that happened to the product", "items": { "$ref": "ProductChange" }, "type": "array" }, "account": { "description": "The target account that owns the entity that changed. Format : `accounts/{merchant_id}`", "type": "string" }, "attribute": { "type": "string", "description": "The attribute in the resource that changed, in this case it will be always `Status`.", "enum": [ "ATTRIBUTE_UNSPECIFIED", "STATUS" ], "enumDescriptions": [ "Unspecified attribute", "Status of the changed entity" ] }, "resourceType": { "enumDescriptions": [ "Unspecified resource", "Resource type : product", "Account service" ], "description": "The resource that changed, in this case it will always be `Product`.", "type": "string", "enum": [ "RESOURCE_UNSPECIFIED", "PRODUCT", "ACCOUNT_SERVICE" ] }, "resource": { "type": "string", "description": "The product name. Format: `accounts/{account}/products/{product}`" }, "expirationTime": { "description": "Optional. The product expiration time. This field will not be set if the notification is sent for a product deletion event.", "type": "string", "format": "google-datetime" }, "managingAccount": { "type": "string", "description": "The account that manages the merchant's account. can be the same as merchant id if it is standalone account. Format : `accounts/{service_provider_id}`" } } }, "ProductReviewItemLevelIssue": { "description": "The ItemLevelIssue of the product review status.", "properties": { "attribute": { "type": "string", "readOnly": true, "description": "Output only. The attribute's name, if the issue is caused by a single attribute." }, "severity": { "enum": [ "SEVERITY_UNSPECIFIED", "NOT_IMPACTED", "DISAPPROVED" ], "enumDescriptions": [ "Not specified.", "This issue represents a warning and does not have a direct affect on the product review.", "Issue disapproves the product review." ], "description": "Output only. How this issue affects serving of the product review.", "readOnly": true, "type": "string" }, "code": { "description": "Output only. The error code of the issue.", "readOnly": true, "type": "string" }, "resolution": { "readOnly": true, "type": "string", "description": "Output only. Whether the issue can be resolved by the merchant." }, "reportingContext": { "enum": [ "REPORTING_CONTEXT_ENUM_UNSPECIFIED", "SHOPPING_ADS", "DISCOVERY_ADS", "DEMAND_GEN_ADS", "DEMAND_GEN_ADS_DISCOVER_SURFACE", "VIDEO_ADS", "DISPLAY_ADS", "LOCAL_INVENTORY_ADS", "VEHICLE_INVENTORY_ADS", "FREE_LISTINGS", "FREE_LISTINGS_UCP_CHECKOUT", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", "YOUTUBE_CHECKOUT", "RENTAL_ADS" ], "description": "Output only. The reporting context the issue applies to.", "enumDescriptions": [ "Not specified.", "[Shopping ads](https://support.google.com/merchants/answer/6149970).", "Deprecated: Use `DEMAND_GEN_ADS` instead. [Discovery and Demand Gen ads](https://support.google.com/merchants/answer/13389785).", "[Demand Gen ads](https://support.google.com/merchants/answer/13389785).", "[Demand Gen ads on Discover surface](https://support.google.com/merchants/answer/13389785).", "[Video ads](https://support.google.com/google-ads/answer/6340491).", "[Display ads](https://support.google.com/merchants/answer/6069387).", "[Local inventory ads](https://support.google.com/merchants/answer/3271956).", "[Vehicle inventory ads](https://support.google.com/merchants/answer/11544533).", "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free product listings on UCP checkout](https://developers.google.com/merchant/ucp).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", "YouTube Checkout .", "Real Estate Rental Ads. ." ], "enumDeprecated": [ false, false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "readOnly": true, "type": "string" }, "description": { "readOnly": true, "type": "string", "description": "Output only. A short issue description in English." }, "detail": { "type": "string", "readOnly": true, "description": "Output only. A detailed issue description in English." }, "documentation": { "readOnly": true, "type": "string", "description": "Output only. The URL of a web page to help with resolving this issue." } }, "id": "ProductReviewItemLevelIssue", "type": "object" }, "MerchantReviewStatus": { "description": "The status of a merchant review, data validation issues, that is, information about a merchant review computed asynchronously.", "type": "object", "properties": { "itemLevelIssues": { "items": { "$ref": "MerchantReviewItemLevelIssue" }, "type": "array", "description": "Output only. A list of all issues associated with the merchant review.", "readOnly": true }, "createTime": { "readOnly": true, "description": "Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", "format": "google-datetime", "type": "string" }, "destinationStatuses": { "type": "array", "readOnly": true, "description": "Output only. The intended destinations for the merchant review.", "items": { "$ref": "MerchantReviewDestinationStatus" } }, "lastUpdateTime": { "description": "Output only. Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", "readOnly": true, "format": "google-datetime", "type": "string" } }, "id": "MerchantReviewStatus" }, "ProductReviewStatus": { "type": "object", "id": "ProductReviewStatus", "description": "Product review status.", "properties": { "lastUpdateTime": { "type": "string", "format": "google-datetime", "description": "Output only. Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", "readOnly": true }, "createTime": { "format": "google-datetime", "type": "string", "readOnly": true, "description": "Output only. Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format." }, "destinationStatuses": { "type": "array", "items": { "$ref": "ProductReviewDestinationStatus" }, "description": "Output only. The intended destinations for the product review.", "readOnly": true }, "itemLevelIssues": { "description": "Output only. A list of all issues associated with the product review.", "type": "array", "items": { "$ref": "ProductReviewItemLevelIssue" }, "readOnly": true } } }, "MerchantReviewDestinationStatus": { "description": "The destination status of the merchant review status.", "id": "MerchantReviewDestinationStatus", "type": "object", "properties": { "reportingContext": { "type": "string", "readOnly": true, "enumDeprecated": [ false, false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "enumDescriptions": [ "Not specified.", "[Shopping ads](https://support.google.com/merchants/answer/6149970).", "Deprecated: Use `DEMAND_GEN_ADS` instead. [Discovery and Demand Gen ads](https://support.google.com/merchants/answer/13389785).", "[Demand Gen ads](https://support.google.com/merchants/answer/13389785).", "[Demand Gen ads on Discover surface](https://support.google.com/merchants/answer/13389785).", "[Video ads](https://support.google.com/google-ads/answer/6340491).", "[Display ads](https://support.google.com/merchants/answer/6069387).", "[Local inventory ads](https://support.google.com/merchants/answer/3271956).", "[Vehicle inventory ads](https://support.google.com/merchants/answer/11544533).", "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free product listings on UCP checkout](https://developers.google.com/merchant/ucp).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", "YouTube Checkout .", "Real Estate Rental Ads. ." ], "enum": [ "REPORTING_CONTEXT_ENUM_UNSPECIFIED", "SHOPPING_ADS", "DISCOVERY_ADS", "DEMAND_GEN_ADS", "DEMAND_GEN_ADS_DISCOVER_SURFACE", "VIDEO_ADS", "DISPLAY_ADS", "LOCAL_INVENTORY_ADS", "VEHICLE_INVENTORY_ADS", "FREE_LISTINGS", "FREE_LISTINGS_UCP_CHECKOUT", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", "YOUTUBE_CHECKOUT", "RENTAL_ADS" ], "description": "Output only. The name of the reporting context." } } }, "ReviewLink": { "type": "object", "properties": { "type": { "description": "Optional. Type of the review URI.", "type": "string", "enumDescriptions": [ "Type unspecified.", "The review page contains only this single review.", "The review page contains a group of reviews including this review." ], "enum": [ "TYPE_UNSPECIFIED", "SINGLETON", "GROUP" ] }, "link": { "type": "string", "description": "Optional. The URI of the review landing page. For example: `http://www.example.com/review_5.html`." } }, "description": "The URI of the review landing page.", "id": "ReviewLink" }, "MerchantReviewAttributes": { "type": "object", "description": "Attributes.", "properties": { "reviewerUsername": { "description": "Optional. Display name of the review author.", "type": "string" }, "content": { "type": "string", "description": "Required. This should be any freeform text provided by the user and should not be truncated. If multiple responses to different questions are provided, all responses should be included, with the minimal context for the responses to make sense. Context should not be provided if questions were left unanswered." }, "isAnonymous": { "description": "Optional. Set to true if the reviewer should remain anonymous.", "type": "boolean" }, "collectionMethod": { "type": "string", "enumDescriptions": [ "Collection method unspecified.", "The user was not responding to a specific solicitation when they submitted the review.", "The user submitted the review in response to a solicitation when the user placed an order.", "The user submitted the review in response to a solicitation after fulfillment of the user's order." ], "description": "Optional. The method used to collect the review.", "enum": [ "COLLECTION_METHOD_UNSPECIFIED", "MERCHANT_UNSOLICITED", "POINT_OF_SALE", "AFTER_FULFILLMENT" ] }, "merchantRatingLink": { "description": "Optional. URL to the landing page that hosts the reviews for this merchant. Do not use a redirect URL.", "type": "string" }, "rating": { "description": "Optional. The reviewer's overall rating of the merchant.", "type": "number", "format": "double" }, "merchantId": { "description": "Required. Must be unique and stable across all requests. In other words, if a request today and another 90 days ago refer to the same merchant, they must have the same id.", "type": "string" }, "maxRating": { "description": "Optional. The maximum possible number for the rating. The value of the max rating must be greater than the value of the min rating.", "type": "string", "format": "int64" }, "merchantDisplayName": { "description": "Optional. Human-readable display name for the merchant.", "type": "string" }, "minRating": { "type": "string", "description": "Optional. The minimum possible number for the rating. This should be the worst possible rating and should not be a value for no rating.", "format": "int64" }, "reviewTime": { "type": "string", "format": "google-datetime", "description": "Required. The timestamp indicating when the review was written." }, "merchantLink": { "type": "string", "description": "Optional. URL to the merchant's main website. Do not use a redirect URL for this value. In other words, the value should point directly to the merchant's site." }, "reviewerId": { "type": "string", "description": "Optional. A permanent, unique identifier for the author of the review in the publisher's system." }, "reviewLanguage": { "description": "Optional. The language of the review defined by BCP-47 language code.", "type": "string" }, "title": { "type": "string", "description": "Optional. The title of the review." }, "reviewCountry": { "type": "string", "description": "Optional. The country where the reviewer made the order defined by ISO 3166-1 Alpha-2 Country Code." } }, "id": "MerchantReviewAttributes" }, "MerchantReviewItemLevelIssue": { "properties": { "detail": { "description": "Output only. A detailed issue description in English.", "readOnly": true, "type": "string" }, "code": { "type": "string", "readOnly": true, "description": "Output only. The error code of the issue." }, "description": { "readOnly": true, "type": "string", "description": "Output only. A short issue description in English." }, "resolution": { "description": "Output only. Whether the issue can be resolved by the merchant.", "readOnly": true, "type": "string" }, "documentation": { "readOnly": true, "description": "Output only. The URL of a web page to help with resolving this issue.", "type": "string" }, "attribute": { "readOnly": true, "description": "Output only. The attribute's name, if the issue is caused by a single attribute.", "type": "string" }, "severity": { "enum": [ "SEVERITY_UNSPECIFIED", "NOT_IMPACTED", "DISAPPROVED" ], "description": "Output only. How this issue affects serving of the merchant review.", "readOnly": true, "enumDescriptions": [ "Not specified.", "This issue represents a warning and does not have a direct affect on the merchant review.", "Issue disapproves the merchant review." ], "type": "string" }, "reportingContext": { "enumDescriptions": [ "Not specified.", "[Shopping ads](https://support.google.com/merchants/answer/6149970).", "Deprecated: Use `DEMAND_GEN_ADS` instead. [Discovery and Demand Gen ads](https://support.google.com/merchants/answer/13389785).", "[Demand Gen ads](https://support.google.com/merchants/answer/13389785).", "[Demand Gen ads on Discover surface](https://support.google.com/merchants/answer/13389785).", "[Video ads](https://support.google.com/google-ads/answer/6340491).", "[Display ads](https://support.google.com/merchants/answer/6069387).", "[Local inventory ads](https://support.google.com/merchants/answer/3271956).", "[Vehicle inventory ads](https://support.google.com/merchants/answer/11544533).", "[Free product listings](https://support.google.com/merchants/answer/9199328).", "[Free product listings on UCP checkout](https://developers.google.com/merchant/ucp).", "[Free local product listings](https://support.google.com/merchants/answer/9825611).", "[Free local vehicle listings](https://support.google.com/merchants/answer/11544533).", "[Youtube Affiliate](https://support.google.com/youtube/answer/13376398).", "[YouTube Shopping](https://support.google.com/merchants/answer/13478370).", "[Cloud retail](https://cloud.google.com/solutions/retail).", "[Local cloud retail](https://cloud.google.com/solutions/retail).", "[Product Reviews](https://support.google.com/merchants/answer/14620732).", "[Merchant Reviews](https://developers.google.com/merchant-review-feeds).", "YouTube Checkout .", "Real Estate Rental Ads. ." ], "enumDeprecated": [ false, false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "enum": [ "REPORTING_CONTEXT_ENUM_UNSPECIFIED", "SHOPPING_ADS", "DISCOVERY_ADS", "DEMAND_GEN_ADS", "DEMAND_GEN_ADS_DISCOVER_SURFACE", "VIDEO_ADS", "DISPLAY_ADS", "LOCAL_INVENTORY_ADS", "VEHICLE_INVENTORY_ADS", "FREE_LISTINGS", "FREE_LISTINGS_UCP_CHECKOUT", "FREE_LOCAL_LISTINGS", "FREE_LOCAL_VEHICLE_LISTINGS", "YOUTUBE_AFFILIATE", "YOUTUBE_SHOPPING", "CLOUD_RETAIL", "LOCAL_CLOUD_RETAIL", "PRODUCT_REVIEWS", "MERCHANT_REVIEWS", "YOUTUBE_CHECKOUT", "RENTAL_ADS" ], "readOnly": true, "description": "Output only. The reporting context the issue applies to.", "type": "string" } }, "type": "object", "description": "The ItemLevelIssue of the merchant review status.", "id": "MerchantReviewItemLevelIssue" } }, "resources": { "accounts": { "resources": { "merchantReviews": { "methods": { "get": { "path": "reviews/v1alpha/{+name}", "httpMethod": "GET", "parameterOrder": [ "name" ], "description": "Gets a merchant review.", "scopes": [ "https://www.googleapis.com/auth/content" ], "flatPath": "reviews/v1alpha/accounts/{accountsId}/merchantReviews/{merchantReviewsId}", "response": { "$ref": "MerchantReview" }, "parameters": { "name": { "description": "Required. The ID of the merchant review. Format: accounts/{account}/merchantReviews/{merchantReview}", "location": "path", "type": "string", "pattern": "^accounts/[^/]+/merchantReviews/[^/]+$", "required": true } }, "id": "merchantapi.accounts.merchantReviews.get" }, "insert": { "parameters": { "parent": { "description": "Required. The account where the merchant review will be inserted. Format: accounts/{account}", "required": true, "location": "path", "pattern": "^accounts/[^/]+$", "type": "string" }, "dataSource": { "description": "Required. The data source of the [merchantreview](https://support.google.com/merchants/answer/7045996?sjid=5253581244217581976-EU) Format: `accounts/{account}/dataSources/{datasource}`.", "location": "query", "type": "string" } }, "id": "merchantapi.accounts.merchantReviews.insert", "response": { "$ref": "MerchantReview" }, "request": { "$ref": "MerchantReview" }, "flatPath": "reviews/v1alpha/accounts/{accountsId}/merchantReviews:insert", "description": "Inserts a review for your Merchant Center account. If the review already exists, then the review is replaced with the new instance.", "scopes": [ "https://www.googleapis.com/auth/content" ], "httpMethod": "POST", "parameterOrder": [ "parent" ], "path": "reviews/v1alpha/{+parent}/merchantReviews:insert" }, "delete": { "description": "Deletes merchant review.", "response": { "$ref": "Empty" }, "httpMethod": "DELETE", "flatPath": "reviews/v1alpha/accounts/{accountsId}/merchantReviews/{merchantReviewsId}", "id": "merchantapi.accounts.merchantReviews.delete", "parameterOrder": [ "name" ], "path": "reviews/v1alpha/{+name}", "parameters": { "name": { "location": "path", "type": "string", "pattern": "^accounts/[^/]+/merchantReviews/[^/]+$", "required": true, "description": "Required. The ID of the merchant review. Format: accounts/{account}/merchantReviews/{merchantReview}" } }, "scopes": [ "https://www.googleapis.com/auth/content" ] }, "list": { "parameterOrder": [ "parent" ], "parameters": { "pageToken": { "description": "Optional. A page token, received from a previous `ListMerchantReviews` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListMerchantReviews` must match the call that provided the page token.", "type": "string", "location": "query" }, "parent": { "type": "string", "required": true, "pattern": "^accounts/[^/]+$", "location": "path", "description": "Required. The account to list merchant reviews for. Format: accounts/{account}" }, "pageSize": { "type": "integer", "description": "Optional. The maximum number of merchant reviews to return. The service can return fewer than this value. The maximum value is 1000; values above 1000 are coerced to 1000. If unspecified, the maximum number of reviews is returned.", "location": "query", "format": "int32" } }, "path": "reviews/v1alpha/{+parent}/merchantReviews", "description": "Lists merchant reviews.", "id": "merchantapi.accounts.merchantReviews.list", "scopes": [ "https://www.googleapis.com/auth/content" ], "response": { "$ref": "ListMerchantReviewsResponse" }, "flatPath": "reviews/v1alpha/accounts/{accountsId}/merchantReviews", "httpMethod": "GET" } } }, "productReviews": { "methods": { "list": { "response": { "$ref": "ListProductReviewsResponse" }, "scopes": [ "https://www.googleapis.com/auth/content" ], "parameterOrder": [ "parent" ], "parameters": { "pageSize": { "format": "int32", "description": "Optional. The maximum number of products to return. The service may return fewer than this value.", "location": "query", "type": "integer" }, "parent": { "location": "path", "type": "string", "pattern": "^accounts/[^/]+$", "description": "Required. The account to list product reviews for. Format: accounts/{account}", "required": true }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A page token, received from a previous `ListProductReviews` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListProductReviews` must match the call that provided the page token." } }, "id": "merchantapi.accounts.productReviews.list", "flatPath": "reviews/v1alpha/accounts/{accountsId}/productReviews", "httpMethod": "GET", "path": "reviews/v1alpha/{+parent}/productReviews", "description": "Lists product reviews." }, "insert": { "parameterOrder": [ "parent" ], "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/content" ], "description": "Inserts a product review.", "response": { "$ref": "ProductReview" }, "request": { "$ref": "ProductReview" }, "parameters": { "parent": { "type": "string", "location": "path", "pattern": "^accounts/[^/]+$", "description": "Required. The account where the product review will be inserted. Format: accounts/{account}", "required": true }, "dataSource": { "location": "query", "description": "Required. Format: `accounts/{account}/dataSources/{datasource}`.", "type": "string" } }, "flatPath": "reviews/v1alpha/accounts/{accountsId}/productReviews:insert", "path": "reviews/v1alpha/{+parent}/productReviews:insert", "id": "merchantapi.accounts.productReviews.insert" }, "get": { "parameterOrder": [ "name" ], "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/content" ], "description": "Gets a product review.", "flatPath": "reviews/v1alpha/accounts/{accountsId}/productReviews/{productReviewsId}", "id": "merchantapi.accounts.productReviews.get", "path": "reviews/v1alpha/{+name}", "parameters": { "name": { "pattern": "^accounts/[^/]+/productReviews/[^/]+$", "location": "path", "type": "string", "description": "Required. The ID of the merchant review. Format: accounts/{account}/productReviews/{productReview}", "required": true } }, "response": { "$ref": "ProductReview" } }, "delete": { "id": "merchantapi.accounts.productReviews.delete", "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/content" ], "parameterOrder": [ "name" ], "path": "reviews/v1alpha/{+name}", "flatPath": "reviews/v1alpha/accounts/{accountsId}/productReviews/{productReviewsId}", "parameters": { "name": { "type": "string", "location": "path", "pattern": "^accounts/[^/]+/productReviews/[^/]+$", "description": "Required. The ID of the Product review. Format: accounts/{account}/productReviews/{productReview}", "required": true } }, "description": "Deletes a product review.", "response": { "$ref": "Empty" } } } } } } }, "batchPath": "batch" }