legacy-libs/google-proto-files/google/ads/googleads/v1/resources/account_budget_proposal.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.resources;
  19
  20 import "google/ads/googleads/v1/enums/account_budget_proposal_status.proto";
  21 import "google/ads/googleads/v1/enums/account_budget_proposal_type.proto";
  22 import "google/ads/googleads/v1/enums/spending_limit_type.proto";
  23 import "google/ads/googleads/v1/enums/time_type.proto";
  24 import "google/protobuf/wrappers.proto";
  25 import "google/api/annotations.proto";
  26
  27 option csharp_namespace = "Google.Ads.GoogleAds.V1.Resources";
  28 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v1/resources;resources";
  29 option java_multiple_files = true;
  30 option java_outer_classname = "AccountBudgetProposalProto";
  31 option java_package = "com.google.ads.googleads.v1.resources";
  32 option objc_class_prefix = "GAA";
  33 option php_namespace = "Google\\Ads\\GoogleAds\\V1\\Resources";
  34 option ruby_package = "Google::Ads::GoogleAds::V1::Resources";
  35 // Proto file describing the AccountBudgetProposal resource.
  36
  37 // An account-level budget proposal.
  38 //
  39 // All fields prefixed with 'proposed' may not necessarily be applied directly.
  40 // For example, proposed spending limits may be adjusted before their
  41 // application.  This is true if the 'proposed' field has an 'approved'
  42 // counterpart, e.g. spending limits.
  43 //
  44 // Please note that the proposal type (proposal_type) changes which fields are
  45 // required and which must remain empty.
  46 message AccountBudgetProposal {
  47   // The resource name of the proposal.
  48   // AccountBudgetProposal resource names have the form:
  49   //
  50   //
  51   // `customers/{customer_id}/accountBudgetProposals/{account_budget_proposal_id}`
  52   string resource_name = 1;
  53
  54   // The ID of the proposal.
  55   google.protobuf.Int64Value id = 14;
  56
  57   // The resource name of the billing setup associated with this proposal.
  58   google.protobuf.StringValue billing_setup = 2;
  59
  60   // The resource name of the account-level budget associated with this
  61   // proposal.
  62   google.protobuf.StringValue account_budget = 3;
  63
  64   // The type of this proposal, e.g. END to end the budget associated with this
  65   // proposal.
  66   google.ads.googleads.v1.enums.AccountBudgetProposalTypeEnum.AccountBudgetProposalType proposal_type = 4;
  67
  68   // The status of this proposal.
  69   // When a new proposal is created, the status defaults to PENDING.
  70   google.ads.googleads.v1.enums.AccountBudgetProposalStatusEnum.AccountBudgetProposalStatus status = 15;
  71
  72   // The name to assign to the account-level budget.
  73   google.protobuf.StringValue proposed_name = 5;
  74
  75   // The approved start date time in yyyy-mm-dd hh:mm:ss format.
  76   google.protobuf.StringValue approved_start_date_time = 20;
  77
  78   // A purchase order number is a value that enables the user to help them
  79   // reference this budget in their monthly invoices.
  80   google.protobuf.StringValue proposed_purchase_order_number = 12;
  81
  82   // Notes associated with this budget.
  83   google.protobuf.StringValue proposed_notes = 13;
  84
  85   // The date time when this account-level budget proposal was created, which is
  86   // not the same as its approval date time, if applicable.
  87   google.protobuf.StringValue creation_date_time = 16;
  88
  89   // The date time when this account-level budget was approved, if applicable.
  90   google.protobuf.StringValue approval_date_time = 17;
  91
  92   // The proposed start date time of the account-level budget, which cannot be
  93   // in the past.
  94   oneof proposed_start_time {
  95     // The proposed start date time in yyyy-mm-dd hh:mm:ss format.
  96     google.protobuf.StringValue proposed_start_date_time = 18;
  97
  98     // The proposed start date time as a well-defined type, e.g. NOW.
  99     google.ads.googleads.v1.enums.TimeTypeEnum.TimeType proposed_start_time_type = 7;
 100   }
 101
 102   // The proposed end date time of the account-level budget, which cannot be in
 103   // the past.
 104   oneof proposed_end_time {
 105     // The proposed end date time in yyyy-mm-dd hh:mm:ss format.
 106     google.protobuf.StringValue proposed_end_date_time = 19;
 107
 108     // The proposed end date time as a well-defined type, e.g. FOREVER.
 109     google.ads.googleads.v1.enums.TimeTypeEnum.TimeType proposed_end_time_type = 9;
 110   }
 111
 112   // The approved end date time of the account-level budget.
 113   oneof approved_end_time {
 114     // The approved end date time in yyyy-mm-dd hh:mm:ss format.
 115     google.protobuf.StringValue approved_end_date_time = 21;
 116
 117     // The approved end date time as a well-defined type, e.g. FOREVER.
 118     google.ads.googleads.v1.enums.TimeTypeEnum.TimeType approved_end_time_type = 22;
 119   }
 120
 121   // The proposed spending limit.
 122   oneof proposed_spending_limit {
 123     // The proposed spending limit in micros.  One million is equivalent to
 124     // one unit.
 125     google.protobuf.Int64Value proposed_spending_limit_micros = 10;
 126
 127     // The proposed spending limit as a well-defined type, e.g. INFINITE.
 128     google.ads.googleads.v1.enums.SpendingLimitTypeEnum.SpendingLimitType proposed_spending_limit_type = 11;
 129   }
 130
 131   // The approved spending limit.
 132   oneof approved_spending_limit {
 133     // The approved spending limit in micros.  One million is equivalent to
 134     // one unit.
 135     google.protobuf.Int64Value approved_spending_limit_micros = 23;
 136
 137     // The approved spending limit as a well-defined type, e.g. INFINITE.
 138     google.ads.googleads.v1.enums.SpendingLimitTypeEnum.SpendingLimitType approved_spending_limit_type = 24;
 139   }
 140 }