diff --git a/discovery/agenciesandbrands-v1.json b/discovery/agenciesandbrands-v1.json
new file mode 100644
index 00000000000..c5f34c22e76
--- /dev/null
+++ b/discovery/agenciesandbrands-v1.json
@@ -0,0 +1,1318 @@
+{
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/agencies-and-brands": {
+ "description": "View, create, edit, and delete data entities in your Agency account."
+ }
+ }
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://agenciesandbrands.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "AgenciesAndBrands",
+ "description": "Agencies and brands API is an externally available HTTP API for ad agencies and brands to programmatically manage their deals and spending with Google Ad Manager publishers.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/authorized-buyers/agencies-and-brands/get-started/start",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "agenciesandbrands:v1",
+ "kind": "discovery#restDescription",
+ "mtlsRootUrl": "https://agenciesandbrands.mtls.googleapis.com/",
+ "name": "agenciesandbrands",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "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"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "agencies": {
+ "resources": {
+ "reports": {
+ "methods": {
+ "create": {
+ "description": "Creates a `Report` object.",
+ "flatPath": "v1/agencies/{agenciesId}/reports",
+ "httpMethod": "POST",
+ "id": "agenciesandbrands.agencies.reports.create",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The parent resource where this `Report` will be created. Format: `agencies/{account_id}`",
+ "location": "path",
+ "pattern": "^agencies/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/reports",
+ "request": {
+ "$ref": "Report"
+ },
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/agencies-and-brands"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a `Report` object.",
+ "flatPath": "v1/agencies/{agenciesId}/reports/{reportsId}",
+ "httpMethod": "DELETE",
+ "id": "agenciesandbrands.agencies.reports.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. Resource name of the report to delete. Format: `agencies/{account_id}/reports/{report_id}`",
+ "location": "path",
+ "pattern": "^agencies/[^/]+/reports/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/agencies-and-brands"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a `Report` object.",
+ "flatPath": "v1/agencies/{agenciesId}/reports/{reportsId}",
+ "httpMethod": "GET",
+ "id": "agenciesandbrands.agencies.reports.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of the report. Format: `agencies/{account_id}/reports/{report_id}`",
+ "location": "path",
+ "pattern": "^agencies/[^/]+/reports/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/agencies-and-brands"
+ ]
+ },
+ "list": {
+ "description": "Lists `Report` objects.",
+ "flatPath": "v1/agencies/{agenciesId}/reports",
+ "httpMethod": "GET",
+ "id": "agenciesandbrands.agencies.reports.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters",
+ "location": "query",
+ "type": "string"
+ },
+ "orderBy": {
+ "description": "Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional. The maximum number of `Reports` to return. The service may return fewer than this value. If unspecified, at most 50 `Reports` will be returned. The maximum value is 1000; values greater than 1000 will be coerced to 1000.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Optional. A page token, received from a previous `ListReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReports` must match the call that provided the page token.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Required. The parent, which owns this collection of reports. Format: `agencies/{account_id}`",
+ "location": "path",
+ "pattern": "^agencies/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "skip": {
+ "description": "Optional. Number of individual resources to skip while paginating.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ }
+ },
+ "path": "v1/{+parent}/reports",
+ "response": {
+ "$ref": "ListReportsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/agencies-and-brands"
+ ]
+ },
+ "patch": {
+ "description": "Updates a `Report` object.",
+ "flatPath": "v1/agencies/{agenciesId}/reports/{reportsId}",
+ "httpMethod": "PATCH",
+ "id": "agenciesandbrands.agencies.reports.patch",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Identifier. The resource name of the report. Report resource name have the form: `agencies/{account_id}/reports/{report_id}`",
+ "location": "path",
+ "pattern": "^agencies/[^/]+/reports/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Optional. The list of fields to update.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "Report"
+ },
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/agencies-and-brands"
+ ]
+ },
+ "run": {
+ "description": "Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation using `OperationsService.GetOperation`. Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain a `RunReportResponse` in its response field containing a report_result that can be passed to the `FetchReportResultRows` method to retrieve the report data.",
+ "flatPath": "v1/agencies/{agenciesId}/reports/{reportsId}:run",
+ "httpMethod": "POST",
+ "id": "agenciesandbrands.agencies.reports.run",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The report to run. Format: `agencies/{account_id}/reports/{report_id}`",
+ "location": "path",
+ "pattern": "^agencies/[^/]+/reports/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}:run",
+ "request": {
+ "$ref": "RunReportRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/agencies-and-brands"
+ ]
+ }
+ },
+ "resources": {
+ "operations": {
+ "methods": {
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+ "flatPath": "v1/agencies/{agenciesId}/reports/{reportsId}/operations/{operationsId}",
+ "httpMethod": "GET",
+ "id": "agenciesandbrands.agencies.reports.operations.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "location": "path",
+ "pattern": "^agencies/[^/]+/reports/[^/]+/operations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/agencies-and-brands"
+ ]
+ }
+ }
+ },
+ "results": {
+ "methods": {
+ "fetchRows": {
+ "description": "Returns the result rows from a completed report. The caller must have previously called `RunReport` and waited for that operation to complete. The rows will be returned according to the order specified by the `sorts` member of the report definition.",
+ "flatPath": "v1/agencies/{agenciesId}/reports/{reportsId}/results/{resultsId}:fetchRows",
+ "httpMethod": "GET",
+ "id": "agenciesandbrands.agencies.reports.results.fetchRows",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The report result being fetched. Format: `agencies/{account_id}/reports/{report_id}/results/{report_result_id}`",
+ "location": "path",
+ "pattern": "^agencies/[^/]+/reports/[^/]+/results/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional. The maximum number of rows to return. The service may return fewer than this value. If unspecified, at most 1,000 rows will be returned. The maximum value is 10,000; values greater than 10,000 will be reduced to 10,000.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Optional. A page token, received from a previous `FetchReportResultRows` call. Provide this to retrieve the second and subsequent batches of rows.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}:fetchRows",
+ "response": {
+ "$ref": "FetchReportResultRowsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/agencies-and-brands"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "revision": "20260828",
+ "rootUrl": "https://agenciesandbrands.googleapis.com/",
+ "schemas": {
+ "Date": {
+ "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",
+ "id": "Date",
+ "properties": {
+ "day": {
+ "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",
+ "type": "integer"
+ },
+ "month": {
+ "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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"
+ }
+ },
+ "type": "object"
+ },
+ "DateRange": {
+ "description": "A date range for a report.",
+ "id": "DateRange",
+ "properties": {
+ "fixed": {
+ "$ref": "FixedDateRange",
+ "description": "A fixed date range."
+ },
+ "relative": {
+ "description": "A relative date range.",
+ "enum": [
+ "RELATIVE_DATE_RANGE_UNSPECIFIED",
+ "TODAY",
+ "YESTERDAY",
+ "THIS_WEEK_TO_DATE",
+ "THIS_WEEK_TO_YESTERDAY",
+ "THIS_MONTH_TO_DATE",
+ "THIS_MONTH_TO_YESTERDAY",
+ "THIS_QUARTER_TO_DATE",
+ "THIS_QUARTER_TO_YESTERDAY",
+ "THIS_YEAR_TO_DATE",
+ "THIS_YEAR_TO_YESTERDAY",
+ "LAST_WEEK",
+ "LAST_WEEK_STARTING_SUNDAY",
+ "LAST_MONTH",
+ "LAST_QUARTER",
+ "LAST_YEAR",
+ "LAST_7_DAYS",
+ "LAST_30_DAYS",
+ "LAST_60_DAYS",
+ "LAST_90_DAYS",
+ "LAST_93_DAYS",
+ "LAST_180_DAYS",
+ "LAST_360_DAYS",
+ "LAST_365_DAYS",
+ "LAST_3_MONTHS",
+ "LAST_6_MONTHS",
+ "LAST_12_MONTHS",
+ "ALL_AVAILABLE"
+ ],
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "The date the report is run.",
+ "The date a day before the date that the report is run.",
+ "From the beginning of the calendar week in which the up to and including the day the report is run.",
+ "From the beginning of the calendar week in which the report is run, up to and including the day before the report is run.",
+ "From the beginning of the calendar month in which the report is run, to up to and including the day the report is run.",
+ "From the beginning of the calendar month in which the report is run, up to and including the day before the report is run.",
+ "From the beginning of the calendar quarter in which the report is run, up to and including the day the report is run.",
+ "From the beginning of the calendar quarter in which the report is run, up to and including the day before the report is run.",
+ "From the beginning of the calendar year in which the report is run, to up to and including the day the report is run.",
+ "From the beginning of the calendar year in which the report is run, to up to and including the day before the report is run.",
+ "The entire previous calendar week, Monday to Sunday (inclusive), preceding the calendar week the report is run.",
+ "The entire previous calendar week, Sunday to Saturday (inclusive), preceding the calendar week the report is run.",
+ "The entire previous calendar month preceding the calendar month the report is run.",
+ "The entire previous calendar quarter preceding the calendar quarter the report is run.",
+ "The entire previous calendar year preceding the calendar year the report is run.",
+ "The 7 days preceding the day the report is run.",
+ "The 30 days preceding the day the report is run.",
+ "The 60 days preceding the day the report is run.",
+ "The 90 days preceding the day the report is run.",
+ "The 93 days preceding the day the report is run.",
+ "The 180 days preceding the day the report is run.",
+ "The 360 days preceding the day the report is run.",
+ "The 365 days preceding the day the report is run.",
+ "The entire previous 3 calendar months preceding the calendar month the report is run.",
+ "The entire previous 6 calendar months preceding the calendar month the report is run.",
+ "The entire previous 12 calendar months preceding the calendar month the report is run.",
+ "From 3 years before the report is run, to the day before the report is run, inclusive."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DoubleList": {
+ "description": "A list of double values.",
+ "id": "DoubleList",
+ "properties": {
+ "values": {
+ "description": "The values",
+ "items": {
+ "format": "double",
+ "type": "number"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "FetchReportResultRowsResponse": {
+ "description": "The response message for the fetch report result rows endpoint.",
+ "id": "FetchReportResultRowsResponse",
+ "properties": {
+ "dateRanges": {
+ "description": "The computed fixed date ranges this report includes. Only returned with the first page of results (when page_token is not included in the request).",
+ "items": {
+ "$ref": "FixedDateRange"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+ "type": "string"
+ },
+ "rows": {
+ "description": "Up to `page_size` rows of report data.",
+ "items": {
+ "$ref": "Row"
+ },
+ "type": "array"
+ },
+ "runTime": {
+ "description": "The time at which the report was scheduled to run. For non-scheduled reports, this is the time at which the report was requested to be run.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "totalRowCount": {
+ "description": "The total number of rows available from this report. Useful for pagination. Only returned with the first page of results (when page_token is not included in the request).",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Field": {
+ "description": "A dimension or a metric in a report.",
+ "id": "Field",
+ "properties": {
+ "dimension": {
+ "description": "The dimension this field represents.",
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ADVERTISER_DOMAIN",
+ "AGENCY_ACCOUNT_ID",
+ "AGENCY_ACCOUNT_NAME",
+ "BID_FILTERING_REASON",
+ "BID_FILTERING_REASON_NAME",
+ "BUYER_SDK",
+ "CAMPAIGN_ID",
+ "CAMPAIGN_NAME",
+ "COUNTRY",
+ "CREATIVE_FORMAT",
+ "CREATIVE_ID",
+ "CREATIVE_POLICIES",
+ "CREATIVE_POLICIES_NAME",
+ "CREATIVE_SIZE",
+ "CURATION_DATA_SEGMENT_ID",
+ "CURATION_PARTNER_NAME",
+ "CURATOR_FEE_TYPE",
+ "DATE",
+ "DEAL_ID",
+ "DEAL_NAME",
+ "DETECTED_ADVERTISER_NAME",
+ "DSP_NAME",
+ "DSP_SEAT_ID",
+ "ENVIRONMENT",
+ "ENVIRONMENT_NAME",
+ "GMA_SDK",
+ "HOUR",
+ "MOBILE_APP_ID",
+ "MOBILE_APP_NAME",
+ "MOBILE_OS",
+ "MONTH",
+ "PACKAGE_FEE_VISIBILITY",
+ "PLACEMENT_ID",
+ "PLATFORM",
+ "PUBLISHER_DOMAIN",
+ "PUBLISHER_ID",
+ "PUBLISHER_NAME",
+ "PUBLISHER_PROTECTIONS",
+ "PUBLISHER_PROTECTIONS_NAME",
+ "SELLER_AUTHORIZATION",
+ "SELLER_AUTHORIZATION_NAME",
+ "SUPPLY_PATH_TYPE",
+ "SUPPLY_PATH_TYPE_NAME",
+ "TRANSACTION_TYPE",
+ "VAST_ERROR_CODE",
+ "WEEK"
+ ],
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "The domain of the advertiser.",
+ "Agency account ID.",
+ "Agency account name.",
+ "Reason that a Real-time Bidding bid was filtered from the auction.",
+ "The short description of the reason that a Real-time Bidding bid was filtered from the auction.",
+ "A boolean indicating whether the impression was rendered by a buyer SDK. If set to true, the impression was rendered by a buyer SDK.",
+ "The ID of the agency campaign.",
+ "The display name of the agency campaign.",
+ "Display name of a country.",
+ "Creative format, \"Display\" vs. \"Video\".",
+ "Creative ID.",
+ "Applied creative policies.",
+ "The localized display name of applied creative policies.",
+ "Creative size.",
+ "The ID of the data segment created by a curator.",
+ "The display name of the curation partner.",
+ "The type of curation service (e.g. packaging or data segment).",
+ "Date.",
+ "Deal ID.",
+ "Deal name.",
+ "Display name of the detected advertiser.",
+ "Display name of the DSP.",
+ "DSP Seat ID.",
+ "The user device and container environment where the impression originates. Supported values are \"app\" and \"web\".",
+ "The localized display name of the user device and container environment where the impression originates. Supported values are \"app\" and \"web\".",
+ "A boolean indicating whether the impression was rendered by the Google Mobile Ads SDK. If set to true, the impression was rendered by the Google Mobile Ads SDK.",
+ "Hour.",
+ "Mobile App ID.",
+ "Mobile App Name.",
+ "Mobile operating system.",
+ "Month.",
+ "The visibility of the package fee (e.g. disclosed or non-disclosed).",
+ "Placement ID.",
+ "Platform, e.g. \"desktop\" vs. \"mobile\".",
+ "Publisher domain.",
+ "Publisher identifier.",
+ "Publisher name.",
+ "Whether publisher protections are applied.",
+ "The localized display name indicating whether publisher protections are applied.",
+ "Seller authorization.",
+ "The localized display name of seller authorization.",
+ "The supply path type of the deal for Agency Direct.",
+ "The localized display name of the supply path type of the deal for Agency Direct.",
+ "The transaction type of the deal.",
+ "VAST error code.",
+ "Week."
+ ],
+ "type": "string"
+ },
+ "metric": {
+ "description": "The metric this field represents.",
+ "enum": [
+ "METRIC_UNSPECIFIED",
+ "ACTIVE_VIEW_MEASURABILITY_RATE",
+ "ACTIVE_VIEW_MEASURABLE",
+ "ACTIVE_VIEW_VIEWABILITY_RATE",
+ "ACTIVE_VIEW_VIEWABLE",
+ "AUCTIONS_WON",
+ "BIDS",
+ "BIDS_IN_AUCTION",
+ "CLICKS",
+ "CPC",
+ "CPM",
+ "CURATION_PARTNER_FEE",
+ "DISCOUNT_AMOUNT",
+ "EFFECTIVE_DISCOUNT_RATE",
+ "ENGAGED_VIEWS",
+ "IMPRESSIONS",
+ "PRE_DISCOUNT_SPEND",
+ "PRE_DISCOUNT_SPEND_WITHOUT_CURATION_PARTNER_FEE",
+ "REACHED_QUERIES",
+ "SPEND",
+ "SPEND_WITHOUT_CURATION_PARTNER_FEE",
+ "VAST_ERROR_COUNT",
+ "VIDEO_COMPLETE",
+ "VIDEO_FIRST_QUARTILE",
+ "VIDEO_MIDPOINT",
+ "VIDEO_START",
+ "VIDEO_THIRD_QUARTILE",
+ "VIDEO_VTR"
+ ],
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "Active View measurability rate.",
+ "Active View measurable.",
+ "Active view viewability rate.",
+ "Active View viewable imps.",
+ "Auctions won.",
+ "Bids.",
+ "Bids in auction.",
+ "Clicks.",
+ "CPC.",
+ "CPM.",
+ "Curator fee.",
+ "Discount amount in media planner currency.",
+ "Discount rate in media planner currency.",
+ "Engaged views.",
+ "Impressions.",
+ "Discount spend in media planner currency.",
+ "Gross media cost in media planner currency.",
+ "Queries that are reached in the mediation chain.",
+ "Spend in reporting currency specified in the request. Defaults to USD.",
+ "Net media cost in media planner currency.",
+ "Number of video impressions failed to render due to VAST errors.",
+ "Number of video impressions played to completion.",
+ "Number of video impressions played to the first quartile.",
+ "Number of video impressions played to the midpoint.",
+ "Number of video impressions played.",
+ "Number of video impressions played to the third quartile.",
+ "The rate in which video impressions were watched to completion."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FieldFilter": {
+ "description": "A filter on a specific field.",
+ "id": "FieldFilter",
+ "properties": {
+ "field": {
+ "$ref": "Field",
+ "description": "Required. The field to filter on."
+ },
+ "operation": {
+ "description": "Required. The operation of this filter.",
+ "enum": [
+ "IN",
+ "NOT_IN",
+ "CONTAINS",
+ "NOT_CONTAINS",
+ "LESS_THAN",
+ "LESS_THAN_EQUALS",
+ "GREATER_THAN",
+ "GREATER_THAN_EQUALS",
+ "BETWEEN",
+ "MATCHES",
+ "NOT_MATCHES"
+ ],
+ "enumDescriptions": [
+ "For scalar operands, checks if the operand is in the set of provided filter values. For list operands, checks if any element in the operand is in the set of provided filter values. Default value.",
+ "For scalar operands, checks that the operand is not in the set of provided filter values. For list operands, checks that none of the elements in the operand is in the set of provided filter values.",
+ "For scalar string operands, checks if the operand contains any of the provided filter substrings. For string list operands, checks if any string in the operand contains any of the provided filter substrings.",
+ "For scalar string operands, checks that the operand contains none of the provided filter substrings. For string list operands, checks that none of the strings in the operand contain none of the provided filter substrings.",
+ "Operand is less than the provided filter value.",
+ "Operand is less than or equal to provided filter value.",
+ "Operand is greater than provided filter value.",
+ "Operand is greater than or equal to provided filter value.",
+ "Operand is between provided filter values.",
+ "Operand matches against a regular expression or set of regular expressions (one must match).",
+ "Operand negative matches against a regular expression or set of regular expressions (none must match)."
+ ],
+ "type": "string"
+ },
+ "values": {
+ "description": "Required. Values to filter to.",
+ "items": {
+ "$ref": "ReportValue"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Filter": {
+ "description": "A filter over one or more fields.",
+ "id": "Filter",
+ "properties": {
+ "andFilter": {
+ "$ref": "FilterList",
+ "description": "A list of filters whose results are AND-ed."
+ },
+ "fieldFilter": {
+ "$ref": "FieldFilter",
+ "description": "A filter on a single field."
+ },
+ "notFilter": {
+ "$ref": "Filter",
+ "description": "A filter whose result is negated."
+ },
+ "orFilter": {
+ "$ref": "FilterList",
+ "description": "A list of filters whose results are OR-ed."
+ }
+ },
+ "type": "object"
+ },
+ "FilterList": {
+ "description": "A list of filters.",
+ "id": "FilterList",
+ "properties": {
+ "filters": {
+ "description": "Required. A list of filters.",
+ "items": {
+ "$ref": "Filter"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "FixedDateRange": {
+ "description": "A date range between two fixed dates (inclusive of end date).",
+ "id": "FixedDateRange",
+ "properties": {
+ "endDate": {
+ "$ref": "Date",
+ "description": "Required. The end date (inclusive) of this date range."
+ },
+ "startDate": {
+ "$ref": "Date",
+ "description": "Required. The start date of this date range."
+ }
+ },
+ "type": "object"
+ },
+ "IntList": {
+ "description": "A list of integer values.",
+ "id": "IntList",
+ "properties": {
+ "values": {
+ "description": "The values",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListReportsResponse": {
+ "description": "Response object for `ListReportsResponse` containing matching `Report` objects.",
+ "id": "ListReportsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+ "type": "string"
+ },
+ "reports": {
+ "description": "The `Report` objects from the specified network.",
+ "items": {
+ "$ref": "Report"
+ },
+ "type": "array"
+ },
+ "totalSize": {
+ "description": "Total number of `Report` objects. If a filter was included in the request, this reflects the total number after the filtering is applied. `total_size` won't be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter `$fields` or `fields`, or by using the HTTP/gRPC header `X-Goog-FieldMask`. For more information, see https://developers.google.com/ad-manager/api/beta/field-masks",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "MetricValueGroup": {
+ "description": "Contains all metric values requested for a single date range and set of column dimension values (returned in the columns field of the response). The order of the metrics in each field corresponds to the order of the metrics specified in the request.",
+ "id": "MetricValueGroup",
+ "properties": {
+ "primaryValues": {
+ "description": "Data for the PRIMARY MetricValueType.",
+ "items": {
+ "$ref": "ReportValue"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "id": "Operation",
+ "properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
+ "type": "boolean"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
+ "type": "string"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "Report": {
+ "description": "The `Report` resource.",
+ "id": "Report",
+ "properties": {
+ "createTime": {
+ "description": "Output only. The instant this report was created.",
+ "format": "google-datetime",
+ "readOnly": true,
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Optional. Display name for the report.",
+ "type": "string"
+ },
+ "locale": {
+ "description": "Output only. The locale of this report. Locale is set from the user's locale at the time of the request. Locale can't be modified.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "Identifier. The resource name of the report. Report resource name have the form: `agencies/{account_id}/reports/{report_id}`",
+ "type": "string"
+ },
+ "reportDefinition": {
+ "$ref": "ReportDefinition",
+ "description": "Required. The report definition of the report."
+ },
+ "reportId": {
+ "description": "Output only. Report ID.",
+ "format": "int64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Output only. The instant this report was last modified.",
+ "format": "google-datetime",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportDefinition": {
+ "description": "The definition of how a report should be run.",
+ "id": "ReportDefinition",
+ "properties": {
+ "currencyCode": {
+ "description": "Optional. The ISO 4217 currency code for this report. Defaults to account currency code if not specified.",
+ "type": "string"
+ },
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "Required. The primary date range of this report."
+ },
+ "dimensions": {
+ "description": "Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.",
+ "items": {
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ADVERTISER_DOMAIN",
+ "AGENCY_ACCOUNT_ID",
+ "AGENCY_ACCOUNT_NAME",
+ "BID_FILTERING_REASON",
+ "BID_FILTERING_REASON_NAME",
+ "BUYER_SDK",
+ "CAMPAIGN_ID",
+ "CAMPAIGN_NAME",
+ "COUNTRY",
+ "CREATIVE_FORMAT",
+ "CREATIVE_ID",
+ "CREATIVE_POLICIES",
+ "CREATIVE_POLICIES_NAME",
+ "CREATIVE_SIZE",
+ "CURATION_DATA_SEGMENT_ID",
+ "CURATION_PARTNER_NAME",
+ "CURATOR_FEE_TYPE",
+ "DATE",
+ "DEAL_ID",
+ "DEAL_NAME",
+ "DETECTED_ADVERTISER_NAME",
+ "DSP_NAME",
+ "DSP_SEAT_ID",
+ "ENVIRONMENT",
+ "ENVIRONMENT_NAME",
+ "GMA_SDK",
+ "HOUR",
+ "MOBILE_APP_ID",
+ "MOBILE_APP_NAME",
+ "MOBILE_OS",
+ "MONTH",
+ "PACKAGE_FEE_VISIBILITY",
+ "PLACEMENT_ID",
+ "PLATFORM",
+ "PUBLISHER_DOMAIN",
+ "PUBLISHER_ID",
+ "PUBLISHER_NAME",
+ "PUBLISHER_PROTECTIONS",
+ "PUBLISHER_PROTECTIONS_NAME",
+ "SELLER_AUTHORIZATION",
+ "SELLER_AUTHORIZATION_NAME",
+ "SUPPLY_PATH_TYPE",
+ "SUPPLY_PATH_TYPE_NAME",
+ "TRANSACTION_TYPE",
+ "VAST_ERROR_CODE",
+ "WEEK"
+ ],
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "The domain of the advertiser.",
+ "Agency account ID.",
+ "Agency account name.",
+ "Reason that a Real-time Bidding bid was filtered from the auction.",
+ "The short description of the reason that a Real-time Bidding bid was filtered from the auction.",
+ "A boolean indicating whether the impression was rendered by a buyer SDK. If set to true, the impression was rendered by a buyer SDK.",
+ "The ID of the agency campaign.",
+ "The display name of the agency campaign.",
+ "Display name of a country.",
+ "Creative format, \"Display\" vs. \"Video\".",
+ "Creative ID.",
+ "Applied creative policies.",
+ "The localized display name of applied creative policies.",
+ "Creative size.",
+ "The ID of the data segment created by a curator.",
+ "The display name of the curation partner.",
+ "The type of curation service (e.g. packaging or data segment).",
+ "Date.",
+ "Deal ID.",
+ "Deal name.",
+ "Display name of the detected advertiser.",
+ "Display name of the DSP.",
+ "DSP Seat ID.",
+ "The user device and container environment where the impression originates. Supported values are \"app\" and \"web\".",
+ "The localized display name of the user device and container environment where the impression originates. Supported values are \"app\" and \"web\".",
+ "A boolean indicating whether the impression was rendered by the Google Mobile Ads SDK. If set to true, the impression was rendered by the Google Mobile Ads SDK.",
+ "Hour.",
+ "Mobile App ID.",
+ "Mobile App Name.",
+ "Mobile operating system.",
+ "Month.",
+ "The visibility of the package fee (e.g. disclosed or non-disclosed).",
+ "Placement ID.",
+ "Platform, e.g. \"desktop\" vs. \"mobile\".",
+ "Publisher domain.",
+ "Publisher identifier.",
+ "Publisher name.",
+ "Whether publisher protections are applied.",
+ "The localized display name indicating whether publisher protections are applied.",
+ "Seller authorization.",
+ "The localized display name of seller authorization.",
+ "The supply path type of the deal for Agency Direct.",
+ "The localized display name of the supply path type of the deal for Agency Direct.",
+ "The transaction type of the deal.",
+ "VAST error code.",
+ "Week."
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "filters": {
+ "description": "Optional. The filters for this report.",
+ "items": {
+ "$ref": "Filter"
+ },
+ "type": "array"
+ },
+ "metrics": {
+ "description": "Required. The list of metrics to report on. If empty, the report will have no metrics.",
+ "items": {
+ "enum": [
+ "METRIC_UNSPECIFIED",
+ "ACTIVE_VIEW_MEASURABILITY_RATE",
+ "ACTIVE_VIEW_MEASURABLE",
+ "ACTIVE_VIEW_VIEWABILITY_RATE",
+ "ACTIVE_VIEW_VIEWABLE",
+ "AUCTIONS_WON",
+ "BIDS",
+ "BIDS_IN_AUCTION",
+ "CLICKS",
+ "CPC",
+ "CPM",
+ "CURATION_PARTNER_FEE",
+ "DISCOUNT_AMOUNT",
+ "EFFECTIVE_DISCOUNT_RATE",
+ "ENGAGED_VIEWS",
+ "IMPRESSIONS",
+ "PRE_DISCOUNT_SPEND",
+ "PRE_DISCOUNT_SPEND_WITHOUT_CURATION_PARTNER_FEE",
+ "REACHED_QUERIES",
+ "SPEND",
+ "SPEND_WITHOUT_CURATION_PARTNER_FEE",
+ "VAST_ERROR_COUNT",
+ "VIDEO_COMPLETE",
+ "VIDEO_FIRST_QUARTILE",
+ "VIDEO_MIDPOINT",
+ "VIDEO_START",
+ "VIDEO_THIRD_QUARTILE",
+ "VIDEO_VTR"
+ ],
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "Active View measurability rate.",
+ "Active View measurable.",
+ "Active view viewability rate.",
+ "Active View viewable imps.",
+ "Auctions won.",
+ "Bids.",
+ "Bids in auction.",
+ "Clicks.",
+ "CPC.",
+ "CPM.",
+ "Curator fee.",
+ "Discount amount in media planner currency.",
+ "Discount rate in media planner currency.",
+ "Engaged views.",
+ "Impressions.",
+ "Discount spend in media planner currency.",
+ "Gross media cost in media planner currency.",
+ "Queries that are reached in the mediation chain.",
+ "Spend in reporting currency specified in the request. Defaults to USD.",
+ "Net media cost in media planner currency.",
+ "Number of video impressions failed to render due to VAST errors.",
+ "Number of video impressions played to completion.",
+ "Number of video impressions played to the first quartile.",
+ "Number of video impressions played to the midpoint.",
+ "Number of video impressions played.",
+ "Number of video impressions played to the third quartile.",
+ "The rate in which video impressions were watched to completion."
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "sorts": {
+ "description": "Optional. Default sorts to apply to this report.",
+ "items": {
+ "$ref": "Sort"
+ },
+ "type": "array"
+ },
+ "timeZone": {
+ "description": "Optional. If time_zone_source is PROVIDED, this is the time zone to use for this report. Leave empty for any other time zone source. Time zone in IANA format. For example, \"America/New_York\".",
+ "type": "string"
+ },
+ "timeZoneSource": {
+ "description": "Optional. Where to get the time zone for this report. Defaults to using the Pacific time zone (PT). If source is PROVIDED, the time_zone field in the report definition must also set a time zone.",
+ "enum": [
+ "TIME_ZONE_SOURCE_UNSPECIFIED",
+ "AD_EXCHANGE",
+ "UTC",
+ "PROVIDED",
+ "AGENCY"
+ ],
+ "enumDescriptions": [
+ "Unspecified default value.",
+ "Use the Pacific time zone(PT).",
+ "Use UTC time zone.",
+ "Use the time zone provided in the ReportDefinition.time_zone field. Reports may take longer to run since the dates are dynamically calculated at request time.",
+ "Use the time zone from the agency's account settings."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportValue": {
+ "description": "Represents a single value in a report.",
+ "id": "ReportValue",
+ "properties": {
+ "boolValue": {
+ "description": "For boolean values.",
+ "type": "boolean"
+ },
+ "bytesValue": {
+ "description": "For bytes values.",
+ "format": "byte",
+ "type": "string"
+ },
+ "doubleListValue": {
+ "$ref": "DoubleList",
+ "description": "For lists of double values."
+ },
+ "doubleValue": {
+ "description": "For double values.",
+ "format": "double",
+ "type": "number"
+ },
+ "intListValue": {
+ "$ref": "IntList",
+ "description": "For lists of integer values."
+ },
+ "intValue": {
+ "description": "For integer values.",
+ "format": "int64",
+ "type": "string"
+ },
+ "stringListValue": {
+ "$ref": "StringList",
+ "description": "For lists of string values."
+ },
+ "stringValue": {
+ "description": "For string values.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Row": {
+ "description": "A row of report data.",
+ "id": "Row",
+ "properties": {
+ "dimensionValues": {
+ "description": "The order of the dimension values is the same as the order of the dimensions specified in the request.",
+ "items": {
+ "$ref": "ReportValue"
+ },
+ "type": "array"
+ },
+ "metricValueGroups": {
+ "description": " The length of the metric_value_groups field will be equal to the length of the date_ranges field in the fetch response. The metric_value_groups field is ordered such that each index corresponds to the date_range at the same index. For example, given date_ranges [x, y], metric_value_groups will have a length of two. The first entry in metric_value_groups represents the metrics for date x and the second entry in metric_value_groups represents the metrics for date y.",
+ "items": {
+ "$ref": "MetricValueGroup"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RunReportMetadata": {
+ "description": "`RunReport` operation metadata.",
+ "id": "RunReportMetadata",
+ "properties": {
+ "percentComplete": {
+ "description": "An estimate of how close this report is to being completed. Will always be 100 for failed and completed reports.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "report": {
+ "description": "The result's parent report.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RunReportRequest": {
+ "description": "Request message for a running a report.",
+ "id": "RunReportRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "RunReportResponse": {
+ "description": "Response message for a completed `RunReport` operation.",
+ "id": "RunReportResponse",
+ "properties": {
+ "reportResult": {
+ "description": "The unique name of the generated result. Use with `FetchReportResultRows` to retrieve data.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Sort": {
+ "description": "Represents a sorting in a report.",
+ "id": "Sort",
+ "properties": {
+ "descending": {
+ "description": "Optional. The sort order. If true the sort will be descending.",
+ "type": "boolean"
+ },
+ "field": {
+ "$ref": "Field",
+ "description": "Required. A field (dimension or metric) to sort by."
+ }
+ },
+ "type": "object"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
+ "id": "Status",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "StringList": {
+ "description": "A list of string values.",
+ "id": "StringList",
+ "properties": {
+ "values": {
+ "description": "The values",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "servicePath": "",
+ "title": "Agencies and Brands API",
+ "version": "v1",
+ "version_module": true
+}
\ No newline at end of file
diff --git a/discovery/agentregistry-v1alpha.json b/discovery/agentregistry-v1alpha.json
index f25db3f6ef5..7e380f6966d 100644
--- a/discovery/agentregistry-v1alpha.json
+++ b/discovery/agentregistry-v1alpha.json
@@ -140,8 +140,10 @@
"$ref": "Location"
},
"scopes": [
+ "https://www.googleapis.com/auth/agentregistry.read-only",
"https://www.googleapis.com/auth/agentregistry.read-write",
- "https://www.googleapis.com/auth/cloud-platform"
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
]
},
"list": {
@@ -188,8 +190,10 @@
"$ref": "ListLocationsResponse"
},
"scopes": [
+ "https://www.googleapis.com/auth/agentregistry.read-only",
"https://www.googleapis.com/auth/agentregistry.read-write",
- "https://www.googleapis.com/auth/cloud-platform"
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
},
@@ -868,8 +872,10 @@
"$ref": "ListOperationsResponse"
},
"scopes": [
+ "https://www.googleapis.com/auth/agentregistry.read-only",
"https://www.googleapis.com/auth/agentregistry.read-write",
- "https://www.googleapis.com/auth/cloud-platform"
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloud-platform.read-only"
]
}
}
@@ -1258,7 +1264,7 @@
],
"parameters": {
"filter": {
- "description": "Optional. Use this field to specify filter criteria on list results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `>` | |--------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state.",
+ "description": "Optional. Use this field to specify filter criteria on list results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `>` | |----------------------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | | publisher | Yes | No | | frontmatter.metadata. | Yes | No | | attributes.. | Yes | No | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state. * `frontmatter.metadata.version=10` to restrict results to skills with a frontmatter metadata `version` equal to `10`.",
"location": "query",
"type": "string"
},
@@ -1349,7 +1355,7 @@
],
"parameters": {
"filter": {
- "description": "Optional. Use this field to specify additional filter criteria on search results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `>` | |--------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state.",
+ "description": "Optional. Use this field to specify additional filter criteria on search results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `>` | |----------------------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | | publisher | Yes | No | | frontmatter.metadata. | Yes | No | | attributes.. | Yes | No | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state. * `frontmatter.metadata.version=10` to restrict results to skills with a frontmatter metadata `version` equal to `10`.",
"location": "query",
"type": "string"
},
@@ -1372,7 +1378,7 @@
"type": "string"
},
"searchString": {
- "description": "Optional. Search criteria used to select the Skills to return. If no search criteria is specified then all accessible Skills will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |---------------------------|-----|-----|-----|----------------| | skillId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | description | No | Yes | No | Included | | frontmatter.name | No | Yes | No | Included | | frontmatter.description | No | Yes | No | Included | | frontmatter.compatibility | No | Yes | No | Included | | frontmatter.license | No | Yes | No | Included | Examples: * `skillId=\"urn:skill:projects-1234:locations:global:private-important-skill\"` to find the skill with the specified skill ID. * `name:important` to find skills whose name contains `important` as a word. * `displayName:works*` to find skills whose display name contains words that start with `works`.",
+ "description": "Optional. Search criteria used to select the Skills to return. If no search criteria is specified then all accessible Skills will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |----------------------------|-----|-----|-----|----------------| | skillId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | description | No | Yes | No | Included | | publisher | No | Yes | Yes | Excluded | | frontmatter.name | No | Yes | No | Included | | frontmatter.description | No | Yes | No | Included | | frontmatter.compatibility | No | Yes | No | Included | | frontmatter.license | No | Yes | No | Included | | frontmatter.metadata. | No | Yes | No | Excluded | | attributes.. | No | Yes | No | Excluded | Examples: * `skillId=\"urn:skill:projects-1234:locations:global:private-important-skill\"` to find the skill with the specified skill ID. * `name:important` to find skills whose name contains `important` as a word. * `displayName:works*` to find skills whose display name contains words that start with `works`. * `frontmatter.metadata.author:alice` to find skills whose frontmatter metadata `author` contains words that start with `alice`.",
"location": "query",
"type": "string"
},
@@ -1559,7 +1565,7 @@
}
}
},
- "revision": "20260812",
+ "revision": "20260821",
"rootUrl": "https://agentregistry.googleapis.com/",
"schemas": {
"A2ASkill": {
diff --git a/discovery/alloydb-v1.json b/discovery/alloydb-v1.json
index 261dd24be0e..989e9c88c28 100644
--- a/discovery/alloydb-v1.json
+++ b/discovery/alloydb-v1.json
@@ -1879,20 +1879,9 @@
}
}
},
- "revision": "20260813",
+ "revision": "20260818",
"rootUrl": "https://alloydb.googleapis.com/",
"schemas": {
- "AlloydbClhErrorsAlloyDbInternalDebugInfo": {
- "description": "AlloyDbInternalDebugInfo contains internal debugging information for AlloyDB errors. It is explicitly kept out of the allowlist (errors.yaml) to ensure it is sanitized (stripped) by OnePlatform for all external requests. Used only to carry internal error details to across UPC/FlowLib boundary for ObservabilityInfo.",
- "id": "AlloydbClhErrorsAlloyDbInternalDebugInfo",
- "properties": {
- "originalError": {
- "description": "The original error message or details before sanitization, used internally for debugging and logging.",
- "type": "string"
- }
- },
- "type": "object"
- },
"AuthorizedNetwork": {
"description": "AuthorizedNetwork contains metadata for an authorized network.",
"id": "AuthorizedNetwork",
diff --git a/discovery/alloydb-v1alpha.json b/discovery/alloydb-v1alpha.json
index 7fa62862d5e..3b2bfa114bc 100644
--- a/discovery/alloydb-v1alpha.json
+++ b/discovery/alloydb-v1alpha.json
@@ -2086,20 +2086,9 @@
}
}
},
- "revision": "20260813",
+ "revision": "20260818",
"rootUrl": "https://alloydb.googleapis.com/",
"schemas": {
- "AlloydbClhErrorsAlloyDbInternalDebugInfo": {
- "description": "AlloyDbInternalDebugInfo contains internal debugging information for AlloyDB errors. It is explicitly kept out of the allowlist (errors.yaml) to ensure it is sanitized (stripped) by OnePlatform for all external requests. Used only to carry internal error details to across UPC/FlowLib boundary for ObservabilityInfo.",
- "id": "AlloydbClhErrorsAlloyDbInternalDebugInfo",
- "properties": {
- "originalError": {
- "description": "The original error message or details before sanitization, used internally for debugging and logging.",
- "type": "string"
- }
- },
- "type": "object"
- },
"AuthorizedNetwork": {
"description": "AuthorizedNetwork contains metadata for an authorized network.",
"id": "AuthorizedNetwork",
diff --git a/discovery/alloydb-v1beta.json b/discovery/alloydb-v1beta.json
index 79bbbe2ef2a..4965af37866 100644
--- a/discovery/alloydb-v1beta.json
+++ b/discovery/alloydb-v1beta.json
@@ -2083,20 +2083,9 @@
}
}
},
- "revision": "20260813",
+ "revision": "20260818",
"rootUrl": "https://alloydb.googleapis.com/",
"schemas": {
- "AlloydbClhErrorsAlloyDbInternalDebugInfo": {
- "description": "AlloyDbInternalDebugInfo contains internal debugging information for AlloyDB errors. It is explicitly kept out of the allowlist (errors.yaml) to ensure it is sanitized (stripped) by OnePlatform for all external requests. Used only to carry internal error details to across UPC/FlowLib boundary for ObservabilityInfo.",
- "id": "AlloydbClhErrorsAlloyDbInternalDebugInfo",
- "properties": {
- "originalError": {
- "description": "The original error message or details before sanitization, used internally for debugging and logging.",
- "type": "string"
- }
- },
- "type": "object"
- },
"AuthorizedNetwork": {
"description": "AuthorizedNetwork contains metadata for an authorized network.",
"id": "AuthorizedNetwork",
diff --git a/discovery/authorizedbuyersmarketplace-v1alpha.json b/discovery/authorizedbuyersmarketplace-v1alpha.json
index 018843b4a88..15fbc7cbb31 100644
--- a/discovery/authorizedbuyersmarketplace-v1alpha.json
+++ b/discovery/authorizedbuyersmarketplace-v1alpha.json
@@ -1806,7 +1806,7 @@
}
}
},
- "revision": "20260723",
+ "revision": "20260828",
"rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/",
"schemas": {
"AcceptProposalRequest": {
@@ -2375,6 +2375,10 @@
"format": "google-datetime",
"readOnly": true,
"type": "string"
+ },
+ "userListId": {
+ "description": "Optional. Immutable. The ID of the User List wrapped by this Data Segment. Curators with a linked Data Partner account can create a data segment that wraps a user list owned by the linked Data Partner account. User lists can be uploaded and managed using the [Data Manager API](https://developers.google.com/data-manager/api/data-partners/audiences). Linking a user list to a data segment lets you define a segment of inventory that is based on an audience you create.",
+ "type": "string"
}
},
"type": "object"
diff --git a/discovery/authorizedbuyersmarketplace-v1beta.json b/discovery/authorizedbuyersmarketplace-v1beta.json
index 34670678925..f8a8fdef65b 100644
--- a/discovery/authorizedbuyersmarketplace-v1beta.json
+++ b/discovery/authorizedbuyersmarketplace-v1beta.json
@@ -517,7 +517,7 @@
}
}
},
- "revision": "20260723",
+ "revision": "20260828",
"rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/",
"schemas": {
"AccessControlSettings": {
@@ -730,6 +730,10 @@
"format": "google-datetime",
"readOnly": true,
"type": "string"
+ },
+ "userListId": {
+ "description": "Optional. Immutable. The ID of the User List wrapped by this Data Segment. Curators with a linked Data Partner account can create a data segment that wraps a user list owned by the linked Data Partner account. User lists can be uploaded and managed using the [Data Manager API](https://developers.google.com/data-manager/api/data-partners/audiences). Linking a user list to a data segment lets you define a segment of inventory that is based on an audience you create.",
+ "type": "string"
}
},
"type": "object"
diff --git a/discovery/ces-v1.json b/discovery/ces-v1.json
index fd9cd566360..4f824aa5f0e 100644
--- a/discovery/ces-v1.json
+++ b/discovery/ces-v1.json
@@ -890,21 +890,6 @@
],
"location": "query",
"type": "string"
- },
- "view": {
- "description": "Optional. The view specifying which fields in the response should be populated.",
- "enum": [
- "CONVERSATION_VIEW_UNSPECIFIED",
- "CONVERSATION_VIEW_BASIC",
- "CONVERSATION_VIEW_FULL"
- ],
- "enumDescriptions": [
- "Not specified, defaults to CONVERSATION_VIEW_BASIC.",
- "The basic view. Returns everything except resolved instructions.",
- "The full view. Includes resolved instructions dynamically per turn."
- ],
- "location": "query",
- "type": "string"
}
},
"path": "v1/{+name}",
@@ -1227,6 +1212,35 @@
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
+ },
+ "stream": {
+ "description": "Sends a streaming message to an agent, allowing for real-time interaction and status updates. Streaming version of `SendMessage`",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}/message:stream",
+ "httpMethod": "POST",
+ "id": "ces.projects.locations.apps.deployments.message.stream",
+ "parameterOrder": [
+ "tenant"
+ ],
+ "parameters": {
+ "tenant": {
+ "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+tenant}/message:stream",
+ "request": {
+ "$ref": "LfA2aV1SendMessageRequest"
+ },
+ "response": {
+ "$ref": "LfA2aV1StreamResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ces",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
}
}
@@ -1621,6 +1635,35 @@
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
+ },
+ "stream": {
+ "description": "Sends a streaming message to an agent, allowing for real-time interaction and status updates. Streaming version of `SendMessage`",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/message:stream",
+ "httpMethod": "POST",
+ "id": "ces.projects.locations.apps.message.stream",
+ "parameterOrder": [
+ "tenant"
+ ],
+ "parameters": {
+ "tenant": {
+ "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+tenant}/message:stream",
+ "request": {
+ "$ref": "LfA2aV1SendMessageRequest"
+ },
+ "response": {
+ "$ref": "LfA2aV1StreamResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ces",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
}
},
@@ -2335,6 +2378,35 @@
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
+ },
+ "stream": {
+ "description": "Sends a streaming message to an agent, allowing for real-time interaction and status updates. Streaming version of `SendMessage`",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}/message:stream",
+ "httpMethod": "POST",
+ "id": "ces.projects.locations.apps.versions.message.stream",
+ "parameterOrder": [
+ "tenant"
+ ],
+ "parameters": {
+ "tenant": {
+ "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+tenant}/message:stream",
+ "request": {
+ "$ref": "LfA2aV1SendMessageRequest"
+ },
+ "response": {
+ "$ref": "LfA2aV1StreamResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ces",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
}
}
@@ -2479,7 +2551,7 @@
}
}
},
- "revision": "20260806",
+ "revision": "20260824",
"rootUrl": "https://ces.googleapis.com/",
"schemas": {
"Action": {
@@ -2997,6 +3069,10 @@
"readOnly": true,
"type": "string"
},
+ "dashboardSettings": {
+ "$ref": "DashboardSettings",
+ "description": "Optional. App-specific dashboard settings for linking and configuring Contact Center Insights dashboards."
+ },
"dataStoreSettings": {
"$ref": "DataStoreSettings",
"description": "Optional. The data store settings for the app."
@@ -4054,23 +4130,10 @@
},
"type": "array"
},
- "resolvedDeveloperInstruction": {
- "description": "Output only. The full dynamically resolved developer instruction generated from templates. This field is only populated on-demand when requested during history retrieval. It is not persisted.",
- "readOnly": true,
- "type": "string"
- },
"rootSpan": {
"$ref": "Span",
"description": "Optional. The root span of the action processing."
},
- "templateAttributes": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Optional. Variables or configurations referenced by the template engine during dynamic prompt generation. This allows reconstructing the exact prompt sent to the model for this turn.",
- "type": "object"
- },
"userIntendedText": {
"description": "Optional. The intended ground-truth text from the Simulated Caller (Polysynth). Only populated when word error rate metrics are enabled.",
"type": "string"
@@ -4078,6 +4141,17 @@
},
"type": "object"
},
+ "DashboardSettings": {
+ "description": "Settings for dashboards associated with the app, that show up in the Monitoring view.",
+ "id": "DashboardSettings",
+ "properties": {
+ "defaultDashboard": {
+ "description": "Optional. The resource name of the default Contact Center Insights dashboard associated with the app. This is the dashboard that will be displayed when users navigate to the Monitoring view for the app. Format: `projects/{project}/locations/{location}/dashboards/{dashboard}`",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"DataStore": {
"description": "A DataStore resource in Vertex AI Search.",
"id": "DataStore",
@@ -4482,6 +4556,11 @@
"enableSnippets": {
"description": "Optional. Whether snippets are enabled.",
"type": "boolean"
+ },
+ "maxSnippets": {
+ "description": "Optional. Number of snippets to return per query. If unset, returns all snippets from the service by default.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
@@ -4505,6 +4584,17 @@
},
"type": "object"
},
+ "DeployChannelResponse": {
+ "description": "Response message for AgentService.DeployChannel.",
+ "id": "DeployChannelResponse",
+ "properties": {
+ "deployment": {
+ "$ref": "Deployment",
+ "description": "The created deployment."
+ }
+ },
+ "type": "object"
+ },
"Deployment": {
"description": "A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.",
"id": "Deployment",
@@ -5510,14 +5600,18 @@
"HARM_CATEGORY_HATE_SPEECH",
"HARM_CATEGORY_DANGEROUS_CONTENT",
"HARM_CATEGORY_HARASSMENT",
- "HARM_CATEGORY_SEXUALLY_EXPLICIT"
+ "HARM_CATEGORY_SEXUALLY_EXPLICIT",
+ "HARM_CATEGORY_PROFANITY",
+ "HARM_CATEGORY_TOXIC"
],
"enumDescriptions": [
"The harm category is unspecified.",
"The harm category is hate speech.",
"The harm category is dangerous content.",
"The harm category is harassment.",
- "The harm category is sexually explicit content."
+ "The harm category is sexually explicit content.",
+ "The harm category is profanity.",
+ "The harm category is toxic."
],
"type": "string"
},
@@ -5588,6 +5682,14 @@
"importOptions": {
"$ref": "ImportAppRequestImportOptions",
"description": "Optional. Options governing the import process for the app."
+ },
+ "jsonPatchContent": {
+ "description": "Optional. Patch content as a JSON string.",
+ "type": "string"
+ },
+ "jsonPatchGcsUri": {
+ "description": "Optional. A Cloud Storage URI pointing to a JSON file containing the patches.",
+ "type": "string"
}
},
"type": "object"
@@ -6459,6 +6561,29 @@
},
"type": "object"
},
+ "LfA2aV1StreamResponse": {
+ "description": "A wrapper object used in streaming operations to encapsulate different types of response data.",
+ "id": "LfA2aV1StreamResponse",
+ "properties": {
+ "artifactUpdate": {
+ "$ref": "LfA2aV1TaskArtifactUpdateEvent",
+ "description": "An event indicating a task artifact update."
+ },
+ "message": {
+ "$ref": "LfA2aV1Message",
+ "description": "A Message object containing a message from the agent."
+ },
+ "statusUpdate": {
+ "$ref": "LfA2aV1TaskStatusUpdateEvent",
+ "description": "An event indicating a task status update."
+ },
+ "task": {
+ "$ref": "LfA2aV1Task",
+ "description": "A Task object containing the current state of the task."
+ }
+ },
+ "type": "object"
+ },
"LfA2aV1StringList": {
"description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.",
"id": "LfA2aV1StringList",
@@ -6514,6 +6639,41 @@
},
"type": "object"
},
+ "LfA2aV1TaskArtifactUpdateEvent": {
+ "description": "A task delta where an artifact has been generated.",
+ "id": "LfA2aV1TaskArtifactUpdateEvent",
+ "properties": {
+ "append": {
+ "description": "If true, the content of this artifact should be appended to a previously sent artifact with the same ID.",
+ "type": "boolean"
+ },
+ "artifact": {
+ "$ref": "LfA2aV1Artifact",
+ "description": "Required. The artifact that was generated or updated."
+ },
+ "contextId": {
+ "description": "Required. The ID of the context that this task belongs to.",
+ "type": "string"
+ },
+ "lastChunk": {
+ "description": "If true, this is the final chunk of the artifact.",
+ "type": "boolean"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Optional. Metadata associated with the artifact update.",
+ "type": "object"
+ },
+ "taskId": {
+ "description": "Required. The ID of the task for this artifact.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"LfA2aV1TaskPushNotificationConfig": {
"description": "A container associating a push notification configuration with a specific task.",
"id": "LfA2aV1TaskPushNotificationConfig",
@@ -6587,6 +6747,33 @@
},
"type": "object"
},
+ "LfA2aV1TaskStatusUpdateEvent": {
+ "description": "An event sent by the agent to notify the client of a change in a task's status.",
+ "id": "LfA2aV1TaskStatusUpdateEvent",
+ "properties": {
+ "contextId": {
+ "description": "Required. The ID of the context that the task belongs to.",
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Optional. Metadata associated with the task update.",
+ "type": "object"
+ },
+ "status": {
+ "$ref": "LfA2aV1TaskStatus",
+ "description": "Required. The new status of the task."
+ },
+ "taskId": {
+ "description": "Required. The ID of the task that has changed.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"ListAgentsResponse": {
"description": "Response message for AgentService.ListAgents.",
"id": "ListAgentsResponse",
@@ -7420,6 +7607,10 @@
"$ref": "AgentCard",
"description": "Required. The agent card of the remote agent that this tool invokes."
},
+ "apiAuthentication": {
+ "$ref": "ApiAuthentication",
+ "description": "Optional. Authentication configuration for calling the remote agent."
+ },
"description": {
"description": "Required. The description of the tool.",
"type": "string"
@@ -7893,6 +8084,10 @@
"$ref": "GoogleSearchSuggestions",
"description": "The suggestions returned from Google Search as a result of invoking the GoogleSearchTool."
},
+ "image": {
+ "$ref": "Image",
+ "description": "Output image from the CES agent."
+ },
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
@@ -8216,6 +8411,11 @@
"description": "Request for the client or the agent to execute the specified tool.",
"id": "ToolCall",
"properties": {
+ "agentName": {
+ "description": "Output only. Human-readable name of the agent that issued this call, e.g. \"Contract Architect\". Empty when the root agent issued it.",
+ "readOnly": true,
+ "type": "string"
+ },
"args": {
"additionalProperties": {
"description": "Properties of the object.",
@@ -8233,6 +8433,11 @@
"description": "Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.",
"type": "string"
},
+ "parentToolCallId": {
+ "description": "Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.",
+ "readOnly": true,
+ "type": "string"
+ },
"tool": {
"description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`",
"type": "string"
@@ -8277,6 +8482,11 @@
"description": "The execution result of a specific tool from the client or the agent.",
"id": "ToolResponse",
"properties": {
+ "agentName": {
+ "description": "Output only. Human-readable name of the agent that issued this call, e.g. \"Contract Architect\". Empty when the root agent issued it.",
+ "readOnly": true,
+ "type": "string"
+ },
"displayName": {
"description": "Output only. Display name of the tool.",
"readOnly": true,
@@ -8286,6 +8496,11 @@
"description": "Optional. The matching ID of the tool call the response is for.",
"type": "string"
},
+ "parentToolCallId": {
+ "description": "Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.",
+ "readOnly": true,
+ "type": "string"
+ },
"response": {
"additionalProperties": {
"description": "Properties of the object.",
diff --git a/discovery/ces-v1beta.json b/discovery/ces-v1beta.json
index a8b6fa908a2..e3cdfb67731 100644
--- a/discovery/ces-v1beta.json
+++ b/discovery/ces-v1beta.json
@@ -1096,21 +1096,6 @@
],
"location": "query",
"type": "string"
- },
- "view": {
- "description": "Optional. The view specifying which fields in the response should be populated.",
- "enum": [
- "CONVERSATION_VIEW_UNSPECIFIED",
- "CONVERSATION_VIEW_BASIC",
- "CONVERSATION_VIEW_FULL"
- ],
- "enumDescriptions": [
- "Not specified, defaults to CONVERSATION_VIEW_BASIC.",
- "The basic view. Returns everything except resolved instructions.",
- "The full view. Includes resolved instructions dynamically per turn."
- ],
- "location": "query",
- "type": "string"
}
},
"path": "v1beta/{+name}",
@@ -1433,6 +1418,35 @@
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
+ },
+ "stream": {
+ "description": "Sends a streaming message to an agent, allowing for real-time interaction and status updates. Streaming version of `SendMessage`",
+ "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/deployments/{deploymentsId}/message:stream",
+ "httpMethod": "POST",
+ "id": "ces.projects.locations.apps.deployments.message.stream",
+ "parameterOrder": [
+ "tenant"
+ ],
+ "parameters": {
+ "tenant": {
+ "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/deployments/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/{+tenant}/message:stream",
+ "request": {
+ "$ref": "LfA2aV1SendMessageRequest"
+ },
+ "response": {
+ "$ref": "LfA2aV1StreamResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ces",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
}
}
@@ -2732,6 +2746,35 @@
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
+ },
+ "stream": {
+ "description": "Sends a streaming message to an agent, allowing for real-time interaction and status updates. Streaming version of `SendMessage`",
+ "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/message:stream",
+ "httpMethod": "POST",
+ "id": "ces.projects.locations.apps.message.stream",
+ "parameterOrder": [
+ "tenant"
+ ],
+ "parameters": {
+ "tenant": {
+ "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/{+tenant}/message:stream",
+ "request": {
+ "$ref": "LfA2aV1SendMessageRequest"
+ },
+ "response": {
+ "$ref": "LfA2aV1StreamResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ces",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
}
},
@@ -3623,6 +3666,35 @@
"https://www.googleapis.com/auth/ces",
"https://www.googleapis.com/auth/cloud-platform"
]
+ },
+ "stream": {
+ "description": "Sends a streaming message to an agent, allowing for real-time interaction and status updates. Streaming version of `SendMessage`",
+ "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/apps/{appsId}/versions/{versionsId}/message:stream",
+ "httpMethod": "POST",
+ "id": "ces.projects.locations.apps.versions.message.stream",
+ "parameterOrder": [
+ "tenant"
+ ],
+ "parameters": {
+ "tenant": {
+ "description": "Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/apps/[^/]+/versions/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/{+tenant}/message:stream",
+ "request": {
+ "$ref": "LfA2aV1SendMessageRequest"
+ },
+ "response": {
+ "$ref": "LfA2aV1StreamResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/ces",
+ "https://www.googleapis.com/auth/cloud-platform"
+ ]
}
}
}
@@ -3767,7 +3839,7 @@
}
}
},
- "revision": "20260806",
+ "revision": "20260824",
"rootUrl": "https://ces.googleapis.com/",
"schemas": {
"Action": {
@@ -4506,6 +4578,10 @@
"readOnly": true,
"type": "string"
},
+ "dashboardSettings": {
+ "$ref": "DashboardSettings",
+ "description": "Optional. App-specific dashboard settings for linking and configuring Contact Center Insights dashboards."
+ },
"dataStoreSettings": {
"$ref": "DataStoreSettings",
"description": "Optional. The data store settings for the app."
@@ -5602,23 +5678,10 @@
},
"type": "array"
},
- "resolvedDeveloperInstruction": {
- "description": "Output only. The full dynamically resolved developer instruction generated from templates. This field is only populated on-demand when requested during history retrieval. It is not persisted.",
- "readOnly": true,
- "type": "string"
- },
"rootSpan": {
"$ref": "Span",
"description": "Optional. The root span of the action processing."
},
- "templateAttributes": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Optional. Variables or configurations referenced by the template engine during dynamic prompt generation. This allows reconstructing the exact prompt sent to the model for this turn.",
- "type": "object"
- },
"userIntendedText": {
"description": "Optional. The intended ground-truth text from the Simulated Caller (Polysynth). Only populated when word error rate metrics are enabled.",
"type": "string"
@@ -5626,6 +5689,17 @@
},
"type": "object"
},
+ "DashboardSettings": {
+ "description": "Settings for dashboards associated with the app, that show up in the Monitoring view.",
+ "id": "DashboardSettings",
+ "properties": {
+ "defaultDashboard": {
+ "description": "Optional. The resource name of the default Contact Center Insights dashboard associated with the app. This is the dashboard that will be displayed when users navigate to the Monitoring view for the app. Format: `projects/{project}/locations/{location}/dashboards/{dashboard}`",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"DataStore": {
"description": "A DataStore resource in Vertex AI Search.",
"id": "DataStore",
@@ -6030,6 +6104,11 @@
"enableSnippets": {
"description": "Optional. Whether snippets are enabled.",
"type": "boolean"
+ },
+ "maxSnippets": {
+ "description": "Optional. Number of snippets to return per query. If unset, returns all snippets from the service by default.",
+ "format": "int32",
+ "type": "integer"
}
},
"type": "object"
@@ -6059,6 +6138,17 @@
"properties": {},
"type": "object"
},
+ "DeployChannelResponse": {
+ "description": "Response message for AgentService.DeployChannel.",
+ "id": "DeployChannelResponse",
+ "properties": {
+ "deployment": {
+ "$ref": "Deployment",
+ "description": "The created deployment."
+ }
+ },
+ "type": "object"
+ },
"Deployment": {
"description": "A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.",
"id": "Deployment",
@@ -9555,14 +9645,18 @@
"HARM_CATEGORY_HATE_SPEECH",
"HARM_CATEGORY_DANGEROUS_CONTENT",
"HARM_CATEGORY_HARASSMENT",
- "HARM_CATEGORY_SEXUALLY_EXPLICIT"
+ "HARM_CATEGORY_SEXUALLY_EXPLICIT",
+ "HARM_CATEGORY_PROFANITY",
+ "HARM_CATEGORY_TOXIC"
],
"enumDescriptions": [
"The harm category is unspecified.",
"The harm category is hate speech.",
"The harm category is dangerous content.",
"The harm category is harassment.",
- "The harm category is sexually explicit content."
+ "The harm category is sexually explicit content.",
+ "The harm category is profanity.",
+ "The harm category is toxic."
],
"type": "string"
},
@@ -9633,6 +9727,14 @@
"importOptions": {
"$ref": "ImportAppRequestImportOptions",
"description": "Optional. Options governing the import process for the app."
+ },
+ "jsonPatchContent": {
+ "description": "Optional. Patch content as a JSON string.",
+ "type": "string"
+ },
+ "jsonPatchGcsUri": {
+ "description": "Optional. A Cloud Storage URI pointing to a JSON file containing the patches.",
+ "type": "string"
}
},
"type": "object"
@@ -10798,6 +10900,29 @@
},
"type": "object"
},
+ "LfA2aV1StreamResponse": {
+ "description": "A wrapper object used in streaming operations to encapsulate different types of response data.",
+ "id": "LfA2aV1StreamResponse",
+ "properties": {
+ "artifactUpdate": {
+ "$ref": "LfA2aV1TaskArtifactUpdateEvent",
+ "description": "An event indicating a task artifact update."
+ },
+ "message": {
+ "$ref": "LfA2aV1Message",
+ "description": "A Message object containing a message from the agent."
+ },
+ "statusUpdate": {
+ "$ref": "LfA2aV1TaskStatusUpdateEvent",
+ "description": "An event indicating a task status update."
+ },
+ "task": {
+ "$ref": "LfA2aV1Task",
+ "description": "A Task object containing the current state of the task."
+ }
+ },
+ "type": "object"
+ },
"LfA2aV1StringList": {
"description": "protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.",
"id": "LfA2aV1StringList",
@@ -10853,6 +10978,41 @@
},
"type": "object"
},
+ "LfA2aV1TaskArtifactUpdateEvent": {
+ "description": "A task delta where an artifact has been generated.",
+ "id": "LfA2aV1TaskArtifactUpdateEvent",
+ "properties": {
+ "append": {
+ "description": "If true, the content of this artifact should be appended to a previously sent artifact with the same ID.",
+ "type": "boolean"
+ },
+ "artifact": {
+ "$ref": "LfA2aV1Artifact",
+ "description": "Required. The artifact that was generated or updated."
+ },
+ "contextId": {
+ "description": "Required. The ID of the context that this task belongs to.",
+ "type": "string"
+ },
+ "lastChunk": {
+ "description": "If true, this is the final chunk of the artifact.",
+ "type": "boolean"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Optional. Metadata associated with the artifact update.",
+ "type": "object"
+ },
+ "taskId": {
+ "description": "Required. The ID of the task for this artifact.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"LfA2aV1TaskPushNotificationConfig": {
"description": "A container associating a push notification configuration with a specific task.",
"id": "LfA2aV1TaskPushNotificationConfig",
@@ -10926,6 +11086,33 @@
},
"type": "object"
},
+ "LfA2aV1TaskStatusUpdateEvent": {
+ "description": "An event sent by the agent to notify the client of a change in a task's status.",
+ "id": "LfA2aV1TaskStatusUpdateEvent",
+ "properties": {
+ "contextId": {
+ "description": "Required. The ID of the context that the task belongs to.",
+ "type": "string"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Optional. Metadata associated with the task update.",
+ "type": "object"
+ },
+ "status": {
+ "$ref": "LfA2aV1TaskStatus",
+ "description": "Required. The new status of the task."
+ },
+ "taskId": {
+ "description": "Required. The ID of the task that has changed.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"ListAgentsResponse": {
"description": "Response message for AgentService.ListAgents.",
"id": "ListAgentsResponse",
@@ -12006,6 +12193,10 @@
"$ref": "AgentCard",
"description": "Required. The agent card of the remote agent that this tool invokes."
},
+ "apiAuthentication": {
+ "$ref": "ApiAuthentication",
+ "description": "Optional. Authentication configuration for calling the remote agent."
+ },
"description": {
"description": "Required. The description of the tool.",
"type": "string"
@@ -12698,6 +12889,10 @@
"$ref": "GoogleSearchSuggestions",
"description": "The suggestions returned from Google Search as a result of invoking the GoogleSearchTool."
},
+ "image": {
+ "$ref": "Image",
+ "description": "Output image from the CES agent."
+ },
"payload": {
"additionalProperties": {
"description": "Properties of the object.",
@@ -13048,6 +13243,11 @@
"description": "Request for the client or the agent to execute the specified tool.",
"id": "ToolCall",
"properties": {
+ "agentName": {
+ "description": "Output only. Human-readable name of the agent that issued this call, e.g. \"Contract Architect\". Empty when the root agent issued it.",
+ "readOnly": true,
+ "type": "string"
+ },
"args": {
"additionalProperties": {
"description": "Properties of the object.",
@@ -13065,6 +13265,11 @@
"description": "Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.",
"type": "string"
},
+ "parentToolCallId": {
+ "description": "Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.",
+ "readOnly": true,
+ "type": "string"
+ },
"tool": {
"description": "Optional. The name of the tool to execute. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`",
"type": "string"
@@ -13109,6 +13314,11 @@
"description": "The execution result of a specific tool from the client or the agent.",
"id": "ToolResponse",
"properties": {
+ "agentName": {
+ "description": "Output only. Human-readable name of the agent that issued this call, e.g. \"Contract Architect\". Empty when the root agent issued it.",
+ "readOnly": true,
+ "type": "string"
+ },
"displayName": {
"description": "Output only. Display name of the tool.",
"readOnly": true,
@@ -13118,6 +13328,11 @@
"description": "Optional. The matching ID of the tool call the response is for.",
"type": "string"
},
+ "parentToolCallId": {
+ "description": "Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.",
+ "readOnly": true,
+ "type": "string"
+ },
"response": {
"additionalProperties": {
"description": "Properties of the object.",
diff --git a/discovery/classroom-v1.json b/discovery/classroom-v1.json
index 311f478d6f5..01da8a0ad76 100644
--- a/discovery/classroom-v1.json
+++ b/discovery/classroom-v1.json
@@ -1274,7 +1274,7 @@
]
},
"patch": {
- "description": "Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course or course work does not exist.",
+ "description": "Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item or an add-on attachment on the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work or an add-on attachment on the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `FAILED_PRECONDITION` if the requested course work has already been deleted. * `NOT_FOUND` if the requested course or course work does not exist.",
"flatPath": "v1/courses/{courseId}/courseWork/{id}",
"httpMethod": "PATCH",
"id": "classroom.courses.courseWork.patch",
@@ -2067,7 +2067,7 @@
]
},
"modifyAttachments": {
- "description": "Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
+ "description": "Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item or an add-on attachment on the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
"flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments",
"httpMethod": "POST",
"id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments",
@@ -2109,7 +2109,7 @@
]
},
"patch": {
- "description": "Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
+ "description": "Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item or an add-on attachment with Grade Sync enabled on the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work or an add-on attachment on the corresponding course work with Grade Sync enabled, if the user is not permitted to make the requested modification to the student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
"flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}",
"httpMethod": "PATCH",
"id": "classroom.courses.courseWork.studentSubmissions.patch",
@@ -2157,7 +2157,7 @@
]
},
"reclaim": {
- "description": "Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
+ "description": "Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item or an add-on attachment on the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. * `FAILED_PRECONDITION` if the student submission has not been turned in. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
"flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim",
"httpMethod": "POST",
"id": "classroom.courses.courseWork.studentSubmissions.reclaim",
@@ -2198,7 +2198,7 @@
]
},
"return": {
- "description": "Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
+ "description": "Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item or an add-on attachment on the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
"flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return",
"httpMethod": "POST",
"id": "classroom.courses.courseWork.studentSubmissions.return",
@@ -2239,7 +2239,7 @@
]
},
"turnIn": {
- "description": "Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
+ "description": "Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item or an add-on attachment on the corresponding course work item. This method returns the following error codes: * `PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. * `INVALID_ARGUMENT` if the request is malformed. * `NOT_FOUND` if the requested course, course work, or student submission does not exist.",
"flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn",
"httpMethod": "POST",
"id": "classroom.courses.courseWork.studentSubmissions.turnIn",
@@ -4376,7 +4376,7 @@
}
}
},
- "revision": "20260816",
+ "revision": "20260825",
"rootUrl": "https://classroom.googleapis.com/",
"schemas": {
"AddOnAttachment": {
diff --git a/discovery/cloudkms-v1.json b/discovery/cloudkms-v1.json
index a909dad43ac..7bfb3f32f4b 100644
--- a/discovery/cloudkms-v1.json
+++ b/discovery/cloudkms-v1.json
@@ -1307,6 +1307,32 @@
"https://www.googleapis.com/auth/cloudkms"
]
},
+ "delete": {
+ "description": "Permanently deletes the given KeyRing. All child resources of the KeyRing must have been previously deleted using their corresponding Delete operations. The specified key ring will be immediately and permanently deleted upon calling this method. This action cannot be undone. Note: the key ring and its metadata will be remembered by KeyManagementService to prevent re-use of the key ring's resource name.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}",
+ "httpMethod": "DELETE",
+ "id": "cloudkms.projects.locations.keyRings.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the KeyRing to delete.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/cloudkms"
+ ]
+ },
"get": {
"description": "Returns metadata for a given KeyRing.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}",
@@ -3063,7 +3089,7 @@
}
}
},
- "revision": "20260814",
+ "revision": "20260821",
"rootUrl": "https://cloudkms.googleapis.com/",
"schemas": {
"AddQuorumMember": {
@@ -3822,7 +3848,7 @@
"type": "string"
},
"trustedWrappingEnabled": {
- "description": "Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion.",
+ "description": "Optional. Immutable. Field indicating that the key may be wrapped by a trusted key. This field can be set for all key purposes except ENCRYPT_DECRYPT, and is only valid for keys with protection level HSM_SINGLE_TENANT. This field can only be set at creation or import time via CreateCryptoKeyVersion, or ImportCryptoKeyVersion.",
"type": "boolean"
}
},
diff --git a/discovery/compute-beta.json b/discovery/compute-beta.json
index 9a7c9013661..8c5a5da362d 100644
--- a/discovery/compute-beta.json
+++ b/discovery/compute-beta.json
@@ -3017,6 +3017,307 @@
}
}
},
+ "dhcpOptionsConfigs": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the specified DhcpOptionsConfig in the given location",
+ "flatPath": "projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}",
+ "httpMethod": "DELETE",
+ "id": "compute.dhcpOptionsConfigs.delete",
+ "parameterOrder": [
+ "project",
+ "region",
+ "dhcpOptionsConfig"
+ ],
+ "parameters": {
+ "dhcpOptionsConfig": {
+ "description": "Name of the DhcpOptionsConfig resource to delete.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "description": "Name of the region of this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
+ "get": {
+ "description": "Returns the specified DhcpOptionsConfig resource in the given location.",
+ "flatPath": "projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}",
+ "httpMethod": "GET",
+ "id": "compute.dhcpOptionsConfigs.get",
+ "parameterOrder": [
+ "project",
+ "region",
+ "dhcpOptionsConfig"
+ ],
+ "parameters": {
+ "dhcpOptionsConfig": {
+ "description": "Name of the DhcpOptionsConfig resource to return.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "description": "Name of the region of this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}",
+ "response": {
+ "$ref": "DhcpOptionsConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
+ "insert": {
+ "description": "Creates a DhcpOptionsConfig in the specified project in the given location\nusing the parameters that are included in the request.",
+ "flatPath": "projects/{project}/regions/{region}/dhcpOptionsConfigs",
+ "httpMethod": "POST",
+ "id": "compute.dhcpOptionsConfigs.insert",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "description": "Name of the region of this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/regions/{region}/dhcpOptionsConfigs",
+ "request": {
+ "$ref": "DhcpOptionsConfig"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
+ "list": {
+ "description": "Lists the DhcpOptionsConfigs for a project in the given location.",
+ "flatPath": "projects/{project}/regions/{region}/dhcpOptionsConfigs",
+ "httpMethod": "GET",
+ "id": "compute.dhcpOptionsConfigs.list",
+ "parameterOrder": [
+ "project",
+ "region"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32",
+ "location": "query",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "description": "Name of the region of this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "projects/{project}/regions/{region}/dhcpOptionsConfigs",
+ "response": {
+ "$ref": "DhcpOptionsConfigList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Patches the specified DhcpOptionsConfig resource with the data included in\nthe request. This method supports PATCH\nsemantics and usesJSON merge\npatch format and processing rules.",
+ "flatPath": "projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}",
+ "httpMethod": "PATCH",
+ "id": "compute.dhcpOptionsConfigs.patch",
+ "parameterOrder": [
+ "project",
+ "region",
+ "dhcpOptionsConfig"
+ ],
+ "parameters": {
+ "dhcpOptionsConfig": {
+ "description": "Name of the DhcpOptionsConfig resource to patch.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "description": "Name of the region for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).\nend_interface: MixerMutationRequestBuilder",
+ "location": "query",
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "update_mask indicates fields to be updated as part of this request.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/regions/{region}/dhcpOptionsConfigs/{dhcpOptionsConfig}",
+ "request": {
+ "$ref": "DhcpOptionsConfig"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "flatPath": "projects/{project}/regions/{region}/dhcpOptionsConfigs/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "id": "compute.dhcpOptionsConfigs.testIamPermissions",
+ "parameterOrder": [
+ "project",
+ "region",
+ "resource"
+ ],
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "region": {
+ "description": "The name of the region for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string"
+ },
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/regions/{region}/dhcpOptionsConfigs/{resource}/testIamPermissions",
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ }
+ }
+ },
"diskSettings": {
"methods": {
"get": {
@@ -7029,6 +7330,72 @@
}
}
},
+ "globalFrontendSettings": {
+ "methods": {
+ "get": {
+ "description": "Gets the Global Frontend Billing Bundle Settings for a project.",
+ "flatPath": "projects/{project}/global/globalFrontendSettings",
+ "httpMethod": "GET",
+ "id": "compute.globalFrontendSettings.get",
+ "parameterOrder": [
+ "project"
+ ],
+ "parameters": {
+ "project": {
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/global/globalFrontendSettings",
+ "response": {
+ "$ref": "GlobalFrontendSettings"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Updates the Global Frontend Billing Bundle Settings for a project.",
+ "flatPath": "projects/{project}/global/globalFrontendSettings",
+ "httpMethod": "PATCH",
+ "id": "compute.globalFrontendSettings.patch",
+ "parameterOrder": [
+ "project"
+ ],
+ "parameters": {
+ "project": {
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "location": "query",
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "e.g., \"type\"",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/global/globalFrontendSettings",
+ "request": {
+ "$ref": "GlobalFrontendSettings"
+ },
+ "response": {
+ "$ref": "GlobalFrontendSettingsPatchResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ }
+ }
+ },
"globalNetworkEndpointGroups": {
"methods": {
"attachNetworkEndpoints": {
@@ -13591,6 +13958,57 @@
"https://www.googleapis.com/auth/compute.readonly"
]
},
+ "getVmExtensionState": {
+ "description": "Retrieves details of a specific VM extension state.\nThis is a read-only API.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/vmExtensionStates/{extensionName}",
+ "httpMethod": "GET",
+ "id": "compute.instances.getVmExtensionState",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance",
+ "extensionName"
+ ],
+ "parameters": {
+ "extensionName": {
+ "description": "The name of the extension to get the state for.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ },
+ "instance": {
+ "description": "Name or id of the instance resource.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "description": "Name of the zone for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/vmExtensionStates/{extensionName}",
+ "response": {
+ "$ref": "VmExtensionState"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
"insert": {
"description": "Creates an instance resource in the specified project using the data\nincluded in the request.",
"flatPath": "projects/{project}/zones/{zone}/instances",
@@ -13792,169 +14210,45 @@
"https://www.googleapis.com/auth/compute.readonly"
]
},
- "patchPartnerMetadata": {
- "description": "Patches partner metadata of the specified instance.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/patchPartnerMetadata",
- "httpMethod": "POST",
- "id": "compute.instances.patchPartnerMetadata",
+ "listVmExtensionStates": {
+ "description": "Lists all VM extensions states for a specific instance.\nThis is a read-only API.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/vmExtensionStates",
+ "httpMethod": "GET",
+ "id": "compute.instances.listVmExtensionStates",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
- "instance": {
- "description": "Name of the instance scoping this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string"
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string"
- },
- "requestId": {
- "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
"location": "query",
"type": "string"
},
- "zone": {
- "description": "The name of the zone for this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "type": "string"
- }
- },
- "path": "projects/{project}/zones/{zone}/instances/{instance}/patchPartnerMetadata",
- "request": {
- "$ref": "PartnerMetadata"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "performMaintenance": {
- "description": "Perform a manual maintenance on the instance.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/performMaintenance",
- "httpMethod": "POST",
- "id": "compute.instances.performMaintenance",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "parameters": {
"instance": {
- "description": "Name of the instance scoping this request.",
+ "description": "Name of the target instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string"
- },
- "requestId": {
- "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+ "maxResults": {
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32",
"location": "query",
- "type": "string"
- },
- "zone": {
- "description": "The name of the zone for this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "type": "string"
- }
- },
- "path": "projects/{project}/zones/{zone}/instances/{instance}/performMaintenance",
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "removeResourcePolicies": {
- "description": "Removes resource policies from an instance.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies",
- "httpMethod": "POST",
- "id": "compute.instances.removeResourcePolicies",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "parameters": {
- "instance": {
- "description": "The instance name for this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string"
- },
- "project": {
- "description": "Project ID for this request.",
- "location": "path",
- "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
- "required": true,
- "type": "string"
+ "minimum": "0",
+ "type": "integer"
},
- "requestId": {
- "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
"location": "query",
"type": "string"
},
- "zone": {
- "description": "The name of the zone for this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "required": true,
- "type": "string"
- }
- },
- "path": "projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies",
- "request": {
- "$ref": "InstancesRemoveResourcePoliciesRequest"
- },
- "response": {
- "$ref": "Operation"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "reportHostAsFaulty": {
- "description": "Mark the host as faulty and try to restart the instance on a new host.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty",
- "httpMethod": "POST",
- "id": "compute.instances.reportHostAsFaulty",
- "parameterOrder": [
- "project",
- "zone",
- "instance"
- ],
- "parameters": {
- "instance": {
- "description": "Name of the instance scoping this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.",
+ "location": "query",
"type": "string"
},
"project": {
@@ -13964,36 +14258,34 @@
"required": true,
"type": "string"
},
- "requestId": {
- "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
"location": "query",
- "type": "string"
+ "type": "boolean"
},
"zone": {
- "description": "The name of the zone for this request.",
+ "description": "Required. Name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty",
- "request": {
- "$ref": "InstancesReportHostAsFaultyRequest"
- },
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/vmExtensionStates",
"response": {
- "$ref": "Operation"
+ "$ref": "ListVmExtensionStatesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
]
},
- "reset": {
- "description": "Performs a reset on the instance. This is a hard reset. The VM\ndoes not do a graceful shutdown. For more information, seeResetting\nan instance.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/reset",
+ "patchPartnerMetadata": {
+ "description": "Patches partner metadata of the specified instance.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/patchPartnerMetadata",
"httpMethod": "POST",
- "id": "compute.instances.reset",
+ "id": "compute.instances.patchPartnerMetadata",
"parameterOrder": [
"project",
"zone",
@@ -14027,7 +14319,10 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/reset",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/patchPartnerMetadata",
+ "request": {
+ "$ref": "PartnerMetadata"
+ },
"response": {
"$ref": "Operation"
},
@@ -14036,11 +14331,11 @@
"https://www.googleapis.com/auth/compute"
]
},
- "resume": {
- "description": "Resumes an instance that was suspended using theinstances().suspend\nmethod.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/resume",
+ "performMaintenance": {
+ "description": "Perform a manual maintenance on the instance.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/performMaintenance",
"httpMethod": "POST",
- "id": "compute.instances.resume",
+ "id": "compute.instances.performMaintenance",
"parameterOrder": [
"project",
"zone",
@@ -14048,7 +14343,7 @@
],
"parameters": {
"instance": {
- "description": "Name of the instance resource to resume.",
+ "description": "Name of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
@@ -14074,10 +14369,7 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/resume",
- "request": {
- "$ref": "InstancesResumeRequest"
- },
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/performMaintenance",
"response": {
"$ref": "Operation"
},
@@ -14086,11 +14378,11 @@
"https://www.googleapis.com/auth/compute"
]
},
- "sendDiagnosticInterrupt": {
- "description": "Sends diagnostic interrupt to the instance.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt",
+ "removeResourcePolicies": {
+ "description": "Removes resource policies from an instance.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies",
"httpMethod": "POST",
- "id": "compute.instances.sendDiagnosticInterrupt",
+ "id": "compute.instances.removeResourcePolicies",
"parameterOrder": [
"project",
"zone",
@@ -14098,7 +14390,7 @@
],
"parameters": {
"instance": {
- "description": "Name of the instance scoping this request.",
+ "description": "The instance name for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
@@ -14111,6 +14403,11 @@
"required": true,
"type": "string"
},
+ "requestId": {
+ "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+ "location": "query",
+ "type": "string"
+ },
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
@@ -14119,28 +14416,35 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/removeResourcePolicies",
+ "request": {
+ "$ref": "InstancesRemoveResourcePoliciesRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
- "setDeletionProtection": {
- "description": "Sets deletion protection on the instance.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection",
+ "reportHostAsFaulty": {
+ "description": "Mark the host as faulty and try to restart the instance on a new host.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty",
"httpMethod": "POST",
- "id": "compute.instances.setDeletionProtection",
+ "id": "compute.instances.reportHostAsFaulty",
"parameterOrder": [
"project",
"zone",
- "resource"
+ "instance"
],
"parameters": {
- "deletionProtection": {
- "default": "true",
- "description": "Whether the resource should be protected against deletion.",
- "location": "query",
- "type": "boolean"
+ "instance": {
+ "description": "Name of the instance scoping this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
},
"project": {
"description": "Project ID for this request.",
@@ -14154,13 +14458,6 @@
"location": "query",
"type": "string"
},
- "resource": {
- "description": "Name or id of the resource for this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string"
- },
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
@@ -14169,7 +14466,10 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/reportHostAsFaulty",
+ "request": {
+ "$ref": "InstancesReportHostAsFaultyRequest"
+ },
"response": {
"$ref": "Operation"
},
@@ -14178,34 +14478,19 @@
"https://www.googleapis.com/auth/compute"
]
},
- "setDiskAutoDelete": {
- "description": "Sets the auto-delete flag for a disk attached to an instance.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete",
+ "reset": {
+ "description": "Performs a reset on the instance. This is a hard reset. The VM\ndoes not do a graceful shutdown. For more information, seeResetting\nan instance.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/reset",
"httpMethod": "POST",
- "id": "compute.instances.setDiskAutoDelete",
+ "id": "compute.instances.reset",
"parameterOrder": [
"project",
"zone",
- "instance",
- "autoDelete",
- "deviceName"
+ "instance"
],
"parameters": {
- "autoDelete": {
- "description": "Whether to auto-delete the disk when the instance is deleted.",
- "location": "query",
- "required": true,
- "type": "boolean"
- },
- "deviceName": {
- "description": "The device name of the disk to modify. Make a get() request\non the instance to view currently attached disks and device names.",
- "location": "query",
- "pattern": "\\w[\\w.-]{0,254}",
- "required": true,
- "type": "string"
- },
"instance": {
- "description": "The instance name for this request.",
+ "description": "Name of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
@@ -14231,7 +14516,7 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/reset",
"response": {
"$ref": "Operation"
},
@@ -14240,17 +14525,24 @@
"https://www.googleapis.com/auth/compute"
]
},
- "setIamPolicy": {
- "description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy",
+ "resume": {
+ "description": "Resumes an instance that was suspended using theinstances().suspend\nmethod.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/resume",
"httpMethod": "POST",
- "id": "compute.instances.setIamPolicy",
+ "id": "compute.instances.resume",
"parameterOrder": [
"project",
"zone",
- "resource"
+ "instance"
],
"parameters": {
+ "instance": {
+ "description": "Name of the instance resource to resume.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ },
"project": {
"description": "Project ID for this request.",
"location": "path",
@@ -14258,11 +14550,9 @@
"required": true,
"type": "string"
},
- "resource": {
- "description": "Name or id of the resource for this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
+ "requestId": {
+ "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+ "location": "query",
"type": "string"
},
"zone": {
@@ -14273,23 +14563,23 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/resume",
"request": {
- "$ref": "ZoneSetPolicyRequest"
+ "$ref": "InstancesResumeRequest"
},
"response": {
- "$ref": "Policy"
+ "$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
- "setLabels": {
- "description": "Sets labels on an instance. To learn more about labels, read theLabeling\nResources documentation.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setLabels",
+ "sendDiagnosticInterrupt": {
+ "description": "Sends diagnostic interrupt to the instance.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt",
"httpMethod": "POST",
- "id": "compute.instances.setLabels",
+ "id": "compute.instances.sendDiagnosticInterrupt",
"parameterOrder": [
"project",
"zone",
@@ -14310,11 +14600,6 @@
"required": true,
"type": "string"
},
- "requestId": {
- "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
- "location": "query",
- "type": "string"
- },
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
@@ -14323,35 +14608,28 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setLabels",
- "request": {
- "$ref": "InstancesSetLabelsRequest"
- },
- "response": {
- "$ref": "Operation"
- },
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/sendDiagnosticInterrupt",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
- "setMachineResources": {
- "description": "Changes the number and/or type of accelerator for a stopped instance to the\nvalues specified in the request.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMachineResources",
+ "setDeletionProtection": {
+ "description": "Sets deletion protection on the instance.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection",
"httpMethod": "POST",
- "id": "compute.instances.setMachineResources",
+ "id": "compute.instances.setDeletionProtection",
"parameterOrder": [
"project",
"zone",
- "instance"
+ "resource"
],
"parameters": {
- "instance": {
- "description": "Name of the instance scoping this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string"
+ "deletionProtection": {
+ "default": "true",
+ "description": "Whether the resource should be protected against deletion.",
+ "location": "query",
+ "type": "boolean"
},
"project": {
"description": "Project ID for this request.",
@@ -14365,6 +14643,13 @@
"location": "query",
"type": "string"
},
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ },
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
@@ -14373,10 +14658,7 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setMachineResources",
- "request": {
- "$ref": "InstancesSetMachineResourcesRequest"
- },
+ "path": "projects/{project}/zones/{zone}/instances/{resource}/setDeletionProtection",
"response": {
"$ref": "Operation"
},
@@ -14385,19 +14667,34 @@
"https://www.googleapis.com/auth/compute"
]
},
- "setMachineType": {
- "description": "Changes the machine type for a stopped instance to the machine\ntype specified in the request.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMachineType",
+ "setDiskAutoDelete": {
+ "description": "Sets the auto-delete flag for a disk attached to an instance.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete",
"httpMethod": "POST",
- "id": "compute.instances.setMachineType",
+ "id": "compute.instances.setDiskAutoDelete",
"parameterOrder": [
"project",
"zone",
- "instance"
+ "instance",
+ "autoDelete",
+ "deviceName"
],
"parameters": {
+ "autoDelete": {
+ "description": "Whether to auto-delete the disk when the instance is deleted.",
+ "location": "query",
+ "required": true,
+ "type": "boolean"
+ },
+ "deviceName": {
+ "description": "The device name of the disk to modify. Make a get() request\non the instance to view currently attached disks and device names.",
+ "location": "query",
+ "pattern": "\\w[\\w.-]{0,254}",
+ "required": true,
+ "type": "string"
+ },
"instance": {
- "description": "Name of the instance scoping this request.",
+ "description": "The instance name for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
@@ -14423,10 +14720,7 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setMachineType",
- "request": {
- "$ref": "InstancesSetMachineTypeRequest"
- },
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setDiskAutoDelete",
"response": {
"$ref": "Operation"
},
@@ -14435,24 +14729,17 @@
"https://www.googleapis.com/auth/compute"
]
},
- "setMetadata": {
- "description": "Sets metadata for the specified instance to the data included\nin the request.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMetadata",
+ "setIamPolicy": {
+ "description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy",
"httpMethod": "POST",
- "id": "compute.instances.setMetadata",
+ "id": "compute.instances.setIamPolicy",
"parameterOrder": [
"project",
"zone",
- "instance"
+ "resource"
],
"parameters": {
- "instance": {
- "description": "Name of the instance scoping this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
- "type": "string"
- },
"project": {
"description": "Project ID for this request.",
"location": "path",
@@ -14460,9 +14747,11 @@
"required": true,
"type": "string"
},
- "requestId": {
- "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
- "location": "query",
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
"type": "string"
},
"zone": {
@@ -14473,23 +14762,23 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setMetadata",
+ "path": "projects/{project}/zones/{zone}/instances/{resource}/setIamPolicy",
"request": {
- "$ref": "Metadata"
+ "$ref": "ZoneSetPolicyRequest"
},
"response": {
- "$ref": "Operation"
+ "$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/compute"
]
},
- "setMinCpuPlatform": {
- "description": "Changes the minimum CPU platform that this instance should use.\nThis method can only\nbe called on a stopped instance. For more information, readSpecifying a\nMinimum CPU Platform.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform",
+ "setLabels": {
+ "description": "Sets labels on an instance. To learn more about labels, read theLabeling\nResources documentation.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setLabels",
"httpMethod": "POST",
- "id": "compute.instances.setMinCpuPlatform",
+ "id": "compute.instances.setLabels",
"parameterOrder": [
"project",
"zone",
@@ -14523,9 +14812,9 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setLabels",
"request": {
- "$ref": "InstancesSetMinCpuPlatformRequest"
+ "$ref": "InstancesSetLabelsRequest"
},
"response": {
"$ref": "Operation"
@@ -14535,11 +14824,11 @@
"https://www.googleapis.com/auth/compute"
]
},
- "setName": {
- "description": "Sets name of an instance.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setName",
+ "setMachineResources": {
+ "description": "Changes the number and/or type of accelerator for a stopped instance to the\nvalues specified in the request.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMachineResources",
"httpMethod": "POST",
- "id": "compute.instances.setName",
+ "id": "compute.instances.setMachineResources",
"parameterOrder": [
"project",
"zone",
@@ -14547,7 +14836,7 @@
],
"parameters": {
"instance": {
- "description": "The instance name for this request.",
+ "description": "Name of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
@@ -14573,9 +14862,9 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setName",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setMachineResources",
"request": {
- "$ref": "InstancesSetNameRequest"
+ "$ref": "InstancesSetMachineResourcesRequest"
},
"response": {
"$ref": "Operation"
@@ -14585,11 +14874,11 @@
"https://www.googleapis.com/auth/compute"
]
},
- "setScheduling": {
- "description": "Sets an instance's scheduling options. You can only call this method on astopped instance,\nthat is, a VM instance that is in a `TERMINATED` state. SeeInstance Life\nCycle for more information on the possible instance states.\nFor more information about setting scheduling options for a VM, seeSet\nVM host maintenance policy.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setScheduling",
+ "setMachineType": {
+ "description": "Changes the machine type for a stopped instance to the machine\ntype specified in the request.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMachineType",
"httpMethod": "POST",
- "id": "compute.instances.setScheduling",
+ "id": "compute.instances.setMachineType",
"parameterOrder": [
"project",
"zone",
@@ -14597,7 +14886,7 @@
],
"parameters": {
"instance": {
- "description": "Instance name for this request.",
+ "description": "Name of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
@@ -14623,9 +14912,9 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setScheduling",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setMachineType",
"request": {
- "$ref": "Scheduling"
+ "$ref": "InstancesSetMachineTypeRequest"
},
"response": {
"$ref": "Operation"
@@ -14635,11 +14924,11 @@
"https://www.googleapis.com/auth/compute"
]
},
- "setSecurityPolicy": {
- "description": "Sets the Google Cloud Armor security policy for the specified instance.\nFor more information, seeGoogle\nCloud Armor Overview",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setSecurityPolicy",
+ "setMetadata": {
+ "description": "Sets metadata for the specified instance to the data included\nin the request.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMetadata",
"httpMethod": "POST",
- "id": "compute.instances.setSecurityPolicy",
+ "id": "compute.instances.setMetadata",
"parameterOrder": [
"project",
"zone",
@@ -14647,8 +14936,9 @@
],
"parameters": {
"instance": {
- "description": "Name of the Instance resource to which the security policy should be\nset. The name should conform to RFC1035.",
+ "description": "Name of the instance scoping this request.",
"location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
@@ -14665,16 +14955,16 @@
"type": "string"
},
"zone": {
- "description": "Name of the zone scoping this request.",
+ "description": "The name of the zone for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setSecurityPolicy",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setMetadata",
"request": {
- "$ref": "InstancesSetSecurityPolicyRequest"
+ "$ref": "Metadata"
},
"response": {
"$ref": "Operation"
@@ -14684,11 +14974,11 @@
"https://www.googleapis.com/auth/compute"
]
},
- "setServiceAccount": {
- "description": "Sets the service account on the instance. For more information,\nreadChanging\nthe service account and access scopes for an instance.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount",
+ "setMinCpuPlatform": {
+ "description": "Changes the minimum CPU platform that this instance should use.\nThis method can only\nbe called on a stopped instance. For more information, readSpecifying a\nMinimum CPU Platform.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform",
"httpMethod": "POST",
- "id": "compute.instances.setServiceAccount",
+ "id": "compute.instances.setMinCpuPlatform",
"parameterOrder": [
"project",
"zone",
@@ -14696,7 +14986,7 @@
],
"parameters": {
"instance": {
- "description": "Name of the instance resource to start.",
+ "description": "Name of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
@@ -14722,9 +15012,9 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setMinCpuPlatform",
"request": {
- "$ref": "InstancesSetServiceAccountRequest"
+ "$ref": "InstancesSetMinCpuPlatformRequest"
},
"response": {
"$ref": "Operation"
@@ -14734,11 +15024,11 @@
"https://www.googleapis.com/auth/compute"
]
},
- "setShieldedInstanceIntegrityPolicy": {
- "description": "Sets the Shielded Instance integrity policy for an instance. You can\nonly use this method on a running instance. This method\nsupports PATCH semantics and uses the JSON merge\npatch format and processing rules.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy",
- "httpMethod": "PATCH",
- "id": "compute.instances.setShieldedInstanceIntegrityPolicy",
+ "setName": {
+ "description": "Sets name of an instance.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setName",
+ "httpMethod": "POST",
+ "id": "compute.instances.setName",
"parameterOrder": [
"project",
"zone",
@@ -14746,7 +15036,7 @@
],
"parameters": {
"instance": {
- "description": "Name or id of the instance scoping this request.",
+ "description": "The instance name for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
@@ -14772,9 +15062,9 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setName",
"request": {
- "$ref": "ShieldedInstanceIntegrityPolicy"
+ "$ref": "InstancesSetNameRequest"
},
"response": {
"$ref": "Operation"
@@ -14784,11 +15074,11 @@
"https://www.googleapis.com/auth/compute"
]
},
- "setShieldedVmIntegrityPolicy": {
- "description": "Sets the Shielded VM integrity policy for a VM instance. You can\nonly use this method on a running VM instance. This method\nsupports PATCH semantics and uses the JSON merge\npatch format and processing rules.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setShieldedVmIntegrityPolicy",
- "httpMethod": "PATCH",
- "id": "compute.instances.setShieldedVmIntegrityPolicy",
+ "setScheduling": {
+ "description": "Sets an instance's scheduling options. You can only call this method on astopped instance,\nthat is, a VM instance that is in a `TERMINATED` state. SeeInstance Life\nCycle for more information on the possible instance states.\nFor more information about setting scheduling options for a VM, seeSet\nVM host maintenance policy.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setScheduling",
+ "httpMethod": "POST",
+ "id": "compute.instances.setScheduling",
"parameterOrder": [
"project",
"zone",
@@ -14796,7 +15086,7 @@
],
"parameters": {
"instance": {
- "description": "Name of the instance scoping this request.",
+ "description": "Instance name for this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
@@ -14822,9 +15112,9 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setShieldedVmIntegrityPolicy",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setScheduling",
"request": {
- "$ref": "ShieldedVmIntegrityPolicy"
+ "$ref": "Scheduling"
},
"response": {
"$ref": "Operation"
@@ -14834,11 +15124,11 @@
"https://www.googleapis.com/auth/compute"
]
},
- "setTags": {
- "description": "Sets network tags\nfor the specified instance to the data included in the request.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setTags",
+ "setSecurityPolicy": {
+ "description": "Sets the Google Cloud Armor security policy for the specified instance.\nFor more information, seeGoogle\nCloud Armor Overview",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setSecurityPolicy",
"httpMethod": "POST",
- "id": "compute.instances.setTags",
+ "id": "compute.instances.setSecurityPolicy",
"parameterOrder": [
"project",
"zone",
@@ -14846,9 +15136,8 @@
],
"parameters": {
"instance": {
- "description": "Name of the instance scoping this request.",
+ "description": "Name of the Instance resource to which the security policy should be\nset. The name should conform to RFC1035.",
"location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
@@ -14865,16 +15154,16 @@
"type": "string"
},
"zone": {
- "description": "The name of the zone for this request.",
+ "description": "Name of the zone scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
"required": true,
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/setTags",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setSecurityPolicy",
"request": {
- "$ref": "Tags"
+ "$ref": "InstancesSetSecurityPolicyRequest"
},
"response": {
"$ref": "Operation"
@@ -14884,11 +15173,11 @@
"https://www.googleapis.com/auth/compute"
]
},
- "simulateMaintenanceEvent": {
- "description": "Simulates a host maintenance event on a VM. For more information, see\nSimulate a host maintenance event.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent",
+ "setServiceAccount": {
+ "description": "Sets the service account on the instance. For more information,\nreadChanging\nthe service account and access scopes for an instance.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount",
"httpMethod": "POST",
- "id": "compute.instances.simulateMaintenanceEvent",
+ "id": "compute.instances.setServiceAccount",
"parameterOrder": [
"project",
"zone",
@@ -14896,7 +15185,7 @@
],
"parameters": {
"instance": {
- "description": "Name of the instance scoping this request.",
+ "description": "Name of the instance resource to start.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
@@ -14914,11 +15203,6 @@
"location": "query",
"type": "string"
},
- "withExtendedNotifications": {
- "description": "Determines whether the customers receive notifications before migration.\nOnly applicable to SF vms.",
- "location": "query",
- "type": "boolean"
- },
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
@@ -14927,7 +15211,10 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setServiceAccount",
+ "request": {
+ "$ref": "InstancesSetServiceAccountRequest"
+ },
"response": {
"$ref": "Operation"
},
@@ -14936,11 +15223,11 @@
"https://www.googleapis.com/auth/compute"
]
},
- "start": {
- "description": "Starts an instance that was stopped using theinstances().stop\nmethod. For more information, seeRestart an\ninstance.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/start",
- "httpMethod": "POST",
- "id": "compute.instances.start",
+ "setShieldedInstanceIntegrityPolicy": {
+ "description": "Sets the Shielded Instance integrity policy for an instance. You can\nonly use this method on a running instance. This method\nsupports PATCH semantics and uses the JSON merge\npatch format and processing rules.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy",
+ "httpMethod": "PATCH",
+ "id": "compute.instances.setShieldedInstanceIntegrityPolicy",
"parameterOrder": [
"project",
"zone",
@@ -14948,7 +15235,7 @@
],
"parameters": {
"instance": {
- "description": "Name of the instance resource to start.",
+ "description": "Name or id of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
@@ -14974,7 +15261,10 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/start",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setShieldedInstanceIntegrityPolicy",
+ "request": {
+ "$ref": "ShieldedInstanceIntegrityPolicy"
+ },
"response": {
"$ref": "Operation"
},
@@ -14983,11 +15273,11 @@
"https://www.googleapis.com/auth/compute"
]
},
- "startWithEncryptionKey": {
- "description": "Starts an instance that was stopped using theinstances().stop\nmethod. For more information, seeRestart an\ninstance.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey",
- "httpMethod": "POST",
- "id": "compute.instances.startWithEncryptionKey",
+ "setShieldedVmIntegrityPolicy": {
+ "description": "Sets the Shielded VM integrity policy for a VM instance. You can\nonly use this method on a running VM instance. This method\nsupports PATCH semantics and uses the JSON merge\npatch format and processing rules.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setShieldedVmIntegrityPolicy",
+ "httpMethod": "PATCH",
+ "id": "compute.instances.setShieldedVmIntegrityPolicy",
"parameterOrder": [
"project",
"zone",
@@ -14995,7 +15285,7 @@
],
"parameters": {
"instance": {
- "description": "Name of the instance resource to start.",
+ "description": "Name of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
@@ -15021,9 +15311,9 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setShieldedVmIntegrityPolicy",
"request": {
- "$ref": "InstancesStartWithEncryptionKeyRequest"
+ "$ref": "ShieldedVmIntegrityPolicy"
},
"response": {
"$ref": "Operation"
@@ -15033,34 +15323,24 @@
"https://www.googleapis.com/auth/compute"
]
},
- "stop": {
- "description": "Stops a running instance, shutting it down cleanly, and allows\nyou to restart the instance at a later time. Stopped instances do not incur\nVM usage charges while they are stopped. However, resources that the VM is\nusing, such as persistent disks and static IP addresses, will continue to\nbe charged until they are deleted. For more information, seeStopping\nan instance.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/stop",
+ "setTags": {
+ "description": "Sets network tags\nfor the specified instance to the data included in the request.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/setTags",
"httpMethod": "POST",
- "id": "compute.instances.stop",
+ "id": "compute.instances.setTags",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
- "discardLocalSsd": {
- "description": "This property is required if the instance has any attached Local SSD disks.\nIf false, Local SSD data will be preserved when the instance is suspended.\nIf true, the contents of any attached Local SSD disks will be discarded.",
- "location": "query",
- "type": "boolean"
- },
"instance": {
- "description": "Name of the instance resource to stop.",
+ "description": "Name of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
- "noGracefulShutdown": {
- "description": "If set to true, Graceful Shutdown is skipped.",
- "location": "query",
- "type": "boolean"
- },
"project": {
"description": "Project ID for this request.",
"location": "path",
@@ -15081,7 +15361,10 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/stop",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/setTags",
+ "request": {
+ "$ref": "Tags"
+ },
"response": {
"$ref": "Operation"
},
@@ -15090,24 +15373,19 @@
"https://www.googleapis.com/auth/compute"
]
},
- "suspend": {
- "description": "This method suspends a running instance, saving its state to persistent\nstorage, and allows you to resume the instance at a later time. Suspended\ninstances have no compute costs (cores or RAM), and incur only storage\ncharges for the saved VM memory and localSSD data. Any charged resources\nthe virtual machine was using, such as persistent disks and static IP\naddresses, will continue to be charged while the instance is suspended.\nFor more information, see\nSuspending and resuming an instance.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/suspend",
+ "simulateMaintenanceEvent": {
+ "description": "Simulates a host maintenance event on a VM. For more information, see\nSimulate a host maintenance event.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent",
"httpMethod": "POST",
- "id": "compute.instances.suspend",
+ "id": "compute.instances.simulateMaintenanceEvent",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
- "discardLocalSsd": {
- "description": "This property is required if the instance has any attached Local SSD disks.\nIf false, Local SSD data will be preserved when the instance is suspended.\nIf true, the contents of any attached Local SSD disks will be discarded.",
- "location": "query",
- "type": "boolean"
- },
"instance": {
- "description": "Name of the instance resource to suspend.",
+ "description": "Name of the instance scoping this request.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
@@ -15125,6 +15403,11 @@
"location": "query",
"type": "string"
},
+ "withExtendedNotifications": {
+ "description": "Determines whether the customers receive notifications before migration.\nOnly applicable to SF vms.",
+ "location": "query",
+ "type": "boolean"
+ },
"zone": {
"description": "The name of the zone for this request.",
"location": "path",
@@ -15133,7 +15416,7 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}/suspend",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/simulateMaintenanceEvent",
"response": {
"$ref": "Operation"
},
@@ -15142,17 +15425,24 @@
"https://www.googleapis.com/auth/compute"
]
},
- "testIamPermissions": {
- "description": "Returns permissions that a caller has on the specified resource.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions",
+ "start": {
+ "description": "Starts an instance that was stopped using theinstances().stop\nmethod. For more information, seeRestart an\ninstance.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/start",
"httpMethod": "POST",
- "id": "compute.instances.testIamPermissions",
+ "id": "compute.instances.start",
"parameterOrder": [
"project",
"zone",
- "resource"
+ "instance"
],
"parameters": {
+ "instance": {
+ "description": "Name of the instance resource to start.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ },
"project": {
"description": "Project ID for this request.",
"location": "path",
@@ -15160,11 +15450,9 @@
"required": true,
"type": "string"
},
- "resource": {
- "description": "Name or id of the resource for this request.",
- "location": "path",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
- "required": true,
+ "requestId": {
+ "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+ "location": "query",
"type": "string"
},
"zone": {
@@ -15175,76 +15463,33 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions",
- "request": {
- "$ref": "TestPermissionsRequest"
- },
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/start",
"response": {
- "$ref": "TestPermissionsResponse"
+ "$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute",
- "https://www.googleapis.com/auth/compute.readonly"
+ "https://www.googleapis.com/auth/compute"
]
},
- "update": {
- "description": "Updates an instance only if the necessary resources are available. This\nmethod can update only a specific set of instance properties. See\nUpdating a running instance for a list of updatable instance\nproperties.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}",
- "httpMethod": "PUT",
- "id": "compute.instances.update",
+ "startWithEncryptionKey": {
+ "description": "Starts an instance that was stopped using theinstances().stop\nmethod. For more information, seeRestart an\ninstance.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey",
+ "httpMethod": "POST",
+ "id": "compute.instances.startWithEncryptionKey",
"parameterOrder": [
"project",
"zone",
"instance"
],
"parameters": {
- "discardLocalSsd": {
- "description": "Whether to discard local SSDs from the instance during restart\ndefault value is false.",
- "location": "query",
- "type": "boolean"
- },
"instance": {
- "description": "Name of the instance resource to update.",
+ "description": "Name of the instance resource to start.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
- "minimalAction": {
- "description": "Specifies the action to take when updating an instance even if the\nupdated properties do not require it. If not specified, then\nCompute Engine acts based on the minimum action that the updated\nproperties require.",
- "enum": [
- "INVALID",
- "NO_EFFECT",
- "REFRESH",
- "RESTART"
- ],
- "enumDescriptions": [
- "",
- "No changes can be made to the instance.",
- "The instance will not restart.",
- "The instance will restart, potentially on a different host."
- ],
- "location": "query",
- "type": "string"
- },
- "mostDisruptiveAllowedAction": {
- "description": "Specifies the most disruptive action that can be taken on the instance\nas part of the update. Compute Engine returns an error if the\ninstance properties require a more disruptive action as part of the\ninstance update. Valid options from lowest to highest are\nNO_EFFECT, REFRESH, and RESTART.",
- "enum": [
- "INVALID",
- "NO_EFFECT",
- "REFRESH",
- "RESTART"
- ],
- "enumDescriptions": [
- "",
- "No changes can be made to the instance.",
- "The instance will not restart.",
- "The instance will restart, potentially on a different host."
- ],
- "location": "query",
- "type": "string"
- },
"project": {
"description": "Project ID for this request.",
"location": "path",
@@ -15265,9 +15510,9 @@
"type": "string"
}
},
- "path": "projects/{project}/zones/{zone}/instances/{instance}",
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/startWithEncryptionKey",
"request": {
- "$ref": "Instance"
+ "$ref": "InstancesStartWithEncryptionKeyRequest"
},
"response": {
"$ref": "Operation"
@@ -15277,30 +15522,274 @@
"https://www.googleapis.com/auth/compute"
]
},
- "updateAccessConfig": {
- "description": "Updates the specified access config from an instance's network interface\nwith the data included in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
- "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig",
+ "stop": {
+ "description": "Stops a running instance, shutting it down cleanly, and allows\nyou to restart the instance at a later time. Stopped instances do not incur\nVM usage charges while they are stopped. However, resources that the VM is\nusing, such as persistent disks and static IP addresses, will continue to\nbe charged until they are deleted. For more information, seeStopping\nan instance.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/stop",
"httpMethod": "POST",
- "id": "compute.instances.updateAccessConfig",
+ "id": "compute.instances.stop",
"parameterOrder": [
"project",
"zone",
- "instance",
- "networkInterface"
+ "instance"
],
"parameters": {
+ "discardLocalSsd": {
+ "description": "This property is required if the instance has any attached Local SSD disks.\nIf false, Local SSD data will be preserved when the instance is suspended.\nIf true, the contents of any attached Local SSD disks will be discarded.",
+ "location": "query",
+ "type": "boolean"
+ },
"instance": {
- "description": "The instance name for this request.",
+ "description": "Name of the instance resource to stop.",
"location": "path",
"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
"required": true,
"type": "string"
},
- "networkInterface": {
- "description": "The name of the network interface where the access config is attached.",
+ "noGracefulShutdown": {
+ "description": "If set to true, Graceful Shutdown is skipped.",
"location": "query",
- "required": true,
- "type": "string"
+ "type": "boolean"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+ "location": "query",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/stop",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
+ "suspend": {
+ "description": "This method suspends a running instance, saving its state to persistent\nstorage, and allows you to resume the instance at a later time. Suspended\ninstances have no compute costs (cores or RAM), and incur only storage\ncharges for the saved VM memory and localSSD data. Any charged resources\nthe virtual machine was using, such as persistent disks and static IP\naddresses, will continue to be charged while the instance is suspended.\nFor more information, see\nSuspending and resuming an instance.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/suspend",
+ "httpMethod": "POST",
+ "id": "compute.instances.suspend",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "parameters": {
+ "discardLocalSsd": {
+ "description": "This property is required if the instance has any attached Local SSD disks.\nIf false, Local SSD data will be preserved when the instance is suspended.\nIf true, the contents of any attached Local SSD disks will be discarded.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "instance": {
+ "description": "Name of the instance resource to suspend.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+ "location": "query",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/zones/{zone}/instances/{instance}/suspend",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "id": "compute.instances.testIamPermissions",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "resource"
+ ],
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/zones/{zone}/instances/{resource}/testIamPermissions",
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
+ "update": {
+ "description": "Updates an instance only if the necessary resources are available. This\nmethod can update only a specific set of instance properties. See\nUpdating a running instance for a list of updatable instance\nproperties.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}",
+ "httpMethod": "PUT",
+ "id": "compute.instances.update",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance"
+ ],
+ "parameters": {
+ "discardLocalSsd": {
+ "description": "Whether to discard local SSDs from the instance during restart\ndefault value is false.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "instance": {
+ "description": "Name of the instance resource to update.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ },
+ "minimalAction": {
+ "description": "Specifies the action to take when updating an instance even if the\nupdated properties do not require it. If not specified, then\nCompute Engine acts based on the minimum action that the updated\nproperties require.",
+ "enum": [
+ "INVALID",
+ "NO_EFFECT",
+ "REFRESH",
+ "RESTART"
+ ],
+ "enumDescriptions": [
+ "",
+ "No changes can be made to the instance.",
+ "The instance will not restart.",
+ "The instance will restart, potentially on a different host."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "mostDisruptiveAllowedAction": {
+ "description": "Specifies the most disruptive action that can be taken on the instance\nas part of the update. Compute Engine returns an error if the\ninstance properties require a more disruptive action as part of the\ninstance update. Valid options from lowest to highest are\nNO_EFFECT, REFRESH, and RESTART.",
+ "enum": [
+ "INVALID",
+ "NO_EFFECT",
+ "REFRESH",
+ "RESTART"
+ ],
+ "enumDescriptions": [
+ "",
+ "No changes can be made to the instance.",
+ "The instance will not restart.",
+ "The instance will restart, potentially on a different host."
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+ "location": "query",
+ "type": "string"
+ },
+ "zone": {
+ "description": "The name of the zone for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/zones/{zone}/instances/{instance}",
+ "request": {
+ "$ref": "Instance"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
+ "updateAccessConfig": {
+ "description": "Updates the specified access config from an instance's network interface\nwith the data included in the request. This method supportsPATCH\nsemantics and uses theJSON merge\npatch format and processing rules.",
+ "flatPath": "projects/{project}/zones/{zone}/instances/{instance}/updateAccessConfig",
+ "httpMethod": "POST",
+ "id": "compute.instances.updateAccessConfig",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "instance",
+ "networkInterface"
+ ],
+ "parameters": {
+ "instance": {
+ "description": "The instance name for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ },
+ "networkInterface": {
+ "description": "The name of the network interface where the access config is attached.",
+ "location": "query",
+ "required": true,
+ "type": "string"
},
"project": {
"description": "Project ID for this request.",
@@ -24426,6 +24915,71 @@
}
}
},
+ "organizationSnapshotRecycleBinPolicy": {
+ "methods": {
+ "get": {
+ "description": "Returns the specified SnapshotRecycleBinPolicy.",
+ "flatPath": "organizations/{organizationsId}/global/snapshotRecycleBinPolicy",
+ "httpMethod": "GET",
+ "id": "compute.organizationSnapshotRecycleBinPolicy.get",
+ "parameterOrder": [
+ "organization"
+ ],
+ "parameters": {
+ "organization": {
+ "description": "Organization ID for this request.",
+ "location": "path",
+ "pattern": "organizations/[0-9]{0,20}",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "{+organization}/global/snapshotRecycleBinPolicy",
+ "response": {
+ "$ref": "SnapshotRecycleBinPolicy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Patches the SnapshotRecycleBinPolicy.",
+ "flatPath": "organizations/{organizationsId}/global/snapshotRecycleBinPolicy",
+ "httpMethod": "PATCH",
+ "id": "compute.organizationSnapshotRecycleBinPolicy.patch",
+ "parameterOrder": [
+ "organization"
+ ],
+ "parameters": {
+ "organization": {
+ "description": "Organization ID for this request.",
+ "location": "path",
+ "pattern": "organizations/[0-9]{0,20}",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "{+organization}/global/snapshotRecycleBinPolicy",
+ "request": {
+ "$ref": "SnapshotRecycleBinPolicy"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ }
+ }
+ },
"packetMirrorings": {
"methods": {
"aggregatedList": {
@@ -26193,6 +26747,300 @@
}
}
},
+ "recoverableSnapshots": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the specified RecoverableSnapshot. Deleting a recoverable snapshot\nwill delete the underlying PD snapshot and is irreversible.",
+ "flatPath": "projects/{project}/global/recoverableSnapshots/{recoverableSnapshot}",
+ "httpMethod": "DELETE",
+ "id": "compute.recoverableSnapshots.delete",
+ "parameterOrder": [
+ "project",
+ "recoverableSnapshot"
+ ],
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "recoverableSnapshot": {
+ "description": "Name of the recoverable Snapshot resource to delete.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/global/recoverableSnapshots/{recoverableSnapshot}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
+ "get": {
+ "description": "Returns the specified RecoverableSnapshot resource.",
+ "flatPath": "projects/{project}/global/recoverableSnapshots/{recoverableSnapshot}",
+ "httpMethod": "GET",
+ "id": "compute.recoverableSnapshots.get",
+ "parameterOrder": [
+ "project",
+ "recoverableSnapshot"
+ ],
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "recoverableSnapshot": {
+ "description": "Name of the Snapshot resource to return.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/global/recoverableSnapshots/{recoverableSnapshot}",
+ "response": {
+ "$ref": "RecoverableSnapshot"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
+ "getIamPolicy": {
+ "description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.",
+ "flatPath": "projects/{project}/global/recoverableSnapshots/{resource}/getIamPolicy",
+ "httpMethod": "GET",
+ "id": "compute.recoverableSnapshots.getIamPolicy",
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "parameters": {
+ "optionsRequestedPolicyVersion": {
+ "description": "Requested IAM Policy version.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/global/recoverableSnapshots/{resource}/getIamPolicy",
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
+ "list": {
+ "description": "Retrieves a list of all of the RecoverableSnapshots in your project.",
+ "flatPath": "projects/{project}/global/recoverableSnapshots",
+ "httpMethod": "GET",
+ "id": "compute.recoverableSnapshots.list",
+ "parameterOrder": [
+ "project"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "A filter expression that filters resources listed in the response. Most\nCompute resources support two types of filter expressions:\nexpressions that support regular expressions and expressions that follow\nAPI improvement proposal AIP-160.\nThese two types of filter expressions cannot be mixed in one request.\n\nIf you want to use AIP-160, your expression must specify the field name, an\noperator, and the value that you want to use for filtering. The value\nmust be a string, a number, or a boolean. The operator\nmust be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`.\n\nFor example, if you are filtering Compute Engine instances, you can\nexclude instances named `example-instance` by specifying\n`name != example-instance`.\n\nThe `:*` comparison can be used to test whether a key has been defined.\nFor example, to find all objects with `owner` label use:\n```\nlabels.owner:*\n```\n\nYou can also filter nested fields. For example, you could specify\n`scheduling.automaticRestart = false` to include instances only\nif they are not scheduled for automatic restarts. You can use filtering\non nested fields to filter based onresource labels.\n\nTo filter on multiple expressions, provide each separate expression within\nparentheses. For example:\n```\n(scheduling.automaticRestart = true)\n(cpuPlatform = \"Intel Skylake\")\n```\nBy default, each expression is an `AND` expression. However, you\ncan include `AND` and `OR` expressions explicitly.\nFor example:\n```\n(cpuPlatform = \"Intel Skylake\") OR\n(cpuPlatform = \"Intel Broadwell\") AND\n(scheduling.automaticRestart = true)\n```\n\nIf you want to use a regular expression, use the `eq` (equal) or `ne`\n(not equal) operator against a single un-parenthesized expression with or\nwithout quotes or against multiple parenthesized expressions. Examples:\n\n`fieldname eq unquoted literal`\n`fieldname eq 'single quoted literal'`\n`fieldname eq \"double quoted literal\"`\n`(fieldname1 eq literal) (fieldname2 ne \"literal\")`\n\nThe literal value is interpreted as a regular expression using GoogleRE2 library syntax.\nThe literal value must match the entire field.\n\nFor example, to filter for instances that do not end with name \"instance\",\nyou would use `name ne .*instance`.\n\nYou cannot combine constraints on multiple fields using regular\nexpressions.",
+ "location": "query",
+ "type": "string"
+ },
+ "maxResults": {
+ "default": "500",
+ "description": "The maximum number of results per page that should be returned.\nIf the number of available results is larger than `maxResults`,\nCompute Engine returns a `nextPageToken` that can be used to get\nthe next page of results in subsequent list requests. Acceptable values are\n`0` to `500`, inclusive. (Default: `500`)",
+ "format": "uint32",
+ "location": "query",
+ "minimum": "0",
+ "type": "integer"
+ },
+ "orderBy": {
+ "description": "Sorts list results by a certain order. By default, results\nare returned in alphanumerical order based on the resource name.\n\nYou can also sort results in descending order based on the creation\ntimestamp using `orderBy=\"creationTimestamp desc\"`. This sorts\nresults based on the `creationTimestamp` field in\nreverse chronological order (newest result first). Use this to sort\nresources like operations so that the newest operation is returned first.\n\nCurrently, only sorting by `name` or\n`creationTimestamp desc` is supported.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageToken": {
+ "description": "Specifies a page token to use. Set `pageToken` to the\n`nextPageToken` returned by a previous list request to get\nthe next page of results.",
+ "location": "query",
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "returnPartialSuccess": {
+ "description": "Opt-in for partial success behavior which provides partial results in case\nof failure. The default value is false.\n\nFor example, when partial success behavior is enabled, aggregatedList for a\nsingle zone scope either returns all resources in the zone or no resources,\nwith an error code.",
+ "location": "query",
+ "type": "boolean"
+ }
+ },
+ "path": "projects/{project}/global/recoverableSnapshots",
+ "response": {
+ "$ref": "RecoverableSnapshotList"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
+ "recover": {
+ "description": "Recovers the specified RecoverableSnapshot.",
+ "flatPath": "projects/{project}/global/recoverableSnapshots/{recoverableSnapshot}/recover",
+ "httpMethod": "POST",
+ "id": "compute.recoverableSnapshots.recover",
+ "parameterOrder": [
+ "project",
+ "recoverableSnapshot"
+ ],
+ "parameters": {
+ "project": {
+ "description": "Project Id of the request",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "recoverableSnapshot": {
+ "description": "Name of the recoverable resource to recover",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+ "location": "query",
+ "type": "string"
+ },
+ "snapshotName": {
+ "description": "Optional. Name of the snapshot after the recovery\nThe name will be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name will be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter will be a lowercase letter, and all following characters can be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
+ "location": "query",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/global/recoverableSnapshots/{recoverableSnapshot}/recover",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
+ "setIamPolicy": {
+ "description": "Sets the access control policy on the specified resource.\nReplaces any existing policy.",
+ "flatPath": "projects/{project}/global/recoverableSnapshots/{resource}/setIamPolicy",
+ "httpMethod": "POST",
+ "id": "compute.recoverableSnapshots.setIamPolicy",
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/global/recoverableSnapshots/{resource}/setIamPolicy",
+ "request": {
+ "$ref": "GlobalSetPolicyRequest"
+ },
+ "response": {
+ "$ref": "Policy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
+ "testIamPermissions": {
+ "description": "Returns permissions that a caller has on the specified resource.",
+ "flatPath": "projects/{project}/global/recoverableSnapshots/{resource}/testIamPermissions",
+ "httpMethod": "POST",
+ "id": "compute.recoverableSnapshots.testIamPermissions",
+ "parameterOrder": [
+ "project",
+ "resource"
+ ],
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "resource": {
+ "description": "Name or id of the resource for this request.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9_]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/global/recoverableSnapshots/{resource}/testIamPermissions",
+ "request": {
+ "$ref": "TestPermissionsRequest"
+ },
+ "response": {
+ "$ref": "TestPermissionsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ }
+ }
+ },
"regionAutoscalers": {
"methods": {
"delete": {
@@ -40340,6 +41188,58 @@
"https://www.googleapis.com/auth/compute.readonly"
]
},
+ "getHealth": {
+ "description": "Get health info on a reservation slot.",
+ "flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}/getHealth",
+ "httpMethod": "POST",
+ "id": "compute.reservationSlots.getHealth",
+ "parameterOrder": [
+ "project",
+ "zone",
+ "parentName",
+ "reservationSlot"
+ ],
+ "parameters": {
+ "parentName": {
+ "description": "The name of the parent reservation, parent block and parent sub-block. In\nthe format of\nreservations/{reservation_name}/reservationBlocks/{reservation_block_name}/reservationSubBlocks/{reservation_sub_block_name}",
+ "location": "path",
+ "pattern": "reservations/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})/reservationSubBlocks/([a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19})",
+ "required": true,
+ "type": "string"
+ },
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "description": "An optional request ID to identify requests.",
+ "location": "query",
+ "type": "string"
+ },
+ "reservationSlot": {
+ "description": "The name of the reservation slot.\nName should conform to RFC1035 or be a resource ID.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ },
+ "zone": {
+ "description": "Name of the zone for this request. Zone name should conform to RFC1035.",
+ "location": "path",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/zones/{zone}/{+parentName}/reservationSlots/{reservationSlot}/getHealth",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ },
"getVersion": {
"description": "Allows customers to get SBOM versions of a reservation slot.",
"flatPath": "projects/{project}/zones/{zone}/reservations/{reservationsId}/reservationBlocks/{reservationBlocksId}/reservationSubBlocks/{reservationSubBlocksId}/reservationSlots/{reservationSlot}/getVersion",
@@ -45307,6 +46207,71 @@
}
}
},
+ "snapshotRecycleBinPolicy": {
+ "methods": {
+ "get": {
+ "description": "Returns the specified SnapshotRecycleBinPolicy.",
+ "flatPath": "projects/{project}/global/snapshotRecycleBinPolicy",
+ "httpMethod": "GET",
+ "id": "compute.snapshotRecycleBinPolicy.get",
+ "parameterOrder": [
+ "project"
+ ],
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/global/snapshotRecycleBinPolicy",
+ "response": {
+ "$ref": "SnapshotRecycleBinPolicy"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
+ "patch": {
+ "description": "Patches the SnapshotRecycleBinPolicy.",
+ "flatPath": "projects/{project}/global/snapshotRecycleBinPolicy",
+ "httpMethod": "PATCH",
+ "id": "compute.snapshotRecycleBinPolicy.patch",
+ "parameterOrder": [
+ "project"
+ ],
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "requestId": {
+ "description": "An optional request ID to identify requests. Specify a unique request ID so\nthat if you must retry your request, the server will know to ignore the\nrequest if it has already been completed.\n\nFor example, consider a situation where you make an initial request and\nthe request times out. If you make the request again with the same\nrequest ID, the server can check if original operation with the same\nrequest ID was received, and if so, will ignore the second request. This\nprevents clients from accidentally creating duplicate commitments.\n\nThe request ID must be\na valid UUID with the exception that zero UUID is not supported\n(00000000-0000-0000-0000-000000000000).",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/global/snapshotRecycleBinPolicy",
+ "request": {
+ "$ref": "SnapshotRecycleBinPolicy"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute"
+ ]
+ }
+ }
+ },
"snapshotSettings": {
"methods": {
"get": {
@@ -45520,6 +46485,41 @@
"https://www.googleapis.com/auth/compute.readonly"
]
},
+ "getEffectiveRecycleBinRule": {
+ "description": "Returns the effective recycle bin rule for a snapshot by merging org and\nproject level rules. If no rules are defined at org and project level, the\nstandard default rule is returned.",
+ "flatPath": "projects/{project}/global/snapshots/{snapshot}/getEffectiveRecycleBinRule",
+ "httpMethod": "GET",
+ "id": "compute.snapshots.getEffectiveRecycleBinRule",
+ "parameterOrder": [
+ "project",
+ "snapshot"
+ ],
+ "parameters": {
+ "project": {
+ "description": "Project ID for this request.",
+ "location": "path",
+ "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))",
+ "required": true,
+ "type": "string"
+ },
+ "snapshot": {
+ "description": "Name of the Snapshot resource to get the effective recycle bin rule for.",
+ "location": "path",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "projects/{project}/global/snapshots/{snapshot}/getEffectiveRecycleBinRule",
+ "response": {
+ "$ref": "SnapshotsGetEffectiveRecycleBinRuleResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/compute",
+ "https://www.googleapis.com/auth/compute.readonly"
+ ]
+ },
"getIamPolicy": {
"description": "Gets the access control policy for a resource. May be empty if no such\npolicy or resource exists.",
"flatPath": "projects/{project}/global/snapshots/{resource}/getIamPolicy",
@@ -53071,7 +54071,7 @@
}
}
},
- "revision": "20260807",
+ "revision": "20260821",
"rootUrl": "https://compute.googleapis.com/",
"schemas": {
"AWSV4Signature": {
@@ -61074,6 +62074,7 @@
"confidentialInstanceType": {
"description": "Defines the type of technology used by the confidential instance.",
"enum": [
+ "BMSAI",
"CCA",
"CONFIDENTIAL_INSTANCE_TYPE_UNSPECIFIED",
"SEV",
@@ -61081,6 +62082,7 @@
"TDX"
],
"enumDescriptions": [
+ "Bare Metal Secure AI.",
"Arm Confidential Compute Architecture.",
"No type specified. Do not use this value.",
"AMD Secure Encrypted Virtualization.",
@@ -61607,6 +62609,316 @@
},
"type": "object"
},
+ "DhcpOptionsConfig": {
+ "description": "A standalone, regional API resource that encapsulates a set of user-defined\nDHCP configurations.",
+ "id": "DhcpOptionsConfig",
+ "properties": {
+ "associations": {
+ "additionalProperties": {
+ "$ref": "DhcpOptionsConfigAssociation"
+ },
+ "description": "Mapping of user-defined keys to DhcpOptionsConfig to Network associations.",
+ "type": "object"
+ },
+ "bootFileIpv4Name": {
+ "description": "The file path and name of the boot image/file on the TFTP server that the\nclient VM guest OS should download and execute during network boot. Used\nwhen the standard DHCP header 'file' field is overloaded. Corresponds to\nDHCPv4 Option 67.",
+ "type": "string"
+ },
+ "bootFileIpv6Parameters": {
+ "description": "A list of UTF-8 encoded parameter strings to be passed as arguments to the\nbootloader program or OS kernel after downloading the boot file.\nCorresponds to DHCPv6 Option 60.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "bootFileIpv6Url": {
+ "description": "The Uniform Resource Locator (URL) specifying the protocol, server address,\nand file path of the boot file that the client VM guest OS should download\nand execute for network boot (e.g., 'tftp://[2001:db8::1]/bootx64.efi' or\n'http://[2001:db8::1]/boot.img'). Corresponds to DHCPv6 Option 59.",
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "description": {
+ "description": "An optional description of this resource. Provide this property when you\ncreate the resource.",
+ "type": "string"
+ },
+ "dnsSearchPaths": {
+ "description": "An ordered list of domain suffixes (search paths) that the client VM guest\nOS should append to resolve hostnames that are not fully qualified. Applies\nto both DHCPv4 Option 119 and DHCPv6 Option 24.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "domainName": {
+ "description": "The domain name that the client VM guest OS should use when resolving\nhostnames via DNS (e.g., 'example.com'). It defines the default domain\nsuffix for the client. Corresponds to DHCPv4 Option 15.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Output only. [Output Only] The unique identifier for the resource type. The server\ngenerates this identifier.",
+ "format": "uint64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#dhcpOptionsConfig",
+ "description": "Output only. [Output Only] Type of the resource. Alwayscompute#dhcpOptionsConfig for dhcp options configs.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "leaseTimeSec": {
+ "description": "The duration, in seconds, of the IPv4 address lease offered by the DHCP\nserver to the client VM guest OS. Corresponds to DHCPv4 Option 51.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "annotations": {
+ "required": [
+ "compute.dhcpOptionsConfigs.insert"
+ ]
+ },
+ "description": "Name of the resource. Provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ },
+ "ntpServerIpv4Addresses": {
+ "description": "An ordered list of IPv4 addresses of Network Time Protocol (NTP) servers\navailable to the client VM guest OS for system clock synchronization,\nlisted in order of preference. Corresponds to DHCPv4 Option 42.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "ntpServerIpv6Addresses": {
+ "description": "An ordered list of IPv6 addresses of Network Time Protocol (NTP) servers\navailable to the client VM guest OS for system clock synchronization.\nCorresponds to DHCPv6 Option 56.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "region": {
+ "description": "Output only. [Output Only] URL of the region where the resource resides.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "Output only. [Output Only] Server-defined URL for the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "tftpServerIpv4Addresses": {
+ "description": "An ordered list of one or more IPv4 addresses of TFTP servers. Provides\nserver redundancy and failover support, and is generally prioritized by\nclients over the single hostname specified in Option 66. Corresponds to\nDHCPv4 Option 150.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "tftpServerIpv4Name": {
+ "description": "The hostname or IP address of the Trivial File Transfer Protocol (TFTP)\nserver from which the client VM guest OS can download boot files. Typically\nused in network booting (PXE) when the standard DHCP header 'sname' field\nis overloaded. Corresponds to DHCPv4 Option 66.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DhcpOptionsConfigAssociation": {
+ "description": "Association represents the relationship between a DHCP options config and a\nnetwork. Association represents the relationship between a DHCP options\nconfig and a network.",
+ "id": "DhcpOptionsConfigAssociation",
+ "properties": {
+ "network": {
+ "description": "Required. The target network this DHCP option is attached to.\nYou can specify this as a full or partial URL. For example, the following\nare all valid URLs:\n \n \n - https://www.googleapis.com/compute/v1/projects/project/global/networks/network\n \n - projects/project/global/networks/network",
+ "type": "string"
+ },
+ "networkId": {
+ "description": "Output only. [Output Only] The server-defined ID of the associated Network.",
+ "format": "uint64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "state": {
+ "description": "Output only. [Output Only] State of the association.",
+ "enum": [
+ "ACTIVE",
+ "ORPHANED",
+ "STATE_UNSPECIFIED"
+ ],
+ "enumDescriptions": [
+ "The association is active and the DHCP configuration is applied.",
+ "The association is orphaned (the network has been deleted).",
+ "Default value. This value is unused."
+ ],
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DhcpOptionsConfigList": {
+ "id": "DhcpOptionsConfigList",
+ "properties": {
+ "etag": {
+ "description": "Server-defined ETag for optimistic concurrency control.",
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of DhcpOptionsConfig resources.",
+ "items": {
+ "$ref": "DhcpOptionsConfig"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "compute#dhcpOptionsConfigList",
+ "description": "Output only. [Output Only] Type of the resource. Alwayscompute#dhcpOptionsConfigList for a list of dhcp options\nconfigs.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "[Output Only] Server-defined URL for this resource.",
+ "type": "string"
+ },
+ "unreachables": {
+ "description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "LIST_OVERHEAD_QUOTA_EXCEED",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "QUOTA_INFO_UNAVAILABLE",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDeprecated": [
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ true,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed\noperation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as\ndeprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as\nexperimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden.\nDeprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "Quota information is not available to client requests (e.g:\nregions.list).",
+ "The user attempted to use a resource that requires a TOS they have not\naccepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "type": "string"
+ },
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }]",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
"Disk": {
"description": "Represents a Persistent Disk resource.\n\nGoogle Compute Engine has two Disk resources:\n\n* [Zonal](/compute/docs/reference/rest/beta/disks)\n* [Regional](/compute/docs/reference/rest/beta/regionDisks)\n\nPersistent disks are required for running your VM instances.\nCreate both boot and non-boot (data) persistent disks. For more information,\nread Persistent Disks. For more\nstorage options, read Storage options.\n\nThe disks resource represents a zonal persistent disk.\nFor more information, readZonal persistent disks.\n\nThe regionDisks resource represents a\nregional persistent disk. For more information, read\nRegional resources.",
"id": "Disk",
@@ -65879,10 +67191,12 @@
},
"confidentialComputeType": {
"enum": [
+ "CONFIDENTIAL_COMPUTE_TYPE_BMSAI",
"CONFIDENTIAL_COMPUTE_TYPE_TDX",
"CONFIDENTIAL_COMPUTE_TYPE_UNSPECIFIED"
],
"enumDescriptions": [
+ "Bare Metal Secure AI.",
"Intel Trust Domain Extensions.",
""
],
@@ -67177,6 +68491,99 @@
},
"type": "object"
},
+ "GetHealthOperationMetadata": {
+ "description": "Metadata for GetHealth operations.",
+ "id": "GetHealthOperationMetadata",
+ "properties": {
+ "healthInfo": {
+ "$ref": "GetHealthOperationMetadataHealthInfo",
+ "description": "Output only. The health information.",
+ "readOnly": true
+ }
+ },
+ "type": "object"
+ },
+ "GetHealthOperationMetadataHealthInfo": {
+ "description": "Health information.",
+ "id": "GetHealthOperationMetadataHealthInfo",
+ "properties": {
+ "availabilitySloStatus": {
+ "description": "Output only. The availability SLO status.",
+ "enum": [
+ "AVAILABILITY_SLO_STATUS_IN_SLO",
+ "AVAILABILITY_SLO_STATUS_OUT_OF_SLO",
+ "AVAILABILITY_SLO_STATUS_SLO_UNKNOWN",
+ "AVAILABILITY_SLO_STATUS_UNSPECIFIED"
+ ],
+ "enumDescriptions": [
+ "The slot availability is in SLO.",
+ "The slot availability is out of SLO.",
+ "The slot availability is unknown.",
+ "Unspecified availability SLO status."
+ ],
+ "readOnly": true,
+ "type": "string"
+ },
+ "healthStatus": {
+ "description": "Output only. The health status.",
+ "enum": [
+ "HEALTH_STATUS_HEALTHY",
+ "HEALTH_STATUS_UNHEALTHY",
+ "HEALTH_STATUS_UNSPECIFIED"
+ ],
+ "enumDescriptions": [
+ "The reservation slot is healthy.",
+ "The reservation slot is unhealthy.",
+ "Unspecified health status."
+ ],
+ "readOnly": true,
+ "type": "string"
+ },
+ "repairCategory": {
+ "description": "Output only. The repair category.",
+ "enum": [
+ "REPAIR_CATEGORY_CRITICAL_FAILURE",
+ "REPAIR_CATEGORY_EMERGENT_MAINTENANCE",
+ "REPAIR_CATEGORY_PLANNED_MAINTENANCE",
+ "REPAIR_CATEGORY_UNSPECIFIED",
+ "REPAIR_CATEGORY_USER_REPORTED_FAULT"
+ ],
+ "enumDescriptions": [
+ "The repair is because of critical failures, that are scoped outside\nemergent maintenance",
+ "The repair is because of an emergent maintenance",
+ "The repair is because of a planned maintenance",
+ "Unspecified repair category.",
+ "The repair is because of a user reported fault"
+ ],
+ "readOnly": true,
+ "type": "string"
+ },
+ "unhealthyReason": {
+ "description": "Output only. The reason for unhealthy status.",
+ "enum": [
+ "UNHEALTHY_REASON_PENDING_USER_APPROVAL",
+ "UNHEALTHY_REASON_REPAIRING",
+ "UNHEALTHY_REASON_UNSCHEDULABLE",
+ "UNHEALTHY_REASON_UNSPECIFIED"
+ ],
+ "enumDescriptions": [
+ "The slot is unhealthy because there is a pending repair, waiting for\ncustomer approval",
+ "The slot is unhealthy because repair is in progress",
+ "The slot is unhealthy because a vm cannot be scheduled on it, and no\nrepairs are running on the slot",
+ "Unspecified unhealthy reason."
+ ],
+ "readOnly": true,
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Output only. The time when health info was updated.",
+ "format": "google-datetime",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"GetVersionOperationMetadata": {
"id": "GetVersionOperationMetadata",
"properties": {
@@ -67220,6 +68627,68 @@
},
"type": "object"
},
+ "GlobalFrontendSettings": {
+ "description": "Represents the Global Frontend Bundle settings for a single project.",
+ "id": "GlobalFrontendSettings",
+ "properties": {
+ "bundleType": {
+ "description": "Customer-settable bundle type.",
+ "enum": [
+ "BUNDLE_TYPE_UNSPECIFIED",
+ "GLOBAL_FRONT_END",
+ "INDIVIDUAL"
+ ],
+ "enumDescriptions": [
+ "Bundling is not active",
+ "Standard Global Frontend bundle",
+ "Ala Carte mode"
+ ],
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "description": "Output only. [Output Only] Creation timestamp in RFC3339 text format.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "description": {
+ "description": "Output only. [Output Only] An optional description of this resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "etag": {
+ "description": "Output only. For optimistic locking",
+ "readOnly": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
+ "format": "uint64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. OUTPUT_ONLY fields\n[Output Only] Name of the resource. Must be 1-63 characters long and match\nthe regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "Output only. [Output Only] Server-defined URL for the resource.",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GlobalFrontendSettingsPatchResponse": {
+ "description": "Response to an UpdateGlobalFrontendSettingsRequest.",
+ "id": "GlobalFrontendSettingsPatchResponse",
+ "properties": {
+ "operation": {
+ "$ref": "Operation"
+ }
+ },
+ "type": "object"
+ },
"GlobalNetworkEndpointGroupsAttachEndpointsRequest": {
"id": "GlobalNetworkEndpointGroupsAttachEndpointsRequest",
"properties": {
@@ -67867,7 +69336,7 @@
"id": "GuestOsFeature",
"properties": {
"type": {
- "description": "The ID of a supported feature. To add multiple values, use commas to\nseparate values. Set to one or more of the following values:\n \n - VIRTIO_SCSI_MULTIQUEUE\n - WINDOWS\n - MULTI_IP_SUBNET\n - UEFI_COMPATIBLE\n - GVNIC\n - SEV_CAPABLE\n - SUSPEND_RESUME_COMPATIBLE\n - SEV_LIVE_MIGRATABLE_V2\n - SEV_SNP_CAPABLE\n - TDX_CAPABLE\n - IDPF\n - SNP_SVSM_CAPABLE\n - CCA_CAPABLE\n\n\nFor more information, see\nEnabling guest operating system features.",
+ "description": "The ID of a supported feature. To add multiple values, use commas to\nseparate values. Set to one or more of the following values:\n \n - VIRTIO_SCSI_MULTIQUEUE\n - WINDOWS\n - MULTI_IP_SUBNET\n - UEFI_COMPATIBLE\n - GVNIC\n - SEV_CAPABLE\n - SUSPEND_RESUME_COMPATIBLE\n - SEV_LIVE_MIGRATABLE_V2\n - SEV_SNP_CAPABLE\n - TDX_CAPABLE\n - IDPF\n - SNP_SVSM_CAPABLE\n - CCA_CAPABLE\n - SUSPEND_SAFE_FPR\n\n\nFor more information, see\nEnabling guest operating system features.",
"enum": [
"BARE_METAL_LINUX_COMPATIBLE",
"CCA_CAPABLE",
@@ -67881,6 +69350,7 @@
"SEV_LIVE_MIGRATABLE_V2",
"SEV_SNP_CAPABLE",
"SNP_SVSM_CAPABLE",
+ "SUSPEND_SAFE_FPR",
"TDX_CAPABLE",
"UEFI_COMPATIBLE",
"VIRTIO_SCSI_MULTIQUEUE",
@@ -67899,6 +69369,7 @@
"",
"",
"",
+ "Indicates the guest OS is safe for free page reporting (FPR) during\nsuspend.",
"",
"",
"",
@@ -78880,6 +80351,11 @@
"readOnly": true,
"type": "string"
},
+ "selfLinkWithId": {
+ "description": "Output only. Server-defined URL for this resource with the resource id.",
+ "readOnly": true,
+ "type": "string"
+ },
"state": {
"description": "Output only. [Output Only] The current state of Interconnect functionality, which can\ntake one of the following values:\n \n - ACTIVE: The Interconnect is valid, turned up and ready to use.\n Attachments may be provisioned on this Interconnect.\n - UNPROVISIONED: The Interconnect has not completed turnup. No\n attachments may be provisioned on this Interconnect.\n - UNDER_MAINTENANCE: The Interconnect is undergoing internal maintenance.\n No attachments may be provisioned or updated on this\n Interconnect.",
"enum": [
@@ -81741,6 +83217,18 @@
"description": "Output only. The remote location for Cross-Site Interconnect wires. This specifies an\nInterconnectLocation city (metropolitan area designator), which itself\nmay match multiple InterconnectLocations.",
"readOnly": true,
"type": "string"
+ },
+ "maxDynamicPathBandwidthGbps": {
+ "description": "Output only. The maximum unmetered bandwidth for dynamic paths allowable per\nWireGroup for this metro.",
+ "format": "int64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "maxFixedPathBandwidthGbps": {
+ "description": "Output only. The maximum unmetered bandwidth for fixed paths allowable per WireGroup\nfor this metro.",
+ "format": "int64",
+ "readOnly": true,
+ "type": "string"
}
},
"type": "object"
@@ -83310,6 +84798,179 @@
},
"type": "object"
},
+ "ListVmExtensionStatesResponse": {
+ "id": "ListVmExtensionStatesResponse",
+ "properties": {
+ "etag": {
+ "description": "Output only. Fingerprint of this resource. A hash of the contents stored\nin this object. This field is used in optimistic locking. This field will\nbe ignored when inserting a VmExtensionPolicy. An up-to-date\nfingerprint must be provided in order to update the VmExtensionPolicy.\n\nTo see the latest value of the fingerprint, make a get() request to\nretrieve a VmExtensionPolicy.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Output only. Unique identifier for the resource; defined by the server.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "items": {
+ "description": "Output only. A list of VM extension policy resources.",
+ "items": {
+ "$ref": "VmExtensionState"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
+ "kind": {
+ "default": "compute#vmExtensionStatesList",
+ "description": "Output only. Type of resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "Output only. This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "Output only. Server-defined URL for this resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "unreachables": {
+ "description": "Output only. Unreachable resources.",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
+ "warning": {
+ "description": "Output only. Informational warning message.",
+ "properties": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "LIST_OVERHEAD_QUOTA_EXCEED",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "QUOTA_INFO_UNAVAILABLE",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDeprecated": [
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ true,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed\noperation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as\ndeprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as\nexperimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden.\nDeprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "Quota information is not available to client requests (e.g:\nregions.list).",
+ "The user attempted to use a resource that requires a TOS they have not\naccepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "type": "string"
+ },
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }]",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
+ }
+ },
+ "readOnly": true,
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
"LocalDisk": {
"id": "LocalDisk",
"properties": {
@@ -84446,10 +86107,11 @@
"readOnly": true
},
"targetStatus": {
- "description": "Output only. [Output Only] The eventual status of the instance. The instance group\nmanager will not be identified as stable till each managed instance reaches\nits targetStatus.",
+ "description": "Output only. The eventual status of the instance. The instance group\nmanager will not be identified as stable till each managed instance reaches\nits targetStatus.",
"enum": [
"ABANDONED",
"DELETED",
+ "INVALID",
"RUNNING",
"STOPPED",
"SUSPENDED"
@@ -84457,6 +86119,7 @@
"enumDescriptions": [
"The managed instance will eventually be ABANDONED, i.e. dissociated\nfrom the managed instance group.",
"The managed instance will eventually be DELETED.",
+ "Only present to map the STATUS_INVALID value.",
"The managed instance will eventually reach status RUNNING.",
"The managed instance will eventually reach status TERMINATED.",
"The managed instance will eventually reach status SUSPENDED."
@@ -86843,6 +88506,7 @@
"description": "Type of network endpoints in this network endpoint group. Can be one ofGCE_VM_IP, GCE_VM_IP_PORT,NON_GCP_PRIVATE_IP_PORT, INTERNET_FQDN_PORT,INTERNET_IP_PORT, SERVERLESS,PRIVATE_SERVICE_CONNECT, GCE_VM_IP_PORTMAP.",
"enum": [
"GCE_VM_IP",
+ "GCE_VM_IP_DEDICATED_BACKEND",
"GCE_VM_IP_PORT",
"GCE_VM_IP_PORTMAP",
"INTERNET_FQDN_PORT",
@@ -86853,6 +88517,7 @@
],
"enumDescriptions": [
"The network endpoint is represented by an IP address.",
+ "The network endpoint for targeting a specific network interface of a\nVM instance in configurations with multiple network interfaces on the\nsame network.",
"The network endpoint is represented by IP address and port pair.",
"The network endpoint is represented by an IP, Port and Client Destination\nPort.",
"The network endpoint is represented by fully qualified domain name and\nport.",
@@ -92906,6 +94571,11 @@
},
"type": "object"
},
+ "getHealthOperationMetadata": {
+ "$ref": "GetHealthOperationMetadata",
+ "description": "Output only. Metadata for GetHealth operations.",
+ "readOnly": true
+ },
"getVersionOperationMetadata": {
"$ref": "GetVersionOperationMetadata"
},
@@ -96968,6 +98638,495 @@
},
"type": "object"
},
+ "RecoverableSnapshot": {
+ "description": "Represents a RecoverableSnapshot resource.\n\nA RecoverableSnapshot represents a snapshot in recycle bin.",
+ "id": "RecoverableSnapshot",
+ "properties": {
+ "creationTimestamp": {
+ "description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional. An optional description of this resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
+ "format": "uint64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#recoverableSnapshot",
+ "description": "Output only. [Output Only] Type of the resource. Alwayscompute#recoverableSnapshot for RecoverableSnapshot\nresources.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. Identifier. Name of the recoverable snapshot generated on the deletion of the snapshot.\nThe name will be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name will be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter will be a lowercase letter, and all following characters can be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "readOnly": true,
+ "type": "string"
+ },
+ "originalResource": {
+ "$ref": "RecoverableSnapshotOriginalSnapshot",
+ "description": "Output only. Output Only] The original snapshot resource.",
+ "readOnly": true
+ },
+ "purgeTimestamp": {
+ "description": "Output only. [Output Only] Purge timestamp of recoverable snapshot inRFC3339\ntext format.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "satisfiesPzi": {
+ "description": "Output only. [Output Only] Reserved for future use.",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "satisfiesPzs": {
+ "description": "Output only. [Output Only] Reserved for future use.",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "selfLink": {
+ "description": "Output only. [Output Only] Server-defined URL for the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "selfLinkWithId": {
+ "description": "Output only. [Output Only] Server-defined URL for this resource's resource id.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "status": {
+ "description": "Output only. [Output Only] Status of the recoverable snapshot.",
+ "enum": [
+ "CREATING",
+ "DELETING",
+ "FAILED",
+ "READY",
+ "RECOVERING",
+ "UNKNOWN"
+ ],
+ "enumDescriptions": [
+ "Recoverable Snapshot creation is in progress.",
+ "Recovered Snapshot is currently being deleted.",
+ "Recoverable Snapshot creation failed.",
+ "Recoverable Snapshot has been created successfully.",
+ "Recoverable Snapshot is currently being recovered.",
+ ""
+ ],
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RecoverableSnapshotList": {
+ "id": "RecoverableSnapshotList",
+ "properties": {
+ "etag": {
+ "type": "string"
+ },
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of RecoverableSnapshots resources.",
+ "items": {
+ "$ref": "RecoverableSnapshot"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "compute#recoverableSnapshotList",
+ "description": "Output only. [Output Only] Type of resource. Alwayscompute#recoverableSnapshotList for lists of\nrecoverablesnapshots.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "Output only. [Output Only] Server-defined URL for this resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "unreachables": {
+ "description": "Output only. [Output Only] Unreachable resources.\nend_interface: MixerListResponseWithEtagBuilder",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "LIST_OVERHEAD_QUOTA_EXCEED",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "QUOTA_INFO_UNAVAILABLE",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDeprecated": [
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ true,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed\noperation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as\ndeprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as\nexperimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden.\nDeprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "Quota information is not available to client requests (e.g:\nregions.list).",
+ "The user attempted to use a resource that requires a TOS they have not\naccepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "type": "string"
+ },
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }]",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "RecoverableSnapshotOriginalSnapshot": {
+ "id": "RecoverableSnapshotOriginalSnapshot",
+ "properties": {
+ "architecture": {
+ "description": "Output only. [Output Only] The architecture of the snapshot. Valid values are\nARM64 or X86_64.",
+ "enum": [
+ "ARCHITECTURE_UNSPECIFIED",
+ "ARM64",
+ "X86_64"
+ ],
+ "enumDescriptions": [
+ "Default value indicating Architecture is not set.",
+ "Machines with architecture ARM64",
+ "Machines with architecture X86_64"
+ ],
+ "readOnly": true,
+ "type": "string"
+ },
+ "autoCreated": {
+ "description": "Output only. [Output Only] Set to true if snapshots are automatically created by\napplying resource policy on the target disk.",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "chainName": {
+ "description": "Creates the new snapshot in the snapshot chain labeled with the\nspecified name. The chain name must be 1-63 characters long and comply\nwith RFC1035. This is an uncommon option only for advanced service\nowners who needs to create separate snapshot chains, for example,\nfor chargeback tracking. When you describe your snapshot resource, this\nfield is visible only if it has a non-empty value.",
+ "type": "string"
+ },
+ "creationSizeBytes": {
+ "description": "Output only. [Output Only] Size in bytes of the snapshot at creation time.",
+ "format": "int64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "creationTimestamp": {
+ "description": "Output only. [Output Only] Creation timestamp inRFC3339 text format.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "deletionTimestamp": {
+ "description": "Output only. [Output Only] Deletion timestamp of snapshot inRFC3339 text format.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "description": {
+ "description": "An optional description of this resource.",
+ "type": "string"
+ },
+ "diskSizeGb": {
+ "description": "Output only. [Output Only] Size of the source disk, specified in GB.",
+ "format": "int64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "downloadBytes": {
+ "description": "Output only. [Output Only] Number of bytes downloaded to restore a snapshot to a disk.",
+ "format": "int64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "enableConfidentialCompute": {
+ "description": "Output only. Whether this snapshot is created from a confidential compute mode disk.\n[Output Only]: This field is not set by user, but from source disk.",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "guestOsFeatures": {
+ "description": "Output only. [Output Only] A list of features to enable on the guest operating system.\nApplicable only for bootable images. Read \nEnabling guest operating system features to see a list of available\noptions.",
+ "items": {
+ "$ref": "GuestOsFeature"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
+ "id": {
+ "description": "Output only. [Output Only] The unique identifier for the original snapshot. This\nidentifier is defined by the server.",
+ "format": "uint64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "labelFingerprint": {
+ "description": "A fingerprint for the labels being applied to this snapshot, which is\nessentially a hash of the labels set used for optimistic locking. The\nfingerprint is initially generated by Compute Engine and changes after\nevery request to modify or update labels. You must always provide an\nup-to-date fingerprint hash in order to update or change labels,\notherwise the request will fail with error412 conditionNotMet.\n\nTo see the latest fingerprint, make a get() request to\nretrieve a snapshot.",
+ "format": "byte",
+ "type": "string"
+ },
+ "labels": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Labels to apply to this snapshot. These can be later modified by\nthe setLabels method.\nLabel values may be empty.",
+ "type": "object"
+ },
+ "licenseCodes": {
+ "description": "Output only. [Output Only] Integer license codes indicating which licenses are\nattached to this snapshot.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
+ "licenses": {
+ "description": "Output only. [Output Only] A list of public visible licenses that apply to this\nsnapshot.",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
+ "maxRetentionDays": {
+ "description": "Number of days the snapshot should be retained before being deleted\nautomatically.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "name": {
+ "description": "Name of the original snapshot provided by the client. The name must be\n1-63 characters long, and comply with RFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must\nbe a dash, lowercase letter, or digit, except the last character, which\ncannot be a dash.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ },
+ "region": {
+ "description": "Output only. [Output Only] URL of the region where the snapshot resides. Only\napplicable for regional snapshots.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "satisfiesPzi": {
+ "description": "Output only. Reserved for future use.",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "satisfiesPzs": {
+ "description": "Output only. [Output Only] Reserved for future use.",
+ "readOnly": true,
+ "type": "boolean"
+ },
+ "selfLink": {
+ "description": "Output only. [Output Only] Server-defined URL for the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "selfLinkWithId": {
+ "description": "Output only. [Output Only] Server-defined URL for this resource's resource id.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "snapshotEncryptionKey": {
+ "$ref": "CustomerEncryptionKey",
+ "description": "Encrypts the snapshot using acustomer-supplied\nencryption key.\n\nAfter you encrypt a snapshot using a customer-supplied key, you must\nprovide the same key if you use the snapshot later. For example, you must\nprovide the encryption key when you create a disk from the encrypted\nsnapshot in a future request.\n\nCustomer-supplied encryption keys do not protect access to metadata\nof the snapshot.\n\nIf you do not provide an encryption key when creating the snapshot, then\nthe snapshot will be encrypted using an automatically generated key and\nyou do not need to provide a key to use the snapshot later."
+ },
+ "snapshotGroupId": {
+ "description": "Output only. [Output Only] The unique ID of the snapshot group that this snapshot\nbelongs to. The usage of snapshot group feature is restricted.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "snapshotGroupName": {
+ "description": "Output only. [Output only] The snapshot group that this snapshot belongs to. The usage\nof snapshot group feature is restricted.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "snapshotType": {
+ "description": "Indicates the type of the snapshot.",
+ "enum": [
+ "ARCHIVE",
+ "STANDARD"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "type": "string"
+ },
+ "sourceDisk": {
+ "description": "The source disk used to create this snapshot.",
+ "type": "string"
+ },
+ "sourceDiskEncryptionKey": {
+ "$ref": "CustomerEncryptionKey",
+ "description": "The customer-supplied\nencryption key of the source disk. Required if the source disk is\nprotected by a customer-supplied encryption key."
+ },
+ "sourceDiskForRecoveryCheckpoint": {
+ "description": "The source disk whose recovery checkpoint will be used to create this\nsnapshot.",
+ "type": "string"
+ },
+ "sourceDiskId": {
+ "description": "Output only. [Output Only] The ID value of the disk used to create this snapshot",
+ "readOnly": true,
+ "type": "string"
+ },
+ "sourceInstantSnapshot": {
+ "description": "The source instant snapshot used to create this snapshot.",
+ "type": "string"
+ },
+ "sourceInstantSnapshotEncryptionKey": {
+ "$ref": "CustomerEncryptionKey",
+ "description": "Customer provided encryption key when creating Snapshot from Instant\nSnapshot."
+ },
+ "sourceInstantSnapshotId": {
+ "description": "Output only. [Output Only] The unique ID of the instant snapshot used to create this\nsnapshot. This value identifies the exact instant snapshot that was used\nto create this persistent disk. For example, if you created the\npersistent disk from an instant snapshot that was later deleted and\nrecreated under the same name, the source instant snapshot ID would\nidentify the exact instant snapshot that was used.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "sourceSnapshotSchedulePolicy": {
+ "description": "Output only. [Output Only] URL of the resource policy which created this\nscheduled snapshot.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "sourceSnapshotSchedulePolicyId": {
+ "description": "Output only. [Output Only] ID of the resource policy which created this\nscheduled snapshot.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "storageBytes": {
+ "description": "Output only. [Output Only] A size of the storage used by the snapshot.",
+ "format": "int64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "storageBytesStatus": {
+ "description": "Output only. [Deprecated] Instead, check the storageBytes field. After\nsnapshot creation, the storageBytesStatus field is alwaysUP_TO_DATE.\n[Output Only] An indicator whether storageBytes is in a\nstable state or it is being adjusted as a result of shared storage\nreallocation. This status can either be unset, meaning the snapshot is\nbeing created, or UP_TO_DATE, meaning the size of the\nsnapshot is up-to-date.",
+ "enum": [
+ "UPDATING",
+ "UP_TO_DATE"
+ ],
+ "enumDescriptions": [
+ "",
+ ""
+ ],
+ "readOnly": true,
+ "type": "string"
+ },
+ "storageLocations": {
+ "description": "Cloud Storage bucket storage location of the snapshot (regional or\nmulti-regional).",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
"Reference": {
"description": "Represents a reference to a resource.",
"id": "Reference",
@@ -99355,10 +101514,12 @@
},
"confidentialComputeType": {
"enum": [
+ "CONFIDENTIAL_COMPUTE_TYPE_BMSAI",
"CONFIDENTIAL_COMPUTE_TYPE_TDX",
"CONFIDENTIAL_COMPUTE_TYPE_UNSPECIFIED"
],
"enumDescriptions": [
+ "Bare Metal Secure AI.",
"Intel Trust Domain Extensions.",
""
],
@@ -109544,302 +111705,347 @@
},
"type": "object"
},
- "SnapshotGroup": {
- "description": "Represents a SnapshotGroup resource.\n\nA snapshot group is a set of snapshots that represents a point in time state\nof a consistency group.",
- "id": "SnapshotGroup",
- "properties": {
- "creationTimestamp": {
- "description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
- "readOnly": true,
- "type": "string"
- },
- "description": {
- "description": "Optional. An optional description of this resource. Provide this property when you\ncreate the resource.",
- "type": "string"
- },
- "id": {
- "description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
- "format": "uint64",
- "readOnly": true,
- "type": "string"
- },
- "kind": {
- "default": "compute#snapshotGroup",
- "description": "Output only. [Output Only] Type of the resource. Alwayscompute#snapshotGroup for SnapshotGroup\nresources.",
- "readOnly": true,
- "type": "string"
- },
- "name": {
- "description": "Identifier. Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
- "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
- "type": "string"
- },
- "selfLink": {
- "description": "Output only. [Output Only] Server-defined URL for the resource.",
- "readOnly": true,
- "type": "string"
- },
- "selfLinkWithId": {
- "description": "Output only. [Output Only] Server-defined URL for this resource's resource id.",
- "readOnly": true,
- "type": "string"
- },
- "sourceInfo": {
- "$ref": "SnapshotGroupSourceInfo",
- "description": "Output only. [Output Only]",
- "readOnly": true
- },
- "sourceInstantSnapshotGroup": {
- "description": "Input field for the source instant snapshot group.",
- "type": "string"
- },
- "sourceInstantSnapshotGroupInfo": {
- "$ref": "SnapshotGroupSourceInstantSnapshotGroupInfo",
- "description": "Output only. [Output Only]",
- "readOnly": true
- },
- "status": {
- "description": "Output only. [Output Only]",
- "enum": [
- "CREATING",
- "DELETING",
- "FAILED",
- "INVALID",
- "READY",
- "UNKNOWN",
- "UPLOADING"
- ],
- "enumDescriptions": [
- "",
- "",
- "",
- "",
- "",
- "",
- ""
- ],
- "readOnly": true,
- "type": "string"
- }
- },
- "type": "object"
- },
- "SnapshotGroupParameters": {
- "id": "SnapshotGroupParameters",
+ "SnapshotGroup": {
+ "description": "Represents a SnapshotGroup resource.\n\nA snapshot group is a set of snapshots that represents a point in time state\nof a consistency group.",
+ "id": "SnapshotGroup",
+ "properties": {
+ "creationTimestamp": {
+ "description": "Output only. [Output Only] Creation timestamp inRFC3339\ntext format.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional. An optional description of this resource. Provide this property when you\ncreate the resource.",
+ "type": "string"
+ },
+ "id": {
+ "description": "Output only. [Output Only] The unique identifier for the resource. This identifier is\ndefined by the server.",
+ "format": "uint64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "kind": {
+ "default": "compute#snapshotGroup",
+ "description": "Output only. [Output Only] Type of the resource. Alwayscompute#snapshotGroup for SnapshotGroup\nresources.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "Identifier. Name of the resource; provided by the client when the resource is created.\nThe name must be 1-63 characters long, and comply withRFC1035.\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.",
+ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "Output only. [Output Only] Server-defined URL for the resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "selfLinkWithId": {
+ "description": "Output only. [Output Only] Server-defined URL for this resource's resource id.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "sourceInfo": {
+ "$ref": "SnapshotGroupSourceInfo",
+ "description": "Output only. [Output Only]",
+ "readOnly": true
+ },
+ "sourceInstantSnapshotGroup": {
+ "description": "Input field for the source instant snapshot group.",
+ "type": "string"
+ },
+ "sourceInstantSnapshotGroupInfo": {
+ "$ref": "SnapshotGroupSourceInstantSnapshotGroupInfo",
+ "description": "Output only. [Output Only]",
+ "readOnly": true
+ },
+ "status": {
+ "description": "Output only. [Output Only]",
+ "enum": [
+ "CREATING",
+ "DELETING",
+ "FAILED",
+ "INVALID",
+ "READY",
+ "UNKNOWN",
+ "UPLOADING"
+ ],
+ "enumDescriptions": [
+ "",
+ "",
+ "",
+ "",
+ "",
+ "",
+ ""
+ ],
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SnapshotGroupParameters": {
+ "id": "SnapshotGroupParameters",
+ "properties": {
+ "replicaZones": {
+ "description": "URLs of the zones where disks should be replicated to. Only applicable\nfor regional resources.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "sourceSnapshotGroup": {
+ "description": "The source snapshot group used to create disks. You can provide this as a\npartial or full URL to the resource. For example, the following are valid\nvalues:\n \n \n - https://www.googleapis.com/compute/v1/projects/project/global/snapshotGroups/snapshotGroup \n - projects/project/global/snapshotGroups/snapshotGroup\n - global/snapshotGroups/snapshotGroup",
+ "type": "string"
+ },
+ "type": {
+ "description": "URL of the disk type resource describing which disk type to use to create\ndisks. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk\ntypes.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SnapshotGroupSourceInfo": {
+ "id": "SnapshotGroupSourceInfo",
+ "properties": {
+ "consistencyGroup": {
+ "readOnly": true,
+ "type": "string"
+ },
+ "consistencyGroupId": {
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SnapshotGroupSourceInstantSnapshotGroupInfo": {
+ "id": "SnapshotGroupSourceInstantSnapshotGroupInfo",
+ "properties": {
+ "instantSnapshotGroup": {
+ "readOnly": true,
+ "type": "string"
+ },
+ "instantSnapshotGroupId": {
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "SnapshotList": {
+ "description": "Contains a list of Snapshot resources.",
+ "id": "SnapshotList",
+ "properties": {
+ "id": {
+ "description": "[Output Only] Unique identifier for the resource; defined by the server.",
+ "type": "string"
+ },
+ "items": {
+ "description": "A list of Snapshot resources.",
+ "items": {
+ "$ref": "Snapshot"
+ },
+ "type": "array"
+ },
+ "kind": {
+ "default": "compute#snapshotList",
+ "description": "Output only. Type of resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "nextPageToken": {
+ "description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
+ "type": "string"
+ },
+ "selfLink": {
+ "description": "Output only. [Output Only] Server-defined URL for this resource.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "warning": {
+ "description": "[Output Only] Informational warning message.",
+ "properties": {
+ "code": {
+ "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.",
+ "enum": [
+ "CLEANUP_FAILED",
+ "DEPRECATED_RESOURCE_USED",
+ "DEPRECATED_TYPE_USED",
+ "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
+ "EXPERIMENTAL_TYPE_USED",
+ "EXTERNAL_API_WARNING",
+ "FIELD_VALUE_OVERRIDEN",
+ "INJECTED_KERNELS_DEPRECATED",
+ "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
+ "LARGE_DEPLOYMENT_WARNING",
+ "LIST_OVERHEAD_QUOTA_EXCEED",
+ "MISSING_TYPE_DEPENDENCY",
+ "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
+ "NEXT_HOP_CANNOT_IP_FORWARD",
+ "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
+ "NEXT_HOP_INSTANCE_NOT_FOUND",
+ "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
+ "NEXT_HOP_NOT_RUNNING",
+ "NOT_CRITICAL_ERROR",
+ "NO_RESULTS_ON_PAGE",
+ "PARTIAL_SUCCESS",
+ "QUOTA_INFO_UNAVAILABLE",
+ "REQUIRED_TOS_AGREEMENT",
+ "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
+ "RESOURCE_NOT_DELETED",
+ "SCHEMA_VALIDATION_IGNORED",
+ "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
+ "UNDECLARED_PROPERTIES",
+ "UNREACHABLE"
+ ],
+ "enumDeprecated": [
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ true,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false,
+ false
+ ],
+ "enumDescriptions": [
+ "Warning about failed cleanup of transient changes made by a failed\noperation.",
+ "A link to a deprecated resource was created.",
+ "When deploying and at least one of the resources has a type marked as\ndeprecated",
+ "The user created a boot disk that is larger than image size.",
+ "When deploying and at least one of the resources has a type marked as\nexperimental",
+ "Warning that is present in an external api call",
+ "Warning that value of a field has been overridden.\nDeprecated unused field.",
+ "The operation involved use of an injected kernel, which is deprecated.",
+ "A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
+ "When deploying a deployment with a exceedingly large number of resources",
+ "Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
+ "A resource depends on a missing type",
+ "The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
+ "The route's next hop instance cannot ip forward.",
+ "The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
+ "The route's nextHopInstance URL refers to an instance that does not exist.",
+ "The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
+ "The route's next hop instance does not have a status of RUNNING.",
+ "Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
+ "No results are present on a particular list page.",
+ "Success is reported, but some results may be missing due to errors",
+ "Quota information is not available to client requests (e.g:\nregions.list).",
+ "The user attempted to use a resource that requires a TOS they have not\naccepted.",
+ "Warning that a resource is in use.",
+ "One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
+ "When a resource schema validation is ignored.",
+ "Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
+ "When undeclared properties in the schema are present",
+ "A given scope cannot be reached."
+ ],
+ "type": "string"
+ },
+ "data": {
+ "description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }]",
+ "items": {
+ "properties": {
+ "key": {
+ "description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).",
+ "type": "string"
+ },
+ "value": {
+ "description": "[Output Only] A warning data value corresponding to the key.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "[Output Only] A human-readable description of the warning code.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "SnapshotParams": {
+ "description": "Additional snapshot params.",
+ "id": "SnapshotParams",
"properties": {
- "replicaZones": {
- "description": "URLs of the zones where disks should be replicated to. Only applicable\nfor regional resources.",
- "items": {
+ "resourceManagerTags": {
+ "additionalProperties": {
"type": "string"
},
- "type": "array"
- },
- "sourceSnapshotGroup": {
- "description": "The source snapshot group used to create disks. You can provide this as a\npartial or full URL to the resource. For example, the following are valid\nvalues:\n \n \n - https://www.googleapis.com/compute/v1/projects/project/global/snapshotGroups/snapshotGroup \n - projects/project/global/snapshotGroups/snapshotGroup\n - global/snapshotGroups/snapshotGroup",
- "type": "string"
- },
- "type": {
- "description": "URL of the disk type resource describing which disk type to use to create\ndisks. Provide this when creating the disk. For example:projects/project/zones/zone/diskTypes/pd-ssd. See Persistent disk\ntypes.",
- "type": "string"
+ "description": "Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have\nthe same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.",
+ "type": "object"
}
},
"type": "object"
},
- "SnapshotGroupSourceInfo": {
- "id": "SnapshotGroupSourceInfo",
+ "SnapshotRecycleBinPolicy": {
+ "description": "Represents the singleton resource Snapshot Recycle Bin Policy that\nconfigures the retention duration for snapshots in the recycle bin.\n\nYou can configure the retention duration for snapshots in the recycle bin\nat the project or organization level. If you configure the policy at the\norganization level, all projects in that organization will share the same\npolicy. If you configure the policy at the project level it will be merged\nwith org level policy (if any) and the snapshots in that project will use\nthat policy.",
+ "id": "SnapshotRecycleBinPolicy",
"properties": {
- "consistencyGroup": {
- "readOnly": true,
- "type": "string"
+ "rules": {
+ "additionalProperties": {
+ "$ref": "SnapshotRecycleBinPolicyRule"
+ },
+ "description": "The rules for the snapshot recycle bin policy. The key is either 'default'\nor namespacedName of the TagValue which can be in the format:\n`{organization_id}/{tag_key_short_name}/{tag_value_short_name}` or\n`{project_id}/{tag_key_short_name}/{tag_value_short_name}` or\n`{project_number}/{tag_key_short_name}/{tag_value_short_name}`. The default\nrule is applied if snapshots do not have any of these tags.\n The value is the rule for the key.",
+ "type": "object"
},
- "consistencyGroupId": {
+ "systemRules": {
+ "additionalProperties": {
+ "$ref": "SnapshotRecycleBinPolicyRule"
+ },
+ "description": "Output only. The system rules for snapshot recycle bin policy.\nDefines the default rule that applies if no customer-defined rule matches.",
"readOnly": true,
- "type": "string"
+ "type": "object"
}
},
"type": "object"
},
- "SnapshotGroupSourceInstantSnapshotGroupInfo": {
- "id": "SnapshotGroupSourceInstantSnapshotGroupInfo",
+ "SnapshotRecycleBinPolicyRule": {
+ "description": "A rule that defines the retention policy for snapshots in the recycle bin.",
+ "id": "SnapshotRecycleBinPolicyRule",
"properties": {
- "instantSnapshotGroup": {
- "readOnly": true,
- "type": "string"
- },
- "instantSnapshotGroupId": {
- "readOnly": true,
- "type": "string"
+ "standardSnapshots": {
+ "$ref": "SnapshotRecycleBinPolicyRuleRuleConfig",
+ "description": "The rule config for standard snapshots."
}
},
"type": "object"
},
- "SnapshotList": {
- "description": "Contains a list of Snapshot resources.",
- "id": "SnapshotList",
+ "SnapshotRecycleBinPolicyRuleRuleConfig": {
+ "description": "The rule config for snapshots in the recycle bin.",
+ "id": "SnapshotRecycleBinPolicyRuleRuleConfig",
"properties": {
- "id": {
- "description": "[Output Only] Unique identifier for the resource; defined by the server.",
- "type": "string"
- },
- "items": {
- "description": "A list of Snapshot resources.",
- "items": {
- "$ref": "Snapshot"
- },
- "type": "array"
- },
- "kind": {
- "default": "compute#snapshotList",
- "description": "Output only. Type of resource.",
- "readOnly": true,
- "type": "string"
- },
- "nextPageToken": {
- "description": "[Output Only] This token allows you to get the next page of results for\nlist requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for\nthe query parameter pageToken in the next list request.\nSubsequent list requests will have their own nextPageToken to\ncontinue paging through the results.",
- "type": "string"
- },
- "selfLink": {
- "description": "Output only. [Output Only] Server-defined URL for this resource.",
- "readOnly": true,
+ "retentionDurationDays": {
+ "description": "The retention duration for snapshots in the recycle bin after which the\nsnapshots are automatically deleted from recycle bin.",
+ "format": "int64",
"type": "string"
- },
- "warning": {
- "description": "[Output Only] Informational warning message.",
- "properties": {
- "code": {
- "description": "[Output Only] A warning code, if applicable. For example, Compute\nEngine returns NO_RESULTS_ON_PAGE if there\nare no results in the response.",
- "enum": [
- "CLEANUP_FAILED",
- "DEPRECATED_RESOURCE_USED",
- "DEPRECATED_TYPE_USED",
- "DISK_SIZE_LARGER_THAN_IMAGE_SIZE",
- "EXPERIMENTAL_TYPE_USED",
- "EXTERNAL_API_WARNING",
- "FIELD_VALUE_OVERRIDEN",
- "INJECTED_KERNELS_DEPRECATED",
- "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB",
- "LARGE_DEPLOYMENT_WARNING",
- "LIST_OVERHEAD_QUOTA_EXCEED",
- "MISSING_TYPE_DEPENDENCY",
- "NEXT_HOP_ADDRESS_NOT_ASSIGNED",
- "NEXT_HOP_CANNOT_IP_FORWARD",
- "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE",
- "NEXT_HOP_INSTANCE_NOT_FOUND",
- "NEXT_HOP_INSTANCE_NOT_ON_NETWORK",
- "NEXT_HOP_NOT_RUNNING",
- "NOT_CRITICAL_ERROR",
- "NO_RESULTS_ON_PAGE",
- "PARTIAL_SUCCESS",
- "QUOTA_INFO_UNAVAILABLE",
- "REQUIRED_TOS_AGREEMENT",
- "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING",
- "RESOURCE_NOT_DELETED",
- "SCHEMA_VALIDATION_IGNORED",
- "SINGLE_INSTANCE_PROPERTY_TEMPLATE",
- "UNDECLARED_PROPERTIES",
- "UNREACHABLE"
- ],
- "enumDeprecated": [
- false,
- false,
- false,
- false,
- false,
- false,
- true,
- false,
- false,
- false,
- false,
- false,
- false,
- false,
- false,
- false,
- false,
- false,
- false,
- false,
- false,
- false,
- false,
- false,
- false,
- false,
- false,
- false,
- false
- ],
- "enumDescriptions": [
- "Warning about failed cleanup of transient changes made by a failed\noperation.",
- "A link to a deprecated resource was created.",
- "When deploying and at least one of the resources has a type marked as\ndeprecated",
- "The user created a boot disk that is larger than image size.",
- "When deploying and at least one of the resources has a type marked as\nexperimental",
- "Warning that is present in an external api call",
- "Warning that value of a field has been overridden.\nDeprecated unused field.",
- "The operation involved use of an injected kernel, which is deprecated.",
- "A WEIGHTED_MAGLEV backend service is associated with a health check that is\nnot of type HTTP/HTTPS/HTTP2.",
- "When deploying a deployment with a exceedingly large number of resources",
- "Resource can't be retrieved due to list overhead quota exceed\nwhich captures the amount of resources filtered out by\nuser-defined list filter.",
- "A resource depends on a missing type",
- "The route's nextHopIp address is not assigned to an instance on the\nnetwork.",
- "The route's next hop instance cannot ip forward.",
- "The route's nextHopInstance URL refers to an instance that does not have an\nipv6 interface on the same network as the route.",
- "The route's nextHopInstance URL refers to an instance that does not exist.",
- "The route's nextHopInstance URL refers to an instance that is not on the\nsame network as the route.",
- "The route's next hop instance does not have a status of RUNNING.",
- "Error which is not critical. We decided to continue the process despite\nthe mentioned error.",
- "No results are present on a particular list page.",
- "Success is reported, but some results may be missing due to errors",
- "Quota information is not available to client requests (e.g:\nregions.list).",
- "The user attempted to use a resource that requires a TOS they have not\naccepted.",
- "Warning that a resource is in use.",
- "One or more of the resources set to auto-delete could not be deleted\nbecause they were in use.",
- "When a resource schema validation is ignored.",
- "Instance template used in instance group manager is valid as such, but\nits application does not make a lot of sense, because it allows only\nsingle instance in instance group.",
- "When undeclared properties in the schema are present",
- "A given scope cannot be reached."
- ],
- "type": "string"
- },
- "data": {
- "description": "[Output Only] Metadata about this warning in key:\nvalue format. For example:\n\n\"data\": [\n {\n \"key\": \"scope\",\n \"value\": \"zones/us-east1-d\"\n }]",
- "items": {
- "properties": {
- "key": {
- "description": "[Output Only] A key that provides more detail on the warning being\nreturned. For example, for warnings where there are no results in a list\nrequest for a particular zone, this key might be scope and\nthe key value might be the zone name. Other examples might be a key\nindicating a deprecated resource and a suggested replacement, or a\nwarning about invalid network settings (for example, if an instance\nattempts to perform IP forwarding but is not enabled for IP forwarding).",
- "type": "string"
- },
- "value": {
- "description": "[Output Only] A warning data value corresponding to the key.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "type": "array"
- },
- "message": {
- "description": "[Output Only] A human-readable description of the warning code.",
- "type": "string"
- }
- },
- "type": "object"
- }
- },
- "type": "object"
- },
- "SnapshotParams": {
- "description": "Additional snapshot params.",
- "id": "SnapshotParams",
- "properties": {
- "resourceManagerTags": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Input only. Resource manager tags to be bound to the snapshot. Tag keys and values have\nthe same definition as resource\nmanager tags. Keys and values can be either in numeric format,\nsuch as `tagKeys/{tag_key_id}` and `tagValues/{tag_value_id}` or in\nnamespaced format such as `{org_id|project_id}/{tag_key_short_name}` and\n`{tag_value_short_name}`. The field is ignored (both PUT &\nPATCH) when empty.",
- "type": "object"
}
},
"type": "object"
@@ -109946,6 +112152,17 @@
},
"type": "object"
},
+ "SnapshotsGetEffectiveRecycleBinRuleResponse": {
+ "id": "SnapshotsGetEffectiveRecycleBinRuleResponse",
+ "properties": {
+ "retentionDurationDays": {
+ "description": "The retention duration of the snapshot in recycle bin.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"SnapshotsScopedList": {
"id": "SnapshotsScopedList",
"properties": {
@@ -113415,10 +115632,14 @@
"description": "Configures subnet mask resolution for this subnetwork.",
"enum": [
"ARP_ALL_RANGES",
+ "ARP_BROADCAST_PRIMARY_RANGE",
+ "ARP_BROADCAST_PRIMARY_RANGE_WITH_LEARNING",
"ARP_PRIMARY_RANGE"
],
"enumDescriptions": [
"All ranges assigned to the VM NIC will respond to ARP.",
+ "VMs will receive an ARP response from a VM instance owning the target IP\naddress within the subnetwork's primary CIDR range, if such a VM instance\nexists and is running.",
+ "Combines ARP_BROADCAST_PRIMARY_RANGE with MAC learning. Enables cache\nmapping between IP addresses and custom MAC addresses of instances and\nuse of it to set the correct destination MAC address. If this option is\nchosen, the subnetwork must have /24 or a smaller CIDR range.",
"Only the primary range of the VM NIC will respond to ARP."
],
"type": "string"
@@ -120433,6 +122654,83 @@
},
"type": "object"
},
+ "VmExtensionState": {
+ "description": "State of an extension on an instance.",
+ "id": "VmExtensionState",
+ "properties": {
+ "enforcementMsg": {
+ "description": "The status message of the extension if the extension fails to enforce.",
+ "type": "string"
+ },
+ "enforcementState": {
+ "description": "The enforcement state of the extension.\nIf the extension is not enforced yet, then the health status will not be\nspecified.",
+ "enum": [
+ "APPLYING_CONFIG",
+ "ENFORCEMENT_STATE_UNSPECIFIED",
+ "INCOMPATIBLE",
+ "INSTALLED",
+ "INSTALLING",
+ "INSTALL_FAILED",
+ "REMOVING",
+ "ROLLBACK_FAILED",
+ "ROLLED_BACK",
+ "ROLLING_BACK",
+ "SERVICE_DISABLED"
+ ],
+ "enumDescriptions": [
+ "A new configuration is being applied to the extension.\nDepending on each extensions' behavior, an extension restart might be\ninvolved in this process to get new configuration applied properly.",
+ "Enforcement state of the extension is unspecified.",
+ "None of the extension revisions of the given extension version is\ncompatible with the VM's architecture and Operating System.",
+ "The extension has been successfully installed.",
+ "The extension is being installed.",
+ "The installation of the extension failed, and there's no recorded stable\nextension revision to rollback to.",
+ "The extension is being removed from the resource.",
+ "The rollback of the extension failed.",
+ "The extension has been successfully rolled back.\n\nThis value describes the rollback state of the extension, not the health\nstatus. It's possible that the extension is rolled back to the last\nstable revision but still keeps crashing, e.g. there's a change to the\nVM and no extension revisions can run normally.",
+ "The extension is being rolled back to the last stable revision the system\nrecorded.",
+ "The service requiring this extension is disabled."
+ ],
+ "type": "string"
+ },
+ "healthMsg": {
+ "description": "The health status message of the extension.",
+ "type": "string"
+ },
+ "healthStatus": {
+ "description": "The health status of the extension.",
+ "enum": [
+ "CRASHED",
+ "HEALTH_STATUS_UNSPECIFIED",
+ "RUNNING",
+ "STARTING",
+ "STOPPED",
+ "STOPPING"
+ ],
+ "enumDescriptions": [
+ "The extension crashed.",
+ "Health status is unspecified.",
+ "The extension is running.",
+ "The extension is starting.",
+ "The extension is stopped.",
+ "The extension is stopping."
+ ],
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the extension.",
+ "type": "string"
+ },
+ "policyId": {
+ "description": "The id of the policy that is enforced on the extension.",
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of the extension.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"VpnGateway": {
"description": "Represents a HA VPN gateway.\n\nHA VPN is a high-availability (HA) Cloud VPN solution that lets you securely\nconnect your on-premises network to your Google Cloud Virtual Private Cloud\nnetwork through an IPsec VPN connection in a single region.\nFor more information about Cloud HA VPN solutions, see\nCloud VPN topologies .",
"id": "VpnGateway",
diff --git a/discovery/container-v1.json b/discovery/container-v1.json
index 597d3766f8f..d4f1fbea055 100644
--- a/discovery/container-v1.json
+++ b/discovery/container-v1.json
@@ -2811,7 +2811,7 @@
}
}
},
- "revision": "20260727",
+ "revision": "20260818",
"rootUrl": "https://container.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
@@ -7161,7 +7161,7 @@
"description": "Parameters for containerd customization."
},
"diskSizeGb": {
- "description": "Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.",
+ "description": "Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 15 GB for node pools running GKE versions 1.36.3-gke.1480000 or later. Or, for earlier versions, the smallest allowed disk size is 12 GB. If unspecified, the default disk size is 100GB.",
"format": "int32",
"type": "integer"
},
@@ -8768,6 +8768,14 @@
"description": "The default version for newly created clusters on the channel.",
"type": "string"
},
+ "previewVersions": {
+ "description": "Output only. List of preview versions for the channel.",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
"upgradeTargetVersion": {
"description": "The auto upgrade target version for clusters on the channel.",
"type": "string"
diff --git a/discovery/container-v1beta1.json b/discovery/container-v1beta1.json
index cff021a8cf2..76638d726c6 100644
--- a/discovery/container-v1beta1.json
+++ b/discovery/container-v1beta1.json
@@ -2837,7 +2837,7 @@
}
}
},
- "revision": "20260727",
+ "revision": "20260818",
"rootUrl": "https://container.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
@@ -3353,7 +3353,7 @@
"type": "string"
},
"diskSizeGb": {
- "description": "Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.",
+ "description": "Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 15 GB for node pools running GKE versions 1.36.3-gke.1480000 or later. Or, for earlier versions, the smallest allowed disk size is 12 GB. If unspecified, the default disk size is 100GB.",
"format": "int32",
"type": "integer"
},
@@ -7557,7 +7557,7 @@
"description": "Parameters for containerd customization."
},
"diskSizeGb": {
- "description": "Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.",
+ "description": "Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 15 GB for node pools running GKE versions 1.36.2-gke.2933000 or later. Or, for earlier versions, the smallest allowed disk size is 12 GB. If unspecified, the default disk size is 100GB.",
"format": "int32",
"type": "integer"
},
@@ -9263,6 +9263,14 @@
"description": "The default version for newly created clusters on the channel.",
"type": "string"
},
+ "previewVersions": {
+ "description": "Output only. List of preview versions for the channel.",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
"upgradeTargetVersion": {
"description": "The auto upgrade target version for clusters on the channel.",
"type": "string"
diff --git a/discovery/content-v2.1.json b/discovery/content-v2.1.json
deleted file mode 100644
index efcfa5a1958..00000000000
--- a/discovery/content-v2.1.json
+++ /dev/null
@@ -1,13682 +0,0 @@
-{
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/content": {
- "description": "Manage your product listings and accounts for Google Shopping"
- }
- }
- }
- },
- "basePath": "/content/v2.1/",
- "baseUrl": "https://shoppingcontent.googleapis.com/content/v2.1/",
- "batchPath": "batch",
- "canonicalName": "Shopping Content",
- "description": "This API is deprecated. Please use Merchant API instead: https://developers.google.com/merchant/api. ",
- "discoveryVersion": "v1",
- "documentationLink": "https://developers.google.com/shopping-content/v2/",
- "fullyEncodeReservedExpansion": true,
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "id": "content:v2.1",
- "kind": "discovery#restDescription",
- "mtlsRootUrl": "https://shoppingcontent.mtls.googleapis.com/",
- "name": "content",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "parameters": {
- "$.xgafv": {
- "description": "V1 error format.",
- "enum": [
- "1",
- "2"
- ],
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "location": "query",
- "type": "string"
- },
- "alt": {
- "default": "json",
- "description": "Data format for response.",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "location": "query",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "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"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "location": "query",
- "type": "string"
- },
- "prettyPrint": {
- "default": "true",
- "description": "Returns response with indentations and line breaks.",
- "location": "query",
- "type": "boolean"
- },
- "quotaUser": {
- "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
- "location": "query",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query",
- "type": "string"
- }
- },
- "protocol": "rest",
- "resources": {
- "accounts": {
- "methods": {
- "authinfo": {
- "description": "Returns information about the authenticated user.",
- "flatPath": "accounts/authinfo",
- "httpMethod": "GET",
- "id": "content.accounts.authinfo",
- "parameterOrder": [],
- "parameters": {},
- "path": "accounts/authinfo",
- "response": {
- "$ref": "AccountsAuthInfoResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "claimwebsite": {
- "description": "Claims the website of a Merchant Center sub-account. Merchant accounts with approved third-party CSSs aren't required to claim a website.",
- "flatPath": "{merchantId}/accounts/{accountId}/claimwebsite",
- "httpMethod": "POST",
- "id": "content.accounts.claimwebsite",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account whose website is claimed.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "overwrite": {
- "description": "Only available to selected merchants, for example multi-client accounts (MCAs) and their sub-accounts. When set to `True`, this option removes any existing claim on the requested website and replaces it with a claim from the account that makes the request.",
- "location": "query",
- "type": "boolean"
- }
- },
- "path": "{merchantId}/accounts/{accountId}/claimwebsite",
- "response": {
- "$ref": "AccountsClaimWebsiteResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "custombatch": {
- "description": "Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request.",
- "flatPath": "accounts/batch",
- "httpMethod": "POST",
- "id": "content.accounts.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "accounts/batch",
- "request": {
- "$ref": "AccountsCustomBatchRequest"
- },
- "response": {
- "$ref": "AccountsCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes a Merchant Center sub-account.",
- "flatPath": "{merchantId}/accounts/{accountId}",
- "httpMethod": "DELETE",
- "id": "content.accounts.delete",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "force": {
- "default": "false",
- "description": "Option to delete sub-accounts with products. The default value is false.",
- "location": "query",
- "type": "boolean"
- },
- "merchantId": {
- "description": "The ID of the managing account. This must be a multi-client account, and accountId must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/accounts/{accountId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves a Merchant Center account.",
- "flatPath": "{merchantId}/accounts/{accountId}",
- "httpMethod": "GET",
- "id": "content.accounts.get",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "view": {
- "description": "Controls which fields will be populated. Acceptable values are: \"merchant\" and \"css\". The default value is \"merchant\".",
- "enum": [
- "MERCHANT",
- "CSS"
- ],
- "enumDescriptions": [
- "Default. View is populated with Merchant Center fields.",
- "View is populated with Comparison Shopping Services fields."
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/accounts/{accountId}",
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "insert": {
- "description": "Creates a Merchant Center sub-account.",
- "flatPath": "{merchantId}/accounts",
- "httpMethod": "POST",
- "id": "content.accounts.insert",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the managing account. This must be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/accounts",
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "link": {
- "description": "Performs an action on a link between two Merchant Center accounts, namely accountId and linkedAccountId.",
- "flatPath": "{merchantId}/accounts/{accountId}/link",
- "httpMethod": "POST",
- "id": "content.accounts.link",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account that should be linked.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/accounts/{accountId}/link",
- "request": {
- "$ref": "AccountsLinkRequest"
- },
- "response": {
- "$ref": "AccountsLinkResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the sub-accounts in your Merchant Center account.",
- "flatPath": "{merchantId}/accounts",
- "httpMethod": "GET",
- "id": "content.accounts.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "label": {
- "description": "If view is set to \"css\", only return accounts that are assigned label with given ID.",
- "format": "uint64",
- "location": "query",
- "type": "string"
- },
- "maxResults": {
- "description": "The maximum number of accounts to return in the response, used for paging.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the managing account. This must be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "name": {
- "description": "If set, only the accounts with the given name (case sensitive) will be returned.",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- },
- "view": {
- "description": "Controls which fields will be populated. Acceptable values are: \"merchant\" and \"css\". The default value is \"merchant\".",
- "enum": [
- "MERCHANT",
- "CSS"
- ],
- "enumDescriptions": [
- "Default. View is populated with Merchant Center fields.",
- "View is populated with Comparison Shopping Services fields."
- ],
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/accounts",
- "response": {
- "$ref": "AccountsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "listlinks": {
- "description": "Returns the list of accounts linked to your Merchant Center account.",
- "flatPath": "{merchantId}/accounts/{accountId}/listlinks",
- "httpMethod": "GET",
- "id": "content.accounts.listlinks",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which to list links.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "maxResults": {
- "description": "The maximum number of links to return in the response, used for pagination. The minimum allowed value is 5 results per page. If provided value is lower than 5, it will be automatically increased to 5.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/accounts/{accountId}/listlinks",
- "response": {
- "$ref": "AccountsListLinksResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "requestphoneverification": {
- "description": "Request verification code to start phone verification.",
- "flatPath": "{merchantId}/accounts/{accountId}/requestphoneverification",
- "httpMethod": "POST",
- "id": "content.accounts.requestphoneverification",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The ID of the account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/accounts/{accountId}/requestphoneverification",
- "request": {
- "$ref": "RequestPhoneVerificationRequest"
- },
- "response": {
- "$ref": "RequestPhoneVerificationResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "update": {
- "description": "Updates a Merchant Center account. Any fields that are not provided are deleted from the resource.",
- "flatPath": "{merchantId}/accounts/{accountId}",
- "httpMethod": "PUT",
- "id": "content.accounts.update",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/accounts/{accountId}",
- "request": {
- "$ref": "Account"
- },
- "response": {
- "$ref": "Account"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "updatelabels": {
- "description": "Updates labels that are assigned to the Merchant Center account by CSS user.",
- "flatPath": "{merchantId}/accounts/{accountId}/updatelabels",
- "httpMethod": "POST",
- "id": "content.accounts.updatelabels",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account whose labels are updated.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/accounts/{accountId}/updatelabels",
- "request": {
- "$ref": "AccountsUpdateLabelsRequest"
- },
- "response": {
- "$ref": "AccountsUpdateLabelsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "verifyphonenumber": {
- "description": "Validates verification code to verify phone number for the account. If successful this will overwrite the value of `accounts.businessinformation.phoneNumber`. Only verified phone number will replace an existing verified phone number.",
- "flatPath": "{merchantId}/accounts/{accountId}/verifyphonenumber",
- "httpMethod": "POST",
- "id": "content.accounts.verifyphonenumber",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The ID of the account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and accountId must be the ID of a sub-account of this account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/accounts/{accountId}/verifyphonenumber",
- "request": {
- "$ref": "VerifyPhoneNumberRequest"
- },
- "response": {
- "$ref": "VerifyPhoneNumberResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- },
- "resources": {
- "credentials": {
- "methods": {
- "create": {
- "description": "Uploads credentials for the Merchant Center account. If credentials already exist for this Merchant Center account and purpose, this method updates them.",
- "flatPath": "accounts/{accountId}/credentials",
- "httpMethod": "POST",
- "id": "content.accounts.credentials.create",
- "parameterOrder": [
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The merchant id of the account these credentials belong to.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "accounts/{accountId}/credentials",
- "request": {
- "$ref": "AccountCredentials"
- },
- "response": {
- "$ref": "AccountCredentials"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "labels": {
- "methods": {
- "create": {
- "description": "Creates a new label, not assigned to any account.",
- "flatPath": "accounts/{accountId}/labels",
- "httpMethod": "POST",
- "id": "content.accounts.labels.create",
- "parameterOrder": [
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The id of the account this label belongs to.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "accounts/{accountId}/labels",
- "request": {
- "$ref": "AccountLabel"
- },
- "response": {
- "$ref": "AccountLabel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes a label and removes it from all accounts to which it was assigned.",
- "flatPath": "accounts/{accountId}/labels/{labelId}",
- "httpMethod": "DELETE",
- "id": "content.accounts.labels.delete",
- "parameterOrder": [
- "accountId",
- "labelId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The id of the account that owns the label.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "labelId": {
- "description": "Required. The id of the label to delete.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "accounts/{accountId}/labels/{labelId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the labels assigned to an account.",
- "flatPath": "accounts/{accountId}/labels",
- "httpMethod": "GET",
- "id": "content.accounts.labels.list",
- "parameterOrder": [
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The account id for whose labels are to be listed.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "A page token, received from a previous `ListAccountLabels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLabels` must match the call that provided the page token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "accounts/{accountId}/labels",
- "response": {
- "$ref": "ListAccountLabelsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "patch": {
- "description": "Updates a label.",
- "flatPath": "accounts/{accountId}/labels/{labelId}",
- "httpMethod": "PATCH",
- "id": "content.accounts.labels.patch",
- "parameterOrder": [
- "accountId",
- "labelId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The id of the account this label belongs to.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "labelId": {
- "description": "Required. The id of the label to update.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "accounts/{accountId}/labels/{labelId}",
- "request": {
- "$ref": "AccountLabel"
- },
- "response": {
- "$ref": "AccountLabel"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "returncarrier": {
- "methods": {
- "create": {
- "description": "Links return carrier to a merchant account.",
- "flatPath": "accounts/{accountId}/returncarrier",
- "httpMethod": "POST",
- "id": "content.accounts.returncarrier.create",
- "parameterOrder": [
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "accounts/{accountId}/returncarrier",
- "request": {
- "$ref": "AccountReturnCarrier"
- },
- "response": {
- "$ref": "AccountReturnCarrier"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Delete a return carrier in the merchant account.",
- "flatPath": "accounts/{accountId}/returncarrier/{carrierAccountId}",
- "httpMethod": "DELETE",
- "id": "content.accounts.returncarrier.delete",
- "parameterOrder": [
- "accountId",
- "carrierAccountId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "carrierAccountId": {
- "description": "Required. The Google-provided unique carrier ID, used to update the resource.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "accounts/{accountId}/returncarrier/{carrierAccountId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists available return carriers in the merchant account.",
- "flatPath": "accounts/{accountId}/returncarrier",
- "httpMethod": "GET",
- "id": "content.accounts.returncarrier.list",
- "parameterOrder": [
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "accounts/{accountId}/returncarrier",
- "response": {
- "$ref": "ListAccountReturnCarrierResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "patch": {
- "description": "Updates a return carrier in the merchant account.",
- "flatPath": "accounts/{accountId}/returncarrier/{carrierAccountId}",
- "httpMethod": "PATCH",
- "id": "content.accounts.returncarrier.patch",
- "parameterOrder": [
- "accountId",
- "carrierAccountId"
- ],
- "parameters": {
- "accountId": {
- "description": "Required. The Merchant Center Account Id under which the Return Carrier is to be linked.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "carrierAccountId": {
- "description": "Required. The Google-provided unique carrier ID, used to update the resource.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "accounts/{accountId}/returncarrier/{carrierAccountId}",
- "request": {
- "$ref": "AccountReturnCarrier"
- },
- "response": {
- "$ref": "AccountReturnCarrier"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- }
- }
- },
- "accountstatuses": {
- "methods": {
- "custombatch": {
- "description": "Retrieves multiple Merchant Center account statuses in a single request.",
- "flatPath": "accountstatuses/batch",
- "httpMethod": "POST",
- "id": "content.accountstatuses.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "accountstatuses/batch",
- "request": {
- "$ref": "AccountstatusesCustomBatchRequest"
- },
- "response": {
- "$ref": "AccountstatusesCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts.",
- "flatPath": "{merchantId}/accountstatuses/{accountId}",
- "httpMethod": "GET",
- "id": "content.accountstatuses.get",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "destinations": {
- "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/accountstatuses/{accountId}",
- "response": {
- "$ref": "AccountStatus"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the statuses of the sub-accounts in your Merchant Center account.",
- "flatPath": "{merchantId}/accountstatuses",
- "httpMethod": "GET",
- "id": "content.accountstatuses.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "destinations": {
- "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "description": "The maximum number of account statuses to return in the response, used for paging.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the managing account. This must be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "name": {
- "description": "If set, only the accounts with the given name (case sensitive) will be returned.",
- "location": "query",
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/accountstatuses",
- "response": {
- "$ref": "AccountstatusesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "accounttax": {
- "methods": {
- "custombatch": {
- "description": "Retrieves and updates tax settings of multiple accounts in a single request.",
- "flatPath": "accounttax/batch",
- "httpMethod": "POST",
- "id": "content.accounttax.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "accounttax/batch",
- "request": {
- "$ref": "AccounttaxCustomBatchRequest"
- },
- "response": {
- "$ref": "AccounttaxCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves the tax settings of the account.",
- "flatPath": "{merchantId}/accounttax/{accountId}",
- "httpMethod": "GET",
- "id": "content.accounttax.get",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which to get/update account tax settings.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/accounttax/{accountId}",
- "response": {
- "$ref": "AccountTax"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the tax settings of the sub-accounts in your Merchant Center account.",
- "flatPath": "{merchantId}/accounttax",
- "httpMethod": "GET",
- "id": "content.accounttax.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "maxResults": {
- "description": "The maximum number of tax settings to return in the response, used for paging.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the managing account. This must be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/accounttax",
- "response": {
- "$ref": "AccounttaxListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "update": {
- "description": "Updates the tax settings of the account. Any fields that are not provided are deleted from the resource.",
- "flatPath": "{merchantId}/accounttax/{accountId}",
- "httpMethod": "PUT",
- "id": "content.accounttax.update",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which to get/update account tax settings.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/accounttax/{accountId}",
- "request": {
- "$ref": "AccountTax"
- },
- "response": {
- "$ref": "AccountTax"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "collections": {
- "methods": {
- "create": {
- "description": "Uploads a collection to your Merchant Center account. If a collection with the same collectionId already exists, this method updates that entry. In each update, the collection is completely replaced by the fields in the body of the update request.",
- "flatPath": "{merchantId}/collections",
- "httpMethod": "POST",
- "id": "content.collections.create",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/collections",
- "request": {
- "$ref": "Collection"
- },
- "response": {
- "$ref": "Collection"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes a collection from your Merchant Center account.",
- "flatPath": "{merchantId}/collections/{collectionId}",
- "httpMethod": "DELETE",
- "id": "content.collections.delete",
- "parameterOrder": [
- "merchantId",
- "collectionId"
- ],
- "parameters": {
- "collectionId": {
- "description": "Required. The collectionId of the collection. CollectionId is the same as the REST ID of the collection.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/collections/{collectionId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves a collection from your Merchant Center account.",
- "flatPath": "{merchantId}/collections/{collectionId}",
- "httpMethod": "GET",
- "id": "content.collections.get",
- "parameterOrder": [
- "merchantId",
- "collectionId"
- ],
- "parameters": {
- "collectionId": {
- "description": "Required. The REST ID of the collection.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/collections/{collectionId}",
- "response": {
- "$ref": "Collection"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the collections in your Merchant Center account. The response might contain fewer items than specified by page_size. Rely on next_page_token to determine if there are more items to be requested.",
- "flatPath": "{merchantId}/collections",
- "httpMethod": "GET",
- "id": "content.collections.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of collections to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/collections",
- "response": {
- "$ref": "ListCollectionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "collectionstatuses": {
- "methods": {
- "get": {
- "description": "Gets the status of a collection from your Merchant Center account.",
- "flatPath": "{merchantId}/collectionstatuses/{collectionId}",
- "httpMethod": "GET",
- "id": "content.collectionstatuses.get",
- "parameterOrder": [
- "merchantId",
- "collectionId"
- ],
- "parameters": {
- "collectionId": {
- "description": "Required. The collectionId of the collection. CollectionId is the same as the REST ID of the collection.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/collectionstatuses/{collectionId}",
- "response": {
- "$ref": "CollectionStatus"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the statuses of the collections in your Merchant Center account.",
- "flatPath": "{merchantId}/collectionstatuses",
- "httpMethod": "GET",
- "id": "content.collectionstatuses.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account that contains the collection. This account cannot be a multi-client account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of collection statuses to return in the response, used for paging. Defaults to 50; values above 1000 will be coerced to 1000.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/collectionstatuses",
- "response": {
- "$ref": "ListCollectionStatusesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "conversionsources": {
- "methods": {
- "create": {
- "description": "Creates a new conversion source.",
- "flatPath": "{merchantId}/conversionsources",
- "httpMethod": "POST",
- "id": "content.conversionsources.create",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account that owns the new conversion source.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/conversionsources",
- "request": {
- "$ref": "ConversionSource"
- },
- "response": {
- "$ref": "ConversionSource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Archives an existing conversion source. It will be recoverable for 30 days. This archiving behavior is not typical in the Content API and unique to this service.",
- "flatPath": "{merchantId}/conversionsources/{conversionSourceId}",
- "httpMethod": "DELETE",
- "id": "content.conversionsources.delete",
- "parameterOrder": [
- "merchantId",
- "conversionSourceId"
- ],
- "parameters": {
- "conversionSourceId": {
- "description": "Required. The ID of the conversion source to be deleted.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The ID of the account that owns the new conversion source.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/conversionsources/{conversionSourceId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Fetches a conversion source.",
- "flatPath": "{merchantId}/conversionsources/{conversionSourceId}",
- "httpMethod": "GET",
- "id": "content.conversionsources.get",
- "parameterOrder": [
- "merchantId",
- "conversionSourceId"
- ],
- "parameters": {
- "conversionSourceId": {
- "description": "Required. The REST ID of the collection.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The ID of the account that owns the new conversion source.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/conversionsources/{conversionSourceId}",
- "response": {
- "$ref": "ConversionSource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Retrieves the list of conversion sources the caller has access to.",
- "flatPath": "{merchantId}/conversionsources",
- "httpMethod": "GET",
- "id": "content.conversionsources.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account that owns the new conversion source.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of conversion sources to return in a page. If no `page_size` is specified, `100` is used as the default value. The maximum value is `200`. Values above `200` will be coerced to `200`. Regardless of pagination, at most `200` conversion sources are returned in total.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "Page token.",
- "location": "query",
- "type": "string"
- },
- "showDeleted": {
- "description": "If true, also returns archived conversion sources.",
- "location": "query",
- "type": "boolean"
- }
- },
- "path": "{merchantId}/conversionsources",
- "response": {
- "$ref": "ListConversionSourcesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "patch": {
- "description": "Updates information of an existing conversion source.",
- "flatPath": "{merchantId}/conversionsources/{conversionSourceId}",
- "httpMethod": "PATCH",
- "id": "content.conversionsources.patch",
- "parameterOrder": [
- "merchantId",
- "conversionSourceId"
- ],
- "parameters": {
- "conversionSourceId": {
- "description": "Required. The ID of the conversion source to be updated.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The ID of the account that owns the new conversion source.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "description": "Optional. List of fields being updated. The following fields can be updated: `attribution_settings`, `display_name`, `currency_code`.",
- "format": "google-fieldmask",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/conversionsources/{conversionSourceId}",
- "request": {
- "$ref": "ConversionSource"
- },
- "response": {
- "$ref": "ConversionSource"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "undelete": {
- "description": "Re-enables an archived conversion source.",
- "flatPath": "{merchantId}/conversionsources/{conversionSourceId}:undelete",
- "httpMethod": "POST",
- "id": "content.conversionsources.undelete",
- "parameterOrder": [
- "merchantId",
- "conversionSourceId"
- ],
- "parameters": {
- "conversionSourceId": {
- "description": "Required. The ID of the conversion source to be undeleted.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The ID of the account that owns the new conversion source.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/conversionsources/{conversionSourceId}:undelete",
- "request": {
- "$ref": "UndeleteConversionSourceRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "csses": {
- "methods": {
- "get": {
- "description": "Retrieves a single CSS domain by ID.",
- "flatPath": "{cssGroupId}/csses/{cssDomainId}",
- "httpMethod": "GET",
- "id": "content.csses.get",
- "parameterOrder": [
- "cssGroupId",
- "cssDomainId"
- ],
- "parameters": {
- "cssDomainId": {
- "description": "Required. The ID of the CSS domain to return.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "cssGroupId": {
- "description": "Required. The ID of the managing account. If this parameter is not the same as [cssDomainId](#cssDomainId), then this ID must be a CSS group ID and `cssDomainId` must be the ID of a CSS domain affiliated with this group.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{cssGroupId}/csses/{cssDomainId}",
- "response": {
- "$ref": "Css"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists CSS domains affiliated with a CSS group.",
- "flatPath": "{cssGroupId}/csses",
- "httpMethod": "GET",
- "id": "content.csses.list",
- "parameterOrder": [
- "cssGroupId"
- ],
- "parameters": {
- "cssGroupId": {
- "description": "Required. The CSS group ID of CSS domains to be listed.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of CSS domains to return. The service may return fewer than this value. If unspecified, at most 50 CSS domains will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "A page token, received from a previous `ListCsses` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCsses` must match the call that provided the page token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{cssGroupId}/csses",
- "response": {
- "$ref": "ListCssesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "updatelabels": {
- "description": "Updates labels that are assigned to a CSS domain by its CSS group.",
- "flatPath": "{cssGroupId}/csses/{cssDomainId}/updatelabels",
- "httpMethod": "POST",
- "id": "content.csses.updatelabels",
- "parameterOrder": [
- "cssGroupId",
- "cssDomainId"
- ],
- "parameters": {
- "cssDomainId": {
- "description": "Required. The ID of the updated CSS domain.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "cssGroupId": {
- "description": "Required. The CSS group ID of the updated CSS domain.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{cssGroupId}/csses/{cssDomainId}/updatelabels",
- "request": {
- "$ref": "LabelIds"
- },
- "response": {
- "$ref": "Css"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "datafeeds": {
- "methods": {
- "custombatch": {
- "description": "Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request.",
- "flatPath": "datafeeds/batch",
- "httpMethod": "POST",
- "id": "content.datafeeds.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "datafeeds/batch",
- "request": {
- "$ref": "DatafeedsCustomBatchRequest"
- },
- "response": {
- "$ref": "DatafeedsCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes a datafeed configuration from your Merchant Center account.",
- "flatPath": "{merchantId}/datafeeds/{datafeedId}",
- "httpMethod": "DELETE",
- "id": "content.datafeeds.delete",
- "parameterOrder": [
- "merchantId",
- "datafeedId"
- ],
- "parameters": {
- "datafeedId": {
- "description": "The ID of the datafeed.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/datafeeds/{datafeedId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "fetchnow": {
- "description": "Invokes a fetch for the datafeed in your Merchant Center account. If you need to call this method more than once per day, we recommend you use the [Products service](https://developers.google.com/shopping-content/reference/rest/v2.1/products) to update your product data.",
- "flatPath": "{merchantId}/datafeeds/{datafeedId}/fetchNow",
- "httpMethod": "POST",
- "id": "content.datafeeds.fetchnow",
- "parameterOrder": [
- "merchantId",
- "datafeedId"
- ],
- "parameters": {
- "datafeedId": {
- "description": "The ID of the datafeed to be fetched.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/datafeeds/{datafeedId}/fetchNow",
- "response": {
- "$ref": "DatafeedsFetchNowResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves a datafeed configuration from your Merchant Center account.",
- "flatPath": "{merchantId}/datafeeds/{datafeedId}",
- "httpMethod": "GET",
- "id": "content.datafeeds.get",
- "parameterOrder": [
- "merchantId",
- "datafeedId"
- ],
- "parameters": {
- "datafeedId": {
- "description": "The ID of the datafeed.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/datafeeds/{datafeedId}",
- "response": {
- "$ref": "Datafeed"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "insert": {
- "description": "Registers a datafeed configuration with your Merchant Center account.",
- "flatPath": "{merchantId}/datafeeds",
- "httpMethod": "POST",
- "id": "content.datafeeds.insert",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/datafeeds",
- "request": {
- "$ref": "Datafeed"
- },
- "response": {
- "$ref": "Datafeed"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the configurations for datafeeds in your Merchant Center account.",
- "flatPath": "{merchantId}/datafeeds",
- "httpMethod": "GET",
- "id": "content.datafeeds.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "maxResults": {
- "description": "The maximum number of products to return in the response, used for paging.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the account that manages the datafeeds. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/datafeeds",
- "response": {
- "$ref": "DatafeedsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "update": {
- "description": "Updates a datafeed configuration of your Merchant Center account. Any fields that are not provided are deleted from the resource.",
- "flatPath": "{merchantId}/datafeeds/{datafeedId}",
- "httpMethod": "PUT",
- "id": "content.datafeeds.update",
- "parameterOrder": [
- "merchantId",
- "datafeedId"
- ],
- "parameters": {
- "datafeedId": {
- "description": "The ID of the datafeed.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/datafeeds/{datafeedId}",
- "request": {
- "$ref": "Datafeed"
- },
- "response": {
- "$ref": "Datafeed"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "datafeedstatuses": {
- "methods": {
- "custombatch": {
- "description": "Gets multiple Merchant Center datafeed statuses in a single request.",
- "flatPath": "datafeedstatuses/batch",
- "httpMethod": "POST",
- "id": "content.datafeedstatuses.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "datafeedstatuses/batch",
- "request": {
- "$ref": "DatafeedstatusesCustomBatchRequest"
- },
- "response": {
- "$ref": "DatafeedstatusesCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves the status of a datafeed from your Merchant Center account.",
- "flatPath": "{merchantId}/datafeedstatuses/{datafeedId}",
- "httpMethod": "GET",
- "id": "content.datafeedstatuses.get",
- "parameterOrder": [
- "merchantId",
- "datafeedId"
- ],
- "parameters": {
- "country": {
- "description": "Deprecated. Use `feedLabel` instead. The country to get the datafeed status for. If this parameter is provided then `language` must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.",
- "location": "query",
- "type": "string"
- },
- "datafeedId": {
- "description": "The ID of the datafeed.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "feedLabel": {
- "description": "The feed label to get the datafeed status for. If this parameter is provided then `language` must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.",
- "location": "query",
- "type": "string"
- },
- "language": {
- "description": "The language to get the datafeed status for. If this parameter is provided then `country` must also be provided. Note that this parameter is required for feeds targeting multiple countries and languages, since a feed may have a different status for each target.",
- "location": "query",
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the account that manages the datafeed. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/datafeedstatuses/{datafeedId}",
- "response": {
- "$ref": "DatafeedStatus"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the statuses of the datafeeds in your Merchant Center account.",
- "flatPath": "{merchantId}/datafeedstatuses",
- "httpMethod": "GET",
- "id": "content.datafeedstatuses.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "maxResults": {
- "description": "The maximum number of products to return in the response, used for paging.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the account that manages the datafeeds. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/datafeedstatuses",
- "response": {
- "$ref": "DatafeedstatusesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "freelistingsprogram": {
- "methods": {
- "get": {
- "description": "Retrieves the status and review eligibility for the free listing program. Returns errors and warnings if they require action to resolve, will become disapprovals, or impact impressions. Use `accountstatuses` to view all issues for an account.",
- "flatPath": "{merchantId}/freelistingsprogram",
- "httpMethod": "GET",
- "id": "content.freelistingsprogram.get",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/freelistingsprogram",
- "response": {
- "$ref": "FreeListingsProgramStatus"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "requestreview": {
- "description": "Requests a review of free listings in a specific region. This method deprecated. Use the `MerchantSupportService` to view product and account issues and request a review.",
- "flatPath": "{merchantId}/freelistingsprogram/requestreview",
- "httpMethod": "POST",
- "id": "content.freelistingsprogram.requestreview",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/freelistingsprogram/requestreview",
- "request": {
- "$ref": "RequestReviewFreeListingsRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- },
- "resources": {
- "checkoutsettings": {
- "methods": {
- "delete": {
- "description": "Deletes `Checkout` settings and unenrolls merchant from `Checkout` program.",
- "flatPath": "{merchantId}/freelistingsprogram/checkoutsettings",
- "httpMethod": "DELETE",
- "id": "content.freelistingsprogram.checkoutsettings.delete",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/freelistingsprogram/checkoutsettings",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Gets Checkout settings for the given merchant. This includes information about review state, enrollment state and URL settings.",
- "flatPath": "{merchantId}/freelistingsprogram/checkoutsettings",
- "httpMethod": "GET",
- "id": "content.freelistingsprogram.checkoutsettings.get",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/freelistingsprogram/checkoutsettings",
- "response": {
- "$ref": "CheckoutSettings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "insert": {
- "description": "Enrolls merchant in `Checkout` program.",
- "flatPath": "{merchantId}/freelistingsprogram/checkoutsettings",
- "httpMethod": "POST",
- "id": "content.freelistingsprogram.checkoutsettings.insert",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/freelistingsprogram/checkoutsettings",
- "request": {
- "$ref": "InsertCheckoutSettingsRequest"
- },
- "response": {
- "$ref": "CheckoutSettings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- }
- }
- },
- "liasettings": {
- "methods": {
- "custombatch": {
- "description": "Retrieves and/or updates the LIA settings of multiple accounts in a single request.",
- "flatPath": "liasettings/batch",
- "httpMethod": "POST",
- "id": "content.liasettings.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "liasettings/batch",
- "request": {
- "$ref": "LiasettingsCustomBatchRequest"
- },
- "response": {
- "$ref": "LiasettingsCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves the LIA settings of the account.",
- "flatPath": "{merchantId}/liasettings/{accountId}",
- "httpMethod": "GET",
- "id": "content.liasettings.get",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which to get or update LIA settings.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/liasettings/{accountId}",
- "response": {
- "$ref": "LiaSettings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "getaccessiblegmbaccounts": {
- "description": "Retrieves the list of accessible Business Profiles.",
- "flatPath": "{merchantId}/liasettings/{accountId}/accessiblegmbaccounts",
- "httpMethod": "GET",
- "id": "content.liasettings.getaccessiblegmbaccounts",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which to retrieve accessible Business Profiles.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/liasettings/{accountId}/accessiblegmbaccounts",
- "response": {
- "$ref": "LiasettingsGetAccessibleGmbAccountsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the LIA settings of the sub-accounts in your Merchant Center account.",
- "flatPath": "{merchantId}/liasettings",
- "httpMethod": "GET",
- "id": "content.liasettings.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "maxResults": {
- "description": "The maximum number of LIA settings to return in the response, used for paging.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the managing account. This must be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/liasettings",
- "response": {
- "$ref": "LiasettingsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "listposdataproviders": {
- "description": "Retrieves the list of POS data providers that have active settings for the all eiligible countries.",
- "flatPath": "liasettings/posdataproviders",
- "httpMethod": "GET",
- "id": "content.liasettings.listposdataproviders",
- "parameterOrder": [],
- "parameters": {},
- "path": "liasettings/posdataproviders",
- "response": {
- "$ref": "LiasettingsListPosDataProvidersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "requestgmbaccess": {
- "description": "Requests access to a specified Business Profile.",
- "flatPath": "{merchantId}/liasettings/{accountId}/requestgmbaccess",
- "httpMethod": "POST",
- "id": "content.liasettings.requestgmbaccess",
- "parameterOrder": [
- "merchantId",
- "accountId",
- "gmbEmail"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which Business Profile access is requested.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "gmbEmail": {
- "description": "The email of the Business Profile.",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/liasettings/{accountId}/requestgmbaccess",
- "response": {
- "$ref": "LiasettingsRequestGmbAccessResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "requestinventoryverification": {
- "description": "Requests inventory validation for the specified country.",
- "flatPath": "{merchantId}/liasettings/{accountId}/requestinventoryverification/{country}",
- "httpMethod": "POST",
- "id": "content.liasettings.requestinventoryverification",
- "parameterOrder": [
- "merchantId",
- "accountId",
- "country"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "country": {
- "description": "The country for which inventory validation is requested.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/liasettings/{accountId}/requestinventoryverification/{country}",
- "response": {
- "$ref": "LiasettingsRequestInventoryVerificationResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "setinventoryverificationcontact": {
- "description": "Sets the inventory verification contact for the specified country.",
- "flatPath": "{merchantId}/liasettings/{accountId}/setinventoryverificationcontact",
- "httpMethod": "POST",
- "id": "content.liasettings.setinventoryverificationcontact",
- "parameterOrder": [
- "merchantId",
- "accountId",
- "country",
- "language",
- "contactName",
- "contactEmail"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account that manages the order. This cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "contactEmail": {
- "description": "The email of the inventory verification contact.",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "contactName": {
- "description": "The name of the inventory verification contact.",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "country": {
- "description": "The country for which inventory verification is requested.",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "language": {
- "description": "The language for which inventory verification is requested.",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/liasettings/{accountId}/setinventoryverificationcontact",
- "response": {
- "$ref": "LiasettingsSetInventoryVerificationContactResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "setomnichannelexperience": {
- "description": "Sets the omnichannel experience for the specified country. Only supported for merchants whose POS data provider is trusted to enable the corresponding experience. For more context, see these help articles [about LFP](https://support.google.com/merchants/answer/7676652) and [how to get started](https://support.google.com/merchants/answer/7676578) with it.",
- "flatPath": "{merchantId}/liasettings/{accountId}/setomnichannelexperience",
- "httpMethod": "POST",
- "id": "content.liasettings.setomnichannelexperience",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which to retrieve accessible Business Profiles.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "country": {
- "description": "The CLDR country code (for example, \"US\") for which the omnichannel experience is selected.",
- "location": "query",
- "type": "string"
- },
- "lsfType": {
- "description": "The Local Store Front (LSF) type for this country. Acceptable values are: - \"`ghlsf`\" (Google-Hosted Local Store Front) - \"`mhlsfBasic`\" (Merchant-Hosted Local Store Front Basic) - \"`mhlsfFull`\" (Merchant-Hosted Local Store Front Full) More details about these types can be found here.",
- "location": "query",
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pickupTypes": {
- "description": "The Pickup types for this country. Acceptable values are: - \"`pickupToday`\" - \"`pickupLater`\" ",
- "location": "query",
- "repeated": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/liasettings/{accountId}/setomnichannelexperience",
- "response": {
- "$ref": "LiaOmnichannelExperience"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "setposdataprovider": {
- "description": "Sets the POS data provider for the specified country.",
- "flatPath": "{merchantId}/liasettings/{accountId}/setposdataprovider",
- "httpMethod": "POST",
- "id": "content.liasettings.setposdataprovider",
- "parameterOrder": [
- "merchantId",
- "accountId",
- "country"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which to retrieve accessible Business Profiles.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "country": {
- "description": "The country for which the POS data provider is selected.",
- "location": "query",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "posDataProviderId": {
- "description": "The ID of POS data provider.",
- "format": "uint64",
- "location": "query",
- "type": "string"
- },
- "posExternalAccountId": {
- "description": "The account ID by which this merchant is known to the POS data provider.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/liasettings/{accountId}/setposdataprovider",
- "response": {
- "$ref": "LiasettingsSetPosDataProviderResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "update": {
- "description": "Updates the LIA settings of the account. Any fields that are not provided are deleted from the resource.",
- "flatPath": "{merchantId}/liasettings/{accountId}",
- "httpMethod": "PUT",
- "id": "content.liasettings.update",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which to get or update LIA settings.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/liasettings/{accountId}",
- "request": {
- "$ref": "LiaSettings"
- },
- "response": {
- "$ref": "LiaSettings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "localinventory": {
- "methods": {
- "custombatch": {
- "description": "Updates local inventory for multiple products or stores in a single request.",
- "flatPath": "localinventory/batch",
- "httpMethod": "POST",
- "id": "content.localinventory.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "localinventory/batch",
- "request": {
- "$ref": "LocalinventoryCustomBatchRequest"
- },
- "response": {
- "$ref": "LocalinventoryCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "insert": {
- "description": "Updates the local inventory of a product in your Merchant Center account.",
- "flatPath": "{merchantId}/products/{productId}/localinventory",
- "httpMethod": "POST",
- "id": "content.localinventory.insert",
- "parameterOrder": [
- "merchantId",
- "productId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "productId": {
- "description": "The REST ID of the product for which to update local inventory.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/products/{productId}/localinventory",
- "request": {
- "$ref": "LocalInventory"
- },
- "response": {
- "$ref": "LocalInventory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "merchantsupport": {
- "methods": {
- "renderaccountissues": {
- "description": "Provide a list of merchant's issues with a support content and available actions. This content and actions are meant to be rendered and shown in third-party applications.",
- "flatPath": "{merchantId}/merchantsupport/renderaccountissues",
- "httpMethod": "POST",
- "id": "content.merchantsupport.renderaccountissues",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "languageCode": {
- "description": "Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language code used to localize support content. If not set, the result will be in default language `en-US`.",
- "location": "query",
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The ID of the account to fetch issues for.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "timeZone": {
- "description": "Optional. The [IANA](https://www.iana.org/time-zones) timezone used to localize times in support content. For example 'America/Los_Angeles'. If not set, results will use as a default UTC.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/merchantsupport/renderaccountissues",
- "request": {
- "$ref": "RenderAccountIssuesRequestPayload"
- },
- "response": {
- "$ref": "RenderAccountIssuesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "renderproductissues": {
- "description": "Provide a list of issues for merchant's product with a support content and available actions. This content and actions are meant to be rendered and shown in third-party applications.",
- "flatPath": "{merchantId}/merchantsupport/renderproductissues/{productId}",
- "httpMethod": "POST",
- "id": "content.merchantsupport.renderproductissues",
- "parameterOrder": [
- "merchantId",
- "productId"
- ],
- "parameters": {
- "languageCode": {
- "description": "Optional. The [IETF BCP-47](https://tools.ietf.org/html/bcp47) language code used to localize support content. If not set, the result will be in default language `en-US`.",
- "location": "query",
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The ID of the account that contains the product.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "productId": {
- "description": "Required. The [REST_ID](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.id) of the product to fetch issues for.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "timeZone": {
- "description": "Optional. The [IANA](https://www.iana.org/time-zones) timezone used to localize times in support content. For example 'America/Los_Angeles'. If not set, results will use as a default UTC.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/merchantsupport/renderproductissues/{productId}",
- "request": {
- "$ref": "RenderProductIssuesRequestPayload"
- },
- "response": {
- "$ref": "RenderProductIssuesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "triggeraction": {
- "description": "Start an action. The action can be requested by merchants in third-party application. Before merchants can request the action, the third-party application needs to show them action specific content and display a user input form. You can submit an allowlist request in the [Shopping API Support Form](https://support.google.com/merchants/contact/shopping_api_support_form) under \"What is the issue/question?\" to get access to this feature. The action can be successfully started only once all `required` inputs are provided. If any `required` input is missing, or invalid value was provided, the service will return 400 error. Validation errors will contain Ids for all problematic field together with translated, human readable error messages that can be shown to the user.",
- "flatPath": "{merchantId}/merchantsupport/triggeraction",
- "httpMethod": "POST",
- "id": "content.merchantsupport.triggeraction",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "languageCode": {
- "description": "Optional. Language code [IETF BCP 47 syntax](https://tools.ietf.org/html/bcp47) used to localize the response. If not set, the result will be in default language `en-US`.",
- "location": "query",
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The ID of the merchant's account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/merchantsupport/triggeraction",
- "request": {
- "$ref": "TriggerActionPayload"
- },
- "response": {
- "$ref": "TriggerActionResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "ordertrackingsignals": {
- "methods": {
- "create": {
- "description": "Creates new order tracking signal.",
- "flatPath": "{merchantId}/ordertrackingsignals",
- "httpMethod": "POST",
- "id": "content.ordertrackingsignals.create",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the merchant for which the order signal is created.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/ordertrackingsignals",
- "request": {
- "$ref": "OrderTrackingSignal"
- },
- "response": {
- "$ref": "OrderTrackingSignal"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "pos": {
- "methods": {
- "custombatch": {
- "description": "Batches multiple POS-related calls in a single request.",
- "flatPath": "pos/batch",
- "httpMethod": "POST",
- "id": "content.pos.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "pos/batch",
- "request": {
- "$ref": "PosCustomBatchRequest"
- },
- "response": {
- "$ref": "PosCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes a store for the given merchant.",
- "flatPath": "{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
- "httpMethod": "DELETE",
- "id": "content.pos.delete",
- "parameterOrder": [
- "merchantId",
- "targetMerchantId",
- "storeCode"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the POS or inventory data provider.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "storeCode": {
- "description": "A store code that is unique per merchant.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "targetMerchantId": {
- "description": "The ID of the target merchant.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves information about the given store.",
- "flatPath": "{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
- "httpMethod": "GET",
- "id": "content.pos.get",
- "parameterOrder": [
- "merchantId",
- "targetMerchantId",
- "storeCode"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the POS or inventory data provider.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "storeCode": {
- "description": "A store code that is unique per merchant.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "targetMerchantId": {
- "description": "The ID of the target merchant.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/pos/{targetMerchantId}/store/{storeCode}",
- "response": {
- "$ref": "PosStore"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "insert": {
- "description": "Creates a store for the given merchant.",
- "flatPath": "{merchantId}/pos/{targetMerchantId}/store",
- "httpMethod": "POST",
- "id": "content.pos.insert",
- "parameterOrder": [
- "merchantId",
- "targetMerchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the POS or inventory data provider.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "targetMerchantId": {
- "description": "The ID of the target merchant.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/pos/{targetMerchantId}/store",
- "request": {
- "$ref": "PosStore"
- },
- "response": {
- "$ref": "PosStore"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "inventory": {
- "description": "Submit inventory for the given merchant.",
- "flatPath": "{merchantId}/pos/{targetMerchantId}/inventory",
- "httpMethod": "POST",
- "id": "content.pos.inventory",
- "parameterOrder": [
- "merchantId",
- "targetMerchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the POS or inventory data provider.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "targetMerchantId": {
- "description": "The ID of the target merchant.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/pos/{targetMerchantId}/inventory",
- "request": {
- "$ref": "PosInventoryRequest"
- },
- "response": {
- "$ref": "PosInventoryResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the stores of the target merchant.",
- "flatPath": "{merchantId}/pos/{targetMerchantId}/store",
- "httpMethod": "GET",
- "id": "content.pos.list",
- "parameterOrder": [
- "merchantId",
- "targetMerchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the POS or inventory data provider.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "targetMerchantId": {
- "description": "The ID of the target merchant.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/pos/{targetMerchantId}/store",
- "response": {
- "$ref": "PosListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "sale": {
- "description": "Submit a sale event for the given merchant.",
- "flatPath": "{merchantId}/pos/{targetMerchantId}/sale",
- "httpMethod": "POST",
- "id": "content.pos.sale",
- "parameterOrder": [
- "merchantId",
- "targetMerchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the POS or inventory data provider.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "targetMerchantId": {
- "description": "The ID of the target merchant.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/pos/{targetMerchantId}/sale",
- "request": {
- "$ref": "PosSaleRequest"
- },
- "response": {
- "$ref": "PosSaleResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "productdeliverytime": {
- "methods": {
- "create": {
- "description": "Creates or updates the delivery time of a product.",
- "flatPath": "{merchantId}/productdeliverytime",
- "httpMethod": "POST",
- "id": "content.productdeliverytime.create",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The Google merchant ID of the account that contains the product. This account cannot be a multi-client account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/productdeliverytime",
- "request": {
- "$ref": "ProductDeliveryTime"
- },
- "response": {
- "$ref": "ProductDeliveryTime"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes the delivery time of a product.",
- "flatPath": "{merchantId}/productdeliverytime/{productId}",
- "httpMethod": "DELETE",
- "id": "content.productdeliverytime.delete",
- "parameterOrder": [
- "merchantId",
- "productId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The Google merchant ID of the account that contains the product. This account cannot be a multi-client account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "productId": {
- "description": "Required. The Content API ID of the product, in the form `channel:contentLanguage:targetCountry:offerId`.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/productdeliverytime/{productId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Gets `productDeliveryTime` by `productId`.",
- "flatPath": "{merchantId}/productdeliverytime/{productId}",
- "httpMethod": "GET",
- "id": "content.productdeliverytime.get",
- "parameterOrder": [
- "merchantId",
- "productId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The Google merchant ID of the account that contains the product. This account cannot be a multi-client account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "productId": {
- "description": "Required. The Content API ID of the product, in the form `channel:contentLanguage:targetCountry:offerId`.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/productdeliverytime/{productId}",
- "response": {
- "$ref": "ProductDeliveryTime"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "products": {
- "methods": {
- "custombatch": {
- "description": "Retrieves, inserts, and deletes multiple products in a single request.",
- "flatPath": "products/batch",
- "httpMethod": "POST",
- "id": "content.products.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "products/batch",
- "request": {
- "$ref": "ProductsCustomBatchRequest"
- },
- "response": {
- "$ref": "ProductsCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes a product from your Merchant Center account.",
- "flatPath": "{merchantId}/products/{productId}",
- "httpMethod": "DELETE",
- "id": "content.products.delete",
- "parameterOrder": [
- "merchantId",
- "productId"
- ],
- "parameters": {
- "feedId": {
- "description": "The Content API Supplemental Feed ID. If present then product deletion applies to the data in a supplemental feed. If absent, entire product will be deleted.",
- "format": "uint64",
- "location": "query",
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "productId": {
- "description": "The REST ID of the product.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/products/{productId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves a product from your Merchant Center account.",
- "flatPath": "{merchantId}/products/{productId}",
- "httpMethod": "GET",
- "id": "content.products.get",
- "parameterOrder": [
- "merchantId",
- "productId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "productId": {
- "description": "The REST ID of the product.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/products/{productId}",
- "response": {
- "$ref": "Product"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "insert": {
- "description": "Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry.",
- "flatPath": "{merchantId}/products",
- "httpMethod": "POST",
- "id": "content.products.insert",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "feedId": {
- "description": "The Content API Supplemental Feed ID. If present then product insertion applies to the data in a supplemental feed.",
- "format": "uint64",
- "location": "query",
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/products",
- "request": {
- "$ref": "Product"
- },
- "response": {
- "$ref": "Product"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the products in your Merchant Center account. The response might contain fewer items than specified by maxResults. Rely on nextPageToken to determine if there are more items to be requested.",
- "flatPath": "{merchantId}/products",
- "httpMethod": "GET",
- "id": "content.products.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "maxResults": {
- "description": "The maximum number of products to return in the response, used for paging. The default value is 25. The maximum value is 250.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the account that contains the products. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/products",
- "response": {
- "$ref": "ProductsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "update": {
- "description": "Updates an existing product in your Merchant Center account. Only updates attributes provided in the request.",
- "flatPath": "{merchantId}/products/{productId}",
- "httpMethod": "PATCH",
- "id": "content.products.update",
- "parameterOrder": [
- "merchantId",
- "productId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "productId": {
- "description": "The REST ID of the product for which to update.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "description": "The comma-separated list of product attributes to be updated. Example: `\"title,salePrice\"`. Attributes specified in the update mask without a value specified in the body will be deleted from the product. *You must specify the update mask to delete attributes.* Only top-level product attributes can be updated. If not defined, product attributes with set values will be updated and other attributes will stay unchanged.",
- "format": "google-fieldmask",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/products/{productId}",
- "request": {
- "$ref": "Product"
- },
- "response": {
- "$ref": "Product"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "productstatuses": {
- "methods": {
- "custombatch": {
- "description": "Gets the statuses of multiple products in a single request.",
- "flatPath": "productstatuses/batch",
- "httpMethod": "POST",
- "id": "content.productstatuses.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "productstatuses/batch",
- "request": {
- "$ref": "ProductstatusesCustomBatchRequest"
- },
- "response": {
- "$ref": "ProductstatusesCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Gets the status of a product from your Merchant Center account.",
- "flatPath": "{merchantId}/productstatuses/{productId}",
- "httpMethod": "GET",
- "id": "content.productstatuses.get",
- "parameterOrder": [
- "merchantId",
- "productId"
- ],
- "parameters": {
- "destinations": {
- "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "productId": {
- "description": "The REST ID of the product.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/productstatuses/{productId}",
- "response": {
- "$ref": "ProductStatus"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the statuses of the products in your Merchant Center account.",
- "flatPath": "{merchantId}/productstatuses",
- "httpMethod": "GET",
- "id": "content.productstatuses.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "destinations": {
- "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "maxResults": {
- "description": "The maximum number of product statuses to return in the response, used for paging. The default value is 25. The maximum value is 250.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the account that contains the products. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/productstatuses",
- "response": {
- "$ref": "ProductstatusesListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "promotions": {
- "methods": {
- "create": {
- "description": "Inserts a promotion for your Merchant Center account. If the promotion already exists, then it updates the promotion instead. To [end or delete] (https://developers.google.com/shopping-content/guides/promotions#end_a_promotion) a promotion update the time period of the promotion to a time that has already passed.",
- "flatPath": "{merchantId}/promotions",
- "httpMethod": "POST",
- "id": "content.promotions.create",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account that contains the collection.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/promotions",
- "request": {
- "$ref": "Promotion"
- },
- "response": {
- "$ref": "Promotion"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves a promotion from your Merchant Center account.",
- "flatPath": "{merchantId}/promotions/{id}",
- "httpMethod": "GET",
- "id": "content.promotions.get",
- "parameterOrder": [
- "merchantId",
- "id"
- ],
- "parameters": {
- "id": {
- "description": "Required. REST ID of the promotion to retrieve.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The ID of the account that contains the collection.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/promotions/{id}",
- "response": {
- "$ref": "Promotion"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "List all promotions from your Merchant Center account.",
- "flatPath": "{merchantId}/promotions",
- "httpMethod": "GET",
- "id": "content.promotions.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "countryCode": {
- "description": "[CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (for example, \"US\"), used as a filter on promotions target country.",
- "location": "query",
- "type": "string"
- },
- "languageCode": {
- "description": "The two-letter ISO 639-1 language code associated with the promotions, used as a filter.",
- "location": "query",
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The ID of the account that contains the collection.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of promotions to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "A page token, received from a previous `ListPromotion` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPromotion` must match the call that provided the page token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/promotions",
- "response": {
- "$ref": "ListPromotionResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "pubsubnotificationsettings": {
- "methods": {
- "get": {
- "description": "Retrieves a Merchant Center account's pubsub notification settings.",
- "flatPath": "{merchantId}/pubsubnotificationsettings",
- "httpMethod": "GET",
- "id": "content.pubsubnotificationsettings.get",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account for which to get pubsub notification settings.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/pubsubnotificationsettings",
- "response": {
- "$ref": "PubsubNotificationSettings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "update": {
- "description": "Register a Merchant Center account for pubsub notifications. Note that cloud topic name shouldn't be provided as part of the request.",
- "flatPath": "{merchantId}/pubsubnotificationsettings",
- "httpMethod": "PUT",
- "id": "content.pubsubnotificationsettings.update",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/pubsubnotificationsettings",
- "request": {
- "$ref": "PubsubNotificationSettings"
- },
- "response": {
- "$ref": "PubsubNotificationSettings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "quotas": {
- "methods": {
- "list": {
- "description": "Lists the daily call quota and usage per method for your Merchant Center account.",
- "flatPath": "{merchantId}/quotas",
- "httpMethod": "GET",
- "id": "content.quotas.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account that has quota. This account must be an admin.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of quotas to return in the response, used for paging. Defaults to 500; values above 1000 will be coerced to 1000.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/quotas",
- "response": {
- "$ref": "ListMethodQuotasResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "recommendations": {
- "methods": {
- "generate": {
- "description": "Generates recommendations for a merchant.",
- "flatPath": "{merchantId}/recommendations/generate",
- "httpMethod": "GET",
- "id": "content.recommendations.generate",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "allowedTag": {
- "description": "Optional. List of allowed tags. Tags are a set of predefined strings that describe the category that individual recommendation types belong to. User can specify zero or more tags in this field to indicate what categories of recommendations they want to receive. Current list of supported tags: - TREND",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "languageCode": {
- "description": "Optional. Language code of the client. If not set, the result will be in default language (English). This language code affects all fields prefixed with \"localized\". This should be set to ISO 639-1 country code. List of currently verified supported language code: en, fr, cs, da, de, es, it, nl, no, pl, pt, pt, fi, sv, vi, tr, th, ko, zh-CN, zh-TW, ja, id, hi",
- "location": "query",
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The ID of the account to fetch recommendations for.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/recommendations/generate",
- "response": {
- "$ref": "GenerateRecommendationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "reportInteraction": {
- "description": "Reports an interaction on a recommendation for a merchant.",
- "flatPath": "{merchantId}/recommendations/reportInteraction",
- "httpMethod": "POST",
- "id": "content.recommendations.reportInteraction",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account that wants to report an interaction.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/recommendations/reportInteraction",
- "request": {
- "$ref": "ReportInteractionRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "regionalinventory": {
- "methods": {
- "custombatch": {
- "description": "Updates regional inventory for multiple products or regions in a single request.",
- "flatPath": "regionalinventory/batch",
- "httpMethod": "POST",
- "id": "content.regionalinventory.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "regionalinventory/batch",
- "request": {
- "$ref": "RegionalinventoryCustomBatchRequest"
- },
- "response": {
- "$ref": "RegionalinventoryCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "insert": {
- "description": "Updates the regional inventory of a product in your Merchant Center account. If a regional inventory with the same region ID already exists, this method updates that entry.",
- "flatPath": "{merchantId}/products/{productId}/regionalinventory",
- "httpMethod": "POST",
- "id": "content.regionalinventory.insert",
- "parameterOrder": [
- "merchantId",
- "productId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account that contains the product. This account cannot be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "productId": {
- "description": "The REST ID of the product for which to update the regional inventory.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/products/{productId}/regionalinventory",
- "request": {
- "$ref": "RegionalInventory"
- },
- "response": {
- "$ref": "RegionalInventory"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "regions": {
- "methods": {
- "create": {
- "description": "Creates a region definition in your Merchant Center account.",
- "flatPath": "{merchantId}/regions",
- "httpMethod": "POST",
- "id": "content.regions.create",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to create region definition.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "regionId": {
- "description": "Required. The id of the region to create.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/regions",
- "request": {
- "$ref": "Region"
- },
- "response": {
- "$ref": "Region"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes a region definition from your Merchant Center account.",
- "flatPath": "{merchantId}/regions/{regionId}",
- "httpMethod": "DELETE",
- "id": "content.regions.delete",
- "parameterOrder": [
- "merchantId",
- "regionId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to delete region definition.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "regionId": {
- "description": "Required. The id of the region to delete.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/regions/{regionId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves a region defined in your Merchant Center account.",
- "flatPath": "{merchantId}/regions/{regionId}",
- "httpMethod": "GET",
- "id": "content.regions.get",
- "parameterOrder": [
- "merchantId",
- "regionId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to retrieve region definition.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "regionId": {
- "description": "Required. The id of the region to retrieve.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/regions/{regionId}",
- "response": {
- "$ref": "Region"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the regions in your Merchant Center account.",
- "flatPath": "{merchantId}/regions",
- "httpMethod": "GET",
- "id": "content.regions.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to list region definitions.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageSize": {
- "description": "The maximum number of regions to return. The service may return fewer than this value. If unspecified, at most 50 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.",
- "format": "int32",
- "location": "query",
- "type": "integer"
- },
- "pageToken": {
- "description": "A page token, received from a previous `ListRegions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRegions` must match the call that provided the page token.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/regions",
- "response": {
- "$ref": "ListRegionsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "patch": {
- "description": "Updates a region definition in your Merchant Center account.",
- "flatPath": "{merchantId}/regions/{regionId}",
- "httpMethod": "PATCH",
- "id": "content.regions.patch",
- "parameterOrder": [
- "merchantId",
- "regionId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to update region definition.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "regionId": {
- "description": "Required. The id of the region to update.",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "description": "Optional. The comma-separated field mask indicating the fields to update. Example: `\"displayName,postalCodeArea.regionCode\"`.",
- "format": "google-fieldmask",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/regions/{regionId}",
- "request": {
- "$ref": "Region"
- },
- "response": {
- "$ref": "Region"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "reports": {
- "methods": {
- "search": {
- "description": "Retrieves merchant performance metrics matching the search query and optionally segmented by selected dimensions.",
- "flatPath": "{merchantId}/reports/search",
- "httpMethod": "POST",
- "id": "content.reports.search",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. Id of the merchant making the call. Must be a standalone account or an MCA subaccount.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/reports/search",
- "request": {
- "$ref": "SearchRequest"
- },
- "response": {
- "$ref": "SearchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "returnpolicyonline": {
- "methods": {
- "create": {
- "description": "Creates a new return policy.",
- "flatPath": "{merchantId}/returnpolicyonline",
- "httpMethod": "POST",
- "id": "content.returnpolicyonline.create",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to retrieve the return policy online object.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/returnpolicyonline",
- "request": {
- "$ref": "ReturnPolicyOnline"
- },
- "response": {
- "$ref": "ReturnPolicyOnline"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "delete": {
- "description": "Deletes an existing return policy.",
- "flatPath": "{merchantId}/returnpolicyonline/{returnPolicyId}",
- "httpMethod": "DELETE",
- "id": "content.returnpolicyonline.delete",
- "parameterOrder": [
- "merchantId",
- "returnPolicyId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to retrieve the return policy online object.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "returnPolicyId": {
- "description": "Required. The id of the return policy to delete.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/returnpolicyonline/{returnPolicyId}",
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Gets an existing return policy.",
- "flatPath": "{merchantId}/returnpolicyonline/{returnPolicyId}",
- "httpMethod": "GET",
- "id": "content.returnpolicyonline.get",
- "parameterOrder": [
- "merchantId",
- "returnPolicyId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to retrieve the return policy online object.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "returnPolicyId": {
- "description": "Required. The id of the return policy to retrieve.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/returnpolicyonline/{returnPolicyId}",
- "response": {
- "$ref": "ReturnPolicyOnline"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists all existing return policies.",
- "flatPath": "{merchantId}/returnpolicyonline",
- "httpMethod": "GET",
- "id": "content.returnpolicyonline.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to retrieve the return policy online object.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/returnpolicyonline",
- "response": {
- "$ref": "ListReturnPolicyOnlineResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "patch": {
- "description": "Updates an existing return policy.",
- "flatPath": "{merchantId}/returnpolicyonline/{returnPolicyId}",
- "httpMethod": "PATCH",
- "id": "content.returnpolicyonline.patch",
- "parameterOrder": [
- "merchantId",
- "returnPolicyId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The id of the merchant for which to retrieve the return policy online object.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "returnPolicyId": {
- "description": "Required. The id of the return policy to update.",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/returnpolicyonline/{returnPolicyId}",
- "request": {
- "$ref": "ReturnPolicyOnline"
- },
- "response": {
- "$ref": "ReturnPolicyOnline"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "shippingsettings": {
- "methods": {
- "custombatch": {
- "description": "Retrieves and updates the shipping settings of multiple accounts in a single request.",
- "flatPath": "shippingsettings/batch",
- "httpMethod": "POST",
- "id": "content.shippingsettings.custombatch",
- "parameterOrder": [],
- "parameters": {},
- "path": "shippingsettings/batch",
- "request": {
- "$ref": "ShippingsettingsCustomBatchRequest"
- },
- "response": {
- "$ref": "ShippingsettingsCustomBatchResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "get": {
- "description": "Retrieves the shipping settings of the account.",
- "flatPath": "{merchantId}/shippingsettings/{accountId}",
- "httpMethod": "GET",
- "id": "content.shippingsettings.get",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which to get/update shipping settings.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/shippingsettings/{accountId}",
- "response": {
- "$ref": "ShippingSettings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "getsupportedcarriers": {
- "description": "Retrieves supported carriers and carrier services for an account.",
- "flatPath": "{merchantId}/supportedCarriers",
- "httpMethod": "GET",
- "id": "content.shippingsettings.getsupportedcarriers",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account for which to retrieve the supported carriers.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/supportedCarriers",
- "response": {
- "$ref": "ShippingsettingsGetSupportedCarriersResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "getsupportedholidays": {
- "description": "Retrieves supported holidays for an account.",
- "flatPath": "{merchantId}/supportedHolidays",
- "httpMethod": "GET",
- "id": "content.shippingsettings.getsupportedholidays",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account for which to retrieve the supported holidays.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/supportedHolidays",
- "response": {
- "$ref": "ShippingsettingsGetSupportedHolidaysResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "getsupportedpickupservices": {
- "description": "Retrieves supported pickup services for an account.",
- "flatPath": "{merchantId}/supportedPickupServices",
- "httpMethod": "GET",
- "id": "content.shippingsettings.getsupportedpickupservices",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "The ID of the account for which to retrieve the supported pickup services.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/supportedPickupServices",
- "response": {
- "$ref": "ShippingsettingsGetSupportedPickupServicesResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "list": {
- "description": "Lists the shipping settings of the sub-accounts in your Merchant Center account.",
- "flatPath": "{merchantId}/shippingsettings",
- "httpMethod": "GET",
- "id": "content.shippingsettings.list",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "maxResults": {
- "description": "The maximum number of shipping settings to return in the response, used for paging.",
- "format": "uint32",
- "location": "query",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the managing account. This must be a multi-client account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "pageToken": {
- "description": "The token returned by the previous request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "{merchantId}/shippingsettings",
- "response": {
- "$ref": "ShippingsettingsListResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "update": {
- "description": "Updates the shipping settings of the account. Any fields that are not provided are deleted from the resource.",
- "flatPath": "{merchantId}/shippingsettings/{accountId}",
- "httpMethod": "PUT",
- "id": "content.shippingsettings.update",
- "parameterOrder": [
- "merchantId",
- "accountId"
- ],
- "parameters": {
- "accountId": {
- "description": "The ID of the account for which to get/update shipping settings.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account. If this parameter is not the same as accountId, then this account must be a multi-client account and `accountId` must be the ID of a sub-account of this account.",
- "format": "uint64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/shippingsettings/{accountId}",
- "request": {
- "$ref": "ShippingSettings"
- },
- "response": {
- "$ref": "ShippingSettings"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- },
- "shoppingadsprogram": {
- "methods": {
- "get": {
- "description": "Retrieves the status and review eligibility for the Shopping Ads program. Returns errors and warnings if they require action to resolve, will become disapprovals, or impact impressions. Use `accountstatuses` to view all issues for an account.",
- "flatPath": "{merchantId}/shoppingadsprogram",
- "httpMethod": "GET",
- "id": "content.shoppingadsprogram.get",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/shoppingadsprogram",
- "response": {
- "$ref": "ShoppingAdsProgramStatus"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- },
- "requestreview": {
- "description": "Requests a review of Shopping ads in a specific region. This method deprecated. Use the `MerchantSupportService` to view product and account issues and request a review.",
- "flatPath": "{merchantId}/shoppingadsprogram/requestreview",
- "httpMethod": "POST",
- "id": "content.shoppingadsprogram.requestreview",
- "parameterOrder": [
- "merchantId"
- ],
- "parameters": {
- "merchantId": {
- "description": "Required. The ID of the account.",
- "format": "int64",
- "location": "path",
- "required": true,
- "type": "string"
- }
- },
- "path": "{merchantId}/shoppingadsprogram/requestreview",
- "request": {
- "$ref": "RequestReviewShoppingAdsRequest"
- },
- "scopes": [
- "https://www.googleapis.com/auth/content"
- ]
- }
- }
- }
- },
- "revision": "20260429",
- "rootUrl": "https://shoppingcontent.googleapis.com/",
- "schemas": {
- "Account": {
- "description": "Account data. After the creation of a new account it may take a few minutes before it's fully operational. The methods delete, insert, and update require the admin role.",
- "id": "Account",
- "properties": {
- "accountManagement": {
- "description": "Output only. How the account is managed. Acceptable values are: - \"`manual`\" - \"`automatic`\" ",
- "readOnly": true,
- "type": "string"
- },
- "adsLinks": {
- "description": "Linked Ads accounts that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected either in the Ads interface or through the Google Ads API. To delete an active link, or to cancel a link request, remove it from the list.",
- "items": {
- "$ref": "AccountAdsLink"
- },
- "type": "array"
- },
- "adultContent": {
- "description": "Indicates whether the merchant sells adult content.",
- "type": "boolean"
- },
- "automaticImprovements": {
- "$ref": "AccountAutomaticImprovements",
- "description": "The automatic improvements of the account can be used to automatically update items, improve images and shipping. Each section inside AutomaticImprovements is updated separately."
- },
- "automaticLabelIds": {
- "description": "Automatically created label IDs that are assigned to the account by CSS Center.",
- "items": {
- "format": "uint64",
- "type": "string"
- },
- "type": "array"
- },
- "businessIdentity": {
- "$ref": "AccountBusinessIdentity",
- "description": "The business identity attributes can be used to self-declare attributes that let customers know more about your business."
- },
- "businessInformation": {
- "$ref": "AccountBusinessInformation",
- "description": "The business information of the account."
- },
- "conversionSettings": {
- "$ref": "AccountConversionSettings",
- "description": "Settings for conversion tracking."
- },
- "cssId": {
- "description": "ID of CSS the account belongs to.",
- "format": "uint64",
- "type": "string"
- },
- "googleMyBusinessLink": {
- "$ref": "AccountGoogleMyBusinessLink",
- "description": "The Business Profile which is linked or in the process of being linked with the Merchant Center account."
- },
- "id": {
- "description": "Required. 64-bit Merchant Center account ID.",
- "format": "uint64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#account`\".",
- "type": "string"
- },
- "labelIds": {
- "description": "Manually created label IDs that are assigned to the account by CSS.",
- "items": {
- "format": "uint64",
- "type": "string"
- },
- "type": "array"
- },
- "name": {
- "description": "Required. Display name for the account.",
- "type": "string"
- },
- "sellerId": {
- "description": "Client-specific, locally-unique, internal ID for the child account.",
- "type": "string"
- },
- "users": {
- "description": "Users with access to the account. Every account (except for subaccounts) must have at least one admin user.",
- "items": {
- "$ref": "AccountUser"
- },
- "type": "array"
- },
- "websiteUrl": {
- "description": "The merchant's website.",
- "type": "string"
- },
- "youtubeChannelLinks": {
- "description": "Linked YouTube channels that are active or pending approval. To create a new link request, add a new link with status `active` to the list. It will remain in a `pending` state until approved or rejected in the YT Creator Studio interface. To delete an active link, or to cancel a link request, remove it from the list.",
- "items": {
- "$ref": "AccountYouTubeChannelLink"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AccountAddress": {
- "id": "AccountAddress",
- "properties": {
- "country": {
- "description": "CLDR country code (for example, \"US\"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.",
- "type": "string"
- },
- "locality": {
- "description": "City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).",
- "type": "string"
- },
- "postalCode": {
- "description": "Postal code or ZIP (for example, \"94043\").",
- "type": "string"
- },
- "region": {
- "description": "Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\").",
- "type": "string"
- },
- "streetAddress": {
- "description": "Street-level part of the address. Use `\\n` to add a second line.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountAdsLink": {
- "id": "AccountAdsLink",
- "properties": {
- "adsId": {
- "description": "Customer ID of the Ads account.",
- "format": "uint64",
- "type": "string"
- },
- "status": {
- "description": "Status of the link between this Merchant Center account and the Ads account. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in Google Ads or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending. Acceptable values are: - \"`active`\" - \"`pending`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountAutomaticImprovements": {
- "description": "The automatic improvements of the account can be used to automatically update items, improve images and shipping.",
- "id": "AccountAutomaticImprovements",
- "properties": {
- "imageImprovements": {
- "$ref": "AccountImageImprovements",
- "description": "This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973) This field is only updated (cleared) if provided."
- },
- "itemUpdates": {
- "$ref": "AccountItemUpdates",
- "description": "Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown. This field is only updated (cleared) if provided."
- },
- "shippingImprovements": {
- "$ref": "AccountShippingImprovements",
- "description": "Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: - Delivery address of an order - Current handling time and shipping time settings - Estimated weekdays or business days - Parcel tracking data This field is only updated (cleared) if provided."
- }
- },
- "type": "object"
- },
- "AccountBusinessIdentity": {
- "description": "The [business identity attributes](https://support.google.com/merchants/answer/10342414) can be used to self-declare attributes that let customers know more about your business.",
- "id": "AccountBusinessIdentity",
- "properties": {
- "blackOwned": {
- "$ref": "AccountIdentityType",
- "description": "Specifies whether the business identifies itself as being black-owned. This optional field is only available for merchants with a business country set to \"US\". This field is not allowed for marketplaces or marketplace sellers."
- },
- "includeForPromotions": {
- "description": "Required. By setting this field, your business may be included in promotions for all the selected attributes. If you clear this option, it won't affect your identification with any of the attributes. For this field to be set, the merchant must self identify with at least one of the `AccountIdentityType`. If none are included, the request will be considered invalid.",
- "type": "boolean"
- },
- "latinoOwned": {
- "$ref": "AccountIdentityType",
- "description": "Specifies whether the business identifies itself as being latino-owned. This optional field is only available for merchants with a business country set to \"US\". This field is not allowed for marketplaces or marketplace sellers."
- },
- "smallBusiness": {
- "$ref": "AccountIdentityType",
- "description": "Specifies whether the business identifies itself as a small business. This optional field is only available for merchants with a business country set to \"US\". It is also not allowed for marketplaces, but it is allowed to marketplace sellers."
- },
- "veteranOwned": {
- "$ref": "AccountIdentityType",
- "description": "Specifies whether the business identifies itself as being veteran-owned. This optional field is only available for merchants with a business country set to \"US\". This field is not allowed for marketplaces or marketplace sellers."
- },
- "womenOwned": {
- "$ref": "AccountIdentityType",
- "description": "Specifies whether the business identifies itself as being women-owned. This optional field is only available for merchants with a business country set to \"US\". This field is not allowed for marketplaces or marketplace sellers."
- }
- },
- "type": "object"
- },
- "AccountBusinessInformation": {
- "id": "AccountBusinessInformation",
- "properties": {
- "address": {
- "$ref": "AccountAddress",
- "description": "The address of the business. Use `\\n` to add a second address line."
- },
- "customerService": {
- "$ref": "AccountCustomerService",
- "description": "The customer service information of the business."
- },
- "koreanBusinessRegistrationNumber": {
- "description": "The 10-digit [Korean business registration number](https://support.google.com/merchants/answer/9037766) separated with dashes in the format: XXX-XX-XXXXX. This field will only be updated if explicitly set.",
- "type": "string"
- },
- "phoneNumber": {
- "description": "The phone number of the business in [E.164](https://en.wikipedia.org/wiki/E.164) format. This can only be updated if a verified phone number is not already set. To replace a verified phone number use the `Accounts.requestphoneverification` and `Accounts.verifyphonenumber`.",
- "type": "string"
- },
- "phoneVerificationStatus": {
- "description": "Verification status of the phone number of the business. This status is read only and can be updated only by successful phone verification. Acceptable values are: - \"`verified`\" - \"`unverified`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountConversionSettings": {
- "description": "Settings for conversion tracking.",
- "id": "AccountConversionSettings",
- "properties": {
- "freeListingsAutoTaggingEnabled": {
- "description": "When enabled, free listing URLs have a parameter to enable conversion tracking for products owned by the current merchant account. See [auto-tagging](https://support.google.com/merchants/answer/11127659).",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "AccountCredentials": {
- "description": "Credentials allowing Google to call a partner's API on behalf of a merchant.",
- "id": "AccountCredentials",
- "properties": {
- "accessToken": {
- "description": "An OAuth access token.",
- "type": "string"
- },
- "expiresIn": {
- "description": "The amount of time, in seconds, after which the access token is no longer valid.",
- "format": "int64",
- "type": "string"
- },
- "purpose": {
- "description": "Indicates to Google how Google should use these OAuth tokens.",
- "enum": [
- "ACCOUNT_CREDENTIALS_PURPOSE_UNSPECIFIED",
- "SHOPIFY_ORDER_MANAGEMENT",
- "SHOPIFY_INTEGRATION"
- ],
- "enumDeprecated": [
- false,
- true,
- false
- ],
- "enumDescriptions": [
- "Unknown purpose.",
- "The credentials allow Google to manage Shopify orders on behalf of the merchant (deprecated).",
- "The credentials allow Google to manage Shopify integration on behalf of the merchant."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountCustomerService": {
- "id": "AccountCustomerService",
- "properties": {
- "email": {
- "description": "Customer service email.",
- "type": "string"
- },
- "phoneNumber": {
- "description": "Customer service phone number.",
- "type": "string"
- },
- "url": {
- "description": "Customer service URL.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountGoogleMyBusinessLink": {
- "id": "AccountGoogleMyBusinessLink",
- "properties": {
- "gmbAccountId": {
- "description": "The ID of the Business Profile. If this is provided, then `gmbEmail` is ignored. The value of this field should match the `accountId` used by the Business Profile API.",
- "type": "string"
- },
- "gmbEmail": {
- "description": "The Business Profile email address of a specific account within a Business Profile. A sample account within a Business Profile could be a business account with set of locations, managed under the Business Profile.",
- "type": "string"
- },
- "status": {
- "description": "Status of the link between this Merchant Center account and the Business Profile. Acceptable values are: - \"`active`\" - \"`pending`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountIdentifier": {
- "id": "AccountIdentifier",
- "properties": {
- "aggregatorId": {
- "description": "The aggregator ID, set for aggregators and subaccounts (in that case, it represents the aggregator of the subaccount).",
- "format": "uint64",
- "type": "string"
- },
- "merchantId": {
- "description": "The merchant account ID, set for individual accounts and subaccounts.",
- "format": "uint64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountIdentityType": {
- "description": "The account identity type used to specify attributes.",
- "id": "AccountIdentityType",
- "properties": {
- "selfIdentified": {
- "description": "Optional. Indicates that the business identifies itself with a given identity type. Setting this field does not automatically mean eligibility for promotions.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "AccountImageImprovements": {
- "description": "This improvement will attempt to automatically correct submitted images if they don't meet the [image requirements](https://support.google.com/merchants/answer/6324350), for example, removing overlays. If successful, the image will be replaced and approved. This improvement is only applied to images of disapproved offers. For more information see: [Automatic image improvements](https://support.google.com/merchants/answer/9242973)",
- "id": "AccountImageImprovements",
- "properties": {
- "accountImageImprovementsSettings": {
- "$ref": "AccountImageImprovementsSettings",
- "description": "Determines how the images should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator."
- },
- "effectiveAllowAutomaticImageImprovements": {
- "description": "Output only. The effective value of allow_automatic_image_improvements. If account_image_improvements_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.",
- "readOnly": true,
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "AccountImageImprovementsSettings": {
- "description": "Settings for the Automatic Image Improvements.",
- "id": "AccountImageImprovementsSettings",
- "properties": {
- "allowAutomaticImageImprovements": {
- "description": "Enables automatic image improvements.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "AccountIssue": {
- "description": "An issue affecting specific merchant.",
- "id": "AccountIssue",
- "properties": {
- "actions": {
- "description": "A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when merchant disagrees with the issue. Actions that are supported in (your) third-party application can be rendered as buttons and should be available to merchant when they expand the issue.",
- "items": {
- "$ref": "Action"
- },
- "type": "array"
- },
- "impact": {
- "$ref": "AccountIssueImpact",
- "description": "Clarifies the severity of the issue. The summarizing message, if present, should be shown right under the title for each issue. It helps merchants to quickly understand the impact of the issue. The detailed breakdown helps the merchant to fully understand the impact of the issue. It can be rendered as dialog that opens when the merchant mouse over the summarized impact statement. Issues with different severity can be styled differently. They may use a different color or icon to signal the difference between `ERROR`, `WARNING` and `INFO`."
- },
- "prerenderedContent": {
- "description": "Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class.",
- "type": "string"
- },
- "prerenderedOutOfCourtDisputeSettlement": {
- "description": "Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `ods-section`* - wrapper around the out-of-court dispute resolution section * `ods-description`* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link. * `ods-param`* - wrapper around the header-value pair for parameters that merchant may need to provide during the ODS process. * `ods-routing-id`* - ods param for the Routing ID. * `ods-reference-id`* - ods param for the Routing ID. * `ods-param-header`* - header for the ODS parameter * `ods-param-value`* - value of the ODS parameter. This value should be rendered in a way that it is easy for merchants to identify and copy. * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon.",
- "type": "string"
- },
- "title": {
- "description": "Title of the issue.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountIssueImpact": {
- "description": "Overall impact of the issue.",
- "id": "AccountIssueImpact",
- "properties": {
- "breakdowns": {
- "description": "Detailed impact breakdown. Explains the types of restriction the issue has in different shopping destinations and territory. If present, it should be rendered to the merchant. Can be shown as a mouse over dropdown or a dialog. Each breakdown item represents a group of regions with the same impact details.",
- "items": {
- "$ref": "Breakdown"
- },
- "type": "array"
- },
- "message": {
- "description": "Optional. Message summarizing the overall impact of the issue. If present, it should be rendered to the merchant. For example: \"Disapproves 90k offers in 25 countries\"",
- "type": "string"
- },
- "severity": {
- "description": "The severity of the issue.",
- "enum": [
- "SEVERITY_UNSPECIFIED",
- "ERROR",
- "WARNING",
- "INFO"
- ],
- "enumDescriptions": [
- "Default value. Will never be provided by the API.",
- "Causes either an account suspension or an item disapproval. Errors should be resolved as soon as possible to ensure items are eligible to appear in results again.",
- "Warnings can negatively impact the performance of ads and can lead to item or account suspensions in the future unless the issue is resolved.",
- "Infos are suggested optimizations to increase data quality. Resolving these issues is recommended, but not required."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountItemUpdates": {
- "description": "Turning on [item updates](https://support.google.com/merchants/answer/3246284) allows Google to automatically update items for you. When item updates are on, Google uses the structured data markup on the website and advanced data extractors to update the price and availability of the items. When the item updates are off, items with mismatched data aren't shown.",
- "id": "AccountItemUpdates",
- "properties": {
- "accountItemUpdatesSettings": {
- "$ref": "AccountItemUpdatesSettings",
- "description": "Determines which attributes of the items should be automatically updated. If this field is not present, then the settings will be deleted. If there are no settings for subaccount, they are inherited from aggregator."
- },
- "effectiveAllowAvailabilityUpdates": {
- "description": "Output only. The effective value of allow_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.",
- "readOnly": true,
- "type": "boolean"
- },
- "effectiveAllowConditionUpdates": {
- "description": "Output only. The effective value of allow_condition_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.",
- "readOnly": true,
- "type": "boolean"
- },
- "effectiveAllowPriceUpdates": {
- "description": "Output only. The effective value of allow_price_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.",
- "readOnly": true,
- "type": "boolean"
- },
- "effectiveAllowStrictAvailabilityUpdates": {
- "description": "Output only. The effective value of allow_strict_availability_updates. If account_item_updates_settings is present, then this value is the same. Otherwise, it represents the inherited value of the parent account. Read-only.",
- "readOnly": true,
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "AccountItemUpdatesSettings": {
- "description": "Settings for the Automatic Item Updates.",
- "id": "AccountItemUpdatesSettings",
- "properties": {
- "allowAvailabilityUpdates": {
- "description": "If availability updates are enabled, any previous availability values get overwritten if Google finds an out-of-stock annotation on the offer's page. If additionally `allow_availability_updates` field is set to true, values get overwritten if Google finds an in-stock annotation on the offer’s page.",
- "type": "boolean"
- },
- "allowConditionUpdates": {
- "description": "If condition updates are enabled, Google always updates item condition with the condition detected from the details of your product.",
- "type": "boolean"
- },
- "allowPriceUpdates": {
- "description": "If price updates are enabled, Google always updates the active price with the crawled information.",
- "type": "boolean"
- },
- "allowStrictAvailabilityUpdates": {
- "description": "If allow_availability_updates is enabled, items are automatically updated in all your Shopping target countries. By default, availability updates will only be applied to items that are 'out of stock' on your website but 'in stock' on Shopping. Set this to true to also update items that are 'in stock' on your website, but 'out of stock' on Google Shopping. In order for this field to have an effect, you must also allow availability updates.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "AccountLabel": {
- "description": "Label assigned by CSS domain or CSS group to one of its sub-accounts.",
- "id": "AccountLabel",
- "properties": {
- "accountId": {
- "description": "Immutable. The ID of account this label belongs to.",
- "format": "int64",
- "type": "string"
- },
- "description": {
- "description": "The description of this label.",
- "type": "string"
- },
- "labelId": {
- "description": "Output only. The ID of the label.",
- "format": "int64",
- "readOnly": true,
- "type": "string"
- },
- "labelType": {
- "description": "Output only. The type of this label.",
- "enum": [
- "LABEL_TYPE_UNSPECIFIED",
- "MANUAL",
- "AUTOMATIC"
- ],
- "enumDescriptions": [
- "Unknown label type.",
- "Indicates that the label was created manually.",
- "Indicates that the label was created automatically by CSS Center."
- ],
- "readOnly": true,
- "type": "string"
- },
- "name": {
- "description": "The display name of this label.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountReturnCarrier": {
- "description": " The return carrier information. This service is designed for merchants enrolled in the Buy on Google program. ",
- "id": "AccountReturnCarrier",
- "properties": {
- "carrierAccountId": {
- "description": "Output only. Immutable. The Google-provided unique carrier ID, used to update the resource.",
- "format": "int64",
- "readOnly": true,
- "type": "string"
- },
- "carrierAccountName": {
- "description": "Name of the carrier account.",
- "type": "string"
- },
- "carrierAccountNumber": {
- "description": "Number of the carrier account.",
- "type": "string"
- },
- "carrierCode": {
- "description": "The carrier code enum. Accepts the values FEDEX or UPS.",
- "enum": [
- "CARRIER_CODE_UNSPECIFIED",
- "FEDEX",
- "UPS"
- ],
- "enumDescriptions": [
- "Carrier not specified",
- "FedEx carrier",
- "UPS carrier"
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountShippingImprovements": {
- "description": "Not available for MCAs [accounts](https://support.google.com/merchants/answer/188487). By turning on [automatic shipping improvements](https://support.google.com/merchants/answer/10027038), you are allowing Google to improve the accuracy of your delivery times shown to shoppers using Google. More accurate delivery times, especially when faster, typically lead to better conversion rates. Google will improve your estimated delivery times based on various factors: * Delivery address of an order * Current handling time and shipping time settings * Estimated weekdays or business days * Parcel tracking data",
- "id": "AccountShippingImprovements",
- "properties": {
- "allowShippingImprovements": {
- "description": "Enables automatic shipping improvements.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "AccountStatus": {
- "description": "The status of an account, that is, information about its products, which is computed offline and not returned immediately at insertion time.",
- "id": "AccountStatus",
- "properties": {
- "accountId": {
- "description": "The ID of the account for which the status is reported.",
- "type": "string"
- },
- "accountLevelIssues": {
- "description": "A list of account level issues.",
- "items": {
- "$ref": "AccountStatusAccountLevelIssue"
- },
- "type": "array"
- },
- "accountManagement": {
- "description": "How the account is managed. Acceptable values are: - \"`manual`\" - \"`automatic`\" ",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountStatus`\"",
- "type": "string"
- },
- "products": {
- "description": "List of product-related data by channel, destination, and country. Data in this field may be delayed by up to 30 minutes.",
- "items": {
- "$ref": "AccountStatusProducts"
- },
- "type": "array"
- },
- "websiteClaimed": {
- "description": "Whether the account's website is claimed or not.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "AccountStatusAccountLevelIssue": {
- "id": "AccountStatusAccountLevelIssue",
- "properties": {
- "country": {
- "description": "Country for which this issue is reported.",
- "type": "string"
- },
- "destination": {
- "description": "The destination the issue applies to. If this field is empty then the issue applies to all available destinations.",
- "type": "string"
- },
- "detail": {
- "description": "Additional details about the issue.",
- "type": "string"
- },
- "documentation": {
- "description": "The URL of a web page to help resolving this issue.",
- "type": "string"
- },
- "id": {
- "description": "Issue identifier.",
- "type": "string"
- },
- "severity": {
- "description": "Severity of the issue. Acceptable values are: - \"`critical`\" - \"`error`\" - \"`suggestion`\" ",
- "type": "string"
- },
- "title": {
- "description": "Short description of the issue.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountStatusItemLevelIssue": {
- "id": "AccountStatusItemLevelIssue",
- "properties": {
- "attributeName": {
- "description": "The attribute's name, if the issue is caused by a single attribute.",
- "type": "string"
- },
- "code": {
- "description": "The error code of the issue.",
- "type": "string"
- },
- "description": {
- "description": "A short issue description in English.",
- "type": "string"
- },
- "detail": {
- "description": "A detailed issue description in English.",
- "type": "string"
- },
- "documentation": {
- "description": "The URL of a web page to help with resolving this issue.",
- "type": "string"
- },
- "numItems": {
- "description": "Number of items with this issue.",
- "format": "int64",
- "type": "string"
- },
- "resolution": {
- "description": "Whether the issue can be resolved by the merchant.",
- "type": "string"
- },
- "servability": {
- "description": "How this issue affects serving of the offer.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountStatusProducts": {
- "id": "AccountStatusProducts",
- "properties": {
- "channel": {
- "description": "The channel the data applies to. Acceptable values are: - \"`local`\" - \"`online`\" ",
- "type": "string"
- },
- "country": {
- "description": "The country the data applies to.",
- "type": "string"
- },
- "destination": {
- "description": "The destination the data applies to.",
- "type": "string"
- },
- "itemLevelIssues": {
- "description": "List of item-level issues.",
- "items": {
- "$ref": "AccountStatusItemLevelIssue"
- },
- "type": "array"
- },
- "statistics": {
- "$ref": "AccountStatusStatistics",
- "description": "Aggregated product statistics."
- }
- },
- "type": "object"
- },
- "AccountStatusStatistics": {
- "id": "AccountStatusStatistics",
- "properties": {
- "active": {
- "description": "Number of active offers.",
- "format": "int64",
- "type": "string"
- },
- "disapproved": {
- "description": "Number of disapproved offers.",
- "format": "int64",
- "type": "string"
- },
- "expiring": {
- "description": "Number of expiring offers.",
- "format": "int64",
- "type": "string"
- },
- "pending": {
- "description": "Number of pending offers.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountTax": {
- "description": "The tax settings of a merchant account. All methods require the admin role.",
- "id": "AccountTax",
- "properties": {
- "accountId": {
- "description": "Required. The ID of the account to which these account tax settings belong.",
- "format": "uint64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountTax`\".",
- "type": "string"
- },
- "rules": {
- "description": "Tax rules. Updating the tax rules will enable \"US\" taxes (not reversible). Defining no rules is equivalent to not charging tax at all.",
- "items": {
- "$ref": "AccountTaxTaxRule"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AccountTaxTaxRule": {
- "description": "Tax calculation rule to apply in a state or province (US only).",
- "id": "AccountTaxTaxRule",
- "properties": {
- "country": {
- "description": "Country code in which tax is applicable.",
- "type": "string"
- },
- "locationId": {
- "description": "Required. State (or province) is which the tax is applicable, described by its location ID (also called criteria ID).",
- "format": "uint64",
- "type": "string"
- },
- "ratePercent": {
- "description": "Explicit tax rate in percent, represented as a floating point number without the percentage character. Must not be negative.",
- "type": "string"
- },
- "shippingTaxed": {
- "description": "If true, shipping charges are also taxed.",
- "type": "boolean"
- },
- "useGlobalRate": {
- "description": "Whether the tax rate is taken from a global tax table or specified explicitly.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "AccountUser": {
- "id": "AccountUser",
- "properties": {
- "admin": {
- "description": "Whether user is an admin.",
- "type": "boolean"
- },
- "emailAddress": {
- "description": "User's email address.",
- "type": "string"
- },
- "orderManager": {
- "deprecated": true,
- "description": "This role is deprecated and can no longer be assigned. Any value set will be ignored.",
- "type": "boolean"
- },
- "paymentsAnalyst": {
- "deprecated": true,
- "description": "This role is deprecated and can no longer be assigned. Any value set will be ignored.",
- "type": "boolean"
- },
- "paymentsManager": {
- "deprecated": true,
- "description": "This role is deprecated and can no longer be assigned. Any value set will be ignored.",
- "type": "boolean"
- },
- "readOnly": {
- "description": "Optional. Whether user has standard read-only access.",
- "type": "boolean"
- },
- "reportingManager": {
- "description": "Whether user is a reporting manager. This role is equivalent to the Performance and insights role in Merchant Center.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "AccountYouTubeChannelLink": {
- "id": "AccountYouTubeChannelLink",
- "properties": {
- "channelId": {
- "description": "Channel ID.",
- "type": "string"
- },
- "status": {
- "description": "Status of the link between this Merchant Center account and the YouTube channel. Upon retrieval, it represents the actual status of the link and can be either `active` if it was approved in YT Creator Studio or `pending` if it's pending approval. Upon insertion, it represents the *intended* status of the link. Re-uploading a link with status `active` when it's still pending or with status `pending` when it's already active will have no effect: the status will remain unchanged. Re-uploading a link with deprecated status `inactive` is equivalent to not submitting the link at all and will delete the link if it was active or cancel the link request if it was pending.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountsAuthInfoResponse": {
- "id": "AccountsAuthInfoResponse",
- "properties": {
- "accountIdentifiers": {
- "description": "The account identifiers corresponding to the authenticated user. - For an individual account: only the merchant ID is defined - For an aggregator: only the aggregator ID is defined - For a subaccount of an MCA: both the merchant ID and the aggregator ID are defined. ",
- "items": {
- "$ref": "AccountIdentifier"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountsAuthInfoResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountsClaimWebsiteResponse": {
- "id": "AccountsClaimWebsiteResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountsClaimWebsiteResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountsCustomBatchRequest": {
- "id": "AccountsCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "AccountsCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AccountsCustomBatchRequestEntry": {
- "description": "A batch entry encoding a single non-batch accounts request.",
- "id": "AccountsCustomBatchRequestEntry",
- "properties": {
- "account": {
- "$ref": "Account",
- "description": "The account to create or update. Only defined if the method is `insert` or `update`."
- },
- "accountId": {
- "description": "The ID of the targeted account. Only defined if the method is not `insert`.",
- "format": "uint64",
- "type": "string"
- },
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "force": {
- "description": "Whether the account should be deleted if the account has offers. Only applicable if the method is `delete`.",
- "type": "boolean"
- },
- "labelIds": {
- "description": "Label IDs for the 'updatelabels' request.",
- "items": {
- "format": "uint64",
- "type": "string"
- },
- "type": "array"
- },
- "linkRequest": {
- "$ref": "AccountsCustomBatchRequestEntryLinkRequest",
- "description": "Details about the `link` request."
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`claimWebsite`\" - \"`delete`\" - \"`get`\" - \"`insert`\" - \"`link`\" - \"`update`\" ",
- "type": "string"
- },
- "overwrite": {
- "description": "Only applicable if the method is `claimwebsite`. Indicates whether or not to take the claim from another account in case there is a conflict.",
- "type": "boolean"
- },
- "view": {
- "description": "Controls which fields are visible. Only applicable if the method is 'get'.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountsCustomBatchRequestEntryLinkRequest": {
- "id": "AccountsCustomBatchRequestEntryLinkRequest",
- "properties": {
- "action": {
- "description": "Action to perform for this link. The `\"request\"` action is only available to select merchants. Acceptable values are: - \"`approve`\" - \"`remove`\" - \"`request`\" ",
- "type": "string"
- },
- "linkType": {
- "description": "Type of the link between the two accounts. Acceptable values are: - \"`channelPartner`\" - \"`eCommercePlatform`\" - \"`paymentServiceProvider`\" - \"`localProductManager`\" ",
- "type": "string"
- },
- "linkedAccountId": {
- "description": "The ID of the linked account.",
- "type": "string"
- },
- "services": {
- "description": "Provided services. Acceptable values are: - \"`shoppingAdsProductManagement`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingActionsOrderManagement`\" - \"`paymentProcessing`\" - \"`localProductManagement`\" ",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AccountsCustomBatchResponse": {
- "id": "AccountsCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "AccountsCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountsCustomBatchResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountsCustomBatchResponseEntry": {
- "description": "A batch entry encoding a single non-batch accounts response.",
- "id": "AccountsCustomBatchResponseEntry",
- "properties": {
- "account": {
- "$ref": "Account",
- "description": "The retrieved, created, or updated account. Not defined if the method was `delete`, `claimwebsite` or `link`."
- },
- "batchId": {
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors for failed custombatch entries. *Note:* Schema errors fail the whole request."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountsCustomBatchResponseEntry`\"",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountsLinkRequest": {
- "id": "AccountsLinkRequest",
- "properties": {
- "action": {
- "description": "Action to perform for this link. The `\"request\"` action is only available to select merchants. Acceptable values are: - \"`approve`\" - \"`remove`\" - \"`request`\" ",
- "type": "string"
- },
- "eCommercePlatformLinkInfo": {
- "$ref": "ECommercePlatformLinkInfo",
- "description": "Additional information required for `eCommercePlatform` link type."
- },
- "linkType": {
- "description": "Type of the link between the two accounts. Acceptable values are: - \"`channelPartner`\" - \"`eCommercePlatform`\" - \"`paymentServiceProvider`\" ",
- "type": "string"
- },
- "linkedAccountId": {
- "description": "The ID of the linked account.",
- "type": "string"
- },
- "paymentServiceProviderLinkInfo": {
- "$ref": "PaymentServiceProviderLinkInfo",
- "description": "Additional information required for `paymentServiceProvider` link type."
- },
- "services": {
- "description": " Acceptable values are: - \"`shoppingAdsProductManagement`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingActionsOrderManagement`\" - \"`paymentProcessing`\" ",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AccountsLinkResponse": {
- "id": "AccountsLinkResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountsLinkResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountsListLinksResponse": {
- "id": "AccountsListLinksResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountsListLinksResponse`\".",
- "type": "string"
- },
- "links": {
- "description": "The list of available links.",
- "items": {
- "$ref": "LinkedAccount"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of links.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountsListResponse": {
- "id": "AccountsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountsListResponse`\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of accounts.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "Account"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AccountsUpdateLabelsRequest": {
- "id": "AccountsUpdateLabelsRequest",
- "properties": {
- "labelIds": {
- "description": "The IDs of labels that should be assigned to the account.",
- "items": {
- "format": "uint64",
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AccountsUpdateLabelsResponse": {
- "id": "AccountsUpdateLabelsResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountsUpdateLabelsResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountstatusesCustomBatchRequest": {
- "id": "AccountstatusesCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "AccountstatusesCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AccountstatusesCustomBatchRequestEntry": {
- "description": "A batch entry encoding a single non-batch accountstatuses request.",
- "id": "AccountstatusesCustomBatchRequestEntry",
- "properties": {
- "accountId": {
- "description": "The ID of the (sub-)account whose status to get.",
- "format": "uint64",
- "type": "string"
- },
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "destinations": {
- "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`get`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountstatusesCustomBatchResponse": {
- "id": "AccountstatusesCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "AccountstatusesCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountstatusesCustomBatchResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccountstatusesCustomBatchResponseEntry": {
- "description": "A batch entry encoding a single non-batch accountstatuses response.",
- "id": "AccountstatusesCustomBatchResponseEntry",
- "properties": {
- "accountStatus": {
- "$ref": "AccountStatus",
- "description": "The requested account status. Defined if and only if the request was successful."
- },
- "batchId": {
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors for failed custombatch entries. *Note:* Schema errors fail the whole request."
- }
- },
- "type": "object"
- },
- "AccountstatusesListResponse": {
- "id": "AccountstatusesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accountstatusesListResponse`\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of account statuses.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "AccountStatus"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AccounttaxCustomBatchRequest": {
- "id": "AccounttaxCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "AccounttaxCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AccounttaxCustomBatchRequestEntry": {
- "description": "A batch entry encoding a single non-batch accounttax request.",
- "id": "AccounttaxCustomBatchRequestEntry",
- "properties": {
- "accountId": {
- "description": "The ID of the account for which to get/update account tax settings.",
- "format": "uint64",
- "type": "string"
- },
- "accountTax": {
- "$ref": "AccountTax",
- "description": "The account tax settings to update. Only defined if the method is `update`."
- },
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`update`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccounttaxCustomBatchResponse": {
- "id": "AccounttaxCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "AccounttaxCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accounttaxCustomBatchResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccounttaxCustomBatchResponseEntry": {
- "description": "A batch entry encoding a single non-batch accounttax response.",
- "id": "AccounttaxCustomBatchResponseEntry",
- "properties": {
- "accountTax": {
- "$ref": "AccountTax",
- "description": "The retrieved or updated account tax settings."
- },
- "batchId": {
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors for failed custombatch entries. *Note:* Schema errors fail the whole request."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accounttaxCustomBatchResponseEntry`\"",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AccounttaxListResponse": {
- "id": "AccounttaxListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#accounttaxListResponse`\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of account tax settings.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "AccountTax"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "Action": {
- "description": "An actionable step that can be executed to solve the issue.",
- "id": "Action",
- "properties": {
- "builtinSimpleAction": {
- "$ref": "BuiltInSimpleAction",
- "description": "Action implemented and performed in (your) third-party application. The application should point the merchant to the place, where they can access the corresponding functionality or provide instructions, if the specific functionality is not available."
- },
- "builtinUserInputAction": {
- "$ref": "BuiltInUserInputAction",
- "description": "Action implemented and performed in (your) third-party application. The application needs to show an additional content and input form to the merchant as specified for given action. They can trigger the action only when they provided all required inputs."
- },
- "buttonLabel": {
- "description": "Label of the action button.",
- "type": "string"
- },
- "externalAction": {
- "$ref": "ExternalAction",
- "description": "Action that is implemented and performed outside of (your) third-party application. The application needs to redirect the merchant to the external location where they can perform the action."
- },
- "isAvailable": {
- "description": "Controlling whether the button is active or disabled. The value is 'false' when the action was already requested or is not available. If the action is not available then a reason will be present. If (your) third-party application shows a disabled button for action that is not available, then it should also show reasons.",
- "type": "boolean"
- },
- "reasons": {
- "description": "List of reasons why the action is not available. The list of reasons is empty if the action is available. If there is only one reason, it can be displayed next to the disabled button. If there are more reasons, all of them should be displayed, for example in a pop-up dialog.",
- "items": {
- "$ref": "ActionReason"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ActionFlow": {
- "description": "Flow that can be selected for an action. When merchant selects a flow, application should open a dialog with more information and input form.",
- "id": "ActionFlow",
- "properties": {
- "dialogButtonLabel": {
- "description": "Label for the button to trigger the action from the action dialog. For example: \"Request review\"",
- "type": "string"
- },
- "dialogCallout": {
- "$ref": "Callout",
- "description": "Important message to be highlighted in the request dialog. For example: \"You can only request a review for disagreeing with this issue once. If it's not approved, you'll need to fix the issue and wait a few days before you can request another review.\""
- },
- "dialogMessage": {
- "$ref": "TextWithTooltip",
- "description": "Message displayed in the request dialog. For example: \"Make sure you've fixed all your country-specific issues. If not, you may have to wait 7 days to request another review\". There may be an more information to be shown in a tooltip."
- },
- "dialogTitle": {
- "description": "Title of the request dialog. For example: \"Before you request a review\"",
- "type": "string"
- },
- "id": {
- "description": "Not for display but need to be sent back for the selected action flow.",
- "type": "string"
- },
- "inputs": {
- "description": "A list of input fields.",
- "items": {
- "$ref": "InputField"
- },
- "type": "array"
- },
- "label": {
- "description": "Text value describing the intent for the action flow. It can be used as an input label if merchant needs to pick one of multiple flows. For example: \"I disagree with the issue\"",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ActionInput": {
- "description": "Input provided by the merchant.",
- "id": "ActionInput",
- "properties": {
- "actionFlowId": {
- "description": "Required. Id of the selected action flow.",
- "type": "string"
- },
- "inputValues": {
- "description": "Required. Values for input fields.",
- "items": {
- "$ref": "InputValue"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ActionReason": {
- "description": "A single reason why the action is not available.",
- "id": "ActionReason",
- "properties": {
- "action": {
- "$ref": "Action",
- "description": "Optional. An action that needs to be performed to solve the problem represented by this reason. This action will always be available. Should be rendered as a link or button next to the summarizing message. For example, the review may be available only once merchant configure all required attributes. In such a situation this action can be a link to the form, where they can fill the missing attribute to unblock the main action."
- },
- "detail": {
- "description": "Detailed explanation of the reason. Should be displayed as a hint if present.",
- "type": "string"
- },
- "message": {
- "description": "Messages summarizing the reason, why the action is not available. For example: \"Review requested on Jan 03. Review requests can take a few days to complete.\"",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Address": {
- "id": "Address",
- "properties": {
- "administrativeArea": {
- "description": "Required. Top-level administrative subdivision of the country. For example, a state like California (\"CA\") or a province like Quebec (\"QC\").",
- "type": "string"
- },
- "city": {
- "description": "Required. City, town or commune. May also include dependent localities or sublocalities (for example, neighborhoods or suburbs).",
- "type": "string"
- },
- "country": {
- "description": "Required. [CLDR country code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml) (for example, \"US\").",
- "type": "string"
- },
- "postalCode": {
- "description": "Required. Postal code or ZIP (for example, \"94043\").",
- "type": "string"
- },
- "streetAddress": {
- "description": "Street-level part of the address. Use `\\n` to add a second line.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AlternateDisputeResolution": {
- "description": "The Alternate Dispute Resolution (ADR) that may be available to merchants in some regions. If present, the link should be shown on the same page as the list of issues.",
- "id": "AlternateDisputeResolution",
- "properties": {
- "label": {
- "description": "The label for the alternate dispute resolution link.",
- "type": "string"
- },
- "uri": {
- "description": "The URL pointing to a page, where merchant can request alternative dispute resolution with an [external body](https://support.google.com/european-union-digital-services-act-redress-options/answer/13535501).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "AttributionSettings": {
- "description": "Represents attribution settings for conversion sources receiving pre-attribution data.",
- "id": "AttributionSettings",
- "properties": {
- "attributionLookbackWindowInDays": {
- "description": "Required. Lookback windows (in days) used for attribution in this source. Supported values are 7, 30, 40.",
- "format": "int32",
- "type": "integer"
- },
- "attributionModel": {
- "enum": [
- "ATTRIBUTION_MODEL_UNSPECIFIED",
- "CROSS_CHANNEL_LAST_CLICK",
- "ADS_PREFERRED_LAST_CLICK",
- "CROSS_CHANNEL_DATA_DRIVEN",
- "CROSS_CHANNEL_FIRST_CLICK",
- "CROSS_CHANNEL_LINEAR",
- "CROSS_CHANNEL_POSITION_BASED",
- "CROSS_CHANNEL_TIME_DECAY"
- ],
- "enumDescriptions": [
- "",
- "Cross-channel Last Click model.",
- "Ads-preferred Last Click model.",
- "Cross-channel Data Driven model.",
- "Cross-channel First Click model.",
- "Cross-channel Linear model.",
- "Cross-channel Position Based model.",
- "Cross-channel Time Decay model."
- ],
- "type": "string"
- },
- "conversionType": {
- "description": "Immutable. Unordered list. List of different conversion types a conversion event can be classified as. A standard \"purchase\" type will be automatically created if this list is empty at creation time.",
- "items": {
- "$ref": "AttributionSettingsConversionType"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "AttributionSettingsConversionType": {
- "description": "Message representing a types of conversion events",
- "id": "AttributionSettingsConversionType",
- "properties": {
- "includeInReporting": {
- "description": "Output only. Option indicating if the type should be included in Merchant Center reporting.",
- "readOnly": true,
- "type": "boolean"
- },
- "name": {
- "description": "Output only. Conversion event name, as it'll be reported by the client.",
- "readOnly": true,
- "type": "string"
- }
- },
- "type": "object"
- },
- "BestSellers": {
- "description": "Fields related to the [Best sellers reports](https://support.google.com/merchants/answer/9488679).",
- "id": "BestSellers",
- "properties": {
- "categoryId": {
- "description": "Google product category ID to calculate the ranking for, represented in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436). If a `WHERE` condition on `best_sellers.category_id` is not specified in the query, rankings for all top-level categories are returned.",
- "format": "int64",
- "type": "string"
- },
- "countryCode": {
- "description": "Country where the ranking is calculated. A `WHERE` condition on `best_sellers.country_code` is required in the query.",
- "type": "string"
- },
- "previousRank": {
- "description": "Popularity rank in the previous week or month.",
- "format": "int64",
- "type": "string"
- },
- "previousRelativeDemand": {
- "description": "Estimated demand in relation to the item with the highest popularity rank in the same category and country in the previous week or month.",
- "enum": [
- "RELATIVE_DEMAND_UNSPECIFIED",
- "VERY_LOW",
- "LOW",
- "MEDIUM",
- "HIGH",
- "VERY_HIGH"
- ],
- "enumDescriptions": [
- "Relative demand is unknown.",
- "Demand is 0-5% of the demand of the highest ranked product clusters or brands.",
- "Demand is 6-10% of the demand of the highest ranked product clusters or brands.",
- "Demand is 11-20% of the demand of the highest ranked product clusters or brands.",
- "Demand is 21-50% of the demand of the highest ranked product clusters or brands.",
- "Demand is 51-100% of the demand of the highest ranked product clusters or brands."
- ],
- "type": "string"
- },
- "rank": {
- "description": "Popularity on Shopping ads and free listings, in the selected category and country, based on the estimated number of units sold.",
- "format": "int64",
- "type": "string"
- },
- "relativeDemand": {
- "description": "Estimated demand in relation to the item with the highest popularity rank in the same category and country.",
- "enum": [
- "RELATIVE_DEMAND_UNSPECIFIED",
- "VERY_LOW",
- "LOW",
- "MEDIUM",
- "HIGH",
- "VERY_HIGH"
- ],
- "enumDescriptions": [
- "Relative demand is unknown.",
- "Demand is 0-5% of the demand of the highest ranked product clusters or brands.",
- "Demand is 6-10% of the demand of the highest ranked product clusters or brands.",
- "Demand is 11-20% of the demand of the highest ranked product clusters or brands.",
- "Demand is 21-50% of the demand of the highest ranked product clusters or brands.",
- "Demand is 51-100% of the demand of the highest ranked product clusters or brands."
- ],
- "type": "string"
- },
- "relativeDemandChange": {
- "description": "Change in the estimated demand. Whether it rose, sank or remained flat.",
- "enum": [
- "RELATIVE_DEMAND_CHANGE_TYPE_UNSPECIFIED",
- "SINKER",
- "FLAT",
- "RISER"
- ],
- "enumDescriptions": [
- "Relative demand change is unknown.",
- "Relative demand is lower than previous time period.",
- "Relative demand is equal to previous time period.",
- "Relative demand is higher than the previous time period."
- ],
- "type": "string"
- },
- "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. If a `WHERE` condition on `best_sellers.report_date` is not specified in the query, the latest available weekly or monthly report is returned."
- },
- "reportGranularity": {
- "description": "Granularity of the report. The ranking can be done over a week or a month timeframe. A `WHERE` condition on `best_sellers.report_granularity` is required in the query.",
- "enum": [
- "REPORT_GRANULARITY_UNSPECIFIED",
- "WEEKLY",
- "MONTHLY"
- ],
- "enumDescriptions": [
- "Report granularity is unknown.",
- "Ranking is done over a week timeframe.",
- "Ranking is done over a month timeframe."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "Brand": {
- "description": "Brand fields. Values are only set for fields requested explicitly in the request's search query.",
- "id": "Brand",
- "properties": {
- "name": {
- "description": "Name of the brand.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Breakdown": {
- "description": "A detailed impact breakdown for a group of regions where the impact of the issue on different shopping destinations is the same.",
- "id": "Breakdown",
- "properties": {
- "details": {
- "description": "Human readable, localized description of issue's effect on different targets. Should be rendered as a list. For example: * \"Products not showing in ads\" * \"Products not showing organically\"",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "regions": {
- "description": "Lists of regions. Should be rendered as a title for this group of details. The full list should be shown to merchant. If the list is too long, it is recommended to make it expandable.",
- "items": {
- "$ref": "BreakdownRegion"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "BreakdownRegion": {
- "description": "Region with code and localized name.",
- "id": "BreakdownRegion",
- "properties": {
- "code": {
- "description": "The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml)",
- "type": "string"
- },
- "name": {
- "description": "The localized name of the region. For region with code='001' the value is 'All countries' or the equivalent in other languages.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "BuiltInSimpleAction": {
- "description": "Action that is implemented and performed in (your) third-party application. Represents various functionality that is expected to be available to merchant and will help them with resolving the issue. The application should point the merchant to the place, where they can access the corresponding functionality. If the functionality is not supported, it is recommended to explain the situation to merchant and provide them with instructions how to solve the issue.",
- "id": "BuiltInSimpleAction",
- "properties": {
- "additionalContent": {
- "$ref": "BuiltInSimpleActionAdditionalContent",
- "description": "Long text from an external source that should be available to the merchant. Present when the type is `SHOW_ADDITIONAL_CONTENT`."
- },
- "attributeCode": {
- "description": "The attribute that needs to be updated. Present when the type is `EDIT_ITEM_ATTRIBUTE`. This field contains a code for attribute, represented in snake_case. You can find a list of product's attributes, with their codes [here](https://support.google.com/merchants/answer/7052112).",
- "type": "string"
- },
- "type": {
- "description": "The type of action that represents a functionality that is expected to be available in third-party application.",
- "enum": [
- "BUILT_IN_SIMPLE_ACTION_TYPE_UNSPECIFIED",
- "VERIFY_PHONE",
- "CLAIM_WEBSITE",
- "ADD_PRODUCTS",
- "ADD_CONTACT_INFO",
- "LINK_ADS_ACCOUNT",
- "ADD_BUSINESS_REGISTRATION_NUMBER",
- "EDIT_ITEM_ATTRIBUTE",
- "FIX_ACCOUNT_ISSUE",
- "SHOW_ADDITIONAL_CONTENT"
- ],
- "enumDescriptions": [
- "Default value. Will never be provided by the API.",
- "Redirect merchant to the part of your application where they can verify their phone.",
- "Redirect merchant to the part of your application where they can claim their website.",
- "Redirect merchant to the part of your application where they can add products.",
- "Open a form where the merchant can edit their contact information.",
- "Redirect merchant to the part of your application where they can link ads account.",
- "Open a form where the merchant can add their business registration number.",
- "Open a form where the merchant can edit an attribute. The attribute that needs to be updated is specified in attribute_code field of the action.",
- "Redirect merchant from the product issues to the diagnostic page with their account issues in your application. This action will be returned only for product issues that are caused by an account issue and thus merchant should resolve the problem on the account level.",
- "Show additional content to the merchant. This action will be used for example to deliver a justification from national authority."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "BuiltInSimpleActionAdditionalContent": {
- "description": "Long text from external source.",
- "id": "BuiltInSimpleActionAdditionalContent",
- "properties": {
- "paragraphs": {
- "description": "Long text organized into paragraphs.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "title": {
- "description": "Title of the additional content;",
- "type": "string"
- }
- },
- "type": "object"
- },
- "BuiltInUserInputAction": {
- "description": "Action that is implemented and performed in (your) third-party application. The application needs to show an additional content and input form to the merchant. They can start the action only when they provided all required inputs. The application will request processing of the action by calling the [triggeraction method](https://developers.google.com/shopping-content/reference/rest/v2.1/merchantsupport/triggeraction).",
- "id": "BuiltInUserInputAction",
- "properties": {
- "actionContext": {
- "description": "Internal details. Not for display but need to be sent back when triggering the action.",
- "type": "string"
- },
- "flows": {
- "description": "Actions may provide multiple different flows. Merchant selects one that fits best to their intent. Selecting the flow is the first step in user's interaction with the action. It affects what input fields will be available and required and also how the request will be processed.",
- "items": {
- "$ref": "ActionFlow"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "BusinessDayConfig": {
- "id": "BusinessDayConfig",
- "properties": {
- "businessDays": {
- "description": "Regular business days, such as '\"monday\"'. May not be empty.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "Callout": {
- "description": "An important message that should be highlighted. Usually displayed as a banner.",
- "id": "Callout",
- "properties": {
- "fullMessage": {
- "$ref": "TextWithTooltip",
- "description": "A full message that needs to be shown to the merchant."
- },
- "styleHint": {
- "description": "Can be used to render messages with different severity in different styles. Snippets off all types contain important information that should be displayed to merchants.",
- "enum": [
- "CALLOUT_STYLE_HINT_UNSPECIFIED",
- "ERROR",
- "WARNING",
- "INFO"
- ],
- "enumDescriptions": [
- "Default value. Will never be provided by the API.",
- "The most important type of information highlighting problems, like an unsuccessful outcome of previously requested actions.",
- "Information warning about pending problems, risks or deadlines.",
- "Default severity for important information like pending status of previously requested action or cooldown for re-review."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "CarrierRate": {
- "id": "CarrierRate",
- "properties": {
- "carrierName": {
- "description": "Carrier service, such as `\"UPS\"` or `\"Fedex\"`. The list of supported carriers can be retrieved through the `getSupportedCarriers` method. Required.",
- "type": "string"
- },
- "carrierService": {
- "description": "Carrier service, such as `\"ground\"` or `\"2 days\"`. The list of supported services for a carrier can be retrieved through the `getSupportedCarriers` method. Required.",
- "type": "string"
- },
- "flatAdjustment": {
- "$ref": "Price",
- "description": "Additive shipping rate modifier. Can be negative. For example `{ \"value\": \"1\", \"currency\" : \"USD\" }` adds $1 to the rate, `{ \"value\": \"-3\", \"currency\" : \"USD\" }` removes $3 from the rate. Optional."
- },
- "name": {
- "description": "Name of the carrier rate. Must be unique per rate group. Required.",
- "type": "string"
- },
- "originPostalCode": {
- "description": "Shipping origin for this carrier rate. Required.",
- "type": "string"
- },
- "percentageAdjustment": {
- "description": "Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `\"5.4\"` increases the rate by 5.4%, `\"-3\"` decreases the rate by 3%. Optional.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "CarriersCarrier": {
- "id": "CarriersCarrier",
- "properties": {
- "country": {
- "description": "The CLDR country code of the carrier (for example, \"US\"). Always present.",
- "type": "string"
- },
- "eddServices": {
- "description": "A list of services supported for EDD (Estimated Delivery Date) calculation. This is the list of valid values for WarehouseBasedDeliveryTime.carrierService.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "name": {
- "description": "The name of the carrier (for example, `\"UPS\"`). Always present.",
- "type": "string"
- },
- "services": {
- "description": "A list of supported services (for example, `\"ground\"`) for that carrier. Contains at least one service. This is the list of valid values for CarrierRate.carrierService.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "CheckoutSettings": {
- "description": "`CheckoutSettings` for a specific merchant ID.",
- "id": "CheckoutSettings",
- "properties": {
- "effectiveEnrollmentState": {
- "description": "Output only. The effective value of enrollment state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account.",
- "enum": [
- "CHECKOUT_ON_MERCHANT_ENROLLMENT_STATE_UNSPECIFIED",
- "INACTIVE",
- "ENROLLED",
- "OPT_OUT"
- ],
- "enumDescriptions": [
- "Default enrollment state when enrollment state is not specified.",
- "Merchant has not enrolled into the feature.",
- "Merchant has enrolled into the feature by providing either an account level URL or checkout URLs as part of their feed.",
- "Merchant has previously enrolled but opted out of the feature."
- ],
- "readOnly": true,
- "type": "string"
- },
- "effectiveReviewState": {
- "description": "Output only. The effective value of review state for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account.",
- "enum": [
- "CHECKOUT_ON_MERCHANT_REVIEW_STATE_UNSPECIFIED",
- "IN_REVIEW",
- "APPROVED",
- "DISAPPROVED"
- ],
- "enumDescriptions": [
- "Default review state when review state is not specified.",
- "Merchant provided URLs are being reviewed for data quality issues.",
- "Merchant account has been approved. Indicates the data quality checks have passed.",
- "Merchant account has been disapproved due to data quality issues."
- ],
- "readOnly": true,
- "type": "string"
- },
- "effectiveUriSettings": {
- "$ref": "UrlSettings",
- "description": "The effective value of `url_settings` for a given merchant ID. If account level settings are present then this value will be a copy of the account level settings. Otherwise, it will have the value of the parent account."
- },
- "enrollmentState": {
- "description": "Output only. Reflects the merchant enrollment state in `Checkout` feature.",
- "enum": [
- "CHECKOUT_ON_MERCHANT_ENROLLMENT_STATE_UNSPECIFIED",
- "INACTIVE",
- "ENROLLED",
- "OPT_OUT"
- ],
- "enumDescriptions": [
- "Default enrollment state when enrollment state is not specified.",
- "Merchant has not enrolled into the feature.",
- "Merchant has enrolled into the feature by providing either an account level URL or checkout URLs as part of their feed.",
- "Merchant has previously enrolled but opted out of the feature."
- ],
- "readOnly": true,
- "type": "string"
- },
- "merchantId": {
- "description": "Required. The ID of the account.",
- "format": "int64",
- "type": "string"
- },
- "reviewState": {
- "description": "Output only. Reflects the merchant review state in `Checkout` feature. This is set based on the data quality reviews of the URL provided by the merchant. A merchant with enrollment state as `ENROLLED` can be in the following review states: `IN_REVIEW`, `APPROVED` or `DISAPPROVED`. A merchant must be in an enrollment_state of `ENROLLED` before a review can begin for the merchant.",
- "enum": [
- "CHECKOUT_ON_MERCHANT_REVIEW_STATE_UNSPECIFIED",
- "IN_REVIEW",
- "APPROVED",
- "DISAPPROVED"
- ],
- "enumDescriptions": [
- "Default review state when review state is not specified.",
- "Merchant provided URLs are being reviewed for data quality issues.",
- "Merchant account has been approved. Indicates the data quality checks have passed.",
- "Merchant account has been disapproved due to data quality issues."
- ],
- "readOnly": true,
- "type": "string"
- },
- "uriSettings": {
- "$ref": "UrlSettings",
- "description": "URL settings for cart or checkout URL."
- }
- },
- "type": "object"
- },
- "CloudExportAdditionalProperties": {
- "description": "Product property for the Cloud Retail API. For example, properties for a TV product could be \"Screen-Resolution\" or \"Screen-Size\".",
- "id": "CloudExportAdditionalProperties",
- "properties": {
- "boolValue": {
- "description": "Boolean value of the given property. For example for a TV product, \"True\" or \"False\" if the screen is UHD.",
- "type": "boolean"
- },
- "floatValue": {
- "description": "Float values of the given property. For example for a TV product 1.2345. Maximum number of specified values for this field is 400. Values are stored in an arbitrary but consistent order.",
- "items": {
- "format": "float",
- "type": "number"
- },
- "type": "array"
- },
- "intValue": {
- "description": "Integer values of the given property. For example, 1080 for a screen resolution of a TV product. Maximum number of specified values for this field is 400. Values are stored in an arbitrary but consistent order.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- },
- "maxValue": {
- "description": "Maximum float value of the given property. For example for a TV product 100.00.",
- "format": "float",
- "type": "number"
- },
- "minValue": {
- "description": "Minimum float value of the given property. For example for a TV product 1.00.",
- "format": "float",
- "type": "number"
- },
- "propertyName": {
- "description": "Name of the given property. For example, \"Screen-Resolution\" for a TV product. Maximum string size is 256 characters.",
- "type": "string"
- },
- "textValue": {
- "description": "Text value of the given property. For example, \"8K(UHD)\" could be a text value for a TV product. Maximum number of specified values for this field is 400. Values are stored in an arbitrary but consistent order. Maximum string size is 256 characters.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "unitCode": {
- "description": "Unit of the given property. For example, \"Pixels\" for a TV product. Maximum string size is 256 bytes.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Collection": {
- "description": "The collection message.",
- "id": "Collection",
- "properties": {
- "customLabel0": {
- "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns. [Custom label](https://support.google.com/merchants/answer/9674217)",
- "type": "string"
- },
- "customLabel1": {
- "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.",
- "type": "string"
- },
- "customLabel2": {
- "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.",
- "type": "string"
- },
- "customLabel3": {
- "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.",
- "type": "string"
- },
- "customLabel4": {
- "description": "Label that you assign to a collection to help organize bidding and reporting in Shopping campaigns.",
- "type": "string"
- },
- "featuredProduct": {
- "description": "This identifies one or more products associated with the collection. Used as a lookup to the corresponding product ID in your product feeds. Provide a maximum of 100 featuredProduct (for collections). Provide up to 10 featuredProduct (for Shoppable Images only) with ID and X and Y coordinates. [featured_product attribute](https://support.google.com/merchants/answer/9703736)",
- "items": {
- "$ref": "CollectionFeaturedProduct"
- },
- "type": "array"
- },
- "headline": {
- "description": "Your collection's name. [headline attribute](https://support.google.com/merchants/answer/9673580)",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "id": {
- "description": "Required. The REST ID of the collection. Content API methods that operate on collections take this as their collectionId parameter. The REST ID for a collection is of the form collectionId. [id attribute](https://support.google.com/merchants/answer/9649290)",
- "type": "string"
- },
- "imageLink": {
- "description": "The URL of a collection’s image. [image_link attribute](https://support.google.com/merchants/answer/9703236)",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "language": {
- "description": "The language of a collection and the language of any featured products linked to the collection. [language attribute](https://support.google.com/merchants/answer/9673781)",
- "type": "string"
- },
- "link": {
- "description": "A collection’s landing page. URL directly linking to your collection's page on your website. [link attribute](https://support.google.com/merchants/answer/9673983)",
- "type": "string"
- },
- "mobileLink": {
- "description": "A collection’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic. [mobile_link attribute](https://support.google.com/merchants/answer/9646123)",
- "type": "string"
- },
- "productCountry": {
- "description": "[product_country attribute](https://support.google.com/merchants/answer/9674155)",
- "type": "string"
- }
- },
- "type": "object"
- },
- "CollectionFeaturedProduct": {
- "description": "The message for FeaturedProduct. [FeaturedProduct](https://support.google.com/merchants/answer/9703736)",
- "id": "CollectionFeaturedProduct",
- "properties": {
- "offerId": {
- "description": "The unique identifier for the product item.",
- "type": "string"
- },
- "x": {
- "description": "Required. X-coordinate of the product callout on the Shoppable Image.",
- "format": "float",
- "type": "number"
- },
- "y": {
- "description": "Required. Y-coordinate of the product callout on the Shoppable Image.",
- "format": "float",
- "type": "number"
- }
- },
- "type": "object"
- },
- "CollectionStatus": {
- "description": "The collectionstatus message.",
- "id": "CollectionStatus",
- "properties": {
- "collectionLevelIssuses": {
- "description": "A list of all issues associated with the collection.",
- "items": {
- "$ref": "CollectionStatusItemLevelIssue"
- },
- "type": "array"
- },
- "creationDate": {
- "description": "Date on which the collection has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\"",
- "type": "string"
- },
- "destinationStatuses": {
- "description": "The intended destinations for the collection.",
- "items": {
- "$ref": "CollectionStatusDestinationStatus"
- },
- "type": "array"
- },
- "id": {
- "description": "Required. The ID of the collection for which status is reported.",
- "type": "string"
- },
- "lastUpdateDate": {
- "description": "Date on which the collection has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\"",
- "type": "string"
- }
- },
- "type": "object"
- },
- "CollectionStatusDestinationStatus": {
- "description": "Destination status message.",
- "id": "CollectionStatusDestinationStatus",
- "properties": {
- "approvedCountries": {
- "description": "Country codes (ISO 3166-1 alpha-2) where the collection is approved.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "destination": {
- "description": "The name of the destination",
- "type": "string"
- },
- "disapprovedCountries": {
- "description": "Country codes (ISO 3166-1 alpha-2) where the collection is disapproved.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "pendingCountries": {
- "description": "Country codes (ISO 3166-1 alpha-2) where the collection is pending approval.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "status": {
- "description": "The status for the specified destination in the collections target country.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "CollectionStatusItemLevelIssue": {
- "description": "Issue associated with the collection.",
- "id": "CollectionStatusItemLevelIssue",
- "properties": {
- "applicableCountries": {
- "description": "Country codes (ISO 3166-1 alpha-2) where issue applies to the offer.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "attributeName": {
- "description": "The attribute's name, if the issue is caused by a single attribute.",
- "type": "string"
- },
- "code": {
- "description": "The error code of the issue.",
- "type": "string"
- },
- "description": {
- "description": "A short issue description in English.",
- "type": "string"
- },
- "destination": {
- "description": "The destination the issue applies to.",
- "type": "string"
- },
- "detail": {
- "description": "A detailed issue description in English.",
- "type": "string"
- },
- "documentation": {
- "description": "The URL of a web page to help with resolving this issue.",
- "type": "string"
- },
- "resolution": {
- "description": "Whether the issue can be resolved by the merchant.",
- "type": "string"
- },
- "servability": {
- "description": "How this issue affects the serving of the collection.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "CompetitiveVisibility": {
- "description": "Fields related to [competitive visibility reports] (https://support.google.com/merchants/answer/11366442).",
- "id": "CompetitiveVisibility",
- "properties": {
- "adsOrganicRatio": {
- "description": "[Ads / organic ratio] (https://support.google.com/merchants/answer/11366442#zippy=%2Cadsfree-ratio) shows how often a merchant receives impressions from Shopping ads compared to organic traffic. The number is rounded and bucketed. Available only in `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.",
- "format": "double",
- "type": "number"
- },
- "categoryBenchmarkVisibilityTrend": {
- "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. Available only in `CompetitiveVisibilityBenchmarkView`. Cannot be filtered on in the 'WHERE' clause.",
- "format": "double",
- "type": "number"
- },
- "categoryId": {
- "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 `WHERE` condition on `competitive_visibility.category_id` is required in the query.",
- "format": "int64",
- "type": "string"
- },
- "countryCode": {
- "description": "The country where impression appeared. Required in the `SELECT` clause. A `WHERE` condition on `competitive_visibility.country_code` is required in the query.",
- "type": "string"
- },
- "date": {
- "$ref": "Date",
- "description": "Date of this row. Available only in `CompetitiveVisibilityBenchmarkView` and `CompetitiveVisibilityCompetitorView`. Required in the `SELECT` clause for `CompetitiveVisibilityMarketBenchmarkView`."
- },
- "domain": {
- "description": "Domain of your competitor or your domain, if 'is_your_domain' is true. Available only in `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Required in the `SELECT` clause for `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.",
- "type": "string"
- },
- "higherPositionRate": {
- "description": "Higher position rate shows how often a competitor’s offer got placed in a higher position on the page than your offer. Available only in `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.",
- "format": "double",
- "type": "number"
- },
- "isYourDomain": {
- "description": "True if this row contains data for your domain. Available only in `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.",
- "type": "boolean"
- },
- "pageOverlapRate": {
- "description": "Page overlap rate describes how frequently competing retailers’ offers are shown together with your offers on the same page. Available only in `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.",
- "format": "double",
- "type": "number"
- },
- "rank": {
- "description": "Position of the domain in the top merchants ranking for the selected keys (`date`, `category_id`, `country_code`, `listing_type`) based on impressions. 1 is the highest. Available only in `CompetitiveVisibilityTopMerchantView` and `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.",
- "format": "uint64",
- "type": "string"
- },
- "relativeVisibility": {
- "description": "Relative 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. Available only in `CompetitiveVisibilityCompetitorView`. Cannot be filtered on in the 'WHERE' clause.",
- "format": "double",
- "type": "number"
- },
- "trafficSource": {
- "description": "Type of impression listing. Required in the `SELECT` clause. Cannot be filtered on in the 'WHERE' clause.",
- "enum": [
- "UNKNOWN",
- "ORGANIC",
- "ADS",
- "ALL"
- ],
- "enumDescriptions": [
- "Traffic source is unknown.",
- "Organic traffic.",
- "Traffic from Ads.",
- "Organic and Ads traffic."
- ],
- "type": "string"
- },
- "yourDomainVisibilityTrend": {
- "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). Available only in `CompetitiveVisibilityBenchmarkView`. Cannot be filtered on in the 'WHERE' clause.",
- "format": "double",
- "type": "number"
- }
- },
- "type": "object"
- },
- "ConversionSource": {
- "description": "Represents a conversion source owned by a Merchant account. A merchant account can have up to 200 conversion sources.",
- "id": "ConversionSource",
- "properties": {
- "conversionSourceId": {
- "description": "Output only. Generated by the Content API upon creation of a new `ConversionSource`. Format: [a-z]{4}:.+ The four characters before the colon represent the type of conversio source. Content after the colon represents the ID of the conversion source within that type. The ID of two different conversion sources might be the same across different types. The following type prefixes are supported: - galk: For GoogleAnalyticsLink sources. - mcdn: For MerchantCenterDestination sources.",
- "readOnly": true,
- "type": "string"
- },
- "expireTime": {
- "description": "Output only. The time when an archived conversion source becomes permanently deleted and is no longer available to undelete.",
- "format": "google-datetime",
- "readOnly": true,
- "type": "string"
- },
- "googleAnalyticsLink": {
- "$ref": "GoogleAnalyticsLink",
- "description": "Immutable. Conversion Source of type \"Link to Google Analytics Property\"."
- },
- "merchantCenterDestination": {
- "$ref": "MerchantCenterDestination",
- "description": "Conversion Source of type \"Merchant Center Tag Destination\"."
- },
- "state": {
- "description": "Output only. Current state of this conversion source. Can't be edited through the API.",
- "enum": [
- "STATE_UNSPECIFIED",
- "ACTIVE",
- "ARCHIVED",
- "PENDING"
- ],
- "enumDescriptions": [
- "",
- "Conversion source is fully functional.",
- "Conversion source has been archived in the last 30 days and not currently functional. Can be restored using the undelete method.",
- "Conversion source creation has started but not fully finished yet."
- ],
- "readOnly": true,
- "type": "string"
- }
- },
- "type": "object"
- },
- "Css": {
- "description": "Information about CSS domain.",
- "id": "Css",
- "properties": {
- "cssDomainId": {
- "description": "Output only. Immutable. The CSS domain ID.",
- "format": "int64",
- "readOnly": true,
- "type": "string"
- },
- "cssGroupId": {
- "description": "Output only. Immutable. The ID of the CSS group this CSS domain is affiliated with. Only populated for CSS group users.",
- "format": "int64",
- "readOnly": true,
- "type": "string"
- },
- "displayName": {
- "description": "Output only. Immutable. The CSS domain's display name, used when space is constrained.",
- "readOnly": true,
- "type": "string"
- },
- "fullName": {
- "description": "Output only. Immutable. The CSS domain's full name.",
- "readOnly": true,
- "type": "string"
- },
- "homepageUri": {
- "description": "Output only. Immutable. The CSS domain's homepage.",
- "readOnly": true,
- "type": "string"
- },
- "labelIds": {
- "description": "A list of label IDs that are assigned to this CSS domain by its CSS group. Only populated for CSS group users.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "CustomAttribute": {
- "description": "A message that represents custom attributes. Exactly one of `value` or `groupValues` must be provided. Maximum allowed number of characters for each custom attribute is 10240 (represents sum of characters for name and value). Maximum 2500 custom attributes can be set per merchant, with total size of 102.4kB.",
- "id": "CustomAttribute",
- "properties": {
- "groupValues": {
- "description": "Subattributes within this attribute group. Exactly one of value or groupValues must be provided.",
- "items": {
- "$ref": "CustomAttribute"
- },
- "type": "array"
- },
- "name": {
- "description": "The name of the attribute. Underscores will be replaced by spaces upon insertion.",
- "type": "string"
- },
- "value": {
- "description": "The value of the attribute.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "CutoffTime": {
- "id": "CutoffTime",
- "properties": {
- "hour": {
- "description": "Hour of the cutoff time until which an order has to be placed to be processed in the same day. Required.",
- "format": "uint32",
- "type": "integer"
- },
- "minute": {
- "description": "Minute of the cutoff time until which an order has to be placed to be processed in the same day. Required.",
- "format": "uint32",
- "type": "integer"
- },
- "timezone": {
- "description": "Timezone identifier for the cutoff time (for example, \"Europe/Zurich\"). List of identifiers. Required.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Datafeed": {
- "description": "Datafeed configuration data.",
- "id": "Datafeed",
- "properties": {
- "attributeLanguage": {
- "description": "The two-letter ISO 639-1 language in which the attributes are defined in the data feed.",
- "type": "string"
- },
- "contentType": {
- "description": "Required. The type of data feed. For product inventory feeds, only feeds for local stores, not online stores, are supported. Acceptable values are: - \"`local products`\" - \"`product inventory`\" - \"`products`\" ",
- "type": "string"
- },
- "fetchSchedule": {
- "$ref": "DatafeedFetchSchedule",
- "description": "Fetch schedule for the feed file."
- },
- "fileName": {
- "description": "Required. The filename of the feed. All feeds must have a unique file name.",
- "type": "string"
- },
- "format": {
- "$ref": "DatafeedFormat",
- "description": "Format of the feed file."
- },
- "id": {
- "description": "Required for update. The ID of the data feed.",
- "format": "int64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#datafeed`\"",
- "type": "string"
- },
- "name": {
- "description": "Required for insert. A descriptive name of the data feed.",
- "type": "string"
- },
- "targets": {
- "description": "The targets this feed should apply to (country, language, destinations).",
- "items": {
- "$ref": "DatafeedTarget"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "DatafeedFetchSchedule": {
- "description": "The required fields vary based on the frequency of fetching. For a monthly fetch schedule, day_of_month and hour are required. For a weekly fetch schedule, weekday and hour are required. For a daily fetch schedule, only hour is required.",
- "id": "DatafeedFetchSchedule",
- "properties": {
- "dayOfMonth": {
- "description": "The day of the month the feed file should be fetched (1-31).",
- "format": "uint32",
- "type": "integer"
- },
- "fetchUrl": {
- "description": "The URL where the feed file can be fetched. Google Merchant Center will support automatic scheduled uploads using the HTTP, HTTPS, FTP, or SFTP protocols, so the value will need to be a valid link using one of those four protocols.",
- "type": "string"
- },
- "hour": {
- "description": "The hour of the day the feed file should be fetched (0-23).",
- "format": "uint32",
- "type": "integer"
- },
- "minuteOfHour": {
- "description": "The minute of the hour the feed file should be fetched (0-59). Read-only.",
- "format": "uint32",
- "type": "integer"
- },
- "password": {
- "description": "An optional password for fetch_url.",
- "type": "string"
- },
- "paused": {
- "description": "Whether the scheduled fetch is paused or not.",
- "type": "boolean"
- },
- "timeZone": {
- "description": "Time zone used for schedule. UTC by default. For example, \"America/Los_Angeles\".",
- "type": "string"
- },
- "username": {
- "description": "An optional user name for fetch_url.",
- "type": "string"
- },
- "weekday": {
- "description": "The day of the week the feed file should be fetched. Acceptable values are: - \"`monday`\" - \"`tuesday`\" - \"`wednesday`\" - \"`thursday`\" - \"`friday`\" - \"`saturday`\" - \"`sunday`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DatafeedFormat": {
- "id": "DatafeedFormat",
- "properties": {
- "columnDelimiter": {
- "description": "Delimiter for the separation of values in a delimiter-separated values feed. If not specified, the delimiter will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - \"`pipe`\" - \"`tab`\" - \"`tilde`\" ",
- "type": "string"
- },
- "fileEncoding": {
- "description": "Character encoding scheme of the data feed. If not specified, the encoding will be auto-detected. Acceptable values are: - \"`latin-1`\" - \"`utf-16be`\" - \"`utf-16le`\" - \"`utf-8`\" - \"`windows-1252`\" ",
- "type": "string"
- },
- "quotingMode": {
- "description": "Specifies how double quotes are interpreted. If not specified, the mode will be auto-detected. Ignored for non-DSV data feeds. Acceptable values are: - \"`normal character`\" - \"`value quoting`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DatafeedStatus": {
- "description": "The status of a datafeed, that is, the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.",
- "id": "DatafeedStatus",
- "properties": {
- "country": {
- "description": "The country for which the status is reported, represented as a CLDR territory code.",
- "type": "string"
- },
- "datafeedId": {
- "description": "The ID of the feed for which the status is reported.",
- "format": "uint64",
- "type": "string"
- },
- "errors": {
- "description": "The list of errors occurring in the feed.",
- "items": {
- "$ref": "DatafeedStatusError"
- },
- "type": "array"
- },
- "feedLabel": {
- "description": "The feed label status is reported for.",
- "type": "string"
- },
- "itemsTotal": {
- "description": "The number of items in the feed that were processed.",
- "format": "uint64",
- "type": "string"
- },
- "itemsValid": {
- "description": "The number of items in the feed that were valid.",
- "format": "uint64",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#datafeedStatus`\"",
- "type": "string"
- },
- "language": {
- "description": "The two-letter ISO 639-1 language for which the status is reported.",
- "type": "string"
- },
- "lastUploadDate": {
- "description": "The last date at which the feed was uploaded.",
- "type": "string"
- },
- "processingStatus": {
- "description": "The processing status of the feed. Acceptable values are: - \"`\"`failure`\": The feed could not be processed or all items had errors.`\" - \"`in progress`\": The feed is being processed. - \"`none`\": The feed has not yet been processed. For example, a feed that has never been uploaded will have this processing status. - \"`success`\": The feed was processed successfully, though some items might have had errors. ",
- "type": "string"
- },
- "warnings": {
- "description": "The list of errors occurring in the feed.",
- "items": {
- "$ref": "DatafeedStatusError"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "DatafeedStatusError": {
- "description": "An error occurring in the feed, like \"invalid price\".",
- "id": "DatafeedStatusError",
- "properties": {
- "code": {
- "description": "The code of the error, for example, \"validation/invalid_value\".",
- "type": "string"
- },
- "count": {
- "description": "The number of occurrences of the error in the feed.",
- "format": "uint64",
- "type": "string"
- },
- "examples": {
- "description": "A list of example occurrences of the error, grouped by product.",
- "items": {
- "$ref": "DatafeedStatusExample"
- },
- "type": "array"
- },
- "message": {
- "description": "The error message, for example, \"Invalid price\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DatafeedStatusExample": {
- "description": "An example occurrence for a particular error.",
- "id": "DatafeedStatusExample",
- "properties": {
- "itemId": {
- "description": "The ID of the example item.",
- "type": "string"
- },
- "lineNumber": {
- "description": "Line number in the data feed where the example is found.",
- "format": "uint64",
- "type": "string"
- },
- "value": {
- "description": "The problematic value.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DatafeedTarget": {
- "id": "DatafeedTarget",
- "properties": {
- "country": {
- "description": "Deprecated. Use `feedLabel` instead. The country where the items in the feed will be included in the search index, represented as a CLDR territory code.",
- "type": "string"
- },
- "excludedDestinations": {
- "description": "The list of [destinations to exclude](//support.google.com/merchants/answer/6324486) for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "feedLabel": {
- "description": "Feed label for the DatafeedTarget. Either `country` or `feedLabel` is required. If both `feedLabel` and `country` is specified, the values must match. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).",
- "type": "string"
- },
- "includedDestinations": {
- "description": "The list of [destinations to include](//support.google.com/merchants/answer/7501026) for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "language": {
- "description": "The two-letter ISO 639-1 language of the items in the feed. Must be a valid language for `targets[].country`.",
- "type": "string"
- },
- "targetCountries": {
- "description": "The countries where the items may be displayed. Represented as a CLDR territory code. Will be ignored for \"product inventory\" feeds.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "DatafeedsCustomBatchRequest": {
- "id": "DatafeedsCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "DatafeedsCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "DatafeedsCustomBatchRequestEntry": {
- "description": "A batch entry encoding a single non-batch datafeeds request.",
- "id": "DatafeedsCustomBatchRequestEntry",
- "properties": {
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "datafeed": {
- "$ref": "Datafeed",
- "description": "The data feed to insert."
- },
- "datafeedId": {
- "description": "The ID of the data feed to get, delete or fetch.",
- "format": "uint64",
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`fetchNow`\" - \"`get`\" - \"`insert`\" - \"`update`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DatafeedsCustomBatchResponse": {
- "id": "DatafeedsCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "DatafeedsCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#datafeedsCustomBatchResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DatafeedsCustomBatchResponseEntry": {
- "description": "A batch entry encoding a single non-batch datafeeds response.",
- "id": "DatafeedsCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32",
- "type": "integer"
- },
- "datafeed": {
- "$ref": "Datafeed",
- "description": "The requested data feed. Defined if and only if the request was successful."
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors for failed custombatch entries. *Note:* Schema errors fail the whole request."
- }
- },
- "type": "object"
- },
- "DatafeedsFetchNowResponse": {
- "id": "DatafeedsFetchNowResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#datafeedsFetchNowResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DatafeedsListResponse": {
- "id": "DatafeedsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#datafeedsListResponse`\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of datafeeds.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "Datafeed"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "DatafeedstatusesCustomBatchRequest": {
- "id": "DatafeedstatusesCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "DatafeedstatusesCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "DatafeedstatusesCustomBatchRequestEntry": {
- "description": "A batch entry encoding a single non-batch datafeedstatuses request.",
- "id": "DatafeedstatusesCustomBatchRequestEntry",
- "properties": {
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "country": {
- "description": "Deprecated. Use `feedLabel` instead. The country to get the datafeed status for. If this parameter is provided, then `language` must also be provided. Note that for multi-target datafeeds this parameter is required.",
- "type": "string"
- },
- "datafeedId": {
- "description": "The ID of the data feed to get.",
- "format": "uint64",
- "type": "string"
- },
- "feedLabel": {
- "description": "The feed label to get the datafeed status for. If this parameter is provided, then `language` must also be provided. Note that for multi-target datafeeds this parameter is required.",
- "type": "string"
- },
- "language": {
- "description": "The language to get the datafeed status for. If this parameter is provided then `country` must also be provided. Note that for multi-target datafeeds this parameter is required.",
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`get`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DatafeedstatusesCustomBatchResponse": {
- "id": "DatafeedstatusesCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "DatafeedstatusesCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#datafeedstatusesCustomBatchResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DatafeedstatusesCustomBatchResponseEntry": {
- "description": "A batch entry encoding a single non-batch datafeedstatuses response.",
- "id": "DatafeedstatusesCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32",
- "type": "integer"
- },
- "datafeedStatus": {
- "$ref": "DatafeedStatus",
- "description": "The requested data feed status. Defined if and only if the request was successful."
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors for failed custombatch entries. *Note:* Schema errors fail the whole request."
- }
- },
- "type": "object"
- },
- "DatafeedstatusesListResponse": {
- "id": "DatafeedstatusesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#datafeedstatusesListResponse`\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of datafeed statuses.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "DatafeedStatus"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "Date": {
- "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",
- "id": "Date",
- "properties": {
- "day": {
- "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",
- "type": "integer"
- },
- "month": {
- "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
- "format": "int32",
- "type": "integer"
- },
- "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"
- }
- },
- "type": "object"
- },
- "DateTime": {
- "description": "Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.",
- "id": "DateTime",
- "properties": {
- "day": {
- "description": "Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.",
- "format": "int32",
- "type": "integer"
- },
- "hours": {
- "description": "Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.",
- "format": "int32",
- "type": "integer"
- },
- "minutes": {
- "description": "Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.",
- "format": "int32",
- "type": "integer"
- },
- "month": {
- "description": "Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.",
- "format": "int32",
- "type": "integer"
- },
- "nanos": {
- "description": "Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.",
- "format": "int32",
- "type": "integer"
- },
- "seconds": {
- "description": "Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.",
- "format": "int32",
- "type": "integer"
- },
- "timeZone": {
- "$ref": "TimeZone",
- "description": "Time zone."
- },
- "utcOffset": {
- "description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.",
- "format": "google-duration",
- "type": "string"
- },
- "year": {
- "description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "DeliveryArea": {
- "description": "A delivery area for the product. Only one of `countryCode` or `postalCodeRange` must be set.",
- "id": "DeliveryArea",
- "properties": {
- "countryCode": {
- "description": "Required. The country that the product can be delivered to. Submit a [unicode CLDR region](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) such as `US` or `CH`.",
- "type": "string"
- },
- "postalCodeRange": {
- "$ref": "DeliveryAreaPostalCodeRange",
- "description": "A postal code, postal code range or postal code prefix that defines this area. Limited to US and AUS."
- },
- "regionCode": {
- "description": "A state, territory, or prefecture. This is supported for the United States, Australia, and Japan. Provide a subdivision code from the ISO 3166-2 code tables ([US](https://en.wikipedia.org/wiki/ISO_3166-2:US), [AU](https://en.wikipedia.org/wiki/ISO_3166-2:AU), or [JP](https://en.wikipedia.org/wiki/ISO_3166-2:JP)) without country prefix (for example, `\"NY\"`, `\"NSW\"`, `\"03\"`).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DeliveryAreaPostalCodeRange": {
- "description": "A range of postal codes that defines the delivery area. Only set `firstPostalCode` when specifying a single postal code.",
- "id": "DeliveryAreaPostalCodeRange",
- "properties": {
- "firstPostalCode": {
- "description": "Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: `\"94108\"`, `\"9410*\"`, `\"9*\"`.",
- "type": "string"
- },
- "lastPostalCode": {
- "description": "A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area (for example [070* - 078*] results in the range [07000 - 07899]). It must have the same length as `firstPostalCode`: if `firstPostalCode` is a postal code then `lastPostalCode` must be a postal code too; if firstPostalCode is a pattern then `lastPostalCode` must be a pattern with the same prefix length. Ignored if not set, then the area is defined as being all the postal codes matching `firstPostalCode`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "DeliveryTime": {
- "id": "DeliveryTime",
- "properties": {
- "cutoffTime": {
- "$ref": "CutoffTime",
- "description": "Business days cutoff time definition. If not configured, the cutoff time will be defaulted to 8AM PST. If local delivery, use Service.StoreConfig.CutoffConfig."
- },
- "handlingBusinessDayConfig": {
- "$ref": "BusinessDayConfig",
- "description": "The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed."
- },
- "holidayCutoffs": {
- "description": "Holiday cutoff definitions. If configured, they specify order cutoff times for holiday-specific shipping.",
- "items": {
- "$ref": "HolidayCutoff"
- },
- "type": "array"
- },
- "maxHandlingTimeInDays": {
- "description": "Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `minHandlingTimeInDays`.",
- "format": "uint32",
- "type": "integer"
- },
- "maxTransitTimeInDays": {
- "description": "Maximum number of business days that are spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to `minTransitTimeInDays`.",
- "format": "uint32",
- "type": "integer"
- },
- "minHandlingTimeInDays": {
- "description": "Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.",
- "format": "uint32",
- "type": "integer"
- },
- "minTransitTimeInDays": {
- "description": "Minimum number of business days that are spent in transit. 0 means same day delivery, 1 means next day delivery. Either `{min,max}TransitTimeInDays` or `transitTimeTable` must be set, but not both.",
- "format": "uint32",
- "type": "integer"
- },
- "transitBusinessDayConfig": {
- "$ref": "BusinessDayConfig",
- "description": "The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed."
- },
- "transitTimeTable": {
- "$ref": "TransitTable",
- "description": "Transit time table, number of business days spent in transit based on row and column dimensions. Either `{min,max}TransitTimeInDays` or `transitTimeTable` can be set, but not both."
- },
- "warehouseBasedDeliveryTimes": {
- "description": "Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in DeliveryTime should be set.",
- "items": {
- "$ref": "WarehouseBasedDeliveryTime"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "Distance": {
- "description": "Distance represented by an integer and unit.",
- "id": "Distance",
- "properties": {
- "unit": {
- "description": "The distance unit. Acceptable values are `None`, `Miles`, and `Kilometers`.",
- "type": "string"
- },
- "value": {
- "description": "The distance represented as a number.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ECommercePlatformLinkInfo": {
- "description": "Additional information required for E_COMMERCE_PLATFORM link type.",
- "id": "ECommercePlatformLinkInfo",
- "properties": {
- "externalAccountId": {
- "description": "The id used by the third party service provider to identify the merchant.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Error": {
- "description": "An error returned by the API.",
- "id": "Error",
- "properties": {
- "domain": {
- "description": "The domain of the error.",
- "type": "string"
- },
- "message": {
- "description": "A description of the error.",
- "type": "string"
- },
- "reason": {
- "description": "The error code.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Errors": {
- "description": "A list of errors returned by a failed batch entry.",
- "id": "Errors",
- "properties": {
- "code": {
- "description": "The HTTP status of the first error in `errors`.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "description": "A list of errors.",
- "items": {
- "$ref": "Error"
- },
- "type": "array"
- },
- "message": {
- "description": "The message of the first error in `errors`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ExternalAction": {
- "description": "Action that is implemented and performed outside of the third-party application. It should redirect the merchant to the provided URL of an external system where they can perform the action. For example to request a review in the Merchant Center.",
- "id": "ExternalAction",
- "properties": {
- "type": {
- "description": "The type of external action.",
- "enum": [
- "EXTERNAL_ACTION_TYPE_UNSPECIFIED",
- "REVIEW_PRODUCT_ISSUE_IN_MERCHANT_CENTER",
- "REVIEW_ACCOUNT_ISSUE_IN_MERCHANT_CENTER",
- "LEGAL_APPEAL_IN_HELP_CENTER",
- "VERIFY_IDENTITY_IN_MERCHANT_CENTER"
- ],
- "enumDescriptions": [
- "Default value. Will never be provided by the API.",
- "Redirect to Merchant Center where the merchant can request a review for issue related to their product.",
- "Redirect to Merchant Center where the merchant can request a review for issue related to their account.",
- "Redirect to the form in Help Center where the merchant can request a legal appeal for the issue.",
- "Redirect to Merchant Center where the merchant can perform identity verification."
- ],
- "type": "string"
- },
- "uri": {
- "description": "URL to external system, for example Merchant Center, where the merchant can perform the action.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "FreeListingsProgramStatus": {
- "description": "Response message for GetFreeListingsProgramStatus.",
- "id": "FreeListingsProgramStatus",
- "properties": {
- "globalState": {
- "description": "State of the program. `ENABLED` if there are offers for at least one region.",
- "enum": [
- "PROGRAM_STATE_UNSPECIFIED",
- "NOT_ENABLED",
- "NO_OFFERS_UPLOADED",
- "ENABLED"
- ],
- "enumDescriptions": [
- "State is unknown.",
- "Program is not enabled for any country.",
- "No products have been uploaded for any region. Upload products to Merchant Center.",
- "Program is enabled and offers are uploaded for at least one country."
- ],
- "type": "string"
- },
- "regionStatuses": {
- "description": "Status of the program in each region. Regions with the same status and review eligibility are grouped together in `regionCodes`.",
- "items": {
- "$ref": "FreeListingsProgramStatusRegionStatus"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "FreeListingsProgramStatusRegionStatus": {
- "description": "Status of program and region.",
- "id": "FreeListingsProgramStatusRegionStatus",
- "properties": {
- "disapprovalDate": {
- "description": "Date by which eligibilityStatus will go from `WARNING` to `DISAPPROVED`. Only visible when your eligibilityStatus is WARNING. In [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DD`.",
- "type": "string"
- },
- "eligibilityStatus": {
- "description": "Eligibility status of the standard free listing program.",
- "enum": [
- "STATE_UNSPECIFIED",
- "APPROVED",
- "DISAPPROVED",
- "WARNING",
- "UNDER_REVIEW",
- "PENDING_REVIEW",
- "ONBOARDING"
- ],
- "enumDescriptions": [
- "State is not known.",
- "If the account has no issues and review is completed successfully.",
- "There are one or more issues that needs to be resolved for account to be active for the program. Detailed list of account issues are available in [accountstatuses](https://developers.google.com/shopping-content/reference/rest/v2.1/accountstatuses) API.",
- "If account has issues but offers are servable. Some of the issue can make account DISAPPROVED after a certain deadline.",
- "Account is under review.",
- "Account is waiting for review to start.",
- "Program is currently onboarding. Upload valid offers to complete onboarding."
- ],
- "type": "string"
- },
- "onboardingIssues": {
- "description": "Issues that must be fixed to be eligible for review.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "regionCodes": {
- "description": "The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) codes for all the regions with the same `eligibilityStatus` and `reviewEligibility`.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "reviewEligibilityStatus": {
- "description": "If a program is eligible for review in a specific region. Only visible if `eligibilityStatus` is `DISAPPROVED`.",
- "enum": [
- "REVIEW_ELIGIBILITY_UNSPECIFIED",
- "ELIGIBLE",
- "INELIGIBLE"
- ],
- "enumDescriptions": [
- "Review eligibility state is unknown.",
- "Account is eligible for review for a specified region code.",
- "Account is not eligible for review for a specified region code."
- ],
- "type": "string"
- },
- "reviewIneligibilityReason": {
- "description": "Review ineligibility reason if account is not eligible for review.",
- "enum": [
- "REVIEW_INELIGIBILITY_REASON_UNSPECIFIED",
- "ONBOARDING_ISSUES",
- "NOT_ENOUGH_OFFERS",
- "IN_COOLDOWN_PERIOD",
- "ALREADY_UNDER_REVIEW",
- "NO_REVIEW_REQUIRED",
- "WILL_BE_REVIEWED_AUTOMATICALLY",
- "IS_RETIRED",
- "ALREADY_REVIEWED"
- ],
- "enumDescriptions": [
- "Requesting a review from Google is not possible.",
- "All onboarding issues needs to be fixed.",
- "Not enough offers uploaded for this country.",
- "Cooldown period applies. Wait until cooldown period ends.",
- "Account is already under review.",
- "No issues available to review.",
- "Account will be automatically reviewed at the end of the grace period.",
- "Account is retired. Should not appear in MC.",
- "Account has already been reviewed. You can't request further reviews."
- ],
- "type": "string"
- },
- "reviewIneligibilityReasonDescription": {
- "description": "Reason a program in a specific region isn’t eligible for review. Only visible if `reviewEligibilityStatus` is `INELIGIBLE`.",
- "type": "string"
- },
- "reviewIneligibilityReasonDetails": {
- "$ref": "FreeListingsProgramStatusReviewIneligibilityReasonDetails",
- "description": "Additional information for ineligibility. If `reviewIneligibilityReason` is `IN_COOLDOWN_PERIOD`, a timestamp for the end of the cooldown period is provided."
- },
- "reviewIssues": {
- "description": "Issues evaluated in the review process. Fix all issues before requesting a review.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "FreeListingsProgramStatusReviewIneligibilityReasonDetails": {
- "description": "Additional details for review ineligibility reasons.",
- "id": "FreeListingsProgramStatusReviewIneligibilityReasonDetails",
- "properties": {
- "cooldownTime": {
- "description": "This timestamp represents end of cooldown period for review ineligbility reason `IN_COOLDOWN_PERIOD`.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "type": "object"
- },
- "FreeShippingThreshold": {
- "description": "Conditions to be met for a product to have free shipping.",
- "id": "FreeShippingThreshold",
- "properties": {
- "country": {
- "description": "Required. The [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) of the country to which an item will ship.",
- "type": "string"
- },
- "priceThreshold": {
- "$ref": "Price",
- "description": "Required. The minimum product price for the shipping cost to become free. Represented as a number."
- }
- },
- "type": "object"
- },
- "GenerateRecommendationsResponse": {
- "description": "Response containing generated recommendations.",
- "id": "GenerateRecommendationsResponse",
- "properties": {
- "recommendations": {
- "description": "Recommendations generated for a request.",
- "items": {
- "$ref": "Recommendation"
- },
- "type": "array"
- },
- "responseToken": {
- "description": "Output only. Response token is a string created for each `GenerateRecommendationsResponse`. This token doesn't expire, and is globally unique. This token must be used when reporting interactions for recommendations.",
- "readOnly": true,
- "type": "string"
- }
- },
- "type": "object"
- },
- "GmbAccounts": {
- "id": "GmbAccounts",
- "properties": {
- "accountId": {
- "description": "The ID of the Merchant Center account.",
- "format": "uint64",
- "type": "string"
- },
- "gmbAccounts": {
- "description": "A list of Business Profiles which are available to the merchant.",
- "items": {
- "$ref": "GmbAccountsGmbAccount"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "GmbAccountsGmbAccount": {
- "id": "GmbAccountsGmbAccount",
- "properties": {
- "email": {
- "description": "The email which identifies the Business Profile.",
- "type": "string"
- },
- "listingCount": {
- "description": "Number of listings under this account.",
- "format": "uint64",
- "type": "string"
- },
- "name": {
- "description": "The name of the Business Profile.",
- "type": "string"
- },
- "type": {
- "description": "The type of the Business Profile (User or Business).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "GoogleAnalyticsLink": {
- "description": "\"Google Analytics Link\" sources can be used to get conversion data from an existing Google Analytics property into the linked Merchant Center account.",
- "id": "GoogleAnalyticsLink",
- "properties": {
- "attributionSettings": {
- "$ref": "AttributionSettings",
- "description": "Output only. Attribution settings for the linked Google Analytics property.",
- "readOnly": true
- },
- "propertyId": {
- "description": "Required. Immutable. ID of the Google Analytics property the merchant is linked to.",
- "format": "int64",
- "type": "string"
- },
- "propertyName": {
- "description": "Output only. Name of the Google Analytics property the merchant is linked to.",
- "readOnly": true,
- "type": "string"
- }
- },
- "type": "object"
- },
- "Headers": {
- "description": "A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `numItems`, `postalCodeGroupNames`, or `location` must be set.",
- "id": "Headers",
- "properties": {
- "locations": {
- "description": "A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.",
- "items": {
- "$ref": "LocationIdSet"
- },
- "type": "array"
- },
- "numberOfItems": {
- "description": "A list of inclusive number of items upper bounds. The last value can be `\"infinity\"`. For example `[\"10\", \"50\", \"infinity\"]` represents the headers \"<= 10 items\", \"<= 50 items\", and \"> 50 items\". Must be non-empty. Can only be set if all other fields are not set.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "postalCodeGroupNames": {
- "description": "A list of postal group names. The last value can be `\"all other locations\"`. Example: `[\"zone 1\", \"zone 2\", \"all other locations\"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "prices": {
- "description": "A list of inclusive order price upper bounds. The last price's value can be `\"infinity\"`. For example `[{\"value\": \"10\", \"currency\": \"USD\"}, {\"value\": \"500\", \"currency\": \"USD\"}, {\"value\": \"infinity\", \"currency\": \"USD\"}]` represents the headers \"<= $10\", \"<= $500\", and \"> $500\". All prices within a service must have the same currency. Must be non-empty. Can only be set if all other fields are not set.",
- "items": {
- "$ref": "Price"
- },
- "type": "array"
- },
- "weights": {
- "description": "A list of inclusive order weight upper bounds. The last weight's value can be `\"infinity\"`. For example `[{\"value\": \"10\", \"unit\": \"kg\"}, {\"value\": \"50\", \"unit\": \"kg\"}, {\"value\": \"infinity\", \"unit\": \"kg\"}]` represents the headers \"<= 10kg\", \"<= 50kg\", and \"> 50kg\". All weights within a service must have the same unit. Must be non-empty. Can only be set if all other fields are not set.",
- "items": {
- "$ref": "Weight"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "HolidayCutoff": {
- "id": "HolidayCutoff",
- "properties": {
- "deadlineDate": {
- "description": "Date of the order deadline, in ISO 8601 format. For example, \"2016-11-29\" for 29th November 2016. Required.",
- "type": "string"
- },
- "deadlineHour": {
- "description": "Hour of the day on the deadline date until which the order has to be placed to qualify for the delivery guarantee. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Required.",
- "format": "uint32",
- "type": "integer"
- },
- "deadlineTimezone": {
- "description": "Timezone identifier for the deadline hour (for example, \"Europe/Zurich\"). List of identifiers. Required.",
- "type": "string"
- },
- "holidayId": {
- "description": "Unique identifier for the holiday. Required.",
- "type": "string"
- },
- "visibleFromDate": {
- "description": "Date on which the deadline will become visible to consumers in ISO 8601 format. For example, \"2016-10-31\" for 31st October 2016. Required.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "HolidaysHoliday": {
- "id": "HolidaysHoliday",
- "properties": {
- "countryCode": {
- "description": "The CLDR territory code of the country in which the holiday is available. For example, \"US\", \"DE\", \"GB\". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present.",
- "type": "string"
- },
- "date": {
- "description": "Date of the holiday, in ISO 8601 format. For example, \"2016-12-25\" for Christmas 2016. Always present.",
- "type": "string"
- },
- "deliveryGuaranteeDate": {
- "description": "Date on which the order has to arrive at the customer's, in ISO 8601 format. For example, \"2016-12-24\" for 24th December 2016. Always present.",
- "type": "string"
- },
- "deliveryGuaranteeHour": {
- "description": "Hour of the day in the delivery location's timezone on the guaranteed delivery date by which the order has to arrive at the customer's. Possible values are: 0 (midnight), 1, ..., 12 (noon), 13, ..., 23. Always present.",
- "format": "uint64",
- "type": "string"
- },
- "id": {
- "description": "Unique identifier for the holiday to be used when configuring holiday cutoffs. Always present.",
- "type": "string"
- },
- "type": {
- "description": "The holiday type. Always present. Acceptable values are: - \"`Christmas`\" - \"`Easter`\" - \"`Father's Day`\" - \"`Halloween`\" - \"`Independence Day (USA)`\" - \"`Mother's Day`\" - \"`Thanksgiving`\" - \"`Valentine's Day`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "InputField": {
- "description": "Input field that needs to be available to the merchant. If the field is marked as required, then a value needs to be provided for a successful processing of the request.",
- "id": "InputField",
- "properties": {
- "checkboxInput": {
- "$ref": "InputFieldCheckboxInput",
- "description": "Input field to provide a boolean value. Corresponds to the [html input type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox)."
- },
- "choiceInput": {
- "$ref": "InputFieldChoiceInput",
- "description": "Input field to select one of the offered choices. Corresponds to the [html input type=radio](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.radio.html#input.radio)."
- },
- "id": {
- "description": "Not for display but need to be sent back for the given input field.",
- "type": "string"
- },
- "label": {
- "$ref": "TextWithTooltip",
- "description": "Input field label. There may be more information to be shown in a tooltip."
- },
- "required": {
- "description": "Whether the field is required. The action button needs to stay disabled till values for all required fields are provided.",
- "type": "boolean"
- },
- "textInput": {
- "$ref": "InputFieldTextInput",
- "description": "Input field to provide text information. Corresponds to the [html input type=text](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text) or [html textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea)."
- }
- },
- "type": "object"
- },
- "InputFieldCheckboxInput": {
- "description": "Checkbox input allows merchants to provide a boolean value. Corresponds to the [html input type=checkbox](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.checkbox.html#input.checkbox). If merchant checks the box, the input value for the field is `true`, otherwise it is `false`. This type of input is often used as a confirmation that the merchant completed required steps before they are allowed to start the action. In such a case, the input field is marked as required and the button to trigger the action should stay disabled until the merchant checks the box.",
- "id": "InputFieldCheckboxInput",
- "properties": {},
- "type": "object"
- },
- "InputFieldChoiceInput": {
- "description": "Choice input allows merchants to select one of the offered choices. Some choices may be linked to additional input fields that should be displayed under or next to the choice option. The value for the additional input field needs to be provided only when the specific choice is selected by the merchant. For example, additional input field can be hidden or disabled until the merchant selects the specific choice.",
- "id": "InputFieldChoiceInput",
- "properties": {
- "options": {
- "description": "A list of choices. Only one option can be selected.",
- "items": {
- "$ref": "InputFieldChoiceInputChoiceInputOption"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "InputFieldChoiceInputChoiceInputOption": {
- "description": "A choice that merchant can select.",
- "id": "InputFieldChoiceInputChoiceInputOption",
- "properties": {
- "additionalInput": {
- "$ref": "InputField",
- "description": "Input that should be displayed when this option is selected. The additional input will not contain a `ChoiceInput`."
- },
- "id": {
- "description": "Not for display but need to be sent back for the selected choice option.",
- "type": "string"
- },
- "label": {
- "$ref": "TextWithTooltip",
- "description": "Short description of the choice option. There may be more information to be shown as a tooltip."
- }
- },
- "type": "object"
- },
- "InputFieldTextInput": {
- "description": "Text input allows merchants to provide a text value.",
- "id": "InputFieldTextInput",
- "properties": {
- "additionalInfo": {
- "$ref": "TextWithTooltip",
- "description": "Additional info regarding the field to be displayed to merchant. For example, warning to not include personal identifiable information. There may be more information to be shown in a tooltip."
- },
- "ariaLabel": {
- "description": "Text to be used as the [aria-label](https://www.w3.org/TR/WCAG20-TECHS/ARIA14.html) for the input.",
- "type": "string"
- },
- "formatInfo": {
- "description": "Information about the required format. If present, it should be shown close to the input field to help merchants to provide a correct value. For example: \"VAT numbers should be in a format similar to SK9999999999\"",
- "type": "string"
- },
- "type": {
- "description": "Type of the text input",
- "enum": [
- "TEXT_INPUT_TYPE_UNSPECIFIED",
- "GENERIC_SHORT_TEXT",
- "GENERIC_LONG_TEXT"
- ],
- "enumDescriptions": [
- "Default value. Will never be provided by the API.",
- "Used when a short text is expected. The field can be rendered as a [text field](https://www.w3.org/TR/2012/WD-html-markup-20121025/input.text.html#input.text).",
- "Used when a longer text is expected. The field should be rendered as a [textarea](https://www.w3.org/TR/2012/WD-html-markup-20121025/textarea.html#textarea)."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "InputValue": {
- "description": "Input provided by the merchant for input field.",
- "id": "InputValue",
- "properties": {
- "checkboxInputValue": {
- "$ref": "InputValueCheckboxInputValue",
- "description": "Value for checkbox input field."
- },
- "choiceInputValue": {
- "$ref": "InputValueChoiceInputValue",
- "description": "Value for choice input field."
- },
- "inputFieldId": {
- "description": "Required. Id of the corresponding input field.",
- "type": "string"
- },
- "textInputValue": {
- "$ref": "InputValueTextInputValue",
- "description": "Value for text input field."
- }
- },
- "type": "object"
- },
- "InputValueCheckboxInputValue": {
- "description": "Value for checkbox input field.",
- "id": "InputValueCheckboxInputValue",
- "properties": {
- "value": {
- "description": "Required. True if the merchant checked the box field. False otherwise.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "InputValueChoiceInputValue": {
- "description": "Value for choice input field.",
- "id": "InputValueChoiceInputValue",
- "properties": {
- "choiceInputOptionId": {
- "description": "Required. Id of the option that was selected by the merchant.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "InputValueTextInputValue": {
- "description": "Value for text input field.",
- "id": "InputValueTextInputValue",
- "properties": {
- "value": {
- "description": "Required. Text provided by the merchant.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "InsertCheckoutSettingsRequest": {
- "description": "Request message for the `InsertCheckoutSettings` method.",
- "id": "InsertCheckoutSettingsRequest",
- "properties": {
- "uriSettings": {
- "$ref": "UrlSettings",
- "description": "Required. The `UrlSettings` for the request. The presence of URL settings indicates `Checkout` enrollment."
- }
- },
- "type": "object"
- },
- "Installment": {
- "description": "Details of a monthly installment payment offering. [Learn more](https://support.google.com/merchants/answer/6324474) about installments.",
- "id": "Installment",
- "properties": {
- "amount": {
- "$ref": "Price",
- "description": "The amount the buyer has to pay per month."
- },
- "creditType": {
- "description": "Optional. Type of installment payments. Supported values are: - \"`finance`\" - \"`lease`\" ",
- "type": "string"
- },
- "downpayment": {
- "$ref": "Price",
- "description": "Optional. The initial down payment amount the buyer has to pay."
- },
- "months": {
- "description": "The number of installments the buyer has to pay.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LabelIds": {
- "description": "The IDs of labels that should be assigned to the CSS domain.",
- "id": "LabelIds",
- "properties": {
- "labelIds": {
- "description": "The list of label IDs.",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LiaAboutPageSettings": {
- "id": "LiaAboutPageSettings",
- "properties": {
- "status": {
- "description": "The status of the verification process for the About page. Supported values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
- "type": "string"
- },
- "url": {
- "description": "The URL for the About page.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiaCountrySettings": {
- "id": "LiaCountrySettings",
- "properties": {
- "about": {
- "$ref": "LiaAboutPageSettings",
- "description": "The settings for the About page."
- },
- "country": {
- "description": "Required. CLDR country code (for example, \"US\").",
- "type": "string"
- },
- "hostedLocalStorefrontActive": {
- "description": "The status of the \"Merchant hosted local storefront\" feature.",
- "type": "boolean"
- },
- "inventory": {
- "$ref": "LiaInventorySettings",
- "description": "LIA inventory verification settings."
- },
- "omnichannelExperience": {
- "$ref": "LiaOmnichannelExperience",
- "description": "The omnichannel experience configured for this country."
- },
- "onDisplayToOrder": {
- "$ref": "LiaOnDisplayToOrderSettings",
- "description": "LIA \"On Display To Order\" settings."
- },
- "posDataProvider": {
- "$ref": "LiaPosDataProvider",
- "description": "The POS data provider linked with this country."
- },
- "storePickupActive": {
- "description": "The status of the \"Store pickup\" feature.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "LiaInventorySettings": {
- "id": "LiaInventorySettings",
- "properties": {
- "inventoryVerificationContactEmail": {
- "description": "The email of the contact for the inventory verification process.",
- "type": "string"
- },
- "inventoryVerificationContactName": {
- "description": "The name of the contact for the inventory verification process.",
- "type": "string"
- },
- "inventoryVerificationContactStatus": {
- "description": "The status of the verification contact. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
- "type": "string"
- },
- "status": {
- "description": "The status of the inventory verification process. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiaOmnichannelExperience": {
- "description": "Omnichannel experience details.",
- "id": "LiaOmnichannelExperience",
- "properties": {
- "country": {
- "description": "The CLDR country code (for example, \"US\").",
- "type": "string"
- },
- "lsfType": {
- "description": "The Local Store Front (LSF) type for this country. Acceptable values are: - \"`ghlsf`\" (Google-Hosted Local Store Front) - \"`mhlsfBasic`\" (Merchant-Hosted Local Store Front Basic) - \"`mhlsfFull`\" (Merchant-Hosted Local Store Front Full) More details about these types can be found here.",
- "type": "string"
- },
- "pickupTypes": {
- "description": "The Pickup types for this country. Acceptable values are: - \"`pickupToday`\" - \"`pickupLater`\" ",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LiaOnDisplayToOrderSettings": {
- "id": "LiaOnDisplayToOrderSettings",
- "properties": {
- "shippingCostPolicyUrl": {
- "description": "Shipping cost and policy URL.",
- "type": "string"
- },
- "status": {
- "description": "The status of the ?On display to order? feature. Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiaPosDataProvider": {
- "id": "LiaPosDataProvider",
- "properties": {
- "posDataProviderId": {
- "description": "The ID of the POS data provider.",
- "format": "uint64",
- "type": "string"
- },
- "posExternalAccountId": {
- "description": "The account ID by which this merchant is known to the POS data provider.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiaSettings": {
- "description": "Local Inventory ads (LIA) settings. All methods except listposdataproviders require the admin role.",
- "id": "LiaSettings",
- "properties": {
- "accountId": {
- "description": "The ID of the account to which these LIA settings belong. Ignored upon update, always present in get request responses.",
- "format": "uint64",
- "type": "string"
- },
- "countrySettings": {
- "description": "The LIA settings for each country.",
- "items": {
- "$ref": "LiaCountrySettings"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liaSettings`\"",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiasettingsCustomBatchRequest": {
- "id": "LiasettingsCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "LiasettingsCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LiasettingsCustomBatchRequestEntry": {
- "id": "LiasettingsCustomBatchRequestEntry",
- "properties": {
- "accountId": {
- "description": "The ID of the account for which to get/update account LIA settings.",
- "format": "uint64",
- "type": "string"
- },
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "contactEmail": {
- "description": "Inventory validation contact email. Required only for SetInventoryValidationContact.",
- "type": "string"
- },
- "contactName": {
- "description": "Inventory validation contact name. Required only for SetInventoryValidationContact.",
- "type": "string"
- },
- "country": {
- "description": "The country code. Required only for RequestInventoryVerification.",
- "type": "string"
- },
- "gmbEmail": {
- "description": "The Business Profile. Required only for RequestGmbAccess.",
- "type": "string"
- },
- "liaSettings": {
- "$ref": "LiaSettings",
- "description": "The account Lia settings to update. Only defined if the method is `update`."
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`getAccessibleGmbAccounts`\" - \"`requestGmbAccess`\" - \"`requestInventoryVerification`\" - \"`setInventoryVerificationContact`\" - \"`update`\" ",
- "type": "string"
- },
- "omnichannelExperience": {
- "$ref": "LiaOmnichannelExperience",
- "description": "The omnichannel experience for a country. Required only for SetOmnichannelExperience."
- },
- "posDataProviderId": {
- "description": "The ID of POS data provider. Required only for SetPosProvider.",
- "format": "uint64",
- "type": "string"
- },
- "posExternalAccountId": {
- "description": "The account ID by which this merchant is known to the POS provider.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiasettingsCustomBatchResponse": {
- "id": "LiasettingsCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "LiasettingsCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liasettingsCustomBatchResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiasettingsCustomBatchResponseEntry": {
- "id": "LiasettingsCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry to which this entry responds.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if, and only if, the request failed."
- },
- "gmbAccounts": {
- "$ref": "GmbAccounts",
- "description": "The list of accessible Business Profiles."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liasettingsCustomBatchResponseEntry`\"",
- "type": "string"
- },
- "liaSettings": {
- "$ref": "LiaSettings",
- "description": "The retrieved or updated Lia settings."
- },
- "omnichannelExperience": {
- "$ref": "LiaOmnichannelExperience",
- "description": "The updated omnichannel experience for a country."
- },
- "posDataProviders": {
- "description": "The list of POS data providers.",
- "items": {
- "$ref": "PosDataProviders"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LiasettingsGetAccessibleGmbAccountsResponse": {
- "id": "LiasettingsGetAccessibleGmbAccountsResponse",
- "properties": {
- "accountId": {
- "description": "The ID of the Merchant Center account.",
- "format": "uint64",
- "type": "string"
- },
- "gmbAccounts": {
- "description": "A list of Business Profiles which are available to the merchant.",
- "items": {
- "$ref": "GmbAccountsGmbAccount"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liasettingsGetAccessibleGmbAccountsResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiasettingsListPosDataProvidersResponse": {
- "id": "LiasettingsListPosDataProvidersResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liasettingsListPosDataProvidersResponse`\".",
- "type": "string"
- },
- "posDataProviders": {
- "description": "The list of POS data providers for each eligible country",
- "items": {
- "$ref": "PosDataProviders"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LiasettingsListResponse": {
- "id": "LiasettingsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liasettingsListResponse`\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of LIA settings.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "LiaSettings"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LiasettingsRequestGmbAccessResponse": {
- "id": "LiasettingsRequestGmbAccessResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liasettingsRequestGmbAccessResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiasettingsRequestInventoryVerificationResponse": {
- "id": "LiasettingsRequestInventoryVerificationResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liasettingsRequestInventoryVerificationResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiasettingsSetInventoryVerificationContactResponse": {
- "id": "LiasettingsSetInventoryVerificationContactResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liasettingsSetInventoryVerificationContactResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LiasettingsSetPosDataProviderResponse": {
- "id": "LiasettingsSetPosDataProviderResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#liasettingsSetPosDataProviderResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LinkService": {
- "id": "LinkService",
- "properties": {
- "service": {
- "description": "Service provided to or by the linked account. Acceptable values are: - \"`shoppingActionsOrderManagement`\" - \"`shoppingActionsProductManagement`\" - \"`shoppingAdsProductManagement`\" - \"`paymentProcessing`\" ",
- "type": "string"
- },
- "status": {
- "description": "Status of the link Acceptable values are: - \"`active`\" - \"`inactive`\" - \"`pending`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LinkedAccount": {
- "id": "LinkedAccount",
- "properties": {
- "linkedAccountId": {
- "description": "The ID of the linked account.",
- "type": "string"
- },
- "services": {
- "description": "List of provided services.",
- "items": {
- "$ref": "LinkService"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ListAccountLabelsResponse": {
- "description": "Response message for the `ListAccountLabels` method.",
- "id": "ListAccountLabelsResponse",
- "properties": {
- "accountLabels": {
- "description": "The labels from the specified account.",
- "items": {
- "$ref": "AccountLabel"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ListAccountReturnCarrierResponse": {
- "description": "Response for listing account return carriers.",
- "id": "ListAccountReturnCarrierResponse",
- "properties": {
- "accountReturnCarriers": {
- "description": "List of all available account return carriers for the merchant.",
- "items": {
- "$ref": "AccountReturnCarrier"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ListCollectionStatusesResponse": {
- "description": "Response message for the ListCollectionStatuses method.",
- "id": "ListCollectionStatusesResponse",
- "properties": {
- "nextPageToken": {
- "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
- "type": "string"
- },
- "resources": {
- "description": "The collectionstatuses listed.",
- "items": {
- "$ref": "CollectionStatus"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ListCollectionsResponse": {
- "description": "Response message for the ListCollections method.",
- "id": "ListCollectionsResponse",
- "properties": {
- "nextPageToken": {
- "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
- "type": "string"
- },
- "resources": {
- "description": "The collections listed.",
- "items": {
- "$ref": "Collection"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ListConversionSourcesResponse": {
- "description": "Response message for the ListConversionSources method.",
- "id": "ListConversionSourcesResponse",
- "properties": {
- "conversionSources": {
- "description": "List of conversion sources.",
- "items": {
- "$ref": "ConversionSource"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "Token to be used to fetch the next results page.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ListCssesResponse": {
- "description": "The response message for the `ListCsses` method",
- "id": "ListCssesResponse",
- "properties": {
- "csses": {
- "description": "The CSS domains affiliated with the specified CSS group.",
- "items": {
- "$ref": "Css"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ListMethodQuotasResponse": {
- "description": "Response message for the ListMethodQuotas method.",
- "id": "ListMethodQuotasResponse",
- "properties": {
- "methodQuotas": {
- "description": "The current quota usage and limits per each method.",
- "items": {
- "$ref": "MethodQuota"
- },
- "type": "array"
- },
- "nextPageToken": {
- "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ListPromotionResponse": {
- "description": "Response message for Promotions.List method.",
- "id": "ListPromotionResponse",
- "properties": {
- "nextPageToken": {
- "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
- "type": "string"
- },
- "promotions": {
- "description": "List of all available promotions for the merchant.",
- "items": {
- "$ref": "Promotion"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ListRegionsResponse": {
- "description": "Response message for the `ListRegions` method.",
- "id": "ListRegionsResponse",
- "properties": {
- "nextPageToken": {
- "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
- "type": "string"
- },
- "regions": {
- "description": "The regions from the specified merchant.",
- "items": {
- "$ref": "Region"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ListReturnPolicyOnlineResponse": {
- "description": "Response message for the `ListReturnPolicyOnline` method.",
- "id": "ListReturnPolicyOnlineResponse",
- "properties": {
- "returnPolicies": {
- "description": "The retrieved return policies.",
- "items": {
- "$ref": "ReturnPolicyOnline"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LocalInventory": {
- "description": "Local inventory resource. For accepted attribute values, see the local product inventory feed specification.",
- "id": "LocalInventory",
- "properties": {
- "availability": {
- "description": "The availability of the product. For accepted attribute values, see the local product inventory feed specification.",
- "type": "string"
- },
- "customAttributes": {
- "description": "A list of custom (merchant-provided) attributes. Can also be used to submit any attribute of the feed specification in its generic form, for example, `{ \"name\": \"size type\", \"value\": \"regular\" }`.",
- "items": {
- "$ref": "CustomAttribute"
- },
- "type": "array"
- },
- "instoreProductLocation": {
- "description": "The in-store product location.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#localInventory`\"",
- "type": "string"
- },
- "pickupMethod": {
- "description": "The supported pickup method for this offer. Unless the value is \"not supported\", this field must be submitted together with `pickupSla`. For accepted attribute values, see the local product inventory feed specification.",
- "type": "string"
- },
- "pickupSla": {
- "description": "The expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the local product inventory feed specification.",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "The price of the product."
- },
- "quantity": {
- "description": "The quantity of the product. Must be nonnegative.",
- "format": "uint32",
- "type": "integer"
- },
- "salePrice": {
- "$ref": "Price",
- "description": "The sale price of the product. Mandatory if `sale_price_effective_date` is defined."
- },
- "salePriceEffectiveDate": {
- "description": "A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates may be specified as 'null' if undecided.",
- "type": "string"
- },
- "storeCode": {
- "description": "Required. The store code of this local inventory resource.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LocalinventoryCustomBatchRequest": {
- "id": "LocalinventoryCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "LocalinventoryCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LocalinventoryCustomBatchRequestEntry": {
- "description": "Batch entry encoding a single local inventory update request.",
- "id": "LocalinventoryCustomBatchRequestEntry",
- "properties": {
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "localInventory": {
- "$ref": "LocalInventory",
- "description": "Local inventory of the product."
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "Method of the batch request entry. Acceptable values are: - \"`insert`\" ",
- "type": "string"
- },
- "productId": {
- "description": "The ID of the product for which to update local inventory.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LocalinventoryCustomBatchResponse": {
- "id": "LocalinventoryCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "LocalinventoryCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#localinventoryCustomBatchResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LocalinventoryCustomBatchResponseEntry": {
- "description": "Batch entry encoding a single local inventory update response.",
- "id": "LocalinventoryCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors for failed custombatch entries. *Note:* Schema errors fail the whole request."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#localinventoryCustomBatchResponseEntry`\"",
- "type": "string"
- }
- },
- "type": "object"
- },
- "LocationIdSet": {
- "id": "LocationIdSet",
- "properties": {
- "locationIds": {
- "description": "A non-empty list of location IDs. They must all be of the same location type (for example, state).",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "LoyaltyProgram": {
- "description": "Allows the setting up of loyalty program benefits (for example price or points). https://support.google.com/merchants/answer/12922446",
- "id": "LoyaltyProgram",
- "properties": {
- "cashbackForFutureUse": {
- "$ref": "Price",
- "description": "Optional. The cashback that can be used for future purchases."
- },
- "loyaltyPoints": {
- "description": "Optional. The amount of loyalty points earned on a purchase.",
- "format": "int64",
- "type": "string"
- },
- "memberPriceEffectiveDate": {
- "description": "Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash.",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price."
- },
- "programLabel": {
- "description": "Required. The label of the loyalty program. This is an internal label that uniquely identifies the relationship between a merchant entity and a loyalty program entity. It must be provided so that system can associate the assets below (for example, price and points) with a merchant. The corresponding program must be linked to the merchant account.",
- "type": "string"
- },
- "shippingLabel": {
- "description": "Optional. The shipping label for the loyalty program. You can use this label to indicate whether this offer has the loyalty shipping benefit. If not specified, the item is not eligible for loyalty shipping for the given loyalty tier.",
- "type": "string"
- },
- "tierLabel": {
- "description": "Required. The label of the tier within the loyalty program. Must match one of the labels within the program.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "MerchantCenterDestination": {
- "description": "\"Merchant Center Destination\" sources can be used to send conversion events from a website using a Google tag directly to a Merchant Center account where the source is created.",
- "id": "MerchantCenterDestination",
- "properties": {
- "attributionSettings": {
- "$ref": "AttributionSettings",
- "description": "Required. Attribution settings being used for the Merchant Center Destination."
- },
- "currencyCode": {
- "description": "Required. Three-letter currency code (ISO 4217). The currency code defines in which currency the conversions sent to this destination will be reported in Merchant Center.",
- "type": "string"
- },
- "destinationId": {
- "description": "Output only. Merchant Center Destination ID.",
- "readOnly": true,
- "type": "string"
- },
- "displayName": {
- "description": "Required. Merchant-specified display name for the destination. This is the name that identifies the conversion source within the Merchant Center UI. Limited to 64 characters.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "MethodQuota": {
- "description": "The quota information per method in the Content API.",
- "id": "MethodQuota",
- "properties": {
- "method": {
- "description": "Output only. The method name, for example `products.list`. Method name does not contain version because quota can be shared between different API versions of the same method.",
- "readOnly": true,
- "type": "string"
- },
- "quotaLimit": {
- "description": "Output only. The maximum number of calls allowed per day for the method.",
- "format": "int64",
- "readOnly": true,
- "type": "string"
- },
- "quotaMinuteLimit": {
- "description": "Output only. The maximum number of calls allowed per minute for the method.",
- "format": "int64",
- "readOnly": true,
- "type": "string"
- },
- "quotaUsage": {
- "description": "Output only. The current quota usage, meaning the number of calls already made to the method per day. Usage is reset every day at 12 PM midday UTC.",
- "format": "int64",
- "readOnly": true,
- "type": "string"
- }
- },
- "type": "object"
- },
- "Metrics": {
- "description": "Performance metrics. Values are only set for metrics requested explicitly in the request's search query.",
- "id": "Metrics",
- "properties": {
- "aos": {
- "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average order size - the average number of items in an order. **This metric cannot be segmented by product dimensions and customer_country_code.**",
- "format": "double",
- "type": "number"
- },
- "aovMicros": {
- "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average order value in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) - the average value (total price of items) of all placed orders. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by product dimensions and customer_country_code.**",
- "format": "double",
- "type": "number"
- },
- "clicks": {
- "description": "Number of clicks.",
- "format": "int64",
- "type": "string"
- },
- "conversionRate": {
- "description": "Number of conversions divided by the number of clicks, reported on the impression date. The metric is currently available only for the `FREE_PRODUCT_LISTING` program.",
- "format": "double",
- "type": "number"
- },
- "conversionValueMicros": {
- "description": "Value of conversions in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) attributed to the product, reported on the conversion date. The metric is currently available only for the `FREE_PRODUCT_LISTING` program. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response.",
- "format": "int64",
- "type": "string"
- },
- "conversions": {
- "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. The metric is currently available only for the `FREE_PRODUCT_LISTING` program.",
- "format": "double",
- "type": "number"
- },
- "ctr": {
- "description": "Click-through rate - the number of clicks merchant's products receive (clicks) divided by the number of times the products are shown (impressions).",
- "format": "double",
- "type": "number"
- },
- "daysToShip": {
- "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average number of days between an order being placed and the order being fully shipped, reported on the last shipment date. **This metric cannot be segmented by product dimensions and customer_country_code.**",
- "format": "double",
- "type": "number"
- },
- "impressions": {
- "description": "Number of times merchant's products are shown.",
- "format": "int64",
- "type": "string"
- },
- "itemDaysToShip": {
- "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Average number of days between an item being ordered and the item being **This metric cannot be segmented by customer_country_code.**",
- "format": "double",
- "type": "number"
- },
- "itemFillRate": {
- "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Percentage of shipped items in relation to all finalized items (shipped or rejected by the merchant; unshipped items are not taken into account), reported on the order date. Item fill rate is lowered by merchant rejections. **This metric cannot be segmented by customer_country_code.**",
- "format": "double",
- "type": "number"
- },
- "orderedItemSalesMicros": {
- "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total price of ordered items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros). Excludes shipping, taxes (US only), and customer cancellations that happened within 30 minutes of placing the order. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**",
- "format": "int64",
- "type": "string"
- },
- "orderedItems": {
- "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of ordered items. Excludes customer cancellations that happened within 30 minutes of placing the order. **This metric cannot be segmented by customer_country_code.**",
- "format": "int64",
- "type": "string"
- },
- "orders": {
- "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of placed orders. Excludes customer cancellations that happened within 30 minutes of placing the order. **This metric cannot be segmented by product dimensions and customer_country_code.**",
- "format": "int64",
- "type": "string"
- },
- "rejectedItems": {
- "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of ordered items canceled by the merchant, reported on the order date. **This metric cannot be segmented by customer_country_code.**",
- "format": "int64",
- "type": "string"
- },
- "returnRate": {
- "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total price of returned items divided by the total price of shipped items, reported on the order date. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**",
- "format": "double",
- "type": "number"
- },
- "returnedItems": {
- "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of ordered items sent back for return, reported on the date when the merchant accepted the return. **This metric cannot be segmented by customer_country_code.**",
- "format": "int64",
- "type": "string"
- },
- "returnsMicros": {
- "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total price of ordered items sent back for return in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the date when the merchant accepted the return. The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**",
- "format": "int64",
- "type": "string"
- },
- "shippedItemSalesMicros": {
- "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Total price of shipped items in micros (1 millionth of a standard unit, 1 USD = 1000000 micros), reported on the order date. Excludes shipping and taxes (US only). The currency of the returned value is stored in the currency_code segment. If this metric is selected, 'segments.currency_code' is automatically added to the SELECT clause in the search query (unless it is explicitly selected by the user) and the currency_code segment is populated in the response. **This metric cannot be segmented by customer_country_code.**",
- "format": "int64",
- "type": "string"
- },
- "shippedItems": {
- "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of shipped items, reported on the shipment date. **This metric cannot be segmented by customer_country_code.**",
- "format": "int64",
- "type": "string"
- },
- "shippedOrders": {
- "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of fully shipped orders, reported on the last shipment date. **This metric cannot be segmented by product dimensions and customer_country_code.**",
- "format": "int64",
- "type": "string"
- },
- "unshippedItems": {
- "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of ordered items not shipped up until the end of the queried day. If a multi-day period is specified in the search query, the returned value is the average number of unshipped items over the days in the queried period. **This metric cannot be segmented by customer_country_code.**",
- "format": "double",
- "type": "number"
- },
- "unshippedOrders": {
- "description": "*Deprecated*: This field is no longer supported and retrieving it returns 0 starting from May 2024. Number of orders not shipped or partially shipped up until the end of the queried day. If a multi-day period is specified in the search query, the returned value is the average number of unshipped orders over the days in the queried period. **This metric cannot be segmented by product dimensions and customer_country_code.**",
- "format": "double",
- "type": "number"
- }
- },
- "type": "object"
- },
- "MinimumOrderValueTable": {
- "id": "MinimumOrderValueTable",
- "properties": {
- "storeCodeSetWithMovs": {
- "items": {
- "$ref": "MinimumOrderValueTableStoreCodeSetWithMov"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "MinimumOrderValueTableStoreCodeSetWithMov": {
- "description": "A list of store code sets sharing the same minimum order value. At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency.",
- "id": "MinimumOrderValueTableStoreCodeSetWithMov",
- "properties": {
- "storeCodes": {
- "description": "A list of unique store codes or empty for the catch all.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "value": {
- "$ref": "Price",
- "description": "The minimum order value for the given stores."
- }
- },
- "type": "object"
- },
- "OrderTrackingSignal": {
- "description": "Represents a merchant trade from which signals are extracted, e.g. shipping.",
- "id": "OrderTrackingSignal",
- "properties": {
- "customerShippingFee": {
- "$ref": "PriceAmount",
- "description": "The shipping fee of the order; this value should be set to zero in the case of free shipping."
- },
- "deliveryPostalCode": {
- "description": "Required. The delivery postal code, as a continuous string without spaces or dashes, e.g. \"95016\". This field will be anonymized in returned OrderTrackingSignal creation response.",
- "type": "string"
- },
- "deliveryRegionCode": {
- "description": "Required. The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping destination.",
- "type": "string"
- },
- "lineItems": {
- "description": "Information about line items in the order.",
- "items": {
- "$ref": "OrderTrackingSignalLineItemDetails"
- },
- "type": "array"
- },
- "merchantId": {
- "description": "The Google merchant ID of this order tracking signal. This value is optional. If left unset, the caller's merchant ID is used. You must request access in order to provide data on behalf of another merchant. For more information, see [Submitting Order Tracking Signals](/shopping-content/guides/order-tracking-signals).",
- "format": "int64",
- "type": "string"
- },
- "orderCreatedTime": {
- "$ref": "DateTime",
- "description": "Required. The time when the order was created on the merchant side. Include the year and timezone string, if available."
- },
- "orderId": {
- "description": "Required. The ID of the order on the merchant side. This field will be hashed in returned OrderTrackingSignal creation response.",
- "type": "string"
- },
- "orderTrackingSignalId": {
- "description": "Output only. The ID that uniquely identifies this order tracking signal.",
- "format": "int64",
- "readOnly": true,
- "type": "string"
- },
- "shipmentLineItemMapping": {
- "description": "The mapping of the line items to the shipment information.",
- "items": {
- "$ref": "OrderTrackingSignalShipmentLineItemMapping"
- },
- "type": "array"
- },
- "shippingInfo": {
- "description": "The shipping information for the order.",
- "items": {
- "$ref": "OrderTrackingSignalShippingInfo"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "OrderTrackingSignalLineItemDetails": {
- "description": "The line items of the order.",
- "id": "OrderTrackingSignalLineItemDetails",
- "properties": {
- "brand": {
- "description": "Brand of the product.",
- "type": "string"
- },
- "gtin": {
- "description": "The Global Trade Item Number.",
- "type": "string"
- },
- "lineItemId": {
- "description": "Required. The ID for this line item.",
- "type": "string"
- },
- "mpn": {
- "description": "The manufacturer part number.",
- "type": "string"
- },
- "productDescription": {
- "deprecated": true,
- "description": "Plain text description of this product (deprecated: Please use product_title instead).",
- "type": "string"
- },
- "productId": {
- "description": "Required. The Content API REST ID of the product, in the form channel:contentLanguage:targetCountry:offerId.",
- "type": "string"
- },
- "productTitle": {
- "description": "Plain text title of this product.",
- "type": "string"
- },
- "quantity": {
- "description": "The quantity of the line item in the order.",
- "format": "int64",
- "type": "string"
- },
- "sku": {
- "deprecated": true,
- "description": "Merchant SKU for this item (deprecated).",
- "type": "string"
- },
- "upc": {
- "deprecated": true,
- "description": "Universal product code for this item (deprecated: Please use GTIN instead).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderTrackingSignalShipmentLineItemMapping": {
- "description": "Represents how many items are in the shipment for the given shipment_id and line_item_id.",
- "id": "OrderTrackingSignalShipmentLineItemMapping",
- "properties": {
- "lineItemId": {
- "description": "Required. The line item ID.",
- "type": "string"
- },
- "quantity": {
- "description": "The line item quantity in the shipment.",
- "format": "int64",
- "type": "string"
- },
- "shipmentId": {
- "description": "Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "OrderTrackingSignalShippingInfo": {
- "description": "The shipping information for the order.",
- "id": "OrderTrackingSignalShippingInfo",
- "properties": {
- "actualDeliveryTime": {
- "$ref": "DateTime",
- "description": "The time when the shipment was actually delivered. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name."
- },
- "carrierName": {
- "description": "The name of the shipping carrier for the delivery. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.",
- "type": "string"
- },
- "carrierServiceName": {
- "description": "The service type for fulfillment, e.g., GROUND, FIRST_CLASS, etc.",
- "type": "string"
- },
- "earliestDeliveryPromiseTime": {
- "$ref": "DateTime",
- "description": "The earliest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name."
- },
- "latestDeliveryPromiseTime": {
- "$ref": "DateTime",
- "description": "The latest delivery promised time. Include the year and timezone string, if available. This field is required, if one of the following fields is absent: tracking_id or carrier_name."
- },
- "originPostalCode": {
- "description": "The origin postal code, as a continuous string without spaces or dashes, e.g. \"95016\". This field will be anonymized in returned OrderTrackingSignal creation response.",
- "type": "string"
- },
- "originRegionCode": {
- "description": "The [CLDR territory code] (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) for the shipping origin.",
- "type": "string"
- },
- "shipmentId": {
- "description": "Required. The shipment ID. This field will be hashed in returned OrderTrackingSignal creation response.",
- "type": "string"
- },
- "shippedTime": {
- "$ref": "DateTime",
- "description": "The time when the shipment was shipped. Include the year and timezone string, if available."
- },
- "shippingStatus": {
- "description": "The status of the shipment.",
- "enum": [
- "SHIPPING_STATE_UNSPECIFIED",
- "SHIPPED",
- "DELIVERED"
- ],
- "enumDescriptions": [
- "The shipping status is not known to merchant.",
- "All items are shipped.",
- "The shipment is already delivered."
- ],
- "type": "string"
- },
- "trackingId": {
- "description": "The tracking ID of the shipment. This field is required if one of the following fields is absent: earliest_delivery_promise_time, latest_delivery_promise_time, and actual_delivery_time.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PaymentServiceProviderLinkInfo": {
- "description": "Additional information required for PAYMENT_SERVICE_PROVIDER link type.",
- "id": "PaymentServiceProviderLinkInfo",
- "properties": {
- "externalAccountBusinessCountry": {
- "description": "The business country of the merchant account as identified by the third party service provider.",
- "type": "string"
- },
- "externalAccountId": {
- "description": "The id used by the third party service provider to identify the merchant.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PickupCarrierService": {
- "id": "PickupCarrierService",
- "properties": {
- "carrierName": {
- "description": "The name of the pickup carrier (for example, `\"UPS\"`). Required.",
- "type": "string"
- },
- "serviceName": {
- "description": "The name of the pickup service (for example, `\"Access point\"`). Required.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PickupServicesPickupService": {
- "id": "PickupServicesPickupService",
- "properties": {
- "carrierName": {
- "description": "The name of the carrier (for example, `\"UPS\"`). Always present.",
- "type": "string"
- },
- "country": {
- "description": "The CLDR country code of the carrier (for example, \"US\"). Always present.",
- "type": "string"
- },
- "serviceName": {
- "description": "The name of the pickup service (for example, `\"Access point\"`). Always present.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosCustomBatchRequest": {
- "id": "PosCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "PosCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "PosCustomBatchRequestEntry": {
- "id": "PosCustomBatchRequestEntry",
- "properties": {
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "inventory": {
- "$ref": "PosInventory",
- "description": "The inventory to submit. This should be set only if the method is `inventory`."
- },
- "merchantId": {
- "description": "The ID of the POS data provider.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" - \"`inventory`\" - \"`sale`\" ",
- "type": "string"
- },
- "sale": {
- "$ref": "PosSale",
- "description": "The sale information to submit. This should be set only if the method is `sale`."
- },
- "store": {
- "$ref": "PosStore",
- "description": "The store information to submit. This should be set only if the method is `insert`."
- },
- "storeCode": {
- "description": "The store code. This should be set only if the method is `delete` or `get`.",
- "type": "string"
- },
- "targetMerchantId": {
- "description": "The ID of the account for which to get/submit data.",
- "format": "uint64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosCustomBatchResponse": {
- "id": "PosCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "PosCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posCustomBatchResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosCustomBatchResponseEntry": {
- "id": "PosCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry to which this entry responds.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors defined if, and only if, the request failed."
- },
- "inventory": {
- "$ref": "PosInventory",
- "description": "The updated inventory information."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posCustomBatchResponseEntry`\"",
- "type": "string"
- },
- "sale": {
- "$ref": "PosSale",
- "description": "The updated sale information."
- },
- "store": {
- "$ref": "PosStore",
- "description": "The retrieved or updated store information."
- }
- },
- "type": "object"
- },
- "PosDataProviders": {
- "id": "PosDataProviders",
- "properties": {
- "country": {
- "description": "Country code.",
- "type": "string"
- },
- "posDataProviders": {
- "description": "A list of POS data providers.",
- "items": {
- "$ref": "PosDataProvidersPosDataProvider"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "PosDataProvidersPosDataProvider": {
- "id": "PosDataProvidersPosDataProvider",
- "properties": {
- "displayName": {
- "description": "The display name of Pos data Provider.",
- "type": "string"
- },
- "fullName": {
- "description": "The full name of this POS data Provider.",
- "type": "string"
- },
- "providerId": {
- "description": "The ID of the account.",
- "format": "uint64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosInventory": {
- "description": "The absolute quantity of an item available at the given store.",
- "id": "PosInventory",
- "properties": {
- "contentLanguage": {
- "description": "Required. The two-letter ISO 639-1 language code for the item.",
- "type": "string"
- },
- "gtin": {
- "description": "Global Trade Item Number.",
- "type": "string"
- },
- "itemId": {
- "description": "Required. A unique identifier for the item.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posInventory`\"",
- "type": "string"
- },
- "pickupMethod": {
- "description": "Optional. Supported pickup method for this offer. Unless the value is \"not supported\", this field must be submitted together with `pickupSla`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).",
- "type": "string"
- },
- "pickupSla": {
- "description": "Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Required. The current price of the item."
- },
- "quantity": {
- "description": "Required. The available quantity of the item.",
- "format": "int64",
- "type": "string"
- },
- "storeCode": {
- "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.",
- "type": "string"
- },
- "targetCountry": {
- "description": "Required. The CLDR territory code for the item.",
- "type": "string"
- },
- "timestamp": {
- "description": "Required. The inventory timestamp, in ISO 8601 format.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosInventoryRequest": {
- "id": "PosInventoryRequest",
- "properties": {
- "contentLanguage": {
- "description": "Required. The two-letter ISO 639-1 language code for the item.",
- "type": "string"
- },
- "gtin": {
- "description": "Global Trade Item Number.",
- "type": "string"
- },
- "itemId": {
- "description": "Required. A unique identifier for the item.",
- "type": "string"
- },
- "pickupMethod": {
- "description": "Optional. Supported pickup method for this offer. Unless the value is \"not supported\", this field must be submitted together with `pickupSla`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).",
- "type": "string"
- },
- "pickupSla": {
- "description": "Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Required. The current price of the item."
- },
- "quantity": {
- "description": "Required. The available quantity of the item.",
- "format": "int64",
- "type": "string"
- },
- "storeCode": {
- "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.",
- "type": "string"
- },
- "targetCountry": {
- "description": "Required. The CLDR territory code for the item.",
- "type": "string"
- },
- "timestamp": {
- "description": "Required. The inventory timestamp, in ISO 8601 format.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosInventoryResponse": {
- "id": "PosInventoryResponse",
- "properties": {
- "contentLanguage": {
- "description": "Required. The two-letter ISO 639-1 language code for the item.",
- "type": "string"
- },
- "gtin": {
- "description": "Global Trade Item Number.",
- "type": "string"
- },
- "itemId": {
- "description": "Required. A unique identifier for the item.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posInventoryResponse`\".",
- "type": "string"
- },
- "pickupMethod": {
- "description": "Optional. Supported pickup method for this offer. Unless the value is \"not supported\", this field must be submitted together with `pickupSla`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).",
- "type": "string"
- },
- "pickupSla": {
- "description": "Optional. Expected date that an order will be ready for pickup relative to the order date. Must be submitted together with `pickupMethod`. For accepted attribute values, see the [local product inventory feed specification](https://support.google.com/merchants/answer/3061342).",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Required. The current price of the item."
- },
- "quantity": {
- "description": "Required. The available quantity of the item.",
- "format": "int64",
- "type": "string"
- },
- "storeCode": {
- "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.",
- "type": "string"
- },
- "targetCountry": {
- "description": "Required. The CLDR territory code for the item.",
- "type": "string"
- },
- "timestamp": {
- "description": "Required. The inventory timestamp, in ISO 8601 format.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosListResponse": {
- "id": "PosListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posListResponse`\".",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "PosStore"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "PosSale": {
- "description": "The change of the available quantity of an item at the given store.",
- "id": "PosSale",
- "properties": {
- "contentLanguage": {
- "description": "Required. The two-letter ISO 639-1 language code for the item.",
- "type": "string"
- },
- "gtin": {
- "description": "Global Trade Item Number.",
- "type": "string"
- },
- "itemId": {
- "description": "Required. A unique identifier for the item.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posSale`\"",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Required. The price of the item."
- },
- "quantity": {
- "description": "Required. The relative change of the available quantity. Negative for items returned.",
- "format": "int64",
- "type": "string"
- },
- "saleId": {
- "description": "A unique ID to group items from the same sale event.",
- "type": "string"
- },
- "storeCode": {
- "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.",
- "type": "string"
- },
- "targetCountry": {
- "description": "Required. The CLDR territory code for the item.",
- "type": "string"
- },
- "timestamp": {
- "description": "Required. The inventory timestamp, in ISO 8601 format.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosSaleRequest": {
- "id": "PosSaleRequest",
- "properties": {
- "contentLanguage": {
- "description": "Required. The two-letter ISO 639-1 language code for the item.",
- "type": "string"
- },
- "gtin": {
- "description": "Global Trade Item Number.",
- "type": "string"
- },
- "itemId": {
- "description": "Required. A unique identifier for the item.",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Required. The price of the item."
- },
- "quantity": {
- "description": "Required. The relative change of the available quantity. Negative for items returned.",
- "format": "int64",
- "type": "string"
- },
- "saleId": {
- "description": "A unique ID to group items from the same sale event.",
- "type": "string"
- },
- "storeCode": {
- "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.",
- "type": "string"
- },
- "targetCountry": {
- "description": "Required. The CLDR territory code for the item.",
- "type": "string"
- },
- "timestamp": {
- "description": "Required. The inventory timestamp, in ISO 8601 format.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosSaleResponse": {
- "id": "PosSaleResponse",
- "properties": {
- "contentLanguage": {
- "description": "Required. The two-letter ISO 639-1 language code for the item.",
- "type": "string"
- },
- "gtin": {
- "description": "Global Trade Item Number.",
- "type": "string"
- },
- "itemId": {
- "description": "Required. A unique identifier for the item.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posSaleResponse`\".",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Required. The price of the item."
- },
- "quantity": {
- "description": "Required. The relative change of the available quantity. Negative for items returned.",
- "format": "int64",
- "type": "string"
- },
- "saleId": {
- "description": "A unique ID to group items from the same sale event.",
- "type": "string"
- },
- "storeCode": {
- "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted through the API or the code of the store in a Business Profile.",
- "type": "string"
- },
- "targetCountry": {
- "description": "Required. The CLDR territory code for the item.",
- "type": "string"
- },
- "timestamp": {
- "description": "Required. The inventory timestamp, in ISO 8601 format.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PosStore": {
- "description": "Store resource.",
- "id": "PosStore",
- "properties": {
- "gcidCategory": {
- "description": "The business type of the store.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#posStore`\"",
- "type": "string"
- },
- "matchingStatus": {
- "description": "Output only. The matching status of POS store and Google Business Profile store. Possible values are: - \"`matched`\": The POS store is successfully matched with the Google Business Profile store. - \"`failed`\": The POS store is not matched with the Google Business Profile store. See matching_status_hint for further details. Note that there is up to 48 hours propagation delay for changes in Merchant Center (e.g. creation of new account, accounts linking) and Google Business Profile (e.g. store address update) which may affect the matching status. In such cases, after a delay call [pos.list](https://developers.google.com/shopping-content/reference/rest/v2.1/pos/list) to retrieve the updated matching status. ",
- "readOnly": true,
- "type": "string"
- },
- "matchingStatusHint": {
- "description": "Output only. The hint of why the matching has failed. This is only set when matching_status=failed. Possible values are: - \"`linked-store-not-found`\": There aren't any Google Business Profile stores available for matching. Connect your Merchant Center account with the Google Business Profile account. Or add a new Google Business Profile store corresponding to the POS store. - \"`store-match-not-found`\": The provided POS store couldn't be matched to any of the connected Google Business Profile stores. Merchant Center account is connected correctly and stores are available on Google Business Profile, but POS store location address does not match with Google Business Profile stores' addresses. Update POS store address or Google Business Profile store address to match correctly. - \"`store-match-unverified`\": The provided POS store couldn't be matched to any of the connected Google Business Profile stores, as the matched Google Business Profile store is unverified. Go through the Google Business Profile verification process to match correctly. ",
- "readOnly": true,
- "type": "string"
- },
- "phoneNumber": {
- "description": "The store phone number.",
- "type": "string"
- },
- "placeId": {
- "description": "The Google Place Id of the store location.",
- "type": "string"
- },
- "storeAddress": {
- "description": "Required. The street address of the store.",
- "type": "string"
- },
- "storeCode": {
- "description": "Required. A store identifier that is unique for the given merchant.",
- "type": "string"
- },
- "storeName": {
- "description": "The merchant or store name.",
- "type": "string"
- },
- "websiteUrl": {
- "description": "The website url for the store or merchant.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PostalCodeGroup": {
- "id": "PostalCodeGroup",
- "properties": {
- "country": {
- "description": "The CLDR territory code of the country the postal code group applies to. Required.",
- "type": "string"
- },
- "name": {
- "description": "The name of the postal code group, referred to in headers. Required.",
- "type": "string"
- },
- "postalCodeRanges": {
- "description": "A range of postal codes. Required.",
- "items": {
- "$ref": "PostalCodeRange"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "PostalCodeRange": {
- "id": "PostalCodeRange",
- "properties": {
- "postalCodeRangeBegin": {
- "description": "A postal code or a pattern of the form `prefix*` denoting the inclusive lower bound of the range defining the area. Examples values: `\"94108\"`, `\"9410*\"`, `\"9*\"`. Required.",
- "type": "string"
- },
- "postalCodeRangeEnd": {
- "description": "A postal code or a pattern of the form `prefix*` denoting the inclusive upper bound of the range defining the area. It must have the same length as `postalCodeRangeBegin`: if `postalCodeRangeBegin` is a postal code then `postalCodeRangeEnd` must be a postal code too; if `postalCodeRangeBegin` is a pattern then `postalCodeRangeEnd` must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching `postalCodeRangeBegin`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Price": {
- "id": "Price",
- "properties": {
- "currency": {
- "description": "The currency of the price.",
- "type": "string"
- },
- "value": {
- "description": "The price represented as a number.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PriceAmount": {
- "description": "The price represented as a number and currency.",
- "id": "PriceAmount",
- "properties": {
- "currency": {
- "description": "The currency of the price.",
- "type": "string"
- },
- "value": {
- "description": "The price represented as a number.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PriceCompetitiveness": {
- "description": "Price competitiveness fields requested by the merchant in the query. Field values are only set if the merchant queries `PriceCompetitivenessProductView`. https://support.google.com/merchants/answer/9626903",
- "id": "PriceCompetitiveness",
- "properties": {
- "benchmarkPriceCurrencyCode": {
- "description": "The price benchmark currency (ISO 4217 code).",
- "type": "string"
- },
- "benchmarkPriceMicros": {
- "description": "The latest available price benchmark in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) for the product's catalog in the benchmark country.",
- "format": "int64",
- "type": "string"
- },
- "countryCode": {
- "description": "The country of the price benchmark (ISO 3166 code).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PriceInsights": {
- "description": "Price insights fields requested by the merchant in the query. Field values are only set if the merchant queries `PriceInsightsProductView`. https://support.google.com/merchants/answer/11916926",
- "id": "PriceInsights",
- "properties": {
- "effectiveness": {
- "description": "The predicted effectiveness of applying the price suggestion, bucketed.",
- "enum": [
- "EFFECTIVENESS_UNSPECIFIED",
- "LOW",
- "MEDIUM",
- "HIGH"
- ],
- "enumDescriptions": [
- "Effectiveness is unknown.",
- "Effectiveness is low.",
- "Effectiveness is medium.",
- "Effectiveness is high."
- ],
- "type": "string"
- },
- "predictedClicksChangeFraction": {
- "description": "The 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.",
- "format": "double",
- "type": "number"
- },
- "predictedConversionsChangeFraction": {
- "description": "The 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",
- "type": "number"
- },
- "predictedGrossProfitChangeFraction": {
- "description": "*Deprecated*: This field is no longer supported and will start returning 0. The predicted change in gross profit as a fraction after introducing the suggested price compared to current active price. For example, 0.05 is a 5% predicted increase in gross profit.",
- "format": "double",
- "type": "number"
- },
- "predictedImpressionsChangeFraction": {
- "description": "The 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.",
- "format": "double",
- "type": "number"
- },
- "predictedMonthlyGrossProfitChangeCurrencyCode": {
- "description": "*Deprecated*: This field is no longer supported and will start returning USD for all requests. The predicted monthly gross profit change currency (ISO 4217 code).",
- "type": "string"
- },
- "predictedMonthlyGrossProfitChangeMicros": {
- "description": "*Deprecated*: This field is no longer supported and will start returning 0. The predicted change in gross profit in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) after introducing the suggested price for a month compared to current active price.",
- "format": "int64",
- "type": "string"
- },
- "suggestedPriceCurrencyCode": {
- "description": "The suggested price currency (ISO 4217 code).",
- "type": "string"
- },
- "suggestedPriceMicros": {
- "description": "The latest suggested price in micros (1 millionth of a standard unit, 1 USD = 1000000 micros) for the product.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Product": {
- "description": " Required product attributes are primarily defined by the product data specification. See the Product Data Specification Help Center article for information. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect. The following reference documentation lists the field names in the **camelCase** casing style while the Products Data Specification lists the names in the **snake_case** casing style.",
- "id": "Product",
- "properties": {
- "additionalImageLinks": {
- "description": "Additional URLs of images of the item.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "additionalSizeType": {
- "description": "Additional cut of the item. Used together with size_type to represent combined size types for apparel items.",
- "type": "string"
- },
- "adsGrouping": {
- "description": "Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.",
- "type": "string"
- },
- "adsLabels": {
- "description": "Similar to ads_grouping, but only works on CPC.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "adsRedirect": {
- "description": "Allows advertisers to override the item URL when the product is shown within the context of Product Ads.",
- "type": "string"
- },
- "adult": {
- "description": "Should be set to true if the item is targeted towards adults.",
- "type": "boolean"
- },
- "ageGroup": {
- "description": "Target age group of the item.",
- "type": "string"
- },
- "autoPricingMinPrice": {
- "$ref": "Price",
- "description": "A safeguard in the [Automated Discounts](//support.google.com/merchants/answer/10295759) and [Dynamic Promotions](//support.google.com/merchants/answer/13949249) projects, ensuring that discounts on merchants' offers do not fall below this value, thereby preserving the offer's value and profitability."
- },
- "availability": {
- "description": "Availability status of the item.",
- "type": "string"
- },
- "availabilityDate": {
- "description": "The day a pre-ordered product becomes available for delivery, in ISO 8601 format.",
- "type": "string"
- },
- "brand": {
- "description": "Brand of the item.",
- "type": "string"
- },
- "canonicalLink": {
- "description": "URL for the canonical version of your item's landing page.",
- "type": "string"
- },
- "certifications": {
- "description": "Product [certification](https://support.google.com/merchants/answer/13528839), introduced for EU energy efficiency labeling compliance using the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database.",
- "items": {
- "$ref": "ProductCertification"
- },
- "type": "array"
- },
- "channel": {
- "description": "Required. The item's channel (online or local). Acceptable values are: - \"`local`\" - \"`online`\" ",
- "type": "string"
- },
- "cloudExportAdditionalProperties": {
- "description": "Extra fields to export to the Cloud Retail program.",
- "items": {
- "$ref": "CloudExportAdditionalProperties"
- },
- "type": "array"
- },
- "color": {
- "description": "Color of the item.",
- "type": "string"
- },
- "condition": {
- "description": "Condition or state of the item.",
- "type": "string"
- },
- "contentLanguage": {
- "description": "Required. The two-letter ISO 639-1 language code for the item.",
- "type": "string"
- },
- "costOfGoodsSold": {
- "$ref": "Price",
- "description": "Cost of goods sold. Used for gross profit reporting."
- },
- "customAttributes": {
- "description": "A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example, `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google (formerly known as Shopping Actions).",
- "items": {
- "$ref": "CustomAttribute"
- },
- "type": "array"
- },
- "customLabel0": {
- "description": "Custom label 0 for custom grouping of items in a Shopping campaign.",
- "type": "string"
- },
- "customLabel1": {
- "description": "Custom label 1 for custom grouping of items in a Shopping campaign.",
- "type": "string"
- },
- "customLabel2": {
- "description": "Custom label 2 for custom grouping of items in a Shopping campaign.",
- "type": "string"
- },
- "customLabel3": {
- "description": "Custom label 3 for custom grouping of items in a Shopping campaign.",
- "type": "string"
- },
- "customLabel4": {
- "description": "Custom label 4 for custom grouping of items in a Shopping campaign.",
- "type": "string"
- },
- "description": {
- "description": "Description of the item.",
- "type": "string"
- },
- "disclosureDate": {
- "description": "The date time when an offer becomes visible in search results across Google’s YouTube surfaces, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. See [Disclosure date](https://support.google.com/merchants/answer/13034208) for more information.",
- "type": "string"
- },
- "displayAdsId": {
- "description": "An identifier for an item for dynamic remarketing campaigns.",
- "type": "string"
- },
- "displayAdsLink": {
- "description": "URL directly to your item's landing page for dynamic remarketing campaigns.",
- "type": "string"
- },
- "displayAdsSimilarIds": {
- "description": "Advertiser-specified recommendations.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "displayAdsTitle": {
- "description": "Title of an item for dynamic remarketing campaigns.",
- "type": "string"
- },
- "displayAdsValue": {
- "description": "Offer margin for dynamic remarketing campaigns.",
- "format": "double",
- "type": "number"
- },
- "energyEfficiencyClass": {
- "description": "The energy efficiency class as defined in EU directive 2010/30/EU.",
- "type": "string"
- },
- "excludedDestinations": {
- "description": "The list of [destinations to exclude](//support.google.com/merchants/answer/6324486) for this target (corresponds to cleared check boxes in Merchant Center). Products that are excluded from all destinations for more than 7 days are automatically deleted.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "expirationDate": {
- "description": "Date on which the item should expire, as specified upon insertion, in ISO 8601 format. The actual expiration date in Google Shopping is exposed in `productstatuses` as `googleExpirationDate` and might be earlier if `expirationDate` is too far in the future.",
- "type": "string"
- },
- "externalSellerId": {
- "description": "Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.",
- "type": "string"
- },
- "feedLabel": {
- "description": "Feed label for the item. Either `targetCountry` or `feedLabel` is required. Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and dashes (-).",
- "type": "string"
- },
- "freeShippingThreshold": {
- "description": "Optional. Conditions to be met for a product to have free shipping.",
- "items": {
- "$ref": "FreeShippingThreshold"
- },
- "type": "array"
- },
- "gender": {
- "description": "Target gender of the item.",
- "type": "string"
- },
- "googleProductCategory": {
- "description": "Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.",
- "type": "string"
- },
- "gtin": {
- "description": "Global Trade Item Number (GTIN) of the item.",
- "type": "string"
- },
- "id": {
- "description": "The REST ID of the product. Content API methods that operate on products take this as their `productId` parameter. The REST ID for a product has one of the 2 forms channel:contentLanguage: targetCountry: offerId or channel:contentLanguage:feedLabel: offerId.",
- "type": "string"
- },
- "identifierExists": {
- "description": "False when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Required according to the Unique Product Identifier Rules for all target countries except for Canada.",
- "type": "boolean"
- },
- "imageLink": {
- "description": "URL of an image of the item.",
- "type": "string"
- },
- "includedDestinations": {
- "description": "The list of [destinations to include](//support.google.com/merchants/answer/7501026) for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "installment": {
- "$ref": "Installment",
- "description": "Number and amount of installments to pay for an item."
- },
- "isBundle": {
- "description": "Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.",
- "type": "boolean"
- },
- "itemGroupId": {
- "description": "Shared identifier for all variants of the same product.",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#product`\"",
- "type": "string"
- },
- "lifestyleImageLinks": {
- "description": "Additional URLs of lifestyle images of the item. Used to explicitly identify images that showcase your item in a real-world context. See the Help Center article for more information.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "link": {
- "description": "URL directly linking to your item's page on your website.",
- "type": "string"
- },
- "linkTemplate": {
- "description": "URL template for merchant hosted local storefront.",
- "type": "string"
- },
- "loyaltyProgram": {
- "$ref": "LoyaltyProgram",
- "description": "Loyalty program information that is used to surface loyalty benefits ( for example, better pricing, points, etc) to the user of this item. This signular field points to the latest uploaded loyalty program info. This field will be deprecated in the coming weeks and should not be used in favor of the plural 'LoyaltyProgram' field below."
- },
- "loyaltyPrograms": {
- "description": "Optional. A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.",
- "items": {
- "$ref": "LoyaltyProgram"
- },
- "type": "array"
- },
- "material": {
- "description": "The material of which the item is made.",
- "type": "string"
- },
- "maxEnergyEfficiencyClass": {
- "description": "The energy efficiency class as defined in EU directive 2010/30/EU.",
- "type": "string"
- },
- "maxHandlingTime": {
- "description": "Maximal product handling time (in business days).",
- "format": "int64",
- "type": "string"
- },
- "maximumRetailPrice": {
- "$ref": "Price",
- "description": "Maximum retail price (MRP) of the item. Applicable to India only."
- },
- "minEnergyEfficiencyClass": {
- "description": "The energy efficiency class as defined in EU directive 2010/30/EU.",
- "type": "string"
- },
- "minHandlingTime": {
- "description": "Minimal product handling time (in business days).",
- "format": "int64",
- "type": "string"
- },
- "mobileLink": {
- "description": "URL for the mobile-optimized version of your item's landing page.",
- "type": "string"
- },
- "mobileLinkTemplate": {
- "description": "URL template for merchant hosted local storefront optimized for mobile devices.",
- "type": "string"
- },
- "mpn": {
- "description": "Manufacturer Part Number (MPN) of the item.",
- "type": "string"
- },
- "multipack": {
- "description": "The number of identical products in a merchant-defined multipack.",
- "format": "int64",
- "type": "string"
- },
- "offerId": {
- "description": "Required. A unique identifier for the item. Leading and trailing whitespaces are stripped and multiple whitespaces are replaced by a single whitespace upon submission. Only valid unicode characters are accepted. See the products feed specification for details. *Note:* Content API methods that operate on products take the REST ID of the product, *not* this identifier.",
- "type": "string"
- },
- "pattern": {
- "description": "The item's pattern (for example, polka dots).",
- "type": "string"
- },
- "pause": {
- "description": "Publication of this item should be temporarily paused. Acceptable values are: - \"`ads`\" ",
- "type": "string"
- },
- "pickupMethod": {
- "description": "The pick up option for the item. Acceptable values are: - \"`buy`\" - \"`reserve`\" - \"`ship to store`\" - \"`not supported`\" ",
- "type": "string"
- },
- "pickupSla": {
- "description": "Item store pickup timeline. Acceptable values are: - \"`same day`\" - \"`next day`\" - \"`2-day`\" - \"`3-day`\" - \"`4-day`\" - \"`5-day`\" - \"`6-day`\" - \"`7-day`\" - \"`multi-week`\" ",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Price of the item."
- },
- "productDetails": {
- "description": "Technical specification or additional product details.",
- "items": {
- "$ref": "ProductProductDetail"
- },
- "type": "array"
- },
- "productHeight": {
- "$ref": "ProductDimension",
- "description": "The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)."
- },
- "productHighlights": {
- "description": "Bullet points describing the most relevant highlights of a product.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "productLength": {
- "$ref": "ProductDimension",
- "description": "The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)."
- },
- "productTypes": {
- "description": "Categories of the item (formatted as in product data specification).",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "productWeight": {
- "$ref": "ProductWeight",
- "description": "The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive)."
- },
- "productWidth": {
- "$ref": "ProductDimension",
- "description": "The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)."
- },
- "promotionIds": {
- "description": "The unique ID of a promotion.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "salePrice": {
- "$ref": "Price",
- "description": "Advertised sale price of the item."
- },
- "salePriceEffectiveDate": {
- "description": "Date range during which the item is on sale (see product data specification ).",
- "type": "string"
- },
- "sellOnGoogleQuantity": {
- "description": "The quantity of the product that is available for selling on Google. Supported only for online products.",
- "format": "int64",
- "type": "string"
- },
- "shipping": {
- "description": "Shipping rules.",
- "items": {
- "$ref": "ProductShipping"
- },
- "type": "array"
- },
- "shippingHeight": {
- "$ref": "ProductShippingDimension",
- "description": "Height of the item for shipping."
- },
- "shippingLabel": {
- "description": "The shipping label of the product, used to group product in account-level shipping rules.",
- "type": "string"
- },
- "shippingLength": {
- "$ref": "ProductShippingDimension",
- "description": "Length of the item for shipping."
- },
- "shippingWeight": {
- "$ref": "ProductShippingWeight",
- "description": "Weight of the item for shipping."
- },
- "shippingWidth": {
- "$ref": "ProductShippingDimension",
- "description": "Width of the item for shipping."
- },
- "shoppingAdsExcludedCountries": {
- "description": "List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in MC feed settings.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "sizeSystem": {
- "description": "System in which the size is specified. Recommended for apparel items.",
- "type": "string"
- },
- "sizeType": {
- "description": "The cut of the item. Recommended for apparel items.",
- "type": "string"
- },
- "sizes": {
- "description": "Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition).",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "source": {
- "description": "Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - \"`api`\" - \"`crawl`\" - \"`feed`\" ",
- "type": "string"
- },
- "structuredDescription": {
- "$ref": "ProductStructuredDescription",
- "description": "Structured description, for algorithmically (AI)-generated descriptions."
- },
- "structuredTitle": {
- "$ref": "ProductStructuredTitle",
- "description": "Structured title, for algorithmically (AI)-generated titles."
- },
- "subscriptionCost": {
- "$ref": "ProductSubscriptionCost",
- "description": "Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract."
- },
- "sustainabilityIncentives": {
- "description": "Optional. The list of sustainability incentive programs.",
- "items": {
- "$ref": "ProductSustainabilityIncentive"
- },
- "type": "array"
- },
- "targetCountry": {
- "description": "Required. The CLDR territory code for the item's country of sale.",
- "type": "string"
- },
- "taxCategory": {
- "description": "The tax category of the product, used to configure detailed tax nexus in account-level tax settings.",
- "type": "string"
- },
- "taxes": {
- "description": "Tax information.",
- "items": {
- "$ref": "ProductTax"
- },
- "type": "array"
- },
- "title": {
- "description": "Title of the item.",
- "type": "string"
- },
- "transitTimeLabel": {
- "description": "The transit time label of the product, used to group product in account-level transit time tables.",
- "type": "string"
- },
- "unitPricingBaseMeasure": {
- "$ref": "ProductUnitPricingBaseMeasure",
- "description": "The preference of the denominator of the unit price."
- },
- "unitPricingMeasure": {
- "$ref": "ProductUnitPricingMeasure",
- "description": "The measure and dimension of an item."
- },
- "virtualModelLink": {
- "description": "URL of the 3D model of the item to provide more visuals.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductCertification": {
- "description": "Product [certification](https://support.google.com/merchants/answer/13528839), introduced for EU energy efficiency labeling compliance using the [EU EPREL](https://eprel.ec.europa.eu/screen/home) database.",
- "id": "ProductCertification",
- "properties": {
- "certificationAuthority": {
- "description": "The certification authority, for example \"European_Commission\". Maximum length is 2000 characters.",
- "type": "string"
- },
- "certificationCode": {
- "description": "The certification code, for eaxample \"123456\". Maximum length is 2000 characters.",
- "type": "string"
- },
- "certificationName": {
- "description": "The name of the certification, for example \"EPREL\". Maximum length is 2000 characters.",
- "type": "string"
- },
- "certificationValue": {
- "description": "The certification value (also known as class, level or grade), for example \"A+\", \"C\", \"gold\". Maximum length is 2000 characters.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductCluster": {
- "description": "Product cluster fields. A product cluster is a grouping for different offers that represent the same product. Values are only set for fields requested explicitly in the request's search query.",
- "id": "ProductCluster",
- "properties": {
- "brand": {
- "description": "Brand of the product cluster.",
- "type": "string"
- },
- "brandInventoryStatus": {
- "description": "Tells if there is at least one product of the brand currently `IN_STOCK` in your product feed across multiple countries, all products are `OUT_OF_STOCK` in your product feed, or `NOT_IN_INVENTORY`. The field doesn't take the Best Sellers report country filter into account.",
- "enum": [
- "INVENTORY_STATUS_UNSPECIFIED",
- "IN_STOCK",
- "OUT_OF_STOCK",
- "NOT_IN_INVENTORY"
- ],
- "enumDescriptions": [
- "Inventory status is unknown.",
- "Merchant has a product for this product cluster or brand in stock.",
- "Merchant has a product for this product cluster or brand in inventory but it is currently out of stock.",
- "Merchant does not have a product for this product cluster or brand in inventory."
- ],
- "type": "string"
- },
- "categoryL1": {
- "description": "Product category (1st level) of the product cluster, represented in Google's product taxonomy.",
- "type": "string"
- },
- "categoryL2": {
- "description": "Product category (2nd level) of the product cluster, represented in Google's product taxonomy.",
- "type": "string"
- },
- "categoryL3": {
- "description": "Product category (3rd level) of the product cluster, represented in Google's product taxonomy.",
- "type": "string"
- },
- "categoryL4": {
- "description": "Product category (4th level) of the product cluster, represented in Google's product taxonomy.",
- "type": "string"
- },
- "categoryL5": {
- "description": "Product category (5th level) of the product cluster, represented in Google's product taxonomy.",
- "type": "string"
- },
- "inventoryStatus": {
- "description": "Tells whether the product cluster is `IN_STOCK` in your product feed across multiple countries, `OUT_OF_STOCK` in your product feed, or `NOT_IN_INVENTORY` at all. The field doesn't take the Best Sellers report country filter into account.",
- "enum": [
- "INVENTORY_STATUS_UNSPECIFIED",
- "IN_STOCK",
- "OUT_OF_STOCK",
- "NOT_IN_INVENTORY"
- ],
- "enumDescriptions": [
- "Inventory status is unknown.",
- "Merchant has a product for this product cluster or brand in stock.",
- "Merchant has a product for this product cluster or brand in inventory but it is currently out of stock.",
- "Merchant does not have a product for this product cluster or brand in inventory."
- ],
- "type": "string"
- },
- "title": {
- "description": "Title of the product cluster.",
- "type": "string"
- },
- "variantGtins": {
- "description": "GTINs of example variants of the product cluster.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ProductDeliveryTime": {
- "description": "The estimated days to deliver a product after an order is placed. Only authorized shipping signals partners working with a merchant can use this resource. Merchants should use the [`products`](https://developers.google.com/shopping-content/reference/rest/v2.1/products#productshipping) resource instead.",
- "id": "ProductDeliveryTime",
- "properties": {
- "areaDeliveryTimes": {
- "description": "Required. A set of associations between `DeliveryArea` and `DeliveryTime` entries. The total number of `areaDeliveryTimes` can be at most 100.",
- "items": {
- "$ref": "ProductDeliveryTimeAreaDeliveryTime"
- },
- "type": "array"
- },
- "productId": {
- "$ref": "ProductId",
- "description": "Required. The `id` of the product."
- }
- },
- "type": "object"
- },
- "ProductDeliveryTimeAreaDeliveryTime": {
- "description": "A pairing of `DeliveryArea` associated with a `DeliveryTime` for this product.",
- "id": "ProductDeliveryTimeAreaDeliveryTime",
- "properties": {
- "deliveryArea": {
- "$ref": "DeliveryArea",
- "description": "Required. The delivery area associated with `deliveryTime` for this product."
- },
- "deliveryTime": {
- "$ref": "ProductDeliveryTimeAreaDeliveryTimeDeliveryTime",
- "description": "Required. The delivery time associated with `deliveryArea` for this product."
- }
- },
- "type": "object"
- },
- "ProductDeliveryTimeAreaDeliveryTimeDeliveryTime": {
- "description": "A delivery time for this product.",
- "id": "ProductDeliveryTimeAreaDeliveryTimeDeliveryTime",
- "properties": {
- "maxHandlingTimeDays": {
- "description": "Required. The maximum number of business days (inclusive) between when an order is placed and when the product ships. If a product ships in the same day, set this value to 0.",
- "format": "int32",
- "type": "integer"
- },
- "maxTransitTimeDays": {
- "description": "Required. The maximum number of business days (inclusive) between when the product ships and when the product is delivered.",
- "format": "int32",
- "type": "integer"
- },
- "minHandlingTimeDays": {
- "description": "Required. The minimum number of business days (inclusive) between when an order is placed and when the product ships. If a product ships in the same day, set this value to 0.",
- "format": "int32",
- "type": "integer"
- },
- "minTransitTimeDays": {
- "description": "Required. The minimum number of business days (inclusive) between when the product ships and when the product is delivered.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "ProductDimension": {
- "id": "ProductDimension",
- "properties": {
- "unit": {
- "description": "Required. The length units. Acceptable values are: - \"`in`\" - \"`cm`\" ",
- "type": "string"
- },
- "value": {
- "description": "Required. The length value represented as a number. The value can have a maximum precision of four decimal places.",
- "format": "double",
- "type": "number"
- }
- },
- "type": "object"
- },
- "ProductId": {
- "description": "The Content API ID of the product.",
- "id": "ProductId",
- "properties": {
- "productId": {
- "description": "The Content API ID of the product, in the form `channel:contentLanguage:targetCountry:offerId`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductIssue": {
- "description": "An issue affecting specific product.",
- "id": "ProductIssue",
- "properties": {
- "actions": {
- "description": "A list of actionable steps that can be executed to solve the issue. An example is requesting a re-review or providing arguments when merchant disagrees with the issue. Actions that are supported in (your) third-party application can be rendered as buttons and should be available to merchant when they expand the issue.",
- "items": {
- "$ref": "Action"
- },
- "type": "array"
- },
- "impact": {
- "$ref": "ProductIssueImpact",
- "description": "Clarifies the severity of the issue. The summarizing message, if present, should be shown right under the title for each issue. It helps merchants to quickly understand the impact of the issue. The detailed breakdown helps the merchant to fully understand the impact of the issue. It can be rendered as dialog that opens when the merchant mouse over the summarized impact statement. Issues with different severity can be styled differently. They may use a different color or icon to signal the difference between `ERROR`, `WARNING` and `INFO`."
- },
- "prerenderedContent": {
- "description": "Details of the issue as a pre-rendered HTML. HTML elements contain CSS classes that can be used to customize the style of the content. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `issue-detail` - top level container for the detail of the issue * `callout-banners` - section of the `issue-detail` with callout banners * `callout-banner` - single callout banner, inside `callout-banners` * `callout-banner-info` - callout with important information (default) * `callout-banner-warning` - callout with a warning * `callout-banner-error` - callout informing about an error (most severe) * `issue-content` - section of the `issue-detail`, contains multiple `content-element` * `content-element` - content element such as a list, link or paragraph, inside `issue-content` * `root-causes` - unordered list with items describing root causes of the issue, inside `issue-content` * `root-causes-intro` - intro text before the `root-causes` list, inside `issue-content` * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon. * `content-moderation` - marks the paragraph that explains how the issue was identified. * `list-intro` - marks the paragraph that contains an intro for a list. This paragraph will be always followed by a list. * `new-element` - Present for new elements added to the pre-rendered content in the future. To make sure that a new content element does not break your style, you can hide everything with this class.",
- "type": "string"
- },
- "prerenderedOutOfCourtDisputeSettlement": {
- "description": "Pre-rendered HTML that contains a link to the external location where the ODS can be requested and instructions for how to request it. HTML elements contain CSS classes that can be used to customize the style of this snippet. Always sanitize the HTML before embedding it directly to your application. The sanitizer needs to allow basic HTML tags, such as: `div`, `span`, `p`, `a`, `ul`, `li`, `table`, `tr`, `td`. For example, you can use [DOMPurify](https://www.npmjs.com/package/dompurify). CSS classes: * `ods-section`* - wrapper around the out-of-court dispute resolution section * `ods-description`* - intro text for the out-of-court dispute resolution. It may contain multiple segments and a link. * `ods-param`* - wrapper around the header-value pair for parameters that merchant may need to provide during the ODS process. * `ods-routing-id`* - ods param for the Routing ID. * `ods-reference-id`* - ods param for the Routing ID. * `ods-param-header`* - header for the ODS parameter * `ods-param-value`* - value of the ODS parameter. This value should be rendered in a way that it is easy for merchants to identify and copy. * `segment` - section of the text, `span` inside paragraph * `segment-attribute` - section of the text that represents a product attribute, for example 'image\\_link' * `segment-literal` - section of the text that contains a special value, for example '0-1000 kg' * `segment-bold` - section of the text that should be rendered as bold * `segment-italic` - section of the text that should be rendered as italic * `tooltip` - used on paragraphs that should be rendered with a tooltip. A section of the text in such a paragraph will have a class `tooltip-text` and is intended to be shown in a mouse over dialog. If the style is not used, the `tooltip-text` section would be shown on a new line, after the main part of the text. * `tooltip-text` - marks a section of the text within a `tooltip`, that is intended to be shown in a mouse over dialog. * `tooltip-icon` - marks a section of the text within a `tooltip`, that can be replaced with a tooltip icon, for example '?' or 'i'. By default, this section contains a `br` tag, that is separating the main text and the tooltip text when the style is not used. * `tooltip-style-question` - the tooltip shows helpful information, can use the '?' as an icon. * `tooltip-style-info` - the tooltip adds additional information fitting to the context, can use the 'i' as an icon.",
- "type": "string"
- },
- "title": {
- "description": "Title of the issue.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductIssueImpact": {
- "description": "Overall impact of product issue.",
- "id": "ProductIssueImpact",
- "properties": {
- "breakdowns": {
- "description": "Detailed impact breakdown. Explains the types of restriction the issue has in different shopping destinations and territory. If present, it should be rendered to the merchant. Can be shown as a mouse over dropdown or a dialog. Each breakdown item represents a group of regions with the same impact details.",
- "items": {
- "$ref": "Breakdown"
- },
- "type": "array"
- },
- "message": {
- "description": "Optional. Message summarizing the overall impact of the issue. If present, it should be rendered to the merchant. For example: \"Limits visibility in France\"",
- "type": "string"
- },
- "severity": {
- "description": "The severity of the issue.",
- "enum": [
- "SEVERITY_UNSPECIFIED",
- "ERROR",
- "WARNING",
- "INFO"
- ],
- "enumDescriptions": [
- "Default value. Will never be provided by the API.",
- "Causes either an account suspension or an item disapproval. Errors should be resolved as soon as possible to ensure items are eligible to appear in results again.",
- "Warnings can negatively impact the performance of ads and can lead to item or account suspensions in the future unless the issue is resolved.",
- "Infos are suggested optimizations to increase data quality. Resolving these issues is recommended, but not required."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductProductDetail": {
- "id": "ProductProductDetail",
- "properties": {
- "attributeName": {
- "description": "The name of the product detail.",
- "type": "string"
- },
- "attributeValue": {
- "description": "The value of the product detail.",
- "type": "string"
- },
- "sectionName": {
- "description": "The section header used to group a set of product details.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductShipping": {
- "id": "ProductShipping",
- "properties": {
- "country": {
- "description": "The CLDR territory code of the country to which an item will ship.",
- "type": "string"
- },
- "locationGroupName": {
- "description": "The location where the shipping is applicable, represented by a location group name.",
- "type": "string"
- },
- "locationId": {
- "description": "The numeric ID of a location that the shipping rate applies to as defined in the Google Ads API.",
- "format": "int64",
- "type": "string"
- },
- "maxHandlingTime": {
- "description": "Maximum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it's received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds.",
- "format": "int64",
- "type": "string"
- },
- "maxTransitTime": {
- "description": "Maximum transit time (inclusive) between when the order has shipped and when it's delivered in business days. 0 means that the order is delivered on the same day as it ships. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds.",
- "format": "int64",
- "type": "string"
- },
- "minHandlingTime": {
- "description": "Minimum handling time (inclusive) between when the order is received and shipped in business days. 0 means that the order is shipped on the same day as it's received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it's not required if maxHandlingTime is present.",
- "format": "int64",
- "type": "string"
- },
- "minTransitTime": {
- "description": "Minimum transit time (inclusive) between when the order has shipped and when it's delivered in business days. 0 means that the order is delivered on the same day as it ships. minTransitTime can only be present together with maxTransitTime; but it's not required if maxTransitTime is present.",
- "format": "int64",
- "type": "string"
- },
- "postalCode": {
- "description": "The postal code range that the shipping rate applies to, represented by a postal code, a postal code prefix followed by a * wildcard, a range between two postal codes or two postal code prefixes of equal length.",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "Fixed shipping price, represented as a number."
- },
- "region": {
- "description": "The geographic region to which a shipping rate applies.",
- "type": "string"
- },
- "service": {
- "description": "A free-form description of the service class or delivery speed.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductShippingDimension": {
- "id": "ProductShippingDimension",
- "properties": {
- "unit": {
- "description": "The unit of value.",
- "type": "string"
- },
- "value": {
- "description": "The dimension of the product used to calculate the shipping cost of the item.",
- "format": "double",
- "type": "number"
- }
- },
- "type": "object"
- },
- "ProductShippingWeight": {
- "id": "ProductShippingWeight",
- "properties": {
- "unit": {
- "description": "The unit of value.",
- "type": "string"
- },
- "value": {
- "description": "The weight of the product used to calculate the shipping cost of the item.",
- "format": "double",
- "type": "number"
- }
- },
- "type": "object"
- },
- "ProductStatus": {
- "description": "The status of a product, that is, information about a product computed asynchronously.",
- "id": "ProductStatus",
- "properties": {
- "creationDate": {
- "description": "Date on which the item has been created, in ISO 8601 format.",
- "type": "string"
- },
- "destinationStatuses": {
- "description": "The intended destinations for the product.",
- "items": {
- "$ref": "ProductStatusDestinationStatus"
- },
- "type": "array"
- },
- "googleExpirationDate": {
- "description": "Date on which the item expires in Google Shopping, in ISO 8601 format.",
- "type": "string"
- },
- "itemLevelIssues": {
- "description": "A list of all issues associated with the product.",
- "items": {
- "$ref": "ProductStatusItemLevelIssue"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productStatus`\"",
- "type": "string"
- },
- "lastUpdateDate": {
- "description": "Date on which the item has been last updated, in ISO 8601 format.",
- "type": "string"
- },
- "link": {
- "description": "The link to the product.",
- "type": "string"
- },
- "productId": {
- "description": "The ID of the product for which status is reported.",
- "type": "string"
- },
- "title": {
- "description": "The title of the product.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductStatusDestinationStatus": {
- "id": "ProductStatusDestinationStatus",
- "properties": {
- "approvedCountries": {
- "description": "List of country codes (ISO 3166-1 alpha-2) where the offer is approved.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "channel": {
- "description": "The channel of the destination.",
- "type": "string"
- },
- "destination": {
- "description": "The name of the destination",
- "type": "string"
- },
- "disapprovedCountries": {
- "description": "List of country codes (ISO 3166-1 alpha-2) where the offer is disapproved.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "pendingCountries": {
- "description": "List of country codes (ISO 3166-1 alpha-2) where the offer is pending approval.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "status": {
- "deprecated": true,
- "description": "Deprecated. Destination approval status in `targetCountry` of the offer.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductStatusItemLevelIssue": {
- "id": "ProductStatusItemLevelIssue",
- "properties": {
- "applicableCountries": {
- "description": "List of country codes (ISO 3166-1 alpha-2) where issue applies to the offer.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "attributeName": {
- "description": "The attribute's name, if the issue is caused by a single attribute.",
- "type": "string"
- },
- "code": {
- "description": "The error code of the issue.",
- "type": "string"
- },
- "description": {
- "description": "A short issue description in English.",
- "type": "string"
- },
- "destination": {
- "description": "The destination the issue applies to.",
- "type": "string"
- },
- "detail": {
- "description": "A detailed issue description in English.",
- "type": "string"
- },
- "documentation": {
- "description": "The URL of a web page to help with resolving this issue.",
- "type": "string"
- },
- "resolution": {
- "description": "Whether the issue can be resolved by the merchant.",
- "type": "string"
- },
- "servability": {
- "description": "How this issue affects serving of the offer.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductStructuredDescription": {
- "description": "Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information.",
- "id": "ProductStructuredDescription",
- "properties": {
- "content": {
- "description": "Required. The description text. Maximum length is 5000 characters.",
- "type": "string"
- },
- "digitalSourceType": {
- "description": "Optional. The digital source type. Acceptable values are: - \"`trained_algorithmic_media`\" - \"`default`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductStructuredTitle": {
- "description": "Structured title, for algorithmically (AI)-generated titles. See [title](https://support.google.com/merchants/answer/6324415#Whentouse) for more information.",
- "id": "ProductStructuredTitle",
- "properties": {
- "content": {
- "description": "Required. The title text. Maximum length is 150 characters.",
- "type": "string"
- },
- "digitalSourceType": {
- "description": "Optional. The digital source type. Acceptable values are: - \"`trained_algorithmic_media`\" - \"`default`\" ",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductSubscriptionCost": {
- "id": "ProductSubscriptionCost",
- "properties": {
- "amount": {
- "$ref": "Price",
- "description": "The amount the buyer has to pay per subscription period."
- },
- "period": {
- "description": "The type of subscription period. - \"`month`\" - \"`year`\" ",
- "type": "string"
- },
- "periodLength": {
- "description": "The number of subscription periods the buyer has to pay.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductSustainabilityIncentive": {
- "description": "Information regarding sustainability related incentive programs such as rebates or tax relief.",
- "id": "ProductSustainabilityIncentive",
- "properties": {
- "amount": {
- "$ref": "Price",
- "description": "Optional. The fixed amount of the incentive."
- },
- "percentage": {
- "description": "Optional. The percentage of the sale price that the incentive is applied to.",
- "format": "double",
- "type": "number"
- },
- "type": {
- "description": "Required. Sustainability incentive program.",
- "enum": [
- "TYPE_UNSPECIFIED",
- "EV_TAX_CREDIT",
- "EV_PRICE_DISCOUNT"
- ],
- "enumDescriptions": [
- "Unspecified or unknown sustainability incentive type.",
- "Program offering tax liability reductions for electric vehicles and, in some countries, plug-in hybrids. These reductions can be based on a specific amount or a percentage of the sale price.",
- "A subsidy program, often called an environmental bonus, provides a purchase grant for electric vehicles and, in some countries, plug-in hybrids. The grant amount may be a fixed sum or a percentage of the sale price."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductTax": {
- "id": "ProductTax",
- "properties": {
- "country": {
- "description": "The country within which the item is taxed, specified as a CLDR territory code.",
- "type": "string"
- },
- "locationId": {
- "description": "The numeric ID of a location that the tax rate applies to as defined in the Google Ads API.",
- "format": "int64",
- "type": "string"
- },
- "postalCode": {
- "description": "The postal code range that the tax rate applies to, represented by a ZIP code, a ZIP code prefix using * wildcard, a range between two ZIP codes or two ZIP code prefixes of equal length. Examples: 94114, 94*, 94002-95460, 94*-95*.",
- "type": "string"
- },
- "rate": {
- "description": "The percentage of tax rate that applies to the item price.",
- "format": "double",
- "type": "number"
- },
- "region": {
- "description": "The geographic region to which the tax rate applies.",
- "type": "string"
- },
- "taxShip": {
- "description": "Should be set to true if tax is charged on shipping.",
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "ProductUnitPricingBaseMeasure": {
- "id": "ProductUnitPricingBaseMeasure",
- "properties": {
- "unit": {
- "description": "The unit of the denominator.",
- "type": "string"
- },
- "value": {
- "description": "The denominator of the unit price.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductUnitPricingMeasure": {
- "id": "ProductUnitPricingMeasure",
- "properties": {
- "unit": {
- "description": "The unit of the measure.",
- "type": "string"
- },
- "value": {
- "description": "The measure of an item.",
- "format": "double",
- "type": "number"
- }
- },
- "type": "object"
- },
- "ProductView": {
- "description": "Product fields. Values are only set for fields requested explicitly in the request's search query.",
- "id": "ProductView",
- "properties": {
- "aggregatedDestinationStatus": {
- "description": "Aggregated destination status.",
- "enum": [
- "AGGREGATED_STATUS_UNSPECIFIED",
- "NOT_ELIGIBLE_OR_DISAPPROVED",
- "PENDING",
- "ELIGIBLE_LIMITED",
- "ELIGIBLE"
- ],
- "enumDescriptions": [
- "Undefined aggregated status.",
- "Offer isn't eligible, or is disapproved for all destinations.",
- "Offer's status is pending in all destinations.",
- "Offer is eligible for some (but not all) destinations.",
- "Offer is eligible for all destinations."
- ],
- "type": "string"
- },
- "availability": {
- "description": "Availability of the product.",
- "type": "string"
- },
- "brand": {
- "description": "Brand of the product.",
- "type": "string"
- },
- "categoryL1": {
- "description": "First level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).",
- "type": "string"
- },
- "categoryL2": {
- "description": "Second level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).",
- "type": "string"
- },
- "categoryL3": {
- "description": "Third level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).",
- "type": "string"
- },
- "categoryL4": {
- "description": "Fourth level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).",
- "type": "string"
- },
- "categoryL5": {
- "description": "Fifth level of the product category in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).",
- "type": "string"
- },
- "channel": {
- "description": "Channel of the product (online versus local).",
- "enum": [
- "CHANNEL_UNSPECIFIED",
- "LOCAL",
- "ONLINE"
- ],
- "enumDescriptions": [
- "Indicates that the channel is unspecified.",
- "Indicates that the channel is local.",
- "Indicates that the channel is online."
- ],
- "type": "string"
- },
- "clickPotential": {
- "description": "Estimated performance potential compared to highest performing products of the merchant.",
- "enum": [
- "CLICK_POTENTIAL_UNSPECIFIED",
- "LOW",
- "MEDIUM",
- "HIGH"
- ],
- "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."
- ],
- "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"
- },
- "condition": {
- "description": "Condition of the product.",
- "type": "string"
- },
- "creationTime": {
- "description": "The time the merchant created the product in timestamp seconds.",
- "format": "google-datetime",
- "type": "string"
- },
- "currencyCode": {
- "description": "Product price currency code (for example, ISO 4217). Absent if product price is not available.",
- "type": "string"
- },
- "expirationDate": {
- "$ref": "Date",
- "description": "Expiration date for the product. Specified on insertion."
- },
- "gtin": {
- "description": "GTIN of the product.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "id": {
- "description": "The REST ID of the product, in the form of channel:contentLanguage:targetCountry:offerId. Content API methods that operate on products take this as their productId parameter. Should always be included in the SELECT clause.",
- "type": "string"
- },
- "itemGroupId": {
- "description": "Item group ID provided by the merchant for grouping variants together.",
- "type": "string"
- },
- "itemIssues": {
- "description": "List of item issues for the product.",
- "items": {
- "$ref": "ProductViewItemIssue"
- },
- "type": "array"
- },
- "languageCode": {
- "description": "Language code of the product in BCP 47 format.",
- "type": "string"
- },
- "offerId": {
- "description": "Merchant-provided id of the product.",
- "type": "string"
- },
- "priceMicros": {
- "description": "Product price specified as micros (1 millionth of a standard unit, 1 USD = 1000000 micros) in the product currency. Absent in case the information about the price of the product is not available.",
- "format": "int64",
- "type": "string"
- },
- "productTypeL1": {
- "description": "First level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436).",
- "type": "string"
- },
- "productTypeL2": {
- "description": "Second level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436).",
- "type": "string"
- },
- "productTypeL3": {
- "description": "Third level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436).",
- "type": "string"
- },
- "productTypeL4": {
- "description": "Fourth level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436).",
- "type": "string"
- },
- "productTypeL5": {
- "description": "Fifth level of the product type in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324436).",
- "type": "string"
- },
- "shippingLabel": {
- "description": "The normalized shipping label specified in the feed",
- "type": "string"
- },
- "title": {
- "description": "Title of the product.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductViewItemIssue": {
- "description": "Item issue associated with the product.",
- "id": "ProductViewItemIssue",
- "properties": {
- "issueType": {
- "$ref": "ProductViewItemIssueItemIssueType",
- "description": "Item issue type."
- },
- "resolution": {
- "description": "Item issue resolution.",
- "enum": [
- "UNKNOWN",
- "MERCHANT_ACTION",
- "PENDING_PROCESSING"
- ],
- "enumDescriptions": [
- "Unknown resolution type.",
- "The merchant has to fix the issue.",
- "The issue will be resolved automatically (for example, image crawl), or Google review. No merchant action is required now. Resolution might lead to another issue (for example, if crawl fails)."
- ],
- "type": "string"
- },
- "severity": {
- "$ref": "ProductViewItemIssueItemIssueSeverity",
- "description": "Item issue severity."
- }
- },
- "type": "object"
- },
- "ProductViewItemIssueIssueSeverityPerDestination": {
- "description": "Issue severity for all affected regions in a destination.",
- "id": "ProductViewItemIssueIssueSeverityPerDestination",
- "properties": {
- "demotedCountries": {
- "description": "List of demoted countries in the destination.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "destination": {
- "description": "Issue destination.",
- "type": "string"
- },
- "disapprovedCountries": {
- "description": "List of disapproved countries in the destination.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ProductViewItemIssueItemIssueSeverity": {
- "description": "Severity of an issue per destination in a region, and aggregated severity.",
- "id": "ProductViewItemIssueItemIssueSeverity",
- "properties": {
- "aggregatedSeverity": {
- "description": "Severity of an issue aggregated for destination.",
- "enum": [
- "AGGREGATED_ISSUE_SEVERITY_UNSPECIFIED",
- "DISAPPROVED",
- "DEMOTED",
- "PENDING"
- ],
- "enumDescriptions": [
- "Undefined Issue severity.",
- "Issue disapproves the product in at least one of the selected destinations.",
- "Issue demotes the product in all selected destinations it affects.",
- "Issue resolution is `PENDING_PROCESSING`."
- ],
- "type": "string"
- },
- "severityPerDestination": {
- "description": "Item issue severity for every destination.",
- "items": {
- "$ref": "ProductViewItemIssueIssueSeverityPerDestination"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ProductViewItemIssueItemIssueType": {
- "description": "Type of the item issue.",
- "id": "ProductViewItemIssueItemIssueType",
- "properties": {
- "canonicalAttribute": {
- "description": "Canonical attribute name for attribute-specific issues.",
- "type": "string"
- },
- "code": {
- "description": "Error code of the issue.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductWeight": {
- "id": "ProductWeight",
- "properties": {
- "unit": {
- "description": "Required. The weight unit. Acceptable values are: - \"`g`\" - \"`kg`\" - \"`oz`\" - \"`lb`\" ",
- "type": "string"
- },
- "value": {
- "description": "Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.",
- "format": "double",
- "type": "number"
- }
- },
- "type": "object"
- },
- "ProductsCustomBatchRequest": {
- "id": "ProductsCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "ProductsCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ProductsCustomBatchRequestEntry": {
- "description": "A batch entry encoding a single non-batch products request.",
- "id": "ProductsCustomBatchRequestEntry",
- "properties": {
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "feedId": {
- "description": "The Content API Supplemental Feed ID. If present then product insertion or deletion applies to a supplemental feed instead of primary Content API feed.",
- "format": "uint64",
- "type": "string"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`delete`\" - \"`get`\" - \"`insert`\" - \"`update`\" ",
- "type": "string"
- },
- "product": {
- "$ref": "Product",
- "description": "The product to insert or update. Only required if the method is `insert` or `update`. If the `update` method is used with `updateMask` only to delete a field, then this isn't required. For example, setting `salePrice` on the `updateMask` and not providing a `product` will result in an existing sale price on the product specified by `productId` being deleted."
- },
- "productId": {
- "description": "The ID of the product to get or mutate. Only defined if the method is `get`, `delete`, or `update`.",
- "type": "string"
- },
- "updateMask": {
- "description": "The comma-separated list of product attributes to be updated. Example: `\"title,salePrice\"`. Attributes specified in the update mask without a value specified in the body will be deleted from the product. *You must specify the update mask to delete attributes.* Only top-level product attributes can be updated. If not defined, product attributes with set values will be updated and other attributes will stay unchanged. Only defined if the method is `update`.",
- "format": "google-fieldmask",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductsCustomBatchResponse": {
- "id": "ProductsCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "ProductsCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productsCustomBatchResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductsCustomBatchResponseEntry": {
- "description": "A batch entry encoding a single non-batch products response.",
- "id": "ProductsCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors for failed custombatch entries. *Note:* Schema errors fail the whole request."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productsCustomBatchResponseEntry`\"",
- "type": "string"
- },
- "product": {
- "$ref": "Product",
- "description": "The inserted product. Only defined if the method is `insert` and if the request was successful."
- }
- },
- "type": "object"
- },
- "ProductsListResponse": {
- "id": "ProductsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productsListResponse`\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of products.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "Product"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ProductstatusesCustomBatchRequest": {
- "id": "ProductstatusesCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "ProductstatusesCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ProductstatusesCustomBatchRequestEntry": {
- "description": "A batch entry encoding a single non-batch productstatuses request.",
- "id": "ProductstatusesCustomBatchRequestEntry",
- "properties": {
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "destinations": {
- "description": "If set, only issues for the specified destinations are returned, otherwise only issues for the Shopping destination.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "includeAttributes": {
- "deprecated": true,
- "description": "Deprecated: Setting this field has no effect and attributes are never included.",
- "type": "boolean"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`get`\" ",
- "type": "string"
- },
- "productId": {
- "description": "The ID of the product whose status to get.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductstatusesCustomBatchResponse": {
- "id": "ProductstatusesCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "ProductstatusesCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productstatusesCustomBatchResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ProductstatusesCustomBatchResponseEntry": {
- "description": "A batch entry encoding a single non-batch productstatuses response.",
- "id": "ProductstatusesCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors for failed custombatch entries. *Note:* Schema errors fail the whole request."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productstatusesCustomBatchResponseEntry`\"",
- "type": "string"
- },
- "productStatus": {
- "$ref": "ProductStatus",
- "description": "The requested product status. Only defined if the request was successful."
- }
- },
- "type": "object"
- },
- "ProductstatusesListResponse": {
- "id": "ProductstatusesListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#productstatusesListResponse`\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of products statuses.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "ProductStatus"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "Promotion": {
- "description": "Represents a promotion. See the following articles for more details. * [Promotions feed specification](https://support.google.com/merchants/answer/2906014) * [Local promotions feed specification](https://support.google.com/merchants/answer/10146130) * [Promotions on Buy on Google product data specification](https://support.google.com/merchants/answer/9173673)",
- "id": "Promotion",
- "properties": {
- "brand": {
- "description": "Product filter by brand for the promotion.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "brandExclusion": {
- "description": "Product filter by brand exclusion for the promotion.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "contentLanguage": {
- "description": "Required. The content language used as part of the unique identifier. `en` content language is available for all target countries. `fr` content language is available for `CA` and `FR` target countries. `de` content language is available for `DE` target country. `nl` content language is available for `NL` target country. `it` content language is available for `IT` target country. `pt` content language is available for `BR` target country. `ja` content language is available for `JP` target country. `ko` content language is available for `KR` target country.",
- "type": "string"
- },
- "couponValueType": {
- "description": "Required. Coupon value type for the promotion.",
- "enum": [
- "COUPON_VALUE_TYPE_UNSPECIFIED",
- "MONEY_OFF",
- "PERCENT_OFF",
- "BUY_M_GET_N_MONEY_OFF",
- "BUY_M_GET_N_PERCENT_OFF",
- "BUY_M_GET_MONEY_OFF",
- "BUY_M_GET_PERCENT_OFF",
- "FREE_GIFT",
- "FREE_GIFT_WITH_VALUE",
- "FREE_GIFT_WITH_ITEM_ID",
- "FREE_SHIPPING_STANDARD",
- "FREE_SHIPPING_OVERNIGHT",
- "FREE_SHIPPING_TWO_DAY"
- ],
- "enumDescriptions": [
- "Indicates that the coupon value type is unspecified.",
- "Money off coupon value type.",
- "Percent off coupon value type.",
- "Buy M quantity, get N money off coupon value type. `buy_this_quantity` and `get_this_quantity` must be present. `money_off_amount` must also be present.",
- "Buy M quantity, get N percent off coupon value type. `buy_this_quantity` and `get_this_quantity` must be present. `percent_off_percentage` must also be present.",
- "Buy M quantity, get money off. `buy_this_quantity` and `money_off_amount` must be present.",
- "Buy M quantity, get money off. `buy_this_quantity` and `percent_off_percentage` must be present.",
- "Free gift with description only.",
- "Free gift with value (description is optional).",
- "Free gift with item ID (description is optional).",
- "Standard free shipping coupon value type.",
- "Overnight free shipping coupon value type.",
- "Two day free shipping coupon value type."
- ],
- "type": "string"
- },
- "customRedemptionRestriction": {
- "description": "The custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set.",
- "type": "string"
- },
- "freeGiftDescription": {
- "description": "Free gift description for the promotion.",
- "type": "string"
- },
- "freeGiftItemId": {
- "description": "Free gift item ID for the promotion.",
- "type": "string"
- },
- "freeGiftValue": {
- "$ref": "PriceAmount",
- "description": "Free gift value for the promotion."
- },
- "genericRedemptionCode": {
- "description": "Generic redemption code for the promotion. To be used with the `offerType` field.",
- "type": "string"
- },
- "getThisQuantityDiscounted": {
- "description": "The number of items discounted in the promotion.",
- "format": "int32",
- "type": "integer"
- },
- "id": {
- "description": "Output only. The REST promotion ID to uniquely identify the promotion. Content API methods that operate on promotions take this as their `promotionId` parameter. The REST ID for a promotion is of the form channel:contentLanguage:targetCountry:promotionId The `channel` field has a value of `\"online\"`, `\"in_store\"`, or `\"online_in_store\"`.",
- "readOnly": true,
- "type": "string"
- },
- "itemGroupId": {
- "description": "Product filter by item group ID for the promotion.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "itemGroupIdExclusion": {
- "description": "Product filter by item group ID exclusion for the promotion.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "itemId": {
- "description": "Product filter by item ID for the promotion.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "itemIdExclusion": {
- "description": "Product filter by item ID exclusion for the promotion.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "limitQuantity": {
- "description": "Maximum purchase quantity for the promotion.",
- "format": "int32",
- "type": "integer"
- },
- "limitValue": {
- "$ref": "PriceAmount",
- "description": "Maximum purchase value for the promotion."
- },
- "longTitle": {
- "description": "Required. Long title for the promotion.",
- "type": "string"
- },
- "maxDiscountAmount": {
- "$ref": "PriceAmount",
- "description": "The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type."
- },
- "minimumPurchaseAmount": {
- "$ref": "PriceAmount",
- "description": "Minimum purchase amount for the promotion."
- },
- "minimumPurchaseQuantity": {
- "description": "Minimum purchase quantity for the promotion.",
- "format": "int32",
- "type": "integer"
- },
- "moneyBudget": {
- "$ref": "PriceAmount",
- "description": "Cost cap for the promotion."
- },
- "moneyOffAmount": {
- "$ref": "PriceAmount",
- "description": "The money off amount offered in the promotion."
- },
- "offerType": {
- "description": "Required. Type of the promotion.",
- "enum": [
- "OFFER_TYPE_UNSPECIFIED",
- "NO_CODE",
- "GENERIC_CODE"
- ],
- "enumDescriptions": [
- "Unknown offer type.",
- "Offer type without a code.",
- "Offer type with a code."
- ],
- "type": "string"
- },
- "orderLimit": {
- "description": "Order limit for the promotion.",
- "format": "int32",
- "type": "integer"
- },
- "percentOff": {
- "description": "The percentage discount offered in the promotion.",
- "format": "int32",
- "type": "integer"
- },
- "productApplicability": {
- "description": "Required. Applicability of the promotion to either all products or only specific products.",
- "enum": [
- "PRODUCT_APPLICABILITY_UNSPECIFIED",
- "ALL_PRODUCTS",
- "SPECIFIC_PRODUCTS"
- ],
- "enumDescriptions": [
- "Which products the promotion applies to is unknown.",
- "Applicable to all products.",
- "Applicable to only a single product or list of products."
- ],
- "type": "string"
- },
- "productType": {
- "description": "Product filter by product type for the promotion.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "productTypeExclusion": {
- "description": "Product filter by product type exclusion for the promotion.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "promotionDestinationIds": {
- "description": "Destination ID for the promotion.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "promotionDisplayDates": {
- "deprecated": true,
- "description": "String representation of the promotion display dates. Deprecated. Use `promotion_display_time_period` instead.",
- "type": "string"
- },
- "promotionDisplayTimePeriod": {
- "$ref": "TimePeriod",
- "description": "`TimePeriod` representation of the promotion's display dates."
- },
- "promotionEffectiveDates": {
- "deprecated": true,
- "description": "String representation of the promotion effective dates. Deprecated. Use `promotion_effective_time_period` instead.",
- "type": "string"
- },
- "promotionEffectiveTimePeriod": {
- "$ref": "TimePeriod",
- "description": "Required. `TimePeriod` representation of the promotion's effective dates."
- },
- "promotionId": {
- "description": "Required. The user provided promotion ID to uniquely identify the promotion.",
- "type": "string"
- },
- "promotionStatus": {
- "$ref": "PromotionPromotionStatus",
- "description": "Output only. The current status of the promotion.",
- "readOnly": true
- },
- "promotionUrl": {
- "description": "URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no promo url is included. URL is used to confirm that the promotion is valid and can be redeemed.",
- "type": "string"
- },
- "redemptionChannel": {
- "description": "Required. Redemption channel for the promotion. At least one channel is required.",
- "items": {
- "enum": [
- "REDEMPTION_CHANNEL_UNSPECIFIED",
- "IN_STORE",
- "ONLINE"
- ],
- "enumDescriptions": [
- "Indicates that the channel is unspecified.",
- "Indicates that the channel is in store.",
- "Indicates that the channel is online."
- ],
- "type": "string"
- },
- "type": "array"
- },
- "redemptionRestriction": {
- "description": "The redemption restriction for the promotion.",
- "enum": [
- "REDEMPTION_RESTRICTION_UNSPECIFIED",
- "SUBSCRIBE_AND_SAVE",
- "FIRST_ORDER",
- "SIGN_UP_FOR_EMAIL",
- "SIGN_UP_FOR_TEXT",
- "FORMS_OF_PAYMENT",
- "CUSTOM"
- ],
- "enumDescriptions": [
- "The redemption restriction is unspecified.",
- "The customer must subscribe to the merchant's channel to redeem the promotion.",
- "The customer must be a first-time customer to redeem the promotion.",
- "The customer must sign up for email's to redeem the promotion.",
- "The customer must sign up for text to redeem the promotion.",
- "The customer must use a specific form of payment to redeem the promotion.",
- "The customer must meet a custom restriction to redeem the promotion. If selected, the `custom_redemption_restriction` field must be set."
- ],
- "type": "string"
- },
- "shippingServiceNames": {
- "description": "Shipping service names for the promotion.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "storeApplicability": {
- "description": "Whether the promotion applies to all stores, or only specified stores. Local Inventory ads promotions throw an error if no store applicability is included. An INVALID_ARGUMENT error is thrown if store_applicability is set to ALL_STORES and store_code or score_code_exclusion is set to a value.",
- "enum": [
- "STORE_APPLICABILITY_UNSPECIFIED",
- "ALL_STORES",
- "SPECIFIC_STORES"
- ],
- "enumDescriptions": [
- "Which store codes the promotion applies to is unknown.",
- "Promotion applies to all stores.",
- "Promotion applies to only the specified stores."
- ],
- "type": "string"
- },
- "storeCode": {
- "description": "Store codes to include for the promotion.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "storeCodeExclusion": {
- "description": "Store codes to exclude for the promotion.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "targetCountry": {
- "description": "Required. The target country used as part of the unique identifier. Can be `AU`, `CA`, `DE`, `FR`, `GB`, `IN`, `US`, `BR`, `ES`, `NL`, `JP`, `IT` or `KR`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PromotionPromotionStatus": {
- "description": "The status of the promotion.",
- "id": "PromotionPromotionStatus",
- "properties": {
- "creationDate": {
- "description": "Date on which the promotion has been created in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\"",
- "type": "string"
- },
- "destinationStatuses": {
- "description": "The intended destinations for the promotion.",
- "items": {
- "$ref": "PromotionPromotionStatusDestinationStatus"
- },
- "type": "array"
- },
- "lastUpdateDate": {
- "description": "Date on which the promotion status has been last updated in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format: Date, time, and offset, for example \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\"",
- "type": "string"
- },
- "promotionIssue": {
- "description": "A list of issues associated with the promotion.",
- "items": {
- "$ref": "PromotionPromotionStatusPromotionIssue"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "PromotionPromotionStatusDestinationStatus": {
- "description": "The destination status of the promotion.",
- "id": "PromotionPromotionStatusDestinationStatus",
- "properties": {
- "destination": {
- "description": "The name of the destination.",
- "type": "string"
- },
- "status": {
- "description": "The status for the specified destination.",
- "enum": [
- "STATE_UNSPECIFIED",
- "IN_REVIEW",
- "REJECTED",
- "LIVE",
- "STOPPED",
- "EXPIRED",
- "PENDING"
- ],
- "enumDescriptions": [
- "Unknown promotion state.",
- "The promotion is under review.",
- "The promotion is disapproved",
- "The promotion is approved and active.",
- "The promotion is stopped by merchant.",
- "The promotion is no longer active.",
- "The promotion is not stopped, and all reviews are approved, but the active date is in the future."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "PromotionPromotionStatusPromotionIssue": {
- "description": "The issue associated with the promotion.",
- "id": "PromotionPromotionStatusPromotionIssue",
- "properties": {
- "code": {
- "description": "Code of the issue.",
- "type": "string"
- },
- "detail": {
- "description": "Explanation of the issue.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "PubsubNotificationSettings": {
- "description": "Settings for Pub/Sub notifications, all methods require that the caller is a direct user of the merchant center account.",
- "id": "PubsubNotificationSettings",
- "properties": {
- "cloudTopicName": {
- "description": "Cloud pub/sub topic to which notifications are sent (read-only).",
- "type": "string"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#pubsubNotificationSettings`\"",
- "type": "string"
- },
- "registeredEvents": {
- "description": "List of event types. Acceptable values are: - \"`orderPendingShipment`\" ",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "RateGroup": {
- "id": "RateGroup",
- "properties": {
- "applicableShippingLabels": {
- "description": "A list of shipping labels defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service. Required.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "carrierRates": {
- "description": "A list of carrier rates that can be referred to by `mainTable` or `singleValue`.",
- "items": {
- "$ref": "CarrierRate"
- },
- "type": "array"
- },
- "mainTable": {
- "$ref": "Table",
- "description": "A table defining the rate group, when `singleValue` is not expressive enough. Can only be set if `singleValue` is not set."
- },
- "name": {
- "description": "Name of the rate group. Optional. If set has to be unique within shipping service.",
- "type": "string"
- },
- "singleValue": {
- "$ref": "Value",
- "description": "The value of the rate group (for example, flat rate $10). Can only be set if `mainTable` and `subtables` are not set."
- },
- "subtables": {
- "description": "A list of subtables referred to by `mainTable`. Can only be set if `mainTable` is set.",
- "items": {
- "$ref": "Table"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "Recommendation": {
- "description": "Recommendations are suggested ways to improve your merchant account's performance. For example, to engage with a feature, or start using a new Google product.",
- "id": "Recommendation",
- "properties": {
- "additionalCallToAction": {
- "description": "Output only. CTAs of this recommendation. Repeated.",
- "items": {
- "$ref": "RecommendationCallToAction"
- },
- "readOnly": true,
- "type": "array"
- },
- "additionalDescriptions": {
- "description": "Output only. List of additional localized descriptions for a recommendation. Localication uses the `languageCode` field in `GenerateRecommendations` requests. Not all description types are guaranteed to be present and we recommend to rely on default description.",
- "items": {
- "$ref": "RecommendationDescription"
- },
- "readOnly": true,
- "type": "array"
- },
- "creative": {
- "description": "Output only. Any creatives attached to the recommendation. Repeated.",
- "items": {
- "$ref": "RecommendationCreative"
- },
- "readOnly": true,
- "type": "array"
- },
- "defaultCallToAction": {
- "$ref": "RecommendationCallToAction",
- "description": "Optional. Default CTA of the recommendation."
- },
- "defaultDescription": {
- "description": "Optional. Localized recommendation description. The localization the {@link `GenerateRecommendationsRequest.language_code`} field in {@link `GenerateRecommendationsRequest`} requests.",
- "type": "string"
- },
- "numericalImpact": {
- "description": "Optional. A numerical score of the impact from the recommendation's description. For example, a recommendation might suggest an upward trend in sales for a certain product. Higher number means larger impact.",
- "format": "int32",
- "type": "integer"
- },
- "paid": {
- "description": "Optional. Indicates whether a user needs to pay when they complete the user journey suggested by the recommendation.",
- "type": "boolean"
- },
- "recommendationName": {
- "description": "Optional. Localized recommendation name. The localization uses the {@link `GenerateRecommendationsRequest.language_code`} field in {@link `GenerateRecommendationsRequest`} requests.",
- "type": "string"
- },
- "subType": {
- "description": "Optional. Subtype of the recommendations. Only applicable when multiple recommendations can be generated per type, and is used as an identifier of recommendation under the same recommendation type.",
- "type": "string"
- },
- "title": {
- "description": "Optional. Localized Recommendation Title. Localization uses the {@link `GenerateRecommendationsRequest.language_code`} field in {@link `GenerateRecommendationsRequest`} requests.",
- "type": "string"
- },
- "type": {
- "description": "Output only. Type of the recommendation. List of currently available recommendation types: - OPPORTUNITY_CREATE_NEW_COLLECTION - OPPORTUNITY_CREATE_EMAIL_CAMPAIGN",
- "readOnly": true,
- "type": "string"
- }
- },
- "type": "object"
- },
- "RecommendationCallToAction": {
- "description": "Call to action (CTA) that explains how a merchant can implement this recommendation",
- "id": "RecommendationCallToAction",
- "properties": {
- "intent": {
- "description": "Output only. Intent of the action. This value describes the intent (for example, `OPEN_CREATE_EMAIL_CAMPAIGN_FLOW`) and can vary from recommendation to recommendation. This value can change over time for the same recommendation. Currently available intent values: - OPEN_CREATE_EMAIL_CAMPAIGN_FLOW: Opens a user journey where they can create a marketing email campaign. (No default URL) - OPEN_CREATE_COLLECTION_TAB: Opens a user journey where they can [create a collection](https://support.google.com/merchants/answer/9703228) for their Merchant account. (No default URL)",
- "readOnly": true,
- "type": "string"
- },
- "localizedText": {
- "description": "Output only. Localized text of the CTA. Optional.",
- "readOnly": true,
- "type": "string"
- },
- "uri": {
- "description": "Optional. URL of the CTA. This field will only be set for some recommendations where there is a suggested landing URL. Otherwise it will be set to an empty string. We recommend developers to use their own custom landing page according to the description of the intent field above when this uri field is empty.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "RecommendationCreative": {
- "description": "Creative is a multimedia attachment to recommendation that can be used on the frontend.",
- "id": "RecommendationCreative",
- "properties": {
- "type": {
- "description": "Type of the creative.",
- "enum": [
- "CREATIVE_TYPE_UNSPECIFIED",
- "VIDEO",
- "PHOTO"
- ],
- "enumDescriptions": [
- "Default value. If provided, shall be considered invalid.",
- "Video creatives.",
- "Photo creatives."
- ],
- "type": "string"
- },
- "uri": {
- "description": "URL of the creative.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "RecommendationDescription": {
- "description": "Google-provided description for the recommendation.",
- "id": "RecommendationDescription",
- "properties": {
- "text": {
- "description": "Output only. Text of the description.",
- "readOnly": true,
- "type": "string"
- },
- "type": {
- "description": "Output only. Type of the description.",
- "enum": [
- "DESCRIPTION_TYPE_UNSPECIFIED",
- "SHORT",
- "LONG"
- ],
- "enumDescriptions": [
- "Default value. Will never be provided by the API.",
- "Short description.",
- "Long description."
- ],
- "readOnly": true,
- "type": "string"
- }
- },
- "type": "object"
- },
- "Region": {
- "description": "Represents a geographic region that you can use as a target with both the `RegionalInventory` and `ShippingSettings` services. You can define regions as collections of either postal codes or, in some countries, using predefined geotargets.",
- "id": "Region",
- "properties": {
- "displayName": {
- "description": "The display name of the region.",
- "type": "string"
- },
- "geotargetArea": {
- "$ref": "RegionGeoTargetArea",
- "description": "A list of geotargets that defines the region area."
- },
- "merchantId": {
- "description": "Output only. Immutable. Merchant that owns the region.",
- "format": "int64",
- "readOnly": true,
- "type": "string"
- },
- "postalCodeArea": {
- "$ref": "RegionPostalCodeArea",
- "description": "A list of postal codes that defines the region area."
- },
- "regionId": {
- "description": "Output only. Immutable. The ID uniquely identifying each region.",
- "readOnly": true,
- "type": "string"
- },
- "regionalInventoryEligible": {
- "description": "Output only. Indicates if the region is eligible to use in the Regional Inventory configuration.",
- "readOnly": true,
- "type": "boolean"
- },
- "shippingEligible": {
- "description": "Output only. Indicates if the region is eligible to use in the Shipping Services configuration.",
- "readOnly": true,
- "type": "boolean"
- }
- },
- "type": "object"
- },
- "RegionGeoTargetArea": {
- "description": "A list of geotargets that defines the region area.",
- "id": "RegionGeoTargetArea",
- "properties": {
- "geotargetCriteriaIds": {
- "description": "Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (e.g., state).",
- "items": {
- "format": "int64",
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "RegionPostalCodeArea": {
- "description": "A list of postal codes that defines the region area. Note: All regions defined using postal codes are accessible via the account's `ShippingSettings.postalCodeGroups` resource.",
- "id": "RegionPostalCodeArea",
- "properties": {
- "postalCodes": {
- "description": "Required. A range of postal codes.",
- "items": {
- "$ref": "RegionPostalCodeAreaPostalCodeRange"
- },
- "type": "array"
- },
- "regionCode": {
- "description": "Required. CLDR territory code or the country the postal code group applies to.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "RegionPostalCodeAreaPostalCodeRange": {
- "description": "A range of postal codes that defines the region area.",
- "id": "RegionPostalCodeAreaPostalCodeRange",
- "properties": {
- "begin": {
- "description": "Required. A postal code or a pattern of the form prefix* denoting the inclusive lower bound of the range defining the area. Examples values: \"94108\", \"9410*\", \"9*\".",
- "type": "string"
- },
- "end": {
- "description": "Optional. A postal code or a pattern of the form prefix* denoting the inclusive upper bound of the range defining the area. It must have the same length as postalCodeRangeBegin: if postalCodeRangeBegin is a postal code then postalCodeRangeEnd must be a postal code too; if postalCodeRangeBegin is a pattern then postalCodeRangeEnd must be a pattern with the same prefix length. Optional: if not set, then the area is defined as being all the postal codes matching postalCodeRangeBegin.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "RegionalInventory": {
- "description": "Regional inventory resource. contains the regional name and all attributes which are overridden for the specified region.",
- "id": "RegionalInventory",
- "properties": {
- "availability": {
- "description": "The availability of the product.",
- "type": "string"
- },
- "customAttributes": {
- "description": "A list of custom (merchant-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form.",
- "items": {
- "$ref": "CustomAttribute"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#regionalInventory`\".",
- "type": "string"
- },
- "price": {
- "$ref": "Price",
- "description": "The price of the product."
- },
- "regionId": {
- "description": "The ID uniquely identifying each region.",
- "type": "string"
- },
- "salePrice": {
- "$ref": "Price",
- "description": "The sale price of the product. Mandatory if `sale_price_effective_date` is defined."
- },
- "salePriceEffectiveDate": {
- "description": "A date range represented by a pair of ISO 8601 dates separated by a space, comma, or slash. Both dates might be specified as 'null' if undecided.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "RegionalinventoryCustomBatchRequest": {
- "id": "RegionalinventoryCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "RegionalinventoryCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "RegionalinventoryCustomBatchRequestEntry": {
- "description": "A batch entry encoding a single non-batch regional inventory request.",
- "id": "RegionalinventoryCustomBatchRequestEntry",
- "properties": {
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "Method of the batch request entry. Acceptable values are: - \"`insert`\" ",
- "type": "string"
- },
- "productId": {
- "description": "The ID of the product for which to update price and availability.",
- "type": "string"
- },
- "regionalInventory": {
- "$ref": "RegionalInventory",
- "description": "Price and availability of the product."
- }
- },
- "type": "object"
- },
- "RegionalinventoryCustomBatchResponse": {
- "id": "RegionalinventoryCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "RegionalinventoryCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#regionalinventoryCustomBatchResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "RegionalinventoryCustomBatchResponseEntry": {
- "description": "A batch entry encoding a single non-batch regional inventory response.",
- "id": "RegionalinventoryCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry this entry responds to.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors for failed custombatch entries. *Note:* Schema errors fail the whole request."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#regionalinventoryCustomBatchResponseEntry`\".",
- "type": "string"
- },
- "regionalInventory": {
- "$ref": "RegionalInventory",
- "description": "Price and availability of the product."
- }
- },
- "type": "object"
- },
- "RenderAccountIssuesRequestPayload": {
- "description": "The payload for configuring how the content should be rendered.",
- "id": "RenderAccountIssuesRequestPayload",
- "properties": {
- "contentOption": {
- "description": "Optional. How the detailed content should be returned. Default option is to return the content as a pre-rendered HTML text.",
- "enum": [
- "CONTENT_OPTION_UNSPECIFIED",
- "PRE_RENDERED_HTML"
- ],
- "enumDescriptions": [
- "Default value. Will never be provided by the API.",
- "Returns the detail of the issue as a pre-rendered HTML text."
- ],
- "type": "string"
- },
- "userInputActionOption": {
- "description": "Optional. How actions with user input form should be handled. If not provided, actions will be returned as links that points merchant to Merchant Center where they can request the action.",
- "enum": [
- "USER_INPUT_ACTION_RENDERING_OPTION_UNSPECIFIED",
- "REDIRECT_TO_MERCHANT_CENTER",
- "BUILT_IN_USER_INPUT_ACTIONS"
- ],
- "enumDescriptions": [
- "Default value. Will never be provided by the API.",
- "Actions that require user input are represented only as links that points merchant to Merchant Center where they can request the action. Provides easier to implement alternative to `BUILT_IN_USER_INPUT_ACTIONS`.",
- "Returns content and input form definition for each complex action. Your application needs to display this content and input form to the merchant before they can request processing of the action. To start the action, your application needs to call the `triggeraction` method."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "RenderAccountIssuesResponse": {
- "description": "Response containing support content and actions for listed account issues.",
- "id": "RenderAccountIssuesResponse",
- "properties": {
- "alternateDisputeResolution": {
- "$ref": "AlternateDisputeResolution",
- "deprecated": true,
- "description": "Alternate Dispute Resolution (ADR) is deprecated. Use `prerendered_out_of_court_dispute_settlement` instead."
- },
- "issues": {
- "description": "List of account issues for a given account. This list can be shown with compressed, expandable items. In the compressed form, the title and impact should be shown for each issue. Once the issue is expanded, the detailed content and available actions should be rendered.",
- "items": {
- "$ref": "AccountIssue"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "RenderProductIssuesRequestPayload": {
- "description": "The payload for configuring how the content should be rendered.",
- "id": "RenderProductIssuesRequestPayload",
- "properties": {
- "contentOption": {
- "description": "Optional. How the detailed content should be returned. Default option is to return the content as a pre-rendered HTML text.",
- "enum": [
- "CONTENT_OPTION_UNSPECIFIED",
- "PRE_RENDERED_HTML"
- ],
- "enumDescriptions": [
- "Default value. Will never be provided by the API.",
- "Returns the detail of the issue as a pre-rendered HTML text."
- ],
- "type": "string"
- },
- "userInputActionOption": {
- "description": "Optional. How actions with user input form should be handled. If not provided, actions will be returned as links that points merchant to Merchant Center where they can request the action.",
- "enum": [
- "USER_INPUT_ACTION_RENDERING_OPTION_UNSPECIFIED",
- "REDIRECT_TO_MERCHANT_CENTER",
- "BUILT_IN_USER_INPUT_ACTIONS"
- ],
- "enumDescriptions": [
- "Default value. Will never be provided by the API.",
- "Actions that require user input are represented only as links that points merchant to Merchant Center where they can request the action. Provides easier to implement alternative to `BUILT_IN_USER_INPUT_ACTIONS`.",
- "Returns content and input form definition for each complex action. Your application needs to display this content and input form to the merchant before they can request processing of the action. To start the action, your application needs to call the `triggeraction` method."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "RenderProductIssuesResponse": {
- "description": "Response containing support content and actions for listed product issues.",
- "id": "RenderProductIssuesResponse",
- "properties": {
- "alternateDisputeResolution": {
- "$ref": "AlternateDisputeResolution",
- "deprecated": true,
- "description": "Alternate Dispute Resolution (ADR) is deprecated. Use `prerendered_out_of_court_dispute_settlement` instead."
- },
- "issues": {
- "description": "List of issues for a given product. This list can be shown with compressed, expandable items. In the compressed form, the title and impact should be shown for each issue. Once the issue is expanded, the detailed content and available actions should be rendered.",
- "items": {
- "$ref": "ProductIssue"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ReportInteractionRequest": {
- "description": "Request to report interactions on a recommendation.",
- "id": "ReportInteractionRequest",
- "properties": {
- "interactionType": {
- "description": "Required. Type of the interaction that is reported, for example INTERACTION_CLICK.",
- "enum": [
- "INTERACTION_TYPE_UNSPECIFIED",
- "INTERACTION_DISMISS",
- "INTERACTION_CLICK"
- ],
- "enumDescriptions": [
- "Default value. If provided, the service will throw ApiError with description \"Required parameter: interactionType\".",
- "When a recommendation is dismissed.",
- "When a recommendation is clicked."
- ],
- "type": "string"
- },
- "responseToken": {
- "description": "Required. Token of the response when recommendation was returned.",
- "type": "string"
- },
- "subtype": {
- "description": "Optional. Subtype of the recommendations this interaction happened on. This field must be set only to the value that is returned by {@link `RecommendationsService.GenerateRecommendations`} call.",
- "type": "string"
- },
- "type": {
- "description": "Required. Type of the recommendations on which this interaction happened. This field must be set only to the value that is returned by {@link `GenerateRecommendationsResponse`} call.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ReportRow": {
- "description": "Result row returned from the search query.",
- "id": "ReportRow",
- "properties": {
- "bestSellers": {
- "$ref": "BestSellers",
- "description": "Best sellers fields requested by the merchant in the query. Field values are only set if the merchant queries `BestSellersProductClusterView` or `BestSellersBrandView`."
- },
- "brand": {
- "$ref": "Brand",
- "description": "Brand fields requested by the merchant in the query. Field values are only set if the merchant queries `BestSellersBrandView`."
- },
- "competitiveVisibility": {
- "$ref": "CompetitiveVisibility",
- "description": "Competitive visibility fields requested by the merchant in the query. Field values are only set if the merchant queries `CompetitiveVisibilityTopMerchantView`, `CompetitiveVisibilityBenchmarkView` or `CompetitiveVisibilityCompetitorView`."
- },
- "metrics": {
- "$ref": "Metrics",
- "description": "Metrics requested by the merchant in the query. Metric values are only set for metrics requested explicitly in the query."
- },
- "priceCompetitiveness": {
- "$ref": "PriceCompetitiveness",
- "description": "Price competitiveness fields requested by the merchant in the query. Field values are only set if the merchant queries `PriceCompetitivenessProductView`."
- },
- "priceInsights": {
- "$ref": "PriceInsights",
- "description": "Price insights fields requested by the merchant in the query. Field values are only set if the merchant queries `PriceInsightsProductView`."
- },
- "productCluster": {
- "$ref": "ProductCluster",
- "description": "Product cluster fields requested by the merchant in the query. Field values are only set if the merchant queries `BestSellersProductClusterView`."
- },
- "productView": {
- "$ref": "ProductView",
- "description": "Product fields requested by the merchant in the query. Field values are only set if the merchant queries `ProductView`."
- },
- "segments": {
- "$ref": "Segments",
- "description": "Segmentation dimensions requested by the merchant in the query. Dimension values are only set for dimensions requested explicitly in the query."
- },
- "topicTrends": {
- "$ref": "TopicTrends",
- "description": "[Topic trends](https://support.google.com/merchants/answer/13542370) fields requested by the merchant in the query. Field values are only set if the merchant queries `TopicTrendsView`."
- }
- },
- "type": "object"
- },
- "RequestPhoneVerificationRequest": {
- "description": "Request message for the RequestPhoneVerification method.",
- "id": "RequestPhoneVerificationRequest",
- "properties": {
- "languageCode": {
- "description": "Language code [IETF BCP 47 syntax](https://tools.ietf.org/html/bcp47) (for example, en-US). Language code is used to provide localized `SMS` and `PHONE_CALL`. Default language used is en-US if not provided.",
- "type": "string"
- },
- "phoneNumber": {
- "description": "Phone number to be verified.",
- "type": "string"
- },
- "phoneRegionCode": {
- "description": "Required. Two letter country code for the phone number, for example `CA` for Canadian numbers. See the [ISO 3166-1 alpha-2](https://wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) officially assigned codes.",
- "type": "string"
- },
- "phoneVerificationMethod": {
- "description": "Verification method to receive verification code.",
- "enum": [
- "PHONE_VERIFICATION_METHOD_UNSPECIFIED",
- "SMS",
- "PHONE_CALL"
- ],
- "enumDescriptions": [
- "Unknown method.",
- "Receive verification code by SMS.",
- "Receive verification code by phone call."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "RequestPhoneVerificationResponse": {
- "description": "Response message for the RequestPhoneVerification method.",
- "id": "RequestPhoneVerificationResponse",
- "properties": {
- "verificationId": {
- "description": "The verification ID to use in subsequent calls to `verifyphonenumber`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "RequestReviewFreeListingsRequest": {
- "description": "Request message for the RequestReviewFreeListings Program method.",
- "id": "RequestReviewFreeListingsRequest",
- "properties": {
- "regionCode": {
- "description": "The code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the country for which review is to be requested.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "RequestReviewShoppingAdsRequest": {
- "description": "Request message for the RequestReviewShoppingAds program method.",
- "id": "RequestReviewShoppingAdsRequest",
- "properties": {
- "regionCode": {
- "description": "The code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the country for which review is to be requested.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ReturnPolicyOnline": {
- "description": "Return policy online object. This is currently used to represent return policies for ads and free listings programs.",
- "id": "ReturnPolicyOnline",
- "properties": {
- "countries": {
- "description": "The countries of sale where the return policy is applicable. The values must be a valid 2 letter ISO 3166 code, e.g. \"US\".",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "itemConditions": {
- "description": "The item conditions that are accepted for returns. This is required to not be empty unless the type of return policy is noReturns.",
- "items": {
- "enum": [
- "ITEM_CONDITION_UNSPECIFIED",
- "NEW",
- "USED"
- ],
- "enumDescriptions": [
- "Default value. This value is unused.",
- "New.",
- "Used."
- ],
- "type": "string"
- },
- "type": "array"
- },
- "label": {
- "description": "The unique user-defined label of the return policy. The same label cannot be used in different return policies for the same country. Policies with the label 'default' will apply to all products, unless a product specifies a return_policy_label attribute.",
- "type": "string"
- },
- "name": {
- "description": "The name of the policy as shown in Merchant Center.",
- "type": "string"
- },
- "policy": {
- "$ref": "ReturnPolicyOnlinePolicy",
- "description": "The return policy."
- },
- "restockingFee": {
- "$ref": "ReturnPolicyOnlineRestockingFee",
- "description": "The restocking fee that applies to all return reason categories. This would be treated as a free restocking fee if the value is not set."
- },
- "returnMethods": {
- "description": "The return methods of how customers can return an item. This value is required to not be empty unless the type of return policy is noReturns.",
- "items": {
- "enum": [
- "RETURN_METHOD_UNSPECIFIED",
- "BY_MAIL",
- "IN_STORE",
- "AT_A_KIOSK"
- ],
- "enumDescriptions": [
- "Default value. This value is unused.",
- "By mail.",
- "In store.",
- "At a kiosk."
- ],
- "type": "string"
- },
- "type": "array"
- },
- "returnPolicyId": {
- "description": "Output only. Return policy ID generated by Google.",
- "readOnly": true,
- "type": "string"
- },
- "returnPolicyUri": {
- "description": "The return policy uri. This can used by Google to do a sanity check for the policy.",
- "type": "string"
- },
- "returnReasonCategoryInfo": {
- "description": "The return reason category information. This required to not be empty unless the type of return policy is noReturns.",
- "items": {
- "$ref": "ReturnPolicyOnlineReturnReasonCategoryInfo"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ReturnPolicyOnlinePolicy": {
- "description": "The available policies.",
- "id": "ReturnPolicyOnlinePolicy",
- "properties": {
- "days": {
- "description": "The number of days items can be returned after delivery, where one day is defined to be 24 hours after the delivery timestamp. Required for `numberOfDaysAfterDelivery` returns.",
- "format": "int64",
- "type": "string"
- },
- "type": {
- "description": "Policy type.",
- "enum": [
- "TYPE_UNSPECIFIED",
- "NUMBER_OF_DAYS_AFTER_DELIVERY",
- "NO_RETURNS",
- "LIFETIME_RETURNS"
- ],
- "enumDescriptions": [
- "Default value. This value is unused.",
- "Number of days after a return is delivered.",
- "No returns.",
- "Life time returns."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "ReturnPolicyOnlineRestockingFee": {
- "description": "The restocking fee. This can either be a fixed fee or a micro percent.",
- "id": "ReturnPolicyOnlineRestockingFee",
- "properties": {
- "fixedFee": {
- "$ref": "PriceAmount",
- "description": "Fixed restocking fee."
- },
- "microPercent": {
- "description": "Percent of total price in micros. 15,000,000 means 15% of the total price would be charged.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "ReturnPolicyOnlineReturnReasonCategoryInfo": {
- "description": "The return reason category info wrapper.",
- "id": "ReturnPolicyOnlineReturnReasonCategoryInfo",
- "properties": {
- "returnLabelSource": {
- "description": "The corresponding return label source. If the `ReturnMethod` field includes `BY_MAIL`, it is required to specify `ReturnLabelSource` for both `BUYER_REMORSE` and `ITEM_DEFECT` return reason categories.",
- "enum": [
- "RETURN_LABEL_SOURCE_UNSPECIFIED",
- "DOWNLOAD_AND_PRINT",
- "IN_THE_BOX",
- "CUSTOMER_RESPONSIBILITY"
- ],
- "enumDescriptions": [
- "Default value. This value is unused.",
- "Download and print the label.",
- "Label in the box.",
- "Customers' responsibility to get the label."
- ],
- "type": "string"
- },
- "returnReasonCategory": {
- "description": "The return reason category.",
- "enum": [
- "RETURN_REASON_CATEGORY_UNSPECIFIED",
- "BUYER_REMORSE",
- "ITEM_DEFECT"
- ],
- "enumDescriptions": [
- "Default value. This value is unused.",
- "Buyer remorse.",
- "Item defect."
- ],
- "type": "string"
- },
- "returnShippingFee": {
- "$ref": "ReturnPolicyOnlineReturnShippingFee",
- "description": "The corresponding return shipping fee. This is only applicable when returnLabelSource is not the customer's responsibility."
- }
- },
- "type": "object"
- },
- "ReturnPolicyOnlineReturnShippingFee": {
- "description": "The return shipping fee. This can either be a fixed fee or a boolean to indicate that the customer pays the actual shipping cost.",
- "id": "ReturnPolicyOnlineReturnShippingFee",
- "properties": {
- "fixedFee": {
- "$ref": "PriceAmount",
- "description": "Fixed return shipping fee amount. This value is only applicable when type is FIXED. We will treat the return shipping fee as free if type is FIXED and this value is not set."
- },
- "type": {
- "description": "Type of return shipping fee.",
- "enum": [
- "TYPE_UNSPECIFIED",
- "FIXED",
- "CUSTOMER_PAYING_ACTUAL_FEE"
- ],
- "enumDescriptions": [
- "Default value. This value is unused.",
- "The return shipping fee is a fixed value.",
- "Customer will pay the actual return shipping fee."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "Row": {
- "id": "Row",
- "properties": {
- "cells": {
- "description": "The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables. Required.",
- "items": {
- "$ref": "Value"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "SearchRequest": {
- "description": "Request message for the ReportService.Search method.",
- "id": "SearchRequest",
- "properties": {
- "pageSize": {
- "description": "Number of ReportRows to retrieve in a single page. Defaults to 1000. Values above 5000 are coerced to 5000.",
- "format": "int32",
- "type": "integer"
- },
- "pageToken": {
- "description": "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"
- },
- "query": {
- "description": "Required. Query that defines performance metrics to retrieve and dimensions according to which the metrics are to be segmented. For details on how to construct your query, see the [Query Language guide](https://developers.google.com/shopping-content/guides/reports/query-language/overview).",
- "type": "string"
- }
- },
- "type": "object"
- },
- "SearchResponse": {
- "description": "Response message for the ReportService.Search method.",
- "id": "SearchResponse",
- "properties": {
- "nextPageToken": {
- "description": "Token which can be sent as `page_token` to retrieve the next page. If omitted, there are no subsequent pages.",
- "type": "string"
- },
- "results": {
- "description": "Rows that matched the search query.",
- "items": {
- "$ref": "ReportRow"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "Segments": {
- "description": "Dimensions according to which metrics are segmented in the response. Values of product dimensions, such as `offer_id`, reflect the state of a product at the time of the corresponding event, for example, impression or order. Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for dimensions requested explicitly in the request's search query.",
- "id": "Segments",
- "properties": {
- "brand": {
- "description": "Brand of the product.",
- "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.",
- "type": "string"
- },
- "categoryL2": {
- "description": "[Product category (2nd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy.",
- "type": "string"
- },
- "categoryL3": {
- "description": "[Product category (3rd level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy.",
- "type": "string"
- },
- "categoryL4": {
- "description": "[Product category (4th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy.",
- "type": "string"
- },
- "categoryL5": {
- "description": "[Product category (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in Google's product taxonomy.",
- "type": "string"
- },
- "currencyCode": {
- "description": "Currency in which price metrics are represented, for example, if you select `ordered_item_sales_micros`, the returned value will be represented by this currency.",
- "type": "string"
- },
- "customLabel0": {
- "description": "Custom label 0 for custom grouping of products.",
- "type": "string"
- },
- "customLabel1": {
- "description": "Custom label 1 for custom grouping of products.",
- "type": "string"
- },
- "customLabel2": {
- "description": "Custom label 2 for custom grouping of products.",
- "type": "string"
- },
- "customLabel3": {
- "description": "Custom label 3 for custom grouping of products.",
- "type": "string"
- },
- "customLabel4": {
- "description": "Custom label 4 for custom grouping of products.",
- "type": "string"
- },
- "customerCountryCode": {
- "description": "Code of the country where the customer is located at the time of the event. Represented in the ISO 3166 format. If the customer country cannot be determined, a special 'ZZ' code is returned.",
- "type": "string"
- },
- "date": {
- "$ref": "Date",
- "description": "Date in the merchant timezone to which metrics apply."
- },
- "offerId": {
- "description": "Merchant-provided id of the product.",
- "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.",
- "type": "string"
- },
- "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.",
- "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.",
- "type": "string"
- },
- "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.",
- "type": "string"
- },
- "productTypeL5": {
- "description": "[Product type (5th level)](https://developers.google.com/shopping-content/guides/reports/segmentation#category_and_product_type) in merchant's own product taxonomy.",
- "type": "string"
- },
- "program": {
- "description": "Program to which metrics apply, for example, Free Product Listing.",
- "enum": [
- "PROGRAM_UNSPECIFIED",
- "SHOPPING_ADS",
- "FREE_PRODUCT_LISTING",
- "FREE_LOCAL_PRODUCT_LISTING",
- "BUY_ON_GOOGLE_LISTING"
- ],
- "enumDescriptions": [
- "Not specified.",
- "Shopping Ads.",
- "Free Product Listing.",
- "Free Local Product Listing.",
- "*Deprecated*: This value is no longer supported. Retrieving all metrics for the `BUY_ON_GOOGLE_LISTING` program returns 0 starting from May 2024. Buy on Google Listing."
- ],
- "type": "string"
- },
- "title": {
- "description": "Title of the product.",
- "type": "string"
- },
- "week": {
- "$ref": "Date",
- "description": "First day of the week (Monday) of the metrics date in the merchant timezone."
- }
- },
- "type": "object"
- },
- "Service": {
- "id": "Service",
- "properties": {
- "active": {
- "description": "A boolean exposing the active status of the shipping service. Required.",
- "type": "boolean"
- },
- "currency": {
- "description": "The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.",
- "type": "string"
- },
- "deliveryCountry": {
- "description": "The CLDR territory code of the country to which the service applies. Required.",
- "type": "string"
- },
- "deliveryTime": {
- "$ref": "DeliveryTime",
- "description": "Time spent in various aspects from order to the delivery of the product. Required."
- },
- "eligibility": {
- "description": "Eligibility for this service. Acceptable values are: - \"`All scenarios`\" - \"`All scenarios except Shopping Actions`\" - \"`Shopping Actions`\" ",
- "type": "string"
- },
- "minimumOrderValue": {
- "$ref": "Price",
- "description": "Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table."
- },
- "minimumOrderValueTable": {
- "$ref": "MinimumOrderValueTable",
- "description": "Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value."
- },
- "name": {
- "description": "Free-form name of the service. Must be unique within target account. Required.",
- "type": "string"
- },
- "pickupService": {
- "$ref": "PickupCarrierService",
- "description": "The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved through the `getSupportedPickupServices` method. Required if and only if the service delivery type is `pickup`."
- },
- "rateGroups": {
- "description": "Shipping rate group definitions. Only the last one is allowed to have an empty `applicableShippingLabels`, which means \"everything else\". The other `applicableShippingLabels` must not overlap.",
- "items": {
- "$ref": "RateGroup"
- },
- "type": "array"
- },
- "shipmentType": {
- "description": "Type of locations this service ships orders to. Acceptable values are: - \"`delivery`\" - \"`pickup` (deprecated)\" - \"`local_delivery`\" - \"`collection_point`\" ",
- "type": "string"
- },
- "storeConfig": {
- "$ref": "ServiceStoreConfig",
- "description": "A list of stores your products are delivered from. This is only available for the local delivery shipment type."
- }
- },
- "type": "object"
- },
- "ServiceStoreConfig": {
- "description": "Stores that provide local delivery. Only valid with local delivery fulfillment.",
- "id": "ServiceStoreConfig",
- "properties": {
- "cutoffConfig": {
- "$ref": "ServiceStoreConfigCutoffConfig",
- "description": "Time local delivery ends for the day. This can be either `local_cutoff_time` or `store_close_offset_hours`, if both are provided an error is thrown."
- },
- "serviceRadius": {
- "$ref": "Distance",
- "description": "Maximum delivery radius. Only needed for local delivery fulfillment type."
- },
- "storeCodes": {
- "description": "A list of store codes that provide local delivery. If empty, then `store_service_type` must be `all_stores`, or an error is thrown. If not empty, then `store_service_type` must be `selected_stores`, or an error is thrown.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "storeServiceType": {
- "description": "Indicates whether all stores listed by this merchant provide local delivery or not. Acceptable values are `all stores` and `selected stores`",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ServiceStoreConfigCutoffConfig": {
- "description": "Time local delivery ends for the day based on the local timezone of the store. `local_cutoff_time` and `store_close_offset_hours` are mutually exclusive.",
- "id": "ServiceStoreConfigCutoffConfig",
- "properties": {
- "localCutoffTime": {
- "$ref": "ServiceStoreConfigCutoffConfigLocalCutoffTime",
- "description": "Time in hours and minutes in the local timezone when local delivery ends."
- },
- "noDeliveryPostCutoff": {
- "description": "Merchants can opt-out of showing n+1 day local delivery when they have a shipping service configured to n day local delivery. For example, if the shipping service defines same-day delivery, and it's past the cut-off, setting this field to `true` results in the calculated shipping service rate returning `NO_DELIVERY_POST_CUTOFF`. In the same example, setting this field to `false` results in the calculated shipping time being one day. This is only for local delivery.",
- "type": "boolean"
- },
- "storeCloseOffsetHours": {
- "description": "Represents cutoff time as the number of hours before store closing. Mutually exclusive with other fields (hour and minute).",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ServiceStoreConfigCutoffConfigLocalCutoffTime": {
- "description": "Time in hours and minutes in the local timezone when local delivery ends.",
- "id": "ServiceStoreConfigCutoffConfigLocalCutoffTime",
- "properties": {
- "hour": {
- "description": "Hour local delivery orders must be placed by to process the same day.",
- "format": "int64",
- "type": "string"
- },
- "minute": {
- "description": "Minute local delivery orders must be placed by to process the same day.",
- "format": "int64",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ShippingSettings": {
- "description": "The merchant account's shipping settings. All methods except getsupportedcarriers and getsupportedholidays require the admin role.",
- "id": "ShippingSettings",
- "properties": {
- "accountId": {
- "description": "The ID of the account to which these account shipping settings belong. Ignored upon update, always present in get request responses.",
- "format": "uint64",
- "type": "string"
- },
- "postalCodeGroups": {
- "description": "A list of postal code groups that can be referred to in `services`. Optional.",
- "items": {
- "$ref": "PostalCodeGroup"
- },
- "type": "array"
- },
- "services": {
- "description": "The target account's list of services. Optional.",
- "items": {
- "$ref": "Service"
- },
- "type": "array"
- },
- "warehouses": {
- "description": "Optional. A list of warehouses which can be referred to in `services`.",
- "items": {
- "$ref": "Warehouse"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ShippingsettingsCustomBatchRequest": {
- "id": "ShippingsettingsCustomBatchRequest",
- "properties": {
- "entries": {
- "description": "The request entries to be processed in the batch.",
- "items": {
- "$ref": "ShippingsettingsCustomBatchRequestEntry"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ShippingsettingsCustomBatchRequestEntry": {
- "description": "A batch entry encoding a single non-batch shippingsettings request.",
- "id": "ShippingsettingsCustomBatchRequestEntry",
- "properties": {
- "accountId": {
- "description": "The ID of the account for which to get/update account shipping settings.",
- "format": "uint64",
- "type": "string"
- },
- "batchId": {
- "description": "An entry ID, unique within the batch request.",
- "format": "uint32",
- "type": "integer"
- },
- "merchantId": {
- "description": "The ID of the managing account.",
- "format": "uint64",
- "type": "string"
- },
- "method": {
- "description": "The method of the batch entry. Acceptable values are: - \"`get`\" - \"`update`\" ",
- "type": "string"
- },
- "shippingSettings": {
- "$ref": "ShippingSettings",
- "description": "The account shipping settings to update. Only defined if the method is `update`."
- }
- },
- "type": "object"
- },
- "ShippingsettingsCustomBatchResponse": {
- "id": "ShippingsettingsCustomBatchResponse",
- "properties": {
- "entries": {
- "description": "The result of the execution of the batch requests.",
- "items": {
- "$ref": "ShippingsettingsCustomBatchResponseEntry"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#shippingsettingsCustomBatchResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ShippingsettingsCustomBatchResponseEntry": {
- "description": "A batch entry encoding a single non-batch shipping settings response.",
- "id": "ShippingsettingsCustomBatchResponseEntry",
- "properties": {
- "batchId": {
- "description": "The ID of the request entry to which this entry responds.",
- "format": "uint32",
- "type": "integer"
- },
- "errors": {
- "$ref": "Errors",
- "description": "A list of errors for failed custombatch entries. *Note:* Schema errors fail the whole request."
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#shippingsettingsCustomBatchResponseEntry`\"",
- "type": "string"
- },
- "shippingSettings": {
- "$ref": "ShippingSettings",
- "description": "The retrieved or updated account shipping settings."
- }
- },
- "type": "object"
- },
- "ShippingsettingsGetSupportedCarriersResponse": {
- "id": "ShippingsettingsGetSupportedCarriersResponse",
- "properties": {
- "carriers": {
- "description": "A list of supported carriers. May be empty.",
- "items": {
- "$ref": "CarriersCarrier"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#shippingsettingsGetSupportedCarriersResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ShippingsettingsGetSupportedHolidaysResponse": {
- "id": "ShippingsettingsGetSupportedHolidaysResponse",
- "properties": {
- "holidays": {
- "description": "A list of holidays applicable for delivery guarantees. May be empty.",
- "items": {
- "$ref": "HolidaysHoliday"
- },
- "type": "array"
- },
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#shippingsettingsGetSupportedHolidaysResponse`\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "ShippingsettingsGetSupportedPickupServicesResponse": {
- "id": "ShippingsettingsGetSupportedPickupServicesResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#shippingsettingsGetSupportedPickupServicesResponse`\".",
- "type": "string"
- },
- "pickupServices": {
- "description": "A list of supported pickup services. May be empty.",
- "items": {
- "$ref": "PickupServicesPickupService"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ShippingsettingsListResponse": {
- "id": "ShippingsettingsListResponse",
- "properties": {
- "kind": {
- "description": "Identifies what kind of resource this is. Value: the fixed string \"`content#shippingsettingsListResponse`\".",
- "type": "string"
- },
- "nextPageToken": {
- "description": "The token for the retrieval of the next page of shipping settings.",
- "type": "string"
- },
- "resources": {
- "items": {
- "$ref": "ShippingSettings"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ShoppingAdsProgramStatus": {
- "description": "Response message for GetShoppingAdsProgramStatus.",
- "id": "ShoppingAdsProgramStatus",
- "properties": {
- "globalState": {
- "description": "State of the program. `ENABLED` if there are offers for at least one region.",
- "enum": [
- "PROGRAM_STATE_UNSPECIFIED",
- "NOT_ENABLED",
- "NO_OFFERS_UPLOADED",
- "ENABLED"
- ],
- "enumDescriptions": [
- "State is unknown.",
- "Program is not enabled for any country.",
- "No products have been uploaded for any region. Upload products to Merchant Center.",
- "Program is enabled and offers are uploaded for at least one country."
- ],
- "type": "string"
- },
- "regionStatuses": {
- "description": "Status of the program in each region. Regions with the same status and review eligibility are grouped together in `regionCodes`.",
- "items": {
- "$ref": "ShoppingAdsProgramStatusRegionStatus"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ShoppingAdsProgramStatusRegionStatus": {
- "description": "Status of program and region.",
- "id": "ShoppingAdsProgramStatusRegionStatus",
- "properties": {
- "disapprovalDate": {
- "description": "Date by which eligibilityStatus will go from `WARNING` to `DISAPPROVED`. Only visible when your eligibilityStatus is WARNING. In [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DD`.",
- "type": "string"
- },
- "eligibilityStatus": {
- "description": "Eligibility status of the Shopping Ads program.",
- "enum": [
- "STATE_UNSPECIFIED",
- "APPROVED",
- "DISAPPROVED",
- "WARNING",
- "UNDER_REVIEW",
- "PENDING_REVIEW",
- "ONBOARDING"
- ],
- "enumDescriptions": [
- "State is not known.",
- "If the account has no issues and review is completed successfully.",
- "There are one or more issues that needs to be resolved for account to be active for the program. Detailed list of account issues are available in [accountstatuses](https://developers.google.com/shopping-content/reference/rest/v2.1/accountstatuses) API.",
- "If account has issues but offers are servable. Some of the issue can make account DISAPPROVED after a certain deadline.",
- "Account is under review.",
- "Account is waiting for review to start.",
- "Program is currently onboarding. Upload valid offers to complete onboarding."
- ],
- "type": "string"
- },
- "onboardingIssues": {
- "description": "Issues that must be fixed to be eligible for review.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "regionCodes": {
- "description": "The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) codes for all the regions with the same `eligibilityStatus` and `reviewEligibility`.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "reviewEligibilityStatus": {
- "description": "If a program is eligible for review in a specific region. Only visible if `eligibilityStatus` is `DISAPPROVED`.",
- "enum": [
- "REVIEW_ELIGIBILITY_UNSPECIFIED",
- "ELIGIBLE",
- "INELIGIBLE"
- ],
- "enumDescriptions": [
- "Review eligibility state is unknown.",
- "Account is eligible for review for a specified region code.",
- "Account is not eligible for review for a specified region code."
- ],
- "type": "string"
- },
- "reviewIneligibilityReason": {
- "description": "Review ineligibility reason if account is not eligible for review.",
- "enum": [
- "REVIEW_INELIGIBILITY_REASON_UNSPECIFIED",
- "ONBOARDING_ISSUES",
- "NOT_ENOUGH_OFFERS",
- "IN_COOLDOWN_PERIOD",
- "ALREADY_UNDER_REVIEW",
- "NO_REVIEW_REQUIRED",
- "WILL_BE_REVIEWED_AUTOMATICALLY",
- "IS_RETIRED",
- "ALREADY_REVIEWED"
- ],
- "enumDescriptions": [
- "Requesting a review from Google is not possible.",
- "All onboarding issues needs to be fixed.",
- "Not enough offers uploaded for this country.",
- "Cooldown period applies. Wait until cooldown period ends.",
- "Account is already under review.",
- "No issues available to review.",
- "Account will be automatically reviewed at the end of the grace period.",
- "Account is retired. Should not appear in MC.",
- "Account has already been reviewed. You can't request further reviews."
- ],
- "type": "string"
- },
- "reviewIneligibilityReasonDescription": {
- "description": "Reason a program in a specific region isn’t eligible for review. Only visible if `reviewEligibilityStatus` is `INELIGIBLE`.",
- "type": "string"
- },
- "reviewIneligibilityReasonDetails": {
- "$ref": "ShoppingAdsProgramStatusReviewIneligibilityReasonDetails",
- "description": "Additional information for ineligibility. If `reviewIneligibilityReason` is `IN_COOLDOWN_PERIOD`, a timestamp for the end of the cooldown period is provided."
- },
- "reviewIssues": {
- "description": "Issues evaluated in the review process. Fix all issues before requesting a review.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "ShoppingAdsProgramStatusReviewIneligibilityReasonDetails": {
- "description": "Additional details for review ineligibility reasons.",
- "id": "ShoppingAdsProgramStatusReviewIneligibilityReasonDetails",
- "properties": {
- "cooldownTime": {
- "description": "This timestamp represents end of cooldown period for review ineligbility reason `IN_COOLDOWN_PERIOD`.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Table": {
- "id": "Table",
- "properties": {
- "columnHeaders": {
- "$ref": "Headers",
- "description": "Headers of the table's columns. Optional: if not set then the table has only one dimension."
- },
- "name": {
- "description": "Name of the table. Required for subtables, ignored for the main table.",
- "type": "string"
- },
- "rowHeaders": {
- "$ref": "Headers",
- "description": "Headers of the table's rows. Required."
- },
- "rows": {
- "description": "The list of rows that constitute the table. Must have the same length as `rowHeaders`. Required.",
- "items": {
- "$ref": "Row"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "TextWithTooltip": {
- "description": "Block of text that may contain a tooltip with more information.",
- "id": "TextWithTooltip",
- "properties": {
- "simpleTooltipValue": {
- "description": "Value of the tooltip as a simple text.",
- "type": "string"
- },
- "simpleValue": {
- "description": "Value of the message as a simple text.",
- "type": "string"
- },
- "tooltipIconStyle": {
- "description": "The suggested type of an icon for tooltip, if a tooltip is present.",
- "enum": [
- "TOOLTIP_ICON_STYLE_UNSPECIFIED",
- "INFO",
- "QUESTION"
- ],
- "enumDescriptions": [
- "Default value. Will never be provided by the API.",
- "Used when the tooltip adds additional information to the context, the 'i' can be used as an icon.",
- "Used when the tooltip shows helpful information, the '?' can be used as an icon."
- ],
- "type": "string"
- }
- },
- "type": "object"
- },
- "TimePeriod": {
- "description": "A message that represents a time period.",
- "id": "TimePeriod",
- "properties": {
- "endTime": {
- "description": "The ending timestamp.",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "The starting timestamp.",
- "format": "google-datetime",
- "type": "string"
- }
- },
- "type": "object"
- },
- "TimeZone": {
- "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).",
- "id": "TimeZone",
- "properties": {
- "id": {
- "description": "IANA Time Zone Database time zone. For example \"America/New_York\".",
- "type": "string"
- },
- "version": {
- "description": "Optional. IANA Time Zone Database version number. For example \"2019a\".",
- "type": "string"
- }
- },
- "type": "object"
- },
- "TopicTrends": {
- "description": "Topic trends fields requested by the merchant in the query. Field values are only set if the merchant queries `TopicTrendsView`. Forecast data can be queried up to 13 weeks by passing a future date in the `date` field. Historical data is measured daily, and forecasted data is projected weekly. All data points are normalized based on the highest data points returned in the response. If you make separate queries with different date ranges, you might see different values for the same date in each response. The recommended way to get a trend score of a topic is `last7_days_search_interest / last{$day}_days_search_interest - 1`. You can view trends for up to eight topics at a time.",
- "id": "TopicTrends",
- "properties": {
- "customerCountryCode": {
- "description": "Country trends are calculated for. Must be a two-letter country code (ISO 3166-1-alpha-2 code), for example, `“US”`.",
- "type": "string"
- },
- "date": {
- "$ref": "Date",
- "description": "Date the trend score was retrieved."
- },
- "last120DaysSearchInterest": {
- "description": "Search interest in the last 120 days, with the same normalization as search_interest. This field is only present for a past date.",
- "format": "double",
- "type": "number"
- },
- "last30DaysSearchInterest": {
- "description": "Search interest in the last 30 days, with the same normalization as search_interest. This field is only present for a past date.",
- "format": "double",
- "type": "number"
- },
- "last7DaysSearchInterest": {
- "description": "Search interest in the last 7 days, with the same normalization as search_interest. This field is only present for a past date.",
- "format": "double",
- "type": "number"
- },
- "last90DaysSearchInterest": {
- "description": "Search interest in the last 90 days, with the same normalization as search_interest. This field is only present for a past date.",
- "format": "double",
- "type": "number"
- },
- "next7DaysSearchInterest": {
- "description": "Estimated search interest in the next 7 days, with the same normalization as search_interest. This field is only present for a future date.",
- "format": "double",
- "type": "number"
- },
- "searchInterest": {
- "description": "Daily search interest, normalized to the time and country to make comparisons easier, with 100 representing peak popularity (from 0 to 100) for the requested time period and location.",
- "format": "double",
- "type": "number"
- },
- "topic": {
- "description": "Google-provided topic trends are calculated for. Only top eight topics are returned. Topic is what shoppers are searching for on Google, grouped by the same concept.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "TransitTable": {
- "id": "TransitTable",
- "properties": {
- "postalCodeGroupNames": {
- "description": "A list of postal group names. The last value can be `\"all other locations\"`. Example: `[\"zone 1\", \"zone 2\", \"all other locations\"]`. The referred postal code groups must match the delivery country of the service.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "rows": {
- "items": {
- "$ref": "TransitTableTransitTimeRow"
- },
- "type": "array"
- },
- "transitTimeLabels": {
- "description": "A list of transit time labels. The last value can be `\"all other labels\"`. Example: `[\"food\", \"electronics\", \"all other labels\"]`.",
- "items": {
- "type": "string"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "TransitTableTransitTimeRow": {
- "id": "TransitTableTransitTimeRow",
- "properties": {
- "values": {
- "items": {
- "$ref": "TransitTableTransitTimeRowTransitTimeValue"
- },
- "type": "array"
- }
- },
- "type": "object"
- },
- "TransitTableTransitTimeRowTransitTimeValue": {
- "id": "TransitTableTransitTimeRowTransitTimeValue",
- "properties": {
- "maxTransitTimeInDays": {
- "description": "Must be greater than or equal to `minTransitTimeInDays`.",
- "format": "uint32",
- "type": "integer"
- },
- "minTransitTimeInDays": {
- "description": "Transit time range (min-max) in business days. 0 means same day delivery, 1 means next day delivery.",
- "format": "uint32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "TriggerActionPayload": {
- "description": "The payload for the triggered action.",
- "id": "TriggerActionPayload",
- "properties": {
- "actionContext": {
- "description": "Required. The context from the selected action. The value is obtained from rendered issues and needs to be sent back to identify the action that is being triggered.",
- "type": "string"
- },
- "actionInput": {
- "$ref": "ActionInput",
- "description": "Required. Input provided by the merchant."
- }
- },
- "type": "object"
- },
- "TriggerActionResponse": {
- "description": "Response informing about the started action.",
- "id": "TriggerActionResponse",
- "properties": {
- "message": {
- "description": "The message for merchant.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "UndeleteConversionSourceRequest": {
- "description": "Request message for the UndeleteConversionSource method.",
- "id": "UndeleteConversionSourceRequest",
- "properties": {},
- "type": "object"
- },
- "UrlSettings": {
- "description": "Specifications related to the `Checkout` URL. The `UriTemplate` is of the form `https://www.mystore.com/checkout?item_id={id}` where `{id}` will be automatically replaced with data from the merchant account with this attribute [offer_id](https://developers.google.com/shopping-content/reference/rest/v2.1/products#Product.FIELDS.offer_id)",
- "id": "UrlSettings",
- "properties": {
- "cartUriTemplate": {
- "description": "URL template when the placeholders are expanded will redirect the buyer to the cart page on the merchant website with the selected item in cart.",
- "type": "string"
- },
- "checkoutUriTemplate": {
- "description": "URL template when the placeholders are expanded will redirect the buyer to the merchant checkout page with the item in the cart.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Value": {
- "description": "The single value of a rate group or the value of a rate group table's cell. Exactly one of `noShipping`, `flatRate`, `pricePercentage`, `carrierRateName`, `subtableName` must be set.",
- "id": "Value",
- "properties": {
- "carrierRateName": {
- "description": "The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.",
- "type": "string"
- },
- "flatRate": {
- "$ref": "Price",
- "description": "A flat rate. Can only be set if all other fields are not set."
- },
- "noShipping": {
- "description": "If true, then the product can't ship. Must be true when set, can only be set if all other fields are not set.",
- "type": "boolean"
- },
- "pricePercentage": {
- "description": "A percentage of the price represented as a number in decimal notation (for example, `\"5.4\"`). Can only be set if all other fields are not set.",
- "type": "string"
- },
- "subtableName": {
- "description": "The name of a subtable. Can only be set in table cells (not for single values), and only if all other fields are not set.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "VerifyPhoneNumberRequest": {
- "description": "Request message for the VerifyPhoneNumber method.",
- "id": "VerifyPhoneNumberRequest",
- "properties": {
- "phoneVerificationMethod": {
- "description": "Verification method used to receive verification code.",
- "enum": [
- "PHONE_VERIFICATION_METHOD_UNSPECIFIED",
- "SMS",
- "PHONE_CALL"
- ],
- "enumDescriptions": [
- "Unknown method.",
- "Receive verification code by SMS.",
- "Receive verification code by phone call."
- ],
- "type": "string"
- },
- "verificationCode": {
- "description": "The verification code that was sent to the phone number for validation.",
- "type": "string"
- },
- "verificationId": {
- "description": "The verification ID returned by `requestphoneverification`.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "VerifyPhoneNumberResponse": {
- "description": "Response message for the VerifyPhoneNumber method.",
- "id": "VerifyPhoneNumberResponse",
- "properties": {
- "verifiedPhoneNumber": {
- "description": "Verified phone number if verification is successful. This phone number can only be replaced by another verified phone number.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "Warehouse": {
- "description": "A fulfillment warehouse, which stores and handles inventory.",
- "id": "Warehouse",
- "properties": {
- "businessDayConfig": {
- "$ref": "BusinessDayConfig",
- "description": "Business days of the warehouse. If not set, will be Monday to Friday by default."
- },
- "cutoffTime": {
- "$ref": "WarehouseCutoffTime",
- "description": "Required. The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code."
- },
- "handlingDays": {
- "description": "Required. The number of days it takes for this warehouse to pack up and ship an item. This is on the warehouse level, but can be overridden on the offer level based on the attributes of an item.",
- "format": "int64",
- "type": "string"
- },
- "name": {
- "description": "Required. The name of the warehouse. Must be unique within account.",
- "type": "string"
- },
- "shippingAddress": {
- "$ref": "Address",
- "description": "Required. Shipping address of the warehouse."
- }
- },
- "type": "object"
- },
- "WarehouseBasedDeliveryTime": {
- "id": "WarehouseBasedDeliveryTime",
- "properties": {
- "carrier": {
- "description": "Required. Carrier, such as `\"UPS\"` or `\"Fedex\"`. The list of supported carriers can be retrieved through the `listSupportedCarriers` method.",
- "type": "string"
- },
- "carrierService": {
- "description": "Required. Carrier service, such as `\"ground\"` or `\"2 days\"`. The list of supported services for a carrier can be retrieved through the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list.",
- "type": "string"
- },
- "originAdministrativeArea": {
- "description": "Shipping origin's state.",
- "type": "string"
- },
- "originCity": {
- "description": "Shipping origin's city.",
- "type": "string"
- },
- "originCountry": {
- "description": "Shipping origin's country represented as a [CLDR territory code](https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml).",
- "type": "string"
- },
- "originPostalCode": {
- "description": "Shipping origin.",
- "type": "string"
- },
- "originStreetAddress": {
- "description": "Shipping origin's street address.",
- "type": "string"
- },
- "warehouseName": {
- "description": "The name of the warehouse. Warehouse name need to be matched with name. If warehouseName is set, the below fields will be ignored. The warehouse info will be read from warehouse.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "WarehouseCutoffTime": {
- "id": "WarehouseCutoffTime",
- "properties": {
- "hour": {
- "description": "Required. Hour (24-hour clock) of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Hour is based on the timezone of warehouse.",
- "format": "int32",
- "type": "integer"
- },
- "minute": {
- "description": "Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Minute is based on the timezone of warehouse.",
- "format": "int32",
- "type": "integer"
- }
- },
- "type": "object"
- },
- "Weight": {
- "id": "Weight",
- "properties": {
- "unit": {
- "description": "Required. The weight unit. Acceptable values are: - \"`kg`\" - \"`lb`\" ",
- "type": "string"
- },
- "value": {
- "description": "Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.",
- "type": "string"
- }
- },
- "type": "object"
- }
- },
- "servicePath": "content/v2.1/",
- "title": "Content API for Shopping",
- "version": "v2.1"
-}
\ No newline at end of file
diff --git a/discovery/curationpartners-v1.json b/discovery/curationpartners-v1.json
new file mode 100644
index 00000000000..6c0b10ed5f1
--- /dev/null
+++ b/discovery/curationpartners-v1.json
@@ -0,0 +1,2397 @@
+{
+ "auth": {
+ "oauth2": {
+ "scopes": {
+ "https://www.googleapis.com/auth/curation-partners": {
+ "description": "See, create, edit, and delete data entities in your Curation account."
+ }
+ }
+ }
+ },
+ "basePath": "",
+ "baseUrl": "https://curationpartners.googleapis.com/",
+ "batchPath": "batch",
+ "canonicalName": "CurationPartners",
+ "description": "Curation partners API is an externally available HTTP API for curators to programmatically manage their data segments and curated packages used by ad agencies.",
+ "discoveryVersion": "v1",
+ "documentationLink": "https://developers.google.com/authorized-buyers/curation/apis/guides/curationpartners/overview",
+ "fullyEncodeReservedExpansion": true,
+ "icons": {
+ "x16": "http://www.google.com/images/icons/product/search-16.gif",
+ "x32": "http://www.google.com/images/icons/product/search-32.gif"
+ },
+ "id": "curationpartners:v1",
+ "kind": "discovery#restDescription",
+ "mtlsRootUrl": "https://curationpartners.mtls.googleapis.com/",
+ "name": "curationpartners",
+ "ownerDomain": "google.com",
+ "ownerName": "Google",
+ "parameters": {
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "access_token": {
+ "description": "OAuth access token.",
+ "location": "query",
+ "type": "string"
+ },
+ "alt": {
+ "default": "json",
+ "description": "Data format for response.",
+ "enum": [
+ "json",
+ "media",
+ "proto"
+ ],
+ "enumDescriptions": [
+ "Responses with Content-Type of application/json",
+ "Media download with context-dependent Content-Type",
+ "Responses with Content-Type of application/x-protobuf"
+ ],
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "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"
+ },
+ "oauth_token": {
+ "description": "OAuth 2.0 token for the current user.",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "quotaUser": {
+ "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "protocol": "rest",
+ "resources": {
+ "curators": {
+ "resources": {
+ "curatedPackages": {
+ "methods": {
+ "activate": {
+ "description": "Activates an existing curated package.",
+ "flatPath": "v1/curators/{curatorsId}/curatedPackages/{curatedPackagesId}:activate",
+ "httpMethod": "POST",
+ "id": "curationpartners.curators.curatedPackages.activate",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the curated package to activate. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`",
+ "location": "path",
+ "pattern": "^curators/[^/]+/curatedPackages/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}:activate",
+ "request": {
+ "$ref": "ActivateCuratedPackageRequest"
+ },
+ "response": {
+ "$ref": "CuratedPackage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ },
+ "create": {
+ "description": "Creates a new curated package.",
+ "flatPath": "v1/curators/{curatorsId}/curatedPackages",
+ "httpMethod": "POST",
+ "id": "curationpartners.curators.curatedPackages.create",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The parent curator account where this curated package will be created. Format: `curators/{accountId}`",
+ "location": "path",
+ "pattern": "^curators/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/curatedPackages",
+ "request": {
+ "$ref": "CuratedPackage"
+ },
+ "response": {
+ "$ref": "CuratedPackage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ },
+ "deactivate": {
+ "description": "Deactivates an existing curated package.",
+ "flatPath": "v1/curators/{curatorsId}/curatedPackages/{curatedPackagesId}:deactivate",
+ "httpMethod": "POST",
+ "id": "curationpartners.curators.curatedPackages.deactivate",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the curated package to deactivate. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`",
+ "location": "path",
+ "pattern": "^curators/[^/]+/curatedPackages/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}:deactivate",
+ "request": {
+ "$ref": "DeactivateCuratedPackageRequest"
+ },
+ "response": {
+ "$ref": "CuratedPackage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ },
+ "get": {
+ "description": "Gets a curated package given its resource name.",
+ "flatPath": "v1/curators/{curatorsId}/curatedPackages/{curatedPackagesId}",
+ "httpMethod": "GET",
+ "id": "curationpartners.curators.curatedPackages.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the curated package to retrieve. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`",
+ "location": "path",
+ "pattern": "^curators/[^/]+/curatedPackages/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "CuratedPackage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ },
+ "list": {
+ "description": "Lists curated packages owned by the specified curator.",
+ "flatPath": "v1/curators/{curatorsId}/curatedPackages",
+ "httpMethod": "GET",
+ "id": "curationpartners.curators.curatedPackages.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * displayName * createTime * updateTime * state * feeCpm.currencyCode * feeCpm.units * feeCpm.nanos * floorPriceCpm.currencyCode * floorPriceCpm.units * floorPriceCpm.nanos",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Optional. A page token, received from a previous `ListCuratedPackages` call. Provide this to retrieve the subsequent page.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Required. The parent curator account which owns this collection of curated packages. Format: `curators/{accountId}`",
+ "location": "path",
+ "pattern": "^curators/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/curatedPackages",
+ "response": {
+ "$ref": "ListCuratedPackagesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ },
+ "patch": {
+ "description": "Updates an existing curated package.",
+ "flatPath": "v1/curators/{curatorsId}/curatedPackages/{curatedPackagesId}",
+ "httpMethod": "PATCH",
+ "id": "curationpartners.curators.curatedPackages.patch",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`",
+ "location": "path",
+ "pattern": "^curators/[^/]+/curatedPackages/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement (the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "CuratedPackage"
+ },
+ "response": {
+ "$ref": "CuratedPackage"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ }
+ }
+ },
+ "dataSegments": {
+ "methods": {
+ "activate": {
+ "description": "Activates a data segment.",
+ "flatPath": "v1/curators/{curatorsId}/dataSegments/{dataSegmentsId}:activate",
+ "httpMethod": "POST",
+ "id": "curationpartners.curators.dataSegments.activate",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. Name of data segment to activate. Format: `curators/{accountId}/dataSegments/{curatorDataSegmentId}`",
+ "location": "path",
+ "pattern": "^curators/[^/]+/dataSegments/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}:activate",
+ "request": {
+ "$ref": "ActivateDataSegmentRequest"
+ },
+ "response": {
+ "$ref": "DataSegment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ },
+ "create": {
+ "description": "Creates a data segment owned by the listed curator. The data segment will be created in the `ACTIVE` state, meaning it will be immediately available for buyers to use in preferred deals, private auction deals, and auction packages.",
+ "flatPath": "v1/curators/{curatorsId}/dataSegments",
+ "httpMethod": "POST",
+ "id": "curationpartners.curators.dataSegments.create",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The parent resource where this data segment will be created. Format: `curators/{accountId}`",
+ "location": "path",
+ "pattern": "^curators/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/dataSegments",
+ "request": {
+ "$ref": "DataSegment"
+ },
+ "response": {
+ "$ref": "DataSegment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ },
+ "deactivate": {
+ "description": "Deactivates a data segment.",
+ "flatPath": "v1/curators/{curatorsId}/dataSegments/{dataSegmentsId}:deactivate",
+ "httpMethod": "POST",
+ "id": "curationpartners.curators.dataSegments.deactivate",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. Name of data segment to deactivate. Format: `curators/{accountId}/dataSegments/{curatorDataSegmentId}`",
+ "location": "path",
+ "pattern": "^curators/[^/]+/dataSegments/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}:deactivate",
+ "request": {
+ "$ref": "DeactivateDataSegmentRequest"
+ },
+ "response": {
+ "$ref": "DataSegment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ },
+ "get": {
+ "description": "Gets a data segment given its name.",
+ "flatPath": "v1/curators/{curatorsId}/dataSegments/{dataSegmentsId}",
+ "httpMethod": "GET",
+ "id": "curationpartners.curators.dataSegments.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. Name of data segment to get. Format: `curators/{accountId}/dataSegments/{curatorDataSegmentId}`",
+ "location": "path",
+ "pattern": "^curators/[^/]+/dataSegments/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "DataSegment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ },
+ "list": {
+ "description": "List the data segments owned by a curator.",
+ "flatPath": "v1/curators/{curatorsId}/dataSegments",
+ "httpMethod": "GET",
+ "id": "curationpartners.curators.dataSegments.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageSize": {
+ "description": "Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Optional. The page token as returned. ListDataSegmentsResponse.nextPageToken",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Required. Name of the parent curator that can access the data segment. Format: `curators/{accountId}`",
+ "location": "path",
+ "pattern": "^curators/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/dataSegments",
+ "response": {
+ "$ref": "ListDataSegmentsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ },
+ "patch": {
+ "description": "Updates a data segment.",
+ "flatPath": "v1/curators/{curatorsId}/dataSegments/{dataSegmentsId}",
+ "httpMethod": "PATCH",
+ "id": "curationpartners.curators.dataSegments.patch",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}`",
+ "location": "path",
+ "pattern": "^curators/[^/]+/dataSegments/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "DataSegment"
+ },
+ "response": {
+ "$ref": "DataSegment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ }
+ }
+ },
+ "reports": {
+ "methods": {
+ "create": {
+ "description": "Creates a `Report` object.",
+ "flatPath": "v1/curators/{curatorsId}/reports",
+ "httpMethod": "POST",
+ "id": "curationpartners.curators.reports.create",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Required. The parent resource where this `Report` will be created. Format: `curators/{account_id}`",
+ "location": "path",
+ "pattern": "^curators/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/reports",
+ "request": {
+ "$ref": "Report"
+ },
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a `Report` object.",
+ "flatPath": "v1/curators/{curatorsId}/reports/{reportsId}",
+ "httpMethod": "DELETE",
+ "id": "curationpartners.curators.reports.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. Resource name of the report to delete. Format: `curators/{account_id}/reports/{report_id}`",
+ "location": "path",
+ "pattern": "^curators/[^/]+/reports/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Empty"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a `Report` object.",
+ "flatPath": "v1/curators/{curatorsId}/reports/{reportsId}",
+ "httpMethod": "GET",
+ "id": "curationpartners.curators.reports.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The resource name of the report. Format: `curators/{account_id}/reports/{report_id}`",
+ "location": "path",
+ "pattern": "^curators/[^/]+/reports/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ },
+ "list": {
+ "description": "Lists `Report` objects.",
+ "flatPath": "v1/curators/{curatorsId}/reports",
+ "httpMethod": "GET",
+ "id": "curationpartners.curators.reports.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters",
+ "location": "query",
+ "type": "string"
+ },
+ "orderBy": {
+ "description": "Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional. The maximum number of `Reports` to return. The service may return fewer than this value. If unspecified, at most 50 `Reports` will be returned. The maximum value is 1000; values greater than 1000 will be coerced to 1000.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Optional. A page token, received from a previous `ListReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReports` must match the call that provided the page token.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Required. The parent, which owns this collection of reports. Format: `curators/{account_id}`",
+ "location": "path",
+ "pattern": "^curators/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "skip": {
+ "description": "Optional. Number of individual resources to skip while paginating.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ }
+ },
+ "path": "v1/{+parent}/reports",
+ "response": {
+ "$ref": "ListReportsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ },
+ "patch": {
+ "description": "Updates a `Report` object.",
+ "flatPath": "v1/curators/{curatorsId}/reports/{reportsId}",
+ "httpMethod": "PATCH",
+ "id": "curationpartners.curators.reports.patch",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Identifier. The resource name of the report. Report resource name have the form: `curators/{account_id}/reports/{report_id}`",
+ "location": "path",
+ "pattern": "^curators/[^/]+/reports/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "updateMask": {
+ "description": "Optional. The list of fields to update.",
+ "format": "google-fieldmask",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "request": {
+ "$ref": "Report"
+ },
+ "response": {
+ "$ref": "Report"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ },
+ "run": {
+ "description": "Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation using `OperationsService.GetOperation`. Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain a `RunReportResponse` in its response field containing a report_result that can be passed to the `FetchReportResultRows` method to retrieve the report data.",
+ "flatPath": "v1/curators/{curatorsId}/reports/{reportsId}:run",
+ "httpMethod": "POST",
+ "id": "curationpartners.curators.reports.run",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The report to run. Format: `curators/{account_id}/reports/{report_id}`",
+ "location": "path",
+ "pattern": "^curators/[^/]+/reports/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}:run",
+ "request": {
+ "$ref": "RunReportRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ }
+ },
+ "resources": {
+ "operations": {
+ "methods": {
+ "get": {
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
+ "flatPath": "v1/curators/{curatorsId}/reports/{reportsId}/operations/{operationsId}",
+ "httpMethod": "GET",
+ "id": "curationpartners.curators.reports.operations.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The name of the operation resource.",
+ "location": "path",
+ "pattern": "^curators/[^/]+/reports/[^/]+/operations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ }
+ }
+ },
+ "results": {
+ "methods": {
+ "fetchRows": {
+ "description": "Returns the result rows from a completed report. The caller must have previously called `RunReport` and waited for that operation to complete. The rows will be returned according to the order specified by the `sorts` member of the report definition.",
+ "flatPath": "v1/curators/{curatorsId}/reports/{reportsId}/results/{resultsId}:fetchRows",
+ "httpMethod": "GET",
+ "id": "curationpartners.curators.reports.results.fetchRows",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "The report result being fetched. Format: `curators/{account_id}/reports/{report_id}/results/{report_result_id}`",
+ "location": "path",
+ "pattern": "^curators/[^/]+/reports/[^/]+/results/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional. The maximum number of rows to return. The service may return fewer than this value. If unspecified, at most 1,000 rows will be returned. The maximum value is 10,000; values greater than 10,000 will be reduced to 10,000.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Optional. A page token, received from a previous `FetchReportResultRows` call. Provide this to retrieve the second and subsequent batches of rows.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}:fetchRows",
+ "response": {
+ "$ref": "FetchReportResultRowsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "mediaPlanners": {
+ "methods": {
+ "list": {
+ "description": "Lists all media planner accounts that the caller has access to. For curators, this will return all media planners that have accepted curator terms. For other accounts, attempting to list media planners will return an error.",
+ "flatPath": "v1/mediaPlanners",
+ "httpMethod": "GET",
+ "id": "curationpartners.mediaPlanners.list",
+ "parameterOrder": [],
+ "parameters": {
+ "filter": {
+ "description": "Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Supported columns for filtering are: * `name` * `displayName` * `ancestorNames`",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "The maximum number of media planners to return. If unspecified, at most 100 media planners will be returned. The maximum value is 500; values above 500 will be coerced to 500.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Optional. A token identifying a page of results the server should return.This value is received from a previous `ListMediaPlanners` call in ListMediaPlannersResponse.nextPageToken.",
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/mediaPlanners",
+ "response": {
+ "$ref": "ListMediaPlannersResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/curation-partners"
+ ]
+ }
+ }
+ }
+ },
+ "revision": "20260828",
+ "rootUrl": "https://curationpartners.googleapis.com/",
+ "schemas": {
+ "AccessControlSettings": {
+ "description": "Settings for controlling access to a curated package.",
+ "id": "AccessControlSettings",
+ "properties": {
+ "allowlistedMediaPlanners": {
+ "description": "Required. Immutable. The list of media planners that are explicitly granted access to the curated package. Eligible media planners can be found in the mediaPlanners.list method. Only a single media planner may be allowlisted at this time. Format: `mediaPlanners/{mediaPlannerAccountId}`",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ActivateCuratedPackageRequest": {
+ "description": "Request message for ActivateCuratedPackage.",
+ "id": "ActivateCuratedPackageRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "ActivateDataSegmentRequest": {
+ "description": "Request message for activating a data segment",
+ "id": "ActivateDataSegmentRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "AdSize": {
+ "description": "Represents size of a single ad slot, or a creative.",
+ "id": "AdSize",
+ "properties": {
+ "height": {
+ "description": "The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.",
+ "format": "int64",
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of the ad slot size.",
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "PIXEL",
+ "INTERSTITIAL",
+ "NATIVE",
+ "FLUID"
+ ],
+ "enumDescriptions": [
+ "A placeholder for an undefined size type.",
+ "Ad slot with size specified by height and width in pixels.",
+ "Special size to describe an interstitial ad slot.",
+ "Native (mobile) ads rendered by the publisher.",
+ "Fluid size (responsive size) can be resized automatically with the change of outside environment."
+ ],
+ "type": "string"
+ },
+ "width": {
+ "description": "The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "CriteriaTargeting": {
+ "description": "Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax.",
+ "id": "CriteriaTargeting",
+ "properties": {
+ "excludedCriteriaIds": {
+ "description": "A list of numeric IDs to be excluded.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "targetedCriteriaIds": {
+ "description": "A list of numeric IDs to be included.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "CuratedPackage": {
+ "description": "Represents a curated package of inventory created and managed by a Curator.",
+ "id": "CuratedPackage",
+ "properties": {
+ "accessSettings": {
+ "$ref": "AccessControlSettings",
+ "description": "Required. Settings for controlling access to the curated package. Access to this curated package is limited to the allowlisted media planners and the creator. Buyers and bidders can not be allowlisted for or have direct access to this resource."
+ },
+ "createTime": {
+ "description": "Output only. The timestamp when the curated package was created. Can be used to filter the response of the curatedPackages.list method.",
+ "format": "google-datetime",
+ "readOnly": true,
+ "type": "string"
+ },
+ "curationFeeVisibility": {
+ "description": "Optional. Immutable. The visibility of the combined curation package fee and data segment fees (the total curation fee).",
+ "enum": [
+ "CURATION_FEE_VISIBILITY_UNSPECIFIED",
+ "DISCLOSED",
+ "NON_DISCLOSED"
+ ],
+ "enumDescriptions": [
+ "The total curation fee visibility is unspecified.",
+ "The total curation fee is visible to all buyers. This is the default value if not set.",
+ "The total curation fee is not visible to all buyers."
+ ],
+ "type": "string"
+ },
+ "description": {
+ "description": "Optional. A description of the curated package, provided by the curator.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Required. The display name assigned to the curated package by the curator. Can be used to filter the response of the curatedPackages.list method.",
+ "type": "string"
+ },
+ "feeCpm": {
+ "$ref": "Money",
+ "description": "Optional. The CPM fee charged by the curator to buyers using this curated package. Can be used to filter the response of the curatedPackages.list method."
+ },
+ "floorPriceCpm": {
+ "$ref": "Money",
+ "description": "Optional. The minimum CPM a buyer has to bid to participate in auctions for inventory in this curated package. Can be used to filter the response of the curatedPackages.list method."
+ },
+ "millipercentOfMediaFee": {
+ "description": "Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Identifier. The unique resource name for the curated package. Format: `curators/{accountId}/curatedPackages/{curatedPackageId}`",
+ "type": "string"
+ },
+ "state": {
+ "description": "Output only. The state of the curated package. Can be used to filter the response of the curatedPackages.list method.",
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "ACTIVE",
+ "INACTIVE"
+ ],
+ "enumDescriptions": [
+ "Default value.",
+ "The curated package is active.",
+ "The curated package is inactive."
+ ],
+ "readOnly": true,
+ "type": "string"
+ },
+ "targeting": {
+ "$ref": "PackageTargeting",
+ "description": "Optional. Targeting criteria for the curated package."
+ },
+ "updateTime": {
+ "description": "Output only. The timestamp when the curated package was last updated. Can be used to filter the response of the curatedPackages.list method.",
+ "format": "google-datetime",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DataSegment": {
+ "description": "Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms. -- Next ID: 9 --",
+ "id": "DataSegment",
+ "properties": {
+ "cpmFee": {
+ "$ref": "Money",
+ "description": "Optional. A fixed fee charged per thousand impressions. Once set, the currency code cannot be changed."
+ },
+ "createTime": {
+ "description": "Output only. Time the data segment was created.",
+ "format": "google-datetime",
+ "readOnly": true,
+ "type": "string"
+ },
+ "millipercentOfMediaFee": {
+ "description": "Optional. The fee will be charged as a percentage of the impression cost, represented in millipercent. For example, 1% is represented as 1000.",
+ "format": "int64",
+ "type": "string"
+ },
+ "name": {
+ "description": "Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `curators/{curatorAccountId}/dataSegments/{curatorDataSegmentId}`",
+ "type": "string"
+ },
+ "state": {
+ "description": "Output only. The state of the data segment.",
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "ACTIVE",
+ "INACTIVE",
+ "SUSPENDED"
+ ],
+ "enumDescriptions": [
+ "Default value.",
+ "The data segment is active.",
+ "The data segment is inactive.",
+ "The data segment is suspended and cannot be activated."
+ ],
+ "readOnly": true,
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Output only. Time the data segment was last updated.",
+ "format": "google-datetime",
+ "readOnly": true,
+ "type": "string"
+ },
+ "userListId": {
+ "description": "Optional. Immutable. The ID of the User List wrapped by this Data Segment. Curators with a linked Data Partner account can create a data segment that wraps a user list owned by the linked Data Partner account. User lists can be uploaded and managed using the [Data Manager API](https://developers.google.com/data-manager/api/data-partners/audiences). Linking a user list to a data segment lets you define a segment of inventory that is based on an audience you create.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Date": {
+ "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",
+ "id": "Date",
+ "properties": {
+ "day": {
+ "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",
+ "type": "integer"
+ },
+ "month": {
+ "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "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"
+ }
+ },
+ "type": "object"
+ },
+ "DateRange": {
+ "description": "A date range for a report.",
+ "id": "DateRange",
+ "properties": {
+ "fixed": {
+ "$ref": "FixedDateRange",
+ "description": "A fixed date range."
+ },
+ "relative": {
+ "description": "A relative date range.",
+ "enum": [
+ "RELATIVE_DATE_RANGE_UNSPECIFIED",
+ "TODAY",
+ "YESTERDAY",
+ "THIS_WEEK_TO_DATE",
+ "THIS_WEEK_TO_YESTERDAY",
+ "THIS_MONTH_TO_DATE",
+ "THIS_MONTH_TO_YESTERDAY",
+ "THIS_QUARTER_TO_DATE",
+ "THIS_QUARTER_TO_YESTERDAY",
+ "THIS_YEAR_TO_DATE",
+ "THIS_YEAR_TO_YESTERDAY",
+ "LAST_WEEK",
+ "LAST_WEEK_STARTING_SUNDAY",
+ "LAST_MONTH",
+ "LAST_QUARTER",
+ "LAST_YEAR",
+ "LAST_7_DAYS",
+ "LAST_30_DAYS",
+ "LAST_60_DAYS",
+ "LAST_90_DAYS",
+ "LAST_93_DAYS",
+ "LAST_180_DAYS",
+ "LAST_360_DAYS",
+ "LAST_365_DAYS",
+ "LAST_3_MONTHS",
+ "LAST_6_MONTHS",
+ "LAST_12_MONTHS",
+ "ALL_AVAILABLE"
+ ],
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "The date the report is run.",
+ "The date a day before the date that the report is run.",
+ "From the beginning of the calendar week in which the up to and including the day the report is run.",
+ "From the beginning of the calendar week in which the report is run, up to and including the day before the report is run.",
+ "From the beginning of the calendar month in which the report is run, to up to and including the day the report is run.",
+ "From the beginning of the calendar month in which the report is run, up to and including the day before the report is run.",
+ "From the beginning of the calendar quarter in which the report is run, up to and including the day the report is run.",
+ "From the beginning of the calendar quarter in which the report is run, up to and including the day before the report is run.",
+ "From the beginning of the calendar year in which the report is run, to up to and including the day the report is run.",
+ "From the beginning of the calendar year in which the report is run, to up to and including the day before the report is run.",
+ "The entire previous calendar week, Monday to Sunday (inclusive), preceding the calendar week the report is run.",
+ "The entire previous calendar week, Sunday to Saturday (inclusive), preceding the calendar week the report is run.",
+ "The entire previous calendar month preceding the calendar month the report is run.",
+ "The entire previous calendar quarter preceding the calendar quarter the report is run.",
+ "The entire previous calendar year preceding the calendar year the report is run.",
+ "The 7 days preceding the day the report is run.",
+ "The 30 days preceding the day the report is run.",
+ "The 60 days preceding the day the report is run.",
+ "The 90 days preceding the day the report is run.",
+ "The 93 days preceding the day the report is run.",
+ "The 180 days preceding the day the report is run.",
+ "The 360 days preceding the day the report is run.",
+ "The 365 days preceding the day the report is run.",
+ "The entire previous 3 calendar months preceding the calendar month the report is run.",
+ "The entire previous 6 calendar months preceding the calendar month the report is run.",
+ "The entire previous 12 calendar months preceding the calendar month the report is run.",
+ "From 3 years before the report is run, to the day before the report is run, inclusive."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DeactivateCuratedPackageRequest": {
+ "description": "Request message for DeactivateCuratedPackage.",
+ "id": "DeactivateCuratedPackageRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "DeactivateDataSegmentRequest": {
+ "description": "Request message for deactivating a data segment",
+ "id": "DeactivateDataSegmentRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "DoubleList": {
+ "description": "A list of double values.",
+ "id": "DoubleList",
+ "properties": {
+ "values": {
+ "description": "The values",
+ "items": {
+ "format": "double",
+ "type": "number"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "FetchReportResultRowsResponse": {
+ "description": "The response message for the fetch report result rows endpoint.",
+ "id": "FetchReportResultRowsResponse",
+ "properties": {
+ "dateRanges": {
+ "description": "The computed fixed date ranges this report includes. Only returned with the first page of results (when page_token is not included in the request).",
+ "items": {
+ "$ref": "FixedDateRange"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+ "type": "string"
+ },
+ "rows": {
+ "description": "Up to `page_size` rows of report data.",
+ "items": {
+ "$ref": "Row"
+ },
+ "type": "array"
+ },
+ "runTime": {
+ "description": "The time at which the report was scheduled to run. For non-scheduled reports, this is the time at which the report was requested to be run.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "totalRowCount": {
+ "description": "The total number of rows available from this report. Useful for pagination. Only returned with the first page of results (when page_token is not included in the request).",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "Field": {
+ "description": "A dimension or a metric in a report.",
+ "id": "Field",
+ "properties": {
+ "dimension": {
+ "description": "The dimension this field represents.",
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ADVERTISER_DOMAIN",
+ "COUNTRY",
+ "CURATION_DATA_SEGMENT_ID",
+ "CURATION_DATA_SEGMENT_RESPONSE_STATUS",
+ "CURATION_DATA_SEGMENT_RESPONSE_STATUS_NAME",
+ "CURATOR_FEE_TYPE",
+ "DATE",
+ "DEAL_ID",
+ "DEAL_NAME",
+ "DETECTED_ADVERTISER_NAME",
+ "DSP_NAME",
+ "DSP_SEAT_ID",
+ "ENVIRONMENT",
+ "ENVIRONMENT_NAME",
+ "HOLDING_COMPANY_NAME",
+ "HOUR",
+ "MOBILE_APP_ID",
+ "MOBILE_APP_NAME",
+ "MOBILE_OS",
+ "MONTH",
+ "PACKAGE_FEE_VISIBILITY",
+ "PLATFORM",
+ "PUBLISHER_DOMAIN",
+ "PUBLISHER_ID",
+ "PUBLISHER_NAME",
+ "WEEK"
+ ],
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "The domain of the advertiser.",
+ "Display name of a country.",
+ "The ID of the data segment created by a curator.",
+ "The response status of the data segment requests in the Real-time curation. Refer to https://developers.google.com/authorized-buyers/curation/get-started/start for details.",
+ "The localized display name of the response status of the data segment requests in the Real-time curation. Refer to https://developers.google.com/authorized-buyers/curation/get-started/start for details.",
+ "The type of curation service (e.g. packaging or data segment).",
+ "Date.",
+ "Deal ID.",
+ "Deal name.",
+ "Display name of the detected advertiser.",
+ "Display name of the DSP.",
+ "DSP Seat ID.",
+ "The user device and container environment where the impression originates. Supported values are \"app\" and \"web\".",
+ "The localized display name of the user device and container environment where the impression originates. Supported values are \"app\" and \"web\".",
+ "Display name of the holding company.",
+ "Hour.",
+ "Mobile App ID.",
+ "Mobile App Name.",
+ "Mobile operating system.",
+ "Month.",
+ "The visibility of the package fee (e.g. disclosed or non-disclosed).",
+ "Platform, e.g. \"desktop\" vs. \"mobile\".",
+ "Publisher domain.",
+ "Publisher identifier.",
+ "Publisher name.",
+ "Week."
+ ],
+ "type": "string"
+ },
+ "metric": {
+ "description": "The metric this field represents.",
+ "enum": [
+ "METRIC_UNSPECIFIED",
+ "ACTIVE_VIEW_MEASURABILITY_RATE",
+ "ACTIVE_VIEW_MEASURABLE",
+ "ACTIVE_VIEW_VIEWABILITY_RATE",
+ "ACTIVE_VIEW_VIEWABLE",
+ "AUCTIONS_WON",
+ "BIDS",
+ "BIDS_IN_AUCTION",
+ "BID_REQUESTS",
+ "CLICKS",
+ "CURATION_PARTNER_FEE",
+ "DATA_SEGMENT_REQUESTS",
+ "IMPRESSIONS",
+ "SPEND"
+ ],
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "Active View measurability rate.",
+ "Active View measurable.",
+ "Active view viewability rate.",
+ "Active View viewable imps.",
+ "Auctions won.",
+ "Bids.",
+ "Bids in auction.",
+ "Bid requests.",
+ "Clicks.",
+ "Curator fee.",
+ "Number of data segment requests sent in the Real-time curation.",
+ "Impressions.",
+ "Spend in reporting currency specified in the request. Defaults to USD."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "FieldFilter": {
+ "description": "A filter on a specific field.",
+ "id": "FieldFilter",
+ "properties": {
+ "field": {
+ "$ref": "Field",
+ "description": "Required. The field to filter on."
+ },
+ "operation": {
+ "description": "Required. The operation of this filter.",
+ "enum": [
+ "IN",
+ "NOT_IN",
+ "CONTAINS",
+ "NOT_CONTAINS",
+ "LESS_THAN",
+ "LESS_THAN_EQUALS",
+ "GREATER_THAN",
+ "GREATER_THAN_EQUALS",
+ "BETWEEN",
+ "MATCHES",
+ "NOT_MATCHES"
+ ],
+ "enumDescriptions": [
+ "For scalar operands, checks if the operand is in the set of provided filter values. For list operands, checks if any element in the operand is in the set of provided filter values. Default value.",
+ "For scalar operands, checks that the operand is not in the set of provided filter values. For list operands, checks that none of the elements in the operand is in the set of provided filter values.",
+ "For scalar string operands, checks if the operand contains any of the provided filter substrings. For string list operands, checks if any string in the operand contains any of the provided filter substrings.",
+ "For scalar string operands, checks that the operand contains none of the provided filter substrings. For string list operands, checks that none of the strings in the operand contain none of the provided filter substrings.",
+ "Operand is less than the provided filter value.",
+ "Operand is less than or equal to provided filter value.",
+ "Operand is greater than provided filter value.",
+ "Operand is greater than or equal to provided filter value.",
+ "Operand is between provided filter values.",
+ "Operand matches against a regular expression or set of regular expressions (one must match).",
+ "Operand negative matches against a regular expression or set of regular expressions (none must match)."
+ ],
+ "type": "string"
+ },
+ "values": {
+ "description": "Required. Values to filter to.",
+ "items": {
+ "$ref": "ReportValue"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Filter": {
+ "description": "A filter over one or more fields.",
+ "id": "Filter",
+ "properties": {
+ "andFilter": {
+ "$ref": "FilterList",
+ "description": "A list of filters whose results are AND-ed."
+ },
+ "fieldFilter": {
+ "$ref": "FieldFilter",
+ "description": "A filter on a single field."
+ },
+ "notFilter": {
+ "$ref": "Filter",
+ "description": "A filter whose result is negated."
+ },
+ "orFilter": {
+ "$ref": "FilterList",
+ "description": "A list of filters whose results are OR-ed."
+ }
+ },
+ "type": "object"
+ },
+ "FilterList": {
+ "description": "A list of filters.",
+ "id": "FilterList",
+ "properties": {
+ "filters": {
+ "description": "Required. A list of filters.",
+ "items": {
+ "$ref": "Filter"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "FixedDateRange": {
+ "description": "A date range between two fixed dates (inclusive of end date).",
+ "id": "FixedDateRange",
+ "properties": {
+ "endDate": {
+ "$ref": "Date",
+ "description": "Required. The end date (inclusive) of this date range."
+ },
+ "startDate": {
+ "$ref": "Date",
+ "description": "Required. The start date of this date range."
+ }
+ },
+ "type": "object"
+ },
+ "IntList": {
+ "description": "A list of integer values.",
+ "id": "IntList",
+ "properties": {
+ "values": {
+ "description": "The values",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "ListCuratedPackagesResponse": {
+ "description": "Response message for ListCuratedPackages.",
+ "id": "ListCuratedPackagesResponse",
+ "properties": {
+ "curatedPackages": {
+ "description": "The list of curated packages.",
+ "items": {
+ "$ref": "CuratedPackage"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results. Pass this value in the ListCuratedPackagesRequest.pageToken field in the subsequent call to `ListCuratedPackages` method to retrieve the next page of results. If empty, then there are no more results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListDataSegmentsResponse": {
+ "description": "Response message for listing data segments.",
+ "id": "ListDataSegmentsResponse",
+ "properties": {
+ "dataSegments": {
+ "description": "The list of data segments.",
+ "items": {
+ "$ref": "DataSegment"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "Continuation token for fetching the next page of results. Pass this value in the ListDataSegmentsRequest.pageToken field in the subsequent call to the `ListDataSegments` method to retrieve the next page of results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListMediaPlannersResponse": {
+ "description": "A response containing media planner account information.",
+ "id": "ListMediaPlannersResponse",
+ "properties": {
+ "mediaPlanners": {
+ "description": "List of media planners.",
+ "items": {
+ "$ref": "MediaPlanner"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token which can be passed to a subsequent call to the ListMediaPlanners method to retrieve the next page of results in ListMediaPlannersRequest.page_token.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ListReportsResponse": {
+ "description": "Response object for `ListReportsResponse` containing matching `Report` objects.",
+ "id": "ListReportsResponse",
+ "properties": {
+ "nextPageToken": {
+ "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+ "type": "string"
+ },
+ "reports": {
+ "description": "The `Report` objects from the specified network.",
+ "items": {
+ "$ref": "Report"
+ },
+ "type": "array"
+ },
+ "totalSize": {
+ "description": "Total number of `Report` objects. If a filter was included in the request, this reflects the total number after the filtering is applied. `total_size` won't be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter `$fields` or `fields`, or by using the HTTP/gRPC header `X-Goog-FieldMask`. For more information, see https://developers.google.com/ad-manager/api/beta/field-masks",
+ "format": "int32",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ },
+ "MediaPlanner": {
+ "description": "Represents a media planner account.",
+ "id": "MediaPlanner",
+ "properties": {
+ "accountId": {
+ "deprecated": true,
+ "description": "Output only. Account ID of the media planner.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "ancestorNames": {
+ "description": "Output only. The ancestor names of the media planner. Format: `mediaPlanners/{mediaPlannerAccountId}`. Can be used to filter the response of the mediaPlanners.list method.",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
+ "displayName": {
+ "description": "Output only. The display name of the media planner. Can be used to filter the response of the mediaPlanners.list method.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "Identifier. The unique resource name of the media planner. Format: `mediaPlanners/{mediaPlannerAccountId}`. Can be used to filter the response of the mediaPlanners.list method.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "MetricValueGroup": {
+ "description": "Contains all metric values requested for a single date range and set of column dimension values (returned in the columns field of the response). The order of the metrics in each field corresponds to the order of the metrics specified in the request.",
+ "id": "MetricValueGroup",
+ "properties": {
+ "primaryValues": {
+ "description": "Data for the PRIMARY MetricValueType.",
+ "items": {
+ "$ref": "ReportValue"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "Money": {
+ "description": "Represents an amount of money with its currency type.",
+ "id": "Money",
+ "properties": {
+ "currencyCode": {
+ "description": "The three-letter currency code defined in ISO 4217.",
+ "type": "string"
+ },
+ "nanos": {
+ "description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "units": {
+ "description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Operation": {
+ "description": "This resource represents a long-running operation that is the result of a network API call.",
+ "id": "Operation",
+ "properties": {
+ "done": {
+ "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
+ "type": "boolean"
+ },
+ "error": {
+ "$ref": "Status",
+ "description": "The error result of the operation in case of failure or cancellation."
+ },
+ "metadata": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
+ "type": "object"
+ },
+ "name": {
+ "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
+ "type": "string"
+ },
+ "response": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "PackagePlacementTargeting": {
+ "description": "Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed.",
+ "id": "PackagePlacementTargeting",
+ "properties": {
+ "includedMobileAppCategoryTargeting": {
+ "description": "Optional. The list of targeted mobile app categories.",
+ "items": {
+ "format": "int64",
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "mobileAppTargeting": {
+ "$ref": "StringTargetingDimension",
+ "description": "Optional. The list of targeted or excluded mobile application IDs that publishers own. Currently, only Android and Apple apps are supported. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded."
+ },
+ "uriTargeting": {
+ "$ref": "StringTargetingDimension",
+ "description": "Optional. The list of targeted or excluded URLs. The domains should have the http/https stripped (for example, google.com), and can contain a max of 5 paths per url."
+ }
+ },
+ "type": "object"
+ },
+ "PackagePublisherProvidedSignalsTargeting": {
+ "description": "Represents targeting about publisher provided signals. Different publisher provided signals types will be logically OR'ed.",
+ "id": "PackagePublisherProvidedSignalsTargeting",
+ "properties": {
+ "audienceTargeting": {
+ "$ref": "TaxonomyTargeting",
+ "description": "Optional. The list of targeted or excluded audience IDs. Based off of IAB Audience Taxonomy version 1.1 (https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Audience%20Taxonomies/Audience%20Taxonomy%201.1.tsv)"
+ },
+ "contentTargeting": {
+ "$ref": "TaxonomyTargeting",
+ "description": "Optional. The list of targeted or excluded content IDs. Based off of IAB Content Taxonomy version 2.2 (https://github.com/InteractiveAdvertisingBureau/Taxonomies/blob/main/Content%20Taxonomies/Content%20Taxonomy%202.2.tsv)"
+ },
+ "videoAndAudioSignalsTargeting": {
+ "$ref": "StringTargetingDimension",
+ "description": "Optional. The list of targeted and excluded video and audio signals IDs. These are additional signals supported by publisher provided signals."
+ }
+ },
+ "type": "object"
+ },
+ "PackageTargeting": {
+ "description": "Targeting criteria for curated and auction packages.",
+ "id": "PackageTargeting",
+ "properties": {
+ "geoTargeting": {
+ "$ref": "CriteriaTargeting",
+ "description": "Optional. The geo criteria IDs to be included or excluded as defined in https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv. If unset, inventory will be targeted regardless of geo."
+ },
+ "includedAcceleratedMobilePageType": {
+ "description": "Optional. The targeted accelerated mobile page type. If unset, inventory will be targeted regardless of AMP status.",
+ "enum": [
+ "ACCELERATED_MOBILE_PAGE_TYPE_UNSPECIFIED",
+ "ACCELERATED_MOBILE_PAGE_TYPE_NON_AMP",
+ "ACCELERATED_MOBILE_PAGE_TYPE_AMP",
+ "ACCELERATED_MOBILE_PAGE_TYPE_AMP_STORY"
+ ],
+ "enumDescriptions": [
+ "Default value. Should not be used in targeting specifications.",
+ "Targets inventory on standard web pages not using any AMP framework.",
+ "Targets inventory on pages built using the core AMP HTML framework.",
+ "Targets inventory on pages using the AMP Story (STAMP) format, which is optimized for visual storytelling (e.g., tappable full-screen experiences)."
+ ],
+ "type": "string"
+ },
+ "includedAdSizes": {
+ "description": "Optional. The list of ad sizes to target. If unset, inventory will be targeted regardless of ad size. Curated packages supports `PIXEL` and `INTERSTITIAL` ad sizes.",
+ "items": {
+ "$ref": "AdSize"
+ },
+ "type": "array"
+ },
+ "includedAuthorizedSellerStatuses": {
+ "description": "Optional. The included list of targeted authorized seller statuses. If empty, inventory will be targeted regardless of seller status.",
+ "items": {
+ "enum": [
+ "AUTHORIZED_SELLER_STATUS_UNSPECIFIED",
+ "AUTHORIZED_SELLER_STATUS_DIRECT",
+ "AUTHORIZED_SELLER_STATUS_RESELLER"
+ ],
+ "enumDescriptions": [
+ "Default value. Should not be used in targeting specifications.",
+ "Targets inventory where the seller is declared as 'DIRECT'. This indicates the publisher (content owner) directly controls the seller account and has a direct business contract with the advertising system for this account.",
+ "Targets inventory where the seller is declared as 'RESELLER'. This indicates the publisher has authorized another entity to operate the listed seller account and resell their ad space."
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "includedCreativeFormat": {
+ "description": "Optional. The creative format to target. If unset, all creative markup types are targeted.",
+ "enum": [
+ "CREATIVE_FORMAT_UNSPECIFIED",
+ "CREATIVE_FORMAT_DISPLAY",
+ "CREATIVE_FORMAT_VIDEO",
+ "CREATIVE_FORMAT_AUDIO"
+ ],
+ "enumDescriptions": [
+ "Default value. Should not be used in targeting specifications.",
+ "Targets ad slots intended for HTML display creatives.",
+ "Targets ad slots intended for video creatives.",
+ "Targets ad slots intended for audio creatives."
+ ],
+ "type": "string"
+ },
+ "includedDataSegments": {
+ "description": "Optional. The active data segments to be targeted. If unset, inventory will be targeted regardless of data segments. Format: `curators/{account_id}/dataSegments/{data_segment_id}`",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "includedDeviceTypes": {
+ "description": "Optional. The list of included device types to target. If empty, all device types are targeted.",
+ "items": {
+ "enum": [
+ "DEVICE_TYPE_UNSPECIFIED",
+ "DEVICE_TYPE_PERSONAL_COMPUTER",
+ "DEVICE_TYPE_CONNECTED_TV",
+ "DEVICE_TYPE_PHONE",
+ "DEVICE_TYPE_TABLET"
+ ],
+ "enumDescriptions": [
+ "Default value. Should not be used in targeting specifications.",
+ "Targets desktop or laptop computers.",
+ "Targets connected TVs: devices that stream TV content, including smart TVs, gaming consoles, and streaming boxes/sticks.",
+ "Targets high-end mobile devices.",
+ "Targets tablet devices."
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "includedEnvironment": {
+ "description": "Optional. The environment to target. If unspecified, all environments are targeted.",
+ "enum": [
+ "ENVIRONMENT_UNSPECIFIED",
+ "ENVIRONMENT_SITE",
+ "ENVIRONMENT_APP"
+ ],
+ "enumDescriptions": [
+ "Default value. Should not be used in targeting specifications.",
+ "Targets inventory rendered within an ad-supported website.",
+ "Targets inventory within a mobile application."
+ ],
+ "type": "string"
+ },
+ "includedNativeInventoryTypes": {
+ "description": "Optional. The targeted native inventory types. If empty, inventory will be targeted regardless of native inventory type.",
+ "items": {
+ "enum": [
+ "NATIVE_INVENTORY_TYPE_UNSPECIFIED",
+ "NATIVE_INVENTORY_TYPE_NATIVE_ONLY",
+ "NATIVE_INVENTORY_TYPE_NATIVE_OR_BANNER"
+ ],
+ "enumDescriptions": [
+ "Default value. Should not be used in targeting specifications.",
+ "Targets ad slots that *only* accept and render native ads.",
+ "Targets ad slots that accept and render either native or banner ads."
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "includedOpenMeasurementTypes": {
+ "description": "Optional. The list of targeted open measurement types. If empty, inventory will be targeted regardless of Open Measurement support.",
+ "items": {
+ "enum": [
+ "OPEN_MEASUREMENT_TYPE_UNSPECIFIED",
+ "OPEN_MEASUREMENT_TYPE_OMID_V1"
+ ],
+ "enumDescriptions": [
+ "Default value. Should not be used in targeting specifications.",
+ "Targets inventory that supports the v1 Open Measurement Interface Definition (OMID)."
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "includedRestrictedCategories": {
+ "description": "Optional. The list of targeted restricted categories. If empty, inventory will be targeted regardless of restricted categories.",
+ "items": {
+ "enum": [
+ "RESTRICTED_CATEGORY_UNSPECIFIED",
+ "RESTRICTED_CATEGORY_ALCOHOL",
+ "RESTRICTED_CATEGORY_GAMBLING"
+ ],
+ "enumDescriptions": [
+ "Default value. Should not be used in targeting specifications.",
+ "Targets inventory where alcohol ads are allowed by the publisher.",
+ "Targets inventory where gambling ads are allowed by the publisher."
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "includedRewardedType": {
+ "description": "Optional. The targeted rewarded type. If unset, inventory will be targeted regardless of rewarded type.",
+ "enum": [
+ "REWARDED_TYPE_UNSPECIFIED",
+ "REWARDED_TYPE_NON_REWARDED",
+ "REWARDED_TYPE_REWARDED"
+ ],
+ "enumDescriptions": [
+ "Default value. Should not be used in targeting specifications.",
+ "Targets inventory that does NOT offer an explicit reward to the user for watching or interacting with the ad.",
+ "Targets inventory that offers a reward to the user in exchange for watching or engaging with the ad."
+ ],
+ "type": "string"
+ },
+ "languageTargeting": {
+ "$ref": "StringTargetingDimension",
+ "description": "Optional. The languages to target. If unset, inventory will be targeted regardless of language. See https://developers.google.com/google-ads/api/data/codes-formats#languages for the list of supported language codes."
+ },
+ "minimumPredictedClickThroughRatePercentageMillis": {
+ "description": "Optional. The targeted minimum predicted click through rate, ranging in values [10, 10000] (0.01% - 10%). A value of 50 means that the configuration will only match adslots for which we predict at least 0.05% click through rate. An unset value indicates inventory will be targeted regardless of predicted click through rate.",
+ "format": "int64",
+ "type": "string"
+ },
+ "minimumPredictedViewabilityPercentage": {
+ "description": "Optional. The targeted minimum predicted viewability percentage. This value must be a multiple of 10 between 10 and 90 (inclusive). For example, 10 is valid, but 0, 15, and 100 are not. A value of 10 means that the configuration will only match adslots for which we predict at least 10% viewability. An unset value indicates inventory will be targeted regardless of predicted viewability.",
+ "format": "int64",
+ "type": "string"
+ },
+ "placementTargeting": {
+ "$ref": "PackagePlacementTargeting",
+ "description": "Optional. Placement targeting information, for example, URL, mobile applications."
+ },
+ "publisherProvidedSignalsTargeting": {
+ "$ref": "PackagePublisherProvidedSignalsTargeting",
+ "description": "Optional. The publisher provided signals to target. If unset, inventory will be targeted regardless of publisher provided signals."
+ },
+ "publisherTargeting": {
+ "$ref": "StringTargetingDimension",
+ "description": "Optional. The targeted publishers. If unset, inventory will be targeted regardless of publisher. Publishers are identified by their publisher ID from ads.txt / app-ads.txt. See https://iabtechlab.com/ads-txt/ and https://iabtechlab.com/app-ads-txt/ for more details."
+ },
+ "verticalTargeting": {
+ "$ref": "CriteriaTargeting",
+ "description": "Optional. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals. If unset, inventory will be targeted regardless of vertical."
+ },
+ "videoTargeting": {
+ "$ref": "PackageVideoTargeting",
+ "description": "Optional. Video specific targeting criteria."
+ }
+ },
+ "type": "object"
+ },
+ "PackageVideoTargeting": {
+ "description": "Video specific targeting criteria.",
+ "id": "PackageVideoTargeting",
+ "properties": {
+ "includedContentDeliveryMethod": {
+ "description": "Optional. The targeted video delivery method. If unset, inventory will be targeted regardless of video delivery method.",
+ "enum": [
+ "CONTENT_DELIVERY_METHOD_UNSPECIFIED",
+ "CONTENT_DELIVERY_METHOD_STREAMING",
+ "CONTENT_DELIVERY_METHOD_PROGRESSIVE"
+ ],
+ "enumDescriptions": [
+ "Default value. Should not be used in targeting specifications.",
+ "Targets video content that is being broadcast live.",
+ "Targets video content that is transferred incrementally as client's playback requires."
+ ],
+ "type": "string"
+ },
+ "includedMaximumAdDurationTargeting": {
+ "description": "Optional. The targeted maximum video ad duration. If unset, inventory will be targeted regardless of maximum video ad duration.",
+ "enum": [
+ "MAXIMUM_VIDEO_AD_DURATION_UNSPECIFIED",
+ "MAXIMUM_VIDEO_AD_DURATION_FIFTEEN_SECONDS",
+ "MAXIMUM_VIDEO_AD_DURATION_TWENTY_SECONDS",
+ "MAXIMUM_VIDEO_AD_DURATION_THIRTY_SECONDS",
+ "MAXIMUM_VIDEO_AD_DURATION_SIXTY_SECONDS",
+ "MAXIMUM_VIDEO_AD_DURATION_NINETY_SECONDS",
+ "MAXIMUM_VIDEO_AD_DURATION_ONE_HUNDRED_TWENTY_SECONDS"
+ ],
+ "enumDescriptions": [
+ "Default value. Should not be used in targeting specifications.",
+ "Applies to video ads with a duration up to 15 seconds (0 < duration <= 15s).",
+ "Applies to video ads with a duration up to 20 seconds (0 < duration <= 20s).",
+ "Applies to video ads with a duration up to 30 seconds (0 < duration <= 30s).",
+ "Applies to video ads with a duration up to 60 seconds (0 < duration <= 60s).",
+ "Applies to video ads with a duration up to 90 seconds (0 < duration <= 90s).",
+ "Applies to video ads with a duration up to 120 seconds (0 < duration <= 120s)."
+ ],
+ "type": "string"
+ },
+ "includedMimeTypes": {
+ "description": "Optional. The list of targeted video mime types using the IANA published MIME type strings (https://www.iana.org/assignments/media-types/media-types.xhtml). If empty, inventory will be targeted regardless of video mime type.",
+ "items": {
+ "enum": [
+ "VIDEO_MIME_TYPE_UNSPECIFIED",
+ "VIDEO_MIME_TYPE_THREEGPP",
+ "VIDEO_MIME_TYPE_APPLICATION_MPEGURL",
+ "VIDEO_MIME_TYPE_MP4",
+ "VIDEO_MIME_TYPE_APPLICATION_MPEGDASH",
+ "VIDEO_MIME_TYPE_APPLICATION_JAVASCRIPT",
+ "VIDEO_MIME_TYPE_WEBM"
+ ],
+ "enumDescriptions": [
+ "Default value. Should not be used in targeting specifications.",
+ "3GPP container format used on 3G phones.",
+ "HLS/M3U8",
+ "MPEG-4 container typically with H.264 codec.",
+ "DASH.",
+ "JavaScript (used for VPAID ads).",
+ "WebM container assuming VP9 codec."
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "includedPlaybackMethods": {
+ "description": "Optional. The list of targeted video playback methods. If empty, inventory will be targeted regardless of video playback method.",
+ "items": {
+ "enum": [
+ "PLAYBACK_METHOD_UNSPECIFIED",
+ "PLAYBACK_METHOD_AUTO_PLAY_SOUND_ON",
+ "PLAYBACK_METHOD_AUTO_PLAY_SOUND_OFF",
+ "PLAYBACK_METHOD_CLICK_TO_PLAY"
+ ],
+ "enumDescriptions": [
+ "Unspecified video playback method. Should not be used.",
+ "Playback starts automatically when the page/content loads.",
+ "Playback starts automatically when the page/content loads, but with sound off.",
+ "Playback is initiated by a user action (e.g., clicking a play button)."
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "includedPlayerSizeTargeting": {
+ "$ref": "VideoPlayerSizeTargeting",
+ "description": "Optional. The targeted video player size. If unset, inventory will be targeted regardless of video player size."
+ },
+ "includedPositionTypes": {
+ "description": "Optional. The targeted video ad position types. If empty, inventory will be targeted regardless of video ad position type.",
+ "items": {
+ "enum": [
+ "POSITION_TYPE_UNSPECIFIED",
+ "POSITION_TYPE_MIDROLL",
+ "POSITION_TYPE_POSTROLL",
+ "POSITION_TYPE_PREROLL"
+ ],
+ "enumDescriptions": [
+ "Default value. Should not be used in targeting specifications.",
+ "The ad is played in the middle of the video content.",
+ "The ad is played after the video content.",
+ "The ad is played before the video content."
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "minimumPredictedCompletionRatePercentage": {
+ "description": "Optional. The targeted minimum predicted completion rate percentage. This value must be a multiple of 10 between 10 and 90 (inclusive). For example, 10 is valid, but 0, 15, and 100 are not. A value of 10 means that the configuration will only match adslots for which we predict at least 10% completion rate. An unset value indicates inventory will be targeted regardless of predicted completion rate.",
+ "format": "int64",
+ "type": "string"
+ },
+ "plcmtTargeting": {
+ "$ref": "VideoPlcmtTargeting",
+ "description": "Optional. The targeted video plcmt types. If unset, inventory will be targeted regardless of video plcmt type."
+ }
+ },
+ "type": "object"
+ },
+ "Report": {
+ "description": "The `Report` resource.",
+ "id": "Report",
+ "properties": {
+ "createTime": {
+ "description": "Output only. The instant this report was created.",
+ "format": "google-datetime",
+ "readOnly": true,
+ "type": "string"
+ },
+ "displayName": {
+ "description": "Optional. Display name for the report.",
+ "type": "string"
+ },
+ "locale": {
+ "description": "Output only. The locale of this report. Locale is set from the user's locale at the time of the request. Locale can't be modified.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "Identifier. The resource name of the report. Report resource name have the form: `curators/{account_id}/reports/{report_id}`",
+ "type": "string"
+ },
+ "reportDefinition": {
+ "$ref": "ReportDefinition",
+ "description": "Required. The report definition of the report."
+ },
+ "reportId": {
+ "description": "Output only. Report ID.",
+ "format": "int64",
+ "readOnly": true,
+ "type": "string"
+ },
+ "updateTime": {
+ "description": "Output only. The instant this report was last modified.",
+ "format": "google-datetime",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportDefinition": {
+ "description": "The definition of how a report should be run.",
+ "id": "ReportDefinition",
+ "properties": {
+ "currencyCode": {
+ "description": "Optional. The ISO 4217 currency code for this report. Defaults to account currency code if not specified.",
+ "type": "string"
+ },
+ "dateRange": {
+ "$ref": "DateRange",
+ "description": "Required. The primary date range of this report."
+ },
+ "dimensions": {
+ "description": "Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.",
+ "items": {
+ "enum": [
+ "DIMENSION_UNSPECIFIED",
+ "ADVERTISER_DOMAIN",
+ "COUNTRY",
+ "CURATION_DATA_SEGMENT_ID",
+ "CURATION_DATA_SEGMENT_RESPONSE_STATUS",
+ "CURATION_DATA_SEGMENT_RESPONSE_STATUS_NAME",
+ "CURATOR_FEE_TYPE",
+ "DATE",
+ "DEAL_ID",
+ "DEAL_NAME",
+ "DETECTED_ADVERTISER_NAME",
+ "DSP_NAME",
+ "DSP_SEAT_ID",
+ "ENVIRONMENT",
+ "ENVIRONMENT_NAME",
+ "HOLDING_COMPANY_NAME",
+ "HOUR",
+ "MOBILE_APP_ID",
+ "MOBILE_APP_NAME",
+ "MOBILE_OS",
+ "MONTH",
+ "PACKAGE_FEE_VISIBILITY",
+ "PLATFORM",
+ "PUBLISHER_DOMAIN",
+ "PUBLISHER_ID",
+ "PUBLISHER_NAME",
+ "WEEK"
+ ],
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "The domain of the advertiser.",
+ "Display name of a country.",
+ "The ID of the data segment created by a curator.",
+ "The response status of the data segment requests in the Real-time curation. Refer to https://developers.google.com/authorized-buyers/curation/get-started/start for details.",
+ "The localized display name of the response status of the data segment requests in the Real-time curation. Refer to https://developers.google.com/authorized-buyers/curation/get-started/start for details.",
+ "The type of curation service (e.g. packaging or data segment).",
+ "Date.",
+ "Deal ID.",
+ "Deal name.",
+ "Display name of the detected advertiser.",
+ "Display name of the DSP.",
+ "DSP Seat ID.",
+ "The user device and container environment where the impression originates. Supported values are \"app\" and \"web\".",
+ "The localized display name of the user device and container environment where the impression originates. Supported values are \"app\" and \"web\".",
+ "Display name of the holding company.",
+ "Hour.",
+ "Mobile App ID.",
+ "Mobile App Name.",
+ "Mobile operating system.",
+ "Month.",
+ "The visibility of the package fee (e.g. disclosed or non-disclosed).",
+ "Platform, e.g. \"desktop\" vs. \"mobile\".",
+ "Publisher domain.",
+ "Publisher identifier.",
+ "Publisher name.",
+ "Week."
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "filters": {
+ "description": "Optional. The filters for this report.",
+ "items": {
+ "$ref": "Filter"
+ },
+ "type": "array"
+ },
+ "metrics": {
+ "description": "Required. The list of metrics to report on. If empty, the report will have no metrics.",
+ "items": {
+ "enum": [
+ "METRIC_UNSPECIFIED",
+ "ACTIVE_VIEW_MEASURABILITY_RATE",
+ "ACTIVE_VIEW_MEASURABLE",
+ "ACTIVE_VIEW_VIEWABILITY_RATE",
+ "ACTIVE_VIEW_VIEWABLE",
+ "AUCTIONS_WON",
+ "BIDS",
+ "BIDS_IN_AUCTION",
+ "BID_REQUESTS",
+ "CLICKS",
+ "CURATION_PARTNER_FEE",
+ "DATA_SEGMENT_REQUESTS",
+ "IMPRESSIONS",
+ "SPEND"
+ ],
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "Active View measurability rate.",
+ "Active View measurable.",
+ "Active view viewability rate.",
+ "Active View viewable imps.",
+ "Auctions won.",
+ "Bids.",
+ "Bids in auction.",
+ "Bid requests.",
+ "Clicks.",
+ "Curator fee.",
+ "Number of data segment requests sent in the Real-time curation.",
+ "Impressions.",
+ "Spend in reporting currency specified in the request. Defaults to USD."
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "sorts": {
+ "description": "Optional. Default sorts to apply to this report.",
+ "items": {
+ "$ref": "Sort"
+ },
+ "type": "array"
+ },
+ "timeZone": {
+ "description": "Optional. If time_zone_source is PROVIDED, this is the time zone to use for this report. Leave empty for any other time zone source. Time zone in IANA format. For example, \"America/New_York\".",
+ "type": "string"
+ },
+ "timeZoneSource": {
+ "description": "Optional. Where to get the time zone for this report. Defaults to using the Pacific time zone (PT). If source is PROVIDED, the time_zone field in the report definition must also set a time zone.",
+ "enum": [
+ "TIME_ZONE_SOURCE_UNSPECIFIED",
+ "AD_EXCHANGE",
+ "UTC",
+ "PROVIDED"
+ ],
+ "enumDescriptions": [
+ "Unspecified default value.",
+ "Use the Pacific time zone(PT).",
+ "Use UTC time zone.",
+ "Use the time zone provided in the ReportDefinition.time_zone field. Reports may take longer to run since the dates are dynamically calculated at request time."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "ReportValue": {
+ "description": "Represents a single value in a report.",
+ "id": "ReportValue",
+ "properties": {
+ "boolValue": {
+ "description": "For boolean values.",
+ "type": "boolean"
+ },
+ "bytesValue": {
+ "description": "For bytes values.",
+ "format": "byte",
+ "type": "string"
+ },
+ "doubleListValue": {
+ "$ref": "DoubleList",
+ "description": "For lists of double values."
+ },
+ "doubleValue": {
+ "description": "For double values.",
+ "format": "double",
+ "type": "number"
+ },
+ "intListValue": {
+ "$ref": "IntList",
+ "description": "For lists of integer values."
+ },
+ "intValue": {
+ "description": "For integer values.",
+ "format": "int64",
+ "type": "string"
+ },
+ "stringListValue": {
+ "$ref": "StringList",
+ "description": "For lists of string values."
+ },
+ "stringValue": {
+ "description": "For string values.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Row": {
+ "description": "A row of report data.",
+ "id": "Row",
+ "properties": {
+ "dimensionValues": {
+ "description": "The order of the dimension values is the same as the order of the dimensions specified in the request.",
+ "items": {
+ "$ref": "ReportValue"
+ },
+ "type": "array"
+ },
+ "metricValueGroups": {
+ "description": " The length of the metric_value_groups field will be equal to the length of the date_ranges field in the fetch response. The metric_value_groups field is ordered such that each index corresponds to the date_range at the same index. For example, given date_ranges [x, y], metric_value_groups will have a length of two. The first entry in metric_value_groups represents the metrics for date x and the second entry in metric_value_groups represents the metrics for date y.",
+ "items": {
+ "$ref": "MetricValueGroup"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "RunReportMetadata": {
+ "description": "`RunReport` operation metadata.",
+ "id": "RunReportMetadata",
+ "properties": {
+ "percentComplete": {
+ "description": "An estimate of how close this report is to being completed. Will always be 100 for failed and completed reports.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "report": {
+ "description": "The result's parent report.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "RunReportRequest": {
+ "description": "Request message for a running a report.",
+ "id": "RunReportRequest",
+ "properties": {},
+ "type": "object"
+ },
+ "RunReportResponse": {
+ "description": "Response message for a completed `RunReport` operation.",
+ "id": "RunReportResponse",
+ "properties": {
+ "reportResult": {
+ "description": "The unique name of the generated result. Use with `FetchReportResultRows` to retrieve data.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Sort": {
+ "description": "Represents a sorting in a report.",
+ "id": "Sort",
+ "properties": {
+ "descending": {
+ "description": "Optional. The sort order. If true the sort will be descending.",
+ "type": "boolean"
+ },
+ "field": {
+ "$ref": "Field",
+ "description": "Required. A field (dimension or metric) to sort by."
+ }
+ },
+ "type": "object"
+ },
+ "Status": {
+ "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
+ "id": "Status",
+ "properties": {
+ "code": {
+ "description": "The status code, which should be an enum value of google.rpc.Code.",
+ "format": "int32",
+ "type": "integer"
+ },
+ "details": {
+ "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
+ "items": {
+ "additionalProperties": {
+ "description": "Properties of the object. Contains field @type with type URL.",
+ "type": "any"
+ },
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "message": {
+ "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "StringList": {
+ "description": "A list of string values.",
+ "id": "StringList",
+ "properties": {
+ "values": {
+ "description": "The values",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "StringTargetingDimension": {
+ "description": "Generic targeting with string values.",
+ "id": "StringTargetingDimension",
+ "properties": {
+ "selectionType": {
+ "description": "Required. How the items in this list should be targeted.",
+ "enum": [
+ "SELECTION_TYPE_UNSPECIFIED",
+ "SELECTION_TYPE_INCLUDE",
+ "SELECTION_TYPE_EXCLUDE"
+ ],
+ "enumDescriptions": [
+ "Unspecified selection type. Should not be used.",
+ "The values in the targeting dimension are included.",
+ "The values in the targeting dimension are excluded."
+ ],
+ "type": "string"
+ },
+ "values": {
+ "description": "Required. The values specified.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "TaxonomyTargeting": {
+ "description": "Defines targeting criteria for handling the IAB audience and content Taxonomy ID space.",
+ "id": "TaxonomyTargeting",
+ "properties": {
+ "excludedTaxonomyIds": {
+ "description": "Optional. The list of excluded content taxonomy IDs.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "targetedTaxonomyIds": {
+ "description": "Optional. The list of targeted content taxonomy IDs.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "VideoPlayerSizeTargeting": {
+ "description": "Represents the size of the video player that can be targeted. Both width and height are required to be set to non-zero values.",
+ "id": "VideoPlayerSizeTargeting",
+ "properties": {
+ "minimumHeight": {
+ "description": "Required. The minimum height of the video player in pixels.",
+ "format": "int64",
+ "type": "string"
+ },
+ "minimumWidth": {
+ "description": "Required. The minimum width of the video player in pixels.",
+ "format": "int64",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "VideoPlcmtTargeting": {
+ "description": "Defines targeting criteria based on the video placement type, often corresponding to the IAB OpenRTB 'plcmt' field.",
+ "id": "VideoPlcmtTargeting",
+ "properties": {
+ "selectionType": {
+ "description": "Required. The selection type for the list of video plcmts.",
+ "enum": [
+ "SELECTION_TYPE_UNSPECIFIED",
+ "SELECTION_TYPE_INCLUDE",
+ "SELECTION_TYPE_EXCLUDE"
+ ],
+ "enumDescriptions": [
+ "Unspecified selection type. Should not be used.",
+ "The values in the targeting dimension are included.",
+ "The values in the targeting dimension are excluded."
+ ],
+ "type": "string"
+ },
+ "videoPlcmtTypes": {
+ "description": "Required. The list of targeted video plcmts types. If empty, inventory will be targeted regardless of video plcmt type.",
+ "items": {
+ "enum": [
+ "VIDEO_PLCMT_TYPE_UNSPECIFIED",
+ "INSTREAM",
+ "ACCOMPANYING_CONTENT",
+ "INTERSTITIAL",
+ "NO_CONTENT"
+ ],
+ "enumDescriptions": [
+ "Default value. Should not be used in targeting specifications.",
+ "Pre-roll, mid-roll, and post-roll ads that are played before, during or after the streaming video content that the consumer has requested. Instream video must be set to “sound on” by default at player start, or have explicitly clear user intent to watch the video content. While there may be other content surrounding the player, the video content must be the focus of the user’s visit. It should remain the primary content on the page and the only video player in-view capable of audio when playing. If the player converts to floating/sticky, subsequent ad calls should accurately convey the updated player size.",
+ "Pre-roll, mid-roll, and post-roll ads that are played before, during, or after streaming video content. The video player loads and plays before, between, or after paragraphs of text or graphical content, and starts playing only when it enters the viewport. Accompanying content should only start playback upon entering the viewport. It may convert to a floating/sticky player as it scrolls off the page.",
+ "Video ads that are played without video content. During playback, it must be the primary focus of the page and take up the majority of the viewport and cannot be scrolled out of view. This can be in placements like in-app video or slideshows.",
+ "Video ads that are played without streaming video content. This can be in placements like slideshows, native feeds, in-content or sticky/floating."
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ }
+ },
+ "servicePath": "",
+ "title": "Curation Partners API",
+ "version": "v1",
+ "version_module": true
+}
\ No newline at end of file
diff --git a/discovery/dataform-v1beta1.json b/discovery/dataform-v1beta1.json
index 3efb2358c7d..18799f88d1a 100644
--- a/discovery/dataform-v1beta1.json
+++ b/discovery/dataform-v1beta1.json
@@ -3428,7 +3428,7 @@
}
}
},
- "revision": "20260819",
+ "revision": "20260826",
"rootUrl": "https://dataform.googleapis.com/",
"schemas": {
"ActionErrorTable": {
@@ -6467,7 +6467,7 @@
"readOnly": true
},
"depth": {
- "description": "Optional. Input only. Immutable. The maximum depth of the Git repository to checkout for this workspace. If defined and greater than 0, the Git repository will be created as a shallow clone with the given depth, otherwise a full clone will be performed. This field is available only for GitHub, Gitlab and 1p repositories with enabled branch management.",
+ "description": "Optional. Input only. Immutable. The maximum depth of the Git repository to checkout for this workspace. If defined and greater than 0, the Git repository will be created as a shallow clone with the given depth, otherwise a full clone will be performed. This field is available only for GitHub, GitLab and 1p repositories with enabled branch management.",
"format": "int32",
"type": "integer"
},
diff --git a/discovery/dataplex-v1.json b/discovery/dataplex-v1.json
index b027abd216e..4f0ec81f390 100644
--- a/discovery/dataplex-v1.json
+++ b/discovery/dataplex-v1.json
@@ -1042,6 +1042,12 @@
"name"
],
"parameters": {
+ "contexts": {
+ "description": "Optional. Specifies the scope of the context in which the search will be performed. This scope will also be used to perform IAM checks, which if passing, will return all resources in the scope.",
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
"name": {
"description": "Required. The project to which the request should be attributed in the following form: projects/{project}/locations/global.",
"location": "path",
@@ -8038,7 +8044,7 @@
}
}
},
- "revision": "20260804",
+ "revision": "20260823",
"rootUrl": "https://dataplex.googleapis.com/",
"schemas": {
"Empty": {
@@ -9843,6 +9849,21 @@
"description": "Output only. The SQL query string which can be executed.",
"readOnly": true,
"type": "string"
+ },
+ "sqlDialect": {
+ "description": "Output only. The SQL dialect of the query.",
+ "enum": [
+ "SQL_DIALECT_UNSPECIFIED",
+ "GOOGLE_SQL",
+ "SPARK_SQL"
+ ],
+ "enumDescriptions": [
+ "SQL dialect unspecified.",
+ "Google SQL dialect.",
+ "Spark SQL dialect."
+ ],
+ "readOnly": true,
+ "type": "string"
}
},
"type": "object"
@@ -9990,6 +10011,20 @@
"type": "string"
},
"type": "array"
+ },
+ "sqlDialect": {
+ "description": "Optional. The SQL dialect to use in the generated SQL queries. If not specified, the default dialect is Google SQL.",
+ "enum": [
+ "SQL_DIALECT_UNSPECIFIED",
+ "GOOGLE_SQL",
+ "SPARK_SQL"
+ ],
+ "enumDescriptions": [
+ "SQL dialect unspecified.",
+ "Google SQL dialect.",
+ "Spark SQL dialect."
+ ],
+ "type": "string"
}
},
"type": "object"
diff --git a/discovery/developerconnect-v1.json b/discovery/developerconnect-v1.json
index 45ca9568719..25884fcddd4 100644
--- a/discovery/developerconnect-v1.json
+++ b/discovery/developerconnect-v1.json
@@ -18,8 +18,73 @@
"endpoints": [
{
"description": "Regional Endpoint",
- "endpointUrl": "https://developerconnect.us-central1.rep.googleapis.com/",
- "location": "us-central1"
+ "endpointUrl": "https://developerconnect.asia-east1.rep.googleapis.com/",
+ "location": "asia-east1"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.asia-east2.rep.googleapis.com/",
+ "location": "asia-east2"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.asia-northeast1.rep.googleapis.com/",
+ "location": "asia-northeast1"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.asia-northeast2.rep.googleapis.com/",
+ "location": "asia-northeast2"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.asia-northeast3.rep.googleapis.com/",
+ "location": "asia-northeast3"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.asia-south1.rep.googleapis.com/",
+ "location": "asia-south1"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.asia-south2.rep.googleapis.com/",
+ "location": "asia-south2"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.asia-southeast1.rep.googleapis.com/",
+ "location": "asia-southeast1"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.asia-southeast2.rep.googleapis.com/",
+ "location": "asia-southeast2"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.australia-southeast1.rep.googleapis.com/",
+ "location": "australia-southeast1"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.australia-southeast2.rep.googleapis.com/",
+ "location": "australia-southeast2"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.europe-central2.rep.googleapis.com/",
+ "location": "europe-central2"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.europe-north1.rep.googleapis.com/",
+ "location": "europe-north1"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.europe-southwest1.rep.googleapis.com/",
+ "location": "europe-southwest1"
},
{
"description": "Regional Endpoint",
@@ -28,19 +93,94 @@
},
{
"description": "Regional Endpoint",
- "endpointUrl": "https://developerconnect.asia-east1.rep.googleapis.com/",
- "location": "asia-east1"
+ "endpointUrl": "https://developerconnect.europe-west10.rep.googleapis.com/",
+ "location": "europe-west10"
},
{
"description": "Regional Endpoint",
- "endpointUrl": "https://developerconnect.asia-east2.rep.googleapis.com/",
- "location": "asia-east2"
+ "endpointUrl": "https://developerconnect.europe-west12.rep.googleapis.com/",
+ "location": "europe-west12"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.europe-west2.rep.googleapis.com/",
+ "location": "europe-west2"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.europe-west3.rep.googleapis.com/",
+ "location": "europe-west3"
},
{
"description": "Regional Endpoint",
"endpointUrl": "https://developerconnect.europe-west4.rep.googleapis.com/",
"location": "europe-west4"
},
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.europe-west6.rep.googleapis.com/",
+ "location": "europe-west6"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.europe-west8.rep.googleapis.com/",
+ "location": "europe-west8"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.europe-west9.rep.googleapis.com/",
+ "location": "europe-west9"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.me-central1.rep.googleapis.com/",
+ "location": "me-central1"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.me-central2.rep.googleapis.com/",
+ "location": "me-central2"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.me-west1.rep.googleapis.com/",
+ "location": "me-west1"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.northamerica-northeast1.rep.googleapis.com/",
+ "location": "northamerica-northeast1"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.northamerica-northeast2.rep.googleapis.com/",
+ "location": "northamerica-northeast2"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.southamerica-east1.rep.googleapis.com/",
+ "location": "southamerica-east1"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.southamerica-west1.rep.googleapis.com/",
+ "location": "southamerica-west1"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.us-central1.rep.googleapis.com/",
+ "location": "us-central1"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.us-central2.rep.googleapis.com/",
+ "location": "us-central2"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.us-east1.rep.googleapis.com/",
+ "location": "us-east1"
+ },
{
"description": "Regional Endpoint",
"endpointUrl": "https://developerconnect.us-east4.rep.googleapis.com/",
@@ -53,8 +193,13 @@
},
{
"description": "Regional Endpoint",
- "endpointUrl": "https://developerconnect.asia-southeast1.rep.googleapis.com/",
- "location": "asia-southeast1"
+ "endpointUrl": "https://developerconnect.us-east7.rep.googleapis.com/",
+ "location": "us-east7"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.us-south1.rep.googleapis.com/",
+ "location": "us-south1"
},
{
"description": "Regional Endpoint",
@@ -65,6 +210,16 @@
"description": "Regional Endpoint",
"endpointUrl": "https://developerconnect.us-west2.rep.googleapis.com/",
"location": "us-west2"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.us-west3.rep.googleapis.com/",
+ "location": "us-west3"
+ },
+ {
+ "description": "Regional Endpoint",
+ "endpointUrl": "https://developerconnect.us-west4.rep.googleapis.com/",
+ "location": "us-west4"
}
],
"fullyEncodeReservedExpansion": true,
@@ -1800,7 +1955,7 @@
}
}
},
- "revision": "20260813",
+ "revision": "20260824",
"rootUrl": "https://developerconnect.googleapis.com/",
"schemas": {
"AccountConnector": {
@@ -2501,6 +2656,21 @@
},
"type": "object"
},
+ "FieldVisibility": {
+ "description": "Visibility rules for individual tool parameters (fields). This allows producers to hide specific fields in tools/list and tools/call.",
+ "id": "FieldVisibility",
+ "properties": {
+ "restriction": {
+ "description": "The visibility restriction labels for this field (comma-separated).",
+ "type": "string"
+ },
+ "selector": {
+ "description": "The name of the parameter in the input_schema or output_schema.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"FinishOAuthResponse": {
"description": "Message for responding to finishing an OAuth flow.",
"id": "FinishOAuthResponse",
@@ -3232,6 +3402,38 @@
},
"type": "object"
},
+ "McpToolVisibility": {
+ "description": "Profile describing the visibility restriction of an MCP tool. Key: \"google.com/tool.profiles/visibility.restriction\"",
+ "id": "McpToolVisibility",
+ "properties": {
+ "fieldVisibility": {
+ "description": "A list of field-level visibility restrictions.",
+ "items": {
+ "$ref": "FieldVisibility"
+ },
+ "type": "array"
+ },
+ "visibilityEnforcementStrategy": {
+ "description": "The strategy used to enforce visibility restrictions. DO NOT USE. This field is not yet implemented.",
+ "enum": [
+ "VISIBILITY_ENFORCEMENT_STRATEGY_UNSPECIFIED",
+ "COMBINE",
+ "OVERRIDE"
+ ],
+ "enumDescriptions": [
+ "Default. Equivalent to COMBINE.",
+ "The principal must satisfy both API-level tool-level) visibility restrictions.",
+ "Bypasses the API-level visibility restrictions check; access is determined solely by the tool-level visibility restrictions."
+ ],
+ "type": "string"
+ },
+ "visibilityRestriction": {
+ "description": "The visibility restriction labels for the tool itself (e.g., \"PRODUCER_DEFINED_PREVIEW\"). Multiple labels can be provided as a comma-separated string.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"OAuthCredential": {
"description": "Represents an OAuth token of the account that authorized the Connection, and associated metadata.",
"id": "OAuthCredential",
diff --git a/discovery/dlp-v2.json b/discovery/dlp-v2.json
index feda3a89a1e..4e5c36764d7 100644
--- a/discovery/dlp-v2.json
+++ b/discovery/dlp-v2.json
@@ -3545,7 +3545,7 @@
],
"parameters": {
"parent": {
- "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project or organization): + Projects scope: `projects/{project_id}/locations/{location_id}` + Organizations scope: `organizations/{org_id}/locations/{location_id}`",
+ "description": "Required. Parent resource name. The format of this value varies depending on the scope of the request (project): + Projects scope: `projects/{project_id}/locations/{location_id}`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
@@ -3634,7 +3634,7 @@
"type": "string"
},
"parent": {
- "description": "Required. Resource name of the organization or project, for example, `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`.",
+ "description": "Required. Resource name of the project, for example, `projects/project-id/locations/asia`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
@@ -5274,7 +5274,7 @@
}
}
},
- "revision": "20260808",
+ "revision": "20260825",
"rootUrl": "https://dlp.googleapis.com/",
"schemas": {
"GooglePrivacyDlpV2Action": {
diff --git a/discovery/file-v1.json b/discovery/file-v1.json
index 716ce00df11..041dd34a5cb 100644
--- a/discovery/file-v1.json
+++ b/discovery/file-v1.json
@@ -1206,7 +1206,7 @@
}
}
},
- "revision": "20260710",
+ "revision": "20260819",
"rootUrl": "https://file.googleapis.com/",
"schemas": {
"Backup": {
@@ -2486,6 +2486,10 @@
"endpointProject": {
"description": "Optional. Consumer service project in which the Private Service Connect endpoint would be set up. This is optional, and only relevant in case the network is a shared VPC. If this is not specified, the endpoint would be setup in the VPC host project.",
"type": "string"
+ },
+ "requestedIpAddress": {
+ "description": "Optional. Immutable. Optional: The desired IP address for the instance. If not specified, an IP will be automatically allocated. The IP must be from the subnetwork range configured in the Service Connection Policy. This effective ip address is set in the ip_addresses field. use 3 instead of 2 to avoid conflict with the reserved_ip_range field.",
+ "type": "string"
}
},
"type": "object"
diff --git a/discovery/firebaseappcheck-v1.json b/discovery/firebaseappcheck-v1.json
index 38301225b35..37a013b15e8 100644
--- a/discovery/firebaseappcheck-v1.json
+++ b/discovery/firebaseappcheck-v1.json
@@ -551,6 +551,35 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
+ },
+ "mintAppCheckToken": {
+ "description": "Mints a new App Check token for the specified Firebase App. This method is intended to be called from a privileged environment where the caller can be authorized via Cloud IAM; for example, using a service account. To call this method, the caller must have the [`firebaseappcheck.googleapis.com/tokens.mint`](https://firebase.google.com/docs/projects/iam/permissions#app-check) permission. Returns a MintAppCheckTokenResponse.",
+ "flatPath": "v1/projects/{projectsId}/apps/{appsId}:mintAppCheckToken",
+ "httpMethod": "POST",
+ "id": "firebaseappcheck.projects.apps.mintAppCheckToken",
+ "parameterOrder": [
+ "app"
+ ],
+ "parameters": {
+ "app": {
+ "description": "Required. The relative resource name of the app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/apps/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+app}:mintAppCheckToken",
+ "request": {
+ "$ref": "GoogleFirebaseAppcheckV1MintAppCheckTokenRequest"
+ },
+ "response": {
+ "$ref": "GoogleFirebaseAppcheckV1MintAppCheckTokenResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase"
+ ]
}
},
"resources": {
@@ -1535,7 +1564,7 @@
}
}
},
- "revision": "20260717",
+ "revision": "20260822",
"rootUrl": "https://firebaseappcheck.googleapis.com/",
"schemas": {
"GoogleFirebaseAppcheckV1AppAttestConfig": {
@@ -1971,6 +2000,17 @@
},
"type": "object"
},
+ "GoogleFirebaseAppcheckV1LimitedUseConfig": {
+ "description": "Configuration for a limited-use App Check token.",
+ "id": "GoogleFirebaseAppcheckV1LimitedUseConfig",
+ "properties": {
+ "jti": {
+ "description": "Optional. Specifies the desired `jti` claim (Section 4.1.7 of RFC 7519) in the returned App Check token. Limited-use App Check tokens with the same `jti` will be counted as the same token for the purposes of replay protection. The size of this field is limited to 500 bytes. If specified, its length must be at least 16 bytes. If this field is omitted or is empty, a randomly generated `jti` claim with length between 16 and 500 bytes (inclusive) will be used in the returned App Check token. Leaving this field empty is only recommended if your custom attestation provider itself is not vulnerable to replay attacks.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"GoogleFirebaseAppcheckV1ListDebugTokensResponse": {
"description": "Response message for the ListDebugTokens method.",
"id": "GoogleFirebaseAppcheckV1ListDebugTokensResponse",
@@ -2025,6 +2065,38 @@
},
"type": "object"
},
+ "GoogleFirebaseAppcheckV1MintAppCheckTokenRequest": {
+ "description": "Request message for the MintAppCheckToken method.",
+ "id": "GoogleFirebaseAppcheckV1MintAppCheckTokenRequest",
+ "properties": {
+ "limitedUseConfig": {
+ "$ref": "GoogleFirebaseAppcheckV1LimitedUseConfig",
+ "description": "Optional. If specified, the returned App Check token will be a limited-use token minted according to the specified configuration options."
+ },
+ "tokenTtl": {
+ "description": "Optional. If specified, the returned App Check token will be a session token, valid for the specified duration. Must be between 30 minutes and 7 days, inclusive.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GoogleFirebaseAppcheckV1MintAppCheckTokenResponse": {
+ "description": "Response message for the MintAppCheckToken method.",
+ "id": "GoogleFirebaseAppcheckV1MintAppCheckTokenResponse",
+ "properties": {
+ "token": {
+ "description": "The App Check token, used to access backend services protected by App Check. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and GCP project. This token is used to access Google services protected by App Check. These tokens can also be [verified by your own custom backends](https://firebase.google.com/docs/app-check/custom-resource-backend) using the Firebase Admin SDK or third-party libraries.",
+ "type": "string"
+ },
+ "ttl": {
+ "description": "The duration from the time this token is minted until its expiration. This field is intended to ease client-side token management, since the client may have clock skew, but is still able to accurately measure a duration.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"GoogleFirebaseAppcheckV1PlayIntegrityConfig": {
"description": "An app's Play Integrity configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangePlayIntegrityToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by the Play Integrity API; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create).",
"id": "GoogleFirebaseAppcheckV1PlayIntegrityConfig",
diff --git a/discovery/firebaseappcheck-v1beta.json b/discovery/firebaseappcheck-v1beta.json
index 2bfbbb4f286..585f237422c 100644
--- a/discovery/firebaseappcheck-v1beta.json
+++ b/discovery/firebaseappcheck-v1beta.json
@@ -612,6 +612,35 @@
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/firebase"
]
+ },
+ "mintAppCheckToken": {
+ "description": "Mints a new App Check token for the specified Firebase App. This method is intended to be called from a privileged environment where the caller can be authorized via Cloud IAM; for example, using a service account. To call this method, the caller must have the [`firebaseappcheck.googleapis.com/tokens.mint`](https://firebase.google.com/docs/projects/iam/permissions#app-check) permission. Returns a MintAppCheckTokenResponse.",
+ "flatPath": "v1beta/projects/{projectsId}/apps/{appsId}:mintAppCheckToken",
+ "httpMethod": "POST",
+ "id": "firebaseappcheck.projects.apps.mintAppCheckToken",
+ "parameterOrder": [
+ "app"
+ ],
+ "parameters": {
+ "app": {
+ "description": "Required. The relative resource name of the app, in the format: ``` projects/{project_number}/apps/{app_id} ``` If necessary, the `project_number` element can be replaced with the project ID of the Firebase project. Learn more about using project identifiers in Google's [AIP 2510](https://google.aip.dev/cloud/2510) standard.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/apps/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1beta/{+app}:mintAppCheckToken",
+ "request": {
+ "$ref": "GoogleFirebaseAppcheckV1betaMintAppCheckTokenRequest"
+ },
+ "response": {
+ "$ref": "GoogleFirebaseAppcheckV1betaMintAppCheckTokenResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/firebase"
+ ]
}
},
"resources": {
@@ -1697,7 +1726,7 @@
}
}
},
- "revision": "20260717",
+ "revision": "20260822",
"rootUrl": "https://firebaseappcheck.googleapis.com/",
"schemas": {
"GoogleFirebaseAppcheckV1betaAppAttestConfig": {
@@ -2187,6 +2216,17 @@
},
"type": "object"
},
+ "GoogleFirebaseAppcheckV1betaLimitedUseConfig": {
+ "description": "Configuration for a limited-use App Check token.",
+ "id": "GoogleFirebaseAppcheckV1betaLimitedUseConfig",
+ "properties": {
+ "jti": {
+ "description": "Optional. Specifies the desired `jti` claim (Section 4.1.7 of RFC 7519) in the returned App Check token. Limited-use App Check tokens with the same `jti` will be counted as the same token for the purposes of replay protection. The size of this field is limited to 500 bytes. If specified, its length must be at least 16 bytes. If this field is omitted or is empty, a randomly generated `jti` claim with length between 16 and 500 bytes (inclusive) will be used in the returned App Check token. Leaving this field empty is only recommended if your custom attestation provider itself is not vulnerable to replay attacks.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"GoogleFirebaseAppcheckV1betaListDebugTokensResponse": {
"description": "Response message for the ListDebugTokens method.",
"id": "GoogleFirebaseAppcheckV1betaListDebugTokensResponse",
@@ -2241,6 +2281,38 @@
},
"type": "object"
},
+ "GoogleFirebaseAppcheckV1betaMintAppCheckTokenRequest": {
+ "description": "Request message for the MintAppCheckToken method.",
+ "id": "GoogleFirebaseAppcheckV1betaMintAppCheckTokenRequest",
+ "properties": {
+ "limitedUseConfig": {
+ "$ref": "GoogleFirebaseAppcheckV1betaLimitedUseConfig",
+ "description": "Optional. If specified, the returned App Check token will be a limited-use token minted according to the specified configuration options."
+ },
+ "tokenTtl": {
+ "description": "Optional. If specified, the returned App Check token will be a session token, valid for the specified duration. Must be between 30 minutes and 7 days, inclusive.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "GoogleFirebaseAppcheckV1betaMintAppCheckTokenResponse": {
+ "description": "Response message for the MintAppCheckToken method.",
+ "id": "GoogleFirebaseAppcheckV1betaMintAppCheckTokenResponse",
+ "properties": {
+ "token": {
+ "description": "The App Check token, used to access backend services protected by App Check. App Check tokens are signed [JWTs](https://tools.ietf.org/html/rfc7519) containing claims that identify the attested app and GCP project. This token is used to access Google services protected by App Check. These tokens can also be [verified by your own custom backends](https://firebase.google.com/docs/app-check/custom-resource-backend) using the Firebase Admin SDK or third-party libraries.",
+ "type": "string"
+ },
+ "ttl": {
+ "description": "The duration from the time this token is minted until its expiration. This field is intended to ease client-side token management, since the client may have clock skew, but is still able to accurately measure a duration.",
+ "format": "google-duration",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"GoogleFirebaseAppcheckV1betaPlayIntegrityConfig": {
"description": "An app's Play Integrity configuration object. This configuration controls certain properties of the `AppCheckToken` returned by ExchangePlayIntegrityToken, such as its ttl. Note that your registered SHA-256 certificate fingerprints are used to validate tokens issued by the Play Integrity API; please register them via the Firebase Console or programmatically via the [Firebase Management Service](https://firebase.google.com/docs/projects/api/reference/rest/v1beta1/projects.androidApps.sha/create).",
"id": "GoogleFirebaseAppcheckV1betaPlayIntegrityConfig",
diff --git a/discovery/hypercomputecluster-v1.json b/discovery/hypercomputecluster-v1.json
index f77870d65c8..ef02874e611 100644
--- a/discovery/hypercomputecluster-v1.json
+++ b/discovery/hypercomputecluster-v1.json
@@ -498,7 +498,7 @@
}
}
},
- "revision": "20260729",
+ "revision": "20260820",
"rootUrl": "https://hypercomputecluster.googleapis.com/",
"schemas": {
"BootDisk": {
@@ -596,6 +596,11 @@
"description": "Optional. Storage resources available to the cluster. Keys specify the ID of the storage resource by which it can be referenced elsewhere, and must conform to [RFC-1034](https://datatracker.ietf.org/doc/html/rfc1034) (lower-case, alphanumeric, and at most 63 characters).",
"type": "object"
},
+ "uid": {
+ "description": "Output only. The globally unique identifier for this Cluster.",
+ "readOnly": true,
+ "type": "string"
+ },
"updateTime": {
"description": "Output only. Time that the cluster was most recently updated.",
"format": "google-datetime",
diff --git a/discovery/index.json b/discovery/index.json
index fc3d0a81f57..b70bd48e8f3 100644
--- a/discovery/index.json
+++ b/discovery/index.json
@@ -241,6 +241,21 @@
"title": "Advisory Notifications API",
"version": "v1"
},
+ {
+ "description": "Agencies and brands API is an externally available HTTP API for ad agencies and brands to programmatically manage their deals and spending with Google Ad Manager publishers.",
+ "discoveryRestUrl": "https://agenciesandbrands.googleapis.com/$discovery/rest?version=v1",
+ "documentationLink": "https://developers.google.com/authorized-buyers/agencies-and-brands/get-started/start",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "id": "agenciesandbrands:v1",
+ "kind": "discovery#directoryItem",
+ "name": "agenciesandbrands",
+ "preferred": true,
+ "title": "Agencies and Brands API",
+ "version": "v1"
+ },
{
"description": "",
"discoveryRestUrl": "https://agentidentity.googleapis.com/$discovery/rest?version=v1alpha",
@@ -2358,21 +2373,6 @@
"title": "Container Analysis API",
"version": "v1"
},
- {
- "description": "This API is deprecated. Please use Merchant API instead: https://developers.google.com/merchant/api.",
- "discoveryRestUrl": "https://shoppingcontent.googleapis.com/$discovery/rest?version=v2.1",
- "documentationLink": "https://developers.google.com/shopping-content/v2/",
- "icons": {
- "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
- "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
- },
- "id": "content:v2.1",
- "kind": "discovery#directoryItem",
- "name": "content",
- "preferred": true,
- "title": "Content API for Shopping",
- "version": "v2.1"
- },
{
"description": "",
"discoveryRestUrl": "https://contentwarehouse.googleapis.com/$discovery/rest?version=v1",
@@ -2403,6 +2403,21 @@
"title": "CSS API",
"version": "v1"
},
+ {
+ "description": "Curation partners API is an externally available HTTP API for curators to programmatically manage their data segments and curated packages used by ad agencies.",
+ "discoveryRestUrl": "https://curationpartners.googleapis.com/$discovery/rest?version=v1",
+ "documentationLink": "https://developers.google.com/authorized-buyers/curation/apis/guides/curationpartners/overview",
+ "icons": {
+ "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
+ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png"
+ },
+ "id": "curationpartners:v1",
+ "kind": "discovery#directoryItem",
+ "name": "curationpartners",
+ "preferred": true,
+ "title": "Curation Partners API",
+ "version": "v1"
+ },
{
"description": "Searches over a website or collection of websites",
"discoveryRestUrl": "https://customsearch.googleapis.com/$discovery/rest?version=v1",
diff --git a/discovery/mybusinessbusinessinformation-v1.json b/discovery/mybusinessbusinessinformation-v1.json
index f4fc058ef7b..c65a5a656da 100644
--- a/discovery/mybusinessbusinessinformation-v1.json
+++ b/discovery/mybusinessbusinessinformation-v1.json
@@ -612,7 +612,7 @@
}
}
},
- "revision": "20260809",
+ "revision": "20260826",
"rootUrl": "https://mybusinessbusinessinformation.googleapis.com/",
"schemas": {
"AdWordsLocationExtensions": {
@@ -1647,10 +1647,10 @@
"properties": {
"closeTime": {
"$ref": "TimeOfDay",
- "description": "Optional. Valid values are `00:00-24:00`, where `24:00` represents midnight at the end of the specified day field. It must be specified if `closed` is `false`. Note: In Proto3 JSON mapping, default zero values (`00:00`) are omitted, producing `{}` for `close_time`."
+ "description": "Optional. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false."
},
"closed": {
- "description": "Optional. If `true`, `end_date`, `open_time`, and `close_time` are ignored, and the date specified in `start_date` is treated as the location being closed for the entire day.",
+ "description": "Optional. If true, `end_date`, `open_time`, and `close_time` are ignored, and the date specified in `start_date` is treated as the location being closed for the entire day.",
"type": "boolean"
},
"endDate": {
@@ -1659,7 +1659,7 @@
},
"openTime": {
"$ref": "TimeOfDay",
- "description": "Optional. Valid values are `00:00-24:00`, where `24:00` represents midnight at the end of the specified day field. It must be specified if `closed` is `false`. Note: In Proto3 JSON mapping, default zero values (`00:00`) are omitted, producing `{}` for `open_time`."
+ "description": "Optional. Valid values are 00:00-24:00 where 24:00 represents midnight at the end of the specified day field. Must be specified if `closed` is false."
},
"startDate": {
"$ref": "Date",
@@ -1754,7 +1754,7 @@
},
"closeTime": {
"$ref": "TimeOfDay",
- "description": "Required. Valid values are `00:00-24:00`, where `24:00` represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (`00:00`) are omitted, producing `{}` for `close_time`."
+ "description": "Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for close_time."
},
"openDay": {
"description": "Required. Indicates the day of the week this period starts on.",
@@ -1782,7 +1782,7 @@
},
"openTime": {
"$ref": "TimeOfDay",
- "description": "Required. Valid values are `00:00-24:00`, where `24:00` represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (`00:00`) are omitted, producing `{}` for `open_time`."
+ "description": "Required. Valid values are 00:00-24:00, where 24:00 represents midnight at the end of the specified day field. Note: In Proto3 JSON mapping, default zero values (00:00) are omitted, producing `{}` for open_time."
}
},
"type": "object"
diff --git a/discovery/networksecurity-v1.json b/discovery/networksecurity-v1.json
index 8f6928cace6..46167ad93a6 100644
--- a/discovery/networksecurity-v1.json
+++ b/discovery/networksecurity-v1.json
@@ -6141,7 +6141,7 @@
}
}
},
- "revision": "20260729",
+ "revision": "20260824",
"rootUrl": "https://networksecurity.googleapis.com/",
"schemas": {
"AddAddressGroupItemsRequest": {
@@ -6353,18 +6353,20 @@
"id": "AuthzPolicy",
"properties": {
"action": {
- "description": "Required. Can be one of `ALLOW`, `DENY`, `CUSTOM`. When the action is `CUSTOM`, `customProvider` must be specified. When the action is `ALLOW`, only requests matching the policy will be allowed. When the action is `DENY`, only requests matching the policy will be denied. When a request arrives, the policies are evaluated in the following order: 1. If there is a `CUSTOM` policy that matches the request, the `CUSTOM` policy is evaluated using the custom authorization providers and the request is denied if the provider rejects the request. 2. If there are any `DENY` policies that match the request, the request is denied. 3. If there are no `ALLOW` policies for the resource or if any of the `ALLOW` policies match the request, the request is allowed. 4. Else the request is denied by default if none of the configured AuthzPolicies with `ALLOW` action match the request.",
+ "description": "Required. Can be one of `ALLOW`, `DENY`, `CUSTOM`, `DENY_BY_DEFAULT`. When the action is `CUSTOM`, `customProvider` must be specified. When the action is `ALLOW`, only requests matching the policy will be allowed. When the action is `DENY`, only requests matching the policy will be denied. When the action is `DENY_BY_DEFAULT`, no `http_rules` or `network_rules` can be specified. When a request arrives, the policies are evaluated in the following order: 1. If there is a `CUSTOM` policy that matches the request, the `CUSTOM` policy is evaluated using the custom authorization providers and the request is denied if the provider rejects the request. 2. If there are any `DENY` policies that match the request, the request is denied. 3. If any of the `ALLOW` policies match the request, the request is allowed. 4. If a `DENY_BY_DEFAULT` policy is applied to the resource, the request is denied (unless it was explicitly allowed by a `CUSTOM` or `ALLOW` policy). 5. Else, the request is allowed by default if no other policies are configured.",
"enum": [
"AUTHZ_ACTION_UNSPECIFIED",
"ALLOW",
"DENY",
- "CUSTOM"
+ "CUSTOM",
+ "DENY_BY_DEFAULT"
],
"enumDescriptions": [
"Unspecified action.",
"Allow request to pass through to the backend.",
"Deny the request and return a HTTP 404 to the client.",
- "Delegate the authorization decision to an external authorization engine."
+ "Delegate the authorization decision to an external authorization engine.",
+ "Establishes a secure-by-default posture by denying any request not explicitly matched by any `ALLOW`, `DENY`, or `CUSTOM` policy. This action serves as a universal fallback: if no other policies match or are configured, the request is denied."
],
"type": "string"
},
@@ -6728,7 +6730,7 @@
"id": "AuthzPolicyAuthzRuleToRequestOperationMCPMethod",
"properties": {
"name": {
- "description": "Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2.",
+ "description": "Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2.",
"type": "string"
},
"params": {
@@ -6781,7 +6783,7 @@
"id": "AuthzPolicyTarget",
"properties": {
"loadBalancingScheme": {
- "description": "Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).",
+ "description": "Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. Supported values include `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).",
"enum": [
"LOAD_BALANCING_SCHEME_UNSPECIFIED",
"INTERNAL_MANAGED",
@@ -9848,6 +9850,20 @@
"description": "Required. A CA pool resource used to issue interception certificates. The CA pool string has a relative resource path following the form \"projects/{project}/locations/{location}/caPools/{ca_pool}\".",
"type": "string"
},
+ "certificateIssuanceMode": {
+ "description": "Optional. The mode used to issue certificates (local CA signing vs direct leaf).",
+ "enum": [
+ "CERTIFICATE_ISSUANCE_MODE_UNSPECIFIED",
+ "DIRECT_LEAF_PROVISIONING",
+ "LOCAL_INTERMEDIATE_CA_SIGNING"
+ ],
+ "enumDescriptions": [
+ "Unspecified default mode.",
+ "Fallback: Direct Private CA leaf certificate provisioning.",
+ "High-speed Local Intermediate CA signing."
+ ],
+ "type": "string"
+ },
"createTime": {
"description": "Output only. The timestamp when the resource was created.",
"format": "google-datetime",
diff --git a/discovery/networksecurity-v1beta1.json b/discovery/networksecurity-v1beta1.json
index d369c039ee5..3f65ece5a06 100644
--- a/discovery/networksecurity-v1beta1.json
+++ b/discovery/networksecurity-v1beta1.json
@@ -6346,7 +6346,7 @@
}
}
},
- "revision": "20260729",
+ "revision": "20260824",
"rootUrl": "https://networksecurity.googleapis.com/",
"schemas": {
"AddAddressGroupItemsRequest": {
@@ -6558,18 +6558,20 @@
"id": "AuthzPolicy",
"properties": {
"action": {
- "description": "Required. Can be one of `ALLOW`, `DENY`, `CUSTOM`. When the action is `CUSTOM`, `customProvider` must be specified. When the action is `ALLOW`, only requests matching the policy will be allowed. When the action is `DENY`, only requests matching the policy will be denied. When a request arrives, the policies are evaluated in the following order: 1. If there is a `CUSTOM` policy that matches the request, the `CUSTOM` policy is evaluated using the custom authorization providers and the request is denied if the provider rejects the request. 2. If there are any `DENY` policies that match the request, the request is denied. 3. If there are no `ALLOW` policies for the resource or if any of the `ALLOW` policies match the request, the request is allowed. 4. Else the request is denied by default if none of the configured AuthzPolicies with `ALLOW` action match the request.",
+ "description": "Required. Can be one of `ALLOW`, `DENY`, `CUSTOM`, `DENY_BY_DEFAULT`. When the action is `CUSTOM`, `customProvider` must be specified. When the action is `ALLOW`, only requests matching the policy will be allowed. When the action is `DENY`, only requests matching the policy will be denied. When the action is `DENY_BY_DEFAULT`, no `http_rules` or `network_rules` can be specified. When a request arrives, the policies are evaluated in the following order: 1. If there is a `CUSTOM` policy that matches the request, the `CUSTOM` policy is evaluated using the custom authorization providers and the request is denied if the provider rejects the request. 2. If there are any `DENY` policies that match the request, the request is denied. 3. If any of the `ALLOW` policies match the request, the request is allowed. 4. If a `DENY_BY_DEFAULT` policy is applied to the resource, the request is denied (unless it was explicitly allowed by a `CUSTOM` or `ALLOW` policy). 5. Else, the request is allowed by default if no other policies are configured.",
"enum": [
"AUTHZ_ACTION_UNSPECIFIED",
"ALLOW",
"DENY",
- "CUSTOM"
+ "CUSTOM",
+ "DENY_BY_DEFAULT"
],
"enumDescriptions": [
"Unspecified action.",
"Allow request to pass through to the backend.",
"Deny the request and return a HTTP 404 to the client.",
- "Delegate the authorization decision to an external authorization engine."
+ "Delegate the authorization decision to an external authorization engine.",
+ "Establishes a secure-by-default posture by denying any request not explicitly matched by any `ALLOW`, `DENY`, or `CUSTOM` policy. This action serves as a universal fallback: if no other policies match or are configured, the request is denied."
],
"type": "string"
},
@@ -6933,7 +6935,7 @@
"id": "AuthzPolicyAuthzRuleToRequestOperationMCPMethod",
"properties": {
"name": {
- "description": "Required. The MCP method to match against. Allowed values are as follows: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2.",
+ "description": "Required. The MCP method to match against. Allowed values include: 1. `tools`, `prompts`, `resources` - these will match against all sub methods under the respective methods. 2. `prompts/list`, `tools/list`, `resources/list`, `resources/templates/list` 3. `prompts/get`, `tools/call`, `resources/subscribe`, `resources/unsubscribe`, `resources/read` Params cannot be specified for categories 1 and 2.",
"type": "string"
},
"params": {
@@ -6986,7 +6988,7 @@
"id": "AuthzPolicyTarget",
"properties": {
"loadBalancingScheme": {
- "description": "Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).",
+ "description": "Optional. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Required only when targeting forwarding rules. If targeting Secure Web Proxy, this field must be `INTERNAL_MANAGED` or not specified. Must not be specified when targeting Agent Gateway. Supported values include `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).",
"enum": [
"LOAD_BALANCING_SCHEME_UNSPECIFIED",
"INTERNAL_MANAGED",
@@ -7325,6 +7327,11 @@
"$ref": "FirewallEndpointEndpointSettings",
"description": "Optional. Settings for the endpoint."
},
+ "explicitPrivateServiceConnectAttachment": {
+ "description": "Output only. The resource name of the explicit PSC Attachment. Format: projects/{project}/regions/{region}/serviceAttachments/{id}",
+ "readOnly": true,
+ "type": "string"
+ },
"labels": {
"additionalProperties": {
"type": "string"
@@ -7499,7 +7506,7 @@
"ITALY"
],
"enumDescriptions": [
- "PAN content cloud region not specified.",
+ "Palo Alto Networks content cloud region not specified.",
"us.hawkeye.services-edge.paloaltonetworks.com",
"APAC content cloud portal: apac.hawkeye.services-edge.paloaltonetworks.com",
"India content cloud portal: in.hawkeye.services-edge.paloaltonetworks.com",
@@ -7563,7 +7570,7 @@
"type": "string"
},
"wildfireRegion": {
- "description": "Optional. The region where WildFire analysis will be performed. PAN supports regions: https://docs.paloaltonetworks.com/advanced-wildfire/administration/advanced-wildfire-overview/advanced-wildfire-deployments/advanced-wildfire-global-cloud",
+ "description": "Optional. The region where WildFire analysis will be performed. Palo Alto Networks supports regions: https://docs.paloaltonetworks.com/advanced-wildfire/administration/advanced-wildfire-overview/advanced-wildfire-deployments/advanced-wildfire-global-cloud",
"enum": [
"WILDFIRE_REGION_UNSPECIFIED",
"CANADA",
@@ -10321,6 +10328,20 @@
"description": "Required. A CA pool resource used to issue interception certificates. The CA pool string has a relative resource path following the form \"projects/{project}/locations/{location}/caPools/{ca_pool}\".",
"type": "string"
},
+ "certificateIssuanceMode": {
+ "description": "Optional. The mode used to issue certificates (local CA signing vs direct leaf).",
+ "enum": [
+ "CERTIFICATE_ISSUANCE_MODE_UNSPECIFIED",
+ "DIRECT_LEAF_PROVISIONING",
+ "LOCAL_INTERMEDIATE_CA_SIGNING"
+ ],
+ "enumDescriptions": [
+ "Unspecified default mode.",
+ "Fallback: Direct Private CA leaf certificate provisioning.",
+ "High-speed Local Intermediate CA signing."
+ ],
+ "type": "string"
+ },
"createTime": {
"description": "Output only. The timestamp when the resource was created.",
"format": "google-datetime",
diff --git a/discovery/recaptchaenterprise-v1.json b/discovery/recaptchaenterprise-v1.json
index 663ea89f95a..709b7b03d13 100644
--- a/discovery/recaptchaenterprise-v1.json
+++ b/discovery/recaptchaenterprise-v1.json
@@ -845,7 +845,7 @@
}
}
},
- "revision": "20260719",
+ "revision": "20260825",
"rootUrl": "https://recaptchaenterprise.googleapis.com/",
"schemas": {
"GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": {
@@ -2496,6 +2496,11 @@
"readOnly": true,
"type": "string"
},
+ "clientSignalsFailed": {
+ "description": "Output only. Indicates a failure collecting reCAPTCHA signals at token generation. This might be a transient condition, or persistent for a user’s environment.",
+ "readOnly": true,
+ "type": "boolean"
+ },
"createTime": {
"description": "Output only. The timestamp corresponding to the generation of the token.",
"format": "google-datetime",
@@ -2915,7 +2920,7 @@
"type": "array"
},
"challengeSecurityPreference": {
- "description": "Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for `IntegrationType` CHECKBOX, INVISIBLE or POLICY_BASED_CHALLENGE.",
+ "description": "Optional. Settings for the frequency and difficulty at which this key triggers captcha challenges. This should only be specified for `IntegrationType` CHECKBOX (defaults to BALANCE), INVISIBLE (defaults to USABILITY), or POLICY_BASED_CHALLENGE (defaults to USABILITY).",
"enum": [
"CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED",
"USABILITY",
diff --git a/discovery/retail-v2alpha.json b/discovery/retail-v2alpha.json
index 399f5515bb4..fa508e10e09 100644
--- a/discovery/retail-v2alpha.json
+++ b/discovery/retail-v2alpha.json
@@ -2874,7 +2874,7 @@
}
}
},
- "revision": "20260813",
+ "revision": "20260826",
"rootUrl": "https://retail.googleapis.com/",
"schemas": {
"GoogleApiHttpBody": {
@@ -4330,6 +4330,13 @@
"description": "Response of the autocomplete query.",
"id": "GoogleCloudRetailV2alphaCompleteQueryResponse",
"properties": {
+ "agentPrompts": {
+ "description": "Conversational prompts to trigger agents like Shopping Agent. This is an experimental feature for select customers.",
+ "items": {
+ "$ref": "GoogleCloudRetailV2alphaCompleteQueryResponseAgentPrompt"
+ },
+ "type": "array"
+ },
"attributeResults": {
"additionalProperties": {
"$ref": "GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult"
@@ -4359,6 +4366,17 @@
},
"type": "object"
},
+ "GoogleCloudRetailV2alphaCompleteQueryResponseAgentPrompt": {
+ "description": "A conversational prompt to trigger agents like Shopping Agent.",
+ "id": "GoogleCloudRetailV2alphaCompleteQueryResponseAgentPrompt",
+ "properties": {
+ "prompt": {
+ "description": "The conversational prompt string.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult": {
"description": "Resource that represents attribute results.",
"id": "GoogleCloudRetailV2alphaCompleteQueryResponseAttributeResult",
@@ -4378,9 +4396,10 @@
"id": "GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResult",
"properties": {
"agentPrompts": {
- "description": "Conversational prompts to trigger agents like Shopping Agent. There may be multiple prompts for a single suggestion. This is an experimental feature for select customers. If you want to receive this prompt information, reach out to the Retail support team.",
+ "deprecated": true,
+ "description": "Deprecated: Use CompleteQueryResponse.agent_prompts instead. Conversational prompts to trigger agents like Shopping Agent. There may be multiple prompts for a single suggestion. This is an experimental feature for select customers.",
"items": {
- "$ref": "GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResultAgentPrompt"
+ "$ref": "GoogleCloudRetailV2alphaCompleteQueryResponseAgentPrompt"
},
"type": "array"
},
@@ -4410,17 +4429,6 @@
},
"type": "object"
},
- "GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResultAgentPrompt": {
- "description": "A conversational prompt to trigger agents like Shopping Agent.",
- "id": "GoogleCloudRetailV2alphaCompleteQueryResponseCompletionResultAgentPrompt",
- "properties": {
- "prompt": {
- "description": "The conversational prompt string.",
- "type": "string"
- }
- },
- "type": "object"
- },
"GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult": {
"deprecated": true,
"description": "Deprecated: Recent search of this user.",
diff --git a/discovery/serviceusage-v1.json b/discovery/serviceusage-v1.json
index f56b8cdd87c..912627c4260 100644
--- a/discovery/serviceusage-v1.json
+++ b/discovery/serviceusage-v1.json
@@ -431,7 +431,7 @@
}
}
},
- "revision": "20260818",
+ "revision": "20260819",
"rootUrl": "https://serviceusage.googleapis.com/",
"schemas": {
"AddEnableRulesMetadata": {
@@ -1565,7 +1565,8 @@
"id": "EnableRule",
"properties": {
"enableType": {
- "description": "Client and resource project enable type.",
+ "deprecated": true,
+ "description": "Deprecated: EnableType is not supported.",
"enum": [
"ENABLE_TYPE_UNSPECIFIED",
"CLIENT",
diff --git a/discovery/serviceusage-v1beta1.json b/discovery/serviceusage-v1beta1.json
index f788ec584e7..2dae57c8e20 100644
--- a/discovery/serviceusage-v1beta1.json
+++ b/discovery/serviceusage-v1beta1.json
@@ -969,7 +969,7 @@
}
}
},
- "revision": "20260818",
+ "revision": "20260819",
"rootUrl": "https://serviceusage.googleapis.com/",
"schemas": {
"AddEnableRulesMetadata": {
@@ -2156,7 +2156,8 @@
"id": "EnableRule",
"properties": {
"enableType": {
- "description": "Client and resource project enable type.",
+ "deprecated": true,
+ "description": "Deprecated: EnableType is not supported.",
"enum": [
"ENABLE_TYPE_UNSPECIFIED",
"CLIENT",
diff --git a/discovery/sqladmin-v1.json b/discovery/sqladmin-v1.json
index b810742167e..0789f28cc36 100644
--- a/discovery/sqladmin-v1.json
+++ b/discovery/sqladmin-v1.json
@@ -664,6 +664,192 @@
}
}
},
+ "blueGreenDeployments": {
+ "methods": {
+ "create": {
+ "description": "Creates a blue-green deployment under a given project and location.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blueGreenDeployments",
+ "httpMethod": "POST",
+ "id": "sql.blueGreenDeployments.create",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "blueGreenDeploymentId": {
+ "description": "Required. The ID to use for the blue-green deployment, which will become the final component of the deployment's resource name. The ID must be unique within the given project and location and between 2-63 characters.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Required. The parent resource where this blue-green deployment will be created. Format: projects/{project}/locations/{location}",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/blueGreenDeployments",
+ "request": {
+ "$ref": "BlueGreenDeployment"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/sqlservice.admin"
+ ]
+ },
+ "delete": {
+ "description": "Deletes a blue-green deployment.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blueGreenDeployments/{blueGreenDeploymentsId}",
+ "httpMethod": "DELETE",
+ "id": "sql.blueGreenDeployments.delete",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "deleteOldSource": {
+ "description": "Optional. If set to true, and the switchover is complete, this deletes the old source instance along with the deployment.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "name": {
+ "description": "Required. The name of the blue-green deployment to delete. Format: projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment}",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/blueGreenDeployments/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/sqlservice.admin"
+ ]
+ },
+ "get": {
+ "description": "Retrieves a blue-green deployment resource under a given project and location.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blueGreenDeployments/{blueGreenDeploymentsId}",
+ "httpMethod": "GET",
+ "id": "sql.blueGreenDeployments.get",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the blue-green deployment to retrieve. Format: projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment}",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/blueGreenDeployments/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
+ "view": {
+ "description": "Optional. Specifies whether to return the basic or detailed view of the resource in the response.",
+ "enum": [
+ "BLUE_GREEN_DEPLOYMENT_VIEW_UNSPECIFIED",
+ "BASIC",
+ "DETAILED"
+ ],
+ "enumDescriptions": [
+ "Blue-green deployment view enumeration. This allows the caller to specify what view they query. If unspecified (BLUE_GREEN_DEPLOYMENT_VIEW_UNSPECIFIED), the behavior is the same as BASIC.",
+ "Includes basic metadata about the blue-green deployment. `BASIC` is the default view.",
+ "Includes basic metadata and configuration differences between source and target instances (`database_version`, `tier`, `edition`, `availability_type`, `data_disk_size_gb`, and `data_disk_type`)."
+ ],
+ "location": "query",
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}",
+ "response": {
+ "$ref": "BlueGreenDeployment"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/sqlservice.admin"
+ ]
+ },
+ "list": {
+ "description": "Lists blue-green deployments under a given project.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blueGreenDeployments",
+ "httpMethod": "GET",
+ "id": "sql.blueGreenDeployments.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "filter": {
+ "description": "Optional. A filter expression that filters the results.",
+ "location": "query",
+ "type": "string"
+ },
+ "orderBy": {
+ "description": "Optional. A comma-separated list of fields to order the results by.",
+ "location": "query",
+ "type": "string"
+ },
+ "pageSize": {
+ "description": "Optional. The maximum number of deployments to return. The service may return fewer deployments than this value. If unspecified, at most 500 deployments are returned. The maximum value is 1000; values above 1000 are treated as 1000.",
+ "format": "int32",
+ "location": "query",
+ "type": "integer"
+ },
+ "pageToken": {
+ "description": "Optional. A page token, received from a previous `ListBlueGreenDeployments` call. Provide this to retrieve the subsequent page.",
+ "location": "query",
+ "type": "string"
+ },
+ "parent": {
+ "description": "Required. The parent resource whose blue-green deployments are to be listed. Format: projects/{project}/locations/{location}",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/blueGreenDeployments",
+ "response": {
+ "$ref": "ListBlueGreenDeploymentsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/sqlservice.admin"
+ ]
+ },
+ "switchover": {
+ "description": "Switches over to green instance for a blue-green deployment.",
+ "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blueGreenDeployments/{blueGreenDeploymentsId}:switchover",
+ "httpMethod": "POST",
+ "id": "sql.blueGreenDeployments.switchover",
+ "parameterOrder": [
+ "name"
+ ],
+ "parameters": {
+ "name": {
+ "description": "Required. The name of the blue-green deployment to switch over. Format: projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment}",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/blueGreenDeployments/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+name}:switchover",
+ "request": {
+ "$ref": "SwitchoverBlueGreenDeploymentRequest"
+ },
+ "response": {
+ "$ref": "Operation"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/cloud-platform",
+ "https://www.googleapis.com/auth/sqlservice.admin"
+ ]
+ }
+ }
+ },
"connect": {
"methods": {
"generateEphemeralCert": {
@@ -798,6 +984,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
@@ -837,6 +1028,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
@@ -869,6 +1065,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
@@ -904,6 +1105,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
@@ -943,6 +1149,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
@@ -985,6 +1196,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
@@ -1065,6 +1281,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Required. Project ID of the project that contains the instance.",
"location": "path",
@@ -1097,6 +1318,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Required. Project ID of the project that contains the instance.",
"location": "path",
@@ -1129,6 +1355,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Required. Project ID of the project that contains the instance.",
"location": "path",
@@ -1164,6 +1395,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Required. Project ID of the project that contains the instance.",
"location": "path",
@@ -1199,6 +1435,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Required. Project ID of the project that contains the instance (Example: project-id).",
"location": "path",
@@ -1234,6 +1475,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Required. Project ID of the project that contains the instance.",
"location": "path",
@@ -1266,6 +1512,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
@@ -1298,6 +1549,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
@@ -1330,6 +1586,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Required. Project ID of the source Cloud SQL instance.",
"location": "path",
@@ -1387,6 +1648,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance to be deleted.",
"location": "path",
@@ -1419,6 +1685,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Required. ID of the project that contains the instance.",
"location": "path",
@@ -1454,6 +1725,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "ID of the project that contains the instance.",
"location": "path",
@@ -1489,6 +1765,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Required. Project ID of the project that contains the instance.",
"location": "path",
@@ -1524,6 +1805,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance to be exported.",
"location": "path",
@@ -1558,6 +1844,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "ID of the project that contains the read replica.",
"location": "path",
@@ -1593,6 +1884,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Required. Project ID of the project that contains the instance.",
"location": "path",
@@ -1625,6 +1921,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
@@ -1652,6 +1953,11 @@
"project"
],
"parameters": {
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project to which the newly created Cloud SQL instances should belong.",
"location": "path",
@@ -1685,6 +1991,11 @@
"location": "query",
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"maxResults": {
"description": "The maximum number of instances to return. The service may return fewer than this value. If unspecified, at most 500 instances are returned. The maximum value is 1000; values above 1000 are coerced to 1000.",
"format": "uint32",
@@ -1728,6 +2039,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
@@ -1760,6 +2076,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
@@ -1834,6 +2155,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Required. Project ID of the project that contains the instance.",
"location": "path",
@@ -1874,6 +2200,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "ID of the project that contains the read replica.",
"location": "path",
@@ -1906,6 +2237,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "ID of the project that contains the instance.",
"location": "path",
@@ -1941,6 +2277,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Required. The project ID that contains the instance.",
"location": "path",
@@ -1973,6 +2314,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"mode": {
"description": "Optional. Reset SSL mode to use.",
"enum": [
@@ -2020,6 +2366,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance to be restarted.",
"location": "path",
@@ -2052,6 +2403,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
@@ -2087,6 +2443,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
@@ -2122,6 +2483,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "ID of the project that contains the read replica.",
"location": "path",
@@ -2154,6 +2520,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "ID of the project that contains the read replica.",
"location": "path",
@@ -2192,6 +2563,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "ID of the project that contains the replica.",
"location": "path",
@@ -2224,6 +2600,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the Cloud SQL project.",
"location": "path",
@@ -2259,6 +2640,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
@@ -2424,6 +2810,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
@@ -2456,6 +2847,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
@@ -2494,6 +2890,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
@@ -2529,6 +2930,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "ID of the project that contains the instance.",
"location": "path",
@@ -2675,6 +3081,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the Cloud SQL project.",
"location": "path",
@@ -2893,6 +3304,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"name": {
"description": "Name of the user in the instance.",
"location": "query",
@@ -2936,6 +3352,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"name": {
"description": "User of the instance.",
"location": "path",
@@ -2974,6 +3395,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
@@ -3009,6 +3435,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"project": {
"description": "Project ID of the project that contains the instance.",
"location": "path",
@@ -3052,6 +3483,11 @@
"required": true,
"type": "string"
},
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "location": "query",
+ "type": "string"
+ },
"name": {
"description": "Name of the user in the instance.",
"location": "query",
@@ -3095,7 +3531,7 @@
}
}
},
- "revision": "20260722",
+ "revision": "20260819",
"rootUrl": "https://sqladmin.googleapis.com/",
"schemas": {
"AclEntry": {
@@ -4053,6 +4489,119 @@
},
"type": "object"
},
+ "BlueGreenDeployment": {
+ "description": "A `BlueGreenDeployment` resource represents a Cloud SQL blue-green deployment setup.",
+ "id": "BlueGreenDeployment",
+ "properties": {
+ "createTime": {
+ "description": "Output only. The time when the deployment was created. Example: `2024-01-01T00:00:00Z`",
+ "format": "google-datetime",
+ "readOnly": true,
+ "type": "string"
+ },
+ "deploymentMappings": {
+ "description": "Output only. A list representing the pairs of source and target instances in the deployment.",
+ "items": {
+ "$ref": "SourceTargetPairedNode"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
+ "deploymentTasks": {
+ "$ref": "DeploymentTasks",
+ "description": "Output only. Combined list of tasks for all paired nodes.",
+ "readOnly": true
+ },
+ "description": {
+ "description": "Optional. User-provided description for the deployment. The description can be up to 255 characters long.",
+ "type": "string"
+ },
+ "errorDetail": {
+ "description": "Output only. Provides details on why switchover is not possible. This field is empty unless a switchover attempt failed or the state is `SWITCHOVER_NOT_READY`. Example: \"The target database version does not match the source instance database version.\"",
+ "readOnly": true,
+ "type": "string"
+ },
+ "name": {
+ "description": "Output only. Identifier. The full resource name of the deployment. Format: projects/{project}/locations/{location}/blueGreenDeployments/{deployment_id}",
+ "readOnly": true,
+ "type": "string"
+ },
+ "requestedConfig": {
+ "$ref": "RequestedConfig",
+ "description": "Optional. Immutable. Optional on create, and immutable. The configuration intended for the target instance(s) when the deployment was created."
+ },
+ "sourceInstance": {
+ "description": "Required. Immutable. Required on create, and immutable. The full resource name of the source instance (the \"blue\" instance). Format: projects/{project}/instances/{instance}",
+ "type": "string"
+ },
+ "state": {
+ "description": "Output only. The current state of the blue-green deployment.",
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "PROVISIONING",
+ "SWITCHOVER_READY",
+ "SWITCHOVER_NOT_READY",
+ "SWITCHOVER_IN_PROGRESS",
+ "SWITCHOVER_COMPLETED",
+ "DELETING"
+ ],
+ "enumDescriptions": [
+ "The default value. This value is used if the state is omitted or unknown.",
+ "The deployment is being provisioned.",
+ "The deployment is ready for switchover.",
+ "The deployment is not ready for switchover.",
+ "The deployment is in the process of switching over.",
+ "The deployment has completed switchover.",
+ "The deployment is being deleted."
+ ],
+ "readOnly": true,
+ "type": "string"
+ },
+ "switchoverTargetInstance": {
+ "description": "Output only. The full resource name of the primary target instance (the \"green\" instance) that will be promoted during switchover. This field is always populated once the deployment is created. Format: projects/{project}/instances/{instance}",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "BlueGreenDeploymentInfo": {
+ "description": "Blue-green deployment metadata for a database instance. In a blue-green deployment, we maintain two environments, one of which is live. This message contains details about the blue-green deployment.",
+ "id": "BlueGreenDeploymentInfo",
+ "properties": {
+ "deploymentId": {
+ "description": "Output only. The resource ID of the blue-green deployment.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "source": {
+ "$ref": "SourceRole",
+ "description": "Output only. The source instance for the Blue-Green deployment.",
+ "readOnly": true
+ },
+ "state": {
+ "description": "Output only. The current state of blue-green-deployment for UI tags",
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "PRE_SWITCHOVER",
+ "POST_SWITCHOVER"
+ ],
+ "enumDescriptions": [
+ "The state of the deployment is unknown.",
+ "The deployment is pre-switchover.",
+ "The deployment is post-switchover."
+ ],
+ "readOnly": true,
+ "type": "string"
+ },
+ "target": {
+ "$ref": "TargetRole",
+ "description": "Output only. The target instance for the Blue-Green deployment.",
+ "readOnly": true
+ }
+ },
+ "type": "object"
+ },
"CloneContext": {
"description": "Database instance clone context.",
"id": "CloneContext",
@@ -4129,6 +4678,28 @@
},
"type": "object"
},
+ "ConfigDiff": {
+ "description": "Represents a specific configuration difference between blue and green instances.",
+ "id": "ConfigDiff",
+ "properties": {
+ "field": {
+ "description": "Output only. The name of the field that differs in the blue and green instances, fully-qualified. Example: `settings.tier`",
+ "readOnly": true,
+ "type": "string"
+ },
+ "sourceValue": {
+ "description": "Output only. The value on the source instance.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "targetValue": {
+ "description": "Output only. The value on the target instance.",
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"ConnectPoolNodeConfig": {
"description": "Details of a single read pool node of a read pool.",
"id": "ConnectPoolNodeConfig",
@@ -4805,6 +5376,11 @@
],
"type": "string"
},
+ "deploymentInfo": {
+ "$ref": "BlueGreenDeploymentInfo",
+ "description": "Output only. Deployment info for the instance. This is set if the instance is currently part of any blue-green setup.",
+ "readOnly": true
+ },
"diskEncryptionConfiguration": {
"$ref": "DiskEncryptionConfiguration",
"description": "Disk encryption configuration specific to an instance."
@@ -4863,14 +5439,16 @@
"CLOUD_SQL_INSTANCE",
"ON_PREMISES_INSTANCE",
"READ_REPLICA_INSTANCE",
- "READ_POOL_INSTANCE"
+ "READ_POOL_INSTANCE",
+ "GREEN_INSTANCE"
],
"enumDescriptions": [
"This is an unknown Cloud SQL instance type.",
"A regular Cloud SQL instance that is not replicating from a primary instance.",
"An instance running on the customer's premises that is not managed by Cloud SQL.",
"A Cloud SQL instance acting as a read-replica.",
- "A Cloud SQL read pool."
+ "A Cloud SQL read pool.",
+ "A Cloud SQL instance acting as a Blue-Green deployment target primary. (MySQL only)"
],
"type": "string"
},
@@ -5225,10 +5803,93 @@
},
"type": "object"
},
+ "DeploymentTask": {
+ "description": "Represents a task executed as part of the deployment on a target instance.",
+ "id": "DeploymentTask",
+ "properties": {
+ "endTime": {
+ "description": "Output only. Task end time (if completed).",
+ "format": "google-datetime",
+ "readOnly": true,
+ "type": "string"
+ },
+ "errorMessage": {
+ "description": "Output only. Optional error details if the task state is `FAILED`.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Output only. Task start time.",
+ "format": "google-datetime",
+ "readOnly": true,
+ "type": "string"
+ },
+ "state": {
+ "description": "Output only. The current state of the task.",
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "PENDING",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED"
+ ],
+ "enumDescriptions": [
+ "The state of the task is unknown.",
+ "The task is pending.",
+ "The task is running.",
+ "The task has succeeded.",
+ "The task has failed."
+ ],
+ "readOnly": true,
+ "type": "string"
+ },
+ "type": {
+ "description": "Output only. The type of the task.",
+ "enum": [
+ "TYPE_UNSPECIFIED",
+ "PROVISION",
+ "UPGRADE",
+ "SWITCHOVER",
+ "DELETE",
+ "POST_SWITCHOVER_OPERATIONS"
+ ],
+ "enumDescriptions": [
+ "The default value. This value is used if the type is omitted.",
+ "Provisions the green environment, which includes creating the target instance.",
+ "Upgrades the green environment, for example, performing a major version upgrade on the target instance.",
+ "Promotes the target instance and then demotes the source instance for this pair.",
+ "Deletes the blue-green deployment, including underlying resources.",
+ "Post-switchover operations, including cleaning up resources of the old instance, taking final backups, and updating metadata."
+ ],
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DeploymentTasks": {
+ "description": "Combined list of tasks for all paired nodes in the deployment.",
+ "id": "DeploymentTasks",
+ "properties": {
+ "task": {
+ "description": "Output only. Tasks performed or being performed on the paired nodes of the deployment at a consolidated level.",
+ "items": {
+ "$ref": "DeploymentTask"
+ },
+ "readOnly": true,
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
"DiskEncryptionConfiguration": {
"description": "Disk encryption configuration for an instance.",
"id": "DiskEncryptionConfiguration",
"properties": {
+ "confidentialMode": {
+ "description": "Optional. If true, enables Confidential Mode for the instance's Hyperdisk Balanced volumes. Only supported for zonal C4A instances currently.",
+ "type": "boolean"
+ },
"kind": {
"description": "This is always `sql#diskEncryptionConfiguration`.",
"type": "string"
@@ -6426,6 +7087,10 @@
"description": "The name of the backup that's used to restore a Cloud SQL instance: Format: \"projects/{project-id}/locations/{location}/backupVaults/{backupvault}/dataSources/{datasource}/backups/{backup-uid}\". Only one of restore_backup_context, backup, backupdr_backup can be passed to the input.",
"type": "string"
},
+ "ignoreMaintenanceVersion": {
+ "description": "Optional. If true, the restore operation proceeds even if the target instance's maintenance version is older than the source instance's maintenance version.",
+ "type": "boolean"
+ },
"restoreBackupContext": {
"$ref": "RestoreBackupContext",
"description": "Parameters required to perform the restore backup operation."
@@ -6659,6 +7324,24 @@
},
"type": "object"
},
+ "ListBlueGreenDeploymentsResponse": {
+ "description": "The response message for listing blue-green deployment resources.",
+ "id": "ListBlueGreenDeploymentsResponse",
+ "properties": {
+ "blueGreenDeployments": {
+ "description": "The list of blue-green deployment resources.",
+ "items": {
+ "$ref": "BlueGreenDeployment"
+ },
+ "type": "array"
+ },
+ "nextPageToken": {
+ "description": "A token to retrieve the next page of results, or empty if there are no more results.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"LocationPreference": {
"description": "Preferred location. This specifies where a Cloud SQL instance is located. Note that if the preferred location is not available, the instance will be located as close as possible within the region. Only one location may be specified.",
"id": "LocationPreference",
@@ -6814,6 +7497,36 @@
},
"type": "object"
},
+ "NodeInfo": {
+ "description": "Details about an instance within the deployment.",
+ "id": "NodeInfo",
+ "properties": {
+ "connection": {
+ "description": "Output only. The instance connection name.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "dns": {
+ "description": "Output only. The unique DNS name for this instance.",
+ "readOnly": true,
+ "type": "string"
+ },
+ "instance": {
+ "description": "Output only. The full resource name of the instance. Format: projects/{project}/instances/{instance}",
+ "readOnly": true,
+ "type": "string"
+ },
+ "ipMappings": {
+ "description": "Output only. The list of IP addresses for this instance.",
+ "items": {
+ "$ref": "IpMapping"
+ },
+ "readOnly": true,
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
"OnPremisesConfiguration": {
"description": "On-premises instance configuration.",
"id": "OnPremisesConfiguration",
@@ -6987,7 +7700,10 @@
"REPAIR_READ_POOL",
"CREATE_READ_POOL",
"PRE_CHECK_MAJOR_VERSION_UPGRADE",
- "SETUP_MIGRATION"
+ "SETUP_MIGRATION",
+ "CREATE_BLUE_GREEN_DEPLOYMENT",
+ "SWITCHOVER_BLUE_GREEN_DEPLOYMENT",
+ "DELETE_BLUE_GREEN_DEPLOYMENT"
],
"enumDeprecated": [
false,
@@ -7043,6 +7759,9 @@
false,
false,
false,
+ false,
+ false,
+ false,
false
],
"enumDescriptions": [
@@ -7099,7 +7818,10 @@
"Repairs entire read pool or specified read pool nodes in the read pool.",
"Creates a Cloud SQL read pool instance.",
"Pre-checks the major version upgrade operation.",
- "This operation type represents individual steps in a multi-step setup migration workflow: including configuration, replication, switchover/back, and data reseeding, as defined by operation's intent."
+ "This operation type represents individual steps in a multi-step setup migration workflow: including configuration, replication, switchover/back, and data reseeding, as defined by operation's intent.",
+ "Creates a new Blue-Green deployment.",
+ "Switches over a Blue-Green deployment.",
+ "Deletes a Blue-Green deployment."
],
"type": "string"
},
@@ -7873,7 +8595,7 @@
"type": "array"
},
"networkAttachmentUri": {
- "description": "Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect via PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID",
+ "description": "Optional. The network attachment of the consumer network that the Private Service Connect enabled Cloud SQL instance is authorized to connect using the PSC interface. format: projects/PROJECT/regions/REGION/networkAttachments/ID",
"type": "string"
},
"pscAutoConnectionPolicyEnabled": {
@@ -8021,6 +8743,17 @@
},
"type": "object"
},
+ "RequestedConfig": {
+ "description": "Configuration specified by the user at creation time for the target (green) instance.",
+ "id": "RequestedConfig",
+ "properties": {
+ "databaseVersion": {
+ "description": "Optional. The target database major version for the upgrade. For example, `MYSQL_8_0` or `POSTGRES_15`.",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"Reschedule": {
"id": "Reschedule",
"properties": {
@@ -8371,7 +9104,7 @@
},
"passwordValidationPolicy": {
"$ref": "PasswordValidationPolicy",
- "description": "The local user password validation policy of the instance."
+ "description": "The local user password validation policy of the instance for PostgreSQL and MySQL."
},
"performanceCaptureConfig": {
"$ref": "PerformanceCaptureConfig",
@@ -8455,6 +9188,72 @@
},
"type": "object"
},
+ "SourceRole": {
+ "description": "The source instance for the Blue-Green deployment.",
+ "id": "SourceRole",
+ "properties": {
+ "targetId": {
+ "$ref": "InstanceReference",
+ "description": "Output only. The target instance paired with this source instance in a blue-green deployment.",
+ "readOnly": true
+ }
+ },
+ "type": "object"
+ },
+ "SourceTargetPairedNode": {
+ "description": "Represents a pairing of a source instance node and a target instance node.",
+ "id": "SourceTargetPairedNode",
+ "properties": {
+ "diffs": {
+ "description": "Output only. Describes the list of differences for the `SourceTargetPairedNode`.",
+ "items": {
+ "$ref": "ConfigDiff"
+ },
+ "readOnly": true,
+ "type": "array"
+ },
+ "source": {
+ "$ref": "NodeInfo",
+ "description": "Output only. Specifies the resource name of the source instance in this pair.",
+ "readOnly": true
+ },
+ "state": {
+ "description": "Output only. Specifies the current state of this specific source-target pair.",
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "PROVISIONING",
+ "PROVISIONED",
+ "UPGRADING",
+ "UPGRADED",
+ "UPGRADE_FAILED",
+ "SWITCHOVER_IN_PROGRESS",
+ "SWITCHOVER_FAILED",
+ "SWITCHOVER_SUCCEEDED",
+ "DELETING"
+ ],
+ "enumDescriptions": [
+ "The state of the paired node is unknown.",
+ "The paired node is being provisioned.",
+ "The paired node is provisioned.",
+ "The paired node is upgrading.",
+ "The paired node is upgraded.",
+ "Upgrade failed on the paired node.",
+ "Switchover is in progress.",
+ "Switchover failed on the paired node.",
+ "Switchover completed successfully.",
+ "The paired node is being deleted."
+ ],
+ "readOnly": true,
+ "type": "string"
+ },
+ "target": {
+ "$ref": "NodeInfo",
+ "description": "Output only. Specifies details of the corresponding target instance in this pair.",
+ "readOnly": true
+ }
+ },
+ "type": "object"
+ },
"SqlActiveDirectoryConfig": {
"description": "Active Directory configuration, relevant only for Cloud SQL for SQL Server.",
"id": "SqlActiveDirectoryConfig",
@@ -8580,7 +9379,9 @@
"SELECTED_OBJECTS_REFERENCE_UNSELECTED_OBJECTS",
"PROMPT_DELETE_EXISTING",
"WILL_DELETE_EXISTING",
- "PG_DDL_REPLICATION_INSUFFICIENT_PRIVILEGE"
+ "PG_DDL_REPLICATION_INSUFFICIENT_PRIVILEGE",
+ "WRITABLE_DESTINATION_REPLICA_RECREATION_DOWNTIME",
+ "WRITABLE_DESTINATION_STORAGE_AUTO_INCREASE_DISABLED"
],
"enumDescriptions": [
"",
@@ -8641,7 +9442,9 @@
"Selected objects reference unselected objects. Based on their object type (foreign key constraint or view), selected objects will fail during migration.",
"The migration will delete existing data in the replica; set replica_overwrite_enabled in the request to acknowledge this. This is an error. MySQL only.",
"The migration will delete existing data in the replica; replica_overwrite_enabled was set in the request acknowledging this. This is a warning rather than an error. MySQL only.",
- "The replication user is missing specific privileges to setup DDL replication. (e.g. CREATE EVENT TRIGGER, CREATE SCHEMA) for PostgreSQL."
+ "The replication user is missing specific privileges to setup DDL replication. (e.g. CREATE EVENT TRIGGER, CREATE SCHEMA) for PostgreSQL.",
+ "Read replicas of the Writable Destination instance will be recreated after external synchronization is complete, causing downtime on read replicas.",
+ "A warning that disk storage auto increase is disabled on the destination instance for a Writable Destination migration."
],
"type": "string"
}
@@ -8754,13 +9557,22 @@
"SqlInstancesResetReplicaSizeRequest": {
"description": "Instance reset replica size request.",
"id": "SqlInstancesResetReplicaSizeRequest",
- "properties": {},
+ "properties": {
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "type": "string"
+ }
+ },
"type": "object"
},
"SqlInstancesStartExternalSyncRequest": {
"description": "Instance start external sync request.",
"id": "SqlInstancesStartExternalSyncRequest",
"properties": {
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "type": "string"
+ },
"migrationType": {
"description": "Optional. MigrationType configures the migration to use physical files or logical dump files. If not set, then the logical dump file configuration is used. Valid values are `LOGICAL` or `PHYSICAL`. Only applicable to MySQL.",
"enum": [
@@ -8824,6 +9636,10 @@
"description": "Instance verify external sync settings request.",
"id": "SqlInstancesVerifyExternalSyncSettingsRequest",
"properties": {
+ "location": {
+ "description": "Optional. Region of the Cloud SQL instance.",
+ "type": "string"
+ },
"migrationType": {
"description": "Optional. MigrationType configures the migration to use physical files or logical dump files. If not set, then the logical dump file configuration is used. Valid values are `LOGICAL` or `PHYSICAL`. Only applicable to MySQL.",
"enum": [
@@ -9032,11 +9848,11 @@
"id": "SqlServerUserDetails",
"properties": {
"disabled": {
- "description": "If the user has been disabled",
+ "description": "Indicates if the user has been disabled.",
"type": "boolean"
},
"serverRoles": {
- "description": "The server roles for this user",
+ "description": "Indicates the server roles for this user.",
"items": {
"type": "string"
},
@@ -9224,6 +10040,12 @@
},
"type": "object"
},
+ "SwitchoverBlueGreenDeploymentRequest": {
+ "description": "Request message for switching over a `BlueGreenDeployment` resource.",
+ "id": "SwitchoverBlueGreenDeploymentRequest",
+ "properties": {},
+ "type": "object"
+ },
"SyncFlags": {
"description": "Initial sync flags for certain Cloud SQL APIs. Currently used for the MySQL external server initial dump.",
"id": "SyncFlags",
@@ -9255,6 +10077,18 @@
},
"type": "object"
},
+ "TargetRole": {
+ "description": "The target instance for the Blue-Green deployment.",
+ "id": "TargetRole",
+ "properties": {
+ "sourceId": {
+ "$ref": "InstanceReference",
+ "description": "Output only. The source instance paired with this target instance in a blue-green deployment.",
+ "readOnly": true
+ }
+ },
+ "type": "object"
+ },
"Tier": {
"description": "A Google Cloud SQL service tier resource.",
"id": "Tier",
diff --git a/discovery/tagmanager-v2.json b/discovery/tagmanager-v2.json
index f4d183893b2..40bf0c21248 100644
--- a/discovery/tagmanager-v2.json
+++ b/discovery/tagmanager-v2.json
@@ -217,6 +217,7 @@
"containers": {
"methods": {
"combine": {
+ "deprecated": true,
"description": "Combines Containers.",
"flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}:combine",
"httpMethod": "POST",
@@ -401,6 +402,7 @@
]
},
"move_tag_id": {
+ "deprecated": true,
"description": "Move Tag ID out of a Container.",
"flatPath": "tagmanager/v2/accounts/{accountsId}/containers/{containersId}:move_tag_id",
"httpMethod": "POST",
@@ -3988,7 +3990,7 @@
}
}
},
- "revision": "20260706",
+ "revision": "20260826",
"rootUrl": "https://tagmanager.googleapis.com/",
"schemas": {
"Account": {
diff --git a/discovery/threatintelligence-v1beta.json b/discovery/threatintelligence-v1beta.json
index 701afa6b5cb..f438f01a481 100644
--- a/discovery/threatintelligence-v1beta.json
+++ b/discovery/threatintelligence-v1beta.json
@@ -842,7 +842,7 @@
}
}
},
- "revision": "20260816",
+ "revision": "20260823",
"rootUrl": "https://threatintelligence.googleapis.com/",
"schemas": {
"Alert": {
@@ -1223,6 +1223,10 @@
"readOnly": true,
"type": "string"
},
+ "domainConfiguration": {
+ "$ref": "DomainConfiguration",
+ "description": "Domain Configuration detail config."
+ },
"technologyWatchlist": {
"$ref": "TechnologyWatchListConfig",
"description": "Technology Watchlist detail config."
@@ -1264,6 +1268,10 @@
"description": "Required. The condition driving the scenario, stored as a stringified JSON. This is used to query/filter documents.",
"type": "string"
},
+ "documentQuery": {
+ "$ref": "DocumentQuery",
+ "description": "Optional. The query used to match documents."
+ },
"legacyMonitorMetadata": {
"$ref": "LegacyMetadata",
"description": "Optional. Legacy metadata associated with this scenario/monitor."
@@ -1683,6 +1691,96 @@
},
"type": "object"
},
+ "DocumentQuery": {
+ "description": "Represents a query to match documents.",
+ "id": "DocumentQuery",
+ "properties": {
+ "dataModel": {
+ "description": "Required. The data model to query against.",
+ "enum": [
+ "DATA_MODEL_UNSPECIFIED",
+ "DATA_MODEL_GTI"
+ ],
+ "enumDescriptions": [
+ "Default value, should never be set.",
+ "GTI data model."
+ ],
+ "type": "string"
+ },
+ "query": {
+ "description": "Required. The query string.",
+ "type": "string"
+ },
+ "queryType": {
+ "description": "Required. The type of query.",
+ "enum": [
+ "QUERY_TYPE_UNSPECIFIED",
+ "QUERY_TYPE_LUCENE"
+ ],
+ "enumDescriptions": [
+ "Default value, should never be set.",
+ "Lucene query type."
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "DomainConfiguration": {
+ "description": "Configuration holding settings for one or more monitored domains.",
+ "id": "DomainConfiguration",
+ "properties": {
+ "domainSettings": {
+ "description": "Optional. A list of settings for individual domains.",
+ "items": {
+ "$ref": "DomainSetting"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ },
+ "DomainMonitoringFeatureConfig": {
+ "description": "Specific configuration for the Domain Monitoring feature.",
+ "id": "DomainMonitoringFeatureConfig",
+ "properties": {
+ "disabled": {
+ "description": "Optional. Whether the Domain Monitoring feature is disabled for the domain.",
+ "type": "boolean"
+ }
+ },
+ "type": "object"
+ },
+ "DomainSetting": {
+ "description": "Feature settings and toggles for a single specific domain.",
+ "id": "DomainSetting",
+ "properties": {
+ "domain": {
+ "description": "Required. The domain name to match against.",
+ "type": "string"
+ },
+ "domainMonitoringConfig": {
+ "$ref": "DomainMonitoringFeatureConfig",
+ "description": "Optional. If not present, Domain Monitoring is enabled."
+ },
+ "state": {
+ "description": "Output only. The verification state of the domain.",
+ "enum": [
+ "STATE_UNSPECIFIED",
+ "PENDING",
+ "VERIFIED"
+ ],
+ "enumDescriptions": [
+ "Default value. This value is unused.",
+ "Verification is pending. The customer needs to add the TXT record.",
+ "Verification succeeded."
+ ],
+ "readOnly": true,
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"EnumerateAlertFacetsResponse": {
"description": "Response message for EnumerateAlertFacets.",
"id": "EnumerateAlertFacetsResponse",
diff --git a/discovery/webcontentpublisher-v1.json b/discovery/webcontentpublisher-v1.json
index d3da81248cb..7e28f4cfb96 100644
--- a/discovery/webcontentpublisher-v1.json
+++ b/discovery/webcontentpublisher-v1.json
@@ -1,16 +1,4 @@
{
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage": {
- "description": "Private Service: https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage"
- },
- "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.readonly": {
- "description": "See and review your subscription information"
- }
- }
- }
- },
"basePath": "",
"baseUrl": "https://webcontentpublisher.googleapis.com/",
"batchPath": "batch",
@@ -140,10 +128,7 @@
},
"response": {
"$ref": "Publication"
- },
- "scopes": [
- "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage"
- ]
+ }
},
"get": {
"description": "Gets a publication.",
@@ -165,11 +150,7 @@
"path": "v1/{+name}",
"response": {
"$ref": "Publication"
- },
- "scopes": [
- "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage",
- "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.readonly"
- ]
+ }
},
"list": {
"description": "Lists publications.",
@@ -207,11 +188,7 @@
"path": "v1/{+parent}/publications",
"response": {
"$ref": "ListPublicationsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage",
- "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.readonly"
- ]
+ }
},
"patch": {
"description": "Updates a publication.",
@@ -242,10 +219,7 @@
},
"response": {
"$ref": "Publication"
- },
- "scopes": [
- "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage"
- ]
+ }
}
},
"resources": {
@@ -279,10 +253,7 @@
},
"response": {
"$ref": "Cta"
- },
- "scopes": [
- "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage"
- ]
+ }
},
"get": {
"description": "Gets a CTA.",
@@ -304,11 +275,7 @@
"path": "v1/{+name}",
"response": {
"$ref": "Cta"
- },
- "scopes": [
- "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage",
- "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.readonly"
- ]
+ }
},
"list": {
"description": "Lists CTAs.",
@@ -341,11 +308,7 @@
"path": "v1/{+parent}/ctas",
"response": {
"$ref": "ListCtasResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage",
- "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.readonly"
- ]
+ }
},
"patch": {
"description": "Updates a CTA.",
@@ -376,10 +339,7 @@
},
"response": {
"$ref": "Cta"
- },
- "scopes": [
- "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage"
- ]
+ }
}
}
}
@@ -419,11 +379,7 @@
"path": "v1/{+name}:checkFreeAccess",
"response": {
"$ref": "CheckFreeAccessResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage",
- "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.readonly"
- ]
+ }
}
}
},
@@ -452,16 +408,12 @@
},
"response": {
"$ref": "GeneratePlatformSiteTokensResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.manage",
- "https://www.googleapis.com/auth/subscribewithgoogle.publications.entitlements.readonly"
- ]
+ }
}
}
}
},
- "revision": "20260823",
+ "revision": "20260827",
"rootUrl": "https://webcontentpublisher.googleapis.com/",
"schemas": {
"CheckFreeAccessResponse": {
diff --git a/release-please-config.json b/release-please-config.json
index 2c4c6b0ab4d..2023e352032 100644
--- a/release-please-config.json
+++ b/release-please-config.json
@@ -334,6 +334,8 @@
"src/apis/cloudproductregistry": {},
"src/apis/agentidentity": {},
"src/apis/androiddeveloperidstatus": {},
- "src/apis/ftp": {}
+ "src/apis/ftp": {},
+ "src/apis/agenciesandbrands": {},
+ "src/apis/curationpartners": {}
}
}
\ No newline at end of file
diff --git a/src/apis/agenciesandbrands/README.md b/src/apis/agenciesandbrands/README.md
new file mode 100644
index 00000000000..4fe93ef9afa
--- /dev/null
+++ b/src/apis/agenciesandbrands/README.md
@@ -0,0 +1,28 @@
+
+
+# agenciesandbrands
+
+> Agencies and brands API is an externally available HTTP API for ad agencies and brands to programmatically manage their deals and spending with Google Ad Manager publishers.
+
+## Installation
+
+```sh
+$ npm install @googleapis/agenciesandbrands
+```
+
+## Usage
+All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client).
+Information on classes can be found in [Googleapis Documentation](https://googleapis.dev/nodejs/googleapis/latest/agenciesandbrands/classes/Agenciesandbrands.html).
+
+## License
+This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/main/LICENSE).
+
+## Contributing
+We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/main/.github/CONTRIBUTING.md).
+
+## Questions/problems?
+* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client).
+* If you've found an bug/issue, please [file it on GitHub](https://github.com/googleapis/google-api-nodejs-client/issues).
+
+
+*Crafted with ❤️ by the Google Node.js team*
diff --git a/src/apis/agenciesandbrands/index.ts b/src/apis/agenciesandbrands/index.ts
new file mode 100644
index 00000000000..2bde8669efd
--- /dev/null
+++ b/src/apis/agenciesandbrands/index.ts
@@ -0,0 +1,47 @@
+// Copyright 2020 Google LLC
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/*! THIS FILE IS AUTO-GENERATED */
+
+import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common';
+import {agenciesandbrands_v1} from './v1';
+
+export const VERSIONS = {
+ v1: agenciesandbrands_v1.Agenciesandbrands,
+};
+
+export function agenciesandbrands(
+ version: 'v1'
+): agenciesandbrands_v1.Agenciesandbrands;
+export function agenciesandbrands(
+ options: agenciesandbrands_v1.Options
+): agenciesandbrands_v1.Agenciesandbrands;
+export function agenciesandbrands(
+ this: GoogleConfigurable,
+ versionOrOptions: 'v1' | agenciesandbrands_v1.Options
+) {
+ return getAPI('agenciesandbrands', versionOrOptions, VERSIONS, this);
+}
+
+const auth = new AuthPlus();
+export {auth};
+export {agenciesandbrands_v1};
+export {
+ AuthPlus,
+ GlobalOptions,
+ APIRequestContext,
+ GoogleConfigurable,
+ StreamMethodOptions,
+ MethodOptions,
+ BodyResponseCallback,
+} from 'googleapis-common';
diff --git a/src/apis/agenciesandbrands/package.json b/src/apis/agenciesandbrands/package.json
new file mode 100644
index 00000000000..989eb412bd6
--- /dev/null
+++ b/src/apis/agenciesandbrands/package.json
@@ -0,0 +1,43 @@
+{
+ "name": "@googleapis/agenciesandbrands",
+ "version": "0.1.0",
+ "description": "agenciesandbrands",
+ "main": "build/index.js",
+ "types": "build/index.d.ts",
+ "keywords": [
+ "google"
+ ],
+ "author": "Google LLC",
+ "license": "Apache-2.0",
+ "homepage": "https://github.com/googleapis/google-api-nodejs-client",
+ "bugs": {
+ "url": "https://github.com/googleapis/google-api-nodejs-client/issues"
+ },
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/googleapis/google-api-nodejs-client.git"
+ },
+ "engines": {
+ "node": ">=12.0.0"
+ },
+ "scripts": {
+ "fix": "gts fix",
+ "lint": "gts check",
+ "compile": "tsc -p .",
+ "prepare": "npm run compile",
+ "webpack": "webpack"
+ },
+ "dependencies": {
+ "googleapis-common": "^8.0.0"
+ },
+ "devDependencies": {
+ "@microsoft/api-documenter": "^7.8.10",
+ "@microsoft/api-extractor": "^7.8.10",
+ "gts": "^6.0.0",
+ "null-loader": "^4.0.0",
+ "ts-loader": "^9.0.0",
+ "typescript": "5.7.3",
+ "webpack": "^5.0.0",
+ "webpack-cli": "^5.0.0"
+ }
+}
diff --git a/src/apis/agenciesandbrands/tsconfig.json b/src/apis/agenciesandbrands/tsconfig.json
new file mode 100644
index 00000000000..e0810904968
--- /dev/null
+++ b/src/apis/agenciesandbrands/tsconfig.json
@@ -0,0 +1,10 @@
+{
+ "extends": "./node_modules/gts/tsconfig-google.json",
+ "compilerOptions": {
+ "rootDir": ".",
+ "outDir": "build"
+ },
+ "include": [
+ "*.ts",
+ ]
+}
diff --git a/src/apis/agenciesandbrands/v1.ts b/src/apis/agenciesandbrands/v1.ts
new file mode 100644
index 00000000000..a1c012b5166
--- /dev/null
+++ b/src/apis/agenciesandbrands/v1.ts
@@ -0,0 +1,1814 @@
+// Copyright 2020 Google LLC
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable @typescript-eslint/no-empty-interface */
+/* eslint-disable @typescript-eslint/no-namespace */
+/* eslint-disable no-irregular-whitespace */
+
+import {
+ OAuth2Client,
+ JWT,
+ Compute,
+ UserRefreshClient,
+ BaseExternalAccountClient,
+ GaxiosResponseWithHTTP2,
+ GoogleConfigurable,
+ createAPIRequest,
+ MethodOptions,
+ StreamMethodOptions,
+ GlobalOptions,
+ GoogleAuth,
+ BodyResponseCallback,
+ APIRequestContext,
+} from 'googleapis-common';
+import {Readable} from 'stream';
+
+export namespace agenciesandbrands_v1 {
+ export interface Options extends GlobalOptions {
+ version: 'v1';
+ }
+
+ interface StandardParameters {
+ /**
+ * Auth client or API Key for the request
+ */
+ auth?:
+ | string
+ | OAuth2Client
+ | JWT
+ | Compute
+ | UserRefreshClient
+ | BaseExternalAccountClient
+ | GoogleAuth;
+
+ /**
+ * V1 error format.
+ */
+ '$.xgafv'?: string;
+ /**
+ * OAuth access token.
+ */
+ access_token?: string;
+ /**
+ * Data format for response.
+ */
+ alt?: string;
+ /**
+ * JSONP
+ */
+ callback?: string;
+ /**
+ * Selector specifying which fields to include in a partial response.
+ */
+ fields?: string;
+ /**
+ * 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.
+ */
+ key?: string;
+ /**
+ * OAuth 2.0 token for the current user.
+ */
+ oauth_token?: string;
+ /**
+ * Returns response with indentations and line breaks.
+ */
+ prettyPrint?: boolean;
+ /**
+ * 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.
+ */
+ quotaUser?: string;
+ /**
+ * Legacy upload protocol for media (e.g. "media", "multipart").
+ */
+ uploadType?: string;
+ /**
+ * Upload protocol for media (e.g. "raw", "multipart").
+ */
+ upload_protocol?: string;
+ }
+
+ /**
+ * Agencies and Brands API
+ *
+ * Agencies and brands API is an externally available HTTP API for ad agencies and brands to programmatically manage their deals and spending with Google Ad Manager publishers.
+ *
+ * @example
+ * ```js
+ * const {google} = require('googleapis');
+ * const agenciesandbrands = google.agenciesandbrands('v1');
+ * ```
+ */
+ export class Agenciesandbrands {
+ context: APIRequestContext;
+ agencies: Resource$Agencies;
+
+ constructor(options: GlobalOptions, google?: GoogleConfigurable) {
+ this.context = {
+ _options: options || {},
+ google,
+ };
+
+ this.agencies = new Resource$Agencies(this.context);
+ }
+ }
+
+ /**
+ * 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
+ */
+ export interface Schema$Date {
+ /**
+ * 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.
+ */
+ day?: number | null;
+ /**
+ * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+ */
+ month?: number | null;
+ /**
+ * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+ */
+ year?: number | null;
+ }
+ /**
+ * A date range for a report.
+ */
+ export interface Schema$DateRange {
+ /**
+ * A fixed date range.
+ */
+ fixed?: Schema$FixedDateRange;
+ /**
+ * A relative date range.
+ */
+ relative?: string | null;
+ }
+ /**
+ * A list of double values.
+ */
+ export interface Schema$DoubleList {
+ /**
+ * The values
+ */
+ values?: number[] | null;
+ }
+ /**
+ * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
+ */
+ export interface Schema$Empty {}
+ /**
+ * The response message for the fetch report result rows endpoint.
+ */
+ export interface Schema$FetchReportResultRowsResponse {
+ /**
+ * The computed fixed date ranges this report includes. Only returned with the first page of results (when page_token is not included in the request).
+ */
+ dateRanges?: Schema$FixedDateRange[];
+ /**
+ * A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ */
+ nextPageToken?: string | null;
+ /**
+ * Up to `page_size` rows of report data.
+ */
+ rows?: Schema$Row[];
+ /**
+ * The time at which the report was scheduled to run. For non-scheduled reports, this is the time at which the report was requested to be run.
+ */
+ runTime?: string | null;
+ /**
+ * The total number of rows available from this report. Useful for pagination. Only returned with the first page of results (when page_token is not included in the request).
+ */
+ totalRowCount?: number | null;
+ }
+ /**
+ * A dimension or a metric in a report.
+ */
+ export interface Schema$Field {
+ /**
+ * The dimension this field represents.
+ */
+ dimension?: string | null;
+ /**
+ * The metric this field represents.
+ */
+ metric?: string | null;
+ }
+ /**
+ * A filter on a specific field.
+ */
+ export interface Schema$FieldFilter {
+ /**
+ * Required. The field to filter on.
+ */
+ field?: Schema$Field;
+ /**
+ * Required. The operation of this filter.
+ */
+ operation?: string | null;
+ /**
+ * Required. Values to filter to.
+ */
+ values?: Schema$ReportValue[];
+ }
+ /**
+ * A filter over one or more fields.
+ */
+ export interface Schema$Filter {
+ /**
+ * A list of filters whose results are AND-ed.
+ */
+ andFilter?: Schema$FilterList;
+ /**
+ * A filter on a single field.
+ */
+ fieldFilter?: Schema$FieldFilter;
+ /**
+ * A filter whose result is negated.
+ */
+ notFilter?: Schema$Filter;
+ /**
+ * A list of filters whose results are OR-ed.
+ */
+ orFilter?: Schema$FilterList;
+ }
+ /**
+ * A list of filters.
+ */
+ export interface Schema$FilterList {
+ /**
+ * Required. A list of filters.
+ */
+ filters?: Schema$Filter[];
+ }
+ /**
+ * A date range between two fixed dates (inclusive of end date).
+ */
+ export interface Schema$FixedDateRange {
+ /**
+ * Required. The end date (inclusive) of this date range.
+ */
+ endDate?: Schema$Date;
+ /**
+ * Required. The start date of this date range.
+ */
+ startDate?: Schema$Date;
+ }
+ /**
+ * A list of integer values.
+ */
+ export interface Schema$IntList {
+ /**
+ * The values
+ */
+ values?: string[] | null;
+ }
+ /**
+ * Response object for `ListReportsResponse` containing matching `Report` objects.
+ */
+ export interface Schema$ListReportsResponse {
+ /**
+ * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+ */
+ nextPageToken?: string | null;
+ /**
+ * The `Report` objects from the specified network.
+ */
+ reports?: Schema$Report[];
+ /**
+ * Total number of `Report` objects. If a filter was included in the request, this reflects the total number after the filtering is applied. `total_size` won't be calculated in the response unless it has been included in a response field mask. The response field mask can be provided to the method by using the URL parameter `$fields` or `fields`, or by using the HTTP/gRPC header `X-Goog-FieldMask`. For more information, see https://developers.google.com/ad-manager/api/beta/field-masks
+ */
+ totalSize?: number | null;
+ }
+ /**
+ * Contains all metric values requested for a single date range and set of column dimension values (returned in the columns field of the response). The order of the metrics in each field corresponds to the order of the metrics specified in the request.
+ */
+ export interface Schema$MetricValueGroup {
+ /**
+ * Data for the PRIMARY MetricValueType.
+ */
+ primaryValues?: Schema$ReportValue[];
+ }
+ /**
+ * This resource represents a long-running operation that is the result of a network API call.
+ */
+ export interface Schema$Operation {
+ /**
+ * If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ */
+ done?: boolean | null;
+ /**
+ * The error result of the operation in case of failure or cancellation.
+ */
+ error?: Schema$Status;
+ /**
+ * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ */
+ metadata?: {[key: string]: any} | null;
+ /**
+ * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id\}`.
+ */
+ name?: string | null;
+ /**
+ * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ */
+ response?: {[key: string]: any} | null;
+ }
+ /**
+ * The `Report` resource.
+ */
+ export interface Schema$Report {
+ /**
+ * Output only. The instant this report was created.
+ */
+ createTime?: string | null;
+ /**
+ * Optional. Display name for the report.
+ */
+ displayName?: string | null;
+ /**
+ * Output only. The locale of this report. Locale is set from the user's locale at the time of the request. Locale can't be modified.
+ */
+ locale?: string | null;
+ /**
+ * Identifier. The resource name of the report. Report resource name have the form: `agencies/{account_id\}/reports/{report_id\}`
+ */
+ name?: string | null;
+ /**
+ * Required. The report definition of the report.
+ */
+ reportDefinition?: Schema$ReportDefinition;
+ /**
+ * Output only. Report ID.
+ */
+ reportId?: string | null;
+ /**
+ * Output only. The instant this report was last modified.
+ */
+ updateTime?: string | null;
+ }
+ /**
+ * The definition of how a report should be run.
+ */
+ export interface Schema$ReportDefinition {
+ /**
+ * Optional. The ISO 4217 currency code for this report. Defaults to account currency code if not specified.
+ */
+ currencyCode?: string | null;
+ /**
+ * Required. The primary date range of this report.
+ */
+ dateRange?: Schema$DateRange;
+ /**
+ * Required. The list of dimensions to report on. If empty, the report will have no dimensions, and any metrics will be totals.
+ */
+ dimensions?: string[] | null;
+ /**
+ * Optional. The filters for this report.
+ */
+ filters?: Schema$Filter[];
+ /**
+ * Required. The list of metrics to report on. If empty, the report will have no metrics.
+ */
+ metrics?: string[] | null;
+ /**
+ * Optional. Default sorts to apply to this report.
+ */
+ sorts?: Schema$Sort[];
+ /**
+ * Optional. If time_zone_source is PROVIDED, this is the time zone to use for this report. Leave empty for any other time zone source. Time zone in IANA format. For example, "America/New_York".
+ */
+ timeZone?: string | null;
+ /**
+ * Optional. Where to get the time zone for this report. Defaults to using the Pacific time zone (PT). If source is PROVIDED, the time_zone field in the report definition must also set a time zone.
+ */
+ timeZoneSource?: string | null;
+ }
+ /**
+ * Represents a single value in a report.
+ */
+ export interface Schema$ReportValue {
+ /**
+ * For boolean values.
+ */
+ boolValue?: boolean | null;
+ /**
+ * For bytes values.
+ */
+ bytesValue?: string | null;
+ /**
+ * For lists of double values.
+ */
+ doubleListValue?: Schema$DoubleList;
+ /**
+ * For double values.
+ */
+ doubleValue?: number | null;
+ /**
+ * For lists of integer values.
+ */
+ intListValue?: Schema$IntList;
+ /**
+ * For integer values.
+ */
+ intValue?: string | null;
+ /**
+ * For lists of string values.
+ */
+ stringListValue?: Schema$StringList;
+ /**
+ * For string values.
+ */
+ stringValue?: string | null;
+ }
+ /**
+ * A row of report data.
+ */
+ export interface Schema$Row {
+ /**
+ * The order of the dimension values is the same as the order of the dimensions specified in the request.
+ */
+ dimensionValues?: Schema$ReportValue[];
+ /**
+ * The length of the metric_value_groups field will be equal to the length of the date_ranges field in the fetch response. The metric_value_groups field is ordered such that each index corresponds to the date_range at the same index. For example, given date_ranges [x, y], metric_value_groups will have a length of two. The first entry in metric_value_groups represents the metrics for date x and the second entry in metric_value_groups represents the metrics for date y.
+ */
+ metricValueGroups?: Schema$MetricValueGroup[];
+ }
+ /**
+ * `RunReport` operation metadata.
+ */
+ export interface Schema$RunReportMetadata {
+ /**
+ * An estimate of how close this report is to being completed. Will always be 100 for failed and completed reports.
+ */
+ percentComplete?: number | null;
+ /**
+ * The result's parent report.
+ */
+ report?: string | null;
+ }
+ /**
+ * Request message for a running a report.
+ */
+ export interface Schema$RunReportRequest {}
+ /**
+ * Response message for a completed `RunReport` operation.
+ */
+ export interface Schema$RunReportResponse {
+ /**
+ * The unique name of the generated result. Use with `FetchReportResultRows` to retrieve data.
+ */
+ reportResult?: string | null;
+ }
+ /**
+ * Represents a sorting in a report.
+ */
+ export interface Schema$Sort {
+ /**
+ * Optional. The sort order. If true the sort will be descending.
+ */
+ descending?: boolean | null;
+ /**
+ * Required. A field (dimension or metric) to sort by.
+ */
+ field?: Schema$Field;
+ }
+ /**
+ * The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).
+ */
+ export interface Schema$Status {
+ /**
+ * The status code, which should be an enum value of google.rpc.Code.
+ */
+ code?: number | null;
+ /**
+ * A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ */
+ details?: Array<{[key: string]: any}> | null;
+ /**
+ * A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ */
+ message?: string | null;
+ }
+ /**
+ * A list of string values.
+ */
+ export interface Schema$StringList {
+ /**
+ * The values
+ */
+ values?: string[] | null;
+ }
+
+ export class Resource$Agencies {
+ context: APIRequestContext;
+ reports: Resource$Agencies$Reports;
+ constructor(context: APIRequestContext) {
+ this.context = context;
+ this.reports = new Resource$Agencies$Reports(this.context);
+ }
+ }
+
+ export class Resource$Agencies$Reports {
+ context: APIRequestContext;
+ operations: Resource$Agencies$Reports$Operations;
+ results: Resource$Agencies$Reports$Results;
+ constructor(context: APIRequestContext) {
+ this.context = context;
+ this.operations = new Resource$Agencies$Reports$Operations(this.context);
+ this.results = new Resource$Agencies$Reports$Results(this.context);
+ }
+
+ /**
+ * Creates a `Report` object.
+ * @example
+ * ```js
+ * // Before running the sample:
+ * // - Enable the API at:
+ * // https://console.developers.google.com/apis/api/agenciesandbrands.googleapis.com
+ * // - Login into gcloud by running:
+ * // ```sh
+ * // $ gcloud auth application-default login
+ * // ```
+ * // - Install the npm module by running:
+ * // ```sh
+ * // $ npm install googleapis
+ * // ```
+ *
+ * const {google} = require('googleapis');
+ * const agenciesandbrands = google.agenciesandbrands('v1');
+ *
+ * async function main() {
+ * const auth = new google.auth.GoogleAuth({
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
+ * scopes: ['https://www.googleapis.com/auth/agencies-and-brands'],
+ * });
+ *
+ * // Acquire an auth client, and bind it to all future calls
+ * const authClient = await auth.getClient();
+ * google.options({auth: authClient});
+ *
+ * // Do the magic
+ * const res = await agenciesandbrands.agencies.reports.create({
+ * // Required. The parent resource where this `Report` will be created. Format: `agencies/{account_id\}`
+ * parent: 'agencies/my-agencie',
+ *
+ * // Request body metadata
+ * requestBody: {
+ * // request body parameters
+ * // {
+ * // "createTime": "my_createTime",
+ * // "displayName": "my_displayName",
+ * // "locale": "my_locale",
+ * // "name": "my_name",
+ * // "reportDefinition": {},
+ * // "reportId": "my_reportId",
+ * // "updateTime": "my_updateTime"
+ * // }
+ * },
+ * });
+ * console.log(res.data);
+ *
+ * // Example response
+ * // {
+ * // "createTime": "my_createTime",
+ * // "displayName": "my_displayName",
+ * // "locale": "my_locale",
+ * // "name": "my_name",
+ * // "reportDefinition": {},
+ * // "reportId": "my_reportId",
+ * // "updateTime": "my_updateTime"
+ * // }
+ * }
+ *
+ * main().catch(e => {
+ * console.error(e);
+ * throw e;
+ * });
+ *
+ * ```
+ *
+ * @param params - Parameters for request
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+ * @param callback - Optional callback that handles the response.
+ * @returns A promise if used with async/await, or void if used with a callback.
+ */
+ create(
+ params: Params$Resource$Agencies$Reports$Create,
+ options: StreamMethodOptions
+ ): Promise>;
+ create(
+ params?: Params$Resource$Agencies$Reports$Create,
+ options?: MethodOptions
+ ): Promise>;
+ create(
+ params: Params$Resource$Agencies$Reports$Create,
+ options: StreamMethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ create(
+ params: Params$Resource$Agencies$Reports$Create,
+ options: MethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ create(
+ params: Params$Resource$Agencies$Reports$Create,
+ callback: BodyResponseCallback
+ ): void;
+ create(callback: BodyResponseCallback): void;
+ create(
+ paramsOrCallback?:
+ | Params$Resource$Agencies$Reports$Create
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ optionsOrCallback?:
+ | MethodOptions
+ | StreamMethodOptions
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ callback?:
+ BodyResponseCallback | BodyResponseCallback
+ ):
+ | void
+ | Promise>
+ | Promise> {
+ let params = (paramsOrCallback ||
+ {}) as Params$Resource$Agencies$Reports$Create;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params = {} as Params$Resource$Agencies$Reports$Create;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl =
+ options.rootUrl || 'https://agenciesandbrands.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (rootUrl + '/v1/{+parent}/reports').replace(
+ /([^:]\/)\/+/g,
+ '$1'
+ ),
+ method: 'POST',
+ apiVersion: '',
+ },
+ options
+ ),
+ params,
+ requiredParams: ['parent'],
+ pathParams: ['parent'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(
+ parameters,
+ callback as BodyResponseCallback
+ );
+ } else {
+ return createAPIRequest(parameters);
+ }
+ }
+
+ /**
+ * Deletes a `Report` object.
+ * @example
+ * ```js
+ * // Before running the sample:
+ * // - Enable the API at:
+ * // https://console.developers.google.com/apis/api/agenciesandbrands.googleapis.com
+ * // - Login into gcloud by running:
+ * // ```sh
+ * // $ gcloud auth application-default login
+ * // ```
+ * // - Install the npm module by running:
+ * // ```sh
+ * // $ npm install googleapis
+ * // ```
+ *
+ * const {google} = require('googleapis');
+ * const agenciesandbrands = google.agenciesandbrands('v1');
+ *
+ * async function main() {
+ * const auth = new google.auth.GoogleAuth({
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
+ * scopes: ['https://www.googleapis.com/auth/agencies-and-brands'],
+ * });
+ *
+ * // Acquire an auth client, and bind it to all future calls
+ * const authClient = await auth.getClient();
+ * google.options({auth: authClient});
+ *
+ * // Do the magic
+ * const res = await agenciesandbrands.agencies.reports.delete({
+ * // Required. Resource name of the report to delete. Format: `agencies/{account_id\}/reports/{report_id\}`
+ * name: 'agencies/my-agencie/reports/my-report',
+ * });
+ * console.log(res.data);
+ *
+ * // Example response
+ * // {}
+ * }
+ *
+ * main().catch(e => {
+ * console.error(e);
+ * throw e;
+ * });
+ *
+ * ```
+ *
+ * @param params - Parameters for request
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+ * @param callback - Optional callback that handles the response.
+ * @returns A promise if used with async/await, or void if used with a callback.
+ */
+ delete(
+ params: Params$Resource$Agencies$Reports$Delete,
+ options: StreamMethodOptions
+ ): Promise>;
+ delete(
+ params?: Params$Resource$Agencies$Reports$Delete,
+ options?: MethodOptions
+ ): Promise>;
+ delete(
+ params: Params$Resource$Agencies$Reports$Delete,
+ options: StreamMethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ delete(
+ params: Params$Resource$Agencies$Reports$Delete,
+ options: MethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ delete(
+ params: Params$Resource$Agencies$Reports$Delete,
+ callback: BodyResponseCallback
+ ): void;
+ delete(callback: BodyResponseCallback): void;
+ delete(
+ paramsOrCallback?:
+ | Params$Resource$Agencies$Reports$Delete
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ optionsOrCallback?:
+ | MethodOptions
+ | StreamMethodOptions
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ callback?:
+ BodyResponseCallback | BodyResponseCallback
+ ):
+ | void
+ | Promise>
+ | Promise> {
+ let params = (paramsOrCallback ||
+ {}) as Params$Resource$Agencies$Reports$Delete;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params = {} as Params$Resource$Agencies$Reports$Delete;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl =
+ options.rootUrl || 'https://agenciesandbrands.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
+ method: 'DELETE',
+ apiVersion: '',
+ },
+ options
+ ),
+ params,
+ requiredParams: ['name'],
+ pathParams: ['name'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(
+ parameters,
+ callback as BodyResponseCallback
+ );
+ } else {
+ return createAPIRequest(parameters);
+ }
+ }
+
+ /**
+ * Retrieves a `Report` object.
+ * @example
+ * ```js
+ * // Before running the sample:
+ * // - Enable the API at:
+ * // https://console.developers.google.com/apis/api/agenciesandbrands.googleapis.com
+ * // - Login into gcloud by running:
+ * // ```sh
+ * // $ gcloud auth application-default login
+ * // ```
+ * // - Install the npm module by running:
+ * // ```sh
+ * // $ npm install googleapis
+ * // ```
+ *
+ * const {google} = require('googleapis');
+ * const agenciesandbrands = google.agenciesandbrands('v1');
+ *
+ * async function main() {
+ * const auth = new google.auth.GoogleAuth({
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
+ * scopes: ['https://www.googleapis.com/auth/agencies-and-brands'],
+ * });
+ *
+ * // Acquire an auth client, and bind it to all future calls
+ * const authClient = await auth.getClient();
+ * google.options({auth: authClient});
+ *
+ * // Do the magic
+ * const res = await agenciesandbrands.agencies.reports.get({
+ * // Required. The resource name of the report. Format: `agencies/{account_id\}/reports/{report_id\}`
+ * name: 'agencies/my-agencie/reports/my-report',
+ * });
+ * console.log(res.data);
+ *
+ * // Example response
+ * // {
+ * // "createTime": "my_createTime",
+ * // "displayName": "my_displayName",
+ * // "locale": "my_locale",
+ * // "name": "my_name",
+ * // "reportDefinition": {},
+ * // "reportId": "my_reportId",
+ * // "updateTime": "my_updateTime"
+ * // }
+ * }
+ *
+ * main().catch(e => {
+ * console.error(e);
+ * throw e;
+ * });
+ *
+ * ```
+ *
+ * @param params - Parameters for request
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+ * @param callback - Optional callback that handles the response.
+ * @returns A promise if used with async/await, or void if used with a callback.
+ */
+ get(
+ params: Params$Resource$Agencies$Reports$Get,
+ options: StreamMethodOptions
+ ): Promise>;
+ get(
+ params?: Params$Resource$Agencies$Reports$Get,
+ options?: MethodOptions
+ ): Promise>;
+ get(
+ params: Params$Resource$Agencies$Reports$Get,
+ options: StreamMethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ get(
+ params: Params$Resource$Agencies$Reports$Get,
+ options: MethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ get(
+ params: Params$Resource$Agencies$Reports$Get,
+ callback: BodyResponseCallback
+ ): void;
+ get(callback: BodyResponseCallback): void;
+ get(
+ paramsOrCallback?:
+ | Params$Resource$Agencies$Reports$Get
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ optionsOrCallback?:
+ | MethodOptions
+ | StreamMethodOptions
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ callback?:
+ BodyResponseCallback | BodyResponseCallback
+ ):
+ | void
+ | Promise>
+ | Promise> {
+ let params = (paramsOrCallback ||
+ {}) as Params$Resource$Agencies$Reports$Get;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params = {} as Params$Resource$Agencies$Reports$Get;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl =
+ options.rootUrl || 'https://agenciesandbrands.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
+ method: 'GET',
+ apiVersion: '',
+ },
+ options
+ ),
+ params,
+ requiredParams: ['name'],
+ pathParams: ['name'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(
+ parameters,
+ callback as BodyResponseCallback
+ );
+ } else {
+ return createAPIRequest(parameters);
+ }
+ }
+
+ /**
+ * Lists `Report` objects.
+ * @example
+ * ```js
+ * // Before running the sample:
+ * // - Enable the API at:
+ * // https://console.developers.google.com/apis/api/agenciesandbrands.googleapis.com
+ * // - Login into gcloud by running:
+ * // ```sh
+ * // $ gcloud auth application-default login
+ * // ```
+ * // - Install the npm module by running:
+ * // ```sh
+ * // $ npm install googleapis
+ * // ```
+ *
+ * const {google} = require('googleapis');
+ * const agenciesandbrands = google.agenciesandbrands('v1');
+ *
+ * async function main() {
+ * const auth = new google.auth.GoogleAuth({
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
+ * scopes: ['https://www.googleapis.com/auth/agencies-and-brands'],
+ * });
+ *
+ * // Acquire an auth client, and bind it to all future calls
+ * const authClient = await auth.getClient();
+ * google.options({auth: authClient});
+ *
+ * // Do the magic
+ * const res = await agenciesandbrands.agencies.reports.list({
+ * // Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
+ * filter: 'placeholder-value',
+ * // Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
+ * orderBy: 'placeholder-value',
+ * // Optional. The maximum number of `Reports` to return. The service may return fewer than this value. If unspecified, at most 50 `Reports` will be returned. The maximum value is 1000; values greater than 1000 will be coerced to 1000.
+ * pageSize: 'placeholder-value',
+ * // Optional. A page token, received from a previous `ListReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReports` must match the call that provided the page token.
+ * pageToken: 'placeholder-value',
+ * // Required. The parent, which owns this collection of reports. Format: `agencies/{account_id\}`
+ * parent: 'agencies/my-agencie',
+ * // Optional. Number of individual resources to skip while paginating.
+ * skip: 'placeholder-value',
+ * });
+ * console.log(res.data);
+ *
+ * // Example response
+ * // {
+ * // "nextPageToken": "my_nextPageToken",
+ * // "reports": [],
+ * // "totalSize": 0
+ * // }
+ * }
+ *
+ * main().catch(e => {
+ * console.error(e);
+ * throw e;
+ * });
+ *
+ * ```
+ *
+ * @param params - Parameters for request
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+ * @param callback - Optional callback that handles the response.
+ * @returns A promise if used with async/await, or void if used with a callback.
+ */
+ list(
+ params: Params$Resource$Agencies$Reports$List,
+ options: StreamMethodOptions
+ ): Promise>;
+ list(
+ params?: Params$Resource$Agencies$Reports$List,
+ options?: MethodOptions
+ ): Promise>;
+ list(
+ params: Params$Resource$Agencies$Reports$List,
+ options: StreamMethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ list(
+ params: Params$Resource$Agencies$Reports$List,
+ options: MethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ list(
+ params: Params$Resource$Agencies$Reports$List,
+ callback: BodyResponseCallback
+ ): void;
+ list(callback: BodyResponseCallback): void;
+ list(
+ paramsOrCallback?:
+ | Params$Resource$Agencies$Reports$List
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ optionsOrCallback?:
+ | MethodOptions
+ | StreamMethodOptions
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ callback?:
+ | BodyResponseCallback
+ | BodyResponseCallback
+ ):
+ | void
+ | Promise>
+ | Promise> {
+ let params = (paramsOrCallback ||
+ {}) as Params$Resource$Agencies$Reports$List;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params = {} as Params$Resource$Agencies$Reports$List;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl =
+ options.rootUrl || 'https://agenciesandbrands.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (rootUrl + '/v1/{+parent}/reports').replace(
+ /([^:]\/)\/+/g,
+ '$1'
+ ),
+ method: 'GET',
+ apiVersion: '',
+ },
+ options
+ ),
+ params,
+ requiredParams: ['parent'],
+ pathParams: ['parent'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(
+ parameters,
+ callback as BodyResponseCallback
+ );
+ } else {
+ return createAPIRequest(parameters);
+ }
+ }
+
+ /**
+ * Updates a `Report` object.
+ * @example
+ * ```js
+ * // Before running the sample:
+ * // - Enable the API at:
+ * // https://console.developers.google.com/apis/api/agenciesandbrands.googleapis.com
+ * // - Login into gcloud by running:
+ * // ```sh
+ * // $ gcloud auth application-default login
+ * // ```
+ * // - Install the npm module by running:
+ * // ```sh
+ * // $ npm install googleapis
+ * // ```
+ *
+ * const {google} = require('googleapis');
+ * const agenciesandbrands = google.agenciesandbrands('v1');
+ *
+ * async function main() {
+ * const auth = new google.auth.GoogleAuth({
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
+ * scopes: ['https://www.googleapis.com/auth/agencies-and-brands'],
+ * });
+ *
+ * // Acquire an auth client, and bind it to all future calls
+ * const authClient = await auth.getClient();
+ * google.options({auth: authClient});
+ *
+ * // Do the magic
+ * const res = await agenciesandbrands.agencies.reports.patch({
+ * // Identifier. The resource name of the report. Report resource name have the form: `agencies/{account_id\}/reports/{report_id\}`
+ * name: 'agencies/my-agencie/reports/my-report',
+ * // Optional. The list of fields to update.
+ * updateMask: 'placeholder-value',
+ *
+ * // Request body metadata
+ * requestBody: {
+ * // request body parameters
+ * // {
+ * // "createTime": "my_createTime",
+ * // "displayName": "my_displayName",
+ * // "locale": "my_locale",
+ * // "name": "my_name",
+ * // "reportDefinition": {},
+ * // "reportId": "my_reportId",
+ * // "updateTime": "my_updateTime"
+ * // }
+ * },
+ * });
+ * console.log(res.data);
+ *
+ * // Example response
+ * // {
+ * // "createTime": "my_createTime",
+ * // "displayName": "my_displayName",
+ * // "locale": "my_locale",
+ * // "name": "my_name",
+ * // "reportDefinition": {},
+ * // "reportId": "my_reportId",
+ * // "updateTime": "my_updateTime"
+ * // }
+ * }
+ *
+ * main().catch(e => {
+ * console.error(e);
+ * throw e;
+ * });
+ *
+ * ```
+ *
+ * @param params - Parameters for request
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+ * @param callback - Optional callback that handles the response.
+ * @returns A promise if used with async/await, or void if used with a callback.
+ */
+ patch(
+ params: Params$Resource$Agencies$Reports$Patch,
+ options: StreamMethodOptions
+ ): Promise>;
+ patch(
+ params?: Params$Resource$Agencies$Reports$Patch,
+ options?: MethodOptions
+ ): Promise>;
+ patch(
+ params: Params$Resource$Agencies$Reports$Patch,
+ options: StreamMethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ patch(
+ params: Params$Resource$Agencies$Reports$Patch,
+ options: MethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ patch(
+ params: Params$Resource$Agencies$Reports$Patch,
+ callback: BodyResponseCallback
+ ): void;
+ patch(callback: BodyResponseCallback): void;
+ patch(
+ paramsOrCallback?:
+ | Params$Resource$Agencies$Reports$Patch
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ optionsOrCallback?:
+ | MethodOptions
+ | StreamMethodOptions
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ callback?:
+ BodyResponseCallback | BodyResponseCallback
+ ):
+ | void
+ | Promise>
+ | Promise> {
+ let params = (paramsOrCallback ||
+ {}) as Params$Resource$Agencies$Reports$Patch;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params = {} as Params$Resource$Agencies$Reports$Patch;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl =
+ options.rootUrl || 'https://agenciesandbrands.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
+ method: 'PATCH',
+ apiVersion: '',
+ },
+ options
+ ),
+ params,
+ requiredParams: ['name'],
+ pathParams: ['name'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(
+ parameters,
+ callback as BodyResponseCallback
+ );
+ } else {
+ return createAPIRequest(parameters);
+ }
+ }
+
+ /**
+ * Initiates the execution of an existing report asynchronously. Users can get the report by polling this operation using `OperationsService.GetOperation`. Poll every 5 seconds initially, with an exponential backoff. Once a report is complete, the operation will contain a `RunReportResponse` in its response field containing a report_result that can be passed to the `FetchReportResultRows` method to retrieve the report data.
+ * @example
+ * ```js
+ * // Before running the sample:
+ * // - Enable the API at:
+ * // https://console.developers.google.com/apis/api/agenciesandbrands.googleapis.com
+ * // - Login into gcloud by running:
+ * // ```sh
+ * // $ gcloud auth application-default login
+ * // ```
+ * // - Install the npm module by running:
+ * // ```sh
+ * // $ npm install googleapis
+ * // ```
+ *
+ * const {google} = require('googleapis');
+ * const agenciesandbrands = google.agenciesandbrands('v1');
+ *
+ * async function main() {
+ * const auth = new google.auth.GoogleAuth({
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
+ * scopes: ['https://www.googleapis.com/auth/agencies-and-brands'],
+ * });
+ *
+ * // Acquire an auth client, and bind it to all future calls
+ * const authClient = await auth.getClient();
+ * google.options({auth: authClient});
+ *
+ * // Do the magic
+ * const res = await agenciesandbrands.agencies.reports.run({
+ * // Required. The report to run. Format: `agencies/{account_id\}/reports/{report_id\}`
+ * name: 'agencies/my-agencie/reports/my-report',
+ *
+ * // Request body metadata
+ * requestBody: {
+ * // request body parameters
+ * // {}
+ * },
+ * });
+ * console.log(res.data);
+ *
+ * // Example response
+ * // {
+ * // "done": false,
+ * // "error": {},
+ * // "metadata": {},
+ * // "name": "my_name",
+ * // "response": {}
+ * // }
+ * }
+ *
+ * main().catch(e => {
+ * console.error(e);
+ * throw e;
+ * });
+ *
+ * ```
+ *
+ * @param params - Parameters for request
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+ * @param callback - Optional callback that handles the response.
+ * @returns A promise if used with async/await, or void if used with a callback.
+ */
+ run(
+ params: Params$Resource$Agencies$Reports$Run,
+ options: StreamMethodOptions
+ ): Promise>;
+ run(
+ params?: Params$Resource$Agencies$Reports$Run,
+ options?: MethodOptions
+ ): Promise>;
+ run(
+ params: Params$Resource$Agencies$Reports$Run,
+ options: StreamMethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ run(
+ params: Params$Resource$Agencies$Reports$Run,
+ options: MethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ run(
+ params: Params$Resource$Agencies$Reports$Run,
+ callback: BodyResponseCallback
+ ): void;
+ run(callback: BodyResponseCallback): void;
+ run(
+ paramsOrCallback?:
+ | Params$Resource$Agencies$Reports$Run
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ optionsOrCallback?:
+ | MethodOptions
+ | StreamMethodOptions
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ callback?:
+ BodyResponseCallback | BodyResponseCallback
+ ):
+ | void
+ | Promise>
+ | Promise> {
+ let params = (paramsOrCallback ||
+ {}) as Params$Resource$Agencies$Reports$Run;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params = {} as Params$Resource$Agencies$Reports$Run;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl =
+ options.rootUrl || 'https://agenciesandbrands.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (rootUrl + '/v1/{+name}:run').replace(/([^:]\/)\/+/g, '$1'),
+ method: 'POST',
+ apiVersion: '',
+ },
+ options
+ ),
+ params,
+ requiredParams: ['name'],
+ pathParams: ['name'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(
+ parameters,
+ callback as BodyResponseCallback
+ );
+ } else {
+ return createAPIRequest(parameters);
+ }
+ }
+ }
+
+ export interface Params$Resource$Agencies$Reports$Create extends StandardParameters {
+ /**
+ * Required. The parent resource where this `Report` will be created. Format: `agencies/{account_id\}`
+ */
+ parent?: string;
+
+ /**
+ * Request body metadata
+ */
+ requestBody?: Schema$Report;
+ }
+ export interface Params$Resource$Agencies$Reports$Delete extends StandardParameters {
+ /**
+ * Required. Resource name of the report to delete. Format: `agencies/{account_id\}/reports/{report_id\}`
+ */
+ name?: string;
+ }
+ export interface Params$Resource$Agencies$Reports$Get extends StandardParameters {
+ /**
+ * Required. The resource name of the report. Format: `agencies/{account_id\}/reports/{report_id\}`
+ */
+ name?: string;
+ }
+ export interface Params$Resource$Agencies$Reports$List extends StandardParameters {
+ /**
+ * Optional. Expression to filter the response. See syntax details at https://developers.google.com/ad-manager/api/beta/filters
+ */
+ filter?: string;
+ /**
+ * Optional. Expression to specify sorting order. See syntax details at https://developers.google.com/ad-manager/api/beta/filters#order
+ */
+ orderBy?: string;
+ /**
+ * Optional. The maximum number of `Reports` to return. The service may return fewer than this value. If unspecified, at most 50 `Reports` will be returned. The maximum value is 1000; values greater than 1000 will be coerced to 1000.
+ */
+ pageSize?: number;
+ /**
+ * Optional. A page token, received from a previous `ListReports` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListReports` must match the call that provided the page token.
+ */
+ pageToken?: string;
+ /**
+ * Required. The parent, which owns this collection of reports. Format: `agencies/{account_id\}`
+ */
+ parent?: string;
+ /**
+ * Optional. Number of individual resources to skip while paginating.
+ */
+ skip?: number;
+ }
+ export interface Params$Resource$Agencies$Reports$Patch extends StandardParameters {
+ /**
+ * Identifier. The resource name of the report. Report resource name have the form: `agencies/{account_id\}/reports/{report_id\}`
+ */
+ name?: string;
+ /**
+ * Optional. The list of fields to update.
+ */
+ updateMask?: string;
+
+ /**
+ * Request body metadata
+ */
+ requestBody?: Schema$Report;
+ }
+ export interface Params$Resource$Agencies$Reports$Run extends StandardParameters {
+ /**
+ * Required. The report to run. Format: `agencies/{account_id\}/reports/{report_id\}`
+ */
+ name?: string;
+
+ /**
+ * Request body metadata
+ */
+ requestBody?: Schema$RunReportRequest;
+ }
+
+ export class Resource$Agencies$Reports$Operations {
+ context: APIRequestContext;
+ constructor(context: APIRequestContext) {
+ this.context = context;
+ }
+
+ /**
+ * Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+ * @example
+ * ```js
+ * // Before running the sample:
+ * // - Enable the API at:
+ * // https://console.developers.google.com/apis/api/agenciesandbrands.googleapis.com
+ * // - Login into gcloud by running:
+ * // ```sh
+ * // $ gcloud auth application-default login
+ * // ```
+ * // - Install the npm module by running:
+ * // ```sh
+ * // $ npm install googleapis
+ * // ```
+ *
+ * const {google} = require('googleapis');
+ * const agenciesandbrands = google.agenciesandbrands('v1');
+ *
+ * async function main() {
+ * const auth = new google.auth.GoogleAuth({
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
+ * scopes: ['https://www.googleapis.com/auth/agencies-and-brands'],
+ * });
+ *
+ * // Acquire an auth client, and bind it to all future calls
+ * const authClient = await auth.getClient();
+ * google.options({auth: authClient});
+ *
+ * // Do the magic
+ * const res = await agenciesandbrands.agencies.reports.operations.get({
+ * // The name of the operation resource.
+ * name: 'agencies/my-agencie/reports/my-report/operations/my-operation',
+ * });
+ * console.log(res.data);
+ *
+ * // Example response
+ * // {
+ * // "done": false,
+ * // "error": {},
+ * // "metadata": {},
+ * // "name": "my_name",
+ * // "response": {}
+ * // }
+ * }
+ *
+ * main().catch(e => {
+ * console.error(e);
+ * throw e;
+ * });
+ *
+ * ```
+ *
+ * @param params - Parameters for request
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+ * @param callback - Optional callback that handles the response.
+ * @returns A promise if used with async/await, or void if used with a callback.
+ */
+ get(
+ params: Params$Resource$Agencies$Reports$Operations$Get,
+ options: StreamMethodOptions
+ ): Promise>;
+ get(
+ params?: Params$Resource$Agencies$Reports$Operations$Get,
+ options?: MethodOptions
+ ): Promise>;
+ get(
+ params: Params$Resource$Agencies$Reports$Operations$Get,
+ options: StreamMethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ get(
+ params: Params$Resource$Agencies$Reports$Operations$Get,
+ options: MethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ get(
+ params: Params$Resource$Agencies$Reports$Operations$Get,
+ callback: BodyResponseCallback
+ ): void;
+ get(callback: BodyResponseCallback): void;
+ get(
+ paramsOrCallback?:
+ | Params$Resource$Agencies$Reports$Operations$Get
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ optionsOrCallback?:
+ | MethodOptions
+ | StreamMethodOptions
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ callback?:
+ BodyResponseCallback | BodyResponseCallback
+ ):
+ | void
+ | Promise>
+ | Promise> {
+ let params = (paramsOrCallback ||
+ {}) as Params$Resource$Agencies$Reports$Operations$Get;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params = {} as Params$Resource$Agencies$Reports$Operations$Get;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl =
+ options.rootUrl || 'https://agenciesandbrands.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'),
+ method: 'GET',
+ apiVersion: '',
+ },
+ options
+ ),
+ params,
+ requiredParams: ['name'],
+ pathParams: ['name'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(
+ parameters,
+ callback as BodyResponseCallback
+ );
+ } else {
+ return createAPIRequest(parameters);
+ }
+ }
+ }
+
+ export interface Params$Resource$Agencies$Reports$Operations$Get extends StandardParameters {
+ /**
+ * The name of the operation resource.
+ */
+ name?: string;
+ }
+
+ export class Resource$Agencies$Reports$Results {
+ context: APIRequestContext;
+ constructor(context: APIRequestContext) {
+ this.context = context;
+ }
+
+ /**
+ * Returns the result rows from a completed report. The caller must have previously called `RunReport` and waited for that operation to complete. The rows will be returned according to the order specified by the `sorts` member of the report definition.
+ * @example
+ * ```js
+ * // Before running the sample:
+ * // - Enable the API at:
+ * // https://console.developers.google.com/apis/api/agenciesandbrands.googleapis.com
+ * // - Login into gcloud by running:
+ * // ```sh
+ * // $ gcloud auth application-default login
+ * // ```
+ * // - Install the npm module by running:
+ * // ```sh
+ * // $ npm install googleapis
+ * // ```
+ *
+ * const {google} = require('googleapis');
+ * const agenciesandbrands = google.agenciesandbrands('v1');
+ *
+ * async function main() {
+ * const auth = new google.auth.GoogleAuth({
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
+ * scopes: ['https://www.googleapis.com/auth/agencies-and-brands'],
+ * });
+ *
+ * // Acquire an auth client, and bind it to all future calls
+ * const authClient = await auth.getClient();
+ * google.options({auth: authClient});
+ *
+ * // Do the magic
+ * const res = await agenciesandbrands.agencies.reports.results.fetchRows({
+ * // The report result being fetched. Format: `agencies/{account_id\}/reports/{report_id\}/results/{report_result_id\}`
+ * name: 'agencies/my-agencie/reports/my-report/results/my-result',
+ * // Optional. The maximum number of rows to return. The service may return fewer than this value. If unspecified, at most 1,000 rows will be returned. The maximum value is 10,000; values greater than 10,000 will be reduced to 10,000.
+ * pageSize: 'placeholder-value',
+ * // Optional. A page token, received from a previous `FetchReportResultRows` call. Provide this to retrieve the second and subsequent batches of rows.
+ * pageToken: 'placeholder-value',
+ * });
+ * console.log(res.data);
+ *
+ * // Example response
+ * // {
+ * // "dateRanges": [],
+ * // "nextPageToken": "my_nextPageToken",
+ * // "rows": [],
+ * // "runTime": "my_runTime",
+ * // "totalRowCount": 0
+ * // }
+ * }
+ *
+ * main().catch(e => {
+ * console.error(e);
+ * throw e;
+ * });
+ *
+ * ```
+ *
+ * @param params - Parameters for request
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+ * @param callback - Optional callback that handles the response.
+ * @returns A promise if used with async/await, or void if used with a callback.
+ */
+ fetchRows(
+ params: Params$Resource$Agencies$Reports$Results$Fetchrows,
+ options: StreamMethodOptions
+ ): Promise>;
+ fetchRows(
+ params?: Params$Resource$Agencies$Reports$Results$Fetchrows,
+ options?: MethodOptions
+ ): Promise>;
+ fetchRows(
+ params: Params$Resource$Agencies$Reports$Results$Fetchrows,
+ options: StreamMethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ fetchRows(
+ params: Params$Resource$Agencies$Reports$Results$Fetchrows,
+ options:
+ | MethodOptions
+ | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ fetchRows(
+ params: Params$Resource$Agencies$Reports$Results$Fetchrows,
+ callback: BodyResponseCallback
+ ): void;
+ fetchRows(
+ callback: BodyResponseCallback
+ ): void;
+ fetchRows(
+ paramsOrCallback?:
+ | Params$Resource$Agencies$Reports$Results$Fetchrows
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ optionsOrCallback?:
+ | MethodOptions
+ | StreamMethodOptions
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ callback?:
+ | BodyResponseCallback
+ | BodyResponseCallback
+ ):
+ | void
+ | Promise>
+ | Promise> {
+ let params = (paramsOrCallback ||
+ {}) as Params$Resource$Agencies$Reports$Results$Fetchrows;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params = {} as Params$Resource$Agencies$Reports$Results$Fetchrows;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl =
+ options.rootUrl || 'https://agenciesandbrands.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (rootUrl + '/v1/{+name}:fetchRows').replace(
+ /([^:]\/)\/+/g,
+ '$1'
+ ),
+ method: 'GET',
+ apiVersion: '',
+ },
+ options
+ ),
+ params,
+ requiredParams: ['name'],
+ pathParams: ['name'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(
+ parameters,
+ callback as BodyResponseCallback
+ );
+ } else {
+ return createAPIRequest(
+ parameters
+ );
+ }
+ }
+ }
+
+ export interface Params$Resource$Agencies$Reports$Results$Fetchrows extends StandardParameters {
+ /**
+ * The report result being fetched. Format: `agencies/{account_id\}/reports/{report_id\}/results/{report_result_id\}`
+ */
+ name?: string;
+ /**
+ * Optional. The maximum number of rows to return. The service may return fewer than this value. If unspecified, at most 1,000 rows will be returned. The maximum value is 10,000; values greater than 10,000 will be reduced to 10,000.
+ */
+ pageSize?: number;
+ /**
+ * Optional. A page token, received from a previous `FetchReportResultRows` call. Provide this to retrieve the second and subsequent batches of rows.
+ */
+ pageToken?: string;
+ }
+}
diff --git a/src/apis/agenciesandbrands/webpack.config.js b/src/apis/agenciesandbrands/webpack.config.js
new file mode 100644
index 00000000000..23bc312604a
--- /dev/null
+++ b/src/apis/agenciesandbrands/webpack.config.js
@@ -0,0 +1,79 @@
+// Copyright 2019 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Use `npm run webpack` to produce Webpack bundle for this library.
+
+const path = require('path');
+
+module.exports = {
+ entry: './index.ts',
+ resolve: {
+ extensions: ['.ts', '.js', '.json'],
+ fallback: {
+ crypto: false,
+ child_process: false,
+ fs: false,
+ http2: false,
+ buffer: 'browserify',
+ process: false,
+ os: false,
+ querystring: false,
+ path: false,
+ stream: 'stream-browserify',
+ url: false,
+ util: false,
+ zlib: false,
+ },
+ },
+ output: {
+ library: 'Agenciesandbrands',
+ filename: 'agenciesandbrands.min.js',
+ path: path.resolve(__dirname, 'dist'),
+ },
+ module: {
+ rules: [
+ {
+ test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/,
+ use: 'null-loader',
+ },
+ {
+ test: /node_modules[\\/]https-proxy-agent[\\/]/,
+ use: 'null-loader',
+ },
+ {
+ test: /node_modules[\\/]gcp-metadata[\\/]/,
+ use: 'null-loader',
+ },
+ {
+ test: /node_modules[\\/]gtoken[\\/]/,
+ use: 'null-loader',
+ },
+ {
+ test: /node_modules[\\/]pkginfo[\\/]/,
+ use: 'null-loader',
+ },
+ {
+ test: /node_modules[\\/]semver[\\/]/,
+ use: 'null-loader',
+ },
+ {
+ test: /\.ts$/,
+ use: 'ts-loader',
+ exclude: /node_modules/,
+ },
+ ],
+ },
+ mode: 'production',
+ plugins: [],
+};
diff --git a/src/apis/agentregistry/v1alpha.ts b/src/apis/agentregistry/v1alpha.ts
index e98cf882cba..26ebfb5fb4e 100644
--- a/src/apis/agentregistry/v1alpha.ts
+++ b/src/apis/agentregistry/v1alpha.ts
@@ -1096,8 +1096,10 @@ export namespace agentregistry_v1alpha {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
+ * 'https://www.googleapis.com/auth/agentregistry.read-only',
* 'https://www.googleapis.com/auth/agentregistry.read-write',
* 'https://www.googleapis.com/auth/cloud-platform',
+ * 'https://www.googleapis.com/auth/cloud-platform.read-only',
* ],
* });
*
@@ -1237,8 +1239,10 @@ export namespace agentregistry_v1alpha {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
+ * 'https://www.googleapis.com/auth/agentregistry.read-only',
* 'https://www.googleapis.com/auth/agentregistry.read-write',
* 'https://www.googleapis.com/auth/cloud-platform',
+ * 'https://www.googleapis.com/auth/cloud-platform.read-only',
* ],
* });
*
@@ -4219,8 +4223,10 @@ export namespace agentregistry_v1alpha {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
+ * 'https://www.googleapis.com/auth/agentregistry.read-only',
* 'https://www.googleapis.com/auth/agentregistry.read-write',
* 'https://www.googleapis.com/auth/cloud-platform',
+ * 'https://www.googleapis.com/auth/cloud-platform.read-only',
* ],
* });
*
@@ -6087,7 +6093,7 @@ export namespace agentregistry_v1alpha {
*
* // Do the magic
* const res = await agentregistry.projects.locations.skills.list({
- * // Optional. Use this field to specify filter criteria on list results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `\>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `\>` | |--------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state.
+ * // Optional. Use this field to specify filter criteria on list results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `\>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `\>` | |----------------------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | | publisher | Yes | No | | frontmatter.metadata. | Yes | No | | attributes.. | Yes | No | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state. * `frontmatter.metadata.version=10` to restrict results to skills with a frontmatter metadata `version` equal to `10`.
* filter: 'placeholder-value',
* // Optional. Hint for how to order the results
* orderBy: 'placeholder-value',
@@ -6408,7 +6414,7 @@ export namespace agentregistry_v1alpha {
*
* // Do the magic
* const res = await agentregistry.projects.locations.skills.search({
- * // Optional. Use this field to specify additional filter criteria on search results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `\>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `\>` | |--------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state.
+ * // Optional. Use this field to specify additional filter criteria on search results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `\>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `\>` | |----------------------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | | publisher | Yes | No | | frontmatter.metadata. | Yes | No | | attributes.. | Yes | No | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state. * `frontmatter.metadata.version=10` to restrict results to skills with a frontmatter metadata `version` equal to `10`.
* filter: 'placeholder-value',
* // Optional. The maximum number of search results to return per page. The page size is capped at `100`, even if a larger value is specified. A negative value will result in an `INVALID_ARGUMENT` error. If unspecified or set to `0`, a default value of `20` will be used. The server may return fewer results than requested.
* pageSize: 'placeholder-value',
@@ -6416,7 +6422,7 @@ export namespace agentregistry_v1alpha {
* pageToken: 'placeholder-value',
* // Required. Parent value for SearchSkillsRequest. Format: `projects/{project\}/locations/{location\}`.
* parent: 'projects/my-project/locations/my-location',
- * // Optional. Search criteria used to select the Skills to return. If no search criteria is specified then all accessible Skills will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |---------------------------|-----|-----|-----|----------------| | skillId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | description | No | Yes | No | Included | | frontmatter.name | No | Yes | No | Included | | frontmatter.description | No | Yes | No | Included | | frontmatter.compatibility | No | Yes | No | Included | | frontmatter.license | No | Yes | No | Included | Examples: * `skillId="urn:skill:projects-1234:locations:global:private-important-skill"` to find the skill with the specified skill ID. * `name:important` to find skills whose name contains `important` as a word. * `displayName:works*` to find skills whose display name contains words that start with `works`.
+ * // Optional. Search criteria used to select the Skills to return. If no search criteria is specified then all accessible Skills will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |----------------------------|-----|-----|-----|----------------| | skillId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | description | No | Yes | No | Included | | publisher | No | Yes | Yes | Excluded | | frontmatter.name | No | Yes | No | Included | | frontmatter.description | No | Yes | No | Included | | frontmatter.compatibility | No | Yes | No | Included | | frontmatter.license | No | Yes | No | Included | | frontmatter.metadata. | No | Yes | No | Excluded | | attributes.. | No | Yes | No | Excluded | Examples: * `skillId="urn:skill:projects-1234:locations:global:private-important-skill"` to find the skill with the specified skill ID. * `name:important` to find skills whose name contains `important` as a word. * `displayName:works*` to find skills whose display name contains words that start with `works`. * `frontmatter.metadata.author:alice` to find skills whose frontmatter metadata `author` contains words that start with `alice`.
* searchString: 'placeholder-value',
* // Optional. The type of search.
* searchType: 'placeholder-value',
@@ -6569,7 +6575,7 @@ export namespace agentregistry_v1alpha {
}
export interface Params$Resource$Projects$Locations$Skills$List extends StandardParameters {
/**
- * Optional. Use this field to specify filter criteria on list results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `\>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `\>` | |--------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state.
+ * Optional. Use this field to specify filter criteria on list results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `\>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `\>` | |----------------------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | | publisher | Yes | No | | frontmatter.metadata. | Yes | No | | attributes.. | Yes | No | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state. * `frontmatter.metadata.version=10` to restrict results to skills with a frontmatter metadata `version` equal to `10`.
*/
filter?: string;
/**
@@ -6610,7 +6616,7 @@ export namespace agentregistry_v1alpha {
}
export interface Params$Resource$Projects$Locations$Skills$Search extends StandardParameters {
/**
- * Optional. Use this field to specify additional filter criteria on search results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `\>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `\>` | |--------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state.
+ * Optional. Use this field to specify additional filter criteria on search results. Filter expressions can be used to restrict results based upon filterable fields, where equality operators can be used. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `<`, `\>`, `NOT`, `AND`, `OR`, and `()`. | Field | `=` | `<`, `\>` | |----------------------------|-----|----------| | state | Yes | No | | targetState | Yes | No | | createTime | Yes | Yes | | updateTime | Yes | Yes | | publisher | Yes | No | | frontmatter.metadata. | Yes | No | | attributes.. | Yes | No | Examples: * `state=ACTIVE` to restrict results to skills in the `ACTIVE` state. * `frontmatter.metadata.version=10` to restrict results to skills with a frontmatter metadata `version` equal to `10`.
*/
filter?: string;
/**
@@ -6626,7 +6632,7 @@ export namespace agentregistry_v1alpha {
*/
parent?: string;
/**
- * Optional. Search criteria used to select the Skills to return. If no search criteria is specified then all accessible Skills will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |---------------------------|-----|-----|-----|----------------| | skillId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | description | No | Yes | No | Included | | frontmatter.name | No | Yes | No | Included | | frontmatter.description | No | Yes | No | Included | | frontmatter.compatibility | No | Yes | No | Included | | frontmatter.license | No | Yes | No | Included | Examples: * `skillId="urn:skill:projects-1234:locations:global:private-important-skill"` to find the skill with the specified skill ID. * `name:important` to find skills whose name contains `important` as a word. * `displayName:works*` to find skills whose display name contains words that start with `works`.
+ * Optional. Search criteria used to select the Skills to return. If no search criteria is specified then all accessible Skills will be returned. Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol `*`. See [instructions](https://docs.cloud.google.com/agent-registry/search-agents-and-tools) for more details. Allowed operators: `=`, `:`, `NOT`, `AND`, `OR`, and `()`. Searchable fields: | Field | `=` | `:` | `*` | Keyword Search | |----------------------------|-----|-----|-----|----------------| | skillId | Yes | Yes | Yes | Included | | name | No | Yes | Yes | Included | | displayName | No | Yes | Yes | Included | | description | No | Yes | No | Included | | publisher | No | Yes | Yes | Excluded | | frontmatter.name | No | Yes | No | Included | | frontmatter.description | No | Yes | No | Included | | frontmatter.compatibility | No | Yes | No | Included | | frontmatter.license | No | Yes | No | Included | | frontmatter.metadata. | No | Yes | No | Excluded | | attributes.. | No | Yes | No | Excluded | Examples: * `skillId="urn:skill:projects-1234:locations:global:private-important-skill"` to find the skill with the specified skill ID. * `name:important` to find skills whose name contains `important` as a word. * `displayName:works*` to find skills whose display name contains words that start with `works`. * `frontmatter.metadata.author:alice` to find skills whose frontmatter metadata `author` contains words that start with `alice`.
*/
searchString?: string;
/**
diff --git a/src/apis/alloydb/v1.ts b/src/apis/alloydb/v1.ts
index 89b2ac8f3d9..ebd4d001634 100644
--- a/src/apis/alloydb/v1.ts
+++ b/src/apis/alloydb/v1.ts
@@ -124,15 +124,6 @@ export namespace alloydb_v1 {
}
}
- /**
- * AlloyDbInternalDebugInfo contains internal debugging information for AlloyDB errors. It is explicitly kept out of the allowlist (errors.yaml) to ensure it is sanitized (stripped) by OnePlatform for all external requests. Used only to carry internal error details to across UPC/FlowLib boundary for ObservabilityInfo.
- */
- export interface Schema$AlloydbClhErrorsAlloyDbInternalDebugInfo {
- /**
- * The original error message or details before sanitization, used internally for debugging and logging.
- */
- originalError?: string | null;
- }
/**
* AuthorizedNetwork contains metadata for an authorized network.
*/
diff --git a/src/apis/alloydb/v1alpha.ts b/src/apis/alloydb/v1alpha.ts
index 0a6372b0efc..408d9e1a66f 100644
--- a/src/apis/alloydb/v1alpha.ts
+++ b/src/apis/alloydb/v1alpha.ts
@@ -124,15 +124,6 @@ export namespace alloydb_v1alpha {
}
}
- /**
- * AlloyDbInternalDebugInfo contains internal debugging information for AlloyDB errors. It is explicitly kept out of the allowlist (errors.yaml) to ensure it is sanitized (stripped) by OnePlatform for all external requests. Used only to carry internal error details to across UPC/FlowLib boundary for ObservabilityInfo.
- */
- export interface Schema$AlloydbClhErrorsAlloyDbInternalDebugInfo {
- /**
- * The original error message or details before sanitization, used internally for debugging and logging.
- */
- originalError?: string | null;
- }
/**
* AuthorizedNetwork contains metadata for an authorized network.
*/
diff --git a/src/apis/alloydb/v1beta.ts b/src/apis/alloydb/v1beta.ts
index ea882ffd015..afd9b83f32a 100644
--- a/src/apis/alloydb/v1beta.ts
+++ b/src/apis/alloydb/v1beta.ts
@@ -124,15 +124,6 @@ export namespace alloydb_v1beta {
}
}
- /**
- * AlloyDbInternalDebugInfo contains internal debugging information for AlloyDB errors. It is explicitly kept out of the allowlist (errors.yaml) to ensure it is sanitized (stripped) by OnePlatform for all external requests. Used only to carry internal error details to across UPC/FlowLib boundary for ObservabilityInfo.
- */
- export interface Schema$AlloydbClhErrorsAlloyDbInternalDebugInfo {
- /**
- * The original error message or details before sanitization, used internally for debugging and logging.
- */
- originalError?: string | null;
- }
/**
* AuthorizedNetwork contains metadata for an authorized network.
*/
diff --git a/src/apis/authorizedbuyersmarketplace/v1alpha.ts b/src/apis/authorizedbuyersmarketplace/v1alpha.ts
index b428fe9a18a..fdd48b1def4 100644
--- a/src/apis/authorizedbuyersmarketplace/v1alpha.ts
+++ b/src/apis/authorizedbuyersmarketplace/v1alpha.ts
@@ -456,6 +456,10 @@ export namespace authorizedbuyersmarketplace_v1alpha {
* Output only. Time the data segment was last updated.
*/
updateTime?: string | null;
+ /**
+ * Optional. Immutable. The ID of the User List wrapped by this Data Segment. Curators with a linked Data Partner account can create a data segment that wraps a user list owned by the linked Data Partner account. User lists can be uploaded and managed using the [Data Manager API](https://developers.google.com/data-manager/api/data-partners/audiences). Linking a user list to a data segment lets you define a segment of inventory that is based on an audience you create.
+ */
+ userListId?: string | null;
}
/**
* Defines targeting for a period of time on a specific week day.
@@ -5209,7 +5213,8 @@ export namespace authorizedbuyersmarketplace_v1alpha {
* // "millipercentOfMediaFee": "my_millipercentOfMediaFee",
* // "name": "my_name",
* // "state": "my_state",
- * // "updateTime": "my_updateTime"
+ * // "updateTime": "my_updateTime",
+ * // "userListId": "my_userListId"
* // }
* }
*
@@ -5354,7 +5359,8 @@ export namespace authorizedbuyersmarketplace_v1alpha {
* // "millipercentOfMediaFee": "my_millipercentOfMediaFee",
* // "name": "my_name",
* // "state": "my_state",
- * // "updateTime": "my_updateTime"
+ * // "updateTime": "my_updateTime",
+ * // "userListId": "my_userListId"
* // }
* },
* });
@@ -5367,7 +5373,8 @@ export namespace authorizedbuyersmarketplace_v1alpha {
* // "millipercentOfMediaFee": "my_millipercentOfMediaFee",
* // "name": "my_name",
* // "state": "my_state",
- * // "updateTime": "my_updateTime"
+ * // "updateTime": "my_updateTime",
+ * // "userListId": "my_userListId"
* // }
* }
*
@@ -5518,7 +5525,8 @@ export namespace authorizedbuyersmarketplace_v1alpha {
* // "millipercentOfMediaFee": "my_millipercentOfMediaFee",
* // "name": "my_name",
* // "state": "my_state",
- * // "updateTime": "my_updateTime"
+ * // "updateTime": "my_updateTime",
+ * // "userListId": "my_userListId"
* // }
* }
*
@@ -5663,7 +5671,8 @@ export namespace authorizedbuyersmarketplace_v1alpha {
* // "millipercentOfMediaFee": "my_millipercentOfMediaFee",
* // "name": "my_name",
* // "state": "my_state",
- * // "updateTime": "my_updateTime"
+ * // "updateTime": "my_updateTime",
+ * // "userListId": "my_userListId"
* // }
* }
*
@@ -5953,7 +5962,8 @@ export namespace authorizedbuyersmarketplace_v1alpha {
* // "millipercentOfMediaFee": "my_millipercentOfMediaFee",
* // "name": "my_name",
* // "state": "my_state",
- * // "updateTime": "my_updateTime"
+ * // "updateTime": "my_updateTime",
+ * // "userListId": "my_userListId"
* // }
* },
* });
@@ -5966,7 +5976,8 @@ export namespace authorizedbuyersmarketplace_v1alpha {
* // "millipercentOfMediaFee": "my_millipercentOfMediaFee",
* // "name": "my_name",
* // "state": "my_state",
- * // "updateTime": "my_updateTime"
+ * // "updateTime": "my_updateTime",
+ * // "userListId": "my_userListId"
* // }
* }
*
diff --git a/src/apis/authorizedbuyersmarketplace/v1beta.ts b/src/apis/authorizedbuyersmarketplace/v1beta.ts
index 84b5a45e905..16e1f684333 100644
--- a/src/apis/authorizedbuyersmarketplace/v1beta.ts
+++ b/src/apis/authorizedbuyersmarketplace/v1beta.ts
@@ -254,6 +254,10 @@ export namespace authorizedbuyersmarketplace_v1beta {
* Output only. Time the data segment was last updated.
*/
updateTime?: string | null;
+ /**
+ * Optional. Immutable. The ID of the User List wrapped by this Data Segment. Curators with a linked Data Partner account can create a data segment that wraps a user list owned by the linked Data Partner account. User lists can be uploaded and managed using the [Data Manager API](https://developers.google.com/data-manager/api/data-partners/audiences). Linking a user list to a data segment lets you define a segment of inventory that is based on an audience you create.
+ */
+ userListId?: string | null;
}
/**
* Request message for DeactivateCuratedPackage.
@@ -1654,7 +1658,8 @@ export namespace authorizedbuyersmarketplace_v1beta {
* // "millipercentOfMediaFee": "my_millipercentOfMediaFee",
* // "name": "my_name",
* // "state": "my_state",
- * // "updateTime": "my_updateTime"
+ * // "updateTime": "my_updateTime",
+ * // "userListId": "my_userListId"
* // }
* }
*
@@ -1799,7 +1804,8 @@ export namespace authorizedbuyersmarketplace_v1beta {
* // "millipercentOfMediaFee": "my_millipercentOfMediaFee",
* // "name": "my_name",
* // "state": "my_state",
- * // "updateTime": "my_updateTime"
+ * // "updateTime": "my_updateTime",
+ * // "userListId": "my_userListId"
* // }
* },
* });
@@ -1812,7 +1818,8 @@ export namespace authorizedbuyersmarketplace_v1beta {
* // "millipercentOfMediaFee": "my_millipercentOfMediaFee",
* // "name": "my_name",
* // "state": "my_state",
- * // "updateTime": "my_updateTime"
+ * // "updateTime": "my_updateTime",
+ * // "userListId": "my_userListId"
* // }
* }
*
@@ -1964,7 +1971,8 @@ export namespace authorizedbuyersmarketplace_v1beta {
* // "millipercentOfMediaFee": "my_millipercentOfMediaFee",
* // "name": "my_name",
* // "state": "my_state",
- * // "updateTime": "my_updateTime"
+ * // "updateTime": "my_updateTime",
+ * // "userListId": "my_userListId"
* // }
* }
*
@@ -2109,7 +2117,8 @@ export namespace authorizedbuyersmarketplace_v1beta {
* // "millipercentOfMediaFee": "my_millipercentOfMediaFee",
* // "name": "my_name",
* // "state": "my_state",
- * // "updateTime": "my_updateTime"
+ * // "updateTime": "my_updateTime",
+ * // "userListId": "my_userListId"
* // }
* }
*
@@ -2399,7 +2408,8 @@ export namespace authorizedbuyersmarketplace_v1beta {
* // "millipercentOfMediaFee": "my_millipercentOfMediaFee",
* // "name": "my_name",
* // "state": "my_state",
- * // "updateTime": "my_updateTime"
+ * // "updateTime": "my_updateTime",
+ * // "userListId": "my_userListId"
* // }
* },
* });
@@ -2412,7 +2422,8 @@ export namespace authorizedbuyersmarketplace_v1beta {
* // "millipercentOfMediaFee": "my_millipercentOfMediaFee",
* // "name": "my_name",
* // "state": "my_state",
- * // "updateTime": "my_updateTime"
+ * // "updateTime": "my_updateTime",
+ * // "userListId": "my_userListId"
* // }
* }
*
diff --git a/src/apis/ces/v1.ts b/src/apis/ces/v1.ts
index 58a95ebdee6..8edba34d11c 100644
--- a/src/apis/ces/v1.ts
+++ b/src/apis/ces/v1.ts
@@ -493,6 +493,10 @@ export namespace ces_v1 {
* Output only. Timestamp when the app was created.
*/
createTime?: string | null;
+ /**
+ * Optional. App-specific dashboard settings for linking and configuring Contact Center Insights dashboards.
+ */
+ dashboardSettings?: Schema$DashboardSettings;
/**
* Optional. The data store settings for the app.
*/
@@ -1241,23 +1245,24 @@ export namespace ces_v1 {
* Optional. List of messages in the conversation turn, including user input, agent responses and intermediate events during the processing.
*/
messages?: Schema$Message[];
- /**
- * Output only. The full dynamically resolved developer instruction generated from templates. This field is only populated on-demand when requested during history retrieval. It is not persisted.
- */
- resolvedDeveloperInstruction?: string | null;
/**
* Optional. The root span of the action processing.
*/
rootSpan?: Schema$Span;
- /**
- * Optional. Variables or configurations referenced by the template engine during dynamic prompt generation. This allows reconstructing the exact prompt sent to the model for this turn.
- */
- templateAttributes?: {[key: string]: any} | null;
/**
* Optional. The intended ground-truth text from the Simulated Caller (Polysynth). Only populated when word error rate metrics are enabled.
*/
userIntendedText?: string | null;
}
+ /**
+ * Settings for dashboards associated with the app, that show up in the Monitoring view.
+ */
+ export interface Schema$DashboardSettings {
+ /**
+ * Optional. The resource name of the default Contact Center Insights dashboard associated with the app. This is the dashboard that will be displayed when users navigate to the Monitoring view for the app. Format: `projects/{project\}/locations/{location\}/dashboards/{dashboard\}`
+ */
+ defaultDashboard?: string | null;
+ }
/**
* A DataStore resource in Vertex AI Search.
*/
@@ -1525,6 +1530,10 @@ export namespace ces_v1 {
* Optional. Whether snippets are enabled.
*/
enableSnippets?: boolean | null;
+ /**
+ * Optional. Number of snippets to return per query. If unset, returns all snippets from the service by default.
+ */
+ maxSnippets?: number | null;
}
/**
* Summarization configuration.
@@ -1543,6 +1552,15 @@ export namespace ces_v1 {
*/
prompt?: string | null;
}
+ /**
+ * Response message for AgentService.DeployChannel.
+ */
+ export interface Schema$DeployChannelResponse {
+ /**
+ * The created deployment.
+ */
+ deployment?: Schema$Deployment;
+ }
/**
* A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.
*/
@@ -2286,6 +2304,14 @@ export namespace ces_v1 {
* Optional. Options governing the import process for the app.
*/
importOptions?: Schema$ImportAppRequestImportOptions;
+ /**
+ * Optional. Patch content as a JSON string.
+ */
+ jsonPatchContent?: string | null;
+ /**
+ * Optional. A Cloud Storage URI pointing to a JSON file containing the patches.
+ */
+ jsonPatchGcsUri?: string | null;
}
/**
* Configuration options for the app import process. These options control how the import behaves, particularly when conflicts arise with existing app data.
@@ -2947,6 +2973,27 @@ export namespace ces_v1 {
*/
task?: Schema$LfA2aV1Task;
}
+ /**
+ * A wrapper object used in streaming operations to encapsulate different types of response data.
+ */
+ export interface Schema$LfA2aV1StreamResponse {
+ /**
+ * An event indicating a task artifact update.
+ */
+ artifactUpdate?: Schema$LfA2aV1TaskArtifactUpdateEvent;
+ /**
+ * A Message object containing a message from the agent.
+ */
+ message?: Schema$LfA2aV1Message;
+ /**
+ * An event indicating a task status update.
+ */
+ statusUpdate?: Schema$LfA2aV1TaskStatusUpdateEvent;
+ /**
+ * A Task object containing the current state of the task.
+ */
+ task?: Schema$LfA2aV1Task;
+ }
/**
* protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.
*/
@@ -2985,6 +3032,35 @@ export namespace ces_v1 {
*/
status?: Schema$LfA2aV1TaskStatus;
}
+ /**
+ * A task delta where an artifact has been generated.
+ */
+ export interface Schema$LfA2aV1TaskArtifactUpdateEvent {
+ /**
+ * If true, the content of this artifact should be appended to a previously sent artifact with the same ID.
+ */
+ append?: boolean | null;
+ /**
+ * Required. The artifact that was generated or updated.
+ */
+ artifact?: Schema$LfA2aV1Artifact;
+ /**
+ * Required. The ID of the context that this task belongs to.
+ */
+ contextId?: string | null;
+ /**
+ * If true, this is the final chunk of the artifact.
+ */
+ lastChunk?: boolean | null;
+ /**
+ * Optional. Metadata associated with the artifact update.
+ */
+ metadata?: {[key: string]: any} | null;
+ /**
+ * Required. The ID of the task for this artifact.
+ */
+ taskId?: string | null;
+ }
/**
* A container associating a push notification configuration with a specific task.
*/
@@ -3031,6 +3107,27 @@ export namespace ces_v1 {
*/
timestamp?: string | null;
}
+ /**
+ * An event sent by the agent to notify the client of a change in a task's status.
+ */
+ export interface Schema$LfA2aV1TaskStatusUpdateEvent {
+ /**
+ * Required. The ID of the context that the task belongs to.
+ */
+ contextId?: string | null;
+ /**
+ * Optional. Metadata associated with the task update.
+ */
+ metadata?: {[key: string]: any} | null;
+ /**
+ * Required. The new status of the task.
+ */
+ status?: Schema$LfA2aV1TaskStatus;
+ /**
+ * Required. The ID of the task that has changed.
+ */
+ taskId?: string | null;
+ }
/**
* Response message for AgentService.ListAgents.
*/
@@ -3659,6 +3756,10 @@ export namespace ces_v1 {
* Required. The agent card of the remote agent that this tool invokes.
*/
agentCard?: Schema$AgentCard;
+ /**
+ * Optional. Authentication configuration for calling the remote agent.
+ */
+ apiAuthentication?: Schema$ApiAuthentication;
/**
* Required. The description of the tool.
*/
@@ -4013,6 +4114,10 @@ export namespace ces_v1 {
* The suggestions returned from Google Search as a result of invoking the GoogleSearchTool.
*/
googleSearchSuggestions?: Schema$GoogleSearchSuggestions;
+ /**
+ * Output image from the CES agent.
+ */
+ image?: Schema$Image;
/**
* Custom payload with structured output from the CES agent.
*/
@@ -4259,6 +4364,10 @@ export namespace ces_v1 {
* Request for the client or the agent to execute the specified tool.
*/
export interface Schema$ToolCall {
+ /**
+ * Output only. Human-readable name of the agent that issued this call, e.g. "Contract Architect". Empty when the root agent issued it.
+ */
+ agentName?: string | null;
/**
* Optional. The input parameters and values for the tool in JSON object format.
*/
@@ -4271,6 +4380,10 @@ export namespace ces_v1 {
* Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.
*/
id?: string | null;
+ /**
+ * Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.
+ */
+ parentToolCallId?: string | null;
/**
* Optional. The name of the tool to execute. Format: `projects/{project\}/locations/{location\}/apps/{app\}/tools/{tool\}`
*/
@@ -4306,6 +4419,10 @@ export namespace ces_v1 {
* The execution result of a specific tool from the client or the agent.
*/
export interface Schema$ToolResponse {
+ /**
+ * Output only. Human-readable name of the agent that issued this call, e.g. "Contract Architect". Empty when the root agent issued it.
+ */
+ agentName?: string | null;
/**
* Output only. Display name of the tool.
*/
@@ -4314,6 +4431,10 @@ export namespace ces_v1 {
* Optional. The matching ID of the tool call the response is for.
*/
id?: string | null;
+ /**
+ * Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.
+ */
+ parentToolCallId?: string | null;
/**
* Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
*/
@@ -5060,6 +5181,7 @@ export namespace ces_v1 {
* // "audioProcessingConfig": {},
* // "clientCertificateSettings": {},
* // "createTime": "my_createTime",
+ * // "dashboardSettings": {},
* // "dataStoreSettings": {},
* // "defaultChannelProfile": {},
* // "deploymentCount": 0,
@@ -5690,6 +5812,7 @@ export namespace ces_v1 {
* // "audioProcessingConfig": {},
* // "clientCertificateSettings": {},
* // "createTime": "my_createTime",
+ * // "dashboardSettings": {},
* // "dataStoreSettings": {},
* // "defaultChannelProfile": {},
* // "deploymentCount": 0,
@@ -6011,7 +6134,9 @@ export namespace ces_v1 {
* // "displayName": "my_displayName",
* // "gcsUri": "my_gcsUri",
* // "ignoreAppLock": false,
- * // "importOptions": {}
+ * // "importOptions": {},
+ * // "jsonPatchContent": "my_jsonPatchContent",
+ * // "jsonPatchGcsUri": "my_jsonPatchGcsUri"
* // }
* },
* });
@@ -6314,6 +6439,7 @@ export namespace ces_v1 {
* // "audioProcessingConfig": {},
* // "clientCertificateSettings": {},
* // "createTime": "my_createTime",
+ * // "dashboardSettings": {},
* // "dataStoreSettings": {},
* // "defaultChannelProfile": {},
* // "deploymentCount": 0,
@@ -6349,6 +6475,7 @@ export namespace ces_v1 {
* // "audioProcessingConfig": {},
* // "clientCertificateSettings": {},
* // "createTime": "my_createTime",
+ * // "dashboardSettings": {},
* // "dataStoreSettings": {},
* // "defaultChannelProfile": {},
* // "deploymentCount": 0,
@@ -8318,8 +8445,6 @@ export namespace ces_v1 {
* name: 'projects/my-project/locations/my-location/apps/my-app/conversations/my-conversation',
* // Optional. Indicate the source of the conversation. If not set, all source will be searched.
* source: 'placeholder-value',
- * // Optional. The view specifying which fields in the response should be populated.
- * view: 'placeholder-value',
* });
* console.log(res.data);
*
@@ -8620,10 +8745,6 @@ export namespace ces_v1 {
* Optional. Indicate the source of the conversation. If not set, all source will be searched.
*/
source?: string;
- /**
- * Optional. The view specifying which fields in the response should be populated.
- */
- view?: string;
}
export interface Params$Resource$Projects$Locations$Apps$Conversations$List extends StandardParameters {
/**
@@ -9826,6 +9947,162 @@ export namespace ces_v1 {
return createAPIRequest(parameters);
}
}
+
+ /**
+ * Sends a streaming message to an agent, allowing for real-time interaction and status updates. Streaming version of `SendMessage`
+ * @example
+ * ```js
+ * // Before running the sample:
+ * // - Enable the API at:
+ * // https://console.developers.google.com/apis/api/ces.googleapis.com
+ * // - Login into gcloud by running:
+ * // ```sh
+ * // $ gcloud auth application-default login
+ * // ```
+ * // - Install the npm module by running:
+ * // ```sh
+ * // $ npm install googleapis
+ * // ```
+ *
+ * const {google} = require('googleapis');
+ * const ces = google.ces('v1');
+ *
+ * async function main() {
+ * const auth = new google.auth.GoogleAuth({
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
+ * scopes: [
+ * 'https://www.googleapis.com/auth/ces',
+ * 'https://www.googleapis.com/auth/cloud-platform',
+ * ],
+ * });
+ *
+ * // Acquire an auth client, and bind it to all future calls
+ * const authClient = await auth.getClient();
+ * google.options({auth: authClient});
+ *
+ * // Do the magic
+ * const res = await ces.projects.locations.apps.deployments.message.stream({
+ * // Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.
+ * tenant:
+ * 'projects/my-project/locations/my-location/apps/my-app/deployments/my-deployment',
+ *
+ * // Request body metadata
+ * requestBody: {
+ * // request body parameters
+ * // {
+ * // "configuration": {},
+ * // "message": {},
+ * // "metadata": {}
+ * // }
+ * },
+ * });
+ * console.log(res.data);
+ *
+ * // Example response
+ * // {
+ * // "artifactUpdate": {},
+ * // "message": {},
+ * // "statusUpdate": {},
+ * // "task": {}
+ * // }
+ * }
+ *
+ * main().catch(e => {
+ * console.error(e);
+ * throw e;
+ * });
+ *
+ * ```
+ *
+ * @param params - Parameters for request
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+ * @param callback - Optional callback that handles the response.
+ * @returns A promise if used with async/await, or void if used with a callback.
+ */
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Deployments$Message$Stream,
+ options: StreamMethodOptions
+ ): Promise>;
+ stream(
+ params?: Params$Resource$Projects$Locations$Apps$Deployments$Message$Stream,
+ options?: MethodOptions
+ ): Promise>;
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Deployments$Message$Stream,
+ options: StreamMethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Deployments$Message$Stream,
+ options:
+ MethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Deployments$Message$Stream,
+ callback: BodyResponseCallback
+ ): void;
+ stream(callback: BodyResponseCallback): void;
+ stream(
+ paramsOrCallback?:
+ | Params$Resource$Projects$Locations$Apps$Deployments$Message$Stream
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ optionsOrCallback?:
+ | MethodOptions
+ | StreamMethodOptions
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ callback?:
+ | BodyResponseCallback
+ | BodyResponseCallback
+ ):
+ | void
+ | Promise>
+ | Promise> {
+ let params = (paramsOrCallback ||
+ {}) as Params$Resource$Projects$Locations$Apps$Deployments$Message$Stream;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params =
+ {} as Params$Resource$Projects$Locations$Apps$Deployments$Message$Stream;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl = options.rootUrl || 'https://ces.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (rootUrl + '/v1/{+tenant}/message:stream').replace(
+ /([^:]\/)\/+/g,
+ '$1'
+ ),
+ method: 'POST',
+ apiVersion: '',
+ },
+ options
+ ),
+ params,
+ requiredParams: ['tenant'],
+ pathParams: ['tenant'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(
+ parameters,
+ callback as BodyResponseCallback
+ );
+ } else {
+ return createAPIRequest(parameters);
+ }
+ }
}
export interface Params$Resource$Projects$Locations$Apps$Deployments$Message$Send extends StandardParameters {
@@ -9839,6 +10116,17 @@ export namespace ces_v1 {
*/
requestBody?: Schema$LfA2aV1SendMessageRequest;
}
+ export interface Params$Resource$Projects$Locations$Apps$Deployments$Message$Stream extends StandardParameters {
+ /**
+ * Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.
+ */
+ tenant?: string;
+
+ /**
+ * Request body metadata
+ */
+ requestBody?: Schema$LfA2aV1SendMessageRequest;
+ }
export class Resource$Projects$Locations$Apps$Examples {
context: APIRequestContext;
@@ -11693,6 +11981,160 @@ export namespace ces_v1 {
return createAPIRequest(parameters);
}
}
+
+ /**
+ * Sends a streaming message to an agent, allowing for real-time interaction and status updates. Streaming version of `SendMessage`
+ * @example
+ * ```js
+ * // Before running the sample:
+ * // - Enable the API at:
+ * // https://console.developers.google.com/apis/api/ces.googleapis.com
+ * // - Login into gcloud by running:
+ * // ```sh
+ * // $ gcloud auth application-default login
+ * // ```
+ * // - Install the npm module by running:
+ * // ```sh
+ * // $ npm install googleapis
+ * // ```
+ *
+ * const {google} = require('googleapis');
+ * const ces = google.ces('v1');
+ *
+ * async function main() {
+ * const auth = new google.auth.GoogleAuth({
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
+ * scopes: [
+ * 'https://www.googleapis.com/auth/ces',
+ * 'https://www.googleapis.com/auth/cloud-platform',
+ * ],
+ * });
+ *
+ * // Acquire an auth client, and bind it to all future calls
+ * const authClient = await auth.getClient();
+ * google.options({auth: authClient});
+ *
+ * // Do the magic
+ * const res = await ces.projects.locations.apps.message.stream({
+ * // Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.
+ * tenant: 'projects/my-project/locations/my-location/apps/my-app',
+ *
+ * // Request body metadata
+ * requestBody: {
+ * // request body parameters
+ * // {
+ * // "configuration": {},
+ * // "message": {},
+ * // "metadata": {}
+ * // }
+ * },
+ * });
+ * console.log(res.data);
+ *
+ * // Example response
+ * // {
+ * // "artifactUpdate": {},
+ * // "message": {},
+ * // "statusUpdate": {},
+ * // "task": {}
+ * // }
+ * }
+ *
+ * main().catch(e => {
+ * console.error(e);
+ * throw e;
+ * });
+ *
+ * ```
+ *
+ * @param params - Parameters for request
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+ * @param callback - Optional callback that handles the response.
+ * @returns A promise if used with async/await, or void if used with a callback.
+ */
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Message$Stream,
+ options: StreamMethodOptions
+ ): Promise>;
+ stream(
+ params?: Params$Resource$Projects$Locations$Apps$Message$Stream,
+ options?: MethodOptions
+ ): Promise>;
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Message$Stream,
+ options: StreamMethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Message$Stream,
+ options:
+ MethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Message$Stream,
+ callback: BodyResponseCallback
+ ): void;
+ stream(callback: BodyResponseCallback): void;
+ stream(
+ paramsOrCallback?:
+ | Params$Resource$Projects$Locations$Apps$Message$Stream
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ optionsOrCallback?:
+ | MethodOptions
+ | StreamMethodOptions
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ callback?:
+ | BodyResponseCallback
+ | BodyResponseCallback
+ ):
+ | void
+ | Promise>
+ | Promise> {
+ let params = (paramsOrCallback ||
+ {}) as Params$Resource$Projects$Locations$Apps$Message$Stream;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params = {} as Params$Resource$Projects$Locations$Apps$Message$Stream;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl = options.rootUrl || 'https://ces.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (rootUrl + '/v1/{+tenant}/message:stream').replace(
+ /([^:]\/)\/+/g,
+ '$1'
+ ),
+ method: 'POST',
+ apiVersion: '',
+ },
+ options
+ ),
+ params,
+ requiredParams: ['tenant'],
+ pathParams: ['tenant'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(
+ parameters,
+ callback as BodyResponseCallback
+ );
+ } else {
+ return createAPIRequest(parameters);
+ }
+ }
}
export interface Params$Resource$Projects$Locations$Apps$Message$Send extends StandardParameters {
@@ -11706,6 +12148,17 @@ export namespace ces_v1 {
*/
requestBody?: Schema$LfA2aV1SendMessageRequest;
}
+ export interface Params$Resource$Projects$Locations$Apps$Message$Stream extends StandardParameters {
+ /**
+ * Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.
+ */
+ tenant?: string;
+
+ /**
+ * Request body metadata
+ */
+ requestBody?: Schema$LfA2aV1SendMessageRequest;
+ }
export class Resource$Projects$Locations$Apps$Sessions {
context: APIRequestContext;
@@ -15262,6 +15715,162 @@ export namespace ces_v1 {
return createAPIRequest(parameters);
}
}
+
+ /**
+ * Sends a streaming message to an agent, allowing for real-time interaction and status updates. Streaming version of `SendMessage`
+ * @example
+ * ```js
+ * // Before running the sample:
+ * // - Enable the API at:
+ * // https://console.developers.google.com/apis/api/ces.googleapis.com
+ * // - Login into gcloud by running:
+ * // ```sh
+ * // $ gcloud auth application-default login
+ * // ```
+ * // - Install the npm module by running:
+ * // ```sh
+ * // $ npm install googleapis
+ * // ```
+ *
+ * const {google} = require('googleapis');
+ * const ces = google.ces('v1');
+ *
+ * async function main() {
+ * const auth = new google.auth.GoogleAuth({
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
+ * scopes: [
+ * 'https://www.googleapis.com/auth/ces',
+ * 'https://www.googleapis.com/auth/cloud-platform',
+ * ],
+ * });
+ *
+ * // Acquire an auth client, and bind it to all future calls
+ * const authClient = await auth.getClient();
+ * google.options({auth: authClient});
+ *
+ * // Do the magic
+ * const res = await ces.projects.locations.apps.versions.message.stream({
+ * // Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.
+ * tenant:
+ * 'projects/my-project/locations/my-location/apps/my-app/versions/my-version',
+ *
+ * // Request body metadata
+ * requestBody: {
+ * // request body parameters
+ * // {
+ * // "configuration": {},
+ * // "message": {},
+ * // "metadata": {}
+ * // }
+ * },
+ * });
+ * console.log(res.data);
+ *
+ * // Example response
+ * // {
+ * // "artifactUpdate": {},
+ * // "message": {},
+ * // "statusUpdate": {},
+ * // "task": {}
+ * // }
+ * }
+ *
+ * main().catch(e => {
+ * console.error(e);
+ * throw e;
+ * });
+ *
+ * ```
+ *
+ * @param params - Parameters for request
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+ * @param callback - Optional callback that handles the response.
+ * @returns A promise if used with async/await, or void if used with a callback.
+ */
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Versions$Message$Stream,
+ options: StreamMethodOptions
+ ): Promise>;
+ stream(
+ params?: Params$Resource$Projects$Locations$Apps$Versions$Message$Stream,
+ options?: MethodOptions
+ ): Promise>;
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Versions$Message$Stream,
+ options: StreamMethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Versions$Message$Stream,
+ options:
+ MethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Versions$Message$Stream,
+ callback: BodyResponseCallback
+ ): void;
+ stream(callback: BodyResponseCallback): void;
+ stream(
+ paramsOrCallback?:
+ | Params$Resource$Projects$Locations$Apps$Versions$Message$Stream
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ optionsOrCallback?:
+ | MethodOptions
+ | StreamMethodOptions
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ callback?:
+ | BodyResponseCallback
+ | BodyResponseCallback
+ ):
+ | void
+ | Promise>
+ | Promise> {
+ let params = (paramsOrCallback ||
+ {}) as Params$Resource$Projects$Locations$Apps$Versions$Message$Stream;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params =
+ {} as Params$Resource$Projects$Locations$Apps$Versions$Message$Stream;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl = options.rootUrl || 'https://ces.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (rootUrl + '/v1/{+tenant}/message:stream').replace(
+ /([^:]\/)\/+/g,
+ '$1'
+ ),
+ method: 'POST',
+ apiVersion: '',
+ },
+ options
+ ),
+ params,
+ requiredParams: ['tenant'],
+ pathParams: ['tenant'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(
+ parameters,
+ callback as BodyResponseCallback
+ );
+ } else {
+ return createAPIRequest(parameters);
+ }
+ }
}
export interface Params$Resource$Projects$Locations$Apps$Versions$Message$Send extends StandardParameters {
@@ -15275,6 +15884,17 @@ export namespace ces_v1 {
*/
requestBody?: Schema$LfA2aV1SendMessageRequest;
}
+ export interface Params$Resource$Projects$Locations$Apps$Versions$Message$Stream extends StandardParameters {
+ /**
+ * Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.
+ */
+ tenant?: string;
+
+ /**
+ * Request body metadata
+ */
+ requestBody?: Schema$LfA2aV1SendMessageRequest;
+ }
export class Resource$Projects$Locations$Operations {
context: APIRequestContext;
diff --git a/src/apis/ces/v1beta.ts b/src/apis/ces/v1beta.ts
index bf89f202664..4a88ef8e0a5 100644
--- a/src/apis/ces/v1beta.ts
+++ b/src/apis/ces/v1beta.ts
@@ -629,6 +629,10 @@ export namespace ces_v1beta {
* Output only. Timestamp when the app was created.
*/
createTime?: string | null;
+ /**
+ * Optional. App-specific dashboard settings for linking and configuring Contact Center Insights dashboards.
+ */
+ dashboardSettings?: Schema$DashboardSettings;
/**
* Optional. The data store settings for the app.
*/
@@ -1402,23 +1406,24 @@ export namespace ces_v1beta {
* Optional. List of messages in the conversation turn, including user input, agent responses and intermediate events during the processing.
*/
messages?: Schema$Message[];
- /**
- * Output only. The full dynamically resolved developer instruction generated from templates. This field is only populated on-demand when requested during history retrieval. It is not persisted.
- */
- resolvedDeveloperInstruction?: string | null;
/**
* Optional. The root span of the action processing.
*/
rootSpan?: Schema$Span;
- /**
- * Optional. Variables or configurations referenced by the template engine during dynamic prompt generation. This allows reconstructing the exact prompt sent to the model for this turn.
- */
- templateAttributes?: {[key: string]: any} | null;
/**
* Optional. The intended ground-truth text from the Simulated Caller (Polysynth). Only populated when word error rate metrics are enabled.
*/
userIntendedText?: string | null;
}
+ /**
+ * Settings for dashboards associated with the app, that show up in the Monitoring view.
+ */
+ export interface Schema$DashboardSettings {
+ /**
+ * Optional. The resource name of the default Contact Center Insights dashboard associated with the app. This is the dashboard that will be displayed when users navigate to the Monitoring view for the app. Format: `projects/{project\}/locations/{location\}/dashboards/{dashboard\}`
+ */
+ defaultDashboard?: string | null;
+ }
/**
* A DataStore resource in Vertex AI Search.
*/
@@ -1686,6 +1691,10 @@ export namespace ces_v1beta {
* Optional. Whether snippets are enabled.
*/
enableSnippets?: boolean | null;
+ /**
+ * Optional. Number of snippets to return per query. If unset, returns all snippets from the service by default.
+ */
+ maxSnippets?: number | null;
}
/**
* Summarization configuration.
@@ -1708,6 +1717,15 @@ export namespace ces_v1beta {
* Operation metadata for EvaluationService.DeleteEvaluationRun.
*/
export interface Schema$DeleteEvaluationRunOperationMetadata {}
+ /**
+ * Response message for AgentService.DeployChannel.
+ */
+ export interface Schema$DeployChannelResponse {
+ /**
+ * The created deployment.
+ */
+ deployment?: Schema$Deployment;
+ }
/**
* A deployment represents an immutable, queryable version of the app. It is used to deploy an app version with a specific channel profile.
*/
@@ -4080,6 +4098,14 @@ export namespace ces_v1beta {
* Optional. Options governing the import process for the app.
*/
importOptions?: Schema$ImportAppRequestImportOptions;
+ /**
+ * Optional. Patch content as a JSON string.
+ */
+ jsonPatchContent?: string | null;
+ /**
+ * Optional. A Cloud Storage URI pointing to a JSON file containing the patches.
+ */
+ jsonPatchGcsUri?: string | null;
}
/**
* Configuration options for the app import process. These options control how the import behaves, particularly when conflicts arise with existing app data.
@@ -4940,6 +4966,27 @@ export namespace ces_v1beta {
*/
task?: Schema$LfA2aV1Task;
}
+ /**
+ * A wrapper object used in streaming operations to encapsulate different types of response data.
+ */
+ export interface Schema$LfA2aV1StreamResponse {
+ /**
+ * An event indicating a task artifact update.
+ */
+ artifactUpdate?: Schema$LfA2aV1TaskArtifactUpdateEvent;
+ /**
+ * A Message object containing a message from the agent.
+ */
+ message?: Schema$LfA2aV1Message;
+ /**
+ * An event indicating a task status update.
+ */
+ statusUpdate?: Schema$LfA2aV1TaskStatusUpdateEvent;
+ /**
+ * A Task object containing the current state of the task.
+ */
+ task?: Schema$LfA2aV1Task;
+ }
/**
* protolint:disable REPEATED_FIELD_NAMES_PLURALIZED A list of strings.
*/
@@ -4978,6 +5025,35 @@ export namespace ces_v1beta {
*/
status?: Schema$LfA2aV1TaskStatus;
}
+ /**
+ * A task delta where an artifact has been generated.
+ */
+ export interface Schema$LfA2aV1TaskArtifactUpdateEvent {
+ /**
+ * If true, the content of this artifact should be appended to a previously sent artifact with the same ID.
+ */
+ append?: boolean | null;
+ /**
+ * Required. The artifact that was generated or updated.
+ */
+ artifact?: Schema$LfA2aV1Artifact;
+ /**
+ * Required. The ID of the context that this task belongs to.
+ */
+ contextId?: string | null;
+ /**
+ * If true, this is the final chunk of the artifact.
+ */
+ lastChunk?: boolean | null;
+ /**
+ * Optional. Metadata associated with the artifact update.
+ */
+ metadata?: {[key: string]: any} | null;
+ /**
+ * Required. The ID of the task for this artifact.
+ */
+ taskId?: string | null;
+ }
/**
* A container associating a push notification configuration with a specific task.
*/
@@ -5024,6 +5100,27 @@ export namespace ces_v1beta {
*/
timestamp?: string | null;
}
+ /**
+ * An event sent by the agent to notify the client of a change in a task's status.
+ */
+ export interface Schema$LfA2aV1TaskStatusUpdateEvent {
+ /**
+ * Required. The ID of the context that the task belongs to.
+ */
+ contextId?: string | null;
+ /**
+ * Optional. Metadata associated with the task update.
+ */
+ metadata?: {[key: string]: any} | null;
+ /**
+ * Required. The new status of the task.
+ */
+ status?: Schema$LfA2aV1TaskStatus;
+ /**
+ * Required. The ID of the task that has changed.
+ */
+ taskId?: string | null;
+ }
/**
* Response message for AgentService.ListAgents.
*/
@@ -5823,6 +5920,10 @@ export namespace ces_v1beta {
* Required. The agent card of the remote agent that this tool invokes.
*/
agentCard?: Schema$AgentCard;
+ /**
+ * Optional. Authentication configuration for calling the remote agent.
+ */
+ apiAuthentication?: Schema$ApiAuthentication;
/**
* Required. The description of the tool.
*/
@@ -6325,6 +6426,10 @@ export namespace ces_v1beta {
* The suggestions returned from Google Search as a result of invoking the GoogleSearchTool.
*/
googleSearchSuggestions?: Schema$GoogleSearchSuggestions;
+ /**
+ * Output image from the CES agent.
+ */
+ image?: Schema$Image;
/**
* Custom payload with structured output from the CES agent.
*/
@@ -6593,6 +6698,10 @@ export namespace ces_v1beta {
* Request for the client or the agent to execute the specified tool.
*/
export interface Schema$ToolCall {
+ /**
+ * Output only. Human-readable name of the agent that issued this call, e.g. "Contract Architect". Empty when the root agent issued it.
+ */
+ agentName?: string | null;
/**
* Optional. The input parameters and values for the tool in JSON object format.
*/
@@ -6605,6 +6714,10 @@ export namespace ces_v1beta {
* Optional. The unique identifier of the tool call. If populated, the client should return the execution result with the matching ID in ToolResponse.
*/
id?: string | null;
+ /**
+ * Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.
+ */
+ parentToolCallId?: string | null;
/**
* Optional. The name of the tool to execute. Format: `projects/{project\}/locations/{location\}/apps/{app\}/tools/{tool\}`
*/
@@ -6640,6 +6753,10 @@ export namespace ces_v1beta {
* The execution result of a specific tool from the client or the agent.
*/
export interface Schema$ToolResponse {
+ /**
+ * Output only. Human-readable name of the agent that issued this call, e.g. "Contract Architect". Empty when the root agent issued it.
+ */
+ agentName?: string | null;
/**
* Output only. Display name of the tool.
*/
@@ -6648,6 +6765,10 @@ export namespace ces_v1beta {
* Optional. The matching ID of the tool call the response is for.
*/
id?: string | null;
+ /**
+ * Output only. The id of the tool call that caused this one, when it was issued by a sub-agent working on behalf of a parent call. Empty for top-level calls. Lets a client group a sub-agent's work under the call that started it instead of rendering every step as a sibling.
+ */
+ parentToolCallId?: string | null;
/**
* Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
*/
@@ -7767,6 +7888,7 @@ export namespace ces_v1beta {
* // "audioProcessingConfig": {},
* // "clientCertificateSettings": {},
* // "createTime": "my_createTime",
+ * // "dashboardSettings": {},
* // "dataStoreSettings": {},
* // "defaultChannelProfile": {},
* // "deploymentCount": 0,
@@ -8564,6 +8686,7 @@ export namespace ces_v1beta {
* // "audioProcessingConfig": {},
* // "clientCertificateSettings": {},
* // "createTime": "my_createTime",
+ * // "dashboardSettings": {},
* // "dataStoreSettings": {},
* // "defaultChannelProfile": {},
* // "deploymentCount": 0,
@@ -8887,7 +9010,9 @@ export namespace ces_v1beta {
* // "displayName": "my_displayName",
* // "gcsUri": "my_gcsUri",
* // "ignoreAppLock": false,
- * // "importOptions": {}
+ * // "importOptions": {},
+ * // "jsonPatchContent": "my_jsonPatchContent",
+ * // "jsonPatchGcsUri": "my_jsonPatchGcsUri"
* // }
* },
* });
@@ -9348,6 +9473,7 @@ export namespace ces_v1beta {
* // "audioProcessingConfig": {},
* // "clientCertificateSettings": {},
* // "createTime": "my_createTime",
+ * // "dashboardSettings": {},
* // "dataStoreSettings": {},
* // "defaultChannelProfile": {},
* // "deploymentCount": 0,
@@ -9385,6 +9511,7 @@ export namespace ces_v1beta {
* // "audioProcessingConfig": {},
* // "clientCertificateSettings": {},
* // "createTime": "my_createTime",
+ * // "dashboardSettings": {},
* // "dataStoreSettings": {},
* // "defaultChannelProfile": {},
* // "deploymentCount": 0,
@@ -11868,8 +11995,6 @@ export namespace ces_v1beta {
* name: 'projects/my-project/locations/my-location/apps/my-app/conversations/my-conversation',
* // Optional. Indicate the source of the conversation. If not set, all source will be searched.
* source: 'placeholder-value',
- * // Optional. The view specifying which fields in the response should be populated.
- * view: 'placeholder-value',
* });
* console.log(res.data);
*
@@ -12181,10 +12306,6 @@ export namespace ces_v1beta {
* Optional. Indicate the source of the conversation. If not set, all source will be searched.
*/
source?: string;
- /**
- * Optional. The view specifying which fields in the response should be populated.
- */
- view?: string;
}
export interface Params$Resource$Projects$Locations$Apps$Conversations$List extends StandardParameters {
/**
@@ -13387,6 +13508,162 @@ export namespace ces_v1beta {
return createAPIRequest(parameters);
}
}
+
+ /**
+ * Sends a streaming message to an agent, allowing for real-time interaction and status updates. Streaming version of `SendMessage`
+ * @example
+ * ```js
+ * // Before running the sample:
+ * // - Enable the API at:
+ * // https://console.developers.google.com/apis/api/ces.googleapis.com
+ * // - Login into gcloud by running:
+ * // ```sh
+ * // $ gcloud auth application-default login
+ * // ```
+ * // - Install the npm module by running:
+ * // ```sh
+ * // $ npm install googleapis
+ * // ```
+ *
+ * const {google} = require('googleapis');
+ * const ces = google.ces('v1beta');
+ *
+ * async function main() {
+ * const auth = new google.auth.GoogleAuth({
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
+ * scopes: [
+ * 'https://www.googleapis.com/auth/ces',
+ * 'https://www.googleapis.com/auth/cloud-platform',
+ * ],
+ * });
+ *
+ * // Acquire an auth client, and bind it to all future calls
+ * const authClient = await auth.getClient();
+ * google.options({auth: authClient});
+ *
+ * // Do the magic
+ * const res = await ces.projects.locations.apps.deployments.message.stream({
+ * // Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.
+ * tenant:
+ * 'projects/my-project/locations/my-location/apps/my-app/deployments/my-deployment',
+ *
+ * // Request body metadata
+ * requestBody: {
+ * // request body parameters
+ * // {
+ * // "configuration": {},
+ * // "message": {},
+ * // "metadata": {}
+ * // }
+ * },
+ * });
+ * console.log(res.data);
+ *
+ * // Example response
+ * // {
+ * // "artifactUpdate": {},
+ * // "message": {},
+ * // "statusUpdate": {},
+ * // "task": {}
+ * // }
+ * }
+ *
+ * main().catch(e => {
+ * console.error(e);
+ * throw e;
+ * });
+ *
+ * ```
+ *
+ * @param params - Parameters for request
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+ * @param callback - Optional callback that handles the response.
+ * @returns A promise if used with async/await, or void if used with a callback.
+ */
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Deployments$Message$Stream,
+ options: StreamMethodOptions
+ ): Promise>;
+ stream(
+ params?: Params$Resource$Projects$Locations$Apps$Deployments$Message$Stream,
+ options?: MethodOptions
+ ): Promise>;
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Deployments$Message$Stream,
+ options: StreamMethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Deployments$Message$Stream,
+ options:
+ MethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Deployments$Message$Stream,
+ callback: BodyResponseCallback
+ ): void;
+ stream(callback: BodyResponseCallback): void;
+ stream(
+ paramsOrCallback?:
+ | Params$Resource$Projects$Locations$Apps$Deployments$Message$Stream
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ optionsOrCallback?:
+ | MethodOptions
+ | StreamMethodOptions
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ callback?:
+ | BodyResponseCallback
+ | BodyResponseCallback
+ ):
+ | void
+ | Promise>
+ | Promise> {
+ let params = (paramsOrCallback ||
+ {}) as Params$Resource$Projects$Locations$Apps$Deployments$Message$Stream;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params =
+ {} as Params$Resource$Projects$Locations$Apps$Deployments$Message$Stream;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl = options.rootUrl || 'https://ces.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (rootUrl + '/v1beta/{+tenant}/message:stream').replace(
+ /([^:]\/)\/+/g,
+ '$1'
+ ),
+ method: 'POST',
+ apiVersion: '',
+ },
+ options
+ ),
+ params,
+ requiredParams: ['tenant'],
+ pathParams: ['tenant'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(
+ parameters,
+ callback as BodyResponseCallback
+ );
+ } else {
+ return createAPIRequest(parameters);
+ }
+ }
}
export interface Params$Resource$Projects$Locations$Apps$Deployments$Message$Send extends StandardParameters {
@@ -13400,6 +13677,17 @@ export namespace ces_v1beta {
*/
requestBody?: Schema$LfA2aV1SendMessageRequest;
}
+ export interface Params$Resource$Projects$Locations$Apps$Deployments$Message$Stream extends StandardParameters {
+ /**
+ * Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.
+ */
+ tenant?: string;
+
+ /**
+ * Request body metadata
+ */
+ requestBody?: Schema$LfA2aV1SendMessageRequest;
+ }
export class Resource$Projects$Locations$Apps$Evaluationdatasets {
context: APIRequestContext;
@@ -19679,6 +19967,160 @@ export namespace ces_v1beta {
return createAPIRequest(parameters);
}
}
+
+ /**
+ * Sends a streaming message to an agent, allowing for real-time interaction and status updates. Streaming version of `SendMessage`
+ * @example
+ * ```js
+ * // Before running the sample:
+ * // - Enable the API at:
+ * // https://console.developers.google.com/apis/api/ces.googleapis.com
+ * // - Login into gcloud by running:
+ * // ```sh
+ * // $ gcloud auth application-default login
+ * // ```
+ * // - Install the npm module by running:
+ * // ```sh
+ * // $ npm install googleapis
+ * // ```
+ *
+ * const {google} = require('googleapis');
+ * const ces = google.ces('v1beta');
+ *
+ * async function main() {
+ * const auth = new google.auth.GoogleAuth({
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
+ * scopes: [
+ * 'https://www.googleapis.com/auth/ces',
+ * 'https://www.googleapis.com/auth/cloud-platform',
+ * ],
+ * });
+ *
+ * // Acquire an auth client, and bind it to all future calls
+ * const authClient = await auth.getClient();
+ * google.options({auth: authClient});
+ *
+ * // Do the magic
+ * const res = await ces.projects.locations.apps.message.stream({
+ * // Optional. Opaque routing identifier. Must match the `tenant` value from the selected `AgentInterface` in the Agent Card when that field is set.
+ * tenant: 'projects/my-project/locations/my-location/apps/my-app',
+ *
+ * // Request body metadata
+ * requestBody: {
+ * // request body parameters
+ * // {
+ * // "configuration": {},
+ * // "message": {},
+ * // "metadata": {}
+ * // }
+ * },
+ * });
+ * console.log(res.data);
+ *
+ * // Example response
+ * // {
+ * // "artifactUpdate": {},
+ * // "message": {},
+ * // "statusUpdate": {},
+ * // "task": {}
+ * // }
+ * }
+ *
+ * main().catch(e => {
+ * console.error(e);
+ * throw e;
+ * });
+ *
+ * ```
+ *
+ * @param params - Parameters for request
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+ * @param callback - Optional callback that handles the response.
+ * @returns A promise if used with async/await, or void if used with a callback.
+ */
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Message$Stream,
+ options: StreamMethodOptions
+ ): Promise>;
+ stream(
+ params?: Params$Resource$Projects$Locations$Apps$Message$Stream,
+ options?: MethodOptions
+ ): Promise>;
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Message$Stream,
+ options: StreamMethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Message$Stream,
+ options:
+ MethodOptions | BodyResponseCallback,
+ callback: BodyResponseCallback
+ ): void;
+ stream(
+ params: Params$Resource$Projects$Locations$Apps$Message$Stream,
+ callback: BodyResponseCallback
+ ): void;
+ stream(callback: BodyResponseCallback): void;
+ stream(
+ paramsOrCallback?:
+ | Params$Resource$Projects$Locations$Apps$Message$Stream
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ optionsOrCallback?:
+ | MethodOptions
+ | StreamMethodOptions
+ | BodyResponseCallback
+ | BodyResponseCallback,
+ callback?:
+ | BodyResponseCallback
+ | BodyResponseCallback
+ ):
+ | void
+ | Promise>
+ | Promise> {
+ let params = (paramsOrCallback ||
+ {}) as Params$Resource$Projects$Locations$Apps$Message$Stream;
+ let options = (optionsOrCallback || {}) as MethodOptions;
+
+ if (typeof paramsOrCallback === 'function') {
+ callback = paramsOrCallback;
+ params = {} as Params$Resource$Projects$Locations$Apps$Message$Stream;
+ options = {};
+ }
+
+ if (typeof optionsOrCallback === 'function') {
+ callback = optionsOrCallback;
+ options = {};
+ }
+
+ const rootUrl = options.rootUrl || 'https://ces.googleapis.com/';
+ const parameters = {
+ options: Object.assign(
+ {
+ url: (rootUrl + '/v1beta/{+tenant}/message:stream').replace(
+ /([^:]\/)\/+/g,
+ '$1'
+ ),
+ method: 'POST',
+ apiVersion: '',
+ },
+ options
+ ),
+ params,
+ requiredParams: ['tenant'],
+ pathParams: ['tenant'],
+ context: this.context,
+ };
+ if (callback) {
+ createAPIRequest(
+ parameters,
+ callback as BodyResponseCallback
+ );
+ } else {
+ return createAPIRequest