customer_feed.proto 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. // Copyright 2022 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. syntax = "proto3";
  15. package google.ads.googleads.v11.resources;
  16. import "google/ads/googleads/v11/common/matching_function.proto";
  17. import "google/ads/googleads/v11/enums/feed_link_status.proto";
  18. import "google/ads/googleads/v11/enums/placeholder_type.proto";
  19. import "google/api/field_behavior.proto";
  20. import "google/api/resource.proto";
  21. option csharp_namespace = "Google.Ads.GoogleAds.V11.Resources";
  22. option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v11/resources;resources";
  23. option java_multiple_files = true;
  24. option java_outer_classname = "CustomerFeedProto";
  25. option java_package = "com.google.ads.googleads.v11.resources";
  26. option objc_class_prefix = "GAA";
  27. option php_namespace = "Google\\Ads\\GoogleAds\\V11\\Resources";
  28. option ruby_package = "Google::Ads::GoogleAds::V11::Resources";
  29. // Proto file describing the CustomerFeed resource.
  30. // A customer feed.
  31. message CustomerFeed {
  32. option (google.api.resource) = {
  33. type: "googleads.googleapis.com/CustomerFeed"
  34. pattern: "customers/{customer_id}/customerFeeds/{feed_id}"
  35. };
  36. // Immutable. The resource name of the customer feed.
  37. // Customer feed resource names have the form:
  38. //
  39. // `customers/{customer_id}/customerFeeds/{feed_id}`
  40. string resource_name = 1 [
  41. (google.api.field_behavior) = IMMUTABLE,
  42. (google.api.resource_reference) = {
  43. type: "googleads.googleapis.com/CustomerFeed"
  44. }
  45. ];
  46. // Immutable. The feed being linked to the customer.
  47. optional string feed = 6 [
  48. (google.api.field_behavior) = IMMUTABLE,
  49. (google.api.resource_reference) = {
  50. type: "googleads.googleapis.com/Feed"
  51. }
  52. ];
  53. // Indicates which placeholder types the feed may populate under the connected
  54. // customer. Required.
  55. repeated google.ads.googleads.v11.enums.PlaceholderTypeEnum.PlaceholderType placeholder_types = 3;
  56. // Matching function associated with the CustomerFeed.
  57. // The matching function is used to filter the set of feed items selected.
  58. // Required.
  59. google.ads.googleads.v11.common.MatchingFunction matching_function = 4;
  60. // Output only. Status of the customer feed.
  61. // This field is read-only.
  62. google.ads.googleads.v11.enums.FeedLinkStatusEnum.FeedLinkStatus status = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
  63. }