legacy-libs/google-proto-files/google/ads/googleads/v0/services/account_budget_proposal_service.proto

   1 // Copyright 2018 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.v0.services;
  19
  20 import "google/ads/googleads/v0/resources/account_budget_proposal.proto";
  21 import "google/api/annotations.proto";
  22 import "google/protobuf/field_mask.proto";
  23
  24 option csharp_namespace = "Google.Ads.GoogleAds.V0.Services";
  25 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v0/services;services";
  26 option java_multiple_files = true;
  27 option java_outer_classname = "AccountBudgetProposalServiceProto";
  28 option java_package = "com.google.ads.googleads.v0.services";
  29 option objc_class_prefix = "GAA";
  30 option php_namespace = "Google\\Ads\\GoogleAds\\V0\\Services";
  31 option ruby_package = "Google::Ads::GoogleAds::V0::Services";
  32
  33 // Proto file describing the AccountBudgetProposal service.
  34
  35 // A service for managing account-level budgets via proposals.
  36 //
  37 // A proposal is a request to create a new budget or make changes to an
  38 // existing one.
  39 //
  40 // Reads for account-level budgets managed by these proposals will be
  41 // supported in a future version.  Please use BudgetOrderService until then:
  42 // https://developers.google.com/adwords/api/docs/guides/budget-order
  43 //
  44 // Mutates:
  45 // The CREATE operation creates a new proposal.
  46 // UPDATE operations aren't supported.
  47 // The REMOVE operation cancels a pending proposal.
  48 service AccountBudgetProposalService {
  49   // Returns an account-level budget proposal in full detail.
  50   rpc GetAccountBudgetProposal(GetAccountBudgetProposalRequest)
  51       returns (google.ads.googleads.v0.resources.AccountBudgetProposal) {
  52     option (google.api.http) = {
  53       get: "/v0/{resource_name=customers/*/accountBudgetProposals/*}"
  54     };
  55   }
  56
  57   // Creates, updates, or removes account budget proposals.  Operation statuses
  58   // are returned.
  59   rpc MutateAccountBudgetProposal(MutateAccountBudgetProposalRequest)
  60       returns (MutateAccountBudgetProposalResponse) {
  61     option (google.api.http) = {
  62       post: "/v0/customers/{customer_id=*}/accountBudgetProposals:mutate"
  63       body: "*"
  64     };
  65   }
  66 }
  67
  68 // Request message for
  69 // [AccountBudgetProposalService.GetAccountBudgetProposal][google.ads.googleads.v0.services.AccountBudgetProposalService.GetAccountBudgetProposal].
  70 message GetAccountBudgetProposalRequest {
  71   // The resource name of the account-level budget proposal to fetch.
  72   string resource_name = 1;
  73 }
  74
  75 // Request message for
  76 // [AccountBudgetProposalService.MutateAccountBudgetProposal][google.ads.googleads.v0.services.AccountBudgetProposalService.MutateAccountBudgetProposal].
  77 message MutateAccountBudgetProposalRequest {
  78   // The ID of the customer.
  79   string customer_id = 1;
  80
  81   // The operation to perform on an individual account-level budget proposal.
  82   AccountBudgetProposalOperation operation = 2;
  83 }
  84
  85 // A single operation to propose the creation of a new account-level budget or
  86 // edit/end/remove an existing one.
  87 message AccountBudgetProposalOperation {
  88   // FieldMask that determines which budget fields are modified.  While budgets
  89   // may be modified, proposals that propose such modifications are final.
  90   // Therefore, update operations are not supported for proposals.
  91   //
  92   // Proposals that modify budgets have the 'update' proposal type.  Specifying
  93   // a mask for any other proposal type is considered an error.
  94   google.protobuf.FieldMask update_mask = 3;
  95
  96   // The mutate operation.
  97   oneof operation {
  98     // Create operation: A new proposal to create a new budget, edit an
  99     // existing budget, end an actively running budget, or remove an approved
 100     // budget scheduled to start in the future.
 101     // No resource name is expected for the new proposal.
 102     google.ads.googleads.v0.resources.AccountBudgetProposal create = 2;
 103
 104     // Remove operation: A resource name for the removed proposal is expected,
 105     // in this format:
 106     //
 107     //
 108     // `customers/{customer_id}/accountBudgetProposals/{account_budget_proposal_id}`
 109     // A request may be cancelled iff it is pending.
 110     string remove = 1;
 111   }
 112 }
 113
 114 // Response message for account-level budget mutate operations.
 115 message MutateAccountBudgetProposalResponse {
 116   // The result of the mutate.
 117   MutateAccountBudgetProposalResult result = 2;
 118 }
 119
 120 // The result for the account budget proposal mutate.
 121 message MutateAccountBudgetProposalResult {
 122   // Returned for successful operations.
 123   string resource_name = 1;
 124 }