legacy-libs/google-proto-files/google/ads/googleads/v1/services/extension_feed_item_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/extension_feed_item.proto";
  21 import "google/api/annotations.proto";
  22 import "google/protobuf/field_mask.proto";
  23 import "google/protobuf/wrappers.proto";
  24
  25 option csharp_namespace = "Google.Ads.GoogleAds.V1.Services";
  26 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v1/services;services";
  27 option java_multiple_files = true;
  28 option java_outer_classname = "ExtensionFeedItemServiceProto";
  29 option java_package = "com.google.ads.googleads.v1.services";
  30 option objc_class_prefix = "GAA";
  31 option php_namespace = "Google\\Ads\\GoogleAds\\V1\\Services";
  32 option ruby_package = "Google::Ads::GoogleAds::V1::Services";
  33 // Proto file describing the ExtensionFeedItem service.
  34
  35 // Service to manage extension feed items.
  36 service ExtensionFeedItemService {
  37   // Returns the requested extension feed item in full detail.
  38   rpc GetExtensionFeedItem(GetExtensionFeedItemRequest) returns (google.ads.googleads.v1.resources.ExtensionFeedItem) {
  39     option (google.api.http) = {
  40       get: "/v1/{resource_name=customers/*/extensionFeedItems/*}"
  41     };
  42   }
  43
  44   // Creates, updates, or removes extension feed items. Operation
  45   // statuses are returned.
  46   rpc MutateExtensionFeedItems(MutateExtensionFeedItemsRequest) returns (MutateExtensionFeedItemsResponse) {
  47     option (google.api.http) = {
  48       post: "/v1/customers/{customer_id=*}/extensionFeedItems:mutate"
  49       body: "*"
  50     };
  51   }
  52 }
  53
  54 // Request message for [ExtensionFeedItemService.GetExtensionFeedItem][google.ads.googleads.v1.services.ExtensionFeedItemService.GetExtensionFeedItem].
  55 message GetExtensionFeedItemRequest {
  56   // The resource name of the extension feed item to fetch.
  57   string resource_name = 1;
  58 }
  59
  60 // Request message for [ExtensionFeedItemService.MutateExtensionFeedItems][google.ads.googleads.v1.services.ExtensionFeedItemService.MutateExtensionFeedItems].
  61 message MutateExtensionFeedItemsRequest {
  62   // The ID of the customer whose extension feed items are being
  63   // modified.
  64   string customer_id = 1;
  65
  66   // The list of operations to perform on individual extension feed items.
  67   repeated ExtensionFeedItemOperation operations = 2;
  68
  69   // If true, the request is validated but not executed. Only errors are
  70   // returned, not results.
  71   bool validate_only = 4;
  72 }
  73
  74 // A single operation (create, update, remove) on an extension feed item.
  75 message ExtensionFeedItemOperation {
  76   // FieldMask that determines which resource fields are modified in an update.
  77   google.protobuf.FieldMask update_mask = 4;
  78
  79   // The mutate operation.
  80   oneof operation {
  81     // Create operation: No resource name is expected for the new extension
  82     // feed item.
  83     google.ads.googleads.v1.resources.ExtensionFeedItem create = 1;
  84
  85     // Update operation: The extension feed item is expected to have a
  86     // valid resource name.
  87     google.ads.googleads.v1.resources.ExtensionFeedItem update = 2;
  88
  89     // Remove operation: A resource name for the removed extension feed item
  90     // is expected, in this format:
  91     //
  92     // `customers/{customer_id}/extensionFeedItems/{feed_item_id}`
  93     string remove = 3;
  94   }
  95 }
  96
  97 // Response message for an extension feed item mutate.
  98 message MutateExtensionFeedItemsResponse {
  99   // All results for the mutate.
 100   repeated MutateExtensionFeedItemResult results = 2;
 101 }
 102
 103 // The result for the extension feed item mutate.
 104 message MutateExtensionFeedItemResult {
 105   // Returned for successful operations.
 106   string resource_name = 1;
 107 }