1// Copyright 2023 Google LLC 2// 3// Licensed under the Apache License, Version 2.0 (the "License"); 4// you may not use this file except in compliance with the License. 5// You may obtain a copy of the License at 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 9// Unless required by applicable law or agreed to in writing, software 10// distributed under the License is distributed on an "AS IS" BASIS, 11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12// See the License for the specific language governing permissions and 13// limitations under the License. 14 15syntax = "proto3"; 16 17package google.ads.googleads.v16.resources; 18 19import "google/ads/googleads/v16/common/local_services.proto"; 20import "google/ads/googleads/v16/enums/local_services_business_registration_check_rejection_reason.proto"; 21import "google/ads/googleads/v16/enums/local_services_business_registration_type.proto"; 22import "google/ads/googleads/v16/enums/local_services_insurance_rejection_reason.proto"; 23import "google/ads/googleads/v16/enums/local_services_license_rejection_reason.proto"; 24import "google/ads/googleads/v16/enums/local_services_verification_artifact_status.proto"; 25import "google/ads/googleads/v16/enums/local_services_verification_artifact_type.proto"; 26import "google/api/field_behavior.proto"; 27import "google/api/resource.proto"; 28 29option csharp_namespace = "Google.Ads.GoogleAds.V16.Resources"; 30option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/resources;resources"; 31option java_multiple_files = true; 32option java_outer_classname = "LocalServicesVerificationArtifactProto"; 33option java_package = "com.google.ads.googleads.v16.resources"; 34option objc_class_prefix = "GAA"; 35option php_namespace = "Google\\Ads\\GoogleAds\\V16\\Resources"; 36option ruby_package = "Google::Ads::GoogleAds::V16::Resources"; 37 38// A local services verification resource. 39message LocalServicesVerificationArtifact { 40 option (google.api.resource) = { 41 type: "googleads.googleapis.com/LocalServicesVerificationArtifact" 42 pattern: "customers/{customer_id}/localServicesVerificationArtifacts/{gls_verification_artifact_id}" 43 }; 44 45 // Immutable. The resource name of the Local Services Verification. 46 // Local Services Verification resource names have the form: 47 // 48 // `customers/{customer_id}/localServicesVerificationArtifacts/{verification_artifact_id}` 49 string resource_name = 1 [ 50 (google.api.field_behavior) = IMMUTABLE, 51 (google.api.resource_reference) = { 52 type: "googleads.googleapis.com/LocalServicesVerificationArtifact" 53 } 54 ]; 55 56 // Output only. The ID of the verification artifact. 57 optional int64 id = 2 [(google.api.field_behavior) = OUTPUT_ONLY]; 58 59 // Output only. The timestamp when this verification artifact was created. 60 // The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads account's timezone. 61 // Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30" 62 string creation_date_time = 3 [(google.api.field_behavior) = OUTPUT_ONLY]; 63 64 // Output only. The status of the verification artifact. 65 google.ads.googleads.v16.enums.LocalServicesVerificationArtifactStatusEnum 66 .LocalServicesVerificationArtifactStatus status = 4 67 [(google.api.field_behavior) = OUTPUT_ONLY]; 68 69 // Output only. The type of the verification artifact. 70 google.ads.googleads.v16.enums.LocalServicesVerificationArtifactTypeEnum 71 .LocalServicesVerificationArtifactType artifact_type = 5 72 [(google.api.field_behavior) = OUTPUT_ONLY]; 73 74 // The types of verification info. 75 oneof artifact_data { 76 // Output only. A background check verification artifact. 77 BackgroundCheckVerificationArtifact background_check_verification_artifact = 78 6 [(google.api.field_behavior) = OUTPUT_ONLY]; 79 80 // Output only. An insurance verification artifact. 81 InsuranceVerificationArtifact insurance_verification_artifact = 7 82 [(google.api.field_behavior) = OUTPUT_ONLY]; 83 84 // Output only. A license verification artifact. 85 LicenseVerificationArtifact license_verification_artifact = 8 86 [(google.api.field_behavior) = OUTPUT_ONLY]; 87 88 // Output only. A business registration check verification artifact. 89 BusinessRegistrationCheckVerificationArtifact 90 business_registration_check_verification_artifact = 9 91 [(google.api.field_behavior) = OUTPUT_ONLY]; 92 } 93} 94 95// A proto holding information specific to local services background check. 96message BackgroundCheckVerificationArtifact { 97 // Output only. URL to access background case. 98 optional string case_url = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; 99 100 // Output only. The timestamp when this background check case result was 101 // adjudicated. The format is "YYYY-MM-DD HH:MM:SS" in the Google Ads 102 // account's timezone. Examples: "2018-03-05 09:15:00" or "2018-02-01 103 // 14:34:30" 104 optional string final_adjudication_date_time = 2 105 [(google.api.field_behavior) = OUTPUT_ONLY]; 106} 107 108// A proto holding information specific to a local services insurance. 109message InsuranceVerificationArtifact { 110 // Output only. Insurance amount. This is measured in "micros" of the currency 111 // mentioned in the insurance document. 112 optional int64 amount_micros = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; 113 114 // Output only. Insurance document's rejection reason. 115 optional 116 google.ads.googleads.v16.enums.LocalServicesInsuranceRejectionReasonEnum 117 .LocalServicesInsuranceRejectionReason rejection_reason = 2 118 [(google.api.field_behavior) = OUTPUT_ONLY]; 119 120 // Output only. The readonly field containing the information for an uploaded 121 // insurance document. 122 optional google.ads.googleads.v16.common.LocalServicesDocumentReadOnly 123 insurance_document_readonly = 3 124 [(google.api.field_behavior) = OUTPUT_ONLY]; 125} 126 127// A proto holding information specific to a local services license. 128message LicenseVerificationArtifact { 129 // Output only. License type / name. 130 optional string license_type = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; 131 132 // Output only. License number. 133 optional string license_number = 2 134 [(google.api.field_behavior) = OUTPUT_ONLY]; 135 136 // Output only. First name of the licensee. 137 optional string licensee_first_name = 3 138 [(google.api.field_behavior) = OUTPUT_ONLY]; 139 140 // Output only. Last name of the licensee. 141 optional string licensee_last_name = 4 142 [(google.api.field_behavior) = OUTPUT_ONLY]; 143 144 // Output only. License rejection reason. 145 optional 146 google.ads.googleads.v16.enums.LocalServicesLicenseRejectionReasonEnum 147 .LocalServicesLicenseRejectionReason rejection_reason = 5 148 [(google.api.field_behavior) = OUTPUT_ONLY]; 149 150 // Output only. The readonly field containing the information for an uploaded 151 // license document. 152 optional google.ads.googleads.v16.common.LocalServicesDocumentReadOnly 153 license_document_readonly = 6 [(google.api.field_behavior) = OUTPUT_ONLY]; 154} 155 156// A proto holding information specific to a local services business 157// registration check. 158message BusinessRegistrationCheckVerificationArtifact { 159 // Output only. The type of business registration check (number, document). 160 optional 161 google.ads.googleads.v16.enums.LocalServicesBusinessRegistrationTypeEnum 162 .LocalServicesBusinessRegistrationType registration_type = 3 163 [(google.api.field_behavior) = OUTPUT_ONLY]; 164 165 // Output only. The id of the check, such as vat_tax_id, representing "VAT Tax 166 // ID" requirement. 167 optional string check_id = 4 [(google.api.field_behavior) = OUTPUT_ONLY]; 168 169 // Output only. Registration document rejection reason. 170 optional google.ads.googleads.v16.enums 171 .LocalServicesBusinessRegistrationCheckRejectionReasonEnum 172 .LocalServicesBusinessRegistrationCheckRejectionReason rejection_reason = 173 5 [(google.api.field_behavior) = OUTPUT_ONLY]; 174 175 // Registration information for the business registration. It will be one 176 // of the following forms based on the requirement from different countries. 177 oneof business_registration { 178 // Output only. Message storing government issued number for the business. 179 BusinessRegistrationNumber registration_number = 1 180 [(google.api.field_behavior) = OUTPUT_ONLY]; 181 182 // Output only. Message storing document info for the business. 183 BusinessRegistrationDocument registration_document = 2 184 [(google.api.field_behavior) = OUTPUT_ONLY]; 185 } 186} 187 188// A proto holding information specific to a local services business 189// registration number. 190message BusinessRegistrationNumber { 191 // Output only. Government-issued number for the business. 192 optional string number = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; 193} 194 195// A proto holding information specific to a local services business 196// registration document. 197message BusinessRegistrationDocument { 198 // Output only. The readonly field containing the information for an uploaded 199 // business registration document. 200 optional google.ads.googleads.v16.common.LocalServicesDocumentReadOnly 201 document_readonly = 1 [(google.api.field_behavior) = OUTPUT_ONLY]; 202} 203