legacy-libs/google-proto-files/google/ads/googleads/v1/resources/campaign_budget.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/budget_delivery_method.proto";
  21 import "google/ads/googleads/v1/enums/budget_period.proto";
  22 import "google/ads/googleads/v1/enums/budget_status.proto";
  23 import "google/protobuf/wrappers.proto";
  24 import "google/api/annotations.proto";
  25
  26 option csharp_namespace = "Google.Ads.GoogleAds.V1.Resources";
  27 option go_package = "google.golang.org/genproto/googleapis/ads/googleads/v1/resources;resources";
  28 option java_multiple_files = true;
  29 option java_outer_classname = "CampaignBudgetProto";
  30 option java_package = "com.google.ads.googleads.v1.resources";
  31 option objc_class_prefix = "GAA";
  32 option php_namespace = "Google\\Ads\\GoogleAds\\V1\\Resources";
  33 option ruby_package = "Google::Ads::GoogleAds::V1::Resources";
  34 // Proto file describing the Budget resource.
  35
  36 // A campaign budget.
  37 message CampaignBudget {
  38   // The resource name of the campaign budget.
  39   // Campaign budget resource names have the form:
  40   //
  41   // `customers/{customer_id}/campaignBudgets/{budget_id}`
  42   string resource_name = 1;
  43
  44   // The ID of the campaign budget.
  45   //
  46   // A campaign budget is created using the CampaignBudgetService create
  47   // operation and is assigned a budget ID. A budget ID can be shared across
  48   // different campaigns; the system will then allocate the campaign budget
  49   // among different campaigns to get optimum results.
  50   google.protobuf.Int64Value id = 3;
  51
  52   // The name of the campaign budget.
  53   //
  54   // When creating a campaign budget through CampaignBudgetService, every
  55   // explicitly shared campaign budget must have a non-null, non-empty name.
  56   // Campaign budgets that are not explicitly shared derive their name from the
  57   // attached campaign's name.
  58   //
  59   // The length of this string must be between 1 and 255, inclusive,
  60   // in UTF-8 bytes, (trimmed).
  61   google.protobuf.StringValue name = 4;
  62
  63   // The amount of the budget, in the local currency for the account.
  64   // Amount is specified in micros, where one million is equivalent to one
  65   // currency unit.
  66   google.protobuf.Int64Value amount_micros = 5;
  67
  68   // The lifetime amount of the budget, in the local currency for the account.
  69   // Amount is specified in micros, where one million is equivalent to one
  70   // currency unit.
  71   google.protobuf.Int64Value total_amount_micros = 10;
  72
  73   // The status of this campaign budget. This field is read-only.
  74   google.ads.googleads.v1.enums.BudgetStatusEnum.BudgetStatus status = 6;
  75
  76   // The delivery method that determines the rate at which the campaign budget
  77   // is spent.
  78   //
  79   // Defaults to STANDARD if unspecified in a create operation.
  80   google.ads.googleads.v1.enums.BudgetDeliveryMethodEnum.BudgetDeliveryMethod delivery_method = 7;
  81
  82   // Specifies whether the budget is explicitly shared. Defaults to true if
  83   // unspecified in a create operation.
  84   //
  85   // If true, the budget was created with the purpose of sharing
  86   // across one or more campaigns.
  87   //
  88   // If false, the budget was created with the intention of only being used
  89   // with a single campaign. The budget's name and status will stay in sync
  90   // with the campaign's name and status. Attempting to share the budget with a
  91   // second campaign will result in an error.
  92   //
  93   // A non-shared budget can become an explicitly shared. The same operation
  94   // must also assign the budget a name.
  95   //
  96   // A shared campaign budget can never become non-shared.
  97   google.protobuf.BoolValue explicitly_shared = 8;
  98
  99   // The number of campaigns actively using the budget.
 100   //
 101   // This field is read-only.
 102   google.protobuf.Int64Value reference_count = 9;
 103
 104   // Indicates whether there is a recommended budget for this campaign budget.
 105   //
 106   // This field is read-only.
 107   google.protobuf.BoolValue has_recommended_budget = 11;
 108
 109   // The recommended budget amount. If no recommendation is available, this will
 110   // be set to the budget amount.
 111   // Amount is specified in micros, where one million is equivalent to one
 112   // currency unit.
 113   //
 114   // This field is read-only.
 115   google.protobuf.Int64Value recommended_budget_amount_micros = 12;
 116
 117   // Period over which to spend the budget. Defaults to DAILY if not specified.
 118   google.ads.googleads.v1.enums.BudgetPeriodEnum.BudgetPeriod period = 13;
 119
 120   // The estimated change in weekly clicks if the recommended budget is applied.
 121   //
 122   // This field is read-only.
 123   google.protobuf.Int64Value recommended_budget_estimated_change_weekly_clicks = 14;
 124
 125   // The estimated change in weekly cost in micros if the recommended budget is
 126   // applied. One million is equivalent to one currency unit.
 127   //
 128   // This field is read-only.
 129   google.protobuf.Int64Value recommended_budget_estimated_change_weekly_cost_micros = 15;
 130
 131   // The estimated change in weekly interactions if the recommended budget is
 132   // applied.
 133   //
 134   // This field is read-only.
 135   google.protobuf.Int64Value recommended_budget_estimated_change_weekly_interactions = 16;
 136
 137   // The estimated change in weekly views if the recommended budget is applied.
 138   //
 139   // This field is read-only.
 140   google.protobuf.Int64Value recommended_budget_estimated_change_weekly_views = 17;
 141 }