/
AddBillingSetup.cs
267 lines (242 loc) · 12.7 KB
/
AddBillingSetup.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
using CommandLine;
using Google.Ads.Gax.Examples;
using Google.Ads.GoogleAds.Lib;
using Google.Ads.GoogleAds.V16.Errors;
using Google.Ads.GoogleAds.V16.Resources;
using Google.Ads.GoogleAds.V16.Services;
using Google.Api.Gax;
using System;
using System.Collections.Generic;
using System.Linq;
using static Google.Ads.GoogleAds.V16.Enums.TimeTypeEnum.Types;
namespace Google.Ads.GoogleAds.Examples.V16
{
/// <summary>
/// This example creates a billing setup for a customer. A billing setup is a link between a
/// payments account and a customer. The new billing setup can either reuse an existing payments
/// account, or create a new payments account with a given payments profile. Billing setups are
/// applicable for clients on monthly invoicing only. See here for details about applying for
/// monthly invoicing: https://support.google.com/google-ads/answer/2375377 In the case of
/// consolidated billing, a payments account is linked to the manager account and is linked to a
/// customer account via a billing setup.
/// </summary>
public class AddBillingSetup : ExampleBase
{
/// <summary>
/// Command line options for running the <see cref="AddBillingSetup"/> example.
/// </summary>
public class Options : OptionsBase
{
/// <summary>
/// The Google Ads customer ID for which the call is made.
/// </summary>
[Option("customerId", Required = true, HelpText =
"The Google Ads customer ID for which the call is made.")]
public long CustomerId { get; set; }
/// <summary>
/// Optional payments account ID to attach to the new billing setup. Must be formatted
/// as "1234-5678-9012-3456".
/// </summary>
[Option("paymentsAccountId", Required = false, HelpText =
"Optional payments account ID to attach to the new billing setup. Must be " +
"formatted as '1234-5678-9012-3456'.")]
public string PaymentsAccountId { get; set; }
/// <summary>
/// Optional payments profile ID to attach to a new payments account and to the new
/// billing setup. Must be formatted as "1234-5678-9012".
/// </summary>
[Option("paymentsProfileId", Required = false, HelpText =
"Optional payments profile ID to attach to a new payments account and to the new" +
" billing setup. Must be formatted as '1234-5678-9012'.")]
public string PaymentsProfileId { get; set; }
}
/// <summary>
/// Main method, to run this code example as a standalone application.
/// </summary>
/// <param name="args">The command line arguments.</param>
public static void Main(string[] args)
{
Options options = ExampleUtilities.ParseCommandLine<Options>(args);
AddBillingSetup codeExample = new AddBillingSetup();
Console.WriteLine(codeExample.Description);
codeExample.Run(new GoogleAdsClient(), options.CustomerId, options.PaymentsAccountId,
options.PaymentsProfileId);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description =>
"This example creates a billing setup for a customer. A billing setup is a link " +
"between a payments account and a customer. The new billing setup can either reuse " +
"an existing payments account, or create a new payments account with a given " +
"payments profile.\n" +
"Billing setups are applicable for clients on monthly invoicing only. See here for " +
"details about applying for monthly invoicing: " +
"https://support.google.com/google-ads/answer/2375377\n" +
"In the case of consolidated billing, a payments account is linked to the " +
"manager account and is linked to a customer account via a billing setup.";
/// <summary>
/// Runs the code example. Either a payments account ID or a payments profile ID must be
/// provided for the example to run successfully. If both are provided, only the payments
/// account ID will be used.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The Google Ads customer ID for which the call is made.</param>
/// <param name="paymentsAccountId">
/// Optional payments account ID to attach to the new billing setup. Must be formatted as
/// "1234-5678-9012-3456".
/// </param>
/// <param name="paymentsProfileId">
/// Optional payments profile ID to attach to a new payments account and to the new billing
/// setup. Must be formatted as "1234-5678-9012".
/// </param>
public void Run(GoogleAdsClient client, long customerId, string paymentsAccountId,
string paymentsProfileId)
{
// Gets the GoogleAdsServiceClient.
GoogleAdsServiceClient googleAdsService = client.GetService(
Services.V16.GoogleAdsService);
// Gets the BillingSetupServiceClient.
BillingSetupServiceClient billingSetupServiceClient =
client.GetService(Services.V16.BillingSetupService);
try
{
// Constructs a new billing setup.
BillingSetup billingSetup =
CreateBillingSetup(customerId, paymentsAccountId, paymentsProfileId);
SetBillingSetupStartDateTime(googleAdsService, customerId, billingSetup);
// Creates the billing setup operation.
BillingSetupOperation operation = new BillingSetupOperation()
{
Create = billingSetup
};
// Issues a mutate request to add the billing setup.
MutateBillingSetupResponse billingResponse =
billingSetupServiceClient.MutateBillingSetup(customerId.ToString(), operation);
Console.WriteLine("Added new billing setup with resource name: " +
$"{billingResponse.Result.ResourceName}");
}
catch (GoogleAdsException e)
{
Console.WriteLine("Failure:");
Console.WriteLine($"Message: {e.Message}");
Console.WriteLine($"Failure: {e.Failure}");
Console.WriteLine($"Request ID: {e.RequestId}");
throw;
}
}
/// <summary>
/// Creates and returns a new Billing Setup instance with complete payment details. One of
/// paymentsAccountId or paymentsProfileId must be provided.
/// </summary>
/// <param name="customerId">The Google Ads customer ID for which the call is made.</param>
/// <param name="paymentsAccountId">
/// Optional payments account ID to attach to the new billing setup. Must be formatted as
/// "1234-5678-9012-3456".
/// </param>
/// <param name="paymentsProfileId">
/// Optional payments profile ID to attach to a new payments account and to the new billing
/// setup. Must be formatted as "1234-5678-9012".
/// </param>
/// <returns>A new BillingSetup instance with complete payment details.</returns>
/// <exception cref="Exception">
/// Generic exception if no payment details have been provided.
/// </exception>
private BillingSetup CreateBillingSetup(long customerId, string paymentsAccountId,
string paymentsProfileId)
{
BillingSetup billingSetup = new BillingSetup();
// Sets the appropriate payments account field.
if (paymentsAccountId != null)
{
// If a payments account id has been provided, set PaymentsAccount to its resource
// name. You can list available payments accounts via the PaymentsAccountService's
// ListPaymentsAccounts method.
billingSetup.PaymentsAccount =
ResourceNames.PaymentsAccount(customerId, paymentsAccountId);
}
else if (paymentsProfileId != null)
{
// Otherwise, create a new payments account by setting the PaymentsAccountInfo
// field. See https://support.google.com/google-ads/answer/7268503 for information
// about payments profiles.
billingSetup.PaymentsAccountInfo = new BillingSetup.Types.PaymentsAccountInfo()
{
PaymentsAccountName = "Payments Account #" + ExampleUtilities.GetRandomString(),
PaymentsProfileId = paymentsProfileId
};
}
else
{
throw new Exception("No paymentsAccountId or paymentsProfileId provided.");
}
return billingSetup;
}
/// <summary>
/// Sets the starting and ending date times for the new billing setup. Queries the
/// customer's account to see if there are any approved billing setups. If there are any,
/// the new billing setup starting date time is set to one day after the last. If not, the
/// billing setup is set to start immediately. The ending date is set to one day after the
/// starting date time.
/// </summary>
/// <param name="googleAdsService">The Google Ads service client.</param>
/// <param name="customerId">The Google Ads customer ID for which the call is made.</param>
/// <param name="billingSetup">
/// The instance of BillingSetup whose starting date time will be set.
/// </param>
private void SetBillingSetupStartDateTime(GoogleAdsServiceClient googleAdsService,
long customerId, BillingSetup billingSetup)
{
// The query to search existing approved billing setups in the end date time descending
// order. See GetBillingSetup.cs for a more detailed example of requesting billing setup
// information.
string query = @"
SELECT billing_setup.end_date_time
FROM billing_setup
WHERE billing_setup.status = 'APPROVED'
ORDER BY billing_setup.end_date_time DESC
LIMIT 1";
// Issues a search request.
PagedEnumerable<SearchGoogleAdsResponse, GoogleAdsRow> searchResponse =
googleAdsService.Search(customerId.ToString(), query);
if (searchResponse.Any())
{
// Retrieves the ending date time of the last billing setup.
string lastEndingDateTimeString = searchResponse.First().BillingSetup.EndDateTime;
// A null ending date time indicates that the current billing setup is set to run
// indefinitely. Billing setups cannot overlap, so throw an exception in this case.
if (lastEndingDateTimeString == null)
{
throw new Exception("Cannot set starting and ending date times for " +
"the new billing setup; the latest existing billing " +
"setup is set to run indefinitely.");
}
DateTime lastEndingDateTime = DateTime.Parse(lastEndingDateTimeString);
// Sets the new billing setup to start one day after the ending date time.
billingSetup.StartDateTime = lastEndingDateTime.AddDays(1).ToString("yyyy-MM-dd");
// Sets the new billing setup to end one day after the starting date time.
billingSetup.EndDateTime = lastEndingDateTime.AddDays(2).ToString("yyyy-MM-dd");
}
else
{
// Otherwise, the only acceptable start time is TimeType.Now.
billingSetup.StartTimeType = TimeType.Now;
// Sets the new billing setup to end tomorrow.
billingSetup.EndDateTime = DateTime.Today.AddDays(1).ToString("yyyy-MM-dd");
}
}
}
}