legacy-libs/google-proto-files/google/ads/googleads/v0/resources/feed_item.proto

   1 // Copyright 2018 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.v0.resources;
  19
  20 import "google/ads/googleads/v0/common/custom_parameter.proto";
  21 import "google/ads/googleads/v0/common/feed_common.proto";
  22 import "google/ads/googleads/v0/common/policy.proto";
  23 import "google/ads/googleads/v0/enums/feed_item_quality_approval_status.proto";
  24 import "google/ads/googleads/v0/enums/feed_item_quality_disapproval_reason.proto";
  25 import "google/ads/googleads/v0/enums/feed_item_status.proto";
  26 import "google/ads/googleads/v0/enums/feed_item_validation_status.proto";
  27 import "google/ads/googleads/v0/enums/geo_targeting_restriction.proto";
  28 import "google/ads/googleads/v0/enums/policy_approval_status.proto";
  29 import "google/ads/googleads/v0/enums/policy_review_status.proto";
  30 import "google/ads/googleads/v0/errors/feed_item_validation_error.proto";
  31 import "google/protobuf/wrappers.proto";
  32
  33 option csharp_namespace = "Google.Ads.GoogleAds.V0.Resources";
  34 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v0/resources;resources";
  35 option java_multiple_files = true;
  36 option java_outer_classname = "FeedItemProto";
  37 option java_package = "com.google.ads.googleads.v0.resources";
  38 option objc_class_prefix = "GAA";
  39 option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Resources";
  40 option ruby_package = "Google::Ads::GoogleAds::V0::Resources";
  41
  42 // Proto file describing the FeedItem resource.
  43
  44 // A feed item.
  45 message FeedItem {
  46   // The resource name of the feed item.
  47   // Feed item resource names have the form:
  48   //
  49   // `customers/{customer_id}/feedItems/{feed_id}_{feed_item_id}`
  50   string resource_name = 1;
  51
  52   // The feed to which this feed item belongs.
  53   google.protobuf.StringValue feed = 2;
  54
  55   // The ID of this feed item.
  56   google.protobuf.Int64Value id = 3;
  57
  58   // Start time in which this feed item is effective and can begin serving.
  59   // The format is "YYYY-MM-DD HH:MM:SS".
  60   // Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
  61   google.protobuf.StringValue start_date_time = 4;
  62
  63   // End time in which this feed item is no longer effective and will stop
  64   // serving.
  65   // The format is "YYYY-MM-DD HH:MM:SS".
  66   // Examples: "2018-03-05 09:15:00" or "2018-02-01 14:34:30"
  67   google.protobuf.StringValue end_date_time = 5;
  68
  69   // The feed item's attribute values.
  70   repeated FeedItemAttributeValue attribute_values = 6;
  71
  72   // Geo targeting restriction specifies the type of location that can be used
  73   // for targeting.
  74   google.ads.googleads.v0.enums.GeoTargetingRestrictionEnum
  75       .GeoTargetingRestriction geo_targeting_restriction = 7;
  76
  77   // The list of mappings used to substitute custom parameter tags in a
  78   // `tracking_url_template`, `final_urls`, or `mobile_final_urls`.
  79   repeated google.ads.googleads.v0.common.CustomParameter
  80       url_custom_parameters = 8;
  81
  82   // Status of the feed item.
  83   // This field is read-only.
  84   google.ads.googleads.v0.enums.FeedItemStatusEnum.FeedItemStatus status = 9;
  85
  86   // List of info about a feed item's validation and approval state for active
  87   // feed mappings. There will be an entry in the list for each type of feed
  88   // mapping associated with the feed, e.g. a feed with a sitelink and a call
  89   // feed mapping would cause every feed item associated with that feed to have
  90   // an entry in this list for both sitelink and call.
  91   // This field is read-only.
  92   repeated FeedItemPlaceholderPolicyInfo policy_infos = 10;
  93 }
  94
  95 // A feed item attribute value.
  96 message FeedItemAttributeValue {
  97   // Id of the feed attribute for which the value is associated with.
  98   google.protobuf.Int64Value feed_attribute_id = 1;
  99
 100   // Int64 value. Should be set if feed_attribute_id refers to a feed attribute
 101   // of type INT64.
 102   google.protobuf.Int64Value integer_value = 2;
 103
 104   // Bool value. Should be set if feed_attribute_id refers to a feed attribute
 105   // of type BOOLEAN.
 106   google.protobuf.BoolValue boolean_value = 3;
 107
 108   // String value. Should be set if feed_attribute_id refers to a feed attribute
 109   // of type STRING, URL or DATE_TIME.
 110   // For STRING the maximum length is 1500 characters. For URL the maximum
 111   // length is 2076 characters. For DATE_TIME the format of the string must
 112   // be the same as start and end time for the feed item.
 113   google.protobuf.StringValue string_value = 4;
 114
 115   // Double value. Should be set if feed_attribute_id refers to a feed attribute
 116   // of type DOUBLE.
 117   google.protobuf.DoubleValue double_value = 5;
 118
 119   // Price value. Should be set if feed_attribute_id refers to a feed attribute
 120   // of type PRICE.
 121   google.ads.googleads.v0.common.Price price_value = 6;
 122
 123   // Repeated int64 value. Should be set if feed_attribute_id refers to a feed
 124   // attribute of type INT64_LIST.
 125   repeated google.protobuf.Int64Value integer_values = 7;
 126
 127   // Repeated bool value. Should be set if feed_attribute_id refers to a feed
 128   // attribute of type BOOLEAN_LIST.
 129   repeated google.protobuf.BoolValue boolean_values = 8;
 130
 131   // Repeated string value. Should be set if feed_attribute_id refers to a feed
 132   // attribute of type STRING_LIST, URL_LIST or DATE_TIME_LIST.
 133   // For STRING_LIST and URL_LIST the total size of the list in bytes may not
 134   // exceed 3000. For DATE_TIME_LIST the number of elements may not exceed 200.
 135   //
 136   // For STRING_LIST the maximum length of each string element is 1500
 137   // characters. For URL_LIST the maximum length is 2076 characters. For
 138   // DATE_TIME the format of the string must be the same as start and end time
 139   // for the feed item.
 140   repeated google.protobuf.StringValue string_values = 9;
 141
 142   // Repeated double value. Should be set if feed_attribute_id refers to a feed
 143   // attribute of type DOUBLE_LIST.
 144   repeated google.protobuf.DoubleValue double_values = 10;
 145 }
 146
 147 // Policy, validation, and quality approval info for a feed item for the
 148 // specified placeholder type.
 149 message FeedItemPlaceholderPolicyInfo {
 150   // The placeholder type.
 151   google.protobuf.Int32Value placeholder_type = 1;
 152
 153   // The FeedMapping that contains the placeholder type.
 154   google.protobuf.StringValue feed_mapping_resource_name = 2;
 155
 156   // Where the placeholder type is in the review process.
 157   google.ads.googleads.v0.enums.PolicyReviewStatusEnum.PolicyReviewStatus
 158       review_status = 3;
 159
 160   // The overall approval status of the placeholder type, calculated based on
 161   // the status of its individual policy topic entries.
 162   google.ads.googleads.v0.enums.PolicyApprovalStatusEnum.PolicyApprovalStatus
 163       approval_status = 4;
 164
 165   // The list of policy findings for the placeholder type.
 166   repeated google.ads.googleads.v0.common.PolicyTopicEntry
 167       policy_topic_entries = 5;
 168
 169   // The validation status of the palceholder type.
 170   google.ads.googleads.v0.enums.FeedItemValidationStatusEnum
 171       .FeedItemValidationStatus validation_status = 6;
 172
 173   // List of placeholder type validation errors.
 174   repeated FeedItemValidationError validation_errors = 7;
 175
 176   // Placeholder type quality evaluation approval status.
 177   google.ads.googleads.v0.enums.FeedItemQualityApprovalStatusEnum
 178       .FeedItemQualityApprovalStatus quality_approval_status = 8;
 179
 180   // List of placeholder type quality evaluation disapproval reasons.
 181   repeated google.ads.googleads.v0.enums.FeedItemQualityDisapprovalReasonEnum
 182       .FeedItemQualityDisapprovalReason quality_disapproval_reasons = 9;
 183 }
 184
 185 // Stores a validation error and the set of offending feed attributes which
 186 // together are responsible for causing a feed item validation error.
 187 message FeedItemValidationError {
 188   // Error code indicating what validation error was triggered. The description
 189   // of the error can be found in the 'description' field.
 190   google.ads.googleads.v0.errors.FeedItemValidationErrorEnum
 191       .FeedItemValidationError validation_error = 1;
 192
 193   // The description of the validation error.
 194   google.protobuf.StringValue description = 2;
 195
 196   // Set of feed attributes in the feed item flagged during validation. If
 197   // empty, no specific feed attributes can be associated with the error
 198   // (e.g. error across the entire feed item).
 199   repeated google.protobuf.Int64Value feed_attribute_ids = 3;
 200
 201   // Any extra information related to this error which is not captured by
 202   // validation_error and feed_attribute_id (e.g. placeholder field IDs when
 203   // feed_attribute_id is not mapped). Note that extra_information is not
 204   // localized.
 205   google.protobuf.StringValue extra_information = 4;
 206 }