• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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.v15.resources;
18
19import "google/ads/googleads/v15/common/feed_item_set_filter_type_infos.proto";
20import "google/ads/googleads/v15/enums/feed_item_set_status.proto";
21import "google/api/field_behavior.proto";
22import "google/api/resource.proto";
23
24option csharp_namespace = "Google.Ads.GoogleAds.V15.Resources";
25option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v15/resources;resources";
26option java_multiple_files = true;
27option java_outer_classname = "FeedItemSetProto";
28option java_package = "com.google.ads.googleads.v15.resources";
29option objc_class_prefix = "GAA";
30option php_namespace = "Google\\Ads\\GoogleAds\\V15\\Resources";
31option ruby_package = "Google::Ads::GoogleAds::V15::Resources";
32
33// Represents a set of feed items. The set can be used and shared among certain
34// feed item features. For instance, the set can be referenced within the
35// matching functions of CustomerFeed, CampaignFeed, and AdGroupFeed.
36message FeedItemSet {
37  option (google.api.resource) = {
38    type: "googleads.googleapis.com/FeedItemSet"
39    pattern: "customers/{customer_id}/feedItemSets/{feed_id}~{feed_item_set_id}"
40  };
41
42  // Immutable. The resource name of the feed item set.
43  // Feed item set resource names have the form:
44  // `customers/{customer_id}/feedItemSets/{feed_id}~{feed_item_set_id}`
45  string resource_name = 1 [
46    (google.api.field_behavior) = IMMUTABLE,
47    (google.api.resource_reference) = {
48      type: "googleads.googleapis.com/FeedItemSet"
49    }
50  ];
51
52  // Immutable. The resource name of the feed containing the feed items in the
53  // set. Immutable. Required.
54  string feed = 2 [
55    (google.api.field_behavior) = IMMUTABLE,
56    (google.api.resource_reference) = { type: "googleads.googleapis.com/Feed" }
57  ];
58
59  // Output only. ID of the set.
60  int64 feed_item_set_id = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
61
62  // Name of the set. Must be unique within the account.
63  string display_name = 4;
64
65  // Output only. Status of the feed item set.
66  // This field is read-only.
67  google.ads.googleads.v15.enums.FeedItemSetStatusEnum.FeedItemSetStatus
68      status = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
69
70  // Represents a filter on locations in a feed item set.
71  // Only applicable if the parent Feed of the FeedItemSet is a LOCATION feed.
72  oneof dynamic_set_filter {
73    // Filter for dynamic location set.
74    // It is only used for sets of locations.
75    google.ads.googleads.v15.common.DynamicLocationSetFilter
76        dynamic_location_set_filter = 5;
77
78    // Filter for dynamic affiliate location set.
79    // This field doesn't apply generally to feed item sets. It is only used for
80    // sets of affiliate locations.
81    google.ads.googleads.v15.common.DynamicAffiliateLocationSetFilter
82        dynamic_affiliate_location_set_filter = 6;
83  }
84}
85