{ "mtlsRootUrl": "https://merchantapi.mtls.googleapis.com/", "discoveryVersion": "v1", "rootUrl": "https://merchantapi.googleapis.com/", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/content": { "description": "Manage your product listings and accounts for Google Shopping" } } } }, "basePath": "", "ownerName": "Google", "revision": "20260930", "parameters": { "alt": { "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" ], "enum": [ "json", "media", "proto" ], "default": "json", "location": "query", "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.", "location": "query", "type": "string" }, "callback": { "type": "string", "location": "query", "description": "JSONP" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "location": "query", "type": "string" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "location": "query", "type": "string" }, "prettyPrint": { "type": "boolean", "description": "Returns response with indentations and line breaks.", "default": "true", "location": "query" }, "$.xgafv": { "description": "V1 error format.", "location": "query", "enum": [ "1", "2" ], "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string" }, "quotaUser": { "type": "string", "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" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, "access_token": { "location": "query", "type": "string", "description": "OAuth access token." } }, "kind": "discovery#restDescription", "name": "merchantapi", "fullyEncodeReservedExpansion": true, "documentationLink": "https://developers.google.com/merchant/api", "servicePath": "", "version": "reports_v1alpha", "protocol": "rest", "version_module": true, "ownerDomain": "google.com", "schemas": { "BestSellersProductClusterView": { "type": "object", "properties": { "variantGtins": { "items": { "type": "string" }, "type": "array", "description": "GTINs of example variants of the product cluster." }, "categoryL5": { "description": "Product category (5th level) of the product cluster, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", "type": "string" }, "categoryL1": { "type": "string", "description": "Product category (1st level) of the product cluster, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436)." }, "categoryL4": { "description": "Product category (4th level) of the product cluster, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", "type": "string" }, "reportDate": { "description": "Report date. The value of this field can only be one of the following: * The first day of the week (Monday) for weekly reports, * The first day of the month for monthly reports. Required in the `SELECT` clause. If a `WHERE` condition on `report_date` is not specified in the query, the latest available weekly or monthly report is returned.", "$ref": "Date" }, "title": { "description": "Title of the product cluster.", "type": "string" }, "relativeDemand": { "enumDescriptions": [ "Not specified.", "Demand is 0-5% of the demand of the highest ranked product cluster or brand.", "Demand is 6-10% of the demand of the highest ranked product cluster or brand.", "Demand is 11-20% of the demand of the highest ranked product cluster or brand.", "Demand is 21-50% of the demand of the highest ranked product cluster or brand.", "Demand is 51-100% of the demand of the highest ranked product cluster or brand." ], "type": "string", "description": "Estimated demand in relation to the product cluster with the highest popularity rank in the same category and country.", "enum": [ "RELATIVE_DEMAND_ENUM_UNSPECIFIED", "VERY_LOW", "LOW", "MEDIUM", "HIGH", "VERY_HIGH" ] }, "inventoryStatus": { "enum": [ "INVENTORY_STATUS_UNSPECIFIED", "IN_STOCK", "OUT_OF_STOCK", "NOT_IN_INVENTORY" ], "description": "Whether the product cluster is `IN_STOCK` in your product data source in at least one of the countries, `OUT_OF_STOCK` in your product data source in all countries, or `NOT_IN_INVENTORY` at all. The field doesn't take the Best sellers report country filter into account.", "enumDescriptions": [ "Not specified.", "You have a product for this product cluster or brand in stock.", "You have a product for this product cluster or brand in inventory but it is currently out of stock.", "You do not have a product for this product cluster or brand in inventory." ], "type": "string" }, "rank": { "format": "int64", "type": "string", "description": "Popularity of the product cluster on Ads and organic surfaces, in the selected category and country, based on the estimated number of units sold." }, "reportCategoryId": { "format": "int64", "description": "Google product category ID to calculate the ranking for, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436). Required in the `SELECT` clause. If a `WHERE` condition on `report_category_id` is not specified in the query, rankings for all top-level categories are returned.", "type": "string" }, "previousRank": { "format": "int64", "type": "string", "description": "Popularity rank in the previous week or month." }, "categoryL2": { "description": "Product category (2nd level) of the product cluster, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", "type": "string" }, "relativeDemandChange": { "enum": [ "RELATIVE_DEMAND_CHANGE_TYPE_ENUM_UNSPECIFIED", "SINKER", "FLAT", "RISER" ], "enumDescriptions": [ "Not specified.", "Relative demand is lower than the previous time period.", "Relative demand is equal to the previous time period.", "Relative demand is higher than the previous time period." ], "type": "string", "description": "Change in the estimated demand. Whether it rose, sank or remained flat." }, "brandInventoryStatus": { "description": "Whether there is at least one product of the brand currently `IN_STOCK` in your product data source in at least one of the countries, all products are `OUT_OF_STOCK` in your product data source in all countries, or `NOT_IN_INVENTORY`. The field doesn't take the Best sellers report country filter into account.", "type": "string", "enumDescriptions": [ "Not specified.", "You have a product for this product cluster or brand in stock.", "You have a product for this product cluster or brand in inventory but it is currently out of stock.", "You do not have a product for this product cluster or brand in inventory." ], "enum": [ "INVENTORY_STATUS_UNSPECIFIED", "IN_STOCK", "OUT_OF_STOCK", "NOT_IN_INVENTORY" ] }, "reportCountryCode": { "type": "string", "description": "Country where the ranking is calculated. Represented in the ISO 3166 format. Required in the `SELECT` clause. Condition on `report_country_code` is required in the `WHERE` clause." }, "brand": { "description": "Brand of the product cluster.", "type": "string" }, "categoryL3": { "type": "string", "description": "Product category (3rd level) of the product cluster, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436)." }, "previousRelativeDemand": { "type": "string", "enumDescriptions": [ "Not specified.", "Demand is 0-5% of the demand of the highest ranked product cluster or brand.", "Demand is 6-10% of the demand of the highest ranked product cluster or brand.", "Demand is 11-20% of the demand of the highest ranked product cluster or brand.", "Demand is 21-50% of the demand of the highest ranked product cluster or brand.", "Demand is 51-100% of the demand of the highest ranked product cluster or brand." ], "description": "Estimated demand in relation to the product cluster with the highest popularity rank in the same category and country in the previous week or month.", "enum": [ "RELATIVE_DEMAND_ENUM_UNSPECIFIED", "VERY_LOW", "LOW", "MEDIUM", "HIGH", "VERY_HIGH" ] }, "reportGranularity": { "type": "string", "description": "Granularity of the report. The ranking can be done over a week or a month timeframe. Required in the `SELECT` clause. Condition on `report_granularity` is required in the `WHERE` clause.", "enumDescriptions": [ "Not specified.", "Report is computed over a week timeframe.", "Report is computed over a month timeframe." ], "enum": [ "REPORT_GRANULARITY_ENUM_UNSPECIFIED", "WEEKLY", "MONTHLY" ] } }, "description": "Fields available for query in `best_sellers_product_cluster_view` table. [Best sellers](https://support.google.com/merchants/answer/9488679) report with top product clusters. A product cluster is a grouping for different offers and variants that represent the same product, for example, Google Pixel 7. Values are only set for fields requested explicitly in the request's search query.", "id": "BestSellersProductClusterView" }, "YoutubeCampaignVideosStatsView": { "description": "Fields available for query in `youtube_campaign_videos_stats_view` table.", "type": "object", "id": "YoutubeCampaignVideosStatsView", "properties": { "commissions": { "description": "Net commission amount includes both purchase and refunds.", "$ref": "Price" }, "productTitles": { "description": "Set of unique [product titles](https://support.google.com/merchants/answer/188494#id) tagged in the video.", "type": "string" }, "conversionRate": { "type": "number", "format": "double", "description": "Conversion rate." }, "orders": { "description": "Number of orders.", "format": "int64", "type": "string" }, "contentType": { "enumDescriptions": [ "Not specified.", "Video content streamed in real-time.", "Short-form, vertical video format, typically up to 60 seconds.", "Ephemeral, short-form video or image collections. Note: YouTube Stories are deprecated.", "Standard on-demand video format (VOD). This includes pre-recorded uploads that are not classified as SHORTS or LIVE_STREAM.", "Community updates which can include text, images, polls, or videos, shared with channel subscribers." ], "type": "string", "enum": [ "CONTENT_TYPE_UNSPECIFIED", "LIVE_STREAM", "SHORTS", "STORY", "VIDEO", "POST" ], "description": "Video format (e.g. video, shorts, live stream)." }, "videoId": { "description": "The ID of the video.", "type": "string" }, "channelId": { "type": "string", "description": "The ID of the creator channel. Required filter in `WHERE` clause." }, "netSales": { "description": "Net sales amount includes both purchase and refunds.", "$ref": "Price" }, "views": { "type": "string", "format": "int64", "description": "Number of YouTube views." }, "clicks": { "description": "Number of product clicks.", "format": "int64", "type": "string" }, "date": { "$ref": "Date", "description": "Date in the Merchant Center account timezone to which metrics apply. Segment. Required in the `WHERE` clause. Cannot be selected." }, "campaignId": { "type": "string", "description": "The ID of the campaign. Required filter in `WHERE` clause." }, "impressions": { "type": "string", "format": "int64", "description": "Number of impressions." }, "videoTitle": { "description": "The title of the video.", "type": "string" }, "grossSales": { "$ref": "Price", "description": "Gross sales amount, excluding refunds." } } }, "SearchResponse": { "properties": { "results": { "description": "Rows that matched the search query.", "items": { "$ref": "ReportRow" }, "type": "array" }, "nextPageToken": { "type": "string", "description": "Token which can be sent as `page_token` to retrieve the next page. If omitted, there are no subsequent pages." } }, "type": "object", "description": "Response message for the `ReportService.Search` method.", "id": "SearchResponse" }, "BestSellersBrandView": { "type": "object", "properties": { "reportGranularity": { "description": "Granularity of the report. The ranking can be done over a week or a month timeframe. Required in the `SELECT` clause. Condition on `report_granularity` is required in the `WHERE` clause.", "type": "string", "enumDescriptions": [ "Not specified.", "Report is computed over a week timeframe.", "Report is computed over a month timeframe." ], "enum": [ "REPORT_GRANULARITY_ENUM_UNSPECIFIED", "WEEKLY", "MONTHLY" ] }, "reportDate": { "$ref": "Date", "description": "Report date. The value of this field can only be one of the following: * The first day of the week (Monday) for weekly reports, * The first day of the month for monthly reports. Required in the `SELECT` clause. If a `WHERE` condition on `report_date` is not specified in the query, the latest available weekly or monthly report is returned." }, "previousRelativeDemand": { "type": "string", "enumDescriptions": [ "Not specified.", "Demand is 0-5% of the demand of the highest ranked product cluster or brand.", "Demand is 6-10% of the demand of the highest ranked product cluster or brand.", "Demand is 11-20% of the demand of the highest ranked product cluster or brand.", "Demand is 21-50% of the demand of the highest ranked product cluster or brand.", "Demand is 51-100% of the demand of the highest ranked product cluster or brand." ], "enum": [ "RELATIVE_DEMAND_ENUM_UNSPECIFIED", "VERY_LOW", "LOW", "MEDIUM", "HIGH", "VERY_HIGH" ], "description": "Estimated demand in relation to the brand with the highest popularity rank in the same category and country in the previous week or month." }, "brand": { "description": "Name of the brand.", "type": "string" }, "reportCountryCode": { "description": "Country where the ranking is calculated. Represented in the ISO 3166 format. Required in the `SELECT` clause. Condition on `report_country_code` is required in the `WHERE` clause.", "type": "string" }, "relativeDemandChange": { "type": "string", "description": "Change in the estimated demand. Whether it rose, sank or remained flat.", "enum": [ "RELATIVE_DEMAND_CHANGE_TYPE_ENUM_UNSPECIFIED", "SINKER", "FLAT", "RISER" ], "enumDescriptions": [ "Not specified.", "Relative demand is lower than the previous time period.", "Relative demand is equal to the previous time period.", "Relative demand is higher than the previous time period." ] }, "reportCategoryId": { "description": "Google product category ID to calculate the ranking for, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436). Required in the `SELECT` clause. If a `WHERE` condition on `report_category_id` is not specified in the query, rankings for all top-level categories are returned.", "type": "string", "format": "int64" }, "previousRank": { "format": "int64", "description": "Popularity rank in the previous week or month.", "type": "string" }, "rank": { "format": "int64", "description": "Popularity of the brand on Ads and organic surfaces, in the selected category and country, based on the estimated number of units sold.", "type": "string" }, "relativeDemand": { "enum": [ "RELATIVE_DEMAND_ENUM_UNSPECIFIED", "VERY_LOW", "LOW", "MEDIUM", "HIGH", "VERY_HIGH" ], "enumDescriptions": [ "Not specified.", "Demand is 0-5% of the demand of the highest ranked product cluster or brand.", "Demand is 6-10% of the demand of the highest ranked product cluster or brand.", "Demand is 11-20% of the demand of the highest ranked product cluster or brand.", "Demand is 21-50% of the demand of the highest ranked product cluster or brand.", "Demand is 51-100% of the demand of the highest ranked product cluster or brand." ], "type": "string", "description": "Estimated demand in relation to the brand with the highest popularity rank in the same category and country." } }, "description": "Fields available for query in `best_sellers_brand_view` table. [Best sellers](https://support.google.com/merchants/answer/9488679) report with top brands. Values are only set for fields requested explicitly in the request's search query.", "id": "BestSellersBrandView" }, "YoutubeCampaignProductsStatsView": { "description": "Fields available for query in `youtube_campaign_products_stats_view` table.", "properties": { "commissions": { "description": "Optional. Net commission amount includes both purchases and refunds.", "$ref": "Price" }, "contentType": { "type": "string", "enumDescriptions": [ "Not specified.", "Video content streamed in real-time.", "Short-form, vertical video format, typically up to 60 seconds.", "Ephemeral, short-form video or image collections. Note: YouTube Stories are deprecated.", "Standard on-demand video format (VOD). This includes pre-recorded uploads that are not classified as SHORTS or LIVE_STREAM.", "Community updates which can include text, images, polls, or videos, shared with channel subscribers." ], "enum": [ "CONTENT_TYPE_UNSPECIFIED", "LIVE_STREAM", "SHORTS", "STORY", "VIDEO", "POST" ], "description": "Optional. The format of the video." }, "views": { "type": "string", "description": "Optional. Number of YouTube views.", "format": "int64" }, "netSales": { "description": "Optional. Net sales amount includes both purchases and refunds.", "$ref": "Price" }, "videoTitle": { "description": "Optional. The title of the video.", "type": "string" }, "clicks": { "type": "string", "format": "int64", "description": "Optional. Number of product clicks." }, "grossSales": { "$ref": "Price", "description": "Optional. Gross sales amount, excluding refunds." }, "videoUrl": { "type": "string", "description": "Optional. The URL of the video." }, "conversionRate": { "description": "Optional. Conversion rate.", "type": "number", "format": "double" }, "campaignId": { "description": "Required. The id of the campaign. Required filter in `WHERE` clause.", "type": "string" }, "date": { "description": "Required. Date in the Merchant Center account timezone to which metrics apply. Segment. Required in the `WHERE` clause. Cannot be selected.", "$ref": "Date" }, "productTitle": { "description": "Optional. The title of the product.", "type": "string" }, "videoId": { "description": "Optional. The id of the video.", "type": "string" }, "orders": { "description": "Optional. Number of orders.", "format": "int64", "type": "string" }, "channelTitle": { "type": "string", "description": "Optional. The title of the creator channel." }, "impressions": { "format": "int64", "description": "Optional. Number of impressions.", "type": "string" } }, "id": "YoutubeCampaignProductsStatsView", "type": "object" }, "ItemIssueSeverity": { "type": "object", "description": "How the issue affects the serving of the product.", "id": "ItemIssueSeverity", "properties": { "aggregatedSeverity": { "enumDescriptions": [ "Not specified.", "Issue disapproves the product in at least one reporting context.", "Issue demotes the product in all reporting contexts it affects.", "Issue resolution is `PENDING_PROCESSING`." ], "enum": [ "AGGREGATED_ISSUE_SEVERITY_UNSPECIFIED", "DISAPPROVED", "DEMOTED", "PENDING" ], "description": "Aggregated severity of the issue for all reporting contexts it affects. Reporting contexts included in the computation of the aggregated severity can be restricted using a filter on the `reporting_context` field. **This field can be used for filtering the results.**", "type": "string" }, "severityPerReportingContext": { "type": "array", "items": { "$ref": "IssueSeverityPerReportingContext" }, "description": "Issue severity per reporting context. Reporting contexts included in this list can be restricted using a filter on the `reporting_context` field." } } }, "SearchRequest": { "type": "object", "id": "SearchRequest", "description": "Request message for the `ReportService.Search` method.", "properties": { "query": { "type": "string", "description": "Required. Query that defines a report to be retrieved. For details on how to construct your query, see the [Query Language guide](/merchant/api/guides/reports/query-language). For the full list of available tables and fields, see the Available fields." }, "pageSize": { "type": "integer", "format": "int32", "description": "Optional. Number of `ReportRows` to retrieve in a single page. Defaults to 1000. Values above 100,000 are coerced to 100,000." }, "pageToken": { "description": "Optional. Token of the page to retrieve. If not specified, the first page of results is returned. In order to request the next page of results, the value obtained from `next_page_token` in the previous response should be used.", "type": "string" } } }, "YoutubeContentPerformanceView": { "description": "Fields available for query in `youtube_content_performance_view` table. [YouTube content performance data](https://support.google.com/merchants/answer/14947975) for your account. This data is only available if an account is enrolled in the [YouTube Shopping Affiliate program](https://support.google.com/merchants/answer/14815513). Values are only set for fields requested explicitly in the request's search query. See the [API guide](https://developers.google.com/merchant/api/guides/reports/analyze-youtube-affiliate-performance#expandable-2) for the query example.", "type": "object", "id": "YoutubeContentPerformanceView", "properties": { "impressions": { "format": "int64", "type": "string", "description": "The number of product impressions." }, "platformCommissions": { "$ref": "Price", "description": "Optional. The commissions amount funded by the platform (pending and paid)." }, "sellerCommissions": { "description": "Optional. The commissions amount funded by sellers (pending and paid).", "$ref": "Price" }, "accountId": { "description": "Optional. Merchant Center Account ID. Can be stand alone account or a sub-account. **This field cannot be used for filtering the results.**", "type": "string", "format": "int64" }, "channelTitle": { "description": "The channel title.", "type": "string" }, "netSales": { "description": "The net sales amount (includes both purchase and refunds).", "$ref": "Price" }, "videoId": { "type": "string", "description": "The video id." }, "subscriberCount": { "format": "int64", "description": "The number of subscribers of the creator channel.", "type": "string" }, "clicks": { "format": "int64", "type": "string", "description": "The number of product clicks." }, "taggedProductIds": { "description": "Set of unique [product IDs](https://support.google.com/merchants/answer/188494#id) tagged on the YouTube video. These IDs correspond to the `offer_id` in the Products API.", "type": "array", "items": { "type": "string" } }, "date": { "$ref": "Date", "description": "Date in the Merchant Center account timezone to which metrics apply. Segment. Cannot be selected in the `SELECT` clause. Condition on `date` is required in the `WHERE` clause. When using date-range, reduce the range if `RESOURCE_EXHAUSTED` is returned." }, "orders": { "type": "string", "description": "The number of orders.", "format": "int64" }, "title": { "description": "The video title.", "type": "string" }, "views": { "description": "The number of YouTube views.", "type": "string", "format": "int64" }, "contentType": { "description": "The content type of the creator content.", "type": "string", "enum": [ "CONTENT_TYPE_UNSPECIFIED", "LIVE_STREAM", "SHORTS", "STORY", "VIDEO", "POST" ], "enumDescriptions": [ "Not specified.", "Video content streamed in real-time.", "Short-form, vertical video format, typically up to 60 seconds.", "Ephemeral, short-form video or image collections. Note: YouTube Stories are deprecated.", "Standard on-demand video format (VOD). This includes pre-recorded uploads that are not classified as SHORTS or LIVE_STREAM.", "Community updates which can include text, images, polls, or videos, shared with channel subscribers." ] }, "publishedDate": { "$ref": "Date", "description": "The published date of the creator content." }, "commissions": { "description": "The commissions amount (pending and paid).", "$ref": "Price" }, "conversionRate": { "format": "double", "type": "number", "description": "The conversion rate. This measures the ratio of orders to clicks." }, "grossSales": { "description": "The gross sales amount, before refunds.", "$ref": "Price" }, "channelId": { "description": "The channel id.", "type": "string" } } }, "YoutubeCampaignsStatsView": { "description": "Fields available for query in `youtube_campaigns_stats_view` table.", "type": "object", "id": "YoutubeCampaignsStatsView", "properties": { "grossSales": { "description": "Gross sales amount, excluding refunds.", "$ref": "Price" }, "date": { "$ref": "Date", "description": "Date in the Merchant Center account timezone to which metrics apply. Segment. Required in the `WHERE` clause. Cannot be selected." }, "campaignId": { "description": "The ID of the campaign.", "type": "string" }, "campaignName": { "type": "string", "description": "The name of the campaign." }, "orders": { "format": "int64", "description": "Number of orders.", "type": "string" }, "endDate": { "$ref": "Date", "description": "The end date of the campaign." }, "commissions": { "description": "Net commission amount. Includes both purchase and refunds.", "$ref": "Price" }, "clicks": { "description": "Number of product clicks.", "type": "string", "format": "int64" }, "activeCreators": { "format": "int64", "description": "The number of active creators in the campaign.", "type": "string" }, "impressions": { "description": "Number of impressions.", "format": "int64", "type": "string" }, "startDate": { "description": "The start date of the campaign.", "$ref": "Date" }, "conversionRate": { "description": "Conversion rate.", "type": "number", "format": "double" }, "netSales": { "$ref": "Price", "description": "Net sales amount. Includes both purchase and refunds." }, "views": { "description": "Number of YouTube views.", "type": "string", "format": "int64" } } }, "YoutubeProductSoldStatsView": { "properties": { "date": { "description": "Date in the Merchant Center account timezone to which metrics apply. Segment. Cannot be present in the `SELECT` clause. Required in the `WHERE` clause.", "$ref": "Date" }, "grossSales": { "description": "Gross sales amount, excluding refunds.", "$ref": "Price" }, "commissions": { "$ref": "Price", "description": "Net commission amount (includes both purchase and refunds)." }, "orders": { "format": "int64", "type": "string", "description": "Number of orders." }, "title": { "type": "string", "description": "Title of the product." }, "netSales": { "description": "Net sales amount (includes both purchase and refunds).", "$ref": "Price" }, "offerId": { "description": "Merchant-provided product id.", "type": "string" }, "productType": { "description": "Category in merchant's own product taxonomy.", "type": "string" } }, "id": "YoutubeProductSoldStatsView", "type": "object", "description": "Fields available for query in `youtube_product_sold_stats_view` table. [YouTube product sold data](https://support.google.com/merchants/answer/14947975) for your account. This data is only available if an account is enrolled in the [YouTube Shopping Affiliate program](https://support.google.com/merchants/answer/14815513). This view focuses exclusively on products that were sold through the affiliate program. In contrast, `YoutubeProductTaggedStatsView` focuses on products a merchant has tagged in YouTube videos, and their subsequent performance in terms of both engagement (views, clicks) and sales. Values are only set for fields requested explicitly in the request's search query." }, "YoutubeProductTaggedStatsView": { "id": "YoutubeProductTaggedStatsView", "description": "Fields available for query in `youtube_product_tagged_stats_view` table. [YouTube product tagged data](https://support.google.com/merchants/answer/14947975) for your account. This data is only available if an account is enrolled in the [YouTube Shopping Affiliate program](https://support.google.com/merchants/answer/14815513). This view focuses on products a merchant has tagged in YouTube videos, and their subsequent performance in terms of engagement (views, clicks) and sales. In contrast, `YoutubeProductSoldStatsView` focuses exclusively on products that were sold through the affiliate program. Values are only set for fields requested explicitly in the request's search query.", "properties": { "netSales": { "$ref": "Price", "description": "Net sales amount (includes both purchase and refunds)." }, "offerId": { "description": "Merchant-provided product ID.", "type": "string" }, "conversionRate": { "format": "double", "type": "number", "description": "The conversion rate of the product." }, "orders": { "description": "Number of orders.", "format": "int64", "type": "string" }, "impressions": { "type": "string", "description": "Number of impressions.", "format": "int64" }, "taggedCreatorCount": { "type": "string", "description": "The number of distinct creators that tagged the product.", "format": "int64" }, "grossSales": { "description": "Gross sales amount, excluding refunds.", "$ref": "Price" }, "taggedVideoCount": { "type": "string", "format": "int64", "description": "The number of distinct videos that tagged the product." }, "views": { "format": "int64", "type": "string", "description": "Number of views." }, "date": { "description": "Date in the Merchant Center account timezone to which metrics apply. Segment. Cannot be present in the `SELECT` clause. Required in the `WHERE` clause.", "$ref": "Date" }, "title": { "description": "Title of the product.", "type": "string" }, "productType": { "description": "Category in merchant's own product taxonomy.", "type": "string" }, "clicks": { "type": "string", "format": "int64", "description": "Number of clicks." }, "commissions": { "$ref": "Price", "description": "Net commission amount (includes both purchase and refunds)." } }, "type": "object" }, "YoutubeCreatorPerformanceView": { "properties": { "title": { "description": "The title of the creator channel.", "type": "string" }, "clicks": { "description": "The number of product clicks.", "format": "int64", "type": "string" }, "date": { "description": "Date in the Merchant Center account timezone to which metrics apply. Segment. Cannot be selected in the `SELECT` clause. Condition on `date` is required in the `WHERE` clause. When using date-range, reduce the range if `RESOURCE_EXHAUSTED` is returned.", "$ref": "Date" }, "views": { "format": "int64", "description": "The number of YouTube views.", "type": "string" }, "grossSales": { "$ref": "Price", "description": "The gross sales amount, before refunds." }, "conversionRate": { "format": "double", "description": "The conversion rate for the creator channel.", "type": "number" }, "channelId": { "description": "The id for the creator channel.", "type": "string" }, "orders": { "format": "int64", "description": "The number of orders.", "type": "string" }, "commissions": { "$ref": "Price", "description": "The commissions amount (pending and paid)." }, "netSales": { "description": "The net sales amount (includes both purchase and refunds).", "$ref": "Price" }, "subscriberCount": { "format": "int64", "description": "Optional. The number of subscribers of the creator channel. See [YouTube creator performance data](https://support.google.com/merchants/answer/14947975) for more details.", "type": "string" } }, "description": "Fields available for query in `youtube_creator_performance_view` table. [YouTube creator performance data](https://support.google.com/merchants/answer/14947975) for your account. This data is only available if an account is enrolled in the [YouTube Shopping Affiliate program](https://support.google.com/merchants/answer/14815513). Values are only set for fields requested explicitly in the request's search query.", "type": "object", "id": "YoutubeCreatorPerformanceView" }, "ItemIssueType": { "description": "Issue type.", "type": "object", "id": "ItemIssueType", "properties": { "code": { "type": "string", "description": "Error code of the issue, equivalent to the `code` of [Product issues](https://developers.google.com/shopping-content/guides/product-issues)." }, "canonicalAttribute": { "description": "Canonical attribute name for attribute-specific issues.", "type": "string" } } }, "PriceInsightsProductView": { "id": "PriceInsightsProductView", "description": "Fields available for query in `price_insights_product_view` table. [Price insights](https://support.google.com/merchants/answer/11916926) report. Values are only set for fields requested explicitly in the request's search query.", "type": "object", "properties": { "predictedImpressionsChangeFraction": { "type": "number", "format": "double", "description": "Predicted change in impressions as a fraction after introducing the suggested price compared to current active price. For example, 0.05 is a 5% predicted increase in impressions." }, "predictedClicksChangeFraction": { "description": "Predicted change in clicks as a fraction after introducing the suggested price compared to current active price. For example, 0.05 is a 5% predicted increase in clicks.", "type": "number", "format": "double" }, "categoryL3": { "type": "string", "description": "Product category (3rd level) in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436)." }, "price": { "$ref": "Price", "description": "Current price of the product." }, "offerId": { "description": "Merchant-provided id of the product.", "type": "string" }, "brand": { "type": "string", "description": "Brand of the product." }, "productTypeL2": { "type": "string", "description": "Product type (2nd level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406)." }, "effectiveness": { "description": "The predicted effectiveness of applying the price suggestion, bucketed.", "enum": [ "EFFECTIVENESS_UNSPECIFIED", "LOW", "MEDIUM", "HIGH" ], "type": "string", "enumDescriptions": [ "Effectiveness is unknown.", "Effectiveness is low.", "Effectiveness is medium.", "Effectiveness is high." ] }, "predictedConversionsChangeFraction": { "type": "number", "description": "Predicted change in conversions as a fraction after introducing the suggested price compared to current active price. For example, 0.05 is a 5% predicted increase in conversions).", "format": "double" }, "suggestedPrice": { "description": "Latest suggested price for the product.", "$ref": "Price" }, "productTypeL4": { "description": "Product type (4th level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406).", "type": "string" }, "categoryL2": { "type": "string", "description": "Product category (2nd level) in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436)." }, "categoryL5": { "description": "Product category (5th level) in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", "type": "string" }, "productTypeL1": { "description": "Product type (1st level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406).", "type": "string" }, "categoryL1": { "description": "Product category (1st level) in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", "type": "string" }, "productTypeL5": { "type": "string", "description": "Product type (5th level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406)." }, "categoryL4": { "type": "string", "description": "Product category (4th level) in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436)." }, "title": { "description": "Title of the product.", "type": "string" }, "id": { "type": "string", "description": "REST ID of the product, in the form of `channel~languageCode~feedLabel~offerId`. Can be used to join data with the `product_view` table. Required in the `SELECT` clause." }, "productTypeL3": { "description": "Product type (3rd level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406).", "type": "string" } } }, "UcpAgenticPerformanceView": { "description": "Fields available for query in `ucp_agentic_performance_view` table. Funnel performance data for your Universal Commerce Protocol (UCP) integration, including metrics (for example, `buy_button_clicks`) and dimensions according to which the metrics are segmented (for example, `customer_country_code`). Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for fields requested explicitly in the request's search query. For more information about how to Monitor and optimize your UCP integration, see [Monitor and optimize your integration](https://developers.google.com/merchant/ucp/guides/tools/merchant-center/analytics).", "type": "object", "id": "UcpAgenticPerformanceView", "properties": { "averageOrderValue": { "description": "Average amount spent on a single order, excluding cancellations and refunds. A single order may contain the purchase of multiple products. Equivalent to Average Order Value in UCP Analytics in Merchant Center. Metric.", "$ref": "Price" }, "accountId": { "format": "int64", "type": "string", "description": "Leaf Merchant Center ID to which metrics apply. Unique (primary key) in the table. Segment." }, "buyButtonClicks": { "format": "int64", "type": "string", "description": "Number of buy button clicks performed directly from Google. Equivalent to Buy Button Clicks in UCP Analytics in Merchant Center. Metric." }, "customerCountryCode": { "type": "string", "description": "Code of the country where the customer is located at the time of the event. Represented in the ISO 3166 format. Segment. If the customer country cannot be determined, a special `ZZ` code is returned." }, "averageCartProductCount": { "type": "number", "description": "Average number of products in the cart at the time of transfer to merchant's website. Equivalent to Average Product Count under Transfers to Merchant Cart in UCP Analytics in Merchant Center. Metric.", "format": "double" }, "cancellations": { "type": "string", "description": "Number of times either a merchant or a customer cancelled an order. Equivalent to Cancellations in UCP Analytics in Merchant Center. Metric.", "format": "int64" }, "cartTransfers": { "type": "string", "description": "Number of times a user transfers the cart to checkout on the merchant's website. Equivalent to Cart Transfers in UCP Analytics in Merchant Center. Metric.", "format": "int64" }, "accountLinkingRate": { "description": "Percentage of times a customer successfully linked their Google account to their merchant account. Equivalent to Account Linking Rate under Account Linking in UCP Analytics in Merchant Center. Metric.", "format": "double", "type": "number" }, "purchaseValue": { "$ref": "Price", "description": "Value of fully completed purchases performed directly from Google. Metric." }, "averageCartProductValue": { "description": "Average product value in the cart at the time of transfer to merchant's website. Equivalent to Average Product Value under Transfers to Merchant Cart in UCP Analytics in Merchant Center. Metric.", "$ref": "Price" }, "accountsLinked": { "description": "Number of times a customer successfully linked their Google account to their merchant account. Equivalent to Accounts Linked in UCP Analytics in Merchant Center. Metric.", "format": "int64", "type": "string" }, "averageCartValue": { "$ref": "Price", "description": "Average value of the cart at the time of transfer to merchant's website. Equivalent to Average Cart Value in UCP Analytics in Merchant Center. Metric." }, "purchaseCount": { "description": "Number of fully completed purchases performed directly from Google. Equivalent to Purchase Count in UCP Analytics in Merchant Center. Metric.", "format": "int64", "type": "string" }, "date": { "description": "Date in the merchant timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause.", "$ref": "Date" }, "averagePurchaseProductCount": { "description": "Average number of products in an order. Equivalent to Average Product Count under Native Checkout in UCP Analytics in Merchant Center. Metric.", "format": "double", "type": "number" }, "averagePurchaseProductValue": { "description": "Average value of the products in an order. Equivalent to Average Product Value under Native Checkout in UCP Analytics in Merchant Center. Metric.", "$ref": "Price" } } }, "CompetitiveVisibilityCompetitorView": { "id": "CompetitiveVisibilityCompetitorView", "properties": { "relativeVisibility": { "format": "double", "type": "number", "description": "[Relative visibility] (https://support.google.com/merchants/answer/11366442#zippy=%2Crelative-visibility) shows how often your competitors’ offers are shown compared to your offers. In other words, this is the number of displayed impressions of a competitor retailer divided by the number of your displayed impressions during a selected time range for a selected product category and country. Cannot be filtered on in the 'WHERE' clause." }, "rank": { "format": "int64", "description": "Position of the domain in the similar businesses ranking for the selected keys (`date`, `report_category_id`, `report_country_code`, `traffic_source`) based on impressions. 1 is the highest. Cannot be filtered on in the 'WHERE' clause.", "type": "string" }, "pageOverlapRate": { "description": "[Page overlap rate] (https://support.google.com/merchants/answer/11366442#zippy=%2Cpage-overlap-rate) shows how frequently competing retailers’ offers are shown together with your offers on the same page. Cannot be filtered on in the 'WHERE' clause.", "type": "number", "format": "double" }, "isYourDomain": { "type": "boolean", "description": "True if this row contains data for your domain. Cannot be filtered on in the 'WHERE' clause." }, "domain": { "type": "string", "description": "Domain of your competitor or your domain, if `is_your_domain` is true. Required in the `SELECT` clause. Cannot be filtered on in the 'WHERE' clause." }, "reportCountryCode": { "description": "Country where impressions appeared. Required in the `SELECT` clause. A condition on `report_country_code` is required in the `WHERE` clause.", "type": "string" }, "higherPositionRate": { "type": "number", "description": "[Higher position rate] (https://support.google.com/merchants/answer/11366442#zippy=%2Chigher-position-rate) shows how often a competitor’s offer got placed in a higher position on the page than your offer. Cannot be filtered on in the 'WHERE' clause.", "format": "double" }, "trafficSource": { "enum": [ "TRAFFIC_SOURCE_ENUM_UNSPECIFIED", "ORGANIC", "ADS", "ALL" ], "type": "string", "description": "Traffic source of impressions. Required in the `SELECT` clause.", "enumDescriptions": [ "Not specified.", "Organic traffic.", "Traffic from ads.", "Organic and ads traffic." ] }, "adsOrganicRatio": { "description": "[Ads / organic ratio] (https://support.google.com/merchants/answer/11366442#zippy=%2Cads-free-ratio) shows how often the domain receives impressions from Shopping ads compared to organic traffic. The number is rounded and bucketed. Cannot be filtered on in the 'WHERE' clause.", "format": "double", "type": "number" }, "date": { "description": "Date of this row. A condition on `date` is required in the `WHERE` clause.", "$ref": "Date" }, "reportCategoryId": { "format": "int64", "description": "Google product category ID to calculate the report for, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436). Required in the `SELECT` clause. A condition on `report_category_id` is required in the `WHERE` clause.", "type": "string" } }, "type": "object", "description": "Fields available for query in `competitive_visibility_competitor_view` table. [Competitive visibility](https://support.google.com/merchants/answer/11366442) report with businesses with similar visibility. Values are only set for fields requested explicitly in the request's search query." }, "UcpAgenticProductPerformanceView": { "properties": { "offerId": { "description": "Merchant-provided ID of the product. Unique (primary key) in the table. Segment.", "type": "string" }, "accountId": { "format": "int64", "description": "Leaf Merchant Center ID to which metrics apply. Segment.", "type": "string" }, "buyButtonClicks": { "type": "string", "description": "Number of buy button clicks performed directly from Google. Equivalent to Buy Button Clicks under Most popular UCP products in UCP Analytics in Merchant Center. Metric.", "format": "int64" }, "customerCountryCode": { "description": "Code of the country where the customer is located at the time of the event. Represented in the ISO 3166 format. Segment. If the customer country cannot be determined, a special 'ZZ' code is returned.", "type": "string" }, "date": { "description": "Date in the merchant timezone to which metrics apply. Segment. Cannot be selected in the `SELECT` clause. Condition on `date` is required in the `WHERE` clause.", "$ref": "Date" }, "title": { "description": "Title of the product. Equivalent to Product under Most popular UCP products in UCP Analytics in Merchant Center. Segment.", "type": "string" } }, "id": "UcpAgenticProductPerformanceView", "description": "Fields available for query in `ucp_agentic_product_performance_view` table. Product performance data for your UCP integration, including metrics (for example, `purchases`) and dimensions according to which the metrics are segmented (for example, `offer_id`, `customer_country_code`). Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for fields requested explicitly in the request's search query. For more information about how to Monitor and optimize your UCP integration, see [Monitor and optimize your integration](https://developers.google.com/merchant/ucp/guides/tools/merchant-center/analytics).", "type": "object" }, "NonProductPerformanceView": { "description": "Fields available for query in `non_product_performance_view` table. Performance data on images and online store links leading to your non-product pages. This includes performance metrics (for example, `clicks`) and dimensions according to which performance metrics are segmented (for example, `date`). Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for fields requested explicitly in the request's search query.", "properties": { "impressions": { "description": "Number of times images and online store links leading to your non-product pages were shown. Metric.", "type": "string", "format": "int64" }, "clicks": { "format": "int64", "type": "string", "description": "Number of clicks on images and online store links leading to your non-product pages. Metric." }, "week": { "description": "First day of the week (Monday) of the metrics date in the Merchant Center account timezone. Segment.", "$ref": "Date" }, "clickThroughRate": { "format": "double", "description": "Click-through rate - the number of clicks (`clicks`) divided by the number of impressions (`impressions`) of images and online store links leading to your non-product pages. Metric.", "type": "number" }, "date": { "$ref": "Date", "description": "Date in the Merchant Center account timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause." } }, "id": "NonProductPerformanceView", "type": "object" }, "CompetitiveVisibilityTopMerchantView": { "id": "CompetitiveVisibilityTopMerchantView", "type": "object", "properties": { "rank": { "format": "int64", "description": "Position of the domain in the top merchants ranking for the selected keys (`date`, `report_category_id`, `report_country_code`, `traffic_source`) based on impressions. 1 is the highest. Cannot be filtered on in the 'WHERE' clause.", "type": "string" }, "domain": { "type": "string", "description": "Domain of your competitor or your domain, if `is_your_domain` is true. Required in the `SELECT` clause. Cannot be filtered on in the 'WHERE' clause." }, "pageOverlapRate": { "description": "[Page overlap rate] (https://support.google.com/merchants/answer/11366442#zippy=%2Cpage-overlap-rate) shows how frequently competing retailers’ offers are shown together with your offers on the same page. Cannot be filtered on in the 'WHERE' clause.", "format": "double", "type": "number" }, "reportCountryCode": { "type": "string", "description": "Country where impressions appeared. Required in the `SELECT` clause. A condition on `report_country_code` is required in the `WHERE` clause." }, "trafficSource": { "type": "string", "enumDescriptions": [ "Not specified.", "Organic traffic.", "Traffic from ads.", "Organic and ads traffic." ], "description": "Traffic source of impressions. Required in the `SELECT` clause.", "enum": [ "TRAFFIC_SOURCE_ENUM_UNSPECIFIED", "ORGANIC", "ADS", "ALL" ] }, "reportCategoryId": { "description": "Google product category ID to calculate the report for, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436). Required in the `SELECT` clause. A condition on `report_category_id` is required in the `WHERE` clause.", "type": "string", "format": "int64" }, "isYourDomain": { "description": "True if this row contains data for your domain. Cannot be filtered on in the 'WHERE' clause.", "type": "boolean" }, "date": { "$ref": "Date", "description": "Date of this row. Cannot be selected in the `SELECT` clause. A condition on `date` is required in the `WHERE` clause." }, "higherPositionRate": { "format": "double", "type": "number", "description": "[Higher position rate] (https://support.google.com/merchants/answer/11366442#zippy=%2Chigher-position-rate) shows how often a competitor’s offer got placed in a higher position on the page than your offer. Cannot be filtered on in the 'WHERE' clause." }, "adsOrganicRatio": { "format": "double", "type": "number", "description": "[Ads / organic ratio] (https://support.google.com/merchants/answer/11366442#zippy=%2Cads-free-ratio) shows how often the domain receives impressions from Shopping ads compared to organic traffic. The number is rounded and bucketed. Cannot be filtered on in the 'WHERE' clause." } }, "description": "Fields available for query in `competitive_visibility_top_merchant_view` table. [Competitive visibility](https://support.google.com/merchants/answer/11366442) report with business with highest visibility. Values are only set for fields requested explicitly in the request's search query." }, "Date": { "properties": { "month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "type": "integer", "format": "int32" }, "day": { "type": "integer", "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "format": "int32" }, "year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32", "type": "integer" } }, "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", "type": "object", "id": "Date" }, "ProductView": { "type": "object", "id": "ProductView", "description": "Fields available for query in `product_view` table. Products in the current inventory. Products in this table are the same as a [Product resource in Products sub-API](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products) but not all product attributes from Products sub-API are available for query in this table. In contrast to Products sub-API, this table allows to filter the returned list of products by product attributes. To retrieve a single product by `id` or list all products, Products sub-API should be used. Values are only set for fields requested explicitly in the request's search query.", "properties": { "categoryL5": { "description": "Product category (5th level) in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", "type": "string" }, "productTypeL2": { "description": "Product type (2nd level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406).", "type": "string" }, "offerId": { "type": "string", "description": "Merchant-provided id of the product." }, "creationTime": { "type": "string", "format": "google-datetime", "description": "The time the merchant created the product in timestamp seconds." }, "feedLabel": { "description": "Feed label of the product.", "type": "string" }, "aggregatedReportingContextStatus": { "description": "Aggregated status across all reporting contexts. Reporting contexts included in the computation of the aggregated status can be restricted using a filter on the `reporting_context` field.", "enum": [ "AGGREGATED_REPORTING_CONTEXT_STATUS_UNSPECIFIED", "NOT_ELIGIBLE_OR_DISAPPROVED", "PENDING", "ELIGIBLE_LIMITED", "ELIGIBLE" ], "enumDescriptions": [ "Not specified.", "Product is not eligible or is disapproved for all reporting contexts and countries.", "Product's status is pending in all reporting contexts and countries.", "Product is eligible for some (but not all) reporting contexts and countries.", "Product is eligible for all reporting contexts and countries." ], "type": "string" }, "channel": { "type": "string", "enumDescriptions": [ "Not specified.", "Online product.", "Local product." ], "description": "Channel of the product. Can be `ONLINE` or `LOCAL`.", "enum": [ "CHANNEL_ENUM_UNSPECIFIED", "ONLINE", "LOCAL" ] }, "itemIssues": { "items": { "$ref": "ItemIssue" }, "description": "List of item issues for the product. **This field cannot be used for sorting the results.** **Only selected attributes of this field (for example, `item_issues.severity.aggregated_severity`) can be used for filtering the results.**", "type": "array" }, "categoryL2": { "description": "Product category (2nd level) in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", "type": "string" }, "price": { "description": "Product price. Absent if the information about the price of the product is not available.", "$ref": "Price" }, "productTypeL3": { "type": "string", "description": "Product type (3rd level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406)." }, "condition": { "type": "string", "description": "[Condition](https://support.google.com/merchants/answer/6324469) of the product." }, "productTypeL5": { "description": "Product type (5th level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406).", "type": "string" }, "thumbnailLink": { "type": "string", "description": "Link to the processed image of the product, hosted on the Google infrastructure." }, "clickPotential": { "enum": [ "CLICK_POTENTIAL_UNSPECIFIED", "LOW", "MEDIUM", "HIGH" ], "description": "Estimated performance potential compared to highest performing products of the merchant.", "type": "string", "enumDescriptions": [ "Unknown predicted clicks impact.", "Potential to receive a low number of clicks compared to the highest performing products of the merchant.", "Potential to receive a moderate number of clicks compared to the highest performing products of the merchant.", "Potential to receive a similar number of clicks as the highest performing products of the merchant." ] }, "categoryL3": { "type": "string", "description": "Product category (3rd level) in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436)." }, "statusPerReportingContext": { "type": "array", "items": { "$ref": "StatusPerReportingContext" }, "description": "Detailed product status per reporting context. Reporting contexts included in this list can be restricted using a filter on the `reporting_context` field. Equivalent to `ProductStatus.destination_statuses` in Products API. **This field cannot be used for sorting or filtering the results.**" }, "title": { "description": "Title of the product.", "type": "string" }, "clickPotentialRank": { "description": "Normalized click potential of the product. Values range from 1 to 1000, where 1 is the highest click potential and 1000 is the theoretical lowest.", "format": "int64", "type": "string" }, "gtin": { "type": "array", "items": { "type": "string" }, "description": "List of Global Trade Item Numbers (GTINs) of the product." }, "reportingContext": { "description": "Reporting context to restrict the query to. Restricts the reporting contexts returned in `status_per_reporting_context` and `item_issues`, and used to compute `aggregated_reporting_context_status`. **This field can only be used in the `WHERE` clause and cannot be selected in the `SELECT` clause.**", "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" ], "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. ." ], "type": "string" }, "availability": { "description": "[Availability](https://support.google.com/merchants/answer/6324448) of the product.", "type": "string" }, "languageCode": { "description": "Language code of the product in BCP 47 format.", "type": "string" }, "categoryL1": { "description": "Product category (1st level) in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", "type": "string" }, "categoryL4": { "description": "Product category (4th level) in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", "type": "string" }, "shippingLabel": { "type": "string", "description": "Normalized [shipping label](https://support.google.com/merchants/answer/6324504) specified in the data source." }, "expirationDate": { "$ref": "Date", "description": "Expiration date for the product, specified on insertion." }, "brand": { "type": "string", "description": "Brand of the product." }, "itemGroupId": { "type": "string", "description": "Item group id provided by the merchant for grouping variants together." }, "id": { "type": "string", "description": "REST ID of the product, in the form of `channel~languageCode~feedLabel~offerId`. Merchant API methods that operate on products take this as their `name` parameter. Required in the `SELECT` clause." }, "productTypeL1": { "description": "Product type (1st level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406).", "type": "string" }, "productTypeL4": { "type": "string", "description": "Product type (4th level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406)." } } }, "Price": { "properties": { "currencyCode": { "type": "string", "description": "The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217)." }, "amountMicros": { "format": "int64", "description": "The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).", "type": "string" } }, "id": "Price", "type": "object", "description": "The price represented as a number and currency." }, "PriceCompetitivenessProductView": { "type": "object", "description": "Fields available for query in `price_competitiveness_product_view` table. [Price competitiveness](https://support.google.com/merchants/answer/9626903) report. Values are only set for fields requested explicitly in the request's search query.", "id": "PriceCompetitivenessProductView", "properties": { "reportCountryCode": { "description": "Country of the price benchmark. Represented in the ISO 3166 format. Required in the `SELECT` clause.", "type": "string" }, "categoryL4": { "description": "Product category (4th level) in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", "type": "string" }, "productTypeL4": { "type": "string", "description": "Product type (4th level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406)." }, "categoryL1": { "description": "Product category (1st level) in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", "type": "string" }, "categoryL5": { "description": "Product category (5th level) in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", "type": "string" }, "categoryL2": { "description": "Product category (2nd level) in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", "type": "string" }, "productTypeL1": { "description": "Product type (1st level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406).", "type": "string" }, "productTypeL5": { "description": "Product type (5th level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406).", "type": "string" }, "price": { "$ref": "Price", "description": "Current price of the product." }, "brand": { "description": "Brand of the product.", "type": "string" }, "productTypeL3": { "type": "string", "description": "Product type (3rd level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406)." }, "benchmarkPrice": { "description": "Latest available price benchmark for the product's catalog in the benchmark country.", "$ref": "Price" }, "id": { "type": "string", "description": "REST ID of the product, in the form of `channel~languageCode~feedLabel~offerId`. Can be used to join data with the `product_view` table. Required in the `SELECT` clause." }, "offerId": { "type": "string", "description": "Merchant-provided id of the product." }, "categoryL3": { "description": "Product category (3rd level) in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).", "type": "string" }, "title": { "type": "string", "description": "Title of the product." }, "productTypeL2": { "type": "string", "description": "Product type (2nd level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406)." } } }, "ProductPerformanceView": { "type": "object", "id": "ProductPerformanceView", "description": "Fields available for query in `product_performance_view` table. Product performance data for your account, including performance metrics (for example, `clicks`) and dimensions according to which performance metrics are segmented (for example, `offer_id`). Values of product dimensions, such as `offer_id`, reflect the state of a product at the time of the impression. Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for fields requested explicitly in the request's search query.", "properties": { "customLabel0": { "description": "Custom label 0 for custom grouping of products. Segment.", "type": "string" }, "categoryL5": { "type": "string", "description": "[Product category (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy. Segment." }, "week": { "description": "First day of the week (Monday) of the metrics date in the Merchant Center account timezone. Segment.", "$ref": "Date" }, "clicks": { "type": "string", "format": "int64", "description": "Number of clicks. Metric." }, "categoryL2": { "description": "[Product category (2nd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy. Segment.", "type": "string" }, "date": { "$ref": "Date", "description": "Date in the Merchant Center account timezone to which metrics apply. Segment. Condition on `date` is required in the `WHERE` clause." }, "marketingMethod": { "enum": [ "MARKETING_METHOD_ENUM_UNSPECIFIED", "ORGANIC", "ADS" ], "enumDescriptions": [ "Not specified.", "Organic marketing.", "Ads-based marketing." ], "description": "Marketing method to which metrics apply. Segment.", "type": "string" }, "productTypeL5": { "type": "string", "description": "[Product type (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment." }, "impressions": { "format": "int64", "description": "Number of times merchant's products are shown. Metric.", "type": "string" }, "productTypeL3": { "description": "[Product type (3rd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment.", "type": "string" }, "conversions": { "format": "double", "type": "number", "description": "Number of conversions attributed to the product, reported on the conversion date. Depending on the attribution model, a conversion might be distributed across multiple clicks, where each click gets its own credit assigned. This metric is a sum of all such credits. Metric. Available only for the `FREE` traffic source." }, "customLabel2": { "description": "Custom label 2 for custom grouping of products. Segment.", "type": "string" }, "customerCountryCode": { "type": "string", "description": "Code of the country where the customer is located at the time of the event. Represented in the ISO 3166 format. Segment. If the customer country cannot be determined, a special 'ZZ' code is returned." }, "customLabel3": { "description": "Custom label 3 for custom grouping of products. Segment.", "type": "string" }, "offerId": { "type": "string", "description": "Merchant-provided id of the product. Segment." }, "categoryL3": { "type": "string", "description": "[Product category (3rd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy. Segment." }, "productTypeL2": { "description": "[Product type (2nd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment.", "type": "string" }, "brand": { "type": "string", "description": "Brand of the product. Segment." }, "categoryL4": { "type": "string", "description": "[Product category (4th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy. Segment." }, "conversionRate": { "type": "number", "description": "Number of conversions divided by the number of clicks, reported on the impression date. Metric. Available only for the `FREE` traffic source.", "format": "double" }, "customLabel4": { "type": "string", "description": "Custom label 4 for custom grouping of products. Segment." }, "productTypeL4": { "description": "[Product type (4th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment.", "type": "string" }, "categoryL1": { "description": "[Product category (1st level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy. Segment.", "type": "string" }, "productTypeL1": { "description": "[Product type (1st level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy. Segment.", "type": "string" }, "customLabel1": { "type": "string", "description": "Custom label 1 for custom grouping of products. Segment." }, "title": { "description": "Title of the product. Segment.", "type": "string" }, "conversionValue": { "$ref": "Price", "description": "Value of conversions attributed to the product, reported on the conversion date. Metric. Available only for the `FREE` traffic source." }, "storeType": { "enum": [ "STORE_TYPE_ENUM_UNSPECIFIED", "ONLINE_STORE", "LOCAL_STORES" ], "description": "Store type to which metrics apply. Can be `ONLINE_STORE` or `LOCAL_STORES`. Segment. For `LOCAL_STORES` store type, further segmentation by a specific store is not available.", "type": "string", "enumDescriptions": [ "Not specified.", "Online store.", "Local (physical) stores." ] }, "clickThroughRate": { "format": "double", "description": "Click-through rate - the number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions). Metric.", "type": "number" } } }, "IssueSeverityPerReportingContext": { "properties": { "demotedCountries": { "items": { "type": "string" }, "description": "List of demoted countries in the reporting context, represented in ISO 3166 format.", "type": "array" }, "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" ], "enumDeprecated": [ false, false, true, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false, false ], "type": "string", "description": "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. ." ] }, "disapprovedCountries": { "description": "List of disapproved countries in the reporting context, represented in ISO 3166 format.", "items": { "type": "string" }, "type": "array" } }, "type": "object", "description": "Issue severity per reporting context.", "id": "IssueSeverityPerReportingContext" }, "ReportRow": { "type": "object", "id": "ReportRow", "description": "Result row returned from the search query. Only the message corresponding to the queried table is populated in the response. Within the populated message, only the fields requested explicitly in the query are populated.", "properties": { "youtubeProductSoldStatsView": { "$ref": "YoutubeProductSoldStatsView", "description": "Fields available for query in `youtube_product_sold_stats_view` table." }, "priceCompetitivenessProductView": { "$ref": "PriceCompetitivenessProductView", "description": "Fields available for query in `price_competitiveness_product_view` table." }, "ucpAgenticProductPerformanceView": { "description": "Fields available for query in `ucp_agentic_product_performance_view` table.", "$ref": "UcpAgenticProductPerformanceView" }, "youtubeCampaignsStatsView": { "$ref": "YoutubeCampaignsStatsView", "description": "Fields available for query in `youtube_campaigns_stats_view` table." }, "nonProductPerformanceView": { "$ref": "NonProductPerformanceView", "description": "Fields available for query in `non_product_performance_view` table." }, "ucpAgenticPerformanceView": { "description": "Fields available for query in `ucp_agentic_performance_view` table.", "$ref": "UcpAgenticPerformanceView" }, "youtubeContentPerformanceView": { "description": "Fields available for query in `youtube_content_performance_view` table.", "$ref": "YoutubeContentPerformanceView" }, "priceInsightsProductView": { "$ref": "PriceInsightsProductView", "description": "Fields available for query in `price_insights_product_view` table." }, "youtubeCampaignProductsStatsView": { "description": "Fields available for query in `youtube_campaign_products_stats_view` table.", "$ref": "YoutubeCampaignProductsStatsView" }, "youtubeIndividualCampaignStatsView": { "$ref": "YoutubeIndividualCampaignStatsView", "description": "Fields available for query in `youtube_individual_campaign_stats_view` table." }, "bestSellersProductClusterView": { "$ref": "BestSellersProductClusterView", "description": "Fields available for query in `best_sellers_product_cluster_view` table." }, "competitiveVisibilityCompetitorView": { "description": "Fields available for query in `competitive_visibility_competitor_view` table.", "$ref": "CompetitiveVisibilityCompetitorView" }, "competitiveVisibilityBenchmarkView": { "description": "Fields available for query in `competitive_visibility_benchmark_view` table.", "$ref": "CompetitiveVisibilityBenchmarkView" }, "productView": { "description": "Fields available for query in `product_view` table.", "$ref": "ProductView" }, "youtubeCreatorPerformanceView": { "$ref": "YoutubeCreatorPerformanceView", "description": "Fields available for query in `youtube_creator_performance_view` table." }, "youtubeCampaignVideosStatsView": { "description": "Fields available for query in `youtube_campaign_videos_stats_view` table.", "$ref": "YoutubeCampaignVideosStatsView" }, "youtubeProductTaggedStatsView": { "description": "Fields available for query in `youtube_product_tagged_stats_view` table.", "$ref": "YoutubeProductTaggedStatsView" }, "bestSellersBrandView": { "description": "Fields available for query in `best_sellers_brand_view` table.", "$ref": "BestSellersBrandView" }, "competitiveVisibilityTopMerchantView": { "$ref": "CompetitiveVisibilityTopMerchantView", "description": "Fields available for query in `competitive_visibility_top_merchant_view` table." }, "productPerformanceView": { "description": "Fields available for query in `product_performance_view` table.", "$ref": "ProductPerformanceView" } } }, "CompetitiveVisibilityBenchmarkView": { "description": "Fields available for query in `competitive_visibility_benchmark_view` table. [Competitive visibility](https://support.google.com/merchants/answer/11366442) report with the category benchmark. Values are only set for fields requested explicitly in the request's search query.", "id": "CompetitiveVisibilityBenchmarkView", "type": "object", "properties": { "trafficSource": { "description": "Traffic source of impressions. Required in the `SELECT` clause.", "enum": [ "TRAFFIC_SOURCE_ENUM_UNSPECIFIED", "ORGANIC", "ADS", "ALL" ], "enumDescriptions": [ "Not specified.", "Organic traffic.", "Traffic from ads.", "Organic and ads traffic." ], "type": "string" }, "reportCategoryId": { "format": "int64", "type": "string", "description": "Google product category ID to calculate the report for, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436). Required in the `SELECT` clause. A condition on `report_category_id` is required in the `WHERE` clause." }, "date": { "$ref": "Date", "description": "Date of this row. Required in the `SELECT` clause. A condition on `date` is required in the `WHERE` clause." }, "categoryBenchmarkVisibilityTrend": { "format": "double", "description": "Change in visibility based on impressions with respect to the start of the selected time range (or first day with non-zero impressions) for a combined set of merchants with highest visibility approximating the market. Cannot be filtered on in the 'WHERE' clause.", "type": "number" }, "yourDomainVisibilityTrend": { "type": "number", "format": "double", "description": "Change in visibility based on impressions for your domain with respect to the start of the selected time range (or first day with non-zero impressions). Cannot be filtered on in the 'WHERE' clause." }, "reportCountryCode": { "description": "Country where impressions appeared. Required in the `SELECT` clause. A condition on `report_country_code` is required in the `WHERE` clause.", "type": "string" } } }, "ProductChange": { "id": "ProductChange", "type": "object", "description": "The change that happened to the product including old value, new value, country code as the region code and reporting context.", "properties": { "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`, ``)" }, "reportingContext": { "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" ], "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. ." ], "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)", "type": "string" }, "regionCode": { "description": "Countries that have the change (if applicable). Represented in the ISO 3166 format.", "type": "string" }, "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" } } }, "ProductStatusChangeMessage": { "description": "The message that the merchant will receive to notify about product status change event", "id": "ProductStatusChangeMessage", "properties": { "resourceId": { "description": "The product id.", "type": "string" }, "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" ] }, "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}`" }, "expirationTime": { "type": "string", "format": "google-datetime", "description": "Optional. The product expiration time. This field will not be set if the notification is sent for a product deletion event." }, "account": { "type": "string", "description": "The target account that owns the entity that changed. Format : `accounts/{merchant_id}`" }, "attribute": { "enum": [ "ATTRIBUTE_UNSPECIFIED", "STATUS" ], "description": "The attribute in the resource that changed, in this case it will be always `Status`.", "enumDescriptions": [ "Unspecified attribute", "Status of the changed entity" ], "type": "string" }, "eventTime": { "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.", "format": "google-datetime", "type": "string" }, "resource": { "type": "string", "description": "The product name. Format: `accounts/{account}/products/{product}`" }, "changes": { "items": { "$ref": "ProductChange" }, "type": "array", "description": "A message to describe the change that happened to the product" } }, "type": "object" }, "YoutubeIndividualCampaignStatsView": { "description": "Fields available for query in `youtube_individual_campaign_stats_view` table.", "id": "YoutubeIndividualCampaignStatsView", "properties": { "channelId": { "description": "The ID of the creator channel.", "type": "string" }, "commissions": { "$ref": "Price", "description": "Net commission amount includes both purchase and refunds." }, "views": { "type": "string", "description": "Number of YouTube views.", "format": "int64" }, "orders": { "description": "Number of orders.", "type": "string", "format": "int64" }, "channelAvatarUri": { "type": "string", "description": "The avatar URI of the creator channel." }, "grossSales": { "description": "Gross sales amount, excluding refunds.", "$ref": "Price" }, "conversionRate": { "type": "number", "description": "Conversion rate.", "format": "double" }, "storyCount": { "format": "int64", "description": "Number of Stories.", "type": "string" }, "campaignId": { "type": "string", "description": "The ID of the campaign. **Condition on `campaign_id` is required in the `WHERE` clause.**" }, "videoCount": { "type": "string", "format": "int64", "description": "Total video count. Includes videos, shorts, live streams, and stories." }, "channelTitle": { "type": "string", "description": "The title of the creator channel." }, "liveCount": { "format": "int64", "type": "string", "description": "Number of Live streams." }, "date": { "description": "Date in the Merchant Center account timezone to which metrics apply. Segment. Required in the `WHERE` clause. Cannot be selected.", "$ref": "Date" }, "productTitles": { "description": "A string containing all product titles, separated by newlines ('\\n').", "type": "string" }, "clicks": { "format": "int64", "type": "string", "description": "Number of product clicks." }, "netSales": { "$ref": "Price", "description": "Net sales amount includes both purchase and refunds." }, "shortsCount": { "format": "int64", "type": "string", "description": "Number of Shorts." }, "impressions": { "type": "string", "format": "int64", "description": "Number of impressions." } }, "type": "object" }, "StatusPerReportingContext": { "properties": { "pendingCountries": { "description": "List of pending countries in the reporting context, represented in [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, for example, `US`.", "type": "array", "items": { "type": "string" } }, "disapprovedCountries": { "type": "array", "items": { "type": "string" }, "description": "List of disapproved countries in the reporting context, represented in [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, for example, `US`." }, "approvedCountries": { "description": "List of approved countries in the reporting context, represented in [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, for example, `US`.", "items": { "type": "string" }, "type": "array" }, "reportingContext": { "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" ], "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. ." ], "type": "string", "description": "Reporting context the status applies to." } }, "type": "object", "id": "StatusPerReportingContext", "description": "Status of the product for a specific reporting context. Equivalent to `DestinationStatus` in Products API." }, "ItemIssue": { "type": "object", "id": "ItemIssue", "properties": { "resolution": { "type": "string", "enumDescriptions": [ "Not specified.", "The merchant has to fix the issue.", "The issue will be resolved automatically (for example, image crawl) or through a Google review. No merchant action is required now. Resolution might lead to another issue (for example, if crawl fails)." ], "description": "Item issue resolution.", "enum": [ "ITEM_ISSUE_RESOLUTION_UNSPECIFIED", "MERCHANT_ACTION", "PENDING_PROCESSING" ] }, "type": { "description": "Item issue type.", "$ref": "ItemIssueType" }, "severity": { "description": "Item issue severity.", "$ref": "ItemIssueSeverity" } }, "description": "Item issue associated with the product." } }, "title": "Merchant API", "id": "merchantapi:reports_v1alpha", "canonicalName": "Merchant", "description": "Programmatically manage your Merchant Center Accounts.", "resources": { "accounts": { "resources": { "reports": { "methods": { "search": { "parameterOrder": [ "parent" ], "response": { "$ref": "SearchResponse" }, "httpMethod": "POST", "description": "Retrieves a report defined by a search query. The response might contain fewer rows than specified by `page_size`. Rely on `next_page_token` to determine if there are more rows to be requested.", "parameters": { "parent": { "required": true, "type": "string", "description": "Required. Id of the account making the call. Must be a standalone account or a subaccount of an advanced account. Format: accounts/{account}", "location": "path", "pattern": "^accounts/[^/]+$" } }, "path": "reports/v1alpha/{+parent}/reports:search", "id": "merchantapi.accounts.reports.search", "request": { "$ref": "SearchRequest" }, "flatPath": "reports/v1alpha/accounts/{accountsId}/reports:search", "scopes": [ "https://www.googleapis.com/auth/content" ] } } } } } }, "batchPath": "batch", "baseUrl": "https://merchantapi.googleapis.com/" }