diff --git a/androidpublisher/v3/androidpublisher-api.json b/androidpublisher/v3/androidpublisher-api.json index 0f0ef1b66c2..f5c092d6276 100644 --- a/androidpublisher/v3/androidpublisher-api.json +++ b/androidpublisher/v3/androidpublisher-api.json @@ -3040,7 +3040,7 @@ } } }, - "revision": "20220125", + "revision": "20220221", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Apk": { @@ -4198,12 +4198,14 @@ "TAX_TIER_UNSPECIFIED", "TAX_TIER_BOOKS_1", "TAX_TIER_NEWS_1", - "TAX_TIER_NEWS_2" + "TAX_TIER_NEWS_2", + "TAX_TIER_MUSIC_OR_AUDIO_1" ], "enumDescriptions": [ "", "", "", + "", "" ], "type": "string" diff --git a/androidpublisher/v3/androidpublisher-gen.go b/androidpublisher/v3/androidpublisher-gen.go index ebdaa438d24..8c30d7a1dde 100644 --- a/androidpublisher/v3/androidpublisher-gen.go +++ b/androidpublisher/v3/androidpublisher-gen.go @@ -2446,6 +2446,7 @@ type RegionalTaxRateInfo struct { // "TAX_TIER_BOOKS_1" // "TAX_TIER_NEWS_1" // "TAX_TIER_NEWS_2" + // "TAX_TIER_MUSIC_OR_AUDIO_1" TaxTier string `json:"taxTier,omitempty"` // ForceSendFields is a list of field names (e.g. diff --git a/api-list.json b/api-list.json index 3bd249fd579..9f45b7cdf7a 100644 --- a/api-list.json +++ b/api-list.json @@ -541,13 +541,28 @@ "documentationLink": "https://developers.google.com/authorized-buyers/apis/marketplace/reference/rest/", "preferred": true }, + { + "kind": "discovery#directoryItem", + "id": "baremetalsolution:v1alpha1", + "name": "baremetalsolution", + "version": "v1alpha1", + "title": "Bare Metal Solution API", + "description": "Provides ways to manage Bare Metal Solution hardware installed in a regional extension located near a Google Cloud data center.", + "discoveryRestUrl": "https://baremetalsolution.googleapis.com/$discovery/rest?version=v1alpha1", + "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" + }, + "documentationLink": "https://cloud.google.com/bare-metal", + "preferred": false + }, { "kind": "discovery#directoryItem", "id": "baremetalsolution:v1", "name": "baremetalsolution", "version": "v1", "title": "Bare Metal Solution API", - "description": "Bare Metal Solution provides hardware to run specialized workloads with low latency on Google Cloud.", + "description": "Provides ways to manage Bare Metal Solution hardware installed in a regional extension located near a Google Cloud data center.", "discoveryRestUrl": "https://baremetalsolution.googleapis.com/$discovery/rest?version=v1", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", @@ -562,7 +577,7 @@ "name": "baremetalsolution", "version": "v2", "title": "Bare Metal Solution API", - "description": "Bare Metal Solution provides hardware to run specialized workloads with low latency on Google Cloud.", + "description": "Provides ways to manage Bare Metal Solution hardware installed in a regional extension located near a Google Cloud data center.", "discoveryRestUrl": "https://baremetalsolution.googleapis.com/$discovery/rest?version=v2", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", diff --git a/apigee/v1/apigee-api.json b/apigee/v1/apigee-api.json index a7ea88bd39d..8ccacd2e129 100644 --- a/apigee/v1/apigee-api.json +++ b/apigee/v1/apigee-api.json @@ -3907,7 +3907,7 @@ "type": "boolean" }, "sequencedRollout": { - "description": "Flag that specifies whether to enable sequenced rollout. If set to `true`, a best-effort attempt will be made to roll out the routing rules corresponding to this deployment and the environment changes to add this deployment in a safe order. This reduces the risk of downtime that could be caused by changing the environment group's routing before the new destination for the affected traffic is ready to receive it. This should only be necessary if the new deployment will be capturing traffic from another environment under a shared environment group or if traffic will be rerouted to a different environment due to a base path removal. The [GenerateDeployChangeReport API](GenerateDeployChangeReport) may be used to examine routing changes before issuing the deployment request, and its response will indicate if a sequenced rollout is recommended for the deployment.", + "description": "Flag that specifies whether to enable sequenced rollout. If set to `true`, the routing rules for this deployment and the environment changes to add the deployment will be rolled out in a safe order. This reduces the risk of downtime that could be caused by changing the environment group's routing before the new destination for the affected traffic is ready to receive it. This should only be necessary if the new deployment will be capturing traffic from another environment under a shared environment group or if traffic will be rerouted to a different environment due to a base path removal. The [GenerateDeployChangeReport API](GenerateDeployChangeReport) may be used to examine routing changes before issuing the deployment request, and its response will indicate if a sequenced rollout is recommended for the deployment.", "location": "query", "type": "boolean" }, @@ -3967,7 +3967,7 @@ "type": "string" }, "sequencedRollout": { - "description": "Flag that specifies whether to enable sequenced rollout. If set to `true`, a best-effort attempt will be made to remove the environment group routing rules corresponding to this deployment before removing the deployment from the runtime. This is likely to be a rare use case; it is only needed when the intended effect of undeploying this proxy is to cause the traffic it currently handles to be rerouted to some other existing proxy in the environment group. The [GenerateUndeployChangeReport API](GenerateUndeployChangeReport) may be used to examine routing changes before issuing the undeployment request, and its response will indicate if a sequenced rollout is recommended for the undeployment.", + "description": "Flag that specifies whether to enable sequenced rollout. If set to `true`, the environment group routing rules corresponding to this deployment will be removed before removing the deployment from the runtime. This is likely to be a rare use case; it is only needed when the intended effect of undeploying this proxy is to cause the traffic it currently handles to be rerouted to some other existing proxy in the environment group. The [GenerateUndeployChangeReport API](GenerateUndeployChangeReport) may be used to examine routing changes before issuing the undeployment request, and its response will indicate if a sequenced rollout is recommended for the undeployment.", "location": "query", "type": "boolean" } @@ -7563,7 +7563,7 @@ } } }, - "revision": "20220210", + "revision": "20220217", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { diff --git a/apigee/v1/apigee-gen.go b/apigee/v1/apigee-gen.go index 271ca621cb9..f4fa5543f58 100644 --- a/apigee/v1/apigee-gen.go +++ b/apigee/v1/apigee-gen.go @@ -29430,15 +29430,14 @@ func (c *OrganizationsEnvironmentsApisRevisionsDeployCall) Override(override boo // SequencedRollout sets the optional parameter "sequencedRollout": Flag // that specifies whether to enable sequenced rollout. If set to `true`, -// a best-effort attempt will be made to roll out the routing rules -// corresponding to this deployment and the environment changes to add -// this deployment in a safe order. This reduces the risk of downtime -// that could be caused by changing the environment group's routing -// before the new destination for the affected traffic is ready to -// receive it. This should only be necessary if the new deployment will -// be capturing traffic from another environment under a shared -// environment group or if traffic will be rerouted to a different -// environment due to a base path removal. The +// the routing rules for this deployment and the environment changes to +// add the deployment will be rolled out in a safe order. This reduces +// the risk of downtime that could be caused by changing the environment +// group's routing before the new destination for the affected traffic +// is ready to receive it. This should only be necessary if the new +// deployment will be capturing traffic from another environment under a +// shared environment group or if traffic will be rerouted to a +// different environment due to a base path removal. The // GenerateDeployChangeReport API (GenerateDeployChangeReport) may be // used to examine routing changes before issuing the deployment // request, and its response will indicate if a sequenced rollout is @@ -29565,7 +29564,7 @@ func (c *OrganizationsEnvironmentsApisRevisionsDeployCall) Do(opts ...googleapi. // "type": "boolean" // }, // "sequencedRollout": { - // "description": "Flag that specifies whether to enable sequenced rollout. If set to `true`, a best-effort attempt will be made to roll out the routing rules corresponding to this deployment and the environment changes to add this deployment in a safe order. This reduces the risk of downtime that could be caused by changing the environment group's routing before the new destination for the affected traffic is ready to receive it. This should only be necessary if the new deployment will be capturing traffic from another environment under a shared environment group or if traffic will be rerouted to a different environment due to a base path removal. The [GenerateDeployChangeReport API](GenerateDeployChangeReport) may be used to examine routing changes before issuing the deployment request, and its response will indicate if a sequenced rollout is recommended for the deployment.", + // "description": "Flag that specifies whether to enable sequenced rollout. If set to `true`, the routing rules for this deployment and the environment changes to add the deployment will be rolled out in a safe order. This reduces the risk of downtime that could be caused by changing the environment group's routing before the new destination for the affected traffic is ready to receive it. This should only be necessary if the new deployment will be capturing traffic from another environment under a shared environment group or if traffic will be rerouted to a different environment due to a base path removal. The [GenerateDeployChangeReport API](GenerateDeployChangeReport) may be used to examine routing changes before issuing the deployment request, and its response will indicate if a sequenced rollout is recommended for the deployment.", // "location": "query", // "type": "boolean" // }, @@ -29765,16 +29764,15 @@ func (r *OrganizationsEnvironmentsApisRevisionsService) Undeploy(name string) *O // SequencedRollout sets the optional parameter "sequencedRollout": Flag // that specifies whether to enable sequenced rollout. If set to `true`, -// a best-effort attempt will be made to remove the environment group -// routing rules corresponding to this deployment before removing the -// deployment from the runtime. This is likely to be a rare use case; it -// is only needed when the intended effect of undeploying this proxy is -// to cause the traffic it currently handles to be rerouted to some -// other existing proxy in the environment group. The -// GenerateUndeployChangeReport API (GenerateUndeployChangeReport) may -// be used to examine routing changes before issuing the undeployment -// request, and its response will indicate if a sequenced rollout is -// recommended for the undeployment. +// the environment group routing rules corresponding to this deployment +// will be removed before removing the deployment from the runtime. This +// is likely to be a rare use case; it is only needed when the intended +// effect of undeploying this proxy is to cause the traffic it currently +// handles to be rerouted to some other existing proxy in the +// environment group. The GenerateUndeployChangeReport API +// (GenerateUndeployChangeReport) may be used to examine routing changes +// before issuing the undeployment request, and its response will +// indicate if a sequenced rollout is recommended for the undeployment. func (c *OrganizationsEnvironmentsApisRevisionsUndeployCall) SequencedRollout(sequencedRollout bool) *OrganizationsEnvironmentsApisRevisionsUndeployCall { c.urlParams_.Set("sequencedRollout", fmt.Sprint(sequencedRollout)) return c @@ -29882,7 +29880,7 @@ func (c *OrganizationsEnvironmentsApisRevisionsUndeployCall) Do(opts ...googleap // "type": "string" // }, // "sequencedRollout": { - // "description": "Flag that specifies whether to enable sequenced rollout. If set to `true`, a best-effort attempt will be made to remove the environment group routing rules corresponding to this deployment before removing the deployment from the runtime. This is likely to be a rare use case; it is only needed when the intended effect of undeploying this proxy is to cause the traffic it currently handles to be rerouted to some other existing proxy in the environment group. The [GenerateUndeployChangeReport API](GenerateUndeployChangeReport) may be used to examine routing changes before issuing the undeployment request, and its response will indicate if a sequenced rollout is recommended for the undeployment.", + // "description": "Flag that specifies whether to enable sequenced rollout. If set to `true`, the environment group routing rules corresponding to this deployment will be removed before removing the deployment from the runtime. This is likely to be a rare use case; it is only needed when the intended effect of undeploying this proxy is to cause the traffic it currently handles to be rerouted to some other existing proxy in the environment group. The [GenerateUndeployChangeReport API](GenerateUndeployChangeReport) may be used to examine routing changes before issuing the undeployment request, and its response will indicate if a sequenced rollout is recommended for the undeployment.", // "location": "query", // "type": "boolean" // } diff --git a/baremetalsolution/v1alpha1/baremetalsolution-api.json b/baremetalsolution/v1alpha1/baremetalsolution-api.json index 71a29f23bb6..2322832f482 100644 --- a/baremetalsolution/v1alpha1/baremetalsolution-api.json +++ b/baremetalsolution/v1alpha1/baremetalsolution-api.json @@ -189,7 +189,7 @@ } } }, - "revision": "20211015", + "revision": "20220209", "rootUrl": "https://baremetalsolution.googleapis.com/", "schemas": { "InstanceConfig": { @@ -294,8 +294,12 @@ "description": "IP address to be assigned to the server.", "type": "string" }, + "existingNetworkId": { + "description": "Name of the existing network to use. Will be of the format at--vlan for pre-intake UI networks like for eg, at-123456-vlan001 or any user-defined name like for eg, my-network-name for networks provisioned using intake UI. The field is exclusively filled only in case of an already existing network. Mutually exclusive with network_id.", + "type": "string" + }, "networkId": { - "description": "Id of the network to use, within the same ProvisioningConfig request.", + "description": "Name of the network to use, within the same ProvisioningConfig request. This represents a new network being provisioned in the same request. Can have any user-defined name like for eg, my-network-name. Mutually exclusive with existing_network_id.", "type": "string" } }, diff --git a/baremetalsolution/v1alpha1/baremetalsolution-gen.go b/baremetalsolution/v1alpha1/baremetalsolution-gen.go index d4598d2c751..6d93889e7d1 100644 --- a/baremetalsolution/v1alpha1/baremetalsolution-gen.go +++ b/baremetalsolution/v1alpha1/baremetalsolution-gen.go @@ -50,6 +50,7 @@ import ( "strings" googleapi "google.golang.org/api/googleapi" + internal "google.golang.org/api/internal" gensupport "google.golang.org/api/internal/gensupport" option "google.golang.org/api/option" internaloption "google.golang.org/api/option/internaloption" @@ -331,8 +332,18 @@ type NetworkAddress struct { // Address: IP address to be assigned to the server. Address string `json:"address,omitempty"` - // NetworkId: Id of the network to use, within the same - // ProvisioningConfig request. + // ExistingNetworkId: Name of the existing network to use. Will be of + // the format at--vlan for pre-intake UI networks like for eg, + // at-123456-vlan001 or any user-defined name like for eg, + // my-network-name for networks provisioned using intake UI. The field + // is exclusively filled only in case of an already existing network. + // Mutually exclusive with network_id. + ExistingNetworkId string `json:"existingNetworkId,omitempty"` + + // NetworkId: Name of the network to use, within the same + // ProvisioningConfig request. This represents a new network being + // provisioned in the same request. Can have any user-defined name like + // for eg, my-network-name. Mutually exclusive with existing_network_id. NetworkId string `json:"networkId,omitempty"` // ForceSendFields is a list of field names (e.g. "Address") to @@ -740,7 +751,7 @@ func (c *ProjectsLocationsSubmitProvisioningConfigCall) Header() http.Header { func (c *ProjectsLocationsSubmitProvisioningConfigCall) doRequest(alt string) (*http.Response, error) { reqHeaders := make(http.Header) - reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/20220112") + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) for k, v := range c.header_ { reqHeaders[k] = v } @@ -915,7 +926,7 @@ func (c *ProjectsProvisioningQuotasListCall) Header() http.Header { func (c *ProjectsProvisioningQuotasListCall) doRequest(alt string) (*http.Response, error) { reqHeaders := make(http.Header) - reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/20220112") + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) for k, v := range c.header_ { reqHeaders[k] = v } diff --git a/chat/v1/chat-api.json b/chat/v1/chat-api.json index 7721218a24a..1ef97faa7ea 100644 --- a/chat/v1/chat-api.json +++ b/chat/v1/chat-api.json @@ -642,7 +642,7 @@ } } }, - "revision": "20220209", + "revision": "20220216", "rootUrl": "https://chat.googleapis.com/", "schemas": { "ActionParameter": { @@ -666,7 +666,7 @@ "properties": { "dialogAction": { "$ref": "DialogAction", - "description": "This response is for Dialog related events and must be accompanied by ResponseType.Dialog" + "description": "A response to an event related to a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs). Must be accompanied by `ResponseType.Dialog`." }, "type": { "description": "The type of bot response.", @@ -675,14 +675,16 @@ "NEW_MESSAGE", "UPDATE_MESSAGE", "UPDATE_USER_MESSAGE_CARDS", - "REQUEST_CONFIG" + "REQUEST_CONFIG", + "DIALOG" ], "enumDescriptions": [ "Default type; will be handled as NEW_MESSAGE.", "Post as a new message in the topic.", "Update the bot's message. This is only permitted on a CARD_CLICKED event where the message sender type is BOT.", "Update the cards on a user's message. This is only permitted as a response to a MESSAGE event with a matched url, or a CARD_CLICKED event where the message sender type is HUMAN. Text will be ignored.", - "Privately ask the user for additional auth or config." + "Privately ask the user for additional auth or config.", + "Presents a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs)." ], "type": "string" }, @@ -694,7 +696,7 @@ "type": "object" }, "ActionStatus": { - "description": "ActionStatus represents status of a request from the bot developer's side. In specific, for each request a bot gets, the bot developer will set both fields below in relation to what the response status and message related to status should be.", + "description": "Represents the status of a request.", "id": "ActionStatus", "properties": { "statusCode": { @@ -740,7 +742,7 @@ "type": "string" }, "userFacingMessage": { - "description": "This message will be the corresponding string to the above status_code. If unset, an appropriate generic message based on the status_code will be shown to the user. If this field is set then the message will be surfaced to the user for both successes and errors.", + "description": "The message to send users about the status of their request. If unset, a generic message based on the `status_code` is sent.", "type": "string" } }, @@ -964,18 +966,18 @@ "type": "object" }, "CommonEventObject": { - "description": "Next available ID = 8", + "description": "Represents information about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes data submitted by users interacting with cards, like data entered in [dialogs](https://developers.google.com/chat/how-tos/bot-dialogs).", "id": "CommonEventObject", "properties": { "formInputs": { "additionalProperties": { "$ref": "Inputs" }, - "description": "The keys are the string IDs associated with the widget and the values are inputs with a widget in the card.", + "description": "A map containing the current values of the widgets in a card. The map keys are the string IDs assigned to each widget, and the values represent inputs to the widget. Depending on the input data type, a different object represents each input: For single-value widgets, `StringInput`. For multi-value widgets, an array of `StringInput` objects. For a date-time picker, a `DateTimeInput`. For a date-only picker, a `DateInput`. For a time-only picker, a `TimeInput`. Corresponds with the data entered by a user on a card in a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs).", "type": "object" }, "hostApp": { - "description": "The hostApp enum which indicates the app the add-on is invoked from", + "description": "The hostApp enum which indicates the app the add-on is invoked from. Always `CHAT` for Chat apps.", "enum": [ "UNSPECIFIED_HOST_APP", "GMAIL", @@ -986,37 +988,35 @@ "SHEETS", "SLIDES", "DRAWINGS", - "CHAT", - "ALL_HOST_APPS" + "CHAT" ], "enumDescriptions": [ - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "This is only used for aggregating logs on the server. Clients should never send these values directly." + "Google can't identify a host app.", + "The add-on launches from Gmail.", + "The add-on launches from Google Calendar.", + "The add-on launches from Google Drive.", + "Not used.", + "The add-on launches from Google Docs.", + "The add-on launches from Google Sheets.", + "The add-on launches from Google Slides.", + "The add-on launches from Google Drawings.", + "A Google Chat app. Not used for Google Workspace add-ons." ], "type": "string" }, "invokedFunction": { - "description": "Name of the invoked function associated with the widget. This field is currently only set for chat.", + "description": "Name of the invoked function associated with the widget. Only set for Chat apps.", "type": "string" }, "parameters": { "additionalProperties": { "type": "string" }, - "description": "Any additional parameters.", + "description": "Custom [parameters](/chat/api/reference/rest/v1/cards#ActionParameter) passed to the invoked function. Both keys and values must be strings.", "type": "object" }, "platform": { - "description": "The platform enum which indicates the platform where the add-on is running.", + "description": "The platform enum which indicates the platform where the event originates (`WEB`, `IOS`, or `ANDROID`). Not supported by Chat apps.", "enum": [ "UNKNOWN_PLATFORM", "WEB", @@ -1032,20 +1032,22 @@ "type": "string" }, "timeZone": { - "$ref": "TimeZone" + "$ref": "TimeZone", + "description": "The timezone ID and offset from Coordinated Universal Time (UTC)." }, "userLocale": { - "description": "The full locale.displayName in the format of [ISO 639 language code]-[ISO 3166 country/region code] such as \"en-US\"", + "description": "The full locale.displayName in the format of [ISO 639 language code]-[ISO 3166 country/region code] such as \"en-US\". Not supported by Chat apps.", "type": "string" } }, "type": "object" }, "DateInput": { - "description": "Input Parameter for Date Picker widget.", + "description": "Date input values. Not supported by Chat apps.", "id": "DateInput", "properties": { "msSinceEpoch": { + "description": "Time since epoch time, in milliseconds.", "format": "int64", "type": "string" } @@ -1053,16 +1055,19 @@ "type": "object" }, "DateTimeInput": { - "description": "Input Parameter for Date and Time Picker widget.", + "description": "Date and time input values. Not supported by Chat apps.", "id": "DateTimeInput", "properties": { "hasDate": { + "description": "Whether the `datetime` input includes a calendar date.", "type": "boolean" }, "hasTime": { + "description": "Whether the `datetime` input includes a timestamp.", "type": "boolean" }, "msSinceEpoch": { + "description": "Time since epoch time, in milliseconds.", "format": "int64", "type": "string" } @@ -1079,14 +1084,14 @@ }, "common": { "$ref": "CommonEventObject", - "description": "This will include form information for dialogs such as form inputs, action parameters." + "description": "Represents information about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/chat/how-tos/bot-dialogs), like data entered on a card." }, "configCompleteRedirectUrl": { "description": "The URL the bot should redirect the user to after they have completed an authorization or configuration flow outside of Google Chat. See the [Authorizing access to 3p services guide](/chat/how-tos/auth-3p) for more information.", "type": "string" }, "dialogEventType": { - "description": "The type of dialog event we have received.", + "description": "The type of [dialog](https://developers.google.com/chat/how-tos/bot-dialogs) event received.", "enum": [ "TYPE_UNSPECIFIED", "REQUEST_DIALOG", @@ -1095,9 +1100,9 @@ ], "enumDescriptions": [ "This could be used when the corresponding event is not dialog related. For example an @mention.", - "For any user action that would result in a dialog opening.", - "For card click events from any dialog.", - "For native cancellation button." + "Any user action that opens a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs).", + "A card click event from a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs).", + "The [dialog](https://developers.google.com/chat/how-tos/bot-dialogs) was cancelled." ], "type": "string" }, @@ -1107,7 +1112,7 @@ "type": "string" }, "isDialogEvent": { - "description": "Whether or not this event is related to dialogs request, submit or cancel. This will be set to true when we want a request/submit/cancel event.", + "description": "True when the event is related to [dialogs](https://developers.google.com/chat/how-tos/bot-dialogs).", "type": "boolean" }, "message": { @@ -1157,22 +1162,22 @@ "properties": { "body": { "$ref": "GoogleAppsCardV1Card", - "description": "Body of the dialog, which will be rendered in a modal. NOTE: The following fields within the objects are not supported: google.apps.card.v1.Widget.date_time_picker google.apps.card.v1.DecoratedText.SwitchControl.on_change_action google.apps.card.v1.TextInput.on_change_action google.apps.card.v1.SelectionInput.on_change_action google.apps.card.v1.DateTimePicker.on_change_action Setting the fields above will have no effect on the dialog." + "description": "Body of the dialog, which is rendered in a modal. Google Chat apps do not support the following card entities: `DateTimePicker`, `OnChangeAction`." } }, "type": "object" }, "DialogAction": { - "description": "Contains dialog if present as well as the ActionStatus for the request sent from user.", + "description": "Contains a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs) and request status code.", "id": "DialogAction", "properties": { "actionStatus": { "$ref": "ActionStatus", - "description": "Status for either invoke dialog or submit dialog requests. This will be used to display a status and message to user if needed. For example in case of an error or success." + "description": "Status for a request to either invoke or submit a [dialog](https://developers.google.com/chat/how-tos/bot-dialogs). Displays a status and message to users, if necessary. For example, in case of an error or success." }, "dialog": { "$ref": "Dialog", - "description": "Dialog for the request." + "description": "[Dialog](https://developers.google.com/chat/how-tos/bot-dialogs) for the request." } }, "type": "object" @@ -1240,6 +1245,7 @@ "type": "string" }, "loadIndicator": { + "description": "Specifies the loading indicator that the action displays while making the call to the action.", "enum": [ "SPINNER", "NONE" @@ -1322,7 +1328,7 @@ "description": "If set, the button is filled with a solid background." }, "disabled": { - "description": "If true, the button is displayed in a disabled state and doesn't respond to user actions.", + "description": "If `true`, the button is displayed in a disabled state and doesn't respond to user actions.", "type": "boolean" }, "icon": { @@ -1345,6 +1351,7 @@ "id": "GoogleAppsCardV1ButtonList", "properties": { "buttons": { + "description": "An array of buttons.", "items": { "$ref": "GoogleAppsCardV1Button" }, @@ -1358,21 +1365,21 @@ "id": "GoogleAppsCardV1Card", "properties": { "cardActions": { - "description": "The actions of this card. They are added to a card's generated toolbar menu. For example, the following JSON constructs a card action menu with Settings and Send Feedback options: ``` \"card_actions\": [ { \"actionLabel\": \"Setting\", \"onClick\": { \"action\": { \"functionName\": \"goToView\", \"parameters\": [ { \"key\": \"viewType\", \"value\": \"SETTING\" } ], \"loadIndicator\": \"LoadIndicator.SPINNER\" } } }, { \"actionLabel\": \"Send Feedback\", \"onClick\": { \"openLink\": { \"url\": \"https://example.com/feedback\" } } } ] ```", + "description": "The card's actions. Actions are added to the card's generated toolbar menu. For example, the following JSON constructs a card action menu with Settings and Send Feedback options: ``` \"card_actions\": [ { \"actionLabel\": \"Settings\", \"onClick\": { \"action\": { \"functionName\": \"goToView\", \"parameters\": [ { \"key\": \"viewType\", \"value\": \"SETTING\" } ], \"loadIndicator\": \"LoadIndicator.SPINNER\" } } }, { \"actionLabel\": \"Send Feedback\", \"onClick\": { \"openLink\": { \"url\": \"https://example.com/feedback\" } } } ] ```", "items": { "$ref": "GoogleAppsCardV1CardAction" }, "type": "array" }, "displayStyle": { - "description": "The display style for peekCardHeader.", + "description": "The display style for `peekCardHeader`.", "enum": [ "DISPLAY_STYLE_UNSPECIFIED", "PEEK", "REPLACE" ], "enumDescriptions": [ - "", + "Default value. Do not use.", "The header of the card appears at the bottom of the sidebar, partially covering the current top card of the stack. Clicking the header pops the card into the card stack. If the card has no header, a generated header is used instead.", "The card is shown by replacing the view of the top card in the card stack." ], @@ -1387,7 +1394,7 @@ "description": "The header of the card. A header usually contains a title and an image." }, "name": { - "description": "Name of the card, which is used as a identifier for the card in card navigation.", + "description": "Name of the card. Used as a card identifier in card navigation.", "type": "string" }, "peekCardHeader": { @@ -1414,7 +1421,7 @@ }, "onClick": { "$ref": "GoogleAppsCardV1OnClick", - "description": "The onclick action for this action item." + "description": "The `onClick` action for this action item." } }, "type": "object" @@ -1435,6 +1442,7 @@ "type": "object" }, "GoogleAppsCardV1CardHeader": { + "description": "Represents a card header.", "id": "GoogleAppsCardV1CardHeader", "properties": { "imageAltText": { @@ -1462,14 +1470,14 @@ "type": "string" }, "title": { - "description": "The title of the card header. The title must be specified. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.", + "description": "Required. The title of the card header. The header has a fixed height: if both a title and subtitle are specified, each takes up one line. If only the title is specified, it takes up both lines.", "type": "string" } }, "type": "object" }, "GoogleAppsCardV1DateTimePicker": { - "description": "The widget that lets users to specify a date and time.", + "description": "The widget that lets users to specify a date and time. Not supported by Google Chat apps.", "id": "GoogleAppsCardV1DateTimePicker", "properties": { "label": { @@ -1477,7 +1485,7 @@ "type": "string" }, "name": { - "description": "The name of the text input that's used in formInput, and uniquely identifies this input.", + "description": "The name of the text input that's used in `formInput`, and uniquely identifies this input.", "type": "string" }, "onChangeAction": { @@ -1672,14 +1680,14 @@ "type": "string" }, "knownIcon": { - "description": "The icon specified by the string name of a list of known icons", + "description": "The icon specified by the string name of a list of known icons.", "type": "string" } }, "type": "object" }, "GoogleAppsCardV1Image": { - "description": "An image that is specified by a URL and can have an onClick action.", + "description": "An image that is specified by a URL and can have an `onClick` action.", "id": "GoogleAppsCardV1Image", "properties": { "altText": { @@ -1691,12 +1699,14 @@ "type": "string" }, "onClick": { - "$ref": "GoogleAppsCardV1OnClick" + "$ref": "GoogleAppsCardV1OnClick", + "description": "The action triggered by an `onClick` event." } }, "type": "object" }, "GoogleAppsCardV1ImageComponent": { + "description": "Represents an image.", "id": "GoogleAppsCardV1ImageComponent", "properties": { "altText": { @@ -1749,11 +1759,12 @@ "type": "object" }, "GoogleAppsCardV1OnClick": { + "description": "Represents the response to an `onClick` event.", "id": "GoogleAppsCardV1OnClick", "properties": { "action": { "$ref": "GoogleAppsCardV1Action", - "description": "If specified, an action is triggered by this onClick." + "description": "If specified, an action is triggered by this `onClick`." }, "card": { "$ref": "GoogleAppsCardV1Card", @@ -1761,30 +1772,33 @@ }, "openDynamicLinkAction": { "$ref": "GoogleAppsCardV1Action", - "description": "An add-on triggers this action when the action needs to open a link. This differs from the open_link above in that this needs to talk to server to get the link. Thus some preparation work is required for web client to do before the open link action response comes back." + "description": "An add-on triggers this action when the action needs to open a link. This differs from the `open_link` above in that this needs to talk to server to get the link. Thus some preparation work is required for web client to do before the open link action response comes back." }, "openLink": { "$ref": "GoogleAppsCardV1OpenLink", - "description": "If specified, this onClick triggers an open link action." + "description": "If specified, this `onClick` triggers an open link action." } }, "type": "object" }, "GoogleAppsCardV1OpenLink": { + "description": "Represents an `onClick` event that opens a hyperlink.", "id": "GoogleAppsCardV1OpenLink", "properties": { "onClose": { + "description": "Whether the client forgets about a link after opening it, or observes it until the window closes. Not supported by Chat apps.", "enum": [ "NOTHING", "RELOAD" ], "enumDescriptions": [ - "Doesn’t reload the card after the child window closes. Reloads the card after the child window closes. If used in conjunction with [OpenAs.OVERLAY](/workspace/add-ons/reference/rpc/google.apps.card.v1#openas), the child window acts as a modal dialog and the main card is blocked until the child window closes.", - "" + "Doesn’t reload the card after the child window closes.", + "Reloads the card after the child window closes. If used in conjunction with [OpenAs.OVERLAY](/workspace/add-ons/reference/rpc/google.apps.card.v1#openas), the child window acts as a modal dialog and the main card is blocked until the child window closes." ], "type": "string" }, "openAs": { + "description": "How to open a link. Not supported by Chat apps.", "enum": [ "FULL_SIZE", "OVERLAY" @@ -1815,7 +1829,7 @@ "type": "string" }, "uncollapsibleWidgetsCount": { - "description": "The number of uncollapsible widgets. For example, when a section contains five widgets and the `numUncollapsibleWidget` is set to `2`, the first two widgets are always shown and the last three are collapsed as default. The `numUncollapsibleWidget` is taken into account only when collapsible is set to `true`.", + "description": "The number of uncollapsible widgets. For example, when a section contains five widgets and the `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are always shown and the last three are collapsed as default. The `uncollapsibleWidgetsCount` is taken into account only when `collapsible` is `true`.", "format": "int32", "type": "integer" }, @@ -1830,10 +1844,11 @@ "type": "object" }, "GoogleAppsCardV1SelectionInput": { - "description": "A widget that creates a UI item (for example, a drop-down list) with options for users to select.", + "description": "A widget that creates a UI item with options for users to select. For example, a dropdown menu.", "id": "GoogleAppsCardV1SelectionInput", "properties": { "items": { + "description": "An array of the selected items.", "items": { "$ref": "GoogleAppsCardV1SelectionItem" }, @@ -1844,7 +1859,7 @@ "type": "string" }, "name": { - "description": "The name of the text input which is used in formInput.", + "description": "The name of the text input which is used in `formInput`.", "type": "string" }, "onChangeAction": { @@ -1852,6 +1867,7 @@ "description": "If specified, the form is submitted when the selection changes. If not specified, you must specify a separate button." }, "type": { + "description": "The type of the selection.", "enum": [ "CHECK_BOX", "RADIO_BUTTON", @@ -1859,10 +1875,10 @@ "DROPDOWN" ], "enumDescriptions": [ - "The selection type is a checkbox.", - "The selection type is a radio button.", - "The selection type is a switch.", - "The selection type is a dropdown." + "A checkbox.", + "A radio button.", + "A switch.", + "A dropdown menu." ], "type": "string" } @@ -1870,7 +1886,7 @@ "type": "object" }, "GoogleAppsCardV1SelectionItem": { - "description": "The item in the switch control. A radio button, at most one of the items is selected.", + "description": "A selectable item in the switch control.", "id": "GoogleAppsCardV1SelectionItem", "properties": { "selected": { @@ -1889,10 +1905,11 @@ "type": "object" }, "GoogleAppsCardV1SuggestionItem": { - "description": "A suggestion item. Only supports text for now.", + "description": "A suggestion item.", "id": "GoogleAppsCardV1SuggestionItem", "properties": { "text": { + "description": "The suggested autocomplete result.", "type": "string" } }, @@ -1903,7 +1920,7 @@ "id": "GoogleAppsCardV1Suggestions", "properties": { "items": { - "description": "A list of suggestions items which will be used in are used in autocomplete.", + "description": "A list of suggestions used for autocomplete recommendations.", "items": { "$ref": "GoogleAppsCardV1SuggestionItem" }, @@ -1913,6 +1930,7 @@ "type": "object" }, "GoogleAppsCardV1SwitchControl": { + "description": "Either a toggle-style switch or a checkbox.", "id": "GoogleAppsCardV1SwitchControl", "properties": { "controlType": { @@ -1923,14 +1941,14 @@ "CHECK_BOX" ], "enumDescriptions": [ - "", + "A toggle-style switch.", "Deprecated in favor of `CHECK_BOX`.", - "" + "A checkbox." ], "type": "string" }, "name": { - "description": "The name of the switch widget that's used in formInput.", + "description": "The name of the switch widget that's used in `formInput`.", "type": "string" }, "onChangeAction": { @@ -1969,7 +1987,7 @@ "type": "string" }, "name": { - "description": "The name of the text input which is used in formInput.", + "description": "The name of the text input which is used in `formInput`.", "type": "string" }, "onChangeAction": { @@ -2175,20 +2193,24 @@ "type": "object" }, "Inputs": { - "description": "The inputs with widgets.", + "description": "Types of data inputs for widgets. Users enter data with these inputs.", "id": "Inputs", "properties": { "dateInput": { - "$ref": "DateInput" + "$ref": "DateInput", + "description": "Date input values. Not supported by Chat apps." }, "dateTimeInput": { - "$ref": "DateTimeInput" + "$ref": "DateTimeInput", + "description": "Date and time input values. Not supported by Chat apps." }, "stringInputs": { - "$ref": "StringInputs" + "$ref": "StringInputs", + "description": "Input parameter for regular widgets. For single-valued widgets, it is a single value list. For multi-valued widgets, such as checkbox, all the values are presented." }, "timeInput": { - "$ref": "TimeInput" + "$ref": "TimeInput", + "description": "Time input values. Not supported by Chat apps." } }, "type": "object" @@ -2520,7 +2542,7 @@ "type": "object" }, "SlashCommand": { - "description": "A Slash Command in Chat.", + "description": "A [slash command](https://developers.google.com/chat/how-tos/slash-commands) in Google Chat.", "id": "SlashCommand", "properties": { "commandId": { @@ -2636,10 +2658,11 @@ "type": "object" }, "StringInputs": { - "description": "Input parameter for regular widgets. For single-valued widgets, it will be a single value list; for multi-valued widgets, such as checkbox, all the values are presented.", + "description": "Input parameter for regular widgets. For single-valued widgets, it is a single value list. For multi-valued widgets, such as checkbox, all the values are presented.", "id": "StringInputs", "properties": { "value": { + "description": "An array of strings entered by the user.", "items": { "type": "string" }, @@ -2685,14 +2708,16 @@ "type": "object" }, "TimeInput": { - "description": "Input Parameter for Time Picker widget.", + "description": "Time input values. Not supported by Chat apps.", "id": "TimeInput", "properties": { "hours": { + "description": "The hour on a 24-hour clock.", "format": "int32", "type": "integer" }, "minutes": { + "description": "The number of minutes past the hour. Valid values are 0 to 59.", "format": "int32", "type": "integer" } @@ -2700,13 +2725,15 @@ "type": "object" }, "TimeZone": { - "description": "The timezone id and offset. The id is the tz database time zones such as \"America/Toronto\". The user timezone offset, in milliseconds, from Coordinated Universal Time (UTC).", + "description": "The timezone ID and offset from Coordinated Universal Time (UTC). Not supported by Chat apps.", "id": "TimeZone", "properties": { "id": { + "description": "The [IANA TZ](https://www.iana.org/time-zones) time zone database code, such as \"America/Toronto\".", "type": "string" }, "offset": { + "description": "The user timezone offset, in milliseconds, from Coordinated Universal Time (UTC).", "format": "int32", "type": "integer" } @@ -2730,7 +2757,7 @@ "type": "boolean" }, "name": { - "description": "Resource name for a Google Chat user. Formatted as `users/AAAAAAAAAAA`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API.", + "description": "Resource name for a Google Chat user. Formatted as `users/{user}`. Represents a [person](https://developers.google.com/people/api/rest/v1/people#Person) in the People API.", "type": "string" }, "type": { diff --git a/chat/v1/chat-gen.go b/chat/v1/chat-gen.go index f5e5f20a009..c589dedaadb 100644 --- a/chat/v1/chat-gen.go +++ b/chat/v1/chat-gen.go @@ -268,8 +268,9 @@ func (s *ActionParameter) MarshalJSON() ([]byte, error) { // ActionResponse: Parameters that a bot can use to configure how it's // response is posted. type ActionResponse struct { - // DialogAction: This response is for Dialog related events and must be - // accompanied by ResponseType.Dialog + // DialogAction: A response to an event related to a dialog + // (https://developers.google.com/chat/how-tos/bot-dialogs). Must be + // accompanied by `ResponseType.Dialog`. DialogAction *DialogAction `json:"dialogAction,omitempty"` // Type: The type of bot response. @@ -285,6 +286,8 @@ type ActionResponse struct { // HUMAN. Text will be ignored. // "REQUEST_CONFIG" - Privately ask the user for additional auth or // config. + // "DIALOG" - Presents a + // [dialog](https://developers.google.com/chat/how-tos/bot-dialogs). Type string `json:"type,omitempty"` // Url: URL for users to auth or config. (Only for REQUEST_CONFIG @@ -314,10 +317,7 @@ func (s *ActionResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// ActionStatus: ActionStatus represents status of a request from the -// bot developer's side. In specific, for each request a bot gets, the -// bot developer will set both fields below in relation to what the -// response status and message related to status should be. +// ActionStatus: Represents the status of a request. type ActionStatus struct { // StatusCode: The status code. // @@ -411,11 +411,9 @@ type ActionStatus struct { // 500 Internal Server Error StatusCode string `json:"statusCode,omitempty"` - // UserFacingMessage: This message will be the corresponding string to - // the above status_code. If unset, an appropriate generic message based - // on the status_code will be shown to the user. If this field is set - // then the message will be surfaced to the user for both successes and - // errors. + // UserFacingMessage: The message to send users about the status of + // their request. If unset, a generic message based on the `status_code` + // is sent. UserFacingMessage string `json:"userFacingMessage,omitempty"` // ForceSendFields is a list of field names (e.g. "StatusCode") to @@ -858,39 +856,51 @@ func (s *Color) UnmarshalJSON(data []byte) error { return nil } -// CommonEventObject: Next available ID = 8 +// CommonEventObject: Represents information about the user's client, +// such as locale, host app, and platform. For Chat apps, +// `CommonEventObject` includes data submitted by users interacting with +// cards, like data entered in dialogs +// (https://developers.google.com/chat/how-tos/bot-dialogs). type CommonEventObject struct { - // FormInputs: The keys are the string IDs associated with the widget - // and the values are inputs with a widget in the card. + // FormInputs: A map containing the current values of the widgets in a + // card. The map keys are the string IDs assigned to each widget, and + // the values represent inputs to the widget. Depending on the input + // data type, a different object represents each input: For single-value + // widgets, `StringInput`. For multi-value widgets, an array of + // `StringInput` objects. For a date-time picker, a `DateTimeInput`. For + // a date-only picker, a `DateInput`. For a time-only picker, a + // `TimeInput`. Corresponds with the data entered by a user on a card in + // a dialog (https://developers.google.com/chat/how-tos/bot-dialogs). FormInputs map[string]Inputs `json:"formInputs,omitempty"` // HostApp: The hostApp enum which indicates the app the add-on is - // invoked from + // invoked from. Always `CHAT` for Chat apps. // // Possible values: - // "UNSPECIFIED_HOST_APP" - // "GMAIL" - // "CALENDAR" - // "DRIVE" - // "DEMO" - // "DOCS" - // "SHEETS" - // "SLIDES" - // "DRAWINGS" - // "CHAT" - // "ALL_HOST_APPS" - This is only used for aggregating logs on the - // server. Clients should never send these values directly. + // "UNSPECIFIED_HOST_APP" - Google can't identify a host app. + // "GMAIL" - The add-on launches from Gmail. + // "CALENDAR" - The add-on launches from Google Calendar. + // "DRIVE" - The add-on launches from Google Drive. + // "DEMO" - Not used. + // "DOCS" - The add-on launches from Google Docs. + // "SHEETS" - The add-on launches from Google Sheets. + // "SLIDES" - The add-on launches from Google Slides. + // "DRAWINGS" - The add-on launches from Google Drawings. + // "CHAT" - A Google Chat app. Not used for Google Workspace add-ons. HostApp string `json:"hostApp,omitempty"` // InvokedFunction: Name of the invoked function associated with the - // widget. This field is currently only set for chat. + // widget. Only set for Chat apps. InvokedFunction string `json:"invokedFunction,omitempty"` - // Parameters: Any additional parameters. + // Parameters: Custom parameters + // (/chat/api/reference/rest/v1/cards#ActionParameter) passed to the + // invoked function. Both keys and values must be strings. Parameters map[string]string `json:"parameters,omitempty"` // Platform: The platform enum which indicates the platform where the - // add-on is running. + // event originates (`WEB`, `IOS`, or `ANDROID`). Not supported by Chat + // apps. // // Possible values: // "UNKNOWN_PLATFORM" @@ -899,10 +909,13 @@ type CommonEventObject struct { // "ANDROID" Platform string `json:"platform,omitempty"` + // TimeZone: The timezone ID and offset from Coordinated Universal Time + // (UTC). TimeZone *TimeZone `json:"timeZone,omitempty"` // UserLocale: The full locale.displayName in the format of [ISO 639 - // language code]-[ISO 3166 country/region code] such as "en-US" + // language code]-[ISO 3166 country/region code] such as "en-US". Not + // supported by Chat apps. UserLocale string `json:"userLocale,omitempty"` // ForceSendFields is a list of field names (e.g. "FormInputs") to @@ -928,8 +941,9 @@ func (s *CommonEventObject) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// DateInput: Input Parameter for Date Picker widget. +// DateInput: Date input values. Not supported by Chat apps. type DateInput struct { + // MsSinceEpoch: Time since epoch time, in milliseconds. MsSinceEpoch int64 `json:"msSinceEpoch,omitempty,string"` // ForceSendFields is a list of field names (e.g. "MsSinceEpoch") to @@ -955,12 +969,16 @@ func (s *DateInput) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// DateTimeInput: Input Parameter for Date and Time Picker widget. +// DateTimeInput: Date and time input values. Not supported by Chat +// apps. type DateTimeInput struct { + // HasDate: Whether the `datetime` input includes a calendar date. HasDate bool `json:"hasDate,omitempty"` + // HasTime: Whether the `datetime` input includes a timestamp. HasTime bool `json:"hasTime,omitempty"` + // MsSinceEpoch: Time since epoch time, in milliseconds. MsSinceEpoch int64 `json:"msSinceEpoch,omitempty,string"` // ForceSendFields is a list of field names (e.g. "HasDate") to @@ -994,8 +1012,11 @@ type DeprecatedEvent struct { // information. Action *FormAction `json:"action,omitempty"` - // Common: This will include form information for dialogs such as form - // inputs, action parameters. + // Common: Represents information about the user's client, such as + // locale, host app, and platform. For Chat apps, `CommonEventObject` + // includes information submitted by users interacting with dialogs + // (https://developers.google.com/chat/how-tos/bot-dialogs), like data + // entered on a card. Common *CommonEventObject `json:"common,omitempty"` // ConfigCompleteRedirectUrl: The URL the bot should redirect the user @@ -1004,23 +1025,27 @@ type DeprecatedEvent struct { // guide (/chat/how-tos/auth-3p) for more information. ConfigCompleteRedirectUrl string `json:"configCompleteRedirectUrl,omitempty"` - // DialogEventType: The type of dialog event we have received. + // DialogEventType: The type of dialog + // (https://developers.google.com/chat/how-tos/bot-dialogs) event + // received. // // Possible values: // "TYPE_UNSPECIFIED" - This could be used when the corresponding // event is not dialog related. For example an @mention. - // "REQUEST_DIALOG" - For any user action that would result in a - // dialog opening. - // "SUBMIT_DIALOG" - For card click events from any dialog. - // "CANCEL_DIALOG" - For native cancellation button. + // "REQUEST_DIALOG" - Any user action that opens a + // [dialog](https://developers.google.com/chat/how-tos/bot-dialogs). + // "SUBMIT_DIALOG" - A card click event from a + // [dialog](https://developers.google.com/chat/how-tos/bot-dialogs). + // "CANCEL_DIALOG" - The + // [dialog](https://developers.google.com/chat/how-tos/bot-dialogs) was + // cancelled. DialogEventType string `json:"dialogEventType,omitempty"` // EventTime: The timestamp indicating when the event occurred. EventTime string `json:"eventTime,omitempty"` - // IsDialogEvent: Whether or not this event is related to dialogs - // request, submit or cancel. This will be set to true when we want a - // request/submit/cancel event. + // IsDialogEvent: True when the event is related to dialogs + // (https://developers.google.com/chat/how-tos/bot-dialogs). IsDialogEvent bool `json:"isDialogEvent,omitempty"` // Message: The message that triggered the event, if applicable. @@ -1079,14 +1104,9 @@ func (s *DeprecatedEvent) MarshalJSON() ([]byte, error) { // Dialog: Wrapper around the card body of the dialog. type Dialog struct { - // Body: Body of the dialog, which will be rendered in a modal. NOTE: - // The following fields within the objects are not supported: - // google.apps.card.v1.Widget.date_time_picker - // google.apps.card.v1.DecoratedText.SwitchControl.on_change_action - // google.apps.card.v1.TextInput.on_change_action - // google.apps.card.v1.SelectionInput.on_change_action - // google.apps.card.v1.DateTimePicker.on_change_action Setting the - // fields above will have no effect on the dialog. + // Body: Body of the dialog, which is rendered in a modal. Google Chat + // apps do not support the following card entities: `DateTimePicker`, + // `OnChangeAction`. Body *GoogleAppsCardV1Card `json:"body,omitempty"` // ForceSendFields is a list of field names (e.g. "Body") to @@ -1112,15 +1132,19 @@ func (s *Dialog) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// DialogAction: Contains dialog if present as well as the ActionStatus -// for the request sent from user. +// DialogAction: Contains a dialog +// (https://developers.google.com/chat/how-tos/bot-dialogs) and request +// status code. type DialogAction struct { - // ActionStatus: Status for either invoke dialog or submit dialog - // requests. This will be used to display a status and message to user - // if needed. For example in case of an error or success. + // ActionStatus: Status for a request to either invoke or submit a + // dialog (https://developers.google.com/chat/how-tos/bot-dialogs). + // Displays a status and message to users, if necessary. For example, in + // case of an error or success. ActionStatus *ActionStatus `json:"actionStatus,omitempty"` - // Dialog: Dialog for the request. + // Dialog: Dialog + // (https://developers.google.com/chat/how-tos/bot-dialogs) for the + // request. Dialog *Dialog `json:"dialog,omitempty"` // ForceSendFields is a list of field names (e.g. "ActionStatus") to @@ -1270,6 +1294,9 @@ type GoogleAppsCardV1Action struct { // is clicked/activated. Function string `json:"function,omitempty"` + // LoadIndicator: Specifies the loading indicator that the action + // displays while making the call to the action. + // // Possible values: // "SPINNER" - Displays a spinner to indicate that content is loading. // "NONE" - Nothing is displayed. @@ -1401,7 +1428,7 @@ type GoogleAppsCardV1Button struct { // Color: If set, the button is filled with a solid background. Color *Color `json:"color,omitempty"` - // Disabled: If true, the button is displayed in a disabled state and + // Disabled: If `true`, the button is displayed in a disabled state and // doesn't respond to user actions. Disabled bool `json:"disabled,omitempty"` @@ -1439,6 +1466,7 @@ func (s *GoogleAppsCardV1Button) MarshalJSON() ([]byte, error) { // GoogleAppsCardV1ButtonList: A list of buttons layed out horizontally. type GoogleAppsCardV1ButtonList struct { + // Buttons: An array of buttons. Buttons []*GoogleAppsCardV1Button `json:"buttons,omitempty"` // ForceSendFields is a list of field names (e.g. "Buttons") to @@ -1487,20 +1515,20 @@ func (s *GoogleAppsCardV1ButtonList) MarshalJSON() ([]byte, error) { // "openLink": { "url": "https://example.com/feedback" } } } ], "name": // "contact-card-K3wB6arF2H9L" } ``` type GoogleAppsCardV1Card struct { - // CardActions: The actions of this card. They are added to a card's + // CardActions: The card's actions. Actions are added to the card's // generated toolbar menu. For example, the following JSON constructs a // card action menu with Settings and Send Feedback options: ``` - // "card_actions": [ { "actionLabel": "Setting", "onClick": { "action": + // "card_actions": [ { "actionLabel": "Settings", "onClick": { "action": // { "functionName": "goToView", "parameters": [ { "key": "viewType", // "value": "SETTING" } ], "loadIndicator": "LoadIndicator.SPINNER" } } // }, { "actionLabel": "Send Feedback", "onClick": { "openLink": { // "url": "https://example.com/feedback" } } } ] ``` CardActions []*GoogleAppsCardV1CardAction `json:"cardActions,omitempty"` - // DisplayStyle: The display style for peekCardHeader. + // DisplayStyle: The display style for `peekCardHeader`. // // Possible values: - // "DISPLAY_STYLE_UNSPECIFIED" + // "DISPLAY_STYLE_UNSPECIFIED" - Default value. Do not use. // "PEEK" - The header of the card appears at the bottom of the // sidebar, partially covering the current top card of the stack. // Clicking the header pops the card into the card stack. If the card @@ -1516,8 +1544,7 @@ type GoogleAppsCardV1Card struct { // an image. Header *GoogleAppsCardV1CardHeader `json:"header,omitempty"` - // Name: Name of the card, which is used as a identifier for the card in - // card navigation. + // Name: Name of the card. Used as a card identifier in card navigation. Name string `json:"name,omitempty"` // PeekCardHeader: When displaying contextual content, the peek card @@ -1559,7 +1586,7 @@ type GoogleAppsCardV1CardAction struct { // ActionLabel: The label that displays as the action menu item. ActionLabel string `json:"actionLabel,omitempty"` - // OnClick: The onclick action for this action item. + // OnClick: The `onClick` action for this action item. OnClick *GoogleAppsCardV1OnClick `json:"onClick,omitempty"` // ForceSendFields is a list of field names (e.g. "ActionLabel") to @@ -1620,6 +1647,7 @@ func (s *GoogleAppsCardV1CardFixedFooter) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleAppsCardV1CardHeader: Represents a card header. type GoogleAppsCardV1CardHeader struct { // ImageAltText: The alternative text of this image which is used for // accessibility. @@ -1638,10 +1666,9 @@ type GoogleAppsCardV1CardHeader struct { // Subtitle: The subtitle of the card header. Subtitle string `json:"subtitle,omitempty"` - // Title: The title of the card header. The title must be specified. The - // header has a fixed height: if both a title and subtitle are - // specified, each takes up one line. If only the title is specified, it - // takes up both lines. + // Title: Required. The title of the card header. The header has a fixed + // height: if both a title and subtitle are specified, each takes up one + // line. If only the title is specified, it takes up both lines. Title string `json:"title,omitempty"` // ForceSendFields is a list of field names (e.g. "ImageAltText") to @@ -1668,12 +1695,12 @@ func (s *GoogleAppsCardV1CardHeader) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1DateTimePicker: The widget that lets users to specify -// a date and time. +// a date and time. Not supported by Google Chat apps. type GoogleAppsCardV1DateTimePicker struct { // Label: The label for the field that displays to the user. Label string `json:"label,omitempty"` - // Name: The name of the text input that's used in formInput, and + // Name: The name of the text input that's used in `formInput`, and // uniquely identifies this input. Name string `json:"name,omitempty"` @@ -1914,7 +1941,7 @@ type GoogleAppsCardV1Icon struct { ImageType string `json:"imageType,omitempty"` // KnownIcon: The icon specified by the string name of a list of known - // icons + // icons. KnownIcon string `json:"knownIcon,omitempty"` // ForceSendFields is a list of field names (e.g. "AltText") to @@ -1941,7 +1968,7 @@ func (s *GoogleAppsCardV1Icon) MarshalJSON() ([]byte, error) { } // GoogleAppsCardV1Image: An image that is specified by a URL and can -// have an onClick action. +// have an `onClick` action. type GoogleAppsCardV1Image struct { // AltText: The alternative text of this image, used for accessibility. AltText string `json:"altText,omitempty"` @@ -1949,6 +1976,7 @@ type GoogleAppsCardV1Image struct { // ImageUrl: An image URL. ImageUrl string `json:"imageUrl,omitempty"` + // OnClick: The action triggered by an `onClick` event. OnClick *GoogleAppsCardV1OnClick `json:"onClick,omitempty"` // ForceSendFields is a list of field names (e.g. "AltText") to @@ -1974,6 +2002,7 @@ func (s *GoogleAppsCardV1Image) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleAppsCardV1ImageComponent: Represents an image. type GoogleAppsCardV1ImageComponent struct { // AltText: The accessibility label for the image. AltText string `json:"altText,omitempty"` @@ -2066,8 +2095,10 @@ func (s *GoogleAppsCardV1ImageCropStyle) UnmarshalJSON(data []byte) error { return nil } +// GoogleAppsCardV1OnClick: Represents the response to an `onClick` +// event. type GoogleAppsCardV1OnClick struct { - // Action: If specified, an action is triggered by this onClick. + // Action: If specified, an action is triggered by this `onClick`. Action *GoogleAppsCardV1Action `json:"action,omitempty"` // Card: A new card is pushed to the card stack after clicking if @@ -2075,13 +2106,13 @@ type GoogleAppsCardV1OnClick struct { Card *GoogleAppsCardV1Card `json:"card,omitempty"` // OpenDynamicLinkAction: An add-on triggers this action when the action - // needs to open a link. This differs from the open_link above in that + // needs to open a link. This differs from the `open_link` above in that // this needs to talk to server to get the link. Thus some preparation // work is required for web client to do before the open link action // response comes back. OpenDynamicLinkAction *GoogleAppsCardV1Action `json:"openDynamicLinkAction,omitempty"` - // OpenLink: If specified, this onClick triggers an open link action. + // OpenLink: If specified, this `onClick` triggers an open link action. OpenLink *GoogleAppsCardV1OpenLink `json:"openLink,omitempty"` // ForceSendFields is a list of field names (e.g. "Action") to @@ -2107,17 +2138,24 @@ func (s *GoogleAppsCardV1OnClick) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleAppsCardV1OpenLink: Represents an `onClick` event that opens a +// hyperlink. type GoogleAppsCardV1OpenLink struct { + // OnClose: Whether the client forgets about a link after opening it, or + // observes it until the window closes. Not supported by Chat apps. + // // Possible values: // "NOTHING" - Doesn’t reload the card after the child window - // closes. Reloads the card after the child window closes. If used in - // conjunction with + // closes. + // "RELOAD" - Reloads the card after the child window closes. If used + // in conjunction with // [OpenAs.OVERLAY](/workspace/add-ons/reference/rpc/google.apps.card.v1# // openas), the child window acts as a modal dialog and the main card is // blocked until the child window closes. - // "RELOAD" OnClose string `json:"onClose,omitempty"` + // OpenAs: How to open a link. Not supported by Chat apps. + // // Possible values: // "FULL_SIZE" - The link opens as a full size window (if that's the // frame used by the client. @@ -2164,10 +2202,10 @@ type GoogleAppsCardV1Section struct { // UncollapsibleWidgetsCount: The number of uncollapsible widgets. For // example, when a section contains five widgets and the - // `numUncollapsibleWidget` is set to `2`, the first two widgets are + // `uncollapsibleWidgetsCount` is set to `2`, the first two widgets are // always shown and the last three are collapsed as default. The - // `numUncollapsibleWidget` is taken into account only when collapsible - // is set to `true`. + // `uncollapsibleWidgetsCount` is taken into account only when + // `collapsible` is `true`. UncollapsibleWidgetsCount int64 `json:"uncollapsibleWidgetsCount,omitempty"` // Widgets: A section must contain at least 1 widget. @@ -2196,15 +2234,16 @@ func (s *GoogleAppsCardV1Section) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleAppsCardV1SelectionInput: A widget that creates a UI item (for -// example, a drop-down list) with options for users to select. +// GoogleAppsCardV1SelectionInput: A widget that creates a UI item with +// options for users to select. For example, a dropdown menu. type GoogleAppsCardV1SelectionInput struct { + // Items: An array of the selected items. Items []*GoogleAppsCardV1SelectionItem `json:"items,omitempty"` // Label: The label displayed ahead of the switch control. Label string `json:"label,omitempty"` - // Name: The name of the text input which is used in formInput. + // Name: The name of the text input which is used in `formInput`. Name string `json:"name,omitempty"` // OnChangeAction: If specified, the form is submitted when the @@ -2212,11 +2251,13 @@ type GoogleAppsCardV1SelectionInput struct { // button. OnChangeAction *GoogleAppsCardV1Action `json:"onChangeAction,omitempty"` + // Type: The type of the selection. + // // Possible values: - // "CHECK_BOX" - The selection type is a checkbox. - // "RADIO_BUTTON" - The selection type is a radio button. - // "SWITCH" - The selection type is a switch. - // "DROPDOWN" - The selection type is a dropdown. + // "CHECK_BOX" - A checkbox. + // "RADIO_BUTTON" - A radio button. + // "SWITCH" - A switch. + // "DROPDOWN" - A dropdown menu. Type string `json:"type,omitempty"` // ForceSendFields is a list of field names (e.g. "Items") to @@ -2242,8 +2283,8 @@ func (s *GoogleAppsCardV1SelectionInput) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleAppsCardV1SelectionItem: The item in the switch control. A -// radio button, at most one of the items is selected. +// GoogleAppsCardV1SelectionItem: A selectable item in the switch +// control. type GoogleAppsCardV1SelectionItem struct { // Selected: If more than one item is selected for `RADIO_BUTTON` and // `DROPDOWN`, the first selected item is treated as selected and the @@ -2280,9 +2321,9 @@ func (s *GoogleAppsCardV1SelectionItem) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// GoogleAppsCardV1SuggestionItem: A suggestion item. Only supports text -// for now. +// GoogleAppsCardV1SuggestionItem: A suggestion item. type GoogleAppsCardV1SuggestionItem struct { + // Text: The suggested autocomplete result. Text string `json:"text,omitempty"` // ForceSendFields is a list of field names (e.g. "Text") to @@ -2311,8 +2352,7 @@ func (s *GoogleAppsCardV1SuggestionItem) MarshalJSON() ([]byte, error) { // GoogleAppsCardV1Suggestions: A container wrapping elements necessary // for showing suggestion items used in text input autocomplete. type GoogleAppsCardV1Suggestions struct { - // Items: A list of suggestions items which will be used in are used in - // autocomplete. + // Items: A list of suggestions used for autocomplete recommendations. Items []*GoogleAppsCardV1SuggestionItem `json:"items,omitempty"` // ForceSendFields is a list of field names (e.g. "Items") to @@ -2338,16 +2378,18 @@ func (s *GoogleAppsCardV1Suggestions) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleAppsCardV1SwitchControl: Either a toggle-style switch or a +// checkbox. type GoogleAppsCardV1SwitchControl struct { // ControlType: The control type, either switch or checkbox. // // Possible values: - // "SWITCH" + // "SWITCH" - A toggle-style switch. // "CHECKBOX" - Deprecated in favor of `CHECK_BOX`. - // "CHECK_BOX" + // "CHECK_BOX" - A checkbox. ControlType string `json:"controlType,omitempty"` - // Name: The name of the switch widget that's used in formInput. + // Name: The name of the switch widget that's used in `formInput`. Name string `json:"name,omitempty"` // OnChangeAction: The action when the switch state is changed. @@ -2402,7 +2444,7 @@ type GoogleAppsCardV1TextInput struct { // Label: At least one of label and hintText must be specified. Label string `json:"label,omitempty"` - // Name: The name of the text input which is used in formInput. + // Name: The name of the text input which is used in `formInput`. Name string `json:"name,omitempty"` // OnChangeAction: The onChange action, for example, invoke a function. @@ -2705,14 +2747,22 @@ func (s *ImageButton) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// Inputs: The inputs with widgets. +// Inputs: Types of data inputs for widgets. Users enter data with these +// inputs. type Inputs struct { + // DateInput: Date input values. Not supported by Chat apps. DateInput *DateInput `json:"dateInput,omitempty"` + // DateTimeInput: Date and time input values. Not supported by Chat + // apps. DateTimeInput *DateTimeInput `json:"dateTimeInput,omitempty"` + // StringInputs: Input parameter for regular widgets. For single-valued + // widgets, it is a single value list. For multi-valued widgets, such as + // checkbox, all the values are presented. StringInputs *StringInputs `json:"stringInputs,omitempty"` + // TimeInput: Time input values. Not supported by Chat apps. TimeInput *TimeInput `json:"timeInput,omitempty"` // ForceSendFields is a list of field names (e.g. "DateInput") to @@ -3196,7 +3246,9 @@ func (s *Section) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// SlashCommand: A Slash Command in Chat. +// SlashCommand: A slash command +// (https://developers.google.com/chat/how-tos/slash-commands) in Google +// Chat. type SlashCommand struct { // CommandId: The id of the slash command invoked. CommandId int64 `json:"commandId,omitempty,string"` @@ -3371,9 +3423,10 @@ func (s *Status) MarshalJSON() ([]byte, error) { } // StringInputs: Input parameter for regular widgets. For single-valued -// widgets, it will be a single value list; for multi-valued widgets, -// such as checkbox, all the values are presented. +// widgets, it is a single value list. For multi-valued widgets, such as +// checkbox, all the values are presented. type StringInputs struct { + // Value: An array of strings entered by the user. Value []string `json:"value,omitempty"` // ForceSendFields is a list of field names (e.g. "Value") to @@ -3486,10 +3539,13 @@ func (s *Thread) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// TimeInput: Input Parameter for Time Picker widget. +// TimeInput: Time input values. Not supported by Chat apps. type TimeInput struct { + // Hours: The hour on a 24-hour clock. Hours int64 `json:"hours,omitempty"` + // Minutes: The number of minutes past the hour. Valid values are 0 to + // 59. Minutes int64 `json:"minutes,omitempty"` // ForceSendFields is a list of field names (e.g. "Hours") to @@ -3515,12 +3571,15 @@ func (s *TimeInput) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// TimeZone: The timezone id and offset. The id is the tz database time -// zones such as "America/Toronto". The user timezone offset, in -// milliseconds, from Coordinated Universal Time (UTC). +// TimeZone: The timezone ID and offset from Coordinated Universal Time +// (UTC). Not supported by Chat apps. type TimeZone struct { + // Id: The IANA TZ (https://www.iana.org/time-zones) time zone database + // code, such as "America/Toronto". Id string `json:"id,omitempty"` + // Offset: The user timezone offset, in milliseconds, from Coordinated + // Universal Time (UTC). Offset int64 `json:"offset,omitempty"` // ForceSendFields is a list of field names (e.g. "Id") to @@ -3559,7 +3618,7 @@ type User struct { IsAnonymous bool `json:"isAnonymous,omitempty"` // Name: Resource name for a Google Chat user. Formatted as - // `users/AAAAAAAAAAA`. Represents a person + // `users/{user}`. Represents a person // (https://developers.google.com/people/api/rest/v1/people#Person) in // the People API. Name string `json:"name,omitempty"` diff --git a/cloudchannel/v1/cloudchannel-api.json b/cloudchannel/v1/cloudchannel-api.json index 0de5624b568..244ae76d600 100644 --- a/cloudchannel/v1/cloudchannel-api.json +++ b/cloudchannel/v1/cloudchannel-api.json @@ -1599,7 +1599,7 @@ } } }, - "revision": "20220217", + "revision": "20220218", "rootUrl": "https://cloudchannel.googleapis.com/", "schemas": { "GoogleCloudChannelV1ActivateEntitlementRequest": { @@ -3168,16 +3168,16 @@ "type": "object" }, "GoogleCloudChannelV1SubscriberEvent": { - "description": "Represents information which resellers will get as part of notification from Cloud Pub/Sub.", + "description": "Represents information which resellers will get as part of notification from Pub/Sub.", "id": "GoogleCloudChannelV1SubscriberEvent", "properties": { "customerEvent": { "$ref": "GoogleCloudChannelV1CustomerEvent", - "description": "Customer event send as part of Pub/Sub event to partners." + "description": "Customer event sent as part of Pub/Sub event to partners." }, "entitlementEvent": { "$ref": "GoogleCloudChannelV1EntitlementEvent", - "description": "Entitlement event send as part of Pub/Sub event to partners." + "description": "Entitlement event sent as part of Pub/Sub event to partners." } }, "type": "object" @@ -3793,16 +3793,16 @@ "type": "object" }, "GoogleCloudChannelV1alpha1SubscriberEvent": { - "description": "Represents information which resellers will get as part of notification from Cloud Pub/Sub.", + "description": "Represents information which resellers will get as part of notification from Pub/Sub.", "id": "GoogleCloudChannelV1alpha1SubscriberEvent", "properties": { "customerEvent": { "$ref": "GoogleCloudChannelV1alpha1CustomerEvent", - "description": "Customer event send as part of Pub/Sub event to partners." + "description": "Customer event sent as part of Pub/Sub event to partners." }, "entitlementEvent": { "$ref": "GoogleCloudChannelV1alpha1EntitlementEvent", - "description": "Entitlement event send as part of Pub/Sub event to partners." + "description": "Entitlement event sent as part of Pub/Sub event to partners." } }, "type": "object" diff --git a/cloudchannel/v1/cloudchannel-gen.go b/cloudchannel/v1/cloudchannel-gen.go index 9ac8335cba1..1e4ba80e51a 100644 --- a/cloudchannel/v1/cloudchannel-gen.go +++ b/cloudchannel/v1/cloudchannel-gen.go @@ -2819,13 +2819,13 @@ func (s *GoogleCloudChannelV1StartPaidServiceRequest) MarshalJSON() ([]byte, err } // GoogleCloudChannelV1SubscriberEvent: Represents information which -// resellers will get as part of notification from Cloud Pub/Sub. +// resellers will get as part of notification from Pub/Sub. type GoogleCloudChannelV1SubscriberEvent struct { - // CustomerEvent: Customer event send as part of Pub/Sub event to + // CustomerEvent: Customer event sent as part of Pub/Sub event to // partners. CustomerEvent *GoogleCloudChannelV1CustomerEvent `json:"customerEvent,omitempty"` - // EntitlementEvent: Entitlement event send as part of Pub/Sub event to + // EntitlementEvent: Entitlement event sent as part of Pub/Sub event to // partners. EntitlementEvent *GoogleCloudChannelV1EntitlementEvent `json:"entitlementEvent,omitempty"` @@ -3845,13 +3845,13 @@ func (s *GoogleCloudChannelV1alpha1RenewalSettings) MarshalJSON() ([]byte, error } // GoogleCloudChannelV1alpha1SubscriberEvent: Represents information -// which resellers will get as part of notification from Cloud Pub/Sub. +// which resellers will get as part of notification from Pub/Sub. type GoogleCloudChannelV1alpha1SubscriberEvent struct { - // CustomerEvent: Customer event send as part of Pub/Sub event to + // CustomerEvent: Customer event sent as part of Pub/Sub event to // partners. CustomerEvent *GoogleCloudChannelV1alpha1CustomerEvent `json:"customerEvent,omitempty"` - // EntitlementEvent: Entitlement event send as part of Pub/Sub event to + // EntitlementEvent: Entitlement event sent as part of Pub/Sub event to // partners. EntitlementEvent *GoogleCloudChannelV1alpha1EntitlementEvent `json:"entitlementEvent,omitempty"` diff --git a/cloudscheduler/v1/cloudscheduler-api.json b/cloudscheduler/v1/cloudscheduler-api.json index 7265eaff787..e13bd4836fa 100644 --- a/cloudscheduler/v1/cloudscheduler-api.json +++ b/cloudscheduler/v1/cloudscheduler-api.json @@ -418,7 +418,7 @@ } } }, - "revision": "20220106", + "revision": "20220212", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { @@ -481,7 +481,7 @@ "type": "string" }, "instance": { - "description": "App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).", + "description": "App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).", "type": "string" }, "service": { @@ -595,7 +595,7 @@ "description": "Settings that determine the retry behavior." }, "schedule": { - "description": "Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count \u003e 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time.", + "description": "Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count \u003e 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time.", "type": "string" }, "scheduleTime": { @@ -792,7 +792,7 @@ "type": "string" }, "topicName": { - "description": "Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by PubSub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.", + "description": "Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.", "type": "string" } }, diff --git a/cloudscheduler/v1/cloudscheduler-gen.go b/cloudscheduler/v1/cloudscheduler-gen.go index 43be03c205b..83467ca7cf9 100644 --- a/cloudscheduler/v1/cloudscheduler-gen.go +++ b/cloudscheduler/v1/cloudscheduler-gen.go @@ -300,7 +300,7 @@ type AppEngineRouting struct { // which is available when the job is attempted. Requests can only be // sent to a specific instance if manual scaling is used in App Engine // Standard - // (https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). + // (https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?#scaling_types_and_instance_classes). // App Engine Flex does not support instances. For more information, see // App Engine Standard request routing // (https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) @@ -492,7 +492,7 @@ type Job struct { // Schedule: Required, except when used with UpdateJob. Describes the // schedule on which the job will be executed. The schedule can be // either of the following types: * Crontab - // (http://en.wikipedia.org/wiki/Cron#Overview) * English-like schedule + // (https://en.wikipedia.org/wiki/Cron#Overview) * English-like schedule // (https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) // As a general rule, execution `n + 1` of a job will not begin until // execution `n` has finished. Cloud Scheduler will never allow two @@ -857,7 +857,7 @@ type PubsubTarget struct { // TopicName: Required. The name of the Cloud Pub/Sub topic to which // messages will be published when a job is delivered. The topic name - // must be in the same format as required by PubSub's + // must be in the same format as required by Pub/Sub's // PublishRequest.name // (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), // for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be diff --git a/cloudscheduler/v1beta1/cloudscheduler-api.json b/cloudscheduler/v1beta1/cloudscheduler-api.json index 60aab55f482..6463b7340c7 100644 --- a/cloudscheduler/v1beta1/cloudscheduler-api.json +++ b/cloudscheduler/v1beta1/cloudscheduler-api.json @@ -433,7 +433,7 @@ } } }, - "revision": "20220106", + "revision": "20220212", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { @@ -496,7 +496,7 @@ "type": "string" }, "instance": { - "description": "App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).", + "description": "App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if [manual scaling is used in App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?#scaling_types_and_instance_classes). App Engine Flex does not support instances. For more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).", "type": "string" }, "service": { @@ -580,7 +580,7 @@ "description": "App Engine HTTP target." }, "attemptDeadline": { - "description": "The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours 15 seconds. * For PubSub targets, this field is ignored.", + "description": "The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. The failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The allowed duration for this deadline is: * For HTTP targets, between 15 seconds and 30 minutes. * For App Engine HTTP targets, between 15 seconds and 24 hours 15 seconds. * For Pub/Sub targets, this field is ignored.", "format": "google-duration", "type": "string" }, @@ -614,7 +614,7 @@ "description": "Settings that determine the retry behavior." }, "schedule": { - "description": "Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](http://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count \u003e 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time.", + "description": "Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: * [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution `n + 1` of a job will not begin until execution `n` has finished. Cloud Scheduler will never allow two simultaneously outstanding executions. For example, this implies that if the `n+1`th execution is scheduled to run at 16:00 but the `n`th execution takes until 16:15, the `n+1`th execution will not start until `16:15`. A scheduled start time will be delayed if the previous execution has not ended when its scheduled time occurs. If retry_count \u003e 0 and a job attempt fails, the job will be tried a total of retry_count times, with exponential backoff, until the next scheduled start time.", "type": "string" }, "scheduleTime": { @@ -811,7 +811,7 @@ "type": "string" }, "topicName": { - "description": "Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by PubSub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.", + "description": "Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in the same project as the Cloud Scheduler job.", "type": "string" } }, diff --git a/cloudscheduler/v1beta1/cloudscheduler-gen.go b/cloudscheduler/v1beta1/cloudscheduler-gen.go index cb1192be325..b94e6781c97 100644 --- a/cloudscheduler/v1beta1/cloudscheduler-gen.go +++ b/cloudscheduler/v1beta1/cloudscheduler-gen.go @@ -300,7 +300,7 @@ type AppEngineRouting struct { // which is available when the job is attempted. Requests can only be // sent to a specific instance if manual scaling is used in App Engine // Standard - // (https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes). + // (https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?#scaling_types_and_instance_classes). // App Engine Flex does not support instances. For more information, see // App Engine Standard request routing // (https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) @@ -454,7 +454,7 @@ type Job struct { // will retry the job according to the RetryConfig. The allowed duration // for this deadline is: * For HTTP targets, between 15 seconds and 30 // minutes. * For App Engine HTTP targets, between 15 seconds and 24 - // hours 15 seconds. * For PubSub targets, this field is ignored. + // hours 15 seconds. * For Pub/Sub targets, this field is ignored. AttemptDeadline string `json:"attemptDeadline,omitempty"` // Description: Optionally caller-specified in CreateJob or UpdateJob. A @@ -499,7 +499,7 @@ type Job struct { // Schedule: Required, except when used with UpdateJob. Describes the // schedule on which the job will be executed. The schedule can be // either of the following types: * Crontab - // (http://en.wikipedia.org/wiki/Cron#Overview) * English-like schedule + // (https://en.wikipedia.org/wiki/Cron#Overview) * English-like schedule // (https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) // As a general rule, execution `n + 1` of a job will not begin until // execution `n` has finished. Cloud Scheduler will never allow two @@ -864,7 +864,7 @@ type PubsubTarget struct { // TopicName: Required. The name of the Cloud Pub/Sub topic to which // messages will be published when a job is delivered. The topic name - // must be in the same format as required by PubSub's + // must be in the same format as required by Pub/Sub's // PublishRequest.name // (https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), // for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be diff --git a/cloudsearch/v1/cloudsearch-api.json b/cloudsearch/v1/cloudsearch-api.json index e4cefd6aa10..d6c7dbf3d4b 100644 --- a/cloudsearch/v1/cloudsearch-api.json +++ b/cloudsearch/v1/cloudsearch-api.json @@ -1172,7 +1172,7 @@ "type": "boolean" }, "pageSize": { - "description": "Maximum number of datasources to fetch in a request. The max value is 100. The default value is 10", + "description": "Maximum number of datasources to fetch in a request. The max value is 1000. The default value is 1000.", "format": "int32", "location": "query", "type": "integer" @@ -1994,7 +1994,7 @@ } } }, - "revision": "20220207", + "revision": "20220215", "rootUrl": "https://cloudsearch.googleapis.com/", "schemas": { "AclInfo": { @@ -5426,6 +5426,9 @@ "avatarInfo": { "$ref": "AvatarInfo" }, + "avatarUrl": { + "type": "string" + }, "description": { "type": "string" }, diff --git a/cloudsearch/v1/cloudsearch-gen.go b/cloudsearch/v1/cloudsearch-gen.go index 73b27a37482..814ac1a3e19 100644 --- a/cloudsearch/v1/cloudsearch-gen.go +++ b/cloudsearch/v1/cloudsearch-gen.go @@ -6606,6 +6606,8 @@ func (s *SpaceId) MarshalJSON() ([]byte, error) { type SpaceInfo struct { AvatarInfo *AvatarInfo `json:"avatarInfo,omitempty"` + AvatarUrl string `json:"avatarUrl,omitempty"` + Description string `json:"description,omitempty"` GroupId *GroupId `json:"groupId,omitempty"` @@ -12426,8 +12428,8 @@ func (c *SettingsDatasourcesListCall) DebugOptionsEnableDebugging(debugOptionsEn } // PageSize sets the optional parameter "pageSize": Maximum number of -// datasources to fetch in a request. The max value is 100. The default -// value is 10 +// datasources to fetch in a request. The max value is 1000. The default +// value is 1000. func (c *SettingsDatasourcesListCall) PageSize(pageSize int64) *SettingsDatasourcesListCall { c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) return c @@ -12548,7 +12550,7 @@ func (c *SettingsDatasourcesListCall) Do(opts ...googleapi.CallOption) (*ListDat // "type": "boolean" // }, // "pageSize": { - // "description": "Maximum number of datasources to fetch in a request. The max value is 100. The default value is 10", + // "description": "Maximum number of datasources to fetch in a request. The max value is 1000. The default value is 1000.", // "format": "int32", // "location": "query", // "type": "integer" diff --git a/cloudsupport/v2beta/cloudsupport-api.json b/cloudsupport/v2beta/cloudsupport-api.json index ddc660a5b65..0f280eee6f8 100644 --- a/cloudsupport/v2beta/cloudsupport-api.json +++ b/cloudsupport/v2beta/cloudsupport-api.json @@ -294,7 +294,7 @@ ], "parameters": { "filter": { - "description": "An expression written in the Cloud filter language. If non-empty, then only cases whose fields match the filter are returned. If empty, then no messages are filtered out. Filter strings can use the following fields: - status (Accepted values: OPEN or CLOSED) - severity (Accepted values: S0, S1, S2, S3, or S4) - creator.email with the operators equals (=) and AND. Additionally, a global restriction (with no operator) can be used to search across displayName, description, and comments (e.g. \"my search\").", + "description": "An expression written in the Cloud filter language. If non-empty, then only cases whose fields match the filter are returned. If empty, then no messages are filtered out. Filter strings can use the following fields: - state (Accepted values: OPEN or CLOSED) - severity (Accepted values: S0, S1, S2, S3, or S4) - creator.email with the operators equals (=) and AND. Additionally, a global restriction (with no operator) can be used to search across displayName, description, and comments (e.g. \"my search\").", "location": "query", "type": "string" }, @@ -575,7 +575,7 @@ } } }, - "revision": "20220129", + "revision": "20220221", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { diff --git a/cloudsupport/v2beta/cloudsupport-gen.go b/cloudsupport/v2beta/cloudsupport-gen.go index d1a0cd792a0..e058b96e648 100644 --- a/cloudsupport/v2beta/cloudsupport-gen.go +++ b/cloudsupport/v2beta/cloudsupport-gen.go @@ -2373,7 +2373,7 @@ func (r *CasesService) List(parent string) *CasesListCall { // Filter sets the optional parameter "filter": An expression written in // the Cloud filter language. If non-empty, then only cases whose fields // match the filter are returned. If empty, then no messages are -// filtered out. Filter strings can use the following fields: - status +// filtered out. Filter strings can use the following fields: - state // (Accepted values: OPEN or CLOSED) - severity (Accepted values: S0, // S1, S2, S3, or S4) - creator.email with the operators equals (=) and // AND. Additionally, a global restriction (with no operator) can be @@ -2507,7 +2507,7 @@ func (c *CasesListCall) Do(opts ...googleapi.CallOption) (*ListCasesResponse, er // ], // "parameters": { // "filter": { - // "description": "An expression written in the Cloud filter language. If non-empty, then only cases whose fields match the filter are returned. If empty, then no messages are filtered out. Filter strings can use the following fields: - status (Accepted values: OPEN or CLOSED) - severity (Accepted values: S0, S1, S2, S3, or S4) - creator.email with the operators equals (=) and AND. Additionally, a global restriction (with no operator) can be used to search across displayName, description, and comments (e.g. \"my search\").", + // "description": "An expression written in the Cloud filter language. If non-empty, then only cases whose fields match the filter are returned. If empty, then no messages are filtered out. Filter strings can use the following fields: - state (Accepted values: OPEN or CLOSED) - severity (Accepted values: S0, S1, S2, S3, or S4) - creator.email with the operators equals (=) and AND. Additionally, a global restriction (with no operator) can be used to search across displayName, description, and comments (e.g. \"my search\").", // "location": "query", // "type": "string" // }, diff --git a/container/v1/container-api.json b/container/v1/container-api.json index 21b7a4ef535..de804888ec9 100644 --- a/container/v1/container-api.json +++ b/container/v1/container-api.json @@ -2459,7 +2459,7 @@ } } }, - "revision": "20220116", + "revision": "20220209", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -4273,6 +4273,10 @@ "$ref": "ShieldedInstanceConfig", "description": "Shielded Instance options." }, + "spot": { + "description": "Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.", + "type": "boolean" + }, "tags": { "description": "The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.", "items": { diff --git a/container/v1/container-gen.go b/container/v1/container-gen.go index 0d1f45e19c6..abc62202f43 100644 --- a/container/v1/container-gen.go +++ b/container/v1/container-gen.go @@ -3428,6 +3428,10 @@ type NodeConfig struct { // ShieldedInstanceConfig: Shielded Instance options. ShieldedInstanceConfig *ShieldedInstanceConfig `json:"shieldedInstanceConfig,omitempty"` + // Spot: Spot flag for enabling Spot VM, which is a rebrand of the + // existing preemptible flag. + Spot bool `json:"spot,omitempty"` + // Tags: The list of instance tags applied to all nodes. Tags are used // to identify valid sources or targets for network firewalls and are // specified by the client during cluster or node pool creation. Each diff --git a/content/v2.1/content-api.json b/content/v2.1/content-api.json index b187262e0f0..0682e320a17 100644 --- a/content/v2.1/content-api.json +++ b/content/v2.1/content-api.json @@ -147,7 +147,7 @@ "type": "string" }, "overwrite": { - "description": "Only available to selected merchants, for example multi-client accounts (MCAs) and their sub-accounts. When set to `True`, this flag removes any existing claim on the requested website and replaces it with a claim from the account that makes the request.", + "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" } @@ -197,7 +197,7 @@ }, "force": { "default": "false", - "description": "Flag to delete sub-accounts with products. The default value is false.", + "description": "Option to delete sub-accounts with products. The default value is false.", "location": "query", "type": "boolean" }, @@ -3239,7 +3239,7 @@ ], "parameters": { "country": { - "description": "The country of the template to retrieve. Defaults to `US`.", + "description": "The country of the template to retrieve. Defaults to \"`US`\".", "location": "query", "type": "string" }, @@ -3282,7 +3282,7 @@ ] }, "instorerefundlineitem": { - "description": "Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return.", + "description": "Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (for example, cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding through Google then through an in-store return.", "flatPath": "{merchantId}/orders/{orderId}/inStoreRefundLineItem", "httpMethod": "POST", "id": "content.orders.instorerefundlineitem", @@ -3364,7 +3364,7 @@ "type": "string" }, "statuses": { - "description": "Obtains orders that match any of the specified statuses. Please note that `active` is a shortcut for `pendingShipment` and `partiallyShipped`, and `completed` is a shortcut for `shipped`, `partiallyDelivered`, `delivered`, `partiallyReturned`, `returned`, and `canceled`.", + "description": "Obtains orders that match any of the specified statuses. Note that `active` is a shortcut for `pendingShipment` and `partiallyShipped`, and `completed` is a shortcut for `shipped`, `partiallyDelivered`, `delivered`, `partiallyReturned`, `returned`, and `canceled`.", "enum": [ "ACTIVE", "COMPLETED", @@ -3510,7 +3510,7 @@ ] }, "returnrefundlineitem": { - "description": "Returns and refunds a line item. Note that this method can only be called on fully shipped orders. Please also note that the Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund.", + "description": "Returns and refunds a line item. Note that this method can only be called on fully shipped orders. The Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund.", "flatPath": "{merchantId}/orders/{orderId}/returnRefundLineItem", "httpMethod": "POST", "id": "content.orders.returnrefundlineitem", @@ -3545,7 +3545,7 @@ ] }, "setlineitemmetadata": { - "description": "Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource.", + "description": "Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided through other methods. Submitted key-value pairs can be retrieved as part of the orders resource.", "flatPath": "{merchantId}/orders/{orderId}/setLineItemMetadata", "httpMethod": "POST", "id": "content.orders.setlineitemmetadata", @@ -4451,7 +4451,7 @@ ] }, "update": { - "description": "Register a Merchant Center account for pubsub notifications. Note that cloud topic name should not be provided as part of the request.", + "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", @@ -5815,11 +5815,11 @@ } } }, - "revision": "20220203", + "revision": "20220217", "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 is fully operational. The methods delete, insert, and update require the admin role.", + "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": { @@ -5913,15 +5913,15 @@ "id": "AccountAddress", "properties": { "country": { - "description": "CLDR country code (e.g. \"US\"). All MCA sub-accounts inherit the country of their parent MCA by default, however the country can be updated for individual sub-accounts.", + "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 (e.g. neighborhoods or suburbs).", + "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 (e.g. \"94043\").", + "description": "Postal code or ZIP (for example, \"94043\").", "type": "string" }, "region": { @@ -6237,7 +6237,7 @@ "type": "object" }, "AccountStatus": { - "description": "The status of an account, i.e., information about its products, which is computed offline and not returned immediately at insertion time.", + "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": { @@ -6415,7 +6415,7 @@ "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.", + "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" }, @@ -6425,7 +6425,7 @@ "type": "object" }, "AccountTaxTaxRule": { - "description": "Tax calculation rule to apply in a state or province (USA only).", + "description": "Tax calculation rule to apply in a state or province (US only).", "id": "AccountTaxTaxRule", "properties": { "country": { @@ -6981,15 +6981,15 @@ "type": "string" }, "city": { - "description": "Required. City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).", + "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](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (e.g. \"US\").", + "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 (e.g. \"94043\").", + "description": "Required. Postal code or ZIP (for example, \"94043\").", "type": "string" }, "streetAddress": { @@ -7153,11 +7153,11 @@ "id": "CarrierRate", "properties": { "carrierName": { - "description": "Carrier service, such as `\"UPS\"` or `\"Fedex\"`. The list of supported carriers can be retrieved via the `getSupportedCarriers` method. Required.", + "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 via the `getSupportedCarriers` method. Required.", + "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": { @@ -7183,7 +7183,7 @@ "id": "CarriersCarrier", "properties": { "country": { - "description": "The CLDR country code of the carrier (e.g., \"US\"). Always present.", + "description": "The CLDR country code of the carrier (for example, \"US\"). Always present.", "type": "string" }, "eddServices": { @@ -7194,11 +7194,11 @@ "type": "array" }, "name": { - "description": "The name of the carrier (e.g., `\"UPS\"`). Always present.", + "description": "The name of the carrier (for example, `\"UPS\"`). Always present.", "type": "string" }, "services": { - "description": "A list of supported services (e.g., `\"ground\"`) for that carrier. Contains at least one service. This is the list of valid values for CarrierRate.carrierService.", + "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" }, @@ -7474,7 +7474,7 @@ "type": "integer" }, "timezone": { - "description": "Timezone identifier for the cutoff time. A list of identifiers can be found in the AdWords API documentation. E.g. \"Europe/Zurich\". Required.", + "description": "Timezone identifier for the cutoff time (for example, \"Europe/Zurich\"). List of identifiers. Required.", "type": "string" } }, @@ -7559,7 +7559,7 @@ "type": "boolean" }, "timeZone": { - "description": "Time zone used for schedule. UTC by default. E.g., \"America/Los_Angeles\".", + "description": "Time zone used for schedule. UTC by default. For example, \"America/Los_Angeles\".", "type": "string" }, "username": { @@ -7592,7 +7592,7 @@ "type": "object" }, "DatafeedStatus": { - "description": "The status of a datafeed, i.e., the result of the last retrieval of the datafeed computed asynchronously when the feed processing is finished.", + "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": { @@ -7652,7 +7652,7 @@ "id": "DatafeedStatusError", "properties": { "code": { - "description": "The code of the error, e.g., \"validation/invalid_value\".", + "description": "The code of the error, for example, \"validation/invalid_value\".", "type": "string" }, "count": { @@ -7668,7 +7668,7 @@ "type": "array" }, "message": { - "description": "The error message, e.g., \"Invalid price\".", + "description": "The error message, for example, \"Invalid price\".", "type": "string" } }, @@ -7702,7 +7702,7 @@ "type": "string" }, "excludedDestinations": { - "description": "The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).", + "description": "The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center).", "items": { "type": "string" }, @@ -8033,7 +8033,7 @@ "type": "integer" }, "maxTransitTimeInDays": { - "description": "Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to `minTransitTimeInDays`.", + "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" }, @@ -8043,7 +8043,7 @@ "type": "integer" }, "minTransitTimeInDays": { - "description": "Minimum number of business days that is 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.", + "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" }, @@ -8320,7 +8320,7 @@ "id": "HolidayCutoff", "properties": { "deadlineDate": { - "description": "Date of the order deadline, in ISO 8601 format. E.g. \"2016-11-29\" for 29th November 2016. Required.", + "description": "Date of the order deadline, in ISO 8601 format. For example, \"2016-11-29\" for 29th November 2016. Required.", "type": "string" }, "deadlineHour": { @@ -8329,7 +8329,7 @@ "type": "integer" }, "deadlineTimezone": { - "description": "Timezone identifier for the deadline hour. A list of identifiers can be found in the AdWords API documentation. E.g. \"Europe/Zurich\". Required.", + "description": "Timezone identifier for the deadline hour (for example, \"Europe/Zurich\"). List of identifiers. Required.", "type": "string" }, "holidayId": { @@ -8337,7 +8337,7 @@ "type": "string" }, "visibleFromDate": { - "description": "Date on which the deadline will become visible to consumers in ISO 8601 format. E.g. \"2016-10-31\" for 31st October 2016. Required.", + "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" } }, @@ -8347,15 +8347,15 @@ "id": "HolidaysHoliday", "properties": { "countryCode": { - "description": "The CLDR territory code of the country in which the holiday is available. E.g. \"US\", \"DE\", \"GB\". A holiday cutoff can only be configured in a shipping settings service with matching delivery country. Always present.", + "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. E.g. \"2016-12-25\" for Christmas 2016. Always present.", + "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. E.g. \"2016-12-24\" for 24th December 2016. Always present.", + "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": { @@ -8495,7 +8495,7 @@ "description": "The settings for the About page." }, "country": { - "description": "Required. CLDR country code (e.g. \"US\").", + "description": "Required. CLDR country code (for example, \"US\").", "type": "string" }, "hostedLocalStorefrontActive": { @@ -9146,7 +9146,7 @@ "id": "LocationIdSet", "properties": { "locationIds": { - "description": "A non-empty list of location IDs. They must all be of the same location type (e.g., state).", + "description": "A non-empty list of location IDs. They must all be of the same location type (for example, state).", "items": { "type": "string" }, @@ -9425,11 +9425,11 @@ "properties": { "priceAmount": { "$ref": "Price", - "description": "The pre-tax or post-tax price depends on the location of the order. - For countries (e.g. US) where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (e.g. France) where price attribute includes tax, this field corresponds to the post-tax value ." + "description": "The pre-tax or post-tax price depends on the location of the order. - For countries (for example, \"US\". where price attribute excludes tax, this field corresponds to the pre-tax value. - For coutries (for example, \"France\") where price attribute includes tax, this field corresponds to the post-tax value ." }, "taxAmount": { "$ref": "Price", - "description": "Tax value, present only for countries where price attribute excludes tax (e.g. US). No tax is referenced as 0 value with the corresponding `currency`." + "description": "Tax value, present only for countries where price attribute excludes tax (for example, \"US\". No tax is referenced as 0 value with the corresponding `currency`." } }, "type": "object" @@ -9559,7 +9559,7 @@ "id": "OrderAddress", "properties": { "country": { - "description": "CLDR country code (e.g. \"US\").", + "description": "CLDR country code (for example, \"US\").", "type": "string" }, "fullAddress": { @@ -9574,11 +9574,11 @@ "type": "boolean" }, "locality": { - "description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).", + "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 (e.g. \"94043\").", + "description": "Postal Code or ZIP (for example, \"94043\").", "type": "string" }, "recipientName": { @@ -9616,7 +9616,7 @@ "type": "integer" }, "reason": { - "description": "The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Buy on Google until you make an update to that product. This will not affect your Shopping ads. Acceptable values are: - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`customerCanceled`\" - \"`customerInitiatedCancel`\" - \"`customerSupportRequested`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceError`\" - \"`returnRefundAbuse`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`failedToCaptureFunds`\" ", + "description": "The reason for the cancellation. Orders that are canceled with a noInventory reason will lead to the removal of the product from Buy on Google until you make an update to that product. This won't affect your Shopping ads. Acceptable values are: - \"`autoPostInternal`\" - \"`autoPostInvalidBillingAddress`\" - \"`autoPostNoInventory`\" - \"`autoPostPriceError`\" - \"`autoPostUndeliverableShippingAddress`\" - \"`couponAbuse`\" - \"`customerCanceled`\" - \"`customerInitiatedCancel`\" - \"`customerSupportRequested`\" - \"`failToPushOrderGoogleError`\" - \"`failToPushOrderMerchantError`\" - \"`failToPushOrderMerchantFulfillmentError`\" - \"`failToPushOrderToMerchant`\" - \"`failToPushOrderToMerchantOutOfStock`\" - \"`invalidCoupon`\" - \"`malformedShippingAddress`\" - \"`merchantDidNotShipOnTime`\" - \"`noInventory`\" - \"`orderTimeout`\" - \"`other`\" - \"`paymentAbuse`\" - \"`paymentDeclined`\" - \"`priceError`\" - \"`returnRefundAbuse`\" - \"`shippingPriceError`\" - \"`taxError`\" - \"`undeliverableShippingAddress`\" - \"`unsupportedPoBoxAddress`\" - \"`failedToCaptureFunds`\" ", "type": "string" }, "reasonText": { @@ -9728,7 +9728,7 @@ }, "product": { "$ref": "OrderLineItemProduct", - "description": "Product data as seen by customer from the time of the order placement. Note that certain attributes values (e.g. title or gtin) might be reformatted and no longer match values submitted via product feed." + "description": "Product data as seen by customer from the time of the order placement. Note that certain attributes values (for example, title or gtin) might be reformatted and no longer match values submitted through product feed." }, "quantityCanceled": { "description": "Number of items canceled.", @@ -9865,7 +9865,7 @@ "type": "string" }, "targetCountry": { - "description": "The CLDR territory // code of the target country of the product.", + "description": "The CLDR territory code of the target country of the product.", "type": "string" }, "title": { @@ -10065,7 +10065,7 @@ "type": "array" }, "endTime": { - "description": "Promotion end time in ISO 8601 format. Date, time, and offset required, e.g., \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\".", + "description": "Promotion end time in ISO 8601 format. Date, time, and offset required, for example, \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\".", "type": "string" }, "funder": { @@ -10085,7 +10085,7 @@ "type": "string" }, "startTime": { - "description": "Promotion start time in ISO 8601 format. Date, time, and offset required, e.g., \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\".", + "description": "Promotion start time in ISO 8601 format. Date, time, and offset required, for example, \"2020-01-02T09:00:00+01:00\" or \"2020-01-02T09:00:00Z\".", "type": "string" }, "subtype": { @@ -10258,7 +10258,7 @@ "id": "OrderShipment", "properties": { "carrier": { - "description": "The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. *Note:* You can also use unsupported carriers, but emails to customers will not include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for US are: - \"`ups`\" (United Parcel Service) *automatic status updates* - \"`usps`\" (United States Postal Service) *automatic status updates* - \"`fedex`\" (FedEx) *automatic status updates * - \"`dhl`\" (DHL eCommerce) *automatic status updates* (US only) - \"`ontrac`\" (OnTrac) *automatic status updates * - \"`dhl express`\" (DHL Express) - \"`deliv`\" (Deliv) - \"`dynamex`\" (TForce) - \"`lasership`\" (LaserShip) - \"`mpx`\" (Military Parcel Xpress) - \"`uds`\" (United Delivery Service) - \"`efw`\" (Estes Forwarding Worldwide) - \"`jd logistics`\" (JD Logistics) - \"`yunexpress`\" (YunExpress) - \"`china post`\" (China Post) - \"`china ems`\" (China Post Express Mail Service) - \"`singapore post`\" (Singapore Post) - \"`pos malaysia`\" (Pos Malaysia) - \"`postnl`\" (PostNL) - \"`ptt`\" (PTT Turkish Post) - \"`eub`\" (ePacket) - \"`chukou1`\" (Chukou1 Logistics) - \"`bestex`\" (Best Express) - \"`canada post`\" (Canada Post) - \"`purolator`\" (Purolator) - \"`canpar`\" (Canpar) - \"`india post`\" (India Post) - \"`blue dart`\" (Blue Dart) - \"`delhivery`\" (Delhivery) - \"`dtdc`\" (DTDC) - \"`tpc india`\" (TPC India) - \"`lso`\" (Lone Star Overnight) - \"`tww`\" (Team Worldwide) Supported carriers for FR are: - \"`la poste`\" (La Poste) *automatic status updates * - \"`colissimo`\" (Colissimo by La Poste) *automatic status updates* - \"`ups`\" (United Parcel Service) *automatic status updates * - \"`chronopost`\" (Chronopost by La Poste) - \"`gls`\" (General Logistics Systems France) - \"`dpd`\" (DPD Group by GeoPost) - \"`bpost`\" (Belgian Post Group) - \"`colis prive`\" (Colis Privé) - \"`boxtal`\" (Boxtal) - \"`geodis`\" (GEODIS) - \"`tnt`\" (TNT) - \"`db schenker`\" (DB Schenker) - \"`aramex`\" (Aramex) ", + "description": "The carrier handling the shipment. For supported carriers, Google includes the carrier name and tracking URL in emails to customers. For select supported carriers, Google also automatically updates the shipment status based on the provided shipment ID. *Note:* You can also use unsupported carriers, but emails to customers won't include the carrier name or tracking URL, and there will be no automatic order status updates. Supported carriers for \"US\" are: - \"`ups`\" (United Parcel Service) *automatic status updates* - \"`usps`\" (United States Postal Service) *automatic status updates* - \"`fedex`\" (FedEx) *automatic status updates * - \"`dhl`\" (DHL eCommerce) *automatic status updates* (US only) - \"`ontrac`\" (OnTrac) *automatic status updates * - \"`dhl express`\" (DHL Express) - \"`deliv`\" (Deliv) - \"`dynamex`\" (TForce) - \"`lasership`\" (LaserShip) - \"`mpx`\" (Military Parcel Xpress) - \"`uds`\" (United Delivery Service) - \"`efw`\" (Estes Forwarding Worldwide) - \"`jd logistics`\" (JD Logistics) - \"`yunexpress`\" (YunExpress) - \"`china post`\" (China Post) - \"`china ems`\" (China Post Express Mail Service) - \"`singapore post`\" (Singapore Post) - \"`pos malaysia`\" (Pos Malaysia) - \"`postnl`\" (PostNL) - \"`ptt`\" (PTT Turkish Post) - \"`eub`\" (ePacket) - \"`chukou1`\" (Chukou1 Logistics) - \"`bestex`\" (Best Express) - \"`canada post`\" (Canada Post) - \"`purolator`\" (Purolator) - \"`canpar`\" (Canpar) - \"`india post`\" (India Post) - \"`blue dart`\" (Blue Dart) - \"`delhivery`\" (Delhivery) - \"`dtdc`\" (DTDC) - \"`tpc india`\" (TPC India) - \"`lso`\" (Lone Star Overnight) - \"`tww`\" (Team Worldwide) Supported carriers for FR are: - \"`la poste`\" (La Poste) *automatic status updates * - \"`colissimo`\" (Colissimo by La Poste) *automatic status updates* - \"`ups`\" (United Parcel Service) *automatic status updates * - \"`chronopost`\" (Chronopost by La Poste) - \"`gls`\" (General Logistics Systems France) - \"`dpd`\" (DPD Group by GeoPost) - \"`bpost`\" (Belgian Post Group) - \"`colis prive`\" (Colis Privé) - \"`boxtal`\" (Boxtal) - \"`geodis`\" (GEODIS) - \"`tnt`\" (TNT) - \"`db schenker`\" (DB Schenker) - \"`aramex`\" (Aramex) ", "type": "string" }, "creationDate": { @@ -10322,7 +10322,7 @@ "id": "OrderShipmentScheduledDeliveryDetails", "properties": { "carrierPhoneNumber": { - "description": "The phone number of the carrier fulfilling the delivery. The phone number is formatted as the international notation in ITU-T Recommendation E.123 (e.g., \"+41 44 668 1800\").", + "description": "The phone number of the carrier fulfilling the delivery. The phone number is formatted as the international notation in ITU-T Recommendation E.123 (for example, \"+41 44 668 1800\").", "type": "string" }, "scheduledDate": { @@ -10839,7 +10839,7 @@ "id": "OrderreturnsRefundOperation", "properties": { "fullRefund": { - "description": "If true, the item will be fully refunded. Allowed only when payment_type is FOP. Merchant can choose this refund option to indicate the full remaining amount of corresponding object to be refunded to the customer via FOP.", + "description": "If true, the item will be fully refunded. Allowed only when payment_type is FOP. Merchant can choose this refund option to indicate the full remaining amount of corresponding object to be refunded to the customer through FOP.", "type": "boolean" }, "partialRefund": { @@ -11028,7 +11028,7 @@ "id": "OrdersCreateTestOrderRequest", "properties": { "country": { - "description": "The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created via `template_name`, or the addresses of orders created via `test_order`. Acceptable values are: - \"`US`\" - \"`FR`\" Defaults to `US`.", + "description": "The CLDR territory code of the country of the test order to create. Affects the currency and addresses of orders created through `template_name`, or the addresses of orders created through `test_order`. Acceptable values are: - \"`US`\" - \"`FR`\" Defaults to \"`US`\".", "type": "string" }, "templateName": { @@ -11103,10 +11103,10 @@ "properties": { "amount": { "$ref": "MonetaryAmount", - "description": "The total amount that is refunded. (e.g. refunding $5 each for 2 products should be done by setting quantity to 2 and amount to 10$) In case of multiple refunds, this should be the amount you currently want to refund to the customer." + "description": "The total amount that is refunded. (for example, refunding $5 each for 2 products should be done by setting quantity to 2 and amount to 10$) In case of multiple refunds, this should be the amount you currently want to refund to the customer." }, "fullRefund": { - "description": "If true, the full item will be refunded. If this is true, amount should not be provided and will be ignored.", + "description": "If true, the full item will be refunded. If this is true, amount shouldn't be provided and will be ignored.", "type": "boolean" }, "lineItemId": { @@ -11133,7 +11133,7 @@ "description": "The amount that is refunded. If this is not the first refund for the shipment, this should be the newly refunded amount." }, "fullRefund": { - "description": "If set to true, all shipping costs for the order will be refunded. If this is true, amount should not be provided and will be ignored. If set to false, submit the amount of the partial shipping refund, excluding the shipping tax. The shipping tax is calculated and handled on Google's side.", + "description": "If set to true, all shipping costs for the order will be refunded. If this is true, amount shouldn't be provided and will be ignored. If set to false, submit the amount of the partial shipping refund, excluding the shipping tax. The shipping tax is calculated and handled on Google's side.", "type": "boolean" } }, @@ -11324,7 +11324,7 @@ "description": "The amount that is refunded. If this is not the first refund for the order, this should be the newly refunded amount." }, "fullRefund": { - "description": "If true, the full order will be refunded, including shipping. If this is true, amount should not be provided and will be ignored.", + "description": "If true, the full order will be refunded, including shipping. If this is true, amount shouldn't be provided and will be ignored.", "type": "boolean" }, "operationId": { @@ -11538,7 +11538,7 @@ "id": "OrdersUpdateLineItemShippingDetailsRequest", "properties": { "deliverByDate": { - "description": "Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past.", + "description": "Updated delivery by date, in ISO 8601 format. If not specified only ship by date is updated. Provided date should be within 1 year timeframe and can't be a date in the past.", "type": "string" }, "lineItemId": { @@ -11554,7 +11554,7 @@ "type": "string" }, "shipByDate": { - "description": "Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated. Provided date should be within 1 year timeframe and can not be a date in the past.", + "description": "Updated ship by date, in ISO 8601 format. If not specified only deliver by date is updated. Provided date should be within 1 year timeframe and can't be a date in the past.", "type": "string" } }, @@ -11687,11 +11687,11 @@ "id": "PickupCarrierService", "properties": { "carrierName": { - "description": "The name of the pickup carrier (e.g., `\"UPS\"`). Required.", + "description": "The name of the pickup carrier (for example, `\"UPS\"`). Required.", "type": "string" }, "serviceName": { - "description": "The name of the pickup service (e.g., `\"Access point\"`). Required.", + "description": "The name of the pickup service (for example, `\"Access point\"`). Required.", "type": "string" } }, @@ -11701,15 +11701,15 @@ "id": "PickupServicesPickupService", "properties": { "carrierName": { - "description": "The name of the carrier (e.g., `\"UPS\"`). Always present.", + "description": "The name of the carrier (for example, `\"UPS\"`). Always present.", "type": "string" }, "country": { - "description": "The CLDR country code of the carrier (e.g., \"US\"). Always present.", + "description": "The CLDR country code of the carrier (for example, \"US\"). Always present.", "type": "string" }, "serviceName": { - "description": "The name of the pickup service (e.g., `\"Access point\"`). Always present.", + "description": "The name of the pickup service (for example, `\"Access point\"`). Always present.", "type": "string" } }, @@ -11883,7 +11883,7 @@ "type": "string" }, "storeCode": { - "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in a Business Profile.", + "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": { @@ -11922,7 +11922,7 @@ "type": "string" }, "storeCode": { - "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in a Business Profile.", + "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": { @@ -11965,7 +11965,7 @@ "type": "string" }, "storeCode": { - "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in a Business Profile.", + "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": { @@ -12029,7 +12029,7 @@ "type": "string" }, "storeCode": { - "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in a Business Profile.", + "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": { @@ -12072,7 +12072,7 @@ "type": "string" }, "storeCode": { - "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in a Business Profile.", + "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": { @@ -12119,7 +12119,7 @@ "type": "string" }, "storeCode": { - "description": "Required. The identifier of the merchant's store. Either a `storeCode` inserted via the API or the code of the store in a Business Profile.", + "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": { @@ -12314,7 +12314,7 @@ "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 (e.g., `{ \"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).", + "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" }, @@ -12373,7 +12373,7 @@ "type": "string" }, "excludedDestinations": { - "description": "The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).", + "description": "The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant Center).", "items": { "type": "string" }, @@ -12486,7 +12486,7 @@ "type": "string" }, "pattern": { - "description": "The item's pattern (e.g. polka dots).", + "description": "The item's pattern (for example, polka dots).", "type": "string" }, "pickupMethod": { @@ -12608,7 +12608,7 @@ "type": "array" }, "source": { - "description": "The source of the offer, i.e., how the offer was created. Acceptable values are: - \"`api`\" - \"`crawl`\" - \"`feed`\" ", + "description": "The source of the offer, that is, how the offer was created. Acceptable values are: - \"`api`\" - \"`crawl`\" - \"`feed`\" ", "type": "string" }, "subscriptionCost": { @@ -12717,22 +12717,22 @@ "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 is received if it happens before the cut-off time. Both maxHandlingTime and maxTransitTime are required if providing shipping speeds.", + "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 is 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.", + "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 is received if it happens before the cut-off time. minHandlingTime can only be present together with maxHandlingTime; but it is not required if maxHandlingTime is present.", + "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 is 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 is not required if maxTransitTime is present.", + "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" }, @@ -12786,7 +12786,7 @@ "type": "object" }, "ProductStatus": { - "description": "The status of a product, i.e., information about a product computed asynchronously.", + "description": "The status of a product, that is, information about a product computed asynchronously.", "id": "ProductStatus", "properties": { "creationDate": { @@ -13531,7 +13531,7 @@ }, "singleValue": { "$ref": "Value", - "description": "The value of the rate group (e.g. flat rate $10). Can only be set if `mainTable` and `subtables` are not set." + "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.", @@ -14266,15 +14266,15 @@ "id": "ReturnAddressAddress", "properties": { "country": { - "description": "CLDR country code (e.g. \"US\").", + "description": "CLDR country code (for example, \"US\").", "type": "string" }, "locality": { - "description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).", + "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 (e.g. \"94043\").", + "description": "Postal code or ZIP (for example, \"94043\").", "type": "string" }, "recipientName": { @@ -15054,7 +15054,7 @@ }, "pickupService": { "$ref": "PickupCarrierService", - "description": "The carrier-service pair delivering items to collection points. The list of supported pickup services can be retrieved via the `getSupportedPickupServices` method. Required if and only if the service delivery type is `pickup`." + "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.", @@ -15103,7 +15103,7 @@ "type": "string" }, "transferIds": { - "description": "The list of bank identifiers used for the transfer. e.g. Trace ID for Federal Automated Clearing House (ACH). This may also be known as the Wire ID.", + "description": "The list of bank identifiers used for the transfer. For example, Trace ID for Federal Automated Clearing House (ACH). This may also be known as the Wire ID.", "items": { "type": "string" }, @@ -15174,7 +15174,7 @@ "id": "SettlementTransactionIdentifiers", "properties": { "adjustmentId": { - "description": "The identifier of the adjustments, if it is available.", + "description": "The identifier of the adjustments, if it's available.", "type": "string" }, "merchantOrderId": { @@ -15691,7 +15691,7 @@ "id": "TestOrderAddress", "properties": { "country": { - "description": "CLDR country code (e.g. \"US\").", + "description": "CLDR country code (for example, \"US\").", "type": "string" }, "fullAddress": { @@ -15706,11 +15706,11 @@ "type": "boolean" }, "locality": { - "description": "City, town or commune. May also include dependent localities or sublocalities (e.g. neighborhoods or suburbs).", + "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 (e.g. \"94043\").", + "description": "Postal Code or ZIP (for example, \"94043\").", "type": "string" }, "recipientName": { @@ -15819,7 +15819,7 @@ "description": "Required. The price for the product. Tax is automatically calculated for orders where marketplace facilitator tax laws are applicable. Otherwise, tax settings from Merchant Center are applied." }, "targetCountry": { - "description": "Required. The CLDR territory // code of the target country of the product.", + "description": "Required. The CLDR territory code of the target country of the product.", "type": "string" }, "title": { @@ -15965,7 +15965,7 @@ "id": "UnitInvoice", "properties": { "additionalCharges": { - "description": "Additional charges for a unit, e.g. shipping costs.", + "description": "Additional charges for a unit, for example, shipping costs.", "items": { "$ref": "UnitInvoiceAdditionalCharge" }, @@ -16034,11 +16034,11 @@ "type": "boolean" }, "pricePercentage": { - "description": "A percentage of the price represented as a number in decimal notation (e.g., `\"5.4\"`). Can only be set if all other fields are not set.", + "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 (i.e., not for single values), and only if all other fields are not set.", + "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" } }, @@ -16116,11 +16116,11 @@ "id": "WarehouseBasedDeliveryTime", "properties": { "carrier": { - "description": "Required. Carrier, such as `\"UPS\"` or `\"Fedex\"`. The list of supported carriers can be retrieved via the `listSupportedCarriers` method.", + "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 via the `listSupportedCarriers` method. The name of the service must be in the eddSupportedServices list.", + "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": { @@ -16132,7 +16132,7 @@ "type": "string" }, "originCountry": { - "description": "Shipping origin's country represented as a [CLDR territory code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml).", + "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": { diff --git a/content/v2.1/content-gen.go b/content/v2.1/content-gen.go index e88d4a0fecb..db1eb373f2a 100644 --- a/content/v2.1/content-gen.go +++ b/content/v2.1/content-gen.go @@ -602,8 +602,8 @@ type ShoppingadsprogramService struct { } // Account: Account data. After the creation of a new account it may -// take a few minutes before it is fully operational. The methods -// delete, insert, and update require the admin role. +// take a few minutes before it's fully operational. The methods delete, +// insert, and update require the admin role. type Account struct { // AccountManagement: Output only. How the account is managed. // Acceptable values are: - "manual" - "automatic" @@ -700,16 +700,16 @@ func (s *Account) MarshalJSON() ([]byte, error) { } type AccountAddress struct { - // Country: CLDR country code (e.g. "US"). All MCA sub-accounts inherit - // the country of their parent MCA by default, however the country can - // be updated for individual sub-accounts. + // Country: 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. Country string `json:"country,omitempty"` // Locality: City, town or commune. May also include dependent - // localities or sublocalities (e.g. neighborhoods or suburbs). + // localities or sublocalities (for example, neighborhoods or suburbs). Locality string `json:"locality,omitempty"` - // PostalCode: Postal code or ZIP (e.g. "94043"). + // PostalCode: Postal code or ZIP (for example, "94043"). PostalCode string `json:"postalCode,omitempty"` // Region: Top-level administrative subdivision of the country. For @@ -1370,9 +1370,9 @@ func (s *AccountShippingImprovements) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// AccountStatus: The status of an account, i.e., information about its -// products, which is computed offline and not returned immediately at -// insertion time. +// AccountStatus: The status of an account, that is, information about +// its products, which is computed offline and not returned immediately +// at insertion time. type AccountStatus struct { // AccountId: The ID of the account for which the status is reported. AccountId string `json:"accountId,omitempty"` @@ -1606,7 +1606,7 @@ type AccountTax struct { // string "content#accountTax". Kind string `json:"kind,omitempty"` - // Rules: Tax rules. Updating the tax rules will enable US taxes (not + // Rules: Tax rules. Updating the tax rules will enable "US" taxes (not // reversible). Defining no rules is equivalent to not charging tax at // all. Rules []*AccountTaxTaxRule `json:"rules,omitempty"` @@ -1639,7 +1639,7 @@ func (s *AccountTax) MarshalJSON() ([]byte, error) { } // AccountTaxTaxRule: Tax calculation rule to apply in a state or -// province (USA only). +// province (US only). type AccountTaxTaxRule struct { // Country: Country code in which tax is applicable. Country string `json:"country,omitempty"` @@ -2632,15 +2632,15 @@ type Address struct { AdministrativeArea string `json:"administrativeArea,omitempty"` // City: Required. City, town or commune. May also include dependent - // localities or sublocalities (e.g. neighborhoods or suburbs). + // localities or sublocalities (for example, neighborhoods or suburbs). City string `json:"city,omitempty"` // Country: Required. CLDR country code - // (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) - // (e.g. "US"). + // (https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml) + // (for example, "US"). Country string `json:"country,omitempty"` - // PostalCode: Required. Postal code or ZIP (e.g. "94043"). + // PostalCode: Required. Postal code or ZIP (for example, "94043"). PostalCode string `json:"postalCode,omitempty"` // StreetAddress: Street-level part of the address. @@ -2888,13 +2888,13 @@ func (s *CaptureOrderResponse) MarshalJSON() ([]byte, error) { type CarrierRate struct { // CarrierName: Carrier service, such as "UPS" or "Fedex". The list - // of supported carriers can be retrieved via the `getSupportedCarriers` - // method. Required. + // of supported carriers can be retrieved through the + // `getSupportedCarriers` method. Required. CarrierName string `json:"carrierName,omitempty"` // CarrierService: Carrier service, such as "ground" or "2 days". - // The list of supported services for a carrier can be retrieved via the - // `getSupportedCarriers` method. Required. + // The list of supported services for a carrier can be retrieved through + // the `getSupportedCarriers` method. Required. CarrierService string `json:"carrierService,omitempty"` // FlatAdjustment: Additive shipping rate modifier. Can be negative. For @@ -2940,8 +2940,8 @@ func (s *CarrierRate) MarshalJSON() ([]byte, error) { } type CarriersCarrier struct { - // Country: The CLDR country code of the carrier (e.g., "US"). Always - // present. + // Country: The CLDR country code of the carrier (for example, "US"). + // Always present. Country string `json:"country,omitempty"` // EddServices: A list of services supported for EDD (Estimated Delivery @@ -2949,12 +2949,12 @@ type CarriersCarrier struct { // WarehouseBasedDeliveryTime.carrierService. EddServices []string `json:"eddServices,omitempty"` - // Name: The name of the carrier (e.g., "UPS"). Always present. + // Name: The name of the carrier (for example, "UPS"). Always present. Name string `json:"name,omitempty"` - // Services: A list of supported services (e.g., "ground") for that - // carrier. Contains at least one service. This is the list of valid - // values for CarrierRate.carrierService. + // Services: 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. Services []string `json:"services,omitempty"` // ForceSendFields is a list of field names (e.g. "Country") to @@ -3387,9 +3387,8 @@ type CutoffTime struct { // placed to be processed in the same day. Required. Minute int64 `json:"minute,omitempty"` - // Timezone: Timezone identifier for the cutoff time. A list of - // identifiers can be found in the AdWords API documentation. E.g. - // "Europe/Zurich". Required. + // Timezone: Timezone identifier for the cutoff time (for example, + // "Europe/Zurich"). List of identifiers. Required. Timezone string `json:"timezone,omitempty"` // ForceSendFields is a list of field names (e.g. "Hour") to @@ -3507,7 +3506,7 @@ type DatafeedFetchSchedule struct { // Paused: Whether the scheduled fetch is paused or not. Paused bool `json:"paused,omitempty"` - // TimeZone: Time zone used for schedule. UTC by default. E.g., + // TimeZone: Time zone used for schedule. UTC by default. For example, // "America/Los_Angeles". TimeZone string `json:"timeZone,omitempty"` @@ -3585,7 +3584,7 @@ func (s *DatafeedFormat) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// DatafeedStatus: The status of a datafeed, i.e., the result of the +// DatafeedStatus: The status of a datafeed, that is, the result of the // last retrieval of the datafeed computed asynchronously when the feed // processing is finished. type DatafeedStatus struct { @@ -3658,7 +3657,7 @@ func (s *DatafeedStatus) MarshalJSON() ([]byte, error) { // DatafeedStatusError: An error occurring in the feed, like "invalid // price". type DatafeedStatusError struct { - // Code: The code of the error, e.g., "validation/invalid_value". + // Code: The code of the error, for example, "validation/invalid_value". Code string `json:"code,omitempty"` // Count: The number of occurrences of the error in the feed. @@ -3668,7 +3667,7 @@ type DatafeedStatusError struct { // product. Examples []*DatafeedStatusExample `json:"examples,omitempty"` - // Message: The error message, e.g., "Invalid price". + // Message: The error message, for example, "Invalid price". Message string `json:"message,omitempty"` // ForceSendFields is a list of field names (e.g. "Code") to @@ -3734,7 +3733,7 @@ type DatafeedTarget struct { Country string `json:"country,omitempty"` // ExcludedDestinations: The list of destinations to exclude for this - // target (corresponds to unchecked check boxes in Merchant Center). + // target (corresponds to cleared check boxes in Merchant Center). ExcludedDestinations []string `json:"excludedDestinations,omitempty"` // IncludedDestinations: The list of destinations to include for this @@ -4306,7 +4305,7 @@ type DeliveryTime struct { // shipped. Must be greater than or equal to `minHandlingTimeInDays`. MaxHandlingTimeInDays int64 `json:"maxHandlingTimeInDays,omitempty"` - // MaxTransitTimeInDays: Maximum number of business days that is spent + // MaxTransitTimeInDays: 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`. MaxTransitTimeInDays int64 `json:"maxTransitTimeInDays,omitempty"` @@ -4316,7 +4315,7 @@ type DeliveryTime struct { // shipped. MinHandlingTimeInDays int64 `json:"minHandlingTimeInDays,omitempty"` - // MinTransitTimeInDays: Minimum number of business days that is spent + // MinTransitTimeInDays: 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. @@ -4731,8 +4730,8 @@ func (s *Headers) MarshalJSON() ([]byte, error) { } type HolidayCutoff struct { - // DeadlineDate: Date of the order deadline, in ISO 8601 format. E.g. - // "2016-11-29" for 29th November 2016. Required. + // DeadlineDate: Date of the order deadline, in ISO 8601 format. For + // example, "2016-11-29" for 29th November 2016. Required. DeadlineDate string `json:"deadlineDate,omitempty"` // DeadlineHour: Hour of the day on the deadline date until which the @@ -4741,17 +4740,16 @@ type HolidayCutoff struct { // Required. DeadlineHour int64 `json:"deadlineHour,omitempty"` - // DeadlineTimezone: Timezone identifier for the deadline hour. A list - // of identifiers can be found in the AdWords API documentation. E.g. - // "Europe/Zurich". Required. + // DeadlineTimezone: Timezone identifier for the deadline hour (for + // example, "Europe/Zurich"). List of identifiers. Required. DeadlineTimezone string `json:"deadlineTimezone,omitempty"` // HolidayId: Unique identifier for the holiday. Required. HolidayId string `json:"holidayId,omitempty"` // VisibleFromDate: Date on which the deadline will become visible to - // consumers in ISO 8601 format. E.g. "2016-10-31" for 31st October - // 2016. Required. + // consumers in ISO 8601 format. For example, "2016-10-31" for 31st + // October 2016. Required. VisibleFromDate string `json:"visibleFromDate,omitempty"` // ForceSendFields is a list of field names (e.g. "DeadlineDate") to @@ -4779,18 +4777,18 @@ func (s *HolidayCutoff) MarshalJSON() ([]byte, error) { type HolidaysHoliday struct { // CountryCode: The CLDR territory code of the country in which the - // holiday is available. E.g. "US", "DE", "GB". A holiday cutoff can - // only be configured in a shipping settings service with matching + // 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. CountryCode string `json:"countryCode,omitempty"` - // Date: Date of the holiday, in ISO 8601 format. E.g. "2016-12-25" for - // Christmas 2016. Always present. + // Date: Date of the holiday, in ISO 8601 format. For example, + // "2016-12-25" for Christmas 2016. Always present. Date string `json:"date,omitempty"` // DeliveryGuaranteeDate: Date on which the order has to arrive at the - // customer's, in ISO 8601 format. E.g. "2016-12-24" for 24th December - // 2016. Always present. + // customer's, in ISO 8601 format. For example, "2016-12-24" for 24th + // December 2016. Always present. DeliveryGuaranteeDate string `json:"deliveryGuaranteeDate,omitempty"` // DeliveryGuaranteeHour: Hour of the day in the delivery location's @@ -5043,7 +5041,7 @@ type LiaCountrySettings struct { // About: The settings for the About page. About *LiaAboutPageSettings `json:"about,omitempty"` - // Country: Required. CLDR country code (e.g. "US"). + // Country: Required. CLDR country code (for example, "US"). Country string `json:"country,omitempty"` // HostedLocalStorefrontActive: The status of the "Merchant hosted local @@ -6297,7 +6295,7 @@ func (s *LocalinventoryCustomBatchResponseEntry) MarshalJSON() ([]byte, error) { type LocationIdSet struct { // LocationIds: A non-empty list of location IDs. They must all be of - // the same location type (e.g., state). + // the same location type (for example, state). LocationIds []string `json:"locationIds,omitempty"` // ForceSendFields is a list of field names (e.g. "LocationIds") to @@ -6757,15 +6755,15 @@ func (s *MinimumOrderValueTableStoreCodeSetWithMov) MarshalJSON() ([]byte, error type MonetaryAmount struct { // PriceAmount: The pre-tax or post-tax price depends on the location of - // the order. - For countries (e.g. US) where price attribute excludes - // tax, this field corresponds to the pre-tax value. - For coutries - // (e.g. France) where price attribute includes tax, this field - // corresponds to the post-tax value . + // the order. - For countries (for example, "US". where price attribute + // excludes tax, this field corresponds to the pre-tax value. - For + // coutries (for example, "France") where price attribute includes tax, + // this field corresponds to the post-tax value . PriceAmount *Price `json:"priceAmount,omitempty"` // TaxAmount: Tax value, present only for countries where price - // attribute excludes tax (e.g. US). No tax is referenced as 0 value - // with the corresponding `currency`. + // attribute excludes tax (for example, "US". No tax is referenced as 0 + // value with the corresponding `currency`. TaxAmount *Price `json:"taxAmount,omitempty"` // ForceSendFields is a list of field names (e.g. "PriceAmount") to @@ -6949,7 +6947,7 @@ func (s *Order) MarshalJSON() ([]byte, error) { } type OrderAddress struct { - // Country: CLDR country code (e.g. "US"). + // Country: CLDR country code (for example, "US"). Country string `json:"country,omitempty"` // FullAddress: Strings representing the lines of the printed label for @@ -6961,10 +6959,10 @@ type OrderAddress struct { IsPostOfficeBox bool `json:"isPostOfficeBox,omitempty"` // Locality: City, town or commune. May also include dependent - // localities or sublocalities (e.g. neighborhoods or suburbs). + // localities or sublocalities (for example, neighborhoods or suburbs). Locality string `json:"locality,omitempty"` - // PostalCode: Postal Code or ZIP (e.g. "94043"). + // PostalCode: Postal Code or ZIP (for example, "94043"). PostalCode string `json:"postalCode,omitempty"` // RecipientName: Name of the recipient. @@ -7017,7 +7015,7 @@ type OrderCancellation struct { // Reason: The reason for the cancellation. Orders that are canceled // with a noInventory reason will lead to the removal of the product // from Buy on Google until you make an update to that product. This - // will not affect your Shopping ads. Acceptable values are: - + // won't affect your Shopping ads. Acceptable values are: - // "autoPostInternal" - "autoPostInvalidBillingAddress" - // "autoPostNoInventory" - "autoPostPriceError" - // "autoPostUndeliverableShippingAddress" - "couponAbuse" - @@ -7227,9 +7225,9 @@ type OrderLineItem struct { Price *Price `json:"price,omitempty"` // Product: Product data as seen by customer from the time of the order - // placement. Note that certain attributes values (e.g. title or gtin) - // might be reformatted and no longer match values submitted via product - // feed. + // placement. Note that certain attributes values (for example, title or + // gtin) might be reformatted and no longer match values submitted + // through product feed. Product *OrderLineItemProduct `json:"product,omitempty"` // QuantityCanceled: Number of items canceled. @@ -7366,8 +7364,8 @@ type OrderLineItemProduct struct { // placed. ShownImage string `json:"shownImage,omitempty"` - // TargetCountry: The CLDR territory // code of the target country of - // the product. + // TargetCountry: The CLDR territory code of the target country of the + // product. TargetCountry string `json:"targetCountry,omitempty"` // Title: The title of the product. @@ -7725,7 +7723,7 @@ type OrderPromotion struct { AppliedItems []*OrderPromotionItem `json:"appliedItems,omitempty"` // EndTime: Promotion end time in ISO 8601 format. Date, time, and - // offset required, e.g., "2020-01-02T09:00:00+01:00" or + // offset required, for example, "2020-01-02T09:00:00+01:00" or // "2020-01-02T09:00:00Z". EndTime string `json:"endTime,omitempty"` @@ -7747,7 +7745,7 @@ type OrderPromotion struct { ShortTitle string `json:"shortTitle,omitempty"` // StartTime: Promotion start time in ISO 8601 format. Date, time, and - // offset required, e.g., "2020-01-02T09:00:00+01:00" or + // offset required, for example, "2020-01-02T09:00:00+01:00" or // "2020-01-02T09:00:00Z". StartTime string `json:"startTime,omitempty"` @@ -8049,9 +8047,9 @@ type OrderShipment struct { // customers. For select supported carriers, Google also automatically // updates the shipment status based on the provided shipment ID. // *Note:* You can also use unsupported carriers, but emails to - // customers will not include the carrier name or tracking URL, and - // there will be no automatic order status updates. Supported carriers - // for US are: - "ups" (United Parcel Service) *automatic status + // customers won't include the carrier name or tracking URL, and there + // will be no automatic order status updates. Supported carriers for + // "US" are: - "ups" (United Parcel Service) *automatic status // updates* - "usps" (United States Postal Service) *automatic status // updates* - "fedex" (FedEx) *automatic status updates * - "dhl" // (DHL eCommerce) *automatic status updates* (US only) - "ontrac" @@ -8170,7 +8168,7 @@ func (s *OrderShipmentLineItemShipment) MarshalJSON() ([]byte, error) { type OrderShipmentScheduledDeliveryDetails struct { // CarrierPhoneNumber: The phone number of the carrier fulfilling the // delivery. The phone number is formatted as the international notation - // in ITU-T Recommendation E.123 (e.g., "+41 44 668 1800"). + // in ITU-T Recommendation E.123 (for example, "+41 44 668 1800"). CarrierPhoneNumber string `json:"carrierPhoneNumber,omitempty"` // ScheduledDate: The date a shipment is scheduled for delivery, in ISO @@ -9111,7 +9109,7 @@ type OrderreturnsRefundOperation struct { // FullRefund: If true, the item will be fully refunded. Allowed only // when payment_type is FOP. Merchant can choose this refund option to // indicate the full remaining amount of corresponding object to be - // refunded to the customer via FOP. + // refunded to the customer through FOP. FullRefund bool `json:"fullRefund,omitempty"` // PartialRefund: If this is set, the item will be partially refunded. @@ -9538,9 +9536,10 @@ func (s *OrdersCancelTestOrderByCustomerResponse) MarshalJSON() ([]byte, error) type OrdersCreateTestOrderRequest struct { // Country: The CLDR territory code of the country of the test order to - // create. Affects the currency and addresses of orders created via - // `template_name`, or the addresses of orders created via `test_order`. - // Acceptable values are: - "US" - "FR" Defaults to `US`. + // create. Affects the currency and addresses of orders created through + // `template_name`, or the addresses of orders created through + // `test_order`. Acceptable values are: - "US" - "FR" Defaults to + // "US". Country string `json:"country,omitempty"` // TemplateName: The test order template to use. Specify as an @@ -9704,14 +9703,14 @@ func (s *OrdersCustomBatchRequestEntryCreateTestReturnReturnItem) MarshalJSON() } type OrdersCustomBatchRequestEntryRefundItemItem struct { - // Amount: The total amount that is refunded. (e.g. refunding $5 each - // for 2 products should be done by setting quantity to 2 and amount to - // 10$) In case of multiple refunds, this should be the amount you - // currently want to refund to the customer. + // Amount: The total amount that is refunded. (for example, refunding $5 + // each for 2 products should be done by setting quantity to 2 and + // amount to 10$) In case of multiple refunds, this should be the amount + // you currently want to refund to the customer. Amount *MonetaryAmount `json:"amount,omitempty"` // FullRefund: If true, the full item will be refunded. If this is true, - // amount should not be provided and will be ignored. + // amount shouldn't be provided and will be ignored. FullRefund bool `json:"fullRefund,omitempty"` // LineItemId: The ID of the line item. Either lineItemId or productId @@ -9754,7 +9753,7 @@ type OrdersCustomBatchRequestEntryRefundItemShipping struct { Amount *Price `json:"amount,omitempty"` // FullRefund: If set to true, all shipping costs for the order will be - // refunded. If this is true, amount should not be provided and will be + // refunded. If this is true, amount shouldn't be provided and will be // ignored. If set to false, submit the amount of the partial shipping // refund, excluding the shipping tax. The shipping tax is calculated // and handled on Google's side. @@ -10149,7 +10148,7 @@ type OrdersRefundOrderRequest struct { Amount *MonetaryAmount `json:"amount,omitempty"` // FullRefund: If true, the full order will be refunded, including - // shipping. If this is true, amount should not be provided and will be + // shipping. If this is true, amount shouldn't be provided and will be // ignored. FullRefund bool `json:"fullRefund,omitempty"` @@ -10562,7 +10561,7 @@ func (s *OrdersShipLineItemsResponse) MarshalJSON() ([]byte, error) { type OrdersUpdateLineItemShippingDetailsRequest struct { // DeliverByDate: Updated delivery by date, in ISO 8601 format. If not // specified only ship by date is updated. Provided date should be - // within 1 year timeframe and can not be a date in the past. + // within 1 year timeframe and can't be a date in the past. DeliverByDate string `json:"deliverByDate,omitempty"` // LineItemId: The ID of the line item to set metadata. Either @@ -10580,7 +10579,7 @@ type OrdersUpdateLineItemShippingDetailsRequest struct { // ShipByDate: Updated ship by date, in ISO 8601 format. If not // specified only deliver by date is updated. Provided date should be - // within 1 year timeframe and can not be a date in the past. + // within 1 year timeframe and can't be a date in the past. ShipByDate string `json:"shipByDate,omitempty"` // ForceSendFields is a list of field names (e.g. "DeliverByDate") to @@ -10860,12 +10859,12 @@ func (s *PaymentServiceProviderLinkInfo) MarshalJSON() ([]byte, error) { } type PickupCarrierService struct { - // CarrierName: The name of the pickup carrier (e.g., "UPS"). + // CarrierName: The name of the pickup carrier (for example, "UPS"). // Required. CarrierName string `json:"carrierName,omitempty"` - // ServiceName: The name of the pickup service (e.g., "Access point"). - // Required. + // ServiceName: The name of the pickup service (for example, "Access + // point"). Required. ServiceName string `json:"serviceName,omitempty"` // ForceSendFields is a list of field names (e.g. "CarrierName") to @@ -10892,15 +10891,16 @@ func (s *PickupCarrierService) MarshalJSON() ([]byte, error) { } type PickupServicesPickupService struct { - // CarrierName: The name of the carrier (e.g., "UPS"). Always present. + // CarrierName: The name of the carrier (for example, "UPS"). Always + // present. CarrierName string `json:"carrierName,omitempty"` - // Country: The CLDR country code of the carrier (e.g., "US"). Always - // present. + // Country: The CLDR country code of the carrier (for example, "US"). + // Always present. Country string `json:"country,omitempty"` - // ServiceName: The name of the pickup service (e.g., "Access point"). - // Always present. + // ServiceName: The name of the pickup service (for example, "Access + // point"). Always present. ServiceName string `json:"serviceName,omitempty"` // ForceSendFields is a list of field names (e.g. "CarrierName") to @@ -11171,7 +11171,7 @@ type PosInventory struct { Quantity int64 `json:"quantity,omitempty,string"` // StoreCode: Required. The identifier of the merchant's store. Either a - // `storeCode` inserted via the API or the code of the store in a + // `storeCode` inserted through the API or the code of the store in a // Business Profile. StoreCode string `json:"storeCode,omitempty"` @@ -11223,7 +11223,7 @@ type PosInventoryRequest struct { Quantity int64 `json:"quantity,omitempty,string"` // StoreCode: Required. The identifier of the merchant's store. Either a - // `storeCode` inserted via the API or the code of the store in a + // `storeCode` inserted through the API or the code of the store in a // Business Profile. StoreCode string `json:"storeCode,omitempty"` @@ -11279,7 +11279,7 @@ type PosInventoryResponse struct { Quantity int64 `json:"quantity,omitempty,string"` // StoreCode: Required. The identifier of the merchant's store. Either a - // `storeCode` inserted via the API or the code of the store in a + // `storeCode` inserted through the API or the code of the store in a // Business Profile. StoreCode string `json:"storeCode,omitempty"` @@ -11379,7 +11379,7 @@ type PosSale struct { SaleId string `json:"saleId,omitempty"` // StoreCode: Required. The identifier of the merchant's store. Either a - // `storeCode` inserted via the API or the code of the store in a + // `storeCode` inserted through the API or the code of the store in a // Business Profile. StoreCode string `json:"storeCode,omitempty"` @@ -11435,7 +11435,7 @@ type PosSaleRequest struct { SaleId string `json:"saleId,omitempty"` // StoreCode: Required. The identifier of the merchant's store. Either a - // `storeCode` inserted via the API or the code of the store in a + // `storeCode` inserted through the API or the code of the store in a // Business Profile. StoreCode string `json:"storeCode,omitempty"` @@ -11495,7 +11495,7 @@ type PosSaleResponse struct { SaleId string `json:"saleId,omitempty"` // StoreCode: Required. The identifier of the merchant's store. Either a - // `storeCode` inserted via the API or the code of the store in a + // `storeCode` inserted through the API or the code of the store in a // Business Profile. StoreCode string `json:"storeCode,omitempty"` @@ -11788,10 +11788,11 @@ type Product struct { // CustomAttributes: A list of custom (merchant-provided) attributes. It // can also be used for submitting any attribute of the feed - // specification in its generic form (e.g., `{ "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). + // 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). CustomAttributes []*CustomAttribute `json:"customAttributes,omitempty"` // CustomLabel0: Custom label 0 for custom grouping of items in a @@ -11839,7 +11840,7 @@ type Product struct { EnergyEfficiencyClass string `json:"energyEfficiencyClass,omitempty"` // ExcludedDestinations: The list of destinations to exclude for this - // target (corresponds to unchecked check boxes in Merchant Center). + // target (corresponds to cleared check boxes in Merchant Center). ExcludedDestinations []string `json:"excludedDestinations,omitempty"` // ExpirationDate: Date on which the item should expire, as specified @@ -11949,7 +11950,7 @@ type Product struct { // the REST ID of the product, *not* this identifier. OfferId string `json:"offerId,omitempty"` - // Pattern: The item's pattern (e.g. polka dots). + // Pattern: The item's pattern (for example, polka dots). Pattern string `json:"pattern,omitempty"` // PickupMethod: The pick up option for the item. Acceptable values are: @@ -12043,7 +12044,7 @@ type Product struct { // same `itemGroupId` value (see size definition). Sizes []string `json:"sizes,omitempty"` - // Source: The source of the offer, i.e., how the offer was created. + // Source: The source of the offer, that is, how the offer was created. // Acceptable values are: - "api" - "crawl" - "feed" Source string `json:"source,omitempty"` @@ -12248,13 +12249,13 @@ type ProductShipping struct { // MaxHandlingTime: 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 is received if it happens + // 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. MaxHandlingTime int64 `json:"maxHandlingTime,omitempty,string"` // MaxTransitTime: Maximum transit time (inclusive) between when the - // order has shipped and when it is delivered in business days. 0 means + // 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. @@ -12262,17 +12263,17 @@ type ProductShipping struct { // MinHandlingTime: 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 is received if it happens + // 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 is not required if maxHandlingTime is + // with maxHandlingTime; but it's not required if maxHandlingTime is // present. MinHandlingTime int64 `json:"minHandlingTime,omitempty,string"` // MinTransitTime: Minimum transit time (inclusive) between when the - // order has shipped and when it is delivered in business days. 0 means + // 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 is not required if maxTransitTime is present. + // it's not required if maxTransitTime is present. MinTransitTime int64 `json:"minTransitTime,omitempty,string"` // PostalCode: The postal code range that the shipping rate applies to, @@ -12404,7 +12405,7 @@ func (s *ProductShippingWeight) UnmarshalJSON(data []byte) error { return nil } -// ProductStatus: The status of a product, i.e., information about a +// ProductStatus: The status of a product, that is, information about a // product computed asynchronously. type ProductStatus struct { // CreationDate: Date on which the item has been created, in ISO 8601 @@ -13437,8 +13438,8 @@ type RateGroup struct { // within shipping service. Name string `json:"name,omitempty"` - // SingleValue: The value of the rate group (e.g. flat rate $10). Can - // only be set if `mainTable` and `subtables` are not set. + // SingleValue: The value of the rate group (for example, flat rate + // $10). Can only be set if `mainTable` and `subtables` are not set. SingleValue *Value `json:"singleValue,omitempty"` // Subtables: A list of subtables referred to by `mainTable`. Can only @@ -14773,14 +14774,14 @@ func (s *ReturnAddress) MarshalJSON() ([]byte, error) { } type ReturnAddressAddress struct { - // Country: CLDR country code (e.g. "US"). + // Country: CLDR country code (for example, "US"). Country string `json:"country,omitempty"` // Locality: City, town or commune. May also include dependent - // localities or sublocalities (e.g. neighborhoods or suburbs). + // localities or sublocalities (for example, neighborhoods or suburbs). Locality string `json:"locality,omitempty"` - // PostalCode: Postal code or ZIP (e.g. "94043"). + // PostalCode: Postal code or ZIP (for example, "94043"). PostalCode string `json:"postalCode,omitempty"` // RecipientName: Name of the recipient to address returns to. @@ -15989,8 +15990,8 @@ type Service struct { // PickupService: The carrier-service pair delivering items to // collection points. The list of supported pickup services can be - // retrieved via the `getSupportedPickupServices` method. Required if - // and only if the service delivery type is `pickup`. + // retrieved through the `getSupportedPickupServices` method. Required + // if and only if the service delivery type is `pickup`. PickupService *PickupCarrierService `json:"pickupService,omitempty"` // RateGroups: Shipping rate group definitions. Only the last one is @@ -16056,9 +16057,9 @@ type SettlementReport struct { // by Google, in ISO 8601 format. TransferDate string `json:"transferDate,omitempty"` - // TransferIds: The list of bank identifiers used for the transfer. e.g. - // Trace ID for Federal Automated Clearing House (ACH). This may also be - // known as the Wire ID. + // TransferIds: The list of bank identifiers used for the transfer. For + // example, Trace ID for Federal Automated Clearing House (ACH). This + // may also be known as the Wire ID. TransferIds []string `json:"transferIds,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -16243,7 +16244,7 @@ func (s *SettlementTransactionAmountCommission) MarshalJSON() ([]byte, error) { } type SettlementTransactionIdentifiers struct { - // AdjustmentId: The identifier of the adjustments, if it is available. + // AdjustmentId: The identifier of the adjustments, if it's available. AdjustmentId string `json:"adjustmentId,omitempty"` // MerchantOrderId: The merchant provided order ID. @@ -17089,7 +17090,7 @@ func (s *TestOrder) MarshalJSON() ([]byte, error) { } type TestOrderAddress struct { - // Country: CLDR country code (e.g. "US"). + // Country: CLDR country code (for example, "US"). Country string `json:"country,omitempty"` // FullAddress: Strings representing the lines of the printed label for @@ -17101,10 +17102,10 @@ type TestOrderAddress struct { IsPostOfficeBox bool `json:"isPostOfficeBox,omitempty"` // Locality: City, town or commune. May also include dependent - // localities or sublocalities (e.g. neighborhoods or suburbs). + // localities or sublocalities (for example, neighborhoods or suburbs). Locality string `json:"locality,omitempty"` - // PostalCode: Postal Code or ZIP (e.g. "94043"). + // PostalCode: Postal Code or ZIP (for example, "94043"). PostalCode string `json:"postalCode,omitempty"` // RecipientName: Name of the recipient. @@ -17247,7 +17248,7 @@ type TestOrderLineItemProduct struct { // applicable. Otherwise, tax settings from Merchant Center are applied. Price *Price `json:"price,omitempty"` - // TargetCountry: Required. The CLDR territory // code of the target + // TargetCountry: Required. The CLDR territory code of the target // country of the product. TargetCountry string `json:"targetCountry,omitempty"` @@ -17513,8 +17514,8 @@ func (s *TransitTableTransitTimeRowTransitTimeValue) MarshalJSON() ([]byte, erro } type UnitInvoice struct { - // AdditionalCharges: Additional charges for a unit, e.g. shipping - // costs. + // AdditionalCharges: Additional charges for a unit, for example, + // shipping costs. AdditionalCharges []*UnitInvoiceAdditionalCharge `json:"additionalCharges,omitempty"` // UnitPrice: [required] Pre-tax or post-tax price of one unit depending @@ -17639,13 +17640,12 @@ type Value struct { NoShipping bool `json:"noShipping,omitempty"` // PricePercentage: A percentage of the price represented as a number in - // decimal notation (e.g., "5.4"). Can only be set if all other fields - // are not set. + // decimal notation (for example, "5.4"). Can only be set if all other + // fields are not set. PricePercentage string `json:"pricePercentage,omitempty"` // SubtableName: The name of a subtable. Can only be set in table cells - // (i.e., not for single values), and only if all other fields are not - // set. + // (not for single values), and only if all other fields are not set. SubtableName string `json:"subtableName,omitempty"` // ForceSendFields is a list of field names (e.g. "CarrierRateName") to @@ -17804,14 +17804,14 @@ func (s *Warehouse) MarshalJSON() ([]byte, error) { type WarehouseBasedDeliveryTime struct { // Carrier: Required. Carrier, such as "UPS" or "Fedex". The list of - // supported carriers can be retrieved via the `listSupportedCarriers` - // method. + // supported carriers can be retrieved through the + // `listSupportedCarriers` method. Carrier string `json:"carrier,omitempty"` // CarrierService: Required. Carrier service, such as "ground" or "2 // days". The list of supported services for a carrier can be retrieved - // via the `listSupportedCarriers` method. The name of the service must - // be in the eddSupportedServices list. + // through the `listSupportedCarriers` method. The name of the service + // must be in the eddSupportedServices list. CarrierService string `json:"carrierService,omitempty"` // OriginAdministrativeArea: Shipping origin's state. @@ -17822,7 +17822,7 @@ type WarehouseBasedDeliveryTime struct { // OriginCountry: Shipping origin's country represented as a CLDR // territory code - // (http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml). + // (https://github.com/unicode-org/cldr/blob/latest/common/main/en.xml). OriginCountry string `json:"originCountry,omitempty"` // OriginPostalCode: Shipping origin. @@ -18081,7 +18081,7 @@ func (r *AccountsService) Claimwebsite(merchantId uint64, accountId uint64) *Acc // Overwrite sets the optional parameter "overwrite": Only available to // selected merchants, for example multi-client accounts (MCAs) and -// their sub-accounts. When set to `True`, this flag removes any +// 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. func (c *AccountsClaimwebsiteCall) Overwrite(overwrite bool) *AccountsClaimwebsiteCall { @@ -18200,7 +18200,7 @@ func (c *AccountsClaimwebsiteCall) Do(opts ...googleapi.CallOption) (*AccountsCl // "type": "string" // }, // "overwrite": { - // "description": "Only available to selected merchants, for example multi-client accounts (MCAs) and their sub-accounts. When set to `True`, this flag removes any existing claim on the requested website and replaces it with a claim from the account that makes the request.", + // "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" // } @@ -18366,7 +18366,7 @@ func (r *AccountsService) Delete(merchantId uint64, accountId uint64) *AccountsD return c } -// Force sets the optional parameter "force": Flag to delete +// Force sets the optional parameter "force": Option to delete // sub-accounts with products. The default value is false. func (c *AccountsDeleteCall) Force(force bool) *AccountsDeleteCall { c.urlParams_.Set("force", fmt.Sprint(force)) @@ -18453,7 +18453,7 @@ func (c *AccountsDeleteCall) Do(opts ...googleapi.CallOption) error { // }, // "force": { // "default": "false", - // "description": "Flag to delete sub-accounts with products. The default value is false.", + // "description": "Option to delete sub-accounts with products. The default value is false.", // "location": "query", // "type": "boolean" // }, @@ -32107,7 +32107,7 @@ func (r *OrdersService) Gettestordertemplate(merchantId uint64, templateName str } // Country sets the optional parameter "country": The country of the -// template to retrieve. Defaults to `US`. +// template to retrieve. Defaults to "US". func (c *OrdersGettestordertemplateCall) Country(country string) *OrdersGettestordertemplateCall { c.urlParams_.Set("country", country) return c @@ -32224,7 +32224,7 @@ func (c *OrdersGettestordertemplateCall) Do(opts ...googleapi.CallOption) (*Orde // ], // "parameters": { // "country": { - // "description": "The country of the template to retrieve. Defaults to `US`.", + // "description": "The country of the template to retrieve. Defaults to \"`US`\".", // "location": "query", // "type": "string" // }, @@ -32283,14 +32283,14 @@ type OrdersInstorerefundlineitemCall struct { // Instorerefundlineitem: Deprecated. Notifies that item return and // refund was handled directly by merchant outside of Google payments -// processing (e.g. cash refund done in store). Note: We recommend -// calling the returnrefundlineitem method to refund in-store returns. -// We will issue the refund directly to the customer. This helps to -// prevent possible differences arising between merchant and Google -// transaction records. We also recommend having the point of sale -// system communicate with Google to ensure that customers do not -// receive a double refund by first refunding via Google then via an -// in-store return. +// processing (for example, cash refund done in store). Note: We +// recommend calling the returnrefundlineitem method to refund in-store +// returns. We will issue the refund directly to the customer. This +// helps to prevent possible differences arising between merchant and +// Google transaction records. We also recommend having the point of +// sale system communicate with Google to ensure that customers do not +// receive a double refund by first refunding through Google then +// through an in-store return. // // - merchantId: The ID of the account that manages the order. This // cannot be a multi-client account. @@ -32396,7 +32396,7 @@ func (c *OrdersInstorerefundlineitemCall) Do(opts ...googleapi.CallOption) (*Ord } return ret, nil // { - // "description": "Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return.", + // "description": "Deprecated. Notifies that item return and refund was handled directly by merchant outside of Google payments processing (for example, cash refund done in store). Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding through Google then through an in-store return.", // "flatPath": "{merchantId}/orders/{orderId}/inStoreRefundLineItem", // "httpMethod": "POST", // "id": "content.orders.instorerefundlineitem", @@ -32505,10 +32505,10 @@ func (c *OrdersListCall) PlacedDateStart(placedDateStart string) *OrdersListCall } // Statuses sets the optional parameter "statuses": Obtains orders that -// match any of the specified statuses. Please note that `active` is a -// shortcut for `pendingShipment` and `partiallyShipped`, and -// `completed` is a shortcut for `shipped`, `partiallyDelivered`, -// `delivered`, `partiallyReturned`, `returned`, and `canceled`. +// match any of the specified statuses. Note that `active` is a shortcut +// for `pendingShipment` and `partiallyShipped`, and `completed` is a +// shortcut for `shipped`, `partiallyDelivered`, `delivered`, +// `partiallyReturned`, `returned`, and `canceled`. // // Possible values: // "ACTIVE" - Return orders with status `active`. The `active` status @@ -32678,7 +32678,7 @@ func (c *OrdersListCall) Do(opts ...googleapi.CallOption) (*OrdersListResponse, // "type": "string" // }, // "statuses": { - // "description": "Obtains orders that match any of the specified statuses. Please note that `active` is a shortcut for `pendingShipment` and `partiallyShipped`, and `completed` is a shortcut for `shipped`, `partiallyDelivered`, `delivered`, `partiallyReturned`, `returned`, and `canceled`.", + // "description": "Obtains orders that match any of the specified statuses. Note that `active` is a shortcut for `pendingShipment` and `partiallyShipped`, and `completed` is a shortcut for `shipped`, `partiallyDelivered`, `delivered`, `partiallyReturned`, `returned`, and `canceled`.", // "enum": [ // "ACTIVE", // "COMPLETED", @@ -33218,13 +33218,12 @@ type OrdersReturnrefundlineitemCall struct { } // Returnrefundlineitem: Returns and refunds a line item. Note that this -// method can only be called on fully shipped orders. Please also note -// that the Orderreturns API is the preferred way to handle returns -// after you receive a return from a customer. You can use -// Orderreturns.list or Orderreturns.get to search for the return, and -// then use Orderreturns.processreturn to issue the refund. If the -// return cannot be found, then we recommend using this API to issue a -// refund. +// method can only be called on fully shipped orders. The Orderreturns +// API is the preferred way to handle returns after you receive a return +// from a customer. You can use Orderreturns.list or Orderreturns.get to +// search for the return, and then use Orderreturns.processreturn to +// issue the refund. If the return cannot be found, then we recommend +// using this API to issue a refund. // // - merchantId: The ID of the account that manages the order. This // cannot be a multi-client account. @@ -33330,7 +33329,7 @@ func (c *OrdersReturnrefundlineitemCall) Do(opts ...googleapi.CallOption) (*Orde } return ret, nil // { - // "description": "Returns and refunds a line item. Note that this method can only be called on fully shipped orders. Please also note that the Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund.", + // "description": "Returns and refunds a line item. Note that this method can only be called on fully shipped orders. The Orderreturns API is the preferred way to handle returns after you receive a return from a customer. You can use Orderreturns.list or Orderreturns.get to search for the return, and then use Orderreturns.processreturn to issue the refund. If the return cannot be found, then we recommend using this API to issue a refund.", // "flatPath": "{merchantId}/orders/{orderId}/returnRefundLineItem", // "httpMethod": "POST", // "id": "content.orders.returnrefundlineitem", @@ -33382,7 +33381,7 @@ type OrdersSetlineitemmetadataCall struct { // Setlineitemmetadata: Sets (or overrides if it already exists) // merchant provided annotations in the form of key-value pairs. A // common use case would be to supply us with additional structured -// information about a line item that cannot be provided via other +// information about a line item that cannot be provided through other // methods. Submitted key-value pairs can be retrieved as part of the // orders resource. // @@ -33490,7 +33489,7 @@ func (c *OrdersSetlineitemmetadataCall) Do(opts ...googleapi.CallOption) (*Order } return ret, nil // { - // "description": "Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource.", + // "description": "Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided through other methods. Submitted key-value pairs can be retrieved as part of the orders resource.", // "flatPath": "{merchantId}/orders/{orderId}/setLineItemMetadata", // "httpMethod": "POST", // "id": "content.orders.setlineitemmetadata", @@ -37496,7 +37495,7 @@ type PubsubnotificationsettingsUpdateCall struct { } // Update: Register a Merchant Center account for pubsub notifications. -// Note that cloud topic name should not be provided as part of the +// Note that cloud topic name shouldn't be provided as part of the // request. // // - merchantId: The ID of the account. @@ -37598,7 +37597,7 @@ func (c *PubsubnotificationsettingsUpdateCall) Do(opts ...googleapi.CallOption) } return ret, nil // { - // "description": "Register a Merchant Center account for pubsub notifications. Note that cloud topic name should not be provided as part of the request.", + // "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", diff --git a/mybusinessbusinessinformation/v1/mybusinessbusinessinformation-api.json b/mybusinessbusinessinformation/v1/mybusinessbusinessinformation-api.json index 54a41813b51..aac67c4101f 100644 --- a/mybusinessbusinessinformation/v1/mybusinessbusinessinformation-api.json +++ b/mybusinessbusinessinformation/v1/mybusinessbusinessinformation-api.json @@ -662,7 +662,7 @@ } } }, - "revision": "20220215", + "revision": "20220221", "rootUrl": "https://mybusinessbusinessinformation.googleapis.com/", "schemas": { "AdWordsLocationExtensions": { @@ -1191,7 +1191,7 @@ }, "profile": { "$ref": "Profile", - "description": "Required. Describes your business in your own voice and shares with users the unique story of your business and offerings." + "description": "Optional. Describes your business in your own voice and shares with users the unique story of your business and offerings. This field is required for all categories except lodging categories (e.g. hotels, motels, inns)." }, "regularHours": { "$ref": "BusinessHours", @@ -1199,8 +1199,7 @@ }, "relationshipData": { "$ref": "RelationshipData", - "description": "Output only. All locations and chain related to this one.", - "readOnly": true + "description": "Optional. All locations and chain related to this one." }, "serviceArea": { "$ref": "ServiceAreaBusiness", diff --git a/mybusinessbusinessinformation/v1/mybusinessbusinessinformation-gen.go b/mybusinessbusinessinformation/v1/mybusinessbusinessinformation-gen.go index ab1dc6738bc..d356704416d 100644 --- a/mybusinessbusinessinformation/v1/mybusinessbusinessinformation-gen.go +++ b/mybusinessbusinessinformation/v1/mybusinessbusinessinformation-gen.go @@ -1184,15 +1184,17 @@ type Location struct { // can use to get in touch with the business. PhoneNumbers *PhoneNumbers `json:"phoneNumbers,omitempty"` - // Profile: Required. Describes your business in your own voice and + // Profile: Optional. Describes your business in your own voice and // shares with users the unique story of your business and offerings. + // This field is required for all categories except lodging categories + // (e.g. hotels, motels, inns). Profile *Profile `json:"profile,omitempty"` // RegularHours: Optional. Operating hours for the business. RegularHours *BusinessHours `json:"regularHours,omitempty"` - // RelationshipData: Output only. All locations and chain related to - // this one. + // RelationshipData: Optional. All locations and chain related to this + // one. RelationshipData *RelationshipData `json:"relationshipData,omitempty"` // ServiceArea: Optional. Service area businesses provide their service diff --git a/prod_tt_sasportal/v1alpha1/prod_tt_sasportal-api.json b/prod_tt_sasportal/v1alpha1/prod_tt_sasportal-api.json index f896eb59ac1..ff3fbae4c5d 100644 --- a/prod_tt_sasportal/v1alpha1/prod_tt_sasportal-api.json +++ b/prod_tt_sasportal/v1alpha1/prod_tt_sasportal-api.json @@ -107,49 +107,6 @@ "resources": { "customers": { "methods": { - "create": { - "description": "Creates a new SAS customer.", - "flatPath": "v1alpha1/customers", - "httpMethod": "POST", - "id": "prod_tt_sasportal.customers.create", - "parameterOrder": [], - "parameters": {}, - "path": "v1alpha1/customers", - "request": { - "$ref": "SasPortalCustomer" - }, - "response": { - "$ref": "SasPortalCustomer" - }, - "scopes": [ - "https://www.googleapis.com/auth/userinfo.email" - ] - }, - "delete": { - "description": "Deletes a customer.", - "flatPath": "v1alpha1/customers/{customersId}", - "httpMethod": "DELETE", - "id": "prod_tt_sasportal.customers.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the customer.", - "location": "path", - "pattern": "^customers/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha1/{+name}", - "response": { - "$ref": "SasPortalEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/userinfo.email" - ] - }, "get": { "description": "Returns a requested customer.", "flatPath": "v1alpha1/customers/{customersId}", @@ -2527,7 +2484,7 @@ } } }, - "revision": "20220219", + "revision": "20220221", "rootUrl": "https://prod-tt-sasportal.googleapis.com/", "schemas": { "SasPortalAssignment": { @@ -2916,6 +2873,11 @@ "description": "Output only. Whether a CPI has validated to have coordinated with the National Quiet Zone office.", "readOnly": true, "type": "boolean" + }, + "nrqzValidation": { + "$ref": "SasPortalNrqzValidation", + "description": "Output only. National Radio Quiet Zone validation info.", + "readOnly": true } }, "type": "object" @@ -3223,6 +3185,31 @@ }, "type": "object" }, + "SasPortalNrqzValidation": { + "description": "Information about National Radio Quiet Zone validation. The presence of the field indicates the device has been validated.", + "id": "SasPortalNrqzValidation", + "properties": { + "caseId": { + "description": "Validation case id.", + "type": "string" + }, + "cpiId": { + "description": "CPI who signed the validation.", + "type": "string" + }, + "latitude": { + "description": "Device latitude associated with the validation.", + "format": "double", + "type": "number" + }, + "longitude": { + "description": "Device longitude associated with the validation.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "SasPortalOperation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "SasPortalOperation", diff --git a/prod_tt_sasportal/v1alpha1/prod_tt_sasportal-gen.go b/prod_tt_sasportal/v1alpha1/prod_tt_sasportal-gen.go index cb12a177769..f9269f9835d 100644 --- a/prod_tt_sasportal/v1alpha1/prod_tt_sasportal-gen.go +++ b/prod_tt_sasportal/v1alpha1/prod_tt_sasportal-gen.go @@ -867,6 +867,10 @@ type SasPortalDeviceMetadata struct { // coordinated with the National Quiet Zone office. NrqzValidated bool `json:"nrqzValidated,omitempty"` + // NrqzValidation: Output only. National Radio Quiet Zone validation + // info. + NrqzValidation *SasPortalNrqzValidation `json:"nrqzValidation,omitempty"` + // ForceSendFields is a list of field names (e.g. "AntennaModel") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -1496,6 +1500,61 @@ func (s *SasPortalNode) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// SasPortalNrqzValidation: Information about National Radio Quiet Zone +// validation. The presence of the field indicates the device has been +// validated. +type SasPortalNrqzValidation struct { + // CaseId: Validation case id. + CaseId string `json:"caseId,omitempty"` + + // CpiId: CPI who signed the validation. + CpiId string `json:"cpiId,omitempty"` + + // Latitude: Device latitude associated with the validation. + Latitude float64 `json:"latitude,omitempty"` + + // Longitude: Device longitude associated with the validation. + Longitude float64 `json:"longitude,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CaseId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CaseId") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *SasPortalNrqzValidation) MarshalJSON() ([]byte, error) { + type NoMethod SasPortalNrqzValidation + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +func (s *SasPortalNrqzValidation) UnmarshalJSON(data []byte) error { + type NoMethod SasPortalNrqzValidation + var s1 struct { + Latitude gensupport.JSONFloat64 `json:"latitude"` + Longitude gensupport.JSONFloat64 `json:"longitude"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Latitude = float64(s1.Latitude) + s.Longitude = float64(s1.Longitude) + return nil +} + // SasPortalOperation: This resource represents a long-running operation // that is the result of a network API call. type SasPortalOperation struct { @@ -1854,263 +1913,6 @@ type SasPortalValidateInstallerResponse struct { googleapi.ServerResponse `json:"-"` } -// method id "prod_tt_sasportal.customers.create": - -type CustomersCreateCall struct { - s *Service - sasportalcustomer *SasPortalCustomer - urlParams_ gensupport.URLParams - ctx_ context.Context - header_ http.Header -} - -// Create: Creates a new SAS customer. -func (r *CustomersService) Create(sasportalcustomer *SasPortalCustomer) *CustomersCreateCall { - c := &CustomersCreateCall{s: r.s, urlParams_: make(gensupport.URLParams)} - c.sasportalcustomer = sasportalcustomer - return c -} - -// Fields allows partial responses to be retrieved. See -// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse -// for more information. -func (c *CustomersCreateCall) Fields(s ...googleapi.Field) *CustomersCreateCall { - c.urlParams_.Set("fields", googleapi.CombineFields(s)) - return c -} - -// Context sets the context to be used in this call's Do method. Any -// pending HTTP request will be aborted if the provided context is -// canceled. -func (c *CustomersCreateCall) Context(ctx context.Context) *CustomersCreateCall { - c.ctx_ = ctx - return c -} - -// Header returns an http.Header that can be modified by the caller to -// add HTTP headers to the request. -func (c *CustomersCreateCall) Header() http.Header { - if c.header_ == nil { - c.header_ = make(http.Header) - } - return c.header_ -} - -func (c *CustomersCreateCall) doRequest(alt string) (*http.Response, error) { - reqHeaders := make(http.Header) - reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) - for k, v := range c.header_ { - reqHeaders[k] = v - } - reqHeaders.Set("User-Agent", c.s.userAgent()) - var body io.Reader = nil - body, err := googleapi.WithoutDataWrapper.JSONReader(c.sasportalcustomer) - if err != nil { - return nil, err - } - reqHeaders.Set("Content-Type", "application/json") - c.urlParams_.Set("alt", alt) - c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha1/customers") - urls += "?" + c.urlParams_.Encode() - req, err := http.NewRequest("POST", urls, body) - if err != nil { - return nil, err - } - req.Header = reqHeaders - return gensupport.SendRequest(c.ctx_, c.s.client, req) -} - -// Do executes the "prod_tt_sasportal.customers.create" call. -// Exactly one of *SasPortalCustomer or error will be non-nil. Any -// non-2xx status code is an error. Response headers are in either -// *SasPortalCustomer.ServerResponse.Header or (if a response was -// returned at all) in error.(*googleapi.Error).Header. Use -// googleapi.IsNotModified to check whether the returned error was -// because http.StatusNotModified was returned. -func (c *CustomersCreateCall) Do(opts ...googleapi.CallOption) (*SasPortalCustomer, error) { - gensupport.SetOptions(c.urlParams_, opts...) - res, err := c.doRequest("json") - if res != nil && res.StatusCode == http.StatusNotModified { - if res.Body != nil { - res.Body.Close() - } - return nil, &googleapi.Error{ - Code: res.StatusCode, - Header: res.Header, - } - } - if err != nil { - return nil, err - } - defer googleapi.CloseBody(res) - if err := googleapi.CheckResponse(res); err != nil { - return nil, err - } - ret := &SasPortalCustomer{ - ServerResponse: googleapi.ServerResponse{ - Header: res.Header, - HTTPStatusCode: res.StatusCode, - }, - } - target := &ret - if err := gensupport.DecodeResponse(target, res); err != nil { - return nil, err - } - return ret, nil - // { - // "description": "Creates a new SAS customer.", - // "flatPath": "v1alpha1/customers", - // "httpMethod": "POST", - // "id": "prod_tt_sasportal.customers.create", - // "parameterOrder": [], - // "parameters": {}, - // "path": "v1alpha1/customers", - // "request": { - // "$ref": "SasPortalCustomer" - // }, - // "response": { - // "$ref": "SasPortalCustomer" - // }, - // "scopes": [ - // "https://www.googleapis.com/auth/userinfo.email" - // ] - // } - -} - -// method id "prod_tt_sasportal.customers.delete": - -type CustomersDeleteCall struct { - s *Service - name string - urlParams_ gensupport.URLParams - ctx_ context.Context - header_ http.Header -} - -// Delete: Deletes a customer. -// -// - name: The name of the customer. -func (r *CustomersService) Delete(name string) *CustomersDeleteCall { - c := &CustomersDeleteCall{s: r.s, urlParams_: make(gensupport.URLParams)} - c.name = name - return c -} - -// Fields allows partial responses to be retrieved. See -// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse -// for more information. -func (c *CustomersDeleteCall) Fields(s ...googleapi.Field) *CustomersDeleteCall { - c.urlParams_.Set("fields", googleapi.CombineFields(s)) - return c -} - -// Context sets the context to be used in this call's Do method. Any -// pending HTTP request will be aborted if the provided context is -// canceled. -func (c *CustomersDeleteCall) Context(ctx context.Context) *CustomersDeleteCall { - c.ctx_ = ctx - return c -} - -// Header returns an http.Header that can be modified by the caller to -// add HTTP headers to the request. -func (c *CustomersDeleteCall) Header() http.Header { - if c.header_ == nil { - c.header_ = make(http.Header) - } - return c.header_ -} - -func (c *CustomersDeleteCall) doRequest(alt string) (*http.Response, error) { - reqHeaders := make(http.Header) - reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) - for k, v := range c.header_ { - reqHeaders[k] = v - } - reqHeaders.Set("User-Agent", c.s.userAgent()) - var body io.Reader = nil - c.urlParams_.Set("alt", alt) - c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha1/{+name}") - urls += "?" + c.urlParams_.Encode() - req, err := http.NewRequest("DELETE", urls, body) - if err != nil { - return nil, err - } - req.Header = reqHeaders - googleapi.Expand(req.URL, map[string]string{ - "name": c.name, - }) - return gensupport.SendRequest(c.ctx_, c.s.client, req) -} - -// Do executes the "prod_tt_sasportal.customers.delete" call. -// Exactly one of *SasPortalEmpty or error will be non-nil. Any non-2xx -// status code is an error. Response headers are in either -// *SasPortalEmpty.ServerResponse.Header or (if a response was returned -// at all) in error.(*googleapi.Error).Header. Use -// googleapi.IsNotModified to check whether the returned error was -// because http.StatusNotModified was returned. -func (c *CustomersDeleteCall) Do(opts ...googleapi.CallOption) (*SasPortalEmpty, error) { - gensupport.SetOptions(c.urlParams_, opts...) - res, err := c.doRequest("json") - if res != nil && res.StatusCode == http.StatusNotModified { - if res.Body != nil { - res.Body.Close() - } - return nil, &googleapi.Error{ - Code: res.StatusCode, - Header: res.Header, - } - } - if err != nil { - return nil, err - } - defer googleapi.CloseBody(res) - if err := googleapi.CheckResponse(res); err != nil { - return nil, err - } - ret := &SasPortalEmpty{ - ServerResponse: googleapi.ServerResponse{ - Header: res.Header, - HTTPStatusCode: res.StatusCode, - }, - } - target := &ret - if err := gensupport.DecodeResponse(target, res); err != nil { - return nil, err - } - return ret, nil - // { - // "description": "Deletes a customer.", - // "flatPath": "v1alpha1/customers/{customersId}", - // "httpMethod": "DELETE", - // "id": "prod_tt_sasportal.customers.delete", - // "parameterOrder": [ - // "name" - // ], - // "parameters": { - // "name": { - // "description": "Required. The name of the customer.", - // "location": "path", - // "pattern": "^customers/[^/]+$", - // "required": true, - // "type": "string" - // } - // }, - // "path": "v1alpha1/{+name}", - // "response": { - // "$ref": "SasPortalEmpty" - // }, - // "scopes": [ - // "https://www.googleapis.com/auth/userinfo.email" - // ] - // } - -} - // method id "prod_tt_sasportal.customers.get": type CustomersGetCall struct { diff --git a/run/v2/run-api.json b/run/v2/run-api.json index 639a991e8db..ab50655dbe1 100644 --- a/run/v2/run-api.json +++ b/run/v2/run-api.json @@ -356,7 +356,7 @@ "type": "string" }, "parent": { - "description": "Required. The location and project to list resources on. Format: projects/{projectnumber}/locations/{location}", + "description": "Required. The location and project to list resources on. Location must be a valid GCP region, and may not be the \"-\" wildcard. Format: projects/{projectnumber}/locations/{location}", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -590,7 +590,7 @@ } } }, - "revision": "20220211", + "revision": "20220218", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunOpV2BinaryAuthorization": { diff --git a/run/v2/run-gen.go b/run/v2/run-gen.go index 6f3a684eb3d..5e918622e48 100644 --- a/run/v2/run-gen.go +++ b/run/v2/run-gen.go @@ -3381,8 +3381,9 @@ type ProjectsLocationsServicesListCall struct { // List: List Services. // -// - parent: The location and project to list resources on. Format: -// projects/{projectnumber}/locations/{location}. +// - parent: The location and project to list resources on. Location +// must be a valid GCP region, and may not be the "-" wildcard. +// Format: projects/{projectnumber}/locations/{location}. func (r *ProjectsLocationsServicesService) List(parent string) *ProjectsLocationsServicesListCall { c := &ProjectsLocationsServicesListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -3531,7 +3532,7 @@ func (c *ProjectsLocationsServicesListCall) Do(opts ...googleapi.CallOption) (*G // "type": "string" // }, // "parent": { - // "description": "Required. The location and project to list resources on. Format: projects/{projectnumber}/locations/{location}", + // "description": "Required. The location and project to list resources on. Location must be a valid GCP region, and may not be the \"-\" wildcard. Format: projects/{projectnumber}/locations/{location}", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+$", // "required": true, diff --git a/securitycenter/v1beta2/securitycenter-api.json b/securitycenter/v1beta2/securitycenter-api.json index 778ee7f7076..b7b54044c6a 100644 --- a/securitycenter/v1beta2/securitycenter-api.json +++ b/securitycenter/v1beta2/securitycenter-api.json @@ -1592,7 +1592,7 @@ } } }, - "revision": "20220210", + "revision": "20220219", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2120,6 +2120,51 @@ }, "type": "object" }, + "GoogleCloudSecuritycenterV1BigQueryExport": { + "description": "Configures how to deliver Findings to BigQuery Instance.", + "id": "GoogleCloudSecuritycenterV1BigQueryExport", + "properties": { + "createTime": { + "description": "Output only. The time at which the big query export was created. This field is set by the server and will be ignored if provided on export on creation.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dataset": { + "description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", + "type": "string" + }, + "description": { + "description": "The description of the export (max of 1024 characters).", + "type": "string" + }, + "filter": { + "description": "Expression that defines the filter to apply across create/update events of findings. The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. Parentheses are supported, and `OR` has higher precedence than `AND`. Restrictions have the form ` ` and may have a `-` character in front of them to indicate negation. The fields map to those defined in the corresponding resource. The supported operators are: * `=` for all value types. * `\u003e`, `\u003c`, `\u003e=`, `\u003c=` for integer values. * `:`, meaning substring matching, for strings. The supported value types are: * string literals in quotes. * integer literals without quotes. * boolean literals `true` and `false` without quotes. Please see the proto documentation in the finding (https://source.corp.google.com/piper///depot/google3/google/cloud/securitycenter/v1/finding.proto) and in the ListFindingsRequest for valid filter syntax. (https://source.corp.google.com/piper///depot/google3/google/cloud/securitycenter/v1/securitycenter_service.proto).", + "type": "string" + }, + "mostRecentEditor": { + "description": "Output only. Email address of the user who last edited the big query export. This field is set by the server and will be ignored if provided on export creation or update.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. Example format: \"organizations/{organization_id}/bigQueryExports/{export_id}\" Example format: \"folders/{folder_id}/bigQueryExports/{export_id}\" Example format: \"projects/{project_id}/bigQueryExports/{export_id}\" This field is provided in responses, and is ignored when provided in create requests.", + "type": "string" + }, + "principal": { + "description": "Output only. The service account that needs permission to create table, upload data to the big query dataset.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The most recent time at which the big export was updated. This field is set by the server and will be ignored if provided on export creation or update.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse": { "description": "The response to a BulkMute request. Contains the LRO information.", "id": "GoogleCloudSecuritycenterV1BulkMuteFindingsResponse", @@ -2249,7 +2294,7 @@ "type": "string" }, "projectDisplayName": { - "description": "The human readable name of project that the resource belongs to.", + "description": "The project id that the resource belongs to.", "type": "string" }, "type": { @@ -2463,7 +2508,7 @@ "type": "string" }, "projectDisplayName": { - "description": "The human readable name of project that the resource belongs to.", + "description": "The project id that the resource belongs to.", "type": "string" } }, diff --git a/securitycenter/v1beta2/securitycenter-gen.go b/securitycenter/v1beta2/securitycenter-gen.go index 0896df08892..93fa5f7cf3e 100644 --- a/securitycenter/v1beta2/securitycenter-gen.go +++ b/securitycenter/v1beta2/securitycenter-gen.go @@ -1110,6 +1110,87 @@ func (s *Geolocation) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleCloudSecuritycenterV1BigQueryExport: Configures how to deliver +// Findings to BigQuery Instance. +type GoogleCloudSecuritycenterV1BigQueryExport struct { + // CreateTime: Output only. The time at which the big query export was + // created. This field is set by the server and will be ignored if + // provided on export on creation. + CreateTime string `json:"createTime,omitempty"` + + // Dataset: The dataset to write findings' updates to. Its format is + // "projects/[project_id]/datasets/[bigquery_dataset_id]". BigQuery + // Dataset unique ID must contain only letters (a-z, A-Z), numbers + // (0-9), or underscores (_). + Dataset string `json:"dataset,omitempty"` + + // Description: The description of the export (max of 1024 characters). + Description string `json:"description,omitempty"` + + // Filter: Expression that defines the filter to apply across + // create/update events of findings. The expression is a list of zero or + // more restrictions combined via logical operators `AND` and `OR`. + // Parentheses are supported, and `OR` has higher precedence than `AND`. + // Restrictions have the form ` ` and may have a `-` character in front + // of them to indicate negation. The fields map to those defined in the + // corresponding resource. The supported operators are: * `=` for all + // value types. * `>`, `<`, `>=`, `<=` for integer values. * `:`, + // meaning substring matching, for strings. The supported value types + // are: * string literals in quotes. * integer literals without quotes. + // * boolean literals `true` and `false` without quotes. Please see the + // proto documentation in the finding + // (https://source.corp.google.com/piper///depot/google3/google/cloud/securitycenter/v1/finding.proto) + // and in the ListFindingsRequest for valid filter syntax. + // (https://source.corp.google.com/piper///depot/google3/google/cloud/securitycenter/v1/securitycenter_service.proto). + Filter string `json:"filter,omitempty"` + + // MostRecentEditor: Output only. Email address of the user who last + // edited the big query export. This field is set by the server and will + // be ignored if provided on export creation or update. + MostRecentEditor string `json:"mostRecentEditor,omitempty"` + + // Name: The relative resource name of this export. See: + // https://cloud.google.com/apis/design/resource_names#relative_resource_name. + // Example format: + // "organizations/{organization_id}/bigQueryExports/{export_id}" Example + // format: "folders/{folder_id}/bigQueryExports/{export_id}" Example + // format: "projects/{project_id}/bigQueryExports/{export_id}" This + // field is provided in responses, and is ignored when provided in + // create requests. + Name string `json:"name,omitempty"` + + // Principal: Output only. The service account that needs permission to + // create table, upload data to the big query dataset. + Principal string `json:"principal,omitempty"` + + // UpdateTime: Output only. The most recent time at which the big export + // was updated. This field is set by the server and will be ignored if + // provided on export creation or update. + UpdateTime string `json:"updateTime,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CreateTime") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CreateTime") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleCloudSecuritycenterV1BigQueryExport) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudSecuritycenterV1BigQueryExport + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleCloudSecuritycenterV1BulkMuteFindingsResponse: The response to // a BulkMute request. Contains the LRO information. type GoogleCloudSecuritycenterV1BulkMuteFindingsResponse struct { @@ -1294,8 +1375,7 @@ type GoogleCloudSecuritycenterV1Resource struct { // to. Project string `json:"project,omitempty"` - // ProjectDisplayName: The human readable name of project that the - // resource belongs to. + // ProjectDisplayName: The project id that the resource belongs to. ProjectDisplayName string `json:"projectDisplayName,omitempty"` // Type: The full resource type of the resource. @@ -1616,8 +1696,7 @@ type GoogleCloudSecuritycenterV1p1beta1Resource struct { // to. Project string `json:"project,omitempty"` - // ProjectDisplayName: The human readable name of project that the - // resource belongs to. + // ProjectDisplayName: The project id that the resource belongs to. ProjectDisplayName string `json:"projectDisplayName,omitempty"` // ForceSendFields is a list of field names (e.g. "Folders") to diff --git a/servicecontrol/v1/servicecontrol-api.json b/servicecontrol/v1/servicecontrol-api.json index 65ec24a86d7..8a675957893 100644 --- a/servicecontrol/v1/servicecontrol-api.json +++ b/servicecontrol/v1/servicecontrol-api.json @@ -197,7 +197,7 @@ } } }, - "revision": "20220114", + "revision": "20220218", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "AllocateInfo": { @@ -1846,6 +1846,217 @@ } }, "type": "object" + }, + "V1HttpRequest": { + "description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.", + "id": "V1HttpRequest", + "properties": { + "cacheFillBytes": { + "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.", + "format": "int64", + "type": "string" + }, + "cacheHit": { + "description": "Whether or not an entity was served from cache (with or without validation).", + "type": "boolean" + }, + "cacheLookup": { + "description": "Whether or not a cache lookup was attempted.", + "type": "boolean" + }, + "cacheValidatedWithOriginServer": { + "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if `cache_hit` is True.", + "type": "boolean" + }, + "latency": { + "description": "The request processing latency on the server, from the time the request was received until the response was sent.", + "format": "google-duration", + "type": "string" + }, + "protocol": { + "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"", + "type": "string" + }, + "referer": { + "description": "The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).", + "type": "string" + }, + "remoteIp": { + "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: `\"192.168.1.1\"`, `\"FE80::0202:B3FF:FE1E:8329\"`.", + "type": "string" + }, + "requestMethod": { + "description": "The request method. Examples: `\"GET\"`, `\"HEAD\"`, `\"PUT\"`, `\"POST\"`.", + "type": "string" + }, + "requestSize": { + "description": "The size of the HTTP request message in bytes, including the request headers and the request body.", + "format": "int64", + "type": "string" + }, + "requestUrl": { + "description": "The scheme (http, https), the host name, the path, and the query portion of the URL that was requested. Example: `\"http://example.com/some/info?color=red\"`.", + "type": "string" + }, + "responseSize": { + "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.", + "format": "int64", + "type": "string" + }, + "serverIp": { + "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.", + "type": "string" + }, + "status": { + "description": "The response code indicating the status of the response. Examples: 200, 404.", + "format": "int32", + "type": "integer" + }, + "userAgent": { + "description": "The user agent sent by the client. Example: `\"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\"`.", + "type": "string" + } + }, + "type": "object" + }, + "V1LogEntry": { + "description": "An individual log entry.", + "id": "V1LogEntry", + "properties": { + "httpRequest": { + "$ref": "V1HttpRequest", + "description": "Optional. Information about the HTTP request associated with this log entry, if applicable." + }, + "insertId": { + "description": "A unique ID for the log entry used for deduplication. If omitted, the implementation will generate one based on operation_id.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "A set of user-defined (key, value) data that provides additional information about the log entry.", + "type": "object" + }, + "monitoredResourceLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "A set of user-defined (key, value) data that provides additional information about the moniotored resource that the log entry belongs to.", + "type": "object" + }, + "name": { + "description": "Required. The log to which this log entry belongs. Examples: `\"syslog\"`, `\"book_log\"`.", + "type": "string" + }, + "operation": { + "$ref": "V1LogEntryOperation", + "description": "Optional. Information about an operation associated with the log entry, if applicable." + }, + "protoPayload": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The log entry payload, represented as a protocol buffer that is expressed as a JSON object. The only accepted type currently is AuditLog.", + "type": "object" + }, + "severity": { + "description": "The severity of the log entry. The default value is `LogSeverity.DEFAULT`.", + "enum": [ + "DEFAULT", + "DEBUG", + "INFO", + "NOTICE", + "WARNING", + "ERROR", + "CRITICAL", + "ALERT", + "EMERGENCY" + ], + "enumDescriptions": [ + "(0) The log entry has no assigned severity level.", + "(100) Debug or trace information.", + "(200) Routine information, such as ongoing status or performance.", + "(300) Normal but significant events, such as start up, shut down, or a configuration change.", + "(400) Warning events might cause problems.", + "(500) Error events are likely to cause problems.", + "(600) Critical events cause more severe problems or outages.", + "(700) A person must take an action immediately.", + "(800) One or more systems are unusable." + ], + "type": "string" + }, + "sourceLocation": { + "$ref": "V1LogEntrySourceLocation", + "description": "Optional. Source code location information associated with the log entry, if any." + }, + "structPayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The log entry payload, represented as a structure that is expressed as a JSON object.", + "type": "object" + }, + "textPayload": { + "description": "The log entry payload, represented as a Unicode string (UTF-8).", + "type": "string" + }, + "timestamp": { + "description": "The time the event described by the log entry occurred. If omitted, defaults to operation start time.", + "format": "google-datetime", + "type": "string" + }, + "trace": { + "description": "Optional. Resource name of the trace associated with the log entry, if any. If this field contains a relative resource name, you can assume the name is relative to `//tracing.googleapis.com`. Example: `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824`", + "type": "string" + } + }, + "type": "object" + }, + "V1LogEntryOperation": { + "description": "Additional information about a potentially long-running operation with which a log entry is associated.", + "id": "V1LogEntryOperation", + "properties": { + "first": { + "description": "Optional. Set this to True if this is the first log entry in the operation.", + "type": "boolean" + }, + "id": { + "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.", + "type": "string" + }, + "last": { + "description": "Optional. Set this to True if this is the last log entry in the operation.", + "type": "boolean" + }, + "producer": { + "description": "Optional. An arbitrary producer identifier. The combination of `id` and `producer` must be globally unique. Examples for `producer`: `\"MyDivision.MyBigCompany.com\"`, `\"github.com/MyProject/MyApplication\"`.", + "type": "string" + } + }, + "type": "object" + }, + "V1LogEntrySourceLocation": { + "description": "Additional information about the source code location that produced the log entry.", + "id": "V1LogEntrySourceLocation", + "properties": { + "file": { + "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.", + "type": "string" + }, + "function": { + "description": "Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: `qual.if.ied.Class.method` (Java), `dir/package.func` (Go), `function` (Python).", + "type": "string" + }, + "line": { + "description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.", + "format": "int64", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/servicecontrol/v1/servicecontrol-gen.go b/servicecontrol/v1/servicecontrol-gen.go index 987a008d13d..67c10b5a31d 100644 --- a/servicecontrol/v1/servicecontrol-gen.go +++ b/servicecontrol/v1/servicecontrol-gen.go @@ -2865,6 +2865,281 @@ func (s *TruncatableString) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// V1HttpRequest: A common proto for logging HTTP requests. Only +// contains semantics defined by the HTTP specification. +// Product-specific logging information MUST be defined in a separate +// message. +type V1HttpRequest struct { + // CacheFillBytes: The number of HTTP response bytes inserted into + // cache. Set only when a cache fill was attempted. + CacheFillBytes int64 `json:"cacheFillBytes,omitempty,string"` + + // CacheHit: Whether or not an entity was served from cache (with or + // without validation). + CacheHit bool `json:"cacheHit,omitempty"` + + // CacheLookup: Whether or not a cache lookup was attempted. + CacheLookup bool `json:"cacheLookup,omitempty"` + + // CacheValidatedWithOriginServer: Whether or not the response was + // validated with the origin server before being served from cache. This + // field is only meaningful if `cache_hit` is True. + CacheValidatedWithOriginServer bool `json:"cacheValidatedWithOriginServer,omitempty"` + + // Latency: The request processing latency on the server, from the time + // the request was received until the response was sent. + Latency string `json:"latency,omitempty"` + + // Protocol: Protocol used for the request. Examples: "HTTP/1.1", + // "HTTP/2", "websocket" + Protocol string `json:"protocol,omitempty"` + + // Referer: The referer URL of the request, as defined in HTTP/1.1 + // Header Field Definitions + // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). + Referer string `json:"referer,omitempty"` + + // RemoteIp: The IP address (IPv4 or IPv6) of the client that issued the + // HTTP request. Examples: "192.168.1.1", + // "FE80::0202:B3FF:FE1E:8329". + RemoteIp string `json:"remoteIp,omitempty"` + + // RequestMethod: The request method. Examples: "GET", "HEAD", + // "PUT", "POST". + RequestMethod string `json:"requestMethod,omitempty"` + + // RequestSize: The size of the HTTP request message in bytes, including + // the request headers and the request body. + RequestSize int64 `json:"requestSize,omitempty,string"` + + // RequestUrl: The scheme (http, https), the host name, the path, and + // the query portion of the URL that was requested. Example: + // "http://example.com/some/info?color=red". + RequestUrl string `json:"requestUrl,omitempty"` + + // ResponseSize: The size of the HTTP response message sent back to the + // client, in bytes, including the response headers and the response + // body. + ResponseSize int64 `json:"responseSize,omitempty,string"` + + // ServerIp: The IP address (IPv4 or IPv6) of the origin server that the + // request was sent to. + ServerIp string `json:"serverIp,omitempty"` + + // Status: The response code indicating the status of the response. + // Examples: 200, 404. + Status int64 `json:"status,omitempty"` + + // UserAgent: The user agent sent by the client. Example: "Mozilla/4.0 + // (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)". + UserAgent string `json:"userAgent,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CacheFillBytes") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CacheFillBytes") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *V1HttpRequest) MarshalJSON() ([]byte, error) { + type NoMethod V1HttpRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// V1LogEntry: An individual log entry. +type V1LogEntry struct { + // HttpRequest: Optional. Information about the HTTP request associated + // with this log entry, if applicable. + HttpRequest *V1HttpRequest `json:"httpRequest,omitempty"` + + // InsertId: A unique ID for the log entry used for deduplication. If + // omitted, the implementation will generate one based on operation_id. + InsertId string `json:"insertId,omitempty"` + + // Labels: A set of user-defined (key, value) data that provides + // additional information about the log entry. + Labels map[string]string `json:"labels,omitempty"` + + // MonitoredResourceLabels: A set of user-defined (key, value) data that + // provides additional information about the moniotored resource that + // the log entry belongs to. + MonitoredResourceLabels map[string]string `json:"monitoredResourceLabels,omitempty"` + + // Name: Required. The log to which this log entry belongs. Examples: + // "syslog", "book_log". + Name string `json:"name,omitempty"` + + // Operation: Optional. Information about an operation associated with + // the log entry, if applicable. + Operation *V1LogEntryOperation `json:"operation,omitempty"` + + // ProtoPayload: The log entry payload, represented as a protocol buffer + // that is expressed as a JSON object. The only accepted type currently + // is AuditLog. + ProtoPayload googleapi.RawMessage `json:"protoPayload,omitempty"` + + // Severity: The severity of the log entry. The default value is + // `LogSeverity.DEFAULT`. + // + // Possible values: + // "DEFAULT" - (0) The log entry has no assigned severity level. + // "DEBUG" - (100) Debug or trace information. + // "INFO" - (200) Routine information, such as ongoing status or + // performance. + // "NOTICE" - (300) Normal but significant events, such as start up, + // shut down, or a configuration change. + // "WARNING" - (400) Warning events might cause problems. + // "ERROR" - (500) Error events are likely to cause problems. + // "CRITICAL" - (600) Critical events cause more severe problems or + // outages. + // "ALERT" - (700) A person must take an action immediately. + // "EMERGENCY" - (800) One or more systems are unusable. + Severity string `json:"severity,omitempty"` + + // SourceLocation: Optional. Source code location information associated + // with the log entry, if any. + SourceLocation *V1LogEntrySourceLocation `json:"sourceLocation,omitempty"` + + // StructPayload: The log entry payload, represented as a structure that + // is expressed as a JSON object. + StructPayload googleapi.RawMessage `json:"structPayload,omitempty"` + + // TextPayload: The log entry payload, represented as a Unicode string + // (UTF-8). + TextPayload string `json:"textPayload,omitempty"` + + // Timestamp: The time the event described by the log entry occurred. If + // omitted, defaults to operation start time. + Timestamp string `json:"timestamp,omitempty"` + + // Trace: Optional. Resource name of the trace associated with the log + // entry, if any. If this field contains a relative resource name, you + // can assume the name is relative to `//tracing.googleapis.com`. + // Example: + // `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824` + Trace string `json:"trace,omitempty"` + + // ForceSendFields is a list of field names (e.g. "HttpRequest") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "HttpRequest") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *V1LogEntry) MarshalJSON() ([]byte, error) { + type NoMethod V1LogEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// V1LogEntryOperation: Additional information about a potentially +// long-running operation with which a log entry is associated. +type V1LogEntryOperation struct { + // First: Optional. Set this to True if this is the first log entry in + // the operation. + First bool `json:"first,omitempty"` + + // Id: Optional. An arbitrary operation identifier. Log entries with the + // same identifier are assumed to be part of the same operation. + Id string `json:"id,omitempty"` + + // Last: Optional. Set this to True if this is the last log entry in the + // operation. + Last bool `json:"last,omitempty"` + + // Producer: Optional. An arbitrary producer identifier. The combination + // of `id` and `producer` must be globally unique. Examples for + // `producer`: "MyDivision.MyBigCompany.com", + // "github.com/MyProject/MyApplication". + Producer string `json:"producer,omitempty"` + + // ForceSendFields is a list of field names (e.g. "First") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "First") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *V1LogEntryOperation) MarshalJSON() ([]byte, error) { + type NoMethod V1LogEntryOperation + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// V1LogEntrySourceLocation: Additional information about the source +// code location that produced the log entry. +type V1LogEntrySourceLocation struct { + // File: Optional. Source file name. Depending on the runtime + // environment, this might be a simple name or a fully-qualified name. + File string `json:"file,omitempty"` + + // Function: Optional. Human-readable name of the function or method + // being invoked, with optional context such as the class or package + // name. This information may be used in contexts such as the logs + // viewer, where a file and line number are less meaningful. The format + // can vary by language. For example: `qual.if.ied.Class.method` (Java), + // `dir/package.func` (Go), `function` (Python). + Function string `json:"function,omitempty"` + + // Line: Optional. Line within the source file. 1-based; 0 indicates no + // line number available. + Line int64 `json:"line,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "File") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "File") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *V1LogEntrySourceLocation) MarshalJSON() ([]byte, error) { + type NoMethod V1LogEntrySourceLocation + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // method id "servicecontrol.services.allocateQuota": type ServicesAllocateQuotaCall struct { diff --git a/servicecontrol/v2/servicecontrol-api.json b/servicecontrol/v2/servicecontrol-api.json index 704a3d60eac..176b55f94d5 100644 --- a/servicecontrol/v2/servicecontrol-api.json +++ b/servicecontrol/v2/servicecontrol-api.json @@ -169,7 +169,7 @@ } } }, - "revision": "20210930", + "revision": "20220218", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "Api": { @@ -848,6 +848,217 @@ } }, "type": "object" + }, + "V2HttpRequest": { + "description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.", + "id": "V2HttpRequest", + "properties": { + "cacheFillBytes": { + "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.", + "format": "int64", + "type": "string" + }, + "cacheHit": { + "description": "Whether or not an entity was served from cache (with or without validation).", + "type": "boolean" + }, + "cacheLookup": { + "description": "Whether or not a cache lookup was attempted.", + "type": "boolean" + }, + "cacheValidatedWithOriginServer": { + "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if `cache_hit` is True.", + "type": "boolean" + }, + "latency": { + "description": "The request processing latency on the server, from the time the request was received until the response was sent.", + "format": "google-duration", + "type": "string" + }, + "protocol": { + "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"", + "type": "string" + }, + "referer": { + "description": "The referer URL of the request, as defined in [HTTP/1.1 Header Field Definitions](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).", + "type": "string" + }, + "remoteIp": { + "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: `\"192.168.1.1\"`, `\"FE80::0202:B3FF:FE1E:8329\"`.", + "type": "string" + }, + "requestMethod": { + "description": "The request method. Examples: `\"GET\"`, `\"HEAD\"`, `\"PUT\"`, `\"POST\"`.", + "type": "string" + }, + "requestSize": { + "description": "The size of the HTTP request message in bytes, including the request headers and the request body.", + "format": "int64", + "type": "string" + }, + "requestUrl": { + "description": "The scheme (http, https), the host name, the path, and the query portion of the URL that was requested. Example: `\"http://example.com/some/info?color=red\"`.", + "type": "string" + }, + "responseSize": { + "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.", + "format": "int64", + "type": "string" + }, + "serverIp": { + "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.", + "type": "string" + }, + "status": { + "description": "The response code indicating the status of the response. Examples: 200, 404.", + "format": "int32", + "type": "integer" + }, + "userAgent": { + "description": "The user agent sent by the client. Example: `\"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\"`.", + "type": "string" + } + }, + "type": "object" + }, + "V2LogEntry": { + "description": "An individual log entry.", + "id": "V2LogEntry", + "properties": { + "httpRequest": { + "$ref": "V2HttpRequest", + "description": "Optional. Information about the HTTP request associated with this log entry, if applicable." + }, + "insertId": { + "description": "A unique ID for the log entry used for deduplication. If omitted, the implementation will generate one based on operation_id.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "A set of user-defined (key, value) data that provides additional information about the log entry.", + "type": "object" + }, + "monitoredResourceLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "A set of user-defined (key, value) data that provides additional information about the moniotored resource that the log entry belongs to.", + "type": "object" + }, + "name": { + "description": "Required. The log to which this log entry belongs. Examples: `\"syslog\"`, `\"book_log\"`.", + "type": "string" + }, + "operation": { + "$ref": "V2LogEntryOperation", + "description": "Optional. Information about an operation associated with the log entry, if applicable." + }, + "protoPayload": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The log entry payload, represented as a protocol buffer that is expressed as a JSON object. The only accepted type currently is AuditLog.", + "type": "object" + }, + "severity": { + "description": "The severity of the log entry. The default value is `LogSeverity.DEFAULT`.", + "enum": [ + "DEFAULT", + "DEBUG", + "INFO", + "NOTICE", + "WARNING", + "ERROR", + "CRITICAL", + "ALERT", + "EMERGENCY" + ], + "enumDescriptions": [ + "(0) The log entry has no assigned severity level.", + "(100) Debug or trace information.", + "(200) Routine information, such as ongoing status or performance.", + "(300) Normal but significant events, such as start up, shut down, or a configuration change.", + "(400) Warning events might cause problems.", + "(500) Error events are likely to cause problems.", + "(600) Critical events cause more severe problems or outages.", + "(700) A person must take an action immediately.", + "(800) One or more systems are unusable." + ], + "type": "string" + }, + "sourceLocation": { + "$ref": "V2LogEntrySourceLocation", + "description": "Optional. Source code location information associated with the log entry, if any." + }, + "structPayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The log entry payload, represented as a structure that is expressed as a JSON object.", + "type": "object" + }, + "textPayload": { + "description": "The log entry payload, represented as a Unicode string (UTF-8).", + "type": "string" + }, + "timestamp": { + "description": "The time the event described by the log entry occurred. If omitted, defaults to operation start time.", + "format": "google-datetime", + "type": "string" + }, + "trace": { + "description": "Optional. Resource name of the trace associated with the log entry, if any. If this field contains a relative resource name, you can assume the name is relative to `//tracing.googleapis.com`. Example: `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824`", + "type": "string" + } + }, + "type": "object" + }, + "V2LogEntryOperation": { + "description": "Additional information about a potentially long-running operation with which a log entry is associated.", + "id": "V2LogEntryOperation", + "properties": { + "first": { + "description": "Optional. Set this to True if this is the first log entry in the operation.", + "type": "boolean" + }, + "id": { + "description": "Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.", + "type": "string" + }, + "last": { + "description": "Optional. Set this to True if this is the last log entry in the operation.", + "type": "boolean" + }, + "producer": { + "description": "Optional. An arbitrary producer identifier. The combination of `id` and `producer` must be globally unique. Examples for `producer`: `\"MyDivision.MyBigCompany.com\"`, `\"github.com/MyProject/MyApplication\"`.", + "type": "string" + } + }, + "type": "object" + }, + "V2LogEntrySourceLocation": { + "description": "Additional information about the source code location that produced the log entry.", + "id": "V2LogEntrySourceLocation", + "properties": { + "file": { + "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.", + "type": "string" + }, + "function": { + "description": "Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: `qual.if.ied.Class.method` (Java), `dir/package.func` (Go), `function` (Python).", + "type": "string" + }, + "line": { + "description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.", + "format": "int64", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/servicecontrol/v2/servicecontrol-gen.go b/servicecontrol/v2/servicecontrol-gen.go index 5d5e73ac892..e0391af54cc 100644 --- a/servicecontrol/v2/servicecontrol-gen.go +++ b/servicecontrol/v2/servicecontrol-gen.go @@ -1295,6 +1295,281 @@ func (s *ThirdPartyPrincipal) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// V2HttpRequest: A common proto for logging HTTP requests. Only +// contains semantics defined by the HTTP specification. +// Product-specific logging information MUST be defined in a separate +// message. +type V2HttpRequest struct { + // CacheFillBytes: The number of HTTP response bytes inserted into + // cache. Set only when a cache fill was attempted. + CacheFillBytes int64 `json:"cacheFillBytes,omitempty,string"` + + // CacheHit: Whether or not an entity was served from cache (with or + // without validation). + CacheHit bool `json:"cacheHit,omitempty"` + + // CacheLookup: Whether or not a cache lookup was attempted. + CacheLookup bool `json:"cacheLookup,omitempty"` + + // CacheValidatedWithOriginServer: Whether or not the response was + // validated with the origin server before being served from cache. This + // field is only meaningful if `cache_hit` is True. + CacheValidatedWithOriginServer bool `json:"cacheValidatedWithOriginServer,omitempty"` + + // Latency: The request processing latency on the server, from the time + // the request was received until the response was sent. + Latency string `json:"latency,omitempty"` + + // Protocol: Protocol used for the request. Examples: "HTTP/1.1", + // "HTTP/2", "websocket" + Protocol string `json:"protocol,omitempty"` + + // Referer: The referer URL of the request, as defined in HTTP/1.1 + // Header Field Definitions + // (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). + Referer string `json:"referer,omitempty"` + + // RemoteIp: The IP address (IPv4 or IPv6) of the client that issued the + // HTTP request. Examples: "192.168.1.1", + // "FE80::0202:B3FF:FE1E:8329". + RemoteIp string `json:"remoteIp,omitempty"` + + // RequestMethod: The request method. Examples: "GET", "HEAD", + // "PUT", "POST". + RequestMethod string `json:"requestMethod,omitempty"` + + // RequestSize: The size of the HTTP request message in bytes, including + // the request headers and the request body. + RequestSize int64 `json:"requestSize,omitempty,string"` + + // RequestUrl: The scheme (http, https), the host name, the path, and + // the query portion of the URL that was requested. Example: + // "http://example.com/some/info?color=red". + RequestUrl string `json:"requestUrl,omitempty"` + + // ResponseSize: The size of the HTTP response message sent back to the + // client, in bytes, including the response headers and the response + // body. + ResponseSize int64 `json:"responseSize,omitempty,string"` + + // ServerIp: The IP address (IPv4 or IPv6) of the origin server that the + // request was sent to. + ServerIp string `json:"serverIp,omitempty"` + + // Status: The response code indicating the status of the response. + // Examples: 200, 404. + Status int64 `json:"status,omitempty"` + + // UserAgent: The user agent sent by the client. Example: "Mozilla/4.0 + // (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)". + UserAgent string `json:"userAgent,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CacheFillBytes") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CacheFillBytes") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *V2HttpRequest) MarshalJSON() ([]byte, error) { + type NoMethod V2HttpRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// V2LogEntry: An individual log entry. +type V2LogEntry struct { + // HttpRequest: Optional. Information about the HTTP request associated + // with this log entry, if applicable. + HttpRequest *V2HttpRequest `json:"httpRequest,omitempty"` + + // InsertId: A unique ID for the log entry used for deduplication. If + // omitted, the implementation will generate one based on operation_id. + InsertId string `json:"insertId,omitempty"` + + // Labels: A set of user-defined (key, value) data that provides + // additional information about the log entry. + Labels map[string]string `json:"labels,omitempty"` + + // MonitoredResourceLabels: A set of user-defined (key, value) data that + // provides additional information about the moniotored resource that + // the log entry belongs to. + MonitoredResourceLabels map[string]string `json:"monitoredResourceLabels,omitempty"` + + // Name: Required. The log to which this log entry belongs. Examples: + // "syslog", "book_log". + Name string `json:"name,omitempty"` + + // Operation: Optional. Information about an operation associated with + // the log entry, if applicable. + Operation *V2LogEntryOperation `json:"operation,omitempty"` + + // ProtoPayload: The log entry payload, represented as a protocol buffer + // that is expressed as a JSON object. The only accepted type currently + // is AuditLog. + ProtoPayload googleapi.RawMessage `json:"protoPayload,omitempty"` + + // Severity: The severity of the log entry. The default value is + // `LogSeverity.DEFAULT`. + // + // Possible values: + // "DEFAULT" - (0) The log entry has no assigned severity level. + // "DEBUG" - (100) Debug or trace information. + // "INFO" - (200) Routine information, such as ongoing status or + // performance. + // "NOTICE" - (300) Normal but significant events, such as start up, + // shut down, or a configuration change. + // "WARNING" - (400) Warning events might cause problems. + // "ERROR" - (500) Error events are likely to cause problems. + // "CRITICAL" - (600) Critical events cause more severe problems or + // outages. + // "ALERT" - (700) A person must take an action immediately. + // "EMERGENCY" - (800) One or more systems are unusable. + Severity string `json:"severity,omitempty"` + + // SourceLocation: Optional. Source code location information associated + // with the log entry, if any. + SourceLocation *V2LogEntrySourceLocation `json:"sourceLocation,omitempty"` + + // StructPayload: The log entry payload, represented as a structure that + // is expressed as a JSON object. + StructPayload googleapi.RawMessage `json:"structPayload,omitempty"` + + // TextPayload: The log entry payload, represented as a Unicode string + // (UTF-8). + TextPayload string `json:"textPayload,omitempty"` + + // Timestamp: The time the event described by the log entry occurred. If + // omitted, defaults to operation start time. + Timestamp string `json:"timestamp,omitempty"` + + // Trace: Optional. Resource name of the trace associated with the log + // entry, if any. If this field contains a relative resource name, you + // can assume the name is relative to `//tracing.googleapis.com`. + // Example: + // `projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824` + Trace string `json:"trace,omitempty"` + + // ForceSendFields is a list of field names (e.g. "HttpRequest") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "HttpRequest") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *V2LogEntry) MarshalJSON() ([]byte, error) { + type NoMethod V2LogEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// V2LogEntryOperation: Additional information about a potentially +// long-running operation with which a log entry is associated. +type V2LogEntryOperation struct { + // First: Optional. Set this to True if this is the first log entry in + // the operation. + First bool `json:"first,omitempty"` + + // Id: Optional. An arbitrary operation identifier. Log entries with the + // same identifier are assumed to be part of the same operation. + Id string `json:"id,omitempty"` + + // Last: Optional. Set this to True if this is the last log entry in the + // operation. + Last bool `json:"last,omitempty"` + + // Producer: Optional. An arbitrary producer identifier. The combination + // of `id` and `producer` must be globally unique. Examples for + // `producer`: "MyDivision.MyBigCompany.com", + // "github.com/MyProject/MyApplication". + Producer string `json:"producer,omitempty"` + + // ForceSendFields is a list of field names (e.g. "First") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "First") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *V2LogEntryOperation) MarshalJSON() ([]byte, error) { + type NoMethod V2LogEntryOperation + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// V2LogEntrySourceLocation: Additional information about the source +// code location that produced the log entry. +type V2LogEntrySourceLocation struct { + // File: Optional. Source file name. Depending on the runtime + // environment, this might be a simple name or a fully-qualified name. + File string `json:"file,omitempty"` + + // Function: Optional. Human-readable name of the function or method + // being invoked, with optional context such as the class or package + // name. This information may be used in contexts such as the logs + // viewer, where a file and line number are less meaningful. The format + // can vary by language. For example: `qual.if.ied.Class.method` (Java), + // `dir/package.func` (Go), `function` (Python). + Function string `json:"function,omitempty"` + + // Line: Optional. Line within the source file. 1-based; 0 indicates no + // line number available. + Line int64 `json:"line,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "File") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "File") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *V2LogEntrySourceLocation) MarshalJSON() ([]byte, error) { + type NoMethod V2LogEntrySourceLocation + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // method id "servicecontrol.services.check": type ServicesCheckCall struct {