From b6072d62905abf4b0f2386ce81ea85db4a51f7a2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Fri, 8 Sep 2023 13:42:15 -0700 Subject: [PATCH] feat(all): auto-regenerate discovery clients (#2148) --- checks/v1alpha/checks-api.json | 571 +----- checks/v1alpha/checks-gen.go | 1543 ----------------- firebase/v1beta1/firebase-api.json | 49 +- firebase/v1beta1/firebase-gen.go | 123 +- .../v1/gmailpostmastertools-api.json | 14 +- .../v1/gmailpostmastertools-gen.go | 41 +- .../v1beta1/gmailpostmastertools-api.json | 14 +- .../v1beta1/gmailpostmastertools-gen.go | 41 +- 8 files changed, 213 insertions(+), 2183 deletions(-) diff --git a/checks/v1alpha/checks-api.json b/checks/v1alpha/checks-api.json index 77211359ae3..75f243b3b47 100644 --- a/checks/v1alpha/checks-api.json +++ b/checks/v1alpha/checks-api.json @@ -412,270 +412,23 @@ "supportsMediaUpload": true } } - }, - "privacypolicy": { - "methods": { - "analyze": { - "description": "Performs a synchronous analysis of a privacy policy, where the policy content is mapped to privacy categories, data types, and purposes.", - "flatPath": "v1alpha/privacypolicy:analyze", - "httpMethod": "POST", - "id": "checks.privacypolicy.analyze", - "parameterOrder": [], - "parameters": {}, - "path": "v1alpha/privacypolicy:analyze", - "request": { - "$ref": "AnalyzePrivacyPolicyRequest" - }, - "response": { - "$ref": "AnalyzePrivacyPolicyResponse" - } - } - } - }, - "projects": { - "resources": { - "privacypolicy": { - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", - "flatPath": "v1alpha/projects/{projectsId}/privacypolicy/operations/{operationsId}:cancel", - "httpMethod": "POST", - "id": "checks.projects.privacypolicy.operations.cancel", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "location": "path", - "pattern": "^projects/[^/]+/privacypolicy/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}:cancel", - "response": { - "$ref": "Empty" - } - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1alpha/projects/{projectsId}/privacypolicy/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "checks.projects.privacypolicy.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/privacypolicy/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "Empty" - } - }, - "get": { - "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - "flatPath": "v1alpha/projects/{projectsId}/privacypolicy/operations/{operationsId}", - "httpMethod": "GET", - "id": "checks.projects.privacypolicy.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/privacypolicy/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "Operation" - } - }, - "list": { - "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - "flatPath": "v1alpha/projects/{projectsId}/privacypolicy/operations", - "httpMethod": "GET", - "id": "checks.projects.privacypolicy.operations.list", - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "description": "The standard list filter.", - "location": "query", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+$", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "The standard list page token.", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+name}/privacypolicy/operations", - "response": { - "$ref": "ListOperationsResponse" - } - }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1alpha/projects/{projectsId}/privacypolicy/operations/{operationsId}:wait", - "httpMethod": "POST", - "id": "checks.projects.privacypolicy.operations.wait", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", - "location": "path", - "pattern": "^projects/[^/]+/privacypolicy/operations/[^/]+$", - "required": true, - "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+name}:wait", - "response": { - "$ref": "Operation" - } - } - } - } - } - } - } } }, - "revision": "20230906", + "revision": "20230907", "rootUrl": "https://checks.googleapis.com/", "schemas": { - "AnalyzePrivacyPolicyRequest": { - "description": "Request for the AnalyzePrivacyPolicy method.", - "id": "AnalyzePrivacyPolicyRequest", - "properties": { - "privacyPolicyPageContent": { - "description": "The HTML content of the privacy policy. This is useful if you'd like to manage the crawling and rendering of the privacy policy.", - "type": "string" - }, - "privacyPolicyUri": { - "description": "The URI that points to the web page for the privacy policy.", - "type": "string" - } - }, - "type": "object" - }, - "AnalyzePrivacyPolicyResponse": { - "description": "Response containing the analyzed privacy policy for the AnalyzePrivacyPolicy method.", - "id": "AnalyzePrivacyPolicyResponse", - "properties": { - "dataPurposeAnnotations": { - "description": "A list of detected purposes in the privacy policy.", - "items": { - "$ref": "PolicyPurposeOfUseAnnotation" - }, - "type": "array" - }, - "dataTypeAnnotations": { - "description": "A list of detected data types in the privacy policy.", - "items": { - "$ref": "PolicyDataTypeAnnotation" - }, - "type": "array" - }, - "htmlContent": { - "description": "HTML content for the privacy policy page. The byte offsets in each annotated section will match this content.", - "type": "string" - }, - "lastUpdatedDateInfo": { - "$ref": "LastUpdatedDate", - "description": "Information about the date when the privacy policy was last updated." - }, - "sectionAnnotations": { - "description": "A list of detected topics in the privacy policy.", - "items": { - "$ref": "PolicySectionAnnotation" - }, - "type": "array" - } - }, - "type": "object" - }, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", "properties": {}, "type": "object" }, - "Date": { - "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp", - "id": "Date", - "properties": { - "day": { - "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", - "format": "int32", - "type": "integer" - }, - "month": { - "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", - "format": "int32", - "type": "integer" - }, - "year": { - "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", - "format": "int32", - "type": "integer" - } - }, - "type": "object" - }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", "properties": {}, "type": "object" }, - "FindPrivacyPolicyResponse": { - "description": "Response containing the analyzed privacy policy for the FindPrivacyPolicy method.", - "id": "FindPrivacyPolicyResponse", - "properties": { - "privacyPolicy": { - "description": "Resource name of the PrivacyPolicy that was found.", - "type": "string" - } - }, - "type": "object" - }, "GoogleChecksAccountV1alphaApp": { "description": "Represents an app in Checks.", "id": "GoogleChecksAccountV1alphaApp", @@ -1878,31 +1631,6 @@ }, "type": "object" }, - "LastUpdatedDate": { - "description": "Information about the date when the privacy policy was last updated.", - "id": "LastUpdatedDate", - "properties": { - "endOffset": { - "description": "Byte offsets for the end of the date text inside the full text.", - "format": "int64", - "type": "string" - }, - "lastUpdatedDate": { - "$ref": "Date", - "description": "Date when the privacy policy was last updated." - }, - "startOffset": { - "description": "Byte offsets for the start of the date text inside the full text.", - "format": "int64", - "type": "string" - }, - "textContent": { - "description": "The bytes of actual text content in the section. Note: - This will correspond to the whole sentence that includes the date. - This field might contain HTML and it is not sanitized.", - "type": "string" - } - }, - "type": "object" - }, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "ListOperationsResponse", @@ -1956,303 +1684,6 @@ }, "type": "object" }, - "PolicyDataTypeAnnotation": { - "id": "PolicyDataTypeAnnotation", - "properties": { - "dataType": { - "description": "Type of the data mentioned in the policy.", - "enum": [ - "DATA_TYPE_UNSPECIFIED", - "CONTACT_INFO_NAME", - "CONTACT_INFO_EMAIL_ADDRESS", - "CONTACT_INFO_PHONE_NUMBER", - "CONTACT_INFO_MAILING_ADDRESS", - "CONTACT_INFO_OTHER", - "IDENTITY_INFO_OTHER", - "USER_CONTENT_EMAIL_MESSAGES", - "USER_CONTENT_TEXT_MESSAGES", - "USER_CONTENT_OTHER_IN_APP_MESSAGES", - "USER_CONTENT_PHOTOS", - "USER_CONTENT_VIDEOS", - "USER_CONTENT_MUSIC_FILES", - "USER_CONTENT_VOICE_OR_SOUND_RECORDINGS", - "USER_CONTENT_OTHER_AUDIO_FILES", - "USER_CONTENT_FILES_AND_DOCS", - "USER_CONTENT_GAMEPLAY_DATA", - "USER_CONTENT_CUSTOMER_SUPPORT", - "COOKIES_AND_TRACKING_ELEMENTS", - "BROWSING_HISTORY", - "SEARCH_HISTORY", - "PURCHASE_HISTORY", - "PRODUCT_INTERACTION", - "USER_GENERATED_CONTENT_OTHER", - "IN_APP_ACTIONS_OTHER", - "ADVERTISING", - "APP_CRASH_LOGS", - "APP_DIAGNOSTICS", - "APP_PERFORMANCE_OTHER", - "USER_IDENTIFIERS", - "DEVICE_IDENTIFIERS", - "IP_ADDRESS", - "CONTACTS", - "AUTHENTICATION_DATA", - "CALENDAR_EVENTS_OR_NOTES", - "HEALTH", - "FITNESS", - "LOCATION_PRECISE", - "LOCATION_COARSE", - "LOCATION_GENERAL", - "APPS_ON_DEVICE", - "FINANCIAL_PAYMENT_INFO", - "FINANCIAL_CREDIT_INFO", - "FINANCIAL_OTHER", - "PERSONAL_INFO_RACE_AND_ETHNICITY", - "PERSONAL_INFO_POLITICAL_OR_RELIGIOUS_BELIEFS", - "PERSONAL_INFO_SEXUAL_ORIENTATION", - "PERSONAL_INFO_OTHER", - "GENERIC_PERSONAL_INFORMATION", - "UNSPECIFIED_INFORMATION", - "OTHER_DATA" - ], - "enumDescriptions": [ - "Default value. Checks cannot determine specific data type.", - "Data type on the privacy policy describing Contact Info: name.", - "Data type on the privacy policy describing Contact Info: email address.", - "Data type on the privacy policy describing Contact Info: phone number.", - "Data type on the privacy policy describing Contact Info: mailing address.", - "Data type on the privacy policy describing Contact Info: other.", - "Data type on the privacy policy describing Identity Info: other.", - "Data type on the privacy policy describing User Content: email messages.", - "Data type on the privacy policy describing User Content: text messages.", - "Data type on the privacy policy describing User Content: other in-app messages.", - "Data type on the privacy policy describing User Content: photos.", - "Data type on the privacy policy describing User Content: videos.", - "Data type on the privacy policy describing User Content: music files.", - "Data type on the privacy policy describing User Content: voice or sound recordings.", - "Data type on the privacy policy describing User Content: other audio files.", - "Data type on the privacy policy describing User Content: files or documents.", - "Data type on the privacy policy describing User Content: gameplay data.", - "Data type on the privacy policy describing User Content: customer support.", - "Data type on the privacy policy describing Cookies and other tracking elements, e.g. web beacons.", - "Data type on the privacy policy describing Browsing History.", - "Data type on the privacy policy describing Search History.", - "Data type on the privacy policy describing Purchase History.", - "Data type on the privacy policy describing Product Interaction data.", - "Data type on the privacy policy describing other User Generated Content.", - "Data type on the privacy policy describing other In App Actions.", - "Data type on the privacy policy describing Advertising data.", - "Data type on the privacy policy describing Crash Logs data.", - "Data type on the privacy policy describing App Diagnostics data.", - "Data type on the privacy policy describing other App Performance data.", - "Data type on the privacy policy describing User or account-level IDs.", - "Data type on the privacy policy describing device-level IDs.", - "Data type on the privacy policy describing IP Addresses.", - "Data type on the privacy policy describing Contacts data.", - "Data type on the privacy policy describing Authentication data, e.g. passwords.", - "Data type on the privacy policy describing Calendar events or notes.", - "Data type on the privacy policy describing Health data.", - "Data type on the privacy policy describing Fitness data.", - "Data type on the privacy policy describing Precise Location data.", - "Data type on the privacy policy describing Coarse Location data.", - "Data type on the privacy policy describing general Location data, without specifying precise or coarse.", - "Data type on the privacy policy describing Apps on Device.", - "Data type on the privacy policy describing Financial Payment info.", - "Data type on the privacy policy describing Financial Credit info.", - "Data type on the privacy policy describing Financial other data.", - "Data type on the privacy policy describing a user’s race or ethnicity.", - "Data type on the privacy policy describing a user’s political or religious beliefs.", - "Data type on the privacy policy describing a user’s sexual orientation.", - "Data type on the privacy policy describing Personal Info other.", - "Data type on the privacy policy describing generic personal information, e.g. \"we collection your personal information.\"", - "Data type on the privacy policy describing information in general with no speicific type, e.g. \"we collect information you voluntarily provide.\"", - "Data type on the privacy policy describing specific types of data that are not covered by others labels, or ambiguous cases where no clear type exists, e.g. \"we collect your movement data,\" which could be location, fitness, or even product interaction, depending on the context." - ], - "type": "string" - }, - "endOffset": { - "description": "Byte offsets for the end of the data type sentence inside the full text.", - "format": "int64", - "type": "string" - }, - "score": { - "description": "Score given by the model representing how confident it was regarding this `text_content` being of `data_type`.", - "format": "float", - "type": "number" - }, - "startOffset": { - "description": "Byte offsets for the start of the data type sentence inside the full text.", - "format": "int64", - "type": "string" - }, - "textContent": { - "description": "Actual text content in the section. This makes it much easier to consume the information. NOTE: This field might contain HTML and does not guarantee a SafeHtml security contract go/safehtmltypecontracts#safehtml.", - "type": "string" - } - }, - "type": "object" - }, - "PolicyPurposeOfUseAnnotation": { - "id": "PolicyPurposeOfUseAnnotation", - "properties": { - "endOffset": { - "description": "Byte offsets for the end of the purpose of use sentence inside the full text.", - "format": "int64", - "type": "string" - }, - "purposeOfUse": { - "description": "Purpose of use mentioned in the policy.", - "enum": [ - "PURPOSE_OF_USE_UNSPECIFIED", - "APP_FUNCTIONALITY", - "APP_DIAGNOSTICS_AND_PERFORMANCE", - "FRAUD_PREVENTION_AND_SECURITY", - "PRODUCT_PERSONALIZATION", - "ANALYTICS", - "DEVELOPERS_COMMUNICATION_AND_MARKETING", - "THIRD_PARTY_ADVERTISING", - "GENERAL_ADVERTISING", - "LEGAL_COMPLIANCE", - "MERGERS_AND_ACQUISITIONS", - "OTHER_SPECIFIED_PURPOSE", - "NO_PURPOSE_MENTIONED" - ], - "enumDescriptions": [ - "Default value. Checks cannot determine specific purpose of use.", - "Data is used for general app functions, or interface with the user, e.g. customer support.", - "Data is used for minimizing app crashes, enabling scalability and performance, etc.", - "Data is used for fraud prevention, protecting user accounts, or other security purposes.", - "Data is used for personalizing/customizing what the user sees.", - "Data is used for evaluating user behavior, measuring audience size, etc.", - "Data is used for sending marketing communications directly to your users, notifications, reminders, or update notices.", - "Data is used by a third-party to display ads in the app (or elsewhere).", - "Data is used for displaying ads in the app, or sharing data with entities who display ads.", - "Data is used for compliance with legal obligations, e.g., regulations, government data requests, law enforcement requests in general, etc.", - "If a company/organization merges or is acquired it transfers users' information to another company/organization.", - "Any other specific purposes that are not listed above.", - "The purpose of use is not explicitly stated or unclear." - ], - "type": "string" - }, - "score": { - "description": "Score given by the model representing how confident it was regarding this `text_content` being of `purpose_of_use`.", - "format": "float", - "type": "number" - }, - "startOffset": { - "description": "Byte offsets for the start of the purpose of use sentence inside the full text.", - "format": "int64", - "type": "string" - }, - "textContent": { - "description": "The bytes of actual text content in the sentence that mentions the purpose of use. This makes it much easier to consume the information.", - "type": "string" - } - }, - "type": "object" - }, - "PolicySectionAnnotation": { - "id": "PolicySectionAnnotation", - "properties": { - "endOffset": { - "description": "Byte offsets for the end of the section inside the full text.", - "format": "int64", - "type": "string" - }, - "score": { - "description": "Score given by the model representing how confident it was regarding this `text_content` being of `section_type`.", - "format": "float", - "type": "number" - }, - "sectionType": { - "description": "Detected type of the high-level topic in the policy.", - "enum": [ - "SECTION_TYPE_UNSPECIFIED", - "FIRST_PARTY_COLLECTION", - "FIRST_PARTY_USE", - "THIRD_PARTY_SHARING", - "CHILDREN_RELATED", - "DATA_RETENTION", - "PRIVACY_CONTACT", - "RIGHT_TO_DELETE", - "RIGHT_TO_RESTRICT_PROCESSING", - "RIGHT_TO_ACCESS", - "RIGHT_TO_RECTIFICATION", - "RIGHT_TO_KNOW_ABOUT_SELLING", - "RIGHT_TO_KNOW_ABOUT_SHARING", - "RIGHT_TO_OPT_OUT_FROM_SELLING", - "RIGHT_TO_OPT_OUT_FROM_SHARING", - "METHOD_TO_OPT_OUT_FROM_SELLING_OR_SHARING", - "AUTHORIZED_AGENT", - "CCPA_CPRA_REFERENCE", - "DATA_PROTECTION_OFFICER", - "DATA_CONTROLLER", - "DO_NOT_SELL", - "GDPR_REFERENCE", - "LAWFUL_LEGAL_BASIS", - "PRIVACY_SHIELD", - "RIGHT_TO_LODGE_A_COMPLAINT", - "TRANSFER_MECHANISMS", - "NO_CHILDREN_DATA_COLLECTION", - "NO_CHILDREN_DATA_SHARING", - "CHILDREN_INFORMATION_PUBLICITY", - "PARENTS_METHOD_OF_INFORMATION_DELETION", - "PARENTS_METHOD_TO_INFORMATION_REVIEW", - "PARENTS_METHOD_TO_STOP_FURTHER_INFORMATION_COLLECTION_USE", - "PARENTS_RIGHT_TO_INFORMATION_DELETION", - "PARENTS_RIGHT_TO_INFORMATION_REVIEW", - "PARENTS_RIGHT_TO_STOP_FURTHER_INFORMATION_COLLECTION_USE" - ], - "enumDescriptions": [ - "Default value. Checks cannot determine specific section type.", - "Section of the privacy policy describes 1st party collection practices.", - "Section of the privacy policy describes 1st party use practices.", - "Section of the privacy policy describes 3rd party sharing practices.", - "Section of the privacy policy describing content related to children.", - "Section of the privacy policy describes data retention practices.", - "Section of the privacy policy references privacy contact information.", - "Section of the privacy policy describes users' right of data deletion.", - "Section of the privacy policy about users' right to restrict processing.", - "Section of the privacy policy about users' right to access their data.", - "Section of the privacy policy about users' right to correct inaccuracies.", - "Section of the privacy policy about users' right to know about information selling.", - "Section of the privacy policy about users' right to know about information sharing.", - "Section of the privacy policy about users' right to opt out from information selling.", - "Section of the privacy policy about users' right to opt out from information sharing.", - "Section of the privacy policy about the method to opt out from selling or sharing.", - "Section of the privacy policy about the authorized agent designated by user.", - "Section of the privacy policy about the mentions of the CCPA or CPRA.", - "Section of the privacy policy about the mentions of data protection officer (DPO).", - "Section of the privacy policy about the mentions of a data controller.", - "Section of the privacy policy stating that the company does not sell data in general (or as defined by the CCPA), without exceptions.", - "Section of the privacy policy about the mentions of the GDPR (General Data Protection Regulation).", - "Section of the privacy policy about lawful/legal basis for data processing.", - "Section of the privacy policy about the Privacy Shielf framework.", - "Section of the privacy policy about the right to lodge a complaint with a supervisory authority.", - "Section of the privacy policy about transfer mechanisms of data from the EU to third countries", - "Section of the privacy policy stating that the company does not collect data from children.", - "Section of the privacy policy stating that the company does not share data from children.", - "Section of the privacy policy stating whether the app allows children to make their personal information publicly available.", - "Section of the privacy policy stating to parents/caregivers/guardians how they can request the deletion of their child's personal information.", - "Section of the privacy policy stating to parents/guardians/caregivers how they can review their child's personal information.", - "Section of the privacy policy stating to parents/caregivers/guardians how they can stop the further collection or use of their child's personal information.", - "Section of the privacy policy stating that a parent/caregiver/guardian has the right to request the deletion of their child's personal. information.", - "Section of the privacy policy stating to parents/guardians/caregivers that they have a right to review their child's personal information.", - "Section of the privacy policy stating to parents/caregivers/guardians that they have the right to stop the further collection or use of their child's personal information." - ], - "type": "string" - }, - "startOffset": { - "description": "Byte offsets for the start of the section inside the full text.", - "format": "int64", - "type": "string" - }, - "textContent": { - "description": "Actual text content in the section.", - "type": "string" - } - }, - "type": "object" - }, "Status": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "id": "Status", diff --git a/checks/v1alpha/checks-gen.go b/checks/v1alpha/checks-gen.go index 5ad50699e40..b1e94053f85 100644 --- a/checks/v1alpha/checks-gen.go +++ b/checks/v1alpha/checks-gen.go @@ -122,8 +122,6 @@ func New(client *http.Client) (*Service, error) { s := &Service{client: client, BasePath: basePath} s.Accounts = NewAccountsService(s) s.Media = NewMediaService(s) - s.Privacypolicy = NewPrivacypolicyService(s) - s.Projects = NewProjectsService(s) return s, nil } @@ -135,10 +133,6 @@ type Service struct { Accounts *AccountsService Media *MediaService - - Privacypolicy *PrivacypolicyService - - Projects *ProjectsService } func (s *Service) userAgent() string { @@ -202,188 +196,11 @@ type MediaService struct { s *Service } -func NewPrivacypolicyService(s *Service) *PrivacypolicyService { - rs := &PrivacypolicyService{s: s} - return rs -} - -type PrivacypolicyService struct { - s *Service -} - -func NewProjectsService(s *Service) *ProjectsService { - rs := &ProjectsService{s: s} - rs.Privacypolicy = NewProjectsPrivacypolicyService(s) - return rs -} - -type ProjectsService struct { - s *Service - - Privacypolicy *ProjectsPrivacypolicyService -} - -func NewProjectsPrivacypolicyService(s *Service) *ProjectsPrivacypolicyService { - rs := &ProjectsPrivacypolicyService{s: s} - rs.Operations = NewProjectsPrivacypolicyOperationsService(s) - return rs -} - -type ProjectsPrivacypolicyService struct { - s *Service - - Operations *ProjectsPrivacypolicyOperationsService -} - -func NewProjectsPrivacypolicyOperationsService(s *Service) *ProjectsPrivacypolicyOperationsService { - rs := &ProjectsPrivacypolicyOperationsService{s: s} - return rs -} - -type ProjectsPrivacypolicyOperationsService struct { - s *Service -} - -// AnalyzePrivacyPolicyRequest: Request for the AnalyzePrivacyPolicy -// method. -type AnalyzePrivacyPolicyRequest struct { - // PrivacyPolicyPageContent: The HTML content of the privacy policy. - // This is useful if you'd like to manage the crawling and rendering of - // the privacy policy. - PrivacyPolicyPageContent string `json:"privacyPolicyPageContent,omitempty"` - - // PrivacyPolicyUri: The URI that points to the web page for the privacy - // policy. - PrivacyPolicyUri string `json:"privacyPolicyUri,omitempty"` - - // ForceSendFields is a list of field names (e.g. - // "PrivacyPolicyPageContent") 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. "PrivacyPolicyPageContent") - // 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 *AnalyzePrivacyPolicyRequest) MarshalJSON() ([]byte, error) { - type NoMethod AnalyzePrivacyPolicyRequest - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - -// AnalyzePrivacyPolicyResponse: Response containing the analyzed -// privacy policy for the AnalyzePrivacyPolicy method. -type AnalyzePrivacyPolicyResponse struct { - // DataPurposeAnnotations: A list of detected purposes in the privacy - // policy. - DataPurposeAnnotations []*PolicyPurposeOfUseAnnotation `json:"dataPurposeAnnotations,omitempty"` - - // DataTypeAnnotations: A list of detected data types in the privacy - // policy. - DataTypeAnnotations []*PolicyDataTypeAnnotation `json:"dataTypeAnnotations,omitempty"` - - // HtmlContent: HTML content for the privacy policy page. The byte - // offsets in each annotated section will match this content. - HtmlContent string `json:"htmlContent,omitempty"` - - // LastUpdatedDateInfo: Information about the date when the privacy - // policy was last updated. - LastUpdatedDateInfo *LastUpdatedDate `json:"lastUpdatedDateInfo,omitempty"` - - // SectionAnnotations: A list of detected topics in the privacy policy. - SectionAnnotations []*PolicySectionAnnotation `json:"sectionAnnotations,omitempty"` - - // ServerResponse contains the HTTP response code and headers from the - // server. - googleapi.ServerResponse `json:"-"` - - // ForceSendFields is a list of field names (e.g. - // "DataPurposeAnnotations") 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. "DataPurposeAnnotations") - // 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 *AnalyzePrivacyPolicyResponse) MarshalJSON() ([]byte, error) { - type NoMethod AnalyzePrivacyPolicyResponse - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - // CancelOperationRequest: The request message for // Operations.CancelOperation. type CancelOperationRequest struct { } -// Date: Represents a whole or partial calendar date, such as a -// birthday. The time of day and time zone are either specified -// elsewhere or are insignificant. The date is relative to the Gregorian -// Calendar. This can represent one of the following: * A full date, -// with non-zero year, month, and day values. * A month and day, with a -// zero year (for example, an anniversary). * A year on its own, with a -// zero month and a zero day. * A year and month, with a zero day (for -// example, a credit card expiration date). Related types: * -// google.type.TimeOfDay * google.type.DateTime * -// google.protobuf.Timestamp -type Date struct { - // Day: Day of a month. Must be from 1 to 31 and valid for the year and - // month, or 0 to specify a year by itself or a year and month where the - // day isn't significant. - Day int64 `json:"day,omitempty"` - - // Month: Month of a year. Must be from 1 to 12, or 0 to specify a year - // without a month and day. - Month int64 `json:"month,omitempty"` - - // Year: Year of the date. Must be from 1 to 9999, or 0 to specify a - // date without a year. - Year int64 `json:"year,omitempty"` - - // ForceSendFields is a list of field names (e.g. "Day") 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. "Day") 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 *Date) MarshalJSON() ([]byte, error) { - type NoMethod Date - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - // Empty: A generic empty message that you can re-use to avoid defining // duplicated empty messages in your APIs. A typical example is to use // it as the request or the response type of an API method. For @@ -395,35 +212,6 @@ type Empty struct { googleapi.ServerResponse `json:"-"` } -// FindPrivacyPolicyResponse: Response containing the analyzed privacy -// policy for the FindPrivacyPolicy method. -type FindPrivacyPolicyResponse struct { - // PrivacyPolicy: Resource name of the PrivacyPolicy that was found. - PrivacyPolicy string `json:"privacyPolicy,omitempty"` - - // ForceSendFields is a list of field names (e.g. "PrivacyPolicy") 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. "PrivacyPolicy") 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 *FindPrivacyPolicyResponse) MarshalJSON() ([]byte, error) { - type NoMethod FindPrivacyPolicyResponse - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - // GoogleChecksAccountV1alphaApp: Represents an app in Checks. type GoogleChecksAccountV1alphaApp struct { // Name: The resource name of the app. Example: `accounts/123/apps/456` @@ -2266,48 +2054,6 @@ func (s *GoogleChecksReportV1alphaSdk) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// LastUpdatedDate: Information about the date when the privacy policy -// was last updated. -type LastUpdatedDate struct { - // EndOffset: Byte offsets for the end of the date text inside the full - // text. - EndOffset int64 `json:"endOffset,omitempty,string"` - - // LastUpdatedDate: Date when the privacy policy was last updated. - LastUpdatedDate *Date `json:"lastUpdatedDate,omitempty"` - - // StartOffset: Byte offsets for the start of the date text inside the - // full text. - StartOffset int64 `json:"startOffset,omitempty,string"` - - // TextContent: The bytes of actual text content in the section. Note: - - // This will correspond to the whole sentence that includes the date. - - // This field might contain HTML and it is not sanitized. - TextContent string `json:"textContent,omitempty"` - - // ForceSendFields is a list of field names (e.g. "EndOffset") 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. "EndOffset") 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 *LastUpdatedDate) MarshalJSON() ([]byte, error) { - type NoMethod LastUpdatedDate - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - // ListOperationsResponse: The response message for // Operations.ListOperations. type ListOperationsResponse struct { @@ -2407,400 +2153,6 @@ func (s *Operation) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -type PolicyDataTypeAnnotation struct { - // DataType: Type of the data mentioned in the policy. - // - // Possible values: - // "DATA_TYPE_UNSPECIFIED" - Default value. Checks cannot determine - // specific data type. - // "CONTACT_INFO_NAME" - Data type on the privacy policy describing - // Contact Info: name. - // "CONTACT_INFO_EMAIL_ADDRESS" - Data type on the privacy policy - // describing Contact Info: email address. - // "CONTACT_INFO_PHONE_NUMBER" - Data type on the privacy policy - // describing Contact Info: phone number. - // "CONTACT_INFO_MAILING_ADDRESS" - Data type on the privacy policy - // describing Contact Info: mailing address. - // "CONTACT_INFO_OTHER" - Data type on the privacy policy describing - // Contact Info: other. - // "IDENTITY_INFO_OTHER" - Data type on the privacy policy describing - // Identity Info: other. - // "USER_CONTENT_EMAIL_MESSAGES" - Data type on the privacy policy - // describing User Content: email messages. - // "USER_CONTENT_TEXT_MESSAGES" - Data type on the privacy policy - // describing User Content: text messages. - // "USER_CONTENT_OTHER_IN_APP_MESSAGES" - Data type on the privacy - // policy describing User Content: other in-app messages. - // "USER_CONTENT_PHOTOS" - Data type on the privacy policy describing - // User Content: photos. - // "USER_CONTENT_VIDEOS" - Data type on the privacy policy describing - // User Content: videos. - // "USER_CONTENT_MUSIC_FILES" - Data type on the privacy policy - // describing User Content: music files. - // "USER_CONTENT_VOICE_OR_SOUND_RECORDINGS" - Data type on the privacy - // policy describing User Content: voice or sound recordings. - // "USER_CONTENT_OTHER_AUDIO_FILES" - Data type on the privacy policy - // describing User Content: other audio files. - // "USER_CONTENT_FILES_AND_DOCS" - Data type on the privacy policy - // describing User Content: files or documents. - // "USER_CONTENT_GAMEPLAY_DATA" - Data type on the privacy policy - // describing User Content: gameplay data. - // "USER_CONTENT_CUSTOMER_SUPPORT" - Data type on the privacy policy - // describing User Content: customer support. - // "COOKIES_AND_TRACKING_ELEMENTS" - Data type on the privacy policy - // describing Cookies and other tracking elements, e.g. web beacons. - // "BROWSING_HISTORY" - Data type on the privacy policy describing - // Browsing History. - // "SEARCH_HISTORY" - Data type on the privacy policy describing - // Search History. - // "PURCHASE_HISTORY" - Data type on the privacy policy describing - // Purchase History. - // "PRODUCT_INTERACTION" - Data type on the privacy policy describing - // Product Interaction data. - // "USER_GENERATED_CONTENT_OTHER" - Data type on the privacy policy - // describing other User Generated Content. - // "IN_APP_ACTIONS_OTHER" - Data type on the privacy policy describing - // other In App Actions. - // "ADVERTISING" - Data type on the privacy policy describing - // Advertising data. - // "APP_CRASH_LOGS" - Data type on the privacy policy describing Crash - // Logs data. - // "APP_DIAGNOSTICS" - Data type on the privacy policy describing App - // Diagnostics data. - // "APP_PERFORMANCE_OTHER" - Data type on the privacy policy - // describing other App Performance data. - // "USER_IDENTIFIERS" - Data type on the privacy policy describing - // User or account-level IDs. - // "DEVICE_IDENTIFIERS" - Data type on the privacy policy describing - // device-level IDs. - // "IP_ADDRESS" - Data type on the privacy policy describing IP - // Addresses. - // "CONTACTS" - Data type on the privacy policy describing Contacts - // data. - // "AUTHENTICATION_DATA" - Data type on the privacy policy describing - // Authentication data, e.g. passwords. - // "CALENDAR_EVENTS_OR_NOTES" - Data type on the privacy policy - // describing Calendar events or notes. - // "HEALTH" - Data type on the privacy policy describing Health data. - // "FITNESS" - Data type on the privacy policy describing Fitness - // data. - // "LOCATION_PRECISE" - Data type on the privacy policy describing - // Precise Location data. - // "LOCATION_COARSE" - Data type on the privacy policy describing - // Coarse Location data. - // "LOCATION_GENERAL" - Data type on the privacy policy describing - // general Location data, without specifying precise or coarse. - // "APPS_ON_DEVICE" - Data type on the privacy policy describing Apps - // on Device. - // "FINANCIAL_PAYMENT_INFO" - Data type on the privacy policy - // describing Financial Payment info. - // "FINANCIAL_CREDIT_INFO" - Data type on the privacy policy - // describing Financial Credit info. - // "FINANCIAL_OTHER" - Data type on the privacy policy describing - // Financial other data. - // "PERSONAL_INFO_RACE_AND_ETHNICITY" - Data type on the privacy - // policy describing a user’s race or ethnicity. - // "PERSONAL_INFO_POLITICAL_OR_RELIGIOUS_BELIEFS" - Data type on the - // privacy policy describing a user’s political or religious beliefs. - // "PERSONAL_INFO_SEXUAL_ORIENTATION" - Data type on the privacy - // policy describing a user’s sexual orientation. - // "PERSONAL_INFO_OTHER" - Data type on the privacy policy describing - // Personal Info other. - // "GENERIC_PERSONAL_INFORMATION" - Data type on the privacy policy - // describing generic personal information, e.g. "we collection your - // personal information." - // "UNSPECIFIED_INFORMATION" - Data type on the privacy policy - // describing information in general with no speicific type, e.g. "we - // collect information you voluntarily provide." - // "OTHER_DATA" - Data type on the privacy policy describing specific - // types of data that are not covered by others labels, or ambiguous - // cases where no clear type exists, e.g. "we collect your movement - // data," which could be location, fitness, or even product interaction, - // depending on the context. - DataType string `json:"dataType,omitempty"` - - // EndOffset: Byte offsets for the end of the data type sentence inside - // the full text. - EndOffset int64 `json:"endOffset,omitempty,string"` - - // Score: Score given by the model representing how confident it was - // regarding this `text_content` being of `data_type`. - Score float64 `json:"score,omitempty"` - - // StartOffset: Byte offsets for the start of the data type sentence - // inside the full text. - StartOffset int64 `json:"startOffset,omitempty,string"` - - // TextContent: Actual text content in the section. This makes it much - // easier to consume the information. NOTE: This field might contain - // HTML and does not guarantee a SafeHtml security contract - // go/safehtmltypecontracts#safehtml. - TextContent string `json:"textContent,omitempty"` - - // ForceSendFields is a list of field names (e.g. "DataType") 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. "DataType") 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 *PolicyDataTypeAnnotation) MarshalJSON() ([]byte, error) { - type NoMethod PolicyDataTypeAnnotation - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - -func (s *PolicyDataTypeAnnotation) UnmarshalJSON(data []byte) error { - type NoMethod PolicyDataTypeAnnotation - var s1 struct { - Score gensupport.JSONFloat64 `json:"score"` - *NoMethod - } - s1.NoMethod = (*NoMethod)(s) - if err := json.Unmarshal(data, &s1); err != nil { - return err - } - s.Score = float64(s1.Score) - return nil -} - -type PolicyPurposeOfUseAnnotation struct { - // EndOffset: Byte offsets for the end of the purpose of use sentence - // inside the full text. - EndOffset int64 `json:"endOffset,omitempty,string"` - - // PurposeOfUse: Purpose of use mentioned in the policy. - // - // Possible values: - // "PURPOSE_OF_USE_UNSPECIFIED" - Default value. Checks cannot - // determine specific purpose of use. - // "APP_FUNCTIONALITY" - Data is used for general app functions, or - // interface with the user, e.g. customer support. - // "APP_DIAGNOSTICS_AND_PERFORMANCE" - Data is used for minimizing app - // crashes, enabling scalability and performance, etc. - // "FRAUD_PREVENTION_AND_SECURITY" - Data is used for fraud - // prevention, protecting user accounts, or other security purposes. - // "PRODUCT_PERSONALIZATION" - Data is used for - // personalizing/customizing what the user sees. - // "ANALYTICS" - Data is used for evaluating user behavior, measuring - // audience size, etc. - // "DEVELOPERS_COMMUNICATION_AND_MARKETING" - Data is used for sending - // marketing communications directly to your users, notifications, - // reminders, or update notices. - // "THIRD_PARTY_ADVERTISING" - Data is used by a third-party to - // display ads in the app (or elsewhere). - // "GENERAL_ADVERTISING" - Data is used for displaying ads in the app, - // or sharing data with entities who display ads. - // "LEGAL_COMPLIANCE" - Data is used for compliance with legal - // obligations, e.g., regulations, government data requests, law - // enforcement requests in general, etc. - // "MERGERS_AND_ACQUISITIONS" - If a company/organization merges or is - // acquired it transfers users' information to another - // company/organization. - // "OTHER_SPECIFIED_PURPOSE" - Any other specific purposes that are - // not listed above. - // "NO_PURPOSE_MENTIONED" - The purpose of use is not explicitly - // stated or unclear. - PurposeOfUse string `json:"purposeOfUse,omitempty"` - - // Score: Score given by the model representing how confident it was - // regarding this `text_content` being of `purpose_of_use`. - Score float64 `json:"score,omitempty"` - - // StartOffset: Byte offsets for the start of the purpose of use - // sentence inside the full text. - StartOffset int64 `json:"startOffset,omitempty,string"` - - // TextContent: The bytes of actual text content in the sentence that - // mentions the purpose of use. This makes it much easier to consume the - // information. - TextContent string `json:"textContent,omitempty"` - - // ForceSendFields is a list of field names (e.g. "EndOffset") 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. "EndOffset") 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 *PolicyPurposeOfUseAnnotation) MarshalJSON() ([]byte, error) { - type NoMethod PolicyPurposeOfUseAnnotation - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - -func (s *PolicyPurposeOfUseAnnotation) UnmarshalJSON(data []byte) error { - type NoMethod PolicyPurposeOfUseAnnotation - var s1 struct { - Score gensupport.JSONFloat64 `json:"score"` - *NoMethod - } - s1.NoMethod = (*NoMethod)(s) - if err := json.Unmarshal(data, &s1); err != nil { - return err - } - s.Score = float64(s1.Score) - return nil -} - -type PolicySectionAnnotation struct { - // EndOffset: Byte offsets for the end of the section inside the full - // text. - EndOffset int64 `json:"endOffset,omitempty,string"` - - // Score: Score given by the model representing how confident it was - // regarding this `text_content` being of `section_type`. - Score float64 `json:"score,omitempty"` - - // SectionType: Detected type of the high-level topic in the policy. - // - // Possible values: - // "SECTION_TYPE_UNSPECIFIED" - Default value. Checks cannot determine - // specific section type. - // "FIRST_PARTY_COLLECTION" - Section of the privacy policy describes - // 1st party collection practices. - // "FIRST_PARTY_USE" - Section of the privacy policy describes 1st - // party use practices. - // "THIRD_PARTY_SHARING" - Section of the privacy policy describes 3rd - // party sharing practices. - // "CHILDREN_RELATED" - Section of the privacy policy describing - // content related to children. - // "DATA_RETENTION" - Section of the privacy policy describes data - // retention practices. - // "PRIVACY_CONTACT" - Section of the privacy policy references - // privacy contact information. - // "RIGHT_TO_DELETE" - Section of the privacy policy describes users' - // right of data deletion. - // "RIGHT_TO_RESTRICT_PROCESSING" - Section of the privacy policy - // about users' right to restrict processing. - // "RIGHT_TO_ACCESS" - Section of the privacy policy about users' - // right to access their data. - // "RIGHT_TO_RECTIFICATION" - Section of the privacy policy about - // users' right to correct inaccuracies. - // "RIGHT_TO_KNOW_ABOUT_SELLING" - Section of the privacy policy about - // users' right to know about information selling. - // "RIGHT_TO_KNOW_ABOUT_SHARING" - Section of the privacy policy about - // users' right to know about information sharing. - // "RIGHT_TO_OPT_OUT_FROM_SELLING" - Section of the privacy policy - // about users' right to opt out from information selling. - // "RIGHT_TO_OPT_OUT_FROM_SHARING" - Section of the privacy policy - // about users' right to opt out from information sharing. - // "METHOD_TO_OPT_OUT_FROM_SELLING_OR_SHARING" - Section of the - // privacy policy about the method to opt out from selling or sharing. - // "AUTHORIZED_AGENT" - Section of the privacy policy about the - // authorized agent designated by user. - // "CCPA_CPRA_REFERENCE" - Section of the privacy policy about the - // mentions of the CCPA or CPRA. - // "DATA_PROTECTION_OFFICER" - Section of the privacy policy about the - // mentions of data protection officer (DPO). - // "DATA_CONTROLLER" - Section of the privacy policy about the - // mentions of a data controller. - // "DO_NOT_SELL" - Section of the privacy policy stating that the - // company does not sell data in general (or as defined by the CCPA), - // without exceptions. - // "GDPR_REFERENCE" - Section of the privacy policy about the mentions - // of the GDPR (General Data Protection Regulation). - // "LAWFUL_LEGAL_BASIS" - Section of the privacy policy about - // lawful/legal basis for data processing. - // "PRIVACY_SHIELD" - Section of the privacy policy about the Privacy - // Shielf framework. - // "RIGHT_TO_LODGE_A_COMPLAINT" - Section of the privacy policy about - // the right to lodge a complaint with a supervisory authority. - // "TRANSFER_MECHANISMS" - Section of the privacy policy about - // transfer mechanisms of data from the EU to third countries - // "NO_CHILDREN_DATA_COLLECTION" - Section of the privacy policy - // stating that the company does not collect data from children. - // "NO_CHILDREN_DATA_SHARING" - Section of the privacy policy stating - // that the company does not share data from children. - // "CHILDREN_INFORMATION_PUBLICITY" - Section of the privacy policy - // stating whether the app allows children to make their personal - // information publicly available. - // "PARENTS_METHOD_OF_INFORMATION_DELETION" - Section of the privacy - // policy stating to parents/caregivers/guardians how they can request - // the deletion of their child's personal information. - // "PARENTS_METHOD_TO_INFORMATION_REVIEW" - Section of the privacy - // policy stating to parents/guardians/caregivers how they can review - // their child's personal information. - // "PARENTS_METHOD_TO_STOP_FURTHER_INFORMATION_COLLECTION_USE" - - // Section of the privacy policy stating to parents/caregivers/guardians - // how they can stop the further collection or use of their child's - // personal information. - // "PARENTS_RIGHT_TO_INFORMATION_DELETION" - Section of the privacy - // policy stating that a parent/caregiver/guardian has the right to - // request the deletion of their child's personal. information. - // "PARENTS_RIGHT_TO_INFORMATION_REVIEW" - Section of the privacy - // policy stating to parents/guardians/caregivers that they have a right - // to review their child's personal information. - // "PARENTS_RIGHT_TO_STOP_FURTHER_INFORMATION_COLLECTION_USE" - - // Section of the privacy policy stating to parents/caregivers/guardians - // that they have the right to stop the further collection or use of - // their child's personal information. - SectionType string `json:"sectionType,omitempty"` - - // StartOffset: Byte offsets for the start of the section inside the - // full text. - StartOffset int64 `json:"startOffset,omitempty,string"` - - // TextContent: Actual text content in the section. - TextContent string `json:"textContent,omitempty"` - - // ForceSendFields is a list of field names (e.g. "EndOffset") 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. "EndOffset") 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 *PolicySectionAnnotation) MarshalJSON() ([]byte, error) { - type NoMethod PolicySectionAnnotation - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - -func (s *PolicySectionAnnotation) UnmarshalJSON(data []byte) error { - type NoMethod PolicySectionAnnotation - var s1 struct { - Score gensupport.JSONFloat64 `json:"score"` - *NoMethod - } - s1.NoMethod = (*NoMethod)(s) - if err := json.Unmarshal(data, &s1); err != nil { - return err - } - s.Score = float64(s1.Score) - return nil -} - // Status: The `Status` type defines a logical error model that is // suitable for different programming environments, including REST APIs // and RPC APIs. It is used by gRPC (https://github.com/grpc). Each @@ -4612,898 +3964,3 @@ func (c *MediaUploadCall) Do(opts ...googleapi.CallOption) (*Operation, error) { // } } - -// method id "checks.privacypolicy.analyze": - -type PrivacypolicyAnalyzeCall struct { - s *Service - analyzeprivacypolicyrequest *AnalyzePrivacyPolicyRequest - urlParams_ gensupport.URLParams - ctx_ context.Context - header_ http.Header -} - -// Analyze: Performs a synchronous analysis of a privacy policy, where -// the policy content is mapped to privacy categories, data types, and -// purposes. -func (r *PrivacypolicyService) Analyze(analyzeprivacypolicyrequest *AnalyzePrivacyPolicyRequest) *PrivacypolicyAnalyzeCall { - c := &PrivacypolicyAnalyzeCall{s: r.s, urlParams_: make(gensupport.URLParams)} - c.analyzeprivacypolicyrequest = analyzeprivacypolicyrequest - 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 *PrivacypolicyAnalyzeCall) Fields(s ...googleapi.Field) *PrivacypolicyAnalyzeCall { - 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 *PrivacypolicyAnalyzeCall) Context(ctx context.Context) *PrivacypolicyAnalyzeCall { - 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 *PrivacypolicyAnalyzeCall) Header() http.Header { - if c.header_ == nil { - c.header_ = make(http.Header) - } - return c.header_ -} - -func (c *PrivacypolicyAnalyzeCall) 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.analyzeprivacypolicyrequest) - 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, "v1alpha/privacypolicy:analyze") - 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 "checks.privacypolicy.analyze" call. -// Exactly one of *AnalyzePrivacyPolicyResponse or error will be -// non-nil. Any non-2xx status code is an error. Response headers are in -// either *AnalyzePrivacyPolicyResponse.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 *PrivacypolicyAnalyzeCall) Do(opts ...googleapi.CallOption) (*AnalyzePrivacyPolicyResponse, 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, gensupport.WrapError(&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, gensupport.WrapError(err) - } - ret := &AnalyzePrivacyPolicyResponse{ - 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": "Performs a synchronous analysis of a privacy policy, where the policy content is mapped to privacy categories, data types, and purposes.", - // "flatPath": "v1alpha/privacypolicy:analyze", - // "httpMethod": "POST", - // "id": "checks.privacypolicy.analyze", - // "parameterOrder": [], - // "parameters": {}, - // "path": "v1alpha/privacypolicy:analyze", - // "request": { - // "$ref": "AnalyzePrivacyPolicyRequest" - // }, - // "response": { - // "$ref": "AnalyzePrivacyPolicyResponse" - // } - // } - -} - -// method id "checks.projects.privacypolicy.operations.cancel": - -type ProjectsPrivacypolicyOperationsCancelCall struct { - s *Service - name string - urlParams_ gensupport.URLParams - ctx_ context.Context - header_ http.Header -} - -// Cancel: Starts asynchronous cancellation on a long-running operation. -// The server makes a best effort to cancel the operation, but success -// is not guaranteed. If the server doesn't support this method, it -// returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use -// Operations.GetOperation or other methods to check whether the -// cancellation succeeded or whether the operation completed despite -// cancellation. On successful cancellation, the operation is not -// deleted; instead, it becomes an operation with an Operation.error -// value with a google.rpc.Status.code of 1, corresponding to -// `Code.CANCELLED`. -// -// - name: The name of the operation resource to be cancelled. -func (r *ProjectsPrivacypolicyOperationsService) Cancel(name string) *ProjectsPrivacypolicyOperationsCancelCall { - c := &ProjectsPrivacypolicyOperationsCancelCall{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 *ProjectsPrivacypolicyOperationsCancelCall) Fields(s ...googleapi.Field) *ProjectsPrivacypolicyOperationsCancelCall { - 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 *ProjectsPrivacypolicyOperationsCancelCall) Context(ctx context.Context) *ProjectsPrivacypolicyOperationsCancelCall { - 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 *ProjectsPrivacypolicyOperationsCancelCall) Header() http.Header { - if c.header_ == nil { - c.header_ = make(http.Header) - } - return c.header_ -} - -func (c *ProjectsPrivacypolicyOperationsCancelCall) 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, "v1alpha/{+name}:cancel") - urls += "?" + c.urlParams_.Encode() - req, err := http.NewRequest("POST", 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 "checks.projects.privacypolicy.operations.cancel" call. -// Exactly one of *Empty or error will be non-nil. Any non-2xx status -// code is an error. Response headers are in either -// *Empty.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 *ProjectsPrivacypolicyOperationsCancelCall) Do(opts ...googleapi.CallOption) (*Empty, 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, gensupport.WrapError(&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, gensupport.WrapError(err) - } - ret := &Empty{ - 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": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", - // "flatPath": "v1alpha/projects/{projectsId}/privacypolicy/operations/{operationsId}:cancel", - // "httpMethod": "POST", - // "id": "checks.projects.privacypolicy.operations.cancel", - // "parameterOrder": [ - // "name" - // ], - // "parameters": { - // "name": { - // "description": "The name of the operation resource to be cancelled.", - // "location": "path", - // "pattern": "^projects/[^/]+/privacypolicy/operations/[^/]+$", - // "required": true, - // "type": "string" - // } - // }, - // "path": "v1alpha/{+name}:cancel", - // "response": { - // "$ref": "Empty" - // } - // } - -} - -// method id "checks.projects.privacypolicy.operations.delete": - -type ProjectsPrivacypolicyOperationsDeleteCall struct { - s *Service - name string - urlParams_ gensupport.URLParams - ctx_ context.Context - header_ http.Header -} - -// Delete: Deletes a long-running operation. This method indicates that -// the client is no longer interested in the operation result. It does -// not cancel the operation. If the server doesn't support this method, -// it returns `google.rpc.Code.UNIMPLEMENTED`. -// -// - name: The name of the operation resource to be deleted. -func (r *ProjectsPrivacypolicyOperationsService) Delete(name string) *ProjectsPrivacypolicyOperationsDeleteCall { - c := &ProjectsPrivacypolicyOperationsDeleteCall{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 *ProjectsPrivacypolicyOperationsDeleteCall) Fields(s ...googleapi.Field) *ProjectsPrivacypolicyOperationsDeleteCall { - 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 *ProjectsPrivacypolicyOperationsDeleteCall) Context(ctx context.Context) *ProjectsPrivacypolicyOperationsDeleteCall { - 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 *ProjectsPrivacypolicyOperationsDeleteCall) Header() http.Header { - if c.header_ == nil { - c.header_ = make(http.Header) - } - return c.header_ -} - -func (c *ProjectsPrivacypolicyOperationsDeleteCall) 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, "v1alpha/{+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 "checks.projects.privacypolicy.operations.delete" call. -// Exactly one of *Empty or error will be non-nil. Any non-2xx status -// code is an error. Response headers are in either -// *Empty.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 *ProjectsPrivacypolicyOperationsDeleteCall) Do(opts ...googleapi.CallOption) (*Empty, 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, gensupport.WrapError(&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, gensupport.WrapError(err) - } - ret := &Empty{ - 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 long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - // "flatPath": "v1alpha/projects/{projectsId}/privacypolicy/operations/{operationsId}", - // "httpMethod": "DELETE", - // "id": "checks.projects.privacypolicy.operations.delete", - // "parameterOrder": [ - // "name" - // ], - // "parameters": { - // "name": { - // "description": "The name of the operation resource to be deleted.", - // "location": "path", - // "pattern": "^projects/[^/]+/privacypolicy/operations/[^/]+$", - // "required": true, - // "type": "string" - // } - // }, - // "path": "v1alpha/{+name}", - // "response": { - // "$ref": "Empty" - // } - // } - -} - -// method id "checks.projects.privacypolicy.operations.get": - -type ProjectsPrivacypolicyOperationsGetCall struct { - s *Service - name string - urlParams_ gensupport.URLParams - ifNoneMatch_ string - ctx_ context.Context - header_ http.Header -} - -// Get: Gets the latest state of a long-running operation. Clients can -// use this method to poll the operation result at intervals as -// recommended by the API service. -// -// - name: The name of the operation resource. -func (r *ProjectsPrivacypolicyOperationsService) Get(name string) *ProjectsPrivacypolicyOperationsGetCall { - c := &ProjectsPrivacypolicyOperationsGetCall{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 *ProjectsPrivacypolicyOperationsGetCall) Fields(s ...googleapi.Field) *ProjectsPrivacypolicyOperationsGetCall { - c.urlParams_.Set("fields", googleapi.CombineFields(s)) - return c -} - -// IfNoneMatch sets the optional parameter which makes the operation -// fail if the object's ETag matches the given value. This is useful for -// getting updates only after the object has changed since the last -// request. Use googleapi.IsNotModified to check whether the response -// error from Do is the result of In-None-Match. -func (c *ProjectsPrivacypolicyOperationsGetCall) IfNoneMatch(entityTag string) *ProjectsPrivacypolicyOperationsGetCall { - c.ifNoneMatch_ = entityTag - 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 *ProjectsPrivacypolicyOperationsGetCall) Context(ctx context.Context) *ProjectsPrivacypolicyOperationsGetCall { - 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 *ProjectsPrivacypolicyOperationsGetCall) Header() http.Header { - if c.header_ == nil { - c.header_ = make(http.Header) - } - return c.header_ -} - -func (c *ProjectsPrivacypolicyOperationsGetCall) 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()) - if c.ifNoneMatch_ != "" { - reqHeaders.Set("If-None-Match", c.ifNoneMatch_) - } - var body io.Reader = nil - c.urlParams_.Set("alt", alt) - c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+name}") - urls += "?" + c.urlParams_.Encode() - req, err := http.NewRequest("GET", 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 "checks.projects.privacypolicy.operations.get" call. -// Exactly one of *Operation or error will be non-nil. Any non-2xx -// status code is an error. Response headers are in either -// *Operation.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 *ProjectsPrivacypolicyOperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, 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, gensupport.WrapError(&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, gensupport.WrapError(err) - } - ret := &Operation{ - 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": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", - // "flatPath": "v1alpha/projects/{projectsId}/privacypolicy/operations/{operationsId}", - // "httpMethod": "GET", - // "id": "checks.projects.privacypolicy.operations.get", - // "parameterOrder": [ - // "name" - // ], - // "parameters": { - // "name": { - // "description": "The name of the operation resource.", - // "location": "path", - // "pattern": "^projects/[^/]+/privacypolicy/operations/[^/]+$", - // "required": true, - // "type": "string" - // } - // }, - // "path": "v1alpha/{+name}", - // "response": { - // "$ref": "Operation" - // } - // } - -} - -// method id "checks.projects.privacypolicy.operations.list": - -type ProjectsPrivacypolicyOperationsListCall struct { - s *Service - name string - urlParams_ gensupport.URLParams - ifNoneMatch_ string - ctx_ context.Context - header_ http.Header -} - -// List: Lists operations that match the specified filter in the -// request. If the server doesn't support this method, it returns -// `UNIMPLEMENTED`. -// -// - name: The name of the operation's parent resource. -func (r *ProjectsPrivacypolicyOperationsService) List(name string) *ProjectsPrivacypolicyOperationsListCall { - c := &ProjectsPrivacypolicyOperationsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} - c.name = name - return c -} - -// Filter sets the optional parameter "filter": The standard list -// filter. -func (c *ProjectsPrivacypolicyOperationsListCall) Filter(filter string) *ProjectsPrivacypolicyOperationsListCall { - c.urlParams_.Set("filter", filter) - return c -} - -// PageSize sets the optional parameter "pageSize": The standard list -// page size. -func (c *ProjectsPrivacypolicyOperationsListCall) PageSize(pageSize int64) *ProjectsPrivacypolicyOperationsListCall { - c.urlParams_.Set("pageSize", fmt.Sprint(pageSize)) - return c -} - -// PageToken sets the optional parameter "pageToken": The standard list -// page token. -func (c *ProjectsPrivacypolicyOperationsListCall) PageToken(pageToken string) *ProjectsPrivacypolicyOperationsListCall { - c.urlParams_.Set("pageToken", pageToken) - 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 *ProjectsPrivacypolicyOperationsListCall) Fields(s ...googleapi.Field) *ProjectsPrivacypolicyOperationsListCall { - c.urlParams_.Set("fields", googleapi.CombineFields(s)) - return c -} - -// IfNoneMatch sets the optional parameter which makes the operation -// fail if the object's ETag matches the given value. This is useful for -// getting updates only after the object has changed since the last -// request. Use googleapi.IsNotModified to check whether the response -// error from Do is the result of In-None-Match. -func (c *ProjectsPrivacypolicyOperationsListCall) IfNoneMatch(entityTag string) *ProjectsPrivacypolicyOperationsListCall { - c.ifNoneMatch_ = entityTag - 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 *ProjectsPrivacypolicyOperationsListCall) Context(ctx context.Context) *ProjectsPrivacypolicyOperationsListCall { - 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 *ProjectsPrivacypolicyOperationsListCall) Header() http.Header { - if c.header_ == nil { - c.header_ = make(http.Header) - } - return c.header_ -} - -func (c *ProjectsPrivacypolicyOperationsListCall) 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()) - if c.ifNoneMatch_ != "" { - reqHeaders.Set("If-None-Match", c.ifNoneMatch_) - } - var body io.Reader = nil - c.urlParams_.Set("alt", alt) - c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "v1alpha/{+name}/privacypolicy/operations") - urls += "?" + c.urlParams_.Encode() - req, err := http.NewRequest("GET", 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 "checks.projects.privacypolicy.operations.list" call. -// Exactly one of *ListOperationsResponse or error will be non-nil. Any -// non-2xx status code is an error. Response headers are in either -// *ListOperationsResponse.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 *ProjectsPrivacypolicyOperationsListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, 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, gensupport.WrapError(&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, gensupport.WrapError(err) - } - ret := &ListOperationsResponse{ - 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": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", - // "flatPath": "v1alpha/projects/{projectsId}/privacypolicy/operations", - // "httpMethod": "GET", - // "id": "checks.projects.privacypolicy.operations.list", - // "parameterOrder": [ - // "name" - // ], - // "parameters": { - // "filter": { - // "description": "The standard list filter.", - // "location": "query", - // "type": "string" - // }, - // "name": { - // "description": "The name of the operation's parent resource.", - // "location": "path", - // "pattern": "^projects/[^/]+$", - // "required": true, - // "type": "string" - // }, - // "pageSize": { - // "description": "The standard list page size.", - // "format": "int32", - // "location": "query", - // "type": "integer" - // }, - // "pageToken": { - // "description": "The standard list page token.", - // "location": "query", - // "type": "string" - // } - // }, - // "path": "v1alpha/{+name}/privacypolicy/operations", - // "response": { - // "$ref": "ListOperationsResponse" - // } - // } - -} - -// Pages invokes f for each page of results. -// A non-nil error returned from f will halt the iteration. -// The provided context supersedes any context provided to the Context method. -func (c *ProjectsPrivacypolicyOperationsListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error { - c.ctx_ = ctx - defer c.PageToken(c.urlParams_.Get("pageToken")) // reset paging to original point - for { - x, err := c.Do() - if err != nil { - return err - } - if err := f(x); err != nil { - return err - } - if x.NextPageToken == "" { - return nil - } - c.PageToken(x.NextPageToken) - } -} - -// method id "checks.projects.privacypolicy.operations.wait": - -type ProjectsPrivacypolicyOperationsWaitCall struct { - s *Service - name string - urlParams_ gensupport.URLParams - ctx_ context.Context - header_ http.Header -} - -// Wait: Waits until the specified long-running operation is done or -// reaches at most a specified timeout, returning the latest state. If -// the operation is already done, the latest state is immediately -// returned. If the timeout specified is greater than the default -// HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does -// not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. -// Note that this method is on a best-effort basis. It may return the -// latest state before the specified timeout (including immediately), -// meaning even an immediate response is no guarantee that the operation -// is done. -// -// - name: The name of the operation resource to wait on. -func (r *ProjectsPrivacypolicyOperationsService) Wait(name string) *ProjectsPrivacypolicyOperationsWaitCall { - c := &ProjectsPrivacypolicyOperationsWaitCall{s: r.s, urlParams_: make(gensupport.URLParams)} - c.name = name - return c -} - -// Timeout sets the optional parameter "timeout": The maximum duration -// to wait before timing out. If left blank, the wait will be at most -// the time permitted by the underlying HTTP/RPC protocol. If RPC -// context deadline is also specified, the shorter one will be used. -func (c *ProjectsPrivacypolicyOperationsWaitCall) Timeout(timeout string) *ProjectsPrivacypolicyOperationsWaitCall { - c.urlParams_.Set("timeout", timeout) - 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 *ProjectsPrivacypolicyOperationsWaitCall) Fields(s ...googleapi.Field) *ProjectsPrivacypolicyOperationsWaitCall { - 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 *ProjectsPrivacypolicyOperationsWaitCall) Context(ctx context.Context) *ProjectsPrivacypolicyOperationsWaitCall { - 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 *ProjectsPrivacypolicyOperationsWaitCall) Header() http.Header { - if c.header_ == nil { - c.header_ = make(http.Header) - } - return c.header_ -} - -func (c *ProjectsPrivacypolicyOperationsWaitCall) 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, "v1alpha/{+name}:wait") - urls += "?" + c.urlParams_.Encode() - req, err := http.NewRequest("POST", 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 "checks.projects.privacypolicy.operations.wait" call. -// Exactly one of *Operation or error will be non-nil. Any non-2xx -// status code is an error. Response headers are in either -// *Operation.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 *ProjectsPrivacypolicyOperationsWaitCall) Do(opts ...googleapi.CallOption) (*Operation, 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, gensupport.WrapError(&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, gensupport.WrapError(err) - } - ret := &Operation{ - 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": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - // "flatPath": "v1alpha/projects/{projectsId}/privacypolicy/operations/{operationsId}:wait", - // "httpMethod": "POST", - // "id": "checks.projects.privacypolicy.operations.wait", - // "parameterOrder": [ - // "name" - // ], - // "parameters": { - // "name": { - // "description": "The name of the operation resource to wait on.", - // "location": "path", - // "pattern": "^projects/[^/]+/privacypolicy/operations/[^/]+$", - // "required": true, - // "type": "string" - // }, - // "timeout": { - // "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - // "format": "google-duration", - // "location": "query", - // "type": "string" - // } - // }, - // "path": "v1alpha/{+name}:wait", - // "response": { - // "$ref": "Operation" - // } - // } - -} diff --git a/firebase/v1beta1/firebase-api.json b/firebase/v1beta1/firebase-api.json index 4733a572b84..4976e343f1c 100644 --- a/firebase/v1beta1/firebase-api.json +++ b/firebase/v1beta1/firebase-api.json @@ -790,9 +790,11 @@ } }, "availableLocations": { + "deprecated": true, "methods": { "list": { - "description": "Lists the valid Google Cloud Platform (GCP) resource locations for the specified Project (including a FirebaseProject). One of these locations can be selected as the Project's [_default_ GCP resource location](https://firebase.google.com/docs/projects/locations), which is the geographical location where the Project's resources, such as Cloud Firestore, will be provisioned by default. However, if the default GCP resource location has already been set for the Project, then this setting cannot be changed. This call checks for any possible [location restrictions](https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations) for the specified Project and, thus, might return a subset of all possible GCP resource locations. To list all GCP resource locations (regardless of any restrictions), call the endpoint without specifying a unique project identifier (that is, `/v1beta1/{parent=projects/-}/listAvailableLocations`). To call `ListAvailableLocations` with a specified project, a member must be at minimum a Viewer of the Project. Calls without a specified project do not require any specific project permissions.", + "deprecated": true, + "description": "**DEPRECATED.** _Instead, use the applicable resource-specific REST API (or associated documentation, as needed) to determine valid locations for each resource used in your Project._ Lists the valid Google Cloud Platform (GCP) resource locations for the specified Project (including a FirebaseProject). One of these locations can be selected as the Project's [_default_ GCP resource location](https://firebase.google.com/docs/projects/locations), which is the geographical location where the Project's resources, such as Cloud Firestore, will be provisioned by default. However, if the default GCP resource location has already been set for the Project, then this setting cannot be changed. This call checks for any possible [location restrictions](https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations) for the specified Project and, thus, might return a subset of all possible GCP resource locations. To list all GCP resource locations (regardless of any restrictions), call the endpoint without specifying a unique project identifier (that is, `/v1beta1/{parent=projects/-}/listAvailableLocations`). To call `ListAvailableLocations` with a specified project, a member must be at minimum a Viewer of the Project. Calls without a specified project do not require any specific project permissions.", "flatPath": "v1beta1/projects/{projectsId}/availableLocations", "httpMethod": "GET", "id": "firebase.projects.availableLocations.list", @@ -833,9 +835,11 @@ } }, "defaultLocation": { + "deprecated": true, "methods": { "finalize": { - "description": "Sets the default Google Cloud Platform (GCP) resource location for the specified FirebaseProject. This method creates an App Engine application with a [default Cloud Storage bucket](https://cloud.google.com/appengine/docs/standard/python/googlecloudstorageclient/setting-up-cloud-storage#activating_a_cloud_storage_bucket), located in the specified [`locationId`](#body.request_body.FIELDS.location_id). This location must be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). After the default GCP resource location is finalized, or if it was already set, it cannot be changed. The default GCP resource location for the specified `FirebaseProject` might already be set because either the underlying GCP `Project` already has an App Engine application or `FinalizeDefaultLocation` was previously called with a specified `locationId`. Any new calls to `FinalizeDefaultLocation` with a *different* specified `locationId` will return a 409 error. The result of this call is an [`Operation`](../../v1beta1/operations), which can be used to track the provisioning process. The [`response`](../../v1beta1/operations#Operation.FIELDS.response) type of the `Operation` is google.protobuf.Empty. The `Operation` can be polled by its `name` using GetOperation until `done` is true. When `done` is true, the `Operation` has either succeeded or failed. If the `Operation` has succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) will be set to a google.protobuf.Empty; if the `Operation` has failed, its `error` will be set to a google.rpc.Status. The `Operation` is automatically deleted after completion, so there is no need to call DeleteOperation. All fields listed in the [request body](#request-body) are required. To call `FinalizeDefaultLocation`, a member must be an Owner of the Project.", + "deprecated": true, + "description": "**DEPRECATED.** _Instead, use the applicable resource-specific REST API to set the location for each resource used in your Project._ Sets the default Google Cloud Platform (GCP) resource location for the specified FirebaseProject. This method creates an App Engine application with a [default Cloud Storage bucket](https://cloud.google.com/appengine/docs/standard/python/googlecloudstorageclient/setting-up-cloud-storage#activating_a_cloud_storage_bucket), located in the specified [`locationId`](#body.request_body.FIELDS.location_id). This location must be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). After the default GCP resource location is finalized, or if it was already set, it cannot be changed. The default GCP resource location for the specified `FirebaseProject` might already be set because either the underlying GCP `Project` already has an App Engine application or `FinalizeDefaultLocation` was previously called with a specified `locationId`. Any new calls to `FinalizeDefaultLocation` with a *different* specified `locationId` will return a 409 error. The result of this call is an [`Operation`](../../v1beta1/operations), which can be used to track the provisioning process. The [`response`](../../v1beta1/operations#Operation.FIELDS.response) type of the `Operation` is google.protobuf.Empty. The `Operation` can be polled by its `name` using GetOperation until `done` is true. When `done` is true, the `Operation` has either succeeded or failed. If the `Operation` has succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) will be set to a google.protobuf.Empty; if the `Operation` has failed, its `error` will be set to a google.rpc.Status. The `Operation` is automatically deleted after completion, so there is no need to call DeleteOperation. All fields listed in the [request body](#request-body) are required. To call `FinalizeDefaultLocation`, a member must be an Owner of the Project.", "flatPath": "v1beta1/projects/{projectsId}/defaultLocation:finalize", "httpMethod": "POST", "id": "firebase.projects.defaultLocation.finalize", @@ -1320,7 +1324,7 @@ } } }, - "revision": "20230804", + "revision": "20230907", "rootUrl": "https://firebase.googleapis.com/", "schemas": { "AddFirebaseRequest": { @@ -1352,11 +1356,12 @@ "id": "AdminSdkConfig", "properties": { "databaseURL": { - "description": "The default Firebase Realtime Database URL.", + "deprecated": true, "type": "string" }, "locationId": { - "description": "The ID of the Project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). This field is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.", + "deprecated": true, + "description": "**DEPRECATED.** _Instead, use product-specific REST APIs to find the location of resources._ The ID of the Project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). This field is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.", "type": "string" }, "projectId": { @@ -1364,7 +1369,8 @@ "type": "string" }, "storageBucket": { - "description": "The default Cloud Storage for Firebase storage bucket name.", + "deprecated": true, + "description": "**DEPRECATED.** _Instead, find the default Cloud Storage for Firebase bucket using the [list endpoint](https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets/list) within the Cloud Storage for Firebase REST API. Note that the default bucket for the Project might not yet be provisioned, so the return might not contain a default bucket._ The default Cloud Storage for Firebase storage bucket name.", "type": "string" } }, @@ -1496,26 +1502,30 @@ "type": "object" }, "DefaultResources": { - "description": "The default resources associated with the Project.", + "deprecated": true, + "description": "**DEPRECATED.** _Auto-provisioning of these resources is changing, so this object no longer reliably provides information about the resources within the Project. Instead, retrieve information about each resource directly from its resource-specific API._ The default auto-provisioned resources associated with the Project.", "id": "DefaultResources", "properties": { "hostingSite": { - "description": "Output only. The default Firebase Hosting site name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Hosting site in another project (learn more about creating non-default, [additional sites](https://firebase.google.com/docs/hosting/multisites)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Hosting site name. For example, if your `projectId` is `myproject123`, your default Hosting site name might be: `myproject123-a5c16`", + "deprecated": true, + "description": "Output only. **DEPRECATED.** _Instead, find the default Firebase Hosting site name using the [ListSites](https://firebase.google.com/docs/reference/hosting/rest/v1beta1/projects.sites/list) within the Firebase Hosting REST API. Note that the default site for the Project might not yet be provisioned, so the return might not contain a default site._ The default Firebase Hosting site name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Hosting site in another project (learn more about creating non-default, [additional sites](https://firebase.google.com/docs/hosting/multisites)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Hosting site name. For example, if your `projectId` is `myproject123`, your default Hosting site name might be: `myproject123-a5c16`", "readOnly": true, "type": "string" }, "locationId": { - "description": "Output only. The ID of the Project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). This field is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.", + "deprecated": true, + "description": "Output only. **DEPRECATED.** _Instead, use product-specific REST APIs to find the location of resources._ The ID of the Project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). This field is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.", "readOnly": true, "type": "string" }, "realtimeDatabaseInstance": { - "description": "Output only. The default Firebase Realtime Database instance name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Realtime Database instance in another project (learn more about [database sharding](https://firebase.google.com/docs/database/usage/sharding)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Realtime Database instance name. For example, if your `projectId` is `myproject123`, your default database instance name might be: `myproject123-a5c16`", + "deprecated": true, + "description": "Output only. **DEPRECATED.** _Instead, find the default Firebase Realtime Database instance name using the [list endpoint](https://firebase.google.com/docs/reference/rest/database/database-management/rest/v1beta/projects.locations.instances/list) within the Firebase Realtime Database REST API. Note that the default instance for the Project might not yet be provisioned, so the return might not contain a default instance._ The default Firebase Realtime Database instance name, in the format: PROJECT_ID Though rare, your `projectId` might already be used as the name for an existing Realtime Database instance in another project (learn more about [database sharding](https://firebase.google.com/docs/database/usage/sharding)). In these cases, your `projectId` is appended with a hyphen then five alphanumeric characters to create your default Realtime Database instance name. For example, if your `projectId` is `myproject123`, your default database instance name might be: `myproject123-a5c16`", "readOnly": true, "type": "string" }, "storageBucket": { - "description": "Output only. The default Cloud Storage for Firebase storage bucket, in the format: PROJECT_ID.appspot.com", + "description": "Output only. **DEPRECATED.** _Instead, find the default Cloud Storage for Firebase bucket using the [list endpoint](https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets/list) within the Cloud Storage for Firebase REST API. Note that the default bucket for the Project might not yet be provisioned, so the return might not contain a default bucket._ The default Cloud Storage for Firebase storage bucket, in the format: PROJECT_ID.appspot.com", "readOnly": true, "type": "string" } @@ -1529,6 +1539,7 @@ "type": "object" }, "FinalizeDefaultLocationRequest": { + "deprecated": true, "id": "FinalizeDefaultLocationRequest", "properties": { "locationId": { @@ -1640,7 +1651,8 @@ }, "resources": { "$ref": "DefaultResources", - "description": "Output only. The default Firebase resources associated with the Project.", + "deprecated": true, + "description": "Output only. **DEPRECATED.** _Auto-provisioning of these resources is changing, so this object no longer reliably provides information about the Project. Instead, retrieve information about each resource directly from its resource-specific API._ The default Firebase resources associated with the Project.", "readOnly": true }, "state": { @@ -1761,6 +1773,7 @@ "type": "object" }, "ListAvailableLocationsResponse": { + "deprecated": true, "id": "ListAvailableLocationsResponse", "properties": { "locations": { @@ -1859,7 +1872,8 @@ "type": "object" }, "Location": { - "description": "A GCP resource location that can be selected for a FirebaseProject.", + "deprecated": true, + "description": "**DEPRECATED.** _This Location is no longer used to determine Firebase resource locations. Instead, consult product documentation to determine valid locations for each resource used in your Project._ A GCP resource location that can be selected for a FirebaseProject.", "id": "Location", "properties": { "features": { @@ -2306,11 +2320,13 @@ "type": "string" }, "databaseURL": { - "description": "The default Firebase Realtime Database URL.", + "deprecated": true, + "description": "**DEPRECATED.** _Instead, find the default Firebase Realtime Database instance name using the [list endpoint](https://firebase.google.com/docs/reference/rest/database/database-management/rest/v1beta/projects.locations.instances/list) within the Firebase Realtime Database REST API. Note that the default instance for the Project might not yet be provisioned, so the return might not contain a default instance._ The default Firebase Realtime Database URL.", "type": "string" }, "locationId": { - "description": "The ID of the Project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). This field is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.", + "deprecated": true, + "description": "**DEPRECATED.** _Instead, use product-specific REST APIs to find the location of resources._ The ID of the Project's default GCP resource location. The location is one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). This field is omitted if the default GCP resource location has not been finalized yet. To set a Project's default GCP resource location, call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you add Firebase resources to the Project.", "type": "string" }, "measurementId": { @@ -2326,7 +2342,8 @@ "type": "string" }, "storageBucket": { - "description": "The default Cloud Storage for Firebase storage bucket name.", + "deprecated": true, + "description": "**DEPRECATED.** _Instead, find the default Cloud Storage for Firebase bucket using the [list endpoint](https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets/list) within the Cloud Storage for Firebase REST API. Note that the default bucket for the Project might not yet be provisioned, so the return might not contain a default bucket._ The default Cloud Storage for Firebase storage bucket name.", "type": "string" } }, diff --git a/firebase/v1beta1/firebase-gen.go b/firebase/v1beta1/firebase-gen.go index eabc7b1dc6d..684c5f7ad00 100644 --- a/firebase/v1beta1/firebase-gen.go +++ b/firebase/v1beta1/firebase-gen.go @@ -345,11 +345,12 @@ func (s *AddGoogleAnalyticsRequest) MarshalJSON() ([]byte, error) { } type AdminSdkConfig struct { - // DatabaseURL: The default Firebase Realtime Database URL. DatabaseURL string `json:"databaseURL,omitempty"` - // LocationId: The ID of the Project's default GCP resource location. - // The location is one of the available GCP resource locations + // LocationId: **DEPRECATED.** _Instead, use product-specific REST APIs + // to find the location of resources._ The ID of the Project's default + // GCP resource location. The location is one of the available GCP + // resource locations // (https://firebase.google.com/docs/projects/locations). This field is // omitted if the default GCP resource location has not been finalized // yet. To set a Project's default GCP resource location, call @@ -363,8 +364,13 @@ type AdminSdkConfig struct { // generally be treated as a convenience alias to reference the Project. ProjectId string `json:"projectId,omitempty"` - // StorageBucket: The default Cloud Storage for Firebase storage bucket - // name. + // StorageBucket: **DEPRECATED.** _Instead, find the default Cloud + // Storage for Firebase bucket using the list endpoint + // (https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets/list) + // within the Cloud Storage for Firebase REST API. Note that the default + // bucket for the Project might not yet be provisioned, so the return + // might not contain a default bucket._ The default Cloud Storage for + // Firebase storage bucket name. StorageBucket string `json:"storageBucket,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -628,9 +634,19 @@ func (s *AndroidAppConfig) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// DefaultResources: The default resources associated with the Project. +// DefaultResources: **DEPRECATED.** _Auto-provisioning of these +// resources is changing, so this object no longer reliably provides +// information about the resources within the Project. Instead, retrieve +// information about each resource directly from its resource-specific +// API._ The default auto-provisioned resources associated with the +// Project. type DefaultResources struct { - // HostingSite: Output only. The default Firebase Hosting site name, in + // HostingSite: Output only. **DEPRECATED.** _Instead, find the default + // Firebase Hosting site name using the ListSites + // (https://firebase.google.com/docs/reference/hosting/rest/v1beta1/projects.sites/list) + // within the Firebase Hosting REST API. Note that the default site for + // the Project might not yet be provisioned, so the return might not + // contain a default site._ The default Firebase Hosting site name, in // the format: PROJECT_ID Though rare, your `projectId` might already be // used as the name for an existing Hosting site in another project // (learn more about creating non-default, additional sites @@ -641,8 +657,10 @@ type DefaultResources struct { // site name might be: `myproject123-a5c16` HostingSite string `json:"hostingSite,omitempty"` - // LocationId: Output only. The ID of the Project's default GCP resource - // location. The location is one of the available GCP resource locations + // LocationId: Output only. **DEPRECATED.** _Instead, use + // product-specific REST APIs to find the location of resources._ The ID + // of the Project's default GCP resource location. The location is one + // of the available GCP resource locations // (https://firebase.google.com/docs/projects/locations). This field is // omitted if the default GCP resource location has not been finalized // yet. To set a Project's default GCP resource location, call @@ -650,7 +668,13 @@ type DefaultResources struct { // after you add Firebase resources to the Project. LocationId string `json:"locationId,omitempty"` - // RealtimeDatabaseInstance: Output only. The default Firebase Realtime + // RealtimeDatabaseInstance: Output only. **DEPRECATED.** _Instead, find + // the default Firebase Realtime Database instance name using the list + // endpoint + // (https://firebase.google.com/docs/reference/rest/database/database-management/rest/v1beta/projects.locations.instances/list) + // within the Firebase Realtime Database REST API. Note that the default + // instance for the Project might not yet be provisioned, so the return + // might not contain a default instance._ The default Firebase Realtime // Database instance name, in the format: PROJECT_ID Though rare, your // `projectId` might already be used as the name for an existing // Realtime Database instance in another project (learn more about @@ -662,8 +686,13 @@ type DefaultResources struct { // your default database instance name might be: `myproject123-a5c16` RealtimeDatabaseInstance string `json:"realtimeDatabaseInstance,omitempty"` - // StorageBucket: Output only. The default Cloud Storage for Firebase - // storage bucket, in the format: PROJECT_ID.appspot.com + // StorageBucket: Output only. **DEPRECATED.** _Instead, find the + // default Cloud Storage for Firebase bucket using the list endpoint + // (https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets/list) + // within the Cloud Storage for Firebase REST API. Note that the default + // bucket for the Project might not yet be provisioned, so the return + // might not contain a default bucket._ The default Cloud Storage for + // Firebase storage bucket, in the format: PROJECT_ID.appspot.com StorageBucket string `json:"storageBucket,omitempty"` // ForceSendFields is a list of field names (e.g. "HostingSite") to @@ -877,8 +906,11 @@ type FirebaseProject struct { // Firebase or third-party services. ProjectNumber int64 `json:"projectNumber,omitempty,string"` - // Resources: Output only. The default Firebase resources associated - // with the Project. + // Resources: Output only. **DEPRECATED.** _Auto-provisioning of these + // resources is changing, so this object no longer reliably provides + // information about the Project. Instead, retrieve information about + // each resource directly from its resource-specific API._ The default + // Firebase resources associated with the Project. Resources *DefaultResources `json:"resources,omitempty"` // State: Output only. The lifecycle state of the Project. @@ -1333,7 +1365,10 @@ func (s *ListWebAppsResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// Location: A GCP resource location that can be selected for a +// Location: **DEPRECATED.** _This Location is no longer used to +// determine Firebase resource locations. Instead, consult product +// documentation to determine valid locations for each resource used in +// your Project._ A GCP resource location that can be selected for a // FirebaseProject. type Location struct { // Features: Products and services that are available in the GCP @@ -2173,11 +2208,19 @@ type WebAppConfig struct { // in the format: PROJECT_ID.firebaseapp.com AuthDomain string `json:"authDomain,omitempty"` - // DatabaseURL: The default Firebase Realtime Database URL. + // DatabaseURL: **DEPRECATED.** _Instead, find the default Firebase + // Realtime Database instance name using the list endpoint + // (https://firebase.google.com/docs/reference/rest/database/database-management/rest/v1beta/projects.locations.instances/list) + // within the Firebase Realtime Database REST API. Note that the default + // instance for the Project might not yet be provisioned, so the return + // might not contain a default instance._ The default Firebase Realtime + // Database URL. DatabaseURL string `json:"databaseURL,omitempty"` - // LocationId: The ID of the Project's default GCP resource location. - // The location is one of the available GCP resource locations + // LocationId: **DEPRECATED.** _Instead, use product-specific REST APIs + // to find the location of resources._ The ID of the Project's default + // GCP resource location. The location is one of the available GCP + // resource locations // (https://firebase.google.com/docs/projects/locations). This field is // omitted if the default GCP resource location has not been finalized // yet. To set a Project's default GCP resource location, call @@ -2209,8 +2252,13 @@ type WebAppConfig struct { // `FirebaseProject`. ProjectId string `json:"projectId,omitempty"` - // StorageBucket: The default Cloud Storage for Firebase storage bucket - // name. + // StorageBucket: **DEPRECATED.** _Instead, find the default Cloud + // Storage for Firebase bucket using the list endpoint + // (https://firebase.google.com/docs/reference/rest/storage/rest/v1beta/projects.buckets/list) + // within the Cloud Storage for Firebase REST API. Note that the default + // bucket for the Project might not yet be provisioned, so the return + // might not contain a default bucket._ The default Cloud Storage for + // Firebase storage bucket name. StorageBucket string `json:"storageBucket,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -5800,15 +5848,18 @@ type ProjectsAvailableLocationsListCall struct { header_ http.Header } -// List: Lists the valid Google Cloud Platform (GCP) resource locations -// for the specified Project (including a FirebaseProject). One of these -// locations can be selected as the Project's _default_ GCP resource -// location (https://firebase.google.com/docs/projects/locations), which -// is the geographical location where the Project's resources, such as -// Cloud Firestore, will be provisioned by default. However, if the -// default GCP resource location has already been set for the Project, -// then this setting cannot be changed. This call checks for any -// possible location restrictions +// List: **DEPRECATED.** _Instead, use the applicable resource-specific +// REST API (or associated documentation, as needed) to determine valid +// locations for each resource used in your Project._ Lists the valid +// Google Cloud Platform (GCP) resource locations for the specified +// Project (including a FirebaseProject). One of these locations can be +// selected as the Project's _default_ GCP resource location +// (https://firebase.google.com/docs/projects/locations), which is the +// geographical location where the Project's resources, such as Cloud +// Firestore, will be provisioned by default. However, if the default +// GCP resource location has already been set for the Project, then this +// setting cannot be changed. This call checks for any possible location +// restrictions // (https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations) // for the specified Project and, thus, might return a subset of all // possible GCP resource locations. To list all GCP resource locations @@ -5949,7 +6000,8 @@ func (c *ProjectsAvailableLocationsListCall) Do(opts ...googleapi.CallOption) (* } return ret, nil // { - // "description": "Lists the valid Google Cloud Platform (GCP) resource locations for the specified Project (including a FirebaseProject). One of these locations can be selected as the Project's [_default_ GCP resource location](https://firebase.google.com/docs/projects/locations), which is the geographical location where the Project's resources, such as Cloud Firestore, will be provisioned by default. However, if the default GCP resource location has already been set for the Project, then this setting cannot be changed. This call checks for any possible [location restrictions](https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations) for the specified Project and, thus, might return a subset of all possible GCP resource locations. To list all GCP resource locations (regardless of any restrictions), call the endpoint without specifying a unique project identifier (that is, `/v1beta1/{parent=projects/-}/listAvailableLocations`). To call `ListAvailableLocations` with a specified project, a member must be at minimum a Viewer of the Project. Calls without a specified project do not require any specific project permissions.", + // "deprecated": true, + // "description": "**DEPRECATED.** _Instead, use the applicable resource-specific REST API (or associated documentation, as needed) to determine valid locations for each resource used in your Project._ Lists the valid Google Cloud Platform (GCP) resource locations for the specified Project (including a FirebaseProject). One of these locations can be selected as the Project's [_default_ GCP resource location](https://firebase.google.com/docs/projects/locations), which is the geographical location where the Project's resources, such as Cloud Firestore, will be provisioned by default. However, if the default GCP resource location has already been set for the Project, then this setting cannot be changed. This call checks for any possible [location restrictions](https://cloud.google.com/resource-manager/docs/organization-policy/defining-locations) for the specified Project and, thus, might return a subset of all possible GCP resource locations. To list all GCP resource locations (regardless of any restrictions), call the endpoint without specifying a unique project identifier (that is, `/v1beta1/{parent=projects/-}/listAvailableLocations`). To call `ListAvailableLocations` with a specified project, a member must be at minimum a Viewer of the Project. Calls without a specified project do not require any specific project permissions.", // "flatPath": "v1beta1/projects/{projectsId}/availableLocations", // "httpMethod": "GET", // "id": "firebase.projects.availableLocations.list", @@ -6022,9 +6074,11 @@ type ProjectsDefaultLocationFinalizeCall struct { header_ http.Header } -// Finalize: Sets the default Google Cloud Platform (GCP) resource -// location for the specified FirebaseProject. This method creates an -// App Engine application with a default Cloud Storage bucket +// Finalize: **DEPRECATED.** _Instead, use the applicable +// resource-specific REST API to set the location for each resource used +// in your Project._ Sets the default Google Cloud Platform (GCP) +// resource location for the specified FirebaseProject. This method +// creates an App Engine application with a default Cloud Storage bucket // (https://cloud.google.com/appengine/docs/standard/python/googlecloudstorageclient/setting-up-cloud-storage#activating_a_cloud_storage_bucket), // located in the specified `locationId` // (#body.request_body.FIELDS.location_id). This location must be one of @@ -6155,7 +6209,8 @@ func (c *ProjectsDefaultLocationFinalizeCall) Do(opts ...googleapi.CallOption) ( } return ret, nil // { - // "description": "Sets the default Google Cloud Platform (GCP) resource location for the specified FirebaseProject. This method creates an App Engine application with a [default Cloud Storage bucket](https://cloud.google.com/appengine/docs/standard/python/googlecloudstorageclient/setting-up-cloud-storage#activating_a_cloud_storage_bucket), located in the specified [`locationId`](#body.request_body.FIELDS.location_id). This location must be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). After the default GCP resource location is finalized, or if it was already set, it cannot be changed. The default GCP resource location for the specified `FirebaseProject` might already be set because either the underlying GCP `Project` already has an App Engine application or `FinalizeDefaultLocation` was previously called with a specified `locationId`. Any new calls to `FinalizeDefaultLocation` with a *different* specified `locationId` will return a 409 error. The result of this call is an [`Operation`](../../v1beta1/operations), which can be used to track the provisioning process. The [`response`](../../v1beta1/operations#Operation.FIELDS.response) type of the `Operation` is google.protobuf.Empty. The `Operation` can be polled by its `name` using GetOperation until `done` is true. When `done` is true, the `Operation` has either succeeded or failed. If the `Operation` has succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) will be set to a google.protobuf.Empty; if the `Operation` has failed, its `error` will be set to a google.rpc.Status. The `Operation` is automatically deleted after completion, so there is no need to call DeleteOperation. All fields listed in the [request body](#request-body) are required. To call `FinalizeDefaultLocation`, a member must be an Owner of the Project.", + // "deprecated": true, + // "description": "**DEPRECATED.** _Instead, use the applicable resource-specific REST API to set the location for each resource used in your Project._ Sets the default Google Cloud Platform (GCP) resource location for the specified FirebaseProject. This method creates an App Engine application with a [default Cloud Storage bucket](https://cloud.google.com/appengine/docs/standard/python/googlecloudstorageclient/setting-up-cloud-storage#activating_a_cloud_storage_bucket), located in the specified [`locationId`](#body.request_body.FIELDS.location_id). This location must be one of the available [GCP resource locations](https://firebase.google.com/docs/projects/locations). After the default GCP resource location is finalized, or if it was already set, it cannot be changed. The default GCP resource location for the specified `FirebaseProject` might already be set because either the underlying GCP `Project` already has an App Engine application or `FinalizeDefaultLocation` was previously called with a specified `locationId`. Any new calls to `FinalizeDefaultLocation` with a *different* specified `locationId` will return a 409 error. The result of this call is an [`Operation`](../../v1beta1/operations), which can be used to track the provisioning process. The [`response`](../../v1beta1/operations#Operation.FIELDS.response) type of the `Operation` is google.protobuf.Empty. The `Operation` can be polled by its `name` using GetOperation until `done` is true. When `done` is true, the `Operation` has either succeeded or failed. If the `Operation` has succeeded, its [`response`](../../v1beta1/operations#Operation.FIELDS.response) will be set to a google.protobuf.Empty; if the `Operation` has failed, its `error` will be set to a google.rpc.Status. The `Operation` is automatically deleted after completion, so there is no need to call DeleteOperation. All fields listed in the [request body](#request-body) are required. To call `FinalizeDefaultLocation`, a member must be an Owner of the Project.", // "flatPath": "v1beta1/projects/{projectsId}/defaultLocation:finalize", // "httpMethod": "POST", // "id": "firebase.projects.defaultLocation.finalize", diff --git a/gmailpostmastertools/v1/gmailpostmastertools-api.json b/gmailpostmastertools/v1/gmailpostmastertools-api.json index 8aa1f4adcac..bbff732836c 100644 --- a/gmailpostmastertools/v1/gmailpostmastertools-api.json +++ b/gmailpostmastertools/v1/gmailpostmastertools-api.json @@ -265,7 +265,7 @@ } } }, - "revision": "20210114", + "revision": "20230907", "rootUrl": "https://gmailpostmastertools.googleapis.com/", "schemas": { "DeliveryError": { @@ -518,7 +518,17 @@ "type": "number" }, "userReportedSpamRatio": { - "description": "The ratio of user-report spam vs. email that was sent to the inbox. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).", + "description": "The ratio of user-report spam vs. email that was sent to the inbox. This is potentially inexact -- users may want to refer to the description of the interval fields userReportedSpamRatioLowerBound and userReportedSpamRatioUpperBound for more explicit accuracy guarantees. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).", + "format": "double", + "type": "number" + }, + "userReportedSpamRatioLowerBound": { + "description": "The lower bound of the confidence interval for the user reported spam ratio. If this field is set, then the value of userReportedSpamRatio is set to the midpoint of this interval and is thus inexact. However, the true ratio is guaranteed to be in between this lower bound and the corresponding upper bound 95% of the time. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).", + "format": "double", + "type": "number" + }, + "userReportedSpamRatioUpperBound": { + "description": "The upper bound of the confidence interval for the user reported spam ratio. If this field is set, then the value of userReportedSpamRatio is set to the midpoint of this interval and is thus inexact. However, the true ratio is guaranteed to be in between this upper bound and the corresponding lower bound 95% of the time. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).", "format": "double", "type": "number" } diff --git a/gmailpostmastertools/v1/gmailpostmastertools-gen.go b/gmailpostmastertools/v1/gmailpostmastertools-gen.go index 4728fb6f3b1..4a2088c5cd3 100644 --- a/gmailpostmastertools/v1/gmailpostmastertools-gen.go +++ b/gmailpostmastertools/v1/gmailpostmastertools-gen.go @@ -557,10 +557,31 @@ type TrafficStats struct { SpfSuccessRatio float64 `json:"spfSuccessRatio,omitempty"` // UserReportedSpamRatio: The ratio of user-report spam vs. email that - // was sent to the inbox. This metric only pertains to emails - // authenticated by DKIM (http://www.dkim.org/). + // was sent to the inbox. This is potentially inexact -- users may want + // to refer to the description of the interval fields + // userReportedSpamRatioLowerBound and userReportedSpamRatioUpperBound + // for more explicit accuracy guarantees. This metric only pertains to + // emails authenticated by DKIM (http://www.dkim.org/). UserReportedSpamRatio float64 `json:"userReportedSpamRatio,omitempty"` + // UserReportedSpamRatioLowerBound: The lower bound of the confidence + // interval for the user reported spam ratio. If this field is set, then + // the value of userReportedSpamRatio is set to the midpoint of this + // interval and is thus inexact. However, the true ratio is guaranteed + // to be in between this lower bound and the corresponding upper bound + // 95% of the time. This metric only pertains to emails authenticated by + // DKIM (http://www.dkim.org/). + UserReportedSpamRatioLowerBound float64 `json:"userReportedSpamRatioLowerBound,omitempty"` + + // UserReportedSpamRatioUpperBound: The upper bound of the confidence + // interval for the user reported spam ratio. If this field is set, then + // the value of userReportedSpamRatio is set to the midpoint of this + // interval and is thus inexact. However, the true ratio is guaranteed + // to be in between this upper bound and the corresponding lower bound + // 95% of the time. This metric only pertains to emails authenticated by + // DKIM (http://www.dkim.org/). + UserReportedSpamRatioUpperBound float64 `json:"userReportedSpamRatioUpperBound,omitempty"` + // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` @@ -592,12 +613,14 @@ func (s *TrafficStats) MarshalJSON() ([]byte, error) { func (s *TrafficStats) UnmarshalJSON(data []byte) error { type NoMethod TrafficStats var s1 struct { - DkimSuccessRatio gensupport.JSONFloat64 `json:"dkimSuccessRatio"` - DmarcSuccessRatio gensupport.JSONFloat64 `json:"dmarcSuccessRatio"` - InboundEncryptionRatio gensupport.JSONFloat64 `json:"inboundEncryptionRatio"` - OutboundEncryptionRatio gensupport.JSONFloat64 `json:"outboundEncryptionRatio"` - SpfSuccessRatio gensupport.JSONFloat64 `json:"spfSuccessRatio"` - UserReportedSpamRatio gensupport.JSONFloat64 `json:"userReportedSpamRatio"` + DkimSuccessRatio gensupport.JSONFloat64 `json:"dkimSuccessRatio"` + DmarcSuccessRatio gensupport.JSONFloat64 `json:"dmarcSuccessRatio"` + InboundEncryptionRatio gensupport.JSONFloat64 `json:"inboundEncryptionRatio"` + OutboundEncryptionRatio gensupport.JSONFloat64 `json:"outboundEncryptionRatio"` + SpfSuccessRatio gensupport.JSONFloat64 `json:"spfSuccessRatio"` + UserReportedSpamRatio gensupport.JSONFloat64 `json:"userReportedSpamRatio"` + UserReportedSpamRatioLowerBound gensupport.JSONFloat64 `json:"userReportedSpamRatioLowerBound"` + UserReportedSpamRatioUpperBound gensupport.JSONFloat64 `json:"userReportedSpamRatioUpperBound"` *NoMethod } s1.NoMethod = (*NoMethod)(s) @@ -610,6 +633,8 @@ func (s *TrafficStats) UnmarshalJSON(data []byte) error { s.OutboundEncryptionRatio = float64(s1.OutboundEncryptionRatio) s.SpfSuccessRatio = float64(s1.SpfSuccessRatio) s.UserReportedSpamRatio = float64(s1.UserReportedSpamRatio) + s.UserReportedSpamRatioLowerBound = float64(s1.UserReportedSpamRatioLowerBound) + s.UserReportedSpamRatioUpperBound = float64(s1.UserReportedSpamRatioUpperBound) return nil } diff --git a/gmailpostmastertools/v1beta1/gmailpostmastertools-api.json b/gmailpostmastertools/v1beta1/gmailpostmastertools-api.json index ce81c20fe35..32f403b24c0 100644 --- a/gmailpostmastertools/v1beta1/gmailpostmastertools-api.json +++ b/gmailpostmastertools/v1beta1/gmailpostmastertools-api.json @@ -265,7 +265,7 @@ } } }, - "revision": "20230702", + "revision": "20230907", "rootUrl": "https://gmailpostmastertools.googleapis.com/", "schemas": { "DeliveryError": { @@ -524,7 +524,17 @@ "type": "number" }, "userReportedSpamRatio": { - "description": "The ratio of user-report spam vs. email that was sent to the inbox. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).", + "description": "The ratio of user-report spam vs. email that was sent to the inbox. This is potentially inexact -- users may want to refer to the description of the interval fields userReportedSpamRatioLowerBound and userReportedSpamRatioUpperBound for more explicit accuracy guarantees. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).", + "format": "double", + "type": "number" + }, + "userReportedSpamRatioLowerBound": { + "description": "The lower bound of the confidence interval for the user reported spam ratio. If this field is set, then the value of userReportedSpamRatio is set to the midpoint of this interval and is thus inexact. However, the true ratio is guaranteed to be in between this lower bound and the corresponding upper bound 95% of the time. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).", + "format": "double", + "type": "number" + }, + "userReportedSpamRatioUpperBound": { + "description": "The upper bound of the confidence interval for the user reported spam ratio. If this field is set, then the value of userReportedSpamRatio is set to the midpoint of this interval and is thus inexact. However, the true ratio is guaranteed to be in between this upper bound and the corresponding lower bound 95% of the time. This metric only pertains to emails authenticated by [DKIM](http://www.dkim.org/).", "format": "double", "type": "number" } diff --git a/gmailpostmastertools/v1beta1/gmailpostmastertools-gen.go b/gmailpostmastertools/v1beta1/gmailpostmastertools-gen.go index f0f720c33a8..0fc10c2a7f1 100644 --- a/gmailpostmastertools/v1beta1/gmailpostmastertools-gen.go +++ b/gmailpostmastertools/v1beta1/gmailpostmastertools-gen.go @@ -563,10 +563,31 @@ type TrafficStats struct { SpfSuccessRatio float64 `json:"spfSuccessRatio,omitempty"` // UserReportedSpamRatio: The ratio of user-report spam vs. email that - // was sent to the inbox. This metric only pertains to emails - // authenticated by DKIM (http://www.dkim.org/). + // was sent to the inbox. This is potentially inexact -- users may want + // to refer to the description of the interval fields + // userReportedSpamRatioLowerBound and userReportedSpamRatioUpperBound + // for more explicit accuracy guarantees. This metric only pertains to + // emails authenticated by DKIM (http://www.dkim.org/). UserReportedSpamRatio float64 `json:"userReportedSpamRatio,omitempty"` + // UserReportedSpamRatioLowerBound: The lower bound of the confidence + // interval for the user reported spam ratio. If this field is set, then + // the value of userReportedSpamRatio is set to the midpoint of this + // interval and is thus inexact. However, the true ratio is guaranteed + // to be in between this lower bound and the corresponding upper bound + // 95% of the time. This metric only pertains to emails authenticated by + // DKIM (http://www.dkim.org/). + UserReportedSpamRatioLowerBound float64 `json:"userReportedSpamRatioLowerBound,omitempty"` + + // UserReportedSpamRatioUpperBound: The upper bound of the confidence + // interval for the user reported spam ratio. If this field is set, then + // the value of userReportedSpamRatio is set to the midpoint of this + // interval and is thus inexact. However, the true ratio is guaranteed + // to be in between this upper bound and the corresponding lower bound + // 95% of the time. This metric only pertains to emails authenticated by + // DKIM (http://www.dkim.org/). + UserReportedSpamRatioUpperBound float64 `json:"userReportedSpamRatioUpperBound,omitempty"` + // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` @@ -598,12 +619,14 @@ func (s *TrafficStats) MarshalJSON() ([]byte, error) { func (s *TrafficStats) UnmarshalJSON(data []byte) error { type NoMethod TrafficStats var s1 struct { - DkimSuccessRatio gensupport.JSONFloat64 `json:"dkimSuccessRatio"` - DmarcSuccessRatio gensupport.JSONFloat64 `json:"dmarcSuccessRatio"` - InboundEncryptionRatio gensupport.JSONFloat64 `json:"inboundEncryptionRatio"` - OutboundEncryptionRatio gensupport.JSONFloat64 `json:"outboundEncryptionRatio"` - SpfSuccessRatio gensupport.JSONFloat64 `json:"spfSuccessRatio"` - UserReportedSpamRatio gensupport.JSONFloat64 `json:"userReportedSpamRatio"` + DkimSuccessRatio gensupport.JSONFloat64 `json:"dkimSuccessRatio"` + DmarcSuccessRatio gensupport.JSONFloat64 `json:"dmarcSuccessRatio"` + InboundEncryptionRatio gensupport.JSONFloat64 `json:"inboundEncryptionRatio"` + OutboundEncryptionRatio gensupport.JSONFloat64 `json:"outboundEncryptionRatio"` + SpfSuccessRatio gensupport.JSONFloat64 `json:"spfSuccessRatio"` + UserReportedSpamRatio gensupport.JSONFloat64 `json:"userReportedSpamRatio"` + UserReportedSpamRatioLowerBound gensupport.JSONFloat64 `json:"userReportedSpamRatioLowerBound"` + UserReportedSpamRatioUpperBound gensupport.JSONFloat64 `json:"userReportedSpamRatioUpperBound"` *NoMethod } s1.NoMethod = (*NoMethod)(s) @@ -616,6 +639,8 @@ func (s *TrafficStats) UnmarshalJSON(data []byte) error { s.OutboundEncryptionRatio = float64(s1.OutboundEncryptionRatio) s.SpfSuccessRatio = float64(s1.SpfSuccessRatio) s.UserReportedSpamRatio = float64(s1.UserReportedSpamRatio) + s.UserReportedSpamRatioLowerBound = float64(s1.UserReportedSpamRatioLowerBound) + s.UserReportedSpamRatioUpperBound = float64(s1.UserReportedSpamRatioUpperBound) return nil }