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/offline_user_data.proto"; 20import "google/ads/googleads/v16/enums/offline_user_data_job_failure_reason.proto"; 21import "google/ads/googleads/v16/enums/offline_user_data_job_match_rate_range.proto"; 22import "google/ads/googleads/v16/enums/offline_user_data_job_status.proto"; 23import "google/ads/googleads/v16/enums/offline_user_data_job_type.proto"; 24import "google/api/field_behavior.proto"; 25import "google/api/resource.proto"; 26 27option csharp_namespace = "Google.Ads.GoogleAds.V16.Resources"; 28option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v16/resources;resources"; 29option java_multiple_files = true; 30option java_outer_classname = "OfflineUserDataJobProto"; 31option java_package = "com.google.ads.googleads.v16.resources"; 32option objc_class_prefix = "GAA"; 33option php_namespace = "Google\\Ads\\GoogleAds\\V16\\Resources"; 34option ruby_package = "Google::Ads::GoogleAds::V16::Resources"; 35 36// Proto file describing the offline user data job resource. 37 38// A job containing offline user data of store visitors, or user list members 39// that will be processed asynchronously. The uploaded data isn't readable and 40// the processing results of the job can only be read using 41// GoogleAdsService.Search/SearchStream. 42message OfflineUserDataJob { 43 option (google.api.resource) = { 44 type: "googleads.googleapis.com/OfflineUserDataJob" 45 pattern: "customers/{customer_id}/offlineUserDataJobs/{offline_user_data_update_id}" 46 }; 47 48 // Immutable. The resource name of the offline user data job. 49 // Offline user data job resource names have the form: 50 // 51 // `customers/{customer_id}/offlineUserDataJobs/{offline_user_data_job_id}` 52 string resource_name = 1 [ 53 (google.api.field_behavior) = IMMUTABLE, 54 (google.api.resource_reference) = { 55 type: "googleads.googleapis.com/OfflineUserDataJob" 56 } 57 ]; 58 59 // Output only. ID of this offline user data job. 60 optional int64 id = 9 [(google.api.field_behavior) = OUTPUT_ONLY]; 61 62 // Immutable. User specified job ID. 63 optional int64 external_id = 10 [(google.api.field_behavior) = IMMUTABLE]; 64 65 // Immutable. Type of the job. 66 google.ads.googleads.v16.enums.OfflineUserDataJobTypeEnum 67 .OfflineUserDataJobType type = 4 68 [(google.api.field_behavior) = IMMUTABLE]; 69 70 // Output only. Status of the job. 71 google.ads.googleads.v16.enums.OfflineUserDataJobStatusEnum 72 .OfflineUserDataJobStatus status = 5 73 [(google.api.field_behavior) = OUTPUT_ONLY]; 74 75 // Output only. Reason for the processing failure, if status is FAILED. 76 google.ads.googleads.v16.enums.OfflineUserDataJobFailureReasonEnum 77 .OfflineUserDataJobFailureReason failure_reason = 6 78 [(google.api.field_behavior) = OUTPUT_ONLY]; 79 80 // Output only. Metadata of offline user data job depicting match rate range. 81 OfflineUserDataJobMetadata operation_metadata = 11 82 [(google.api.field_behavior) = OUTPUT_ONLY]; 83 84 // Metadata of the job. 85 oneof metadata { 86 // Immutable. Metadata for data updates to a CRM-based user list. 87 google.ads.googleads.v16.common.CustomerMatchUserListMetadata 88 customer_match_user_list_metadata = 7 89 [(google.api.field_behavior) = IMMUTABLE]; 90 91 // Immutable. Metadata for store sales data update. 92 google.ads.googleads.v16.common.StoreSalesMetadata store_sales_metadata = 8 93 [(google.api.field_behavior) = IMMUTABLE]; 94 } 95} 96 97// Metadata of offline user data job. 98message OfflineUserDataJobMetadata { 99 // Output only. Match rate of the Customer Match user list upload. Describes 100 // the estimated match rate when the status of the job is "RUNNING" and final 101 // match rate when the final match rate is available after the status of the 102 // job is "SUCCESS/FAILED". 103 google.ads.googleads.v16.enums.OfflineUserDataJobMatchRateRangeEnum 104 .OfflineUserDataJobMatchRateRange match_rate_range = 1 105 [(google.api.field_behavior) = OUTPUT_ONLY]; 106} 107