aboutsummaryrefslogtreecommitdiff
path: root/google/ads/googleads/v1/services/feed_item_target_service.proto
diff options
context:
space:
mode:
Diffstat (limited to 'google/ads/googleads/v1/services/feed_item_target_service.proto')
-rw-r--r--google/ads/googleads/v1/services/feed_item_target_service.proto94
1 files changed, 94 insertions, 0 deletions
diff --git a/google/ads/googleads/v1/services/feed_item_target_service.proto b/google/ads/googleads/v1/services/feed_item_target_service.proto
new file mode 100644
index 000000000..08dba26d7
--- /dev/null
+++ b/google/ads/googleads/v1/services/feed_item_target_service.proto
@@ -0,0 +1,94 @@
+// Copyright 2019 Google LLC.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+syntax = "proto3";
+
+package google.ads.googleads.v1.services;
+
+import "google/ads/googleads/v1/resources/feed_item_target.proto";
+import "google/api/annotations.proto";
+
+option csharp_namespace = "Google.Ads.GoogleAds.V1.Services";
+option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v1/services;services";
+option java_multiple_files = true;
+option java_outer_classname = "FeedItemTargetServiceProto";
+option java_package = "com.google.ads.googleads.v1.services";
+option objc_class_prefix = "GAA";
+option php_namespace = "Google\\Ads\\GoogleAds\\V1\\Services";
+option ruby_package = "Google::Ads::GoogleAds::V1::Services";
+
+// Proto file describing the FeedItemTarget service.
+
+// Service to manage feed item targets.
+service FeedItemTargetService {
+ // Returns the requested feed item targets in full detail.
+ rpc GetFeedItemTarget(GetFeedItemTargetRequest) returns (google.ads.googleads.v1.resources.FeedItemTarget) {
+ option (google.api.http) = {
+ get: "/v1/{resource_name=customers/*/feedItemTargets/*}"
+ };
+ }
+
+ // Creates or removes feed item targets. Operation statuses are returned.
+ rpc MutateFeedItemTargets(MutateFeedItemTargetsRequest) returns (MutateFeedItemTargetsResponse) {
+ option (google.api.http) = {
+ post: "/v1/customers/{customer_id=*}/feedItemTargets:mutate"
+ body: "*"
+ };
+ }
+}
+
+// Request message for [FeedItemTargetService.GetFeedItemTarget][google.ads.googleads.v1.services.FeedItemTargetService.GetFeedItemTarget].
+message GetFeedItemTargetRequest {
+ // The resource name of the feed item targets to fetch.
+ string resource_name = 1;
+}
+
+// Request message for [FeedItemTargetService.MutateFeedItemTargets][google.ads.googleads.v1.services.FeedItemTargetService.MutateFeedItemTargets].
+message MutateFeedItemTargetsRequest {
+ // The ID of the customer whose feed item targets are being modified.
+ string customer_id = 1;
+
+ // The list of operations to perform on individual feed item targets.
+ repeated FeedItemTargetOperation operations = 2;
+}
+
+// A single operation (create, remove) on an feed item target.
+message FeedItemTargetOperation {
+ // The mutate operation.
+ oneof operation {
+ // Create operation: No resource name is expected for the new feed item
+ // target.
+ google.ads.googleads.v1.resources.FeedItemTarget create = 1;
+
+ // Remove operation: A resource name for the removed feed item target is
+ // expected, in this format:
+ //
+ //
+ // `customers/{customer_id}/feedItemTargets/{feed_id}~{feed_item_id}~{feed_item_target_type}~{feed_item_target_id}`
+ string remove = 2;
+ }
+}
+
+// Response message for an feed item target mutate.
+message MutateFeedItemTargetsResponse {
+ // All results for the mutate.
+ repeated MutateFeedItemTargetResult results = 2;
+}
+
+// The result for the feed item target mutate.
+message MutateFeedItemTargetResult {
+ // Returned for successful operations.
+ string resource_name = 1;
+}