legacy-libs/google-proto-files/google/ads/googleads/v1/services/feed_item_target_service.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.services;
  19
  20 import "google/ads/googleads/v1/resources/feed_item_target.proto";
  21 import "google/api/annotations.proto";
  22
  23 option csharp_namespace = "Google.Ads.GoogleAds.V1.Services";
  24 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v1/services;services";
  25 option java_multiple_files = true;
  26 option java_outer_classname = "FeedItemTargetServiceProto";
  27 option java_package = "com.google.ads.googleads.v1.services";
  28 option objc_class_prefix = "GAA";
  29 option php_namespace = "Google\\Ads\\GoogleAds\\V1\\Services";
  30 option ruby_package = "Google::Ads::GoogleAds::V1::Services";
  31 // Proto file describing the FeedItemTarget service.
  32
  33 // Service to manage feed item targets.
  34 service FeedItemTargetService {
  35   // Returns the requested feed item targets in full detail.
  36   rpc GetFeedItemTarget(GetFeedItemTargetRequest) returns (google.ads.googleads.v1.resources.FeedItemTarget) {
  37     option (google.api.http) = {
  38       get: "/v1/{resource_name=customers/*/feedItemTargets/*}"
  39     };
  40   }
  41
  42   // Creates or removes feed item targets. Operation statuses are returned.
  43   rpc MutateFeedItemTargets(MutateFeedItemTargetsRequest) returns (MutateFeedItemTargetsResponse) {
  44     option (google.api.http) = {
  45       post: "/v1/customers/{customer_id=*}/feedItemTargets:mutate"
  46       body: "*"
  47     };
  48   }
  49 }
  50
  51 // Request message for [FeedItemTargetService.GetFeedItemTarget][google.ads.googleads.v1.services.FeedItemTargetService.GetFeedItemTarget].
  52 message GetFeedItemTargetRequest {
  53   // The resource name of the feed item targets to fetch.
  54   string resource_name = 1;
  55 }
  56
  57 // Request message for [FeedItemTargetService.MutateFeedItemTargets][google.ads.googleads.v1.services.FeedItemTargetService.MutateFeedItemTargets].
  58 message MutateFeedItemTargetsRequest {
  59   // The ID of the customer whose feed item targets are being modified.
  60   string customer_id = 1;
  61
  62   // The list of operations to perform on individual feed item targets.
  63   repeated FeedItemTargetOperation operations = 2;
  64 }
  65
  66 // A single operation (create, remove) on an feed item target.
  67 message FeedItemTargetOperation {
  68   // The mutate operation.
  69   oneof operation {
  70     // Create operation: No resource name is expected for the new feed item
  71     // target.
  72     google.ads.googleads.v1.resources.FeedItemTarget create = 1;
  73
  74     // Remove operation: A resource name for the removed feed item target is
  75     // expected, in this format:
  76     //
  77     //
  78     // `customers/{customer_id}/feedItemTargets/{feed_id}~{feed_item_id}~{feed_item_target_type}~{feed_item_target_id}`
  79     string remove = 2;
  80   }
  81 }
  82
  83 // Response message for an feed item target mutate.
  84 message MutateFeedItemTargetsResponse {
  85   // All results for the mutate.
  86   repeated MutateFeedItemTargetResult results = 2;
  87 }
  88
  89 // The result for the feed item target mutate.
  90 message MutateFeedItemTargetResult {
  91   // Returned for successful operations.
  92   string resource_name = 1;
  93 }