legacy-libs/google-proto-files/google/ads/googleads/v1/resources/feed_mapping.proto

   1 // Copyright 2019 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 //
  15
  16 syntax = "proto3";
  17
  18 package google.ads.googleads.v1.resources;
  19
  20 import "google/ads/googleads/v1/enums/ad_customizer_placeholder_field.proto";
  21 import "google/ads/googleads/v1/enums/affiliate_location_placeholder_field.proto";
  22 import "google/ads/googleads/v1/enums/app_placeholder_field.proto";
  23 import "google/ads/googleads/v1/enums/call_placeholder_field.proto";
  24 import "google/ads/googleads/v1/enums/callout_placeholder_field.proto";
  25 import "google/ads/googleads/v1/enums/custom_placeholder_field.proto";
  26 import "google/ads/googleads/v1/enums/dsa_page_feed_criterion_field.proto";
  27 import "google/ads/googleads/v1/enums/education_placeholder_field.proto";
  28 import "google/ads/googleads/v1/enums/feed_mapping_criterion_type.proto";
  29 import "google/ads/googleads/v1/enums/feed_mapping_status.proto";
  30 import "google/ads/googleads/v1/enums/flight_placeholder_field.proto";
  31 import "google/ads/googleads/v1/enums/hotel_placeholder_field.proto";
  32 import "google/ads/googleads/v1/enums/job_placeholder_field.proto";
  33 import "google/ads/googleads/v1/enums/local_placeholder_field.proto";
  34 import "google/ads/googleads/v1/enums/location_extension_targeting_criterion_field.proto";
  35 import "google/ads/googleads/v1/enums/location_placeholder_field.proto";
  36 import "google/ads/googleads/v1/enums/message_placeholder_field.proto";
  37 import "google/ads/googleads/v1/enums/placeholder_type.proto";
  38 import "google/ads/googleads/v1/enums/price_placeholder_field.proto";
  39 import "google/ads/googleads/v1/enums/promotion_placeholder_field.proto";
  40 import "google/ads/googleads/v1/enums/real_estate_placeholder_field.proto";
  41 import "google/ads/googleads/v1/enums/sitelink_placeholder_field.proto";
  42 import "google/ads/googleads/v1/enums/structured_snippet_placeholder_field.proto";
  43 import "google/ads/googleads/v1/enums/travel_placeholder_field.proto";
  44 import "google/protobuf/wrappers.proto";
  45 import "google/api/annotations.proto";
  46
  47 option csharp_namespace = "Google.Ads.GoogleAds.V1.Resources";
  48 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v1/resources;resources";
  49 option java_multiple_files = true;
  50 option java_outer_classname = "FeedMappingProto";
  51 option java_package = "com.google.ads.googleads.v1.resources";
  52 option objc_class_prefix = "GAA";
  53 option php_namespace = "Google\\Ads\\GoogleAds\\V1\\Resources";
  54 option ruby_package = "Google::Ads::GoogleAds::V1::Resources";
  55 // Proto file describing the FeedMapping resource.
  56
  57 // A feed mapping.
  58 message FeedMapping {
  59   // The resource name of the feed mapping.
  60   // Feed mapping resource names have the form:
  61   //
  62   // `customers/{customer_id}/feedMappings/{feed_id}~{feed_mapping_id}`
  63   string resource_name = 1;
  64
  65   // The feed of this feed mapping.
  66   google.protobuf.StringValue feed = 2;
  67
  68   // Feed attributes to field mappings. These mappings are a one-to-many
  69   // relationship meaning that 1 feed attribute can be used to populate
  70   // multiple placeholder fields, but 1 placeholder field can only draw
  71   // data from 1 feed attribute. Ad Customizer is an exception, 1 placeholder
  72   // field can be mapped to multiple feed attributes. Required.
  73   repeated AttributeFieldMapping attribute_field_mappings = 5;
  74
  75   // Status of the feed mapping.
  76   // This field is read-only.
  77   google.ads.googleads.v1.enums.FeedMappingStatusEnum.FeedMappingStatus status = 6;
  78
  79   // Feed mapping target. Can be either a placeholder or a criterion. For a
  80   // given feed, the active FeedMappings must have unique targets. Required.
  81   oneof target {
  82     // The placeholder type of this mapping (i.e., if the mapping maps feed
  83     // attributes to placeholder fields).
  84     google.ads.googleads.v1.enums.PlaceholderTypeEnum.PlaceholderType placeholder_type = 3;
  85
  86     // The criterion type of this mapping (i.e., if the mapping maps feed
  87     // attributes to criterion fields).
  88     google.ads.googleads.v1.enums.FeedMappingCriterionTypeEnum.FeedMappingCriterionType criterion_type = 4;
  89   }
  90 }
  91
  92 // Maps from feed attribute id to a placeholder or criterion field id.
  93 message AttributeFieldMapping {
  94   // Feed attribute from which to map.
  95   google.protobuf.Int64Value feed_attribute_id = 1;
  96
  97   // The placeholder field ID. If a placeholder field enum is not published in
  98   // the current API version, then this field will be populated and the field
  99   // oneof will be empty.
 100   // This field is read-only.
 101   google.protobuf.Int64Value field_id = 2;
 102
 103   // Placeholder or criterion field to be populated using data from
 104   // the above feed attribute. Required.
 105   oneof field {
 106     // Sitelink Placeholder Fields.
 107     google.ads.googleads.v1.enums.SitelinkPlaceholderFieldEnum.SitelinkPlaceholderField sitelink_field = 3;
 108
 109     // Call Placeholder Fields.
 110     google.ads.googleads.v1.enums.CallPlaceholderFieldEnum.CallPlaceholderField call_field = 4;
 111
 112     // App Placeholder Fields.
 113     google.ads.googleads.v1.enums.AppPlaceholderFieldEnum.AppPlaceholderField app_field = 5;
 114
 115     // Location Placeholder Fields. This field is read-only.
 116     google.ads.googleads.v1.enums.LocationPlaceholderFieldEnum.LocationPlaceholderField location_field = 6;
 117
 118     // Affiliate Location Placeholder Fields. This field is read-only.
 119     google.ads.googleads.v1.enums.AffiliateLocationPlaceholderFieldEnum.AffiliateLocationPlaceholderField affiliate_location_field = 7;
 120
 121     // Callout Placeholder Fields.
 122     google.ads.googleads.v1.enums.CalloutPlaceholderFieldEnum.CalloutPlaceholderField callout_field = 8;
 123
 124     // Structured Snippet Placeholder Fields.
 125     google.ads.googleads.v1.enums.StructuredSnippetPlaceholderFieldEnum.StructuredSnippetPlaceholderField structured_snippet_field = 9;
 126
 127     // Message Placeholder Fields.
 128     google.ads.googleads.v1.enums.MessagePlaceholderFieldEnum.MessagePlaceholderField message_field = 10;
 129
 130     // Price Placeholder Fields.
 131     google.ads.googleads.v1.enums.PricePlaceholderFieldEnum.PricePlaceholderField price_field = 11;
 132
 133     // Promotion Placeholder Fields.
 134     google.ads.googleads.v1.enums.PromotionPlaceholderFieldEnum.PromotionPlaceholderField promotion_field = 12;
 135
 136     // Ad Customizer Placeholder Fields
 137     google.ads.googleads.v1.enums.AdCustomizerPlaceholderFieldEnum.AdCustomizerPlaceholderField ad_customizer_field = 13;
 138
 139     // Dynamic Search Ad Page Feed Fields.
 140     google.ads.googleads.v1.enums.DsaPageFeedCriterionFieldEnum.DsaPageFeedCriterionField dsa_page_feed_field = 14;
 141
 142     // Location Target Fields.
 143     google.ads.googleads.v1.enums.LocationExtensionTargetingCriterionFieldEnum.LocationExtensionTargetingCriterionField location_extension_targeting_field = 15;
 144
 145     // Education Placeholder Fields
 146     google.ads.googleads.v1.enums.EducationPlaceholderFieldEnum.EducationPlaceholderField education_field = 16;
 147
 148     // Flight Placeholder Fields
 149     google.ads.googleads.v1.enums.FlightPlaceholderFieldEnum.FlightPlaceholderField flight_field = 17;
 150
 151     // Custom Placeholder Fields
 152     google.ads.googleads.v1.enums.CustomPlaceholderFieldEnum.CustomPlaceholderField custom_field = 18;
 153
 154     // Hotel Placeholder Fields
 155     google.ads.googleads.v1.enums.HotelPlaceholderFieldEnum.HotelPlaceholderField hotel_field = 19;
 156
 157     // Real Estate Placeholder Fields
 158     google.ads.googleads.v1.enums.RealEstatePlaceholderFieldEnum.RealEstatePlaceholderField real_estate_field = 20;
 159
 160     // Travel Placeholder Fields
 161     google.ads.googleads.v1.enums.TravelPlaceholderFieldEnum.TravelPlaceholderField travel_field = 21;
 162
 163     // Local Placeholder Fields
 164     google.ads.googleads.v1.enums.LocalPlaceholderFieldEnum.LocalPlaceholderField local_field = 22;
 165
 166     // Job Placeholder Fields
 167     google.ads.googleads.v1.enums.JobPlaceholderFieldEnum.JobPlaceholderField job_field = 23;
 168   }
 169 }