v1.d.ts
25.3 KB
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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace localservices_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Local Services API
*
*
*
* @example
* ```js
* const {google} = require('googleapis');
* const localservices = google.localservices('v1');
* ```
*/
export class Localservices {
context: APIRequestContext;
accountReports: Resource$Accountreports;
detailedLeadReports: Resource$Detailedleadreports;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* An Account Report of a GLS account identified by their account id containing aggregate data gathered from a particular date range. Next ID: 18
*/
export interface Schema$GoogleAdsHomeservicesLocalservicesV1AccountReport {
/**
* Unique identifier of the GLS account.
*/
accountId?: string | null;
/**
* Aggregator specific information related to the account.
*/
aggregatorInfo?: Schema$GoogleAdsHomeservicesLocalservicesV1AggregatorInfo;
/**
* Average review rating score from 1-5 stars.
*/
averageFiveStarRating?: number | null;
/**
* Average weekly budget in the currency code of the account.
*/
averageWeeklyBudget?: number | null;
/**
* Business name of the account.
*/
businessName?: string | null;
/**
* Currency code of the account.
*/
currencyCode?: string | null;
/**
* Number of charged leads the account received in current specified period.
*/
currentPeriodChargedLeads?: string | null;
/**
* Number of connected phone calls (duration over 30s) in current specified period.
*/
currentPeriodConnectedPhoneCalls?: string | null;
/**
* Number of phone calls in current specified period, including both connected and unconnected calls.
*/
currentPeriodPhoneCalls?: string | null;
/**
* Total cost of the account in current specified period in the account's specified currency.
*/
currentPeriodTotalCost?: number | null;
/**
* Number of impressions that customers have had in the past 2 days.
*/
impressionsLastTwoDays?: string | null;
/**
* Phone lead responsiveness of the account for the past 90 days from current date. This is computed by taking the total number of connected calls from charged phone leads and dividing by the total number of calls received.
*/
phoneLeadResponsiveness?: number | null;
/**
* Number of charged leads the account received in previous specified period.
*/
previousPeriodChargedLeads?: string | null;
/**
* Number of connected phone calls (duration over 30s) in previous specified period.
*/
previousPeriodConnectedPhoneCalls?: string | null;
/**
* Number of phone calls in previous specified period, including both connected and unconnected calls.
*/
previousPeriodPhoneCalls?: string | null;
/**
* Total cost of the account in previous specified period in the account's specified currency.
*/
previousPeriodTotalCost?: number | null;
/**
* Total number of reviews the account has up to current date.
*/
totalReview?: number | null;
}
/**
* Conatiner for aggregator specific information if lead is for an aggregator GLS account.
*/
export interface Schema$GoogleAdsHomeservicesLocalservicesV1AggregatorInfo {
/**
* Provider id (listed in aggregator system) which maps to a account id in GLS system.
*/
aggregatorProviderId?: string | null;
}
/**
* A Detailed Lead Report of a lead identified by their lead id and contains consumer, account, monetization, and lead data.
*/
export interface Schema$GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport {
/**
* Identifies account that received the lead.
*/
accountId?: string | null;
/**
* Aggregator specific information related to the lead.
*/
aggregatorInfo?: Schema$GoogleAdsHomeservicesLocalservicesV1AggregatorInfo;
/**
* Business name associated to the account.
*/
businessName?: string | null;
/**
* Whether the lead has been charged.
*/
chargeStatus?: string | null;
/**
* Currency code.
*/
currencyCode?: string | null;
/**
* Dispute status related to the lead.
*/
disputeStatus?: string | null;
/**
* Location of the associated account's home city.
*/
geo?: string | null;
/**
* Lead category (e.g. hvac, plumber)
*/
leadCategory?: string | null;
/**
* Timestamp of when the lead was created.
*/
leadCreationTimestamp?: string | null;
/**
* Unique identifier of a Detailed Lead Report.
*/
leadId?: string | null;
/**
* Price of the lead (available only after it has been charged).
*/
leadPrice?: number | null;
/**
* Lead type.
*/
leadType?: string | null;
/**
* More information associated to only message leads.
*/
messageLead?: Schema$GoogleAdsHomeservicesLocalservicesV1MessageLead;
/**
* More information associated to only phone leads.
*/
phoneLead?: Schema$GoogleAdsHomeservicesLocalservicesV1PhoneLead;
/**
* Timezone of the particular provider associated to a lead.
*/
timezone?: Schema$GoogleTypeTimeZone;
}
/**
* Container for message lead specific information.
*/
export interface Schema$GoogleAdsHomeservicesLocalservicesV1MessageLead {
/**
* Consumer phone number associated with the message lead.
*/
consumerPhoneNumber?: string | null;
/**
* Name of the customer who created the lead.
*/
customerName?: string | null;
/**
* The job type of the specified lead.
*/
jobType?: string | null;
/**
* The postal code of the customer who created the lead.
*/
postalCode?: string | null;
}
/**
* Container for phone lead specific information.
*/
export interface Schema$GoogleAdsHomeservicesLocalservicesV1PhoneLead {
/**
* Timestamp of the phone call which resulted in a charged phone lead.
*/
chargedCallTimestamp?: string | null;
/**
* Duration of the charged phone call in seconds.
*/
chargedConnectedCallDurationSeconds?: string | null;
/**
* Consumer phone number associated with the phone lead.
*/
consumerPhoneNumber?: string | null;
}
/**
* A page of the response received from the SearchAccountReports method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.
*/
export interface Schema$GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse {
/**
* List of account reports which maps 1:1 to a particular linked GLS account.
*/
accountReports?: Schema$GoogleAdsHomeservicesLocalservicesV1AccountReport[];
/**
* Pagination token to retrieve the next page of results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set.
*/
nextPageToken?: string | null;
}
/**
* A page of the response received from the SearchDetailedLeadReports method. A paginated response where more pages are available has `next_page_token` set. This token can be used in a subsequent request to retrieve the next request page.
*/
export interface Schema$GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse {
/**
* List of detailed lead reports uniquely identified by external lead id.
*/
detailedLeadReports?: Schema$GoogleAdsHomeservicesLocalservicesV1DetailedLeadReport[];
/**
* Pagination token to retrieve the next page of results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set.
*/
nextPageToken?: string | null;
}
/**
* Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).
*/
export interface Schema$GoogleTypeTimeZone {
/**
* IANA Time Zone Database time zone, e.g. "America/New_York".
*/
id?: string | null;
/**
* Optional. IANA Time Zone Database version number, e.g. "2019a".
*/
version?: string | null;
}
export class Resource$Accountreports {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Get account reports containing aggregate account data of all linked GLS accounts. Caller needs to provide their manager customer id and the associated auth credential that allows them read permissions on their linked accounts.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/localservices.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const localservices = google.localservices('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/adwords'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await localservices.accountReports.search({
* // Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
* 'endDate.day': 'placeholder-value',
* // Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
* 'endDate.month': 'placeholder-value',
* // Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
* 'endDate.year': 'placeholder-value',
* // The maximum number of accounts to return. If the page size is unset, page size will default to 1000. Maximum page_size is 10000. Optional.
* pageSize: 'placeholder-value',
* // The `next_page_token` value returned from a previous request to SearchAccountReports that indicates where listing should continue. Optional.
* pageToken: 'placeholder-value',
* // A query string for searching for account reports. Caller must provide a customer id of their MCC account with an associated Gaia Mint that allows read permission on their linked accounts. Search expressions are case insensitive. Example query: | Query | Description | |-------------------------|-----------------------------------------------| | manager_customer_id:123 | Get Account Report for Manager with id 123. | Required.
* query: 'placeholder-value',
* // Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
* 'startDate.day': 'placeholder-value',
* // Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
* 'startDate.month': 'placeholder-value',
* // Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
* 'startDate.year': 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "accountReports": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
search(params: Params$Resource$Accountreports$Search, options: StreamMethodOptions): GaxiosPromise<Readable>;
search(params?: Params$Resource$Accountreports$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse>;
search(params: Params$Resource$Accountreports$Search, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
search(params: Params$Resource$Accountreports$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse>, callback: BodyResponseCallback<Schema$GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse>): void;
search(params: Params$Resource$Accountreports$Search, callback: BodyResponseCallback<Schema$GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse>): void;
search(callback: BodyResponseCallback<Schema$GoogleAdsHomeservicesLocalservicesV1SearchAccountReportsResponse>): void;
}
export interface Params$Resource$Accountreports$Search extends StandardParameters {
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
'endDate.day'?: number;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
'endDate.month'?: number;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
'endDate.year'?: number;
/**
* The maximum number of accounts to return. If the page size is unset, page size will default to 1000. Maximum page_size is 10000. Optional.
*/
pageSize?: number;
/**
* The `next_page_token` value returned from a previous request to SearchAccountReports that indicates where listing should continue. Optional.
*/
pageToken?: string;
/**
* A query string for searching for account reports. Caller must provide a customer id of their MCC account with an associated Gaia Mint that allows read permission on their linked accounts. Search expressions are case insensitive. Example query: | Query | Description | |-------------------------|-----------------------------------------------| | manager_customer_id:123 | Get Account Report for Manager with id 123. | Required.
*/
query?: string;
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
'startDate.day'?: number;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
'startDate.month'?: number;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
'startDate.year'?: number;
}
export class Resource$Detailedleadreports {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Get detailed lead reports containing leads that have been received by all linked GLS accounts. Caller needs to provide their manager customer id and the associated auth credential that allows them read permissions on their linked accounts.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/localservices.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const localservices = google.localservices('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: ['https://www.googleapis.com/auth/adwords'],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await localservices.detailedLeadReports.search({
* // Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
* 'endDate.day': 'placeholder-value',
* // Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
* 'endDate.month': 'placeholder-value',
* // Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
* 'endDate.year': 'placeholder-value',
* // The maximum number of accounts to return. If the page size is unset, page size will default to 1000. Maximum page_size is 10000. Optional.
* pageSize: 'placeholder-value',
* // The `next_page_token` value returned from a previous request to SearchDetailedLeadReports that indicates where listing should continue. Optional.
* pageToken: 'placeholder-value',
* // A query string for searching for account reports. Caller must provide a customer id of their MCC account with an associated Gaia Mint that allows read permission on their linked accounts. Search expressions are case insensitive. Example query: | Query | Description | |-------------------------|-----------------------------------------------| | manager_customer_id:123 | Get Detailed Lead Report for Manager with id | | | 123. | Required.
* query: 'placeholder-value',
* // Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
* 'startDate.day': 'placeholder-value',
* // Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
* 'startDate.month': 'placeholder-value',
* // Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
* 'startDate.year': 'placeholder-value',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "detailedLeadReports": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
search(params: Params$Resource$Detailedleadreports$Search, options: StreamMethodOptions): GaxiosPromise<Readable>;
search(params?: Params$Resource$Detailedleadreports$Search, options?: MethodOptions): GaxiosPromise<Schema$GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse>;
search(params: Params$Resource$Detailedleadreports$Search, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
search(params: Params$Resource$Detailedleadreports$Search, options: MethodOptions | BodyResponseCallback<Schema$GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse>, callback: BodyResponseCallback<Schema$GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse>): void;
search(params: Params$Resource$Detailedleadreports$Search, callback: BodyResponseCallback<Schema$GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse>): void;
search(callback: BodyResponseCallback<Schema$GoogleAdsHomeservicesLocalservicesV1SearchDetailedLeadReportsResponse>): void;
}
export interface Params$Resource$Detailedleadreports$Search extends StandardParameters {
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
'endDate.day'?: number;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
'endDate.month'?: number;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
'endDate.year'?: number;
/**
* The maximum number of accounts to return. If the page size is unset, page size will default to 1000. Maximum page_size is 10000. Optional.
*/
pageSize?: number;
/**
* The `next_page_token` value returned from a previous request to SearchDetailedLeadReports that indicates where listing should continue. Optional.
*/
pageToken?: string;
/**
* A query string for searching for account reports. Caller must provide a customer id of their MCC account with an associated Gaia Mint that allows read permission on their linked accounts. Search expressions are case insensitive. Example query: | Query | Description | |-------------------------|-----------------------------------------------| | manager_customer_id:123 | Get Detailed Lead Report for Manager with id | | | 123. | Required.
*/
query?: string;
/**
* Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
*/
'startDate.day'?: number;
/**
* Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
*/
'startDate.month'?: number;
/**
* Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
*/
'startDate.year'?: number;
}
export {};
}