v2.d.ts
130 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
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
/**
* Copyright 2019 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.
*/
import { OAuth2Client, JWT, Compute, UserRefreshClient } from 'google-auth-library';
import { GoogleConfigurable, MethodOptions, GlobalOptions, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { GaxiosPromise } from 'gaxios';
export declare namespace jobs_v2 {
export interface Options extends GlobalOptions {
version: 'v2';
}
interface StandardParameters {
/**
* 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;
}
/**
* Cloud Talent Solution API
*
* Cloud Talent Solution provides the capability to create, read, update, and delete job postings, as well as search jobs based on keywords and filters.
*
* @example
* const {google} = require('googleapis');
* const jobs = google.jobs('v2');
*
* @namespace jobs
* @type {Function}
* @version v2
* @variation v2
* @param {object=} options Options for Jobs
*/
export class Jobs {
context: APIRequestContext;
companies: Resource$Companies;
jobs: Resource$Jobs;
v2: Resource$V2;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Input only. Batch delete jobs request.
*/
export interface Schema$BatchDeleteJobsRequest {
/**
* Required. The filter string specifies the jobs to be deleted. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Required) Sample Query: companyName = "companies/123" AND requisitionId = "req-1"
*/
filter?: string | null;
}
/**
* Represents count of jobs within one bucket.
*/
export interface Schema$BucketizedCount {
/**
* Number of jobs whose numeric field value fall into `range`.
*/
count?: number | null;
/**
* Bucket range on which histogram was performed for the numeric field, that is, the count represents number of jobs in this range.
*/
range?: Schema$BucketRange;
}
/**
* Represents starting and ending value of a range in double.
*/
export interface Schema$BucketRange {
/**
* Starting value of the bucket range.
*/
from?: number | null;
/**
* Ending value of the bucket range.
*/
to?: number | null;
}
/**
* Output only. Commute details related to this job.
*/
export interface Schema$CommuteInfo {
/**
* Location used as the destination in the commute calculation.
*/
jobLocation?: Schema$JobLocation;
/**
* The number of seconds required to travel to the job location from the query location. A duration of 0 seconds indicates that the job is not reachable within the requested duration, but was returned as part of an expanded query.
*/
travelDuration?: string | null;
}
/**
* Input only. Parameters needed for commute search.
*/
export interface Schema$CommutePreference {
/**
* Optional. If `true`, jobs without street level addresses may also be returned. For city level addresses, the city center is used. For state and coarser level addresses, text matching is used. If this field is set to `false` or is not specified, only jobs that include street level addresses will be returned by commute search.
*/
allowNonStreetLevelAddress?: boolean | null;
/**
* Optional. The departure hour to use to calculate traffic impact. Accepts an integer between 0 and 23, representing the hour in the time zone of the start_location. Must not be present if road_traffic is specified.
*/
departureHourLocal?: number | null;
/**
* Required. The method of transportation for which to calculate the commute time.
*/
method?: string | null;
/**
* Optional. Specifies the traffic density to use when calculating commute time. Must not be present if departure_hour_local is specified.
*/
roadTraffic?: string | null;
/**
* Required. The latitude and longitude of the location from which to calculate the commute time.
*/
startLocation?: Schema$LatLng;
/**
* Required. The maximum travel time in seconds. The maximum allowed value is `3600s` (one hour). Format is `123s`.
*/
travelTime?: string | null;
}
/**
* A Company resource represents a company in the service. A company is the entity that owns job listings, that is, the hiring entity responsible for employing applicants for the job position.
*/
export interface Schema$Company {
/**
* Optional. The URL to employer's career site or careers page on the employer's web site.
*/
careerPageLink?: string | null;
/**
* Optional. Identifiers external to the application that help to further identify the employer.
*/
companyInfoSources?: Schema$CompanyInfoSource[];
/**
* Optional. The employer's company size.
*/
companySize?: string | null;
/**
* Deprecated. Do not use this field. Optional. This field is no longer used. Any value set to it is ignored.
*/
disableLocationOptimization?: boolean | null;
/**
* Required. The name of the employer to be displayed with the job, for example, "Google, LLC.".
*/
displayName?: string | null;
/**
* Optional. The unique company identifier provided by the client to identify an employer for billing purposes. Recommended practice is to use the distributor_company_id. Defaults to same value as distributor_company_id when a value is not provided.
*/
distributorBillingCompanyId?: string | null;
/**
* Required. A client's company identifier, used to uniquely identify the company. If an employer has a subsidiary or sub-brand, such as "Alphabet" and "Google", which the client wishes to use as the company displayed on the job. Best practice is to create a distinct company identifier for each distinct brand displayed. The maximum number of allowed characters is 255.
*/
distributorCompanyId?: string | null;
/**
* Optional. Equal Employment Opportunity legal disclaimer text to be associated with all jobs, and typically to be displayed in all roles. The maximum number of allowed characters is 500.
*/
eeoText?: string | null;
/**
* Optional. Set to true if it is the hiring agency that post jobs for other employers. Defaults to false if not provided.
*/
hiringAgency?: boolean | null;
/**
* Optional. The street address of the company's main headquarters, which may be different from the job location. The service attempts to geolocate the provided address, and populates a more specific location wherever possible in structured_company_hq_location.
*/
hqLocation?: string | null;
/**
* Optional. A URL that hosts the employer's company logo. If provided, the logo image should be squared at 80x80 pixels. The url must be a Google Photos or Google Album url. Only images in these Google sub-domains are accepted.
*/
imageUrl?: string | null;
/**
* Optional. A list of keys of filterable Job.custom_attributes, whose corresponding `string_values` are used in keyword search. Jobs with `string_values` under these specified field keys are returned if any of the values matches the search keyword. Custom field values with parenthesis, brackets and special symbols might not be properly searchable, and those keyword queries need to be surrounded by quotes.
*/
keywordSearchableCustomAttributes?: string[] | null;
/**
* Deprecated. Use keyword_searchable_custom_attributes instead. Optional. A list of filterable custom fields that should be used in keyword search. The jobs of this company are returned if any of these custom fields matches the search keyword. Custom field values with parenthesis, brackets and special symbols might not be properly searchable, and those keyword queries need to be surrounded by quotes.
*/
keywordSearchableCustomFields?: number[] | null;
/**
* Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".
*/
name?: string | null;
/**
* Output only. A structured headquarters location of the company, resolved from hq_location if possible.
*/
structuredCompanyHqLocation?: Schema$JobLocation;
/**
* Output only. Indicates whether a company is flagged to be suspended from public availability by the service when job content appears suspicious, abusive, or spammy.
*/
suspended?: boolean | null;
/**
* Deprecated. Use display_name instead. Required. The name of the employer to be displayed with the job, for example, "Google, LLC.".
*/
title?: string | null;
/**
* Optional. The URL representing the company's primary web site or home page, such as, "www.google.com".
*/
website?: string | null;
}
/**
* A resource that represents an external Google identifier for a company, for example, a Google+ business page or a Google Maps business page. For unsupported types, use `unknown_type_id`.
*/
export interface Schema$CompanyInfoSource {
/**
* Optional. The Google's Knowledge Graph value for the employer's company.
*/
freebaseMid?: string | null;
/**
* Optional. The numeric identifier for the employer's Google+ business page.
*/
gplusId?: string | null;
/**
* Optional. The numeric identifier for the employer's headquarters on Google Maps, namely, the Google Maps CID (cell id).
*/
mapsCid?: string | null;
/**
* Optional. A Google identifier that does not match any of the other types.
*/
unknownTypeId?: string | null;
}
/**
* A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type. Annualization: One compensation entry can be annualized if - it contains valid amount or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year.
*/
export interface Schema$CompensationEntry {
/**
* Optional. Compensation amount.
*/
amount?: Schema$Money;
/**
* Optional. Compensation description. For example, could indicate equity terms or provide additional context to an estimated bonus.
*/
description?: string | null;
/**
* Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1
*/
expectedUnitsPerYear?: number | null;
/**
* Optional. Compensation range.
*/
range?: Schema$CompensationRange;
/**
* Required. Compensation type.
*/
type?: string | null;
/**
* Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
*/
unit?: string | null;
}
/**
* Input only. Filter on job compensation type and amount.
*/
export interface Schema$CompensationFilter {
/**
* Optional. Whether to include jobs whose compensation range is unspecified.
*/
includeJobsWithUnspecifiedCompensationRange?: boolean | null;
/**
* Optional. Compensation range.
*/
range?: Schema$CompensationRange;
/**
* Required. Type of filter.
*/
type?: string | null;
/**
* Required. Specify desired `base compensation entry's` CompensationInfo.CompensationUnit.
*/
units?: string[] | null;
}
/**
* Input only. Compensation based histogram request.
*/
export interface Schema$CompensationHistogramRequest {
/**
* Required. Numeric histogram options, like buckets, whether include min or max value.
*/
bucketingOption?: Schema$NumericBucketingOption;
/**
* Required. Type of the request, representing which field the histogramming should be performed over. A single request can only specify one histogram of each `CompensationHistogramRequestType`.
*/
type?: string | null;
}
/**
* Output only. Compensation based histogram result.
*/
export interface Schema$CompensationHistogramResult {
/**
* Histogram result.
*/
result?: Schema$NumericBucketingResult;
/**
* Type of the request, corresponding to CompensationHistogramRequest.type.
*/
type?: string | null;
}
/**
* Job compensation details.
*/
export interface Schema$CompensationInfo {
/**
* Deprecated. Use entries instead. Optional. The amount of compensation or pay for the job. As an alternative, compensation_amount_min and compensation_amount_max may be used to define a range of compensation.
*/
amount?: Schema$Money;
/**
* Output only. Annualized base compensation range. Computed as base compensation entry's CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization.
*/
annualizedBaseCompensationRange?: Schema$CompensationRange;
/**
* Output only. Annualized total compensation range. Computed as all compensation entries' CompensationEntry.compensation times CompensationEntry.expected_units_per_year. See CompensationEntry for explanation on compensation annualization.
*/
annualizedTotalCompensationRange?: Schema$CompensationRange;
/**
* Optional. Job compensation information. At most one entry can be of type CompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job.
*/
entries?: Schema$CompensationEntry[];
/**
* Deprecated. Use entries instead. Optional. An upper bound on a range for compensation or pay for the job. The currency type is specified in compensation_amount.
*/
max?: Schema$Money;
/**
* Deprecated. Use entries instead. Optional. A lower bound on a range for compensation or pay for the job. The currency type is specified in compensation_amount.
*/
min?: Schema$Money;
/**
* Deprecated. Use entries instead. Optional. Type of job compensation.
*/
type?: string | null;
}
/**
* Compensation range.
*/
export interface Schema$CompensationRange {
/**
* Optional. The maximum amount of compensation. If left empty, the value is set to a maximal compensation value and the currency code is set to match the currency code of min_compensation.
*/
max?: Schema$Money;
/**
* Optional. The minimum amount of compensation. If left empty, the value is set to zero and the currency code is set to match the currency code of max_compensation.
*/
min?: Schema$Money;
}
/**
* Output only. Response of auto-complete query.
*/
export interface Schema$CompleteQueryResponse {
/**
* Results of the matching job/company candidates.
*/
completionResults?: Schema$CompletionResult[];
/**
* Additional information for the API invocation, such as the request tracking id.
*/
metadata?: Schema$ResponseMetadata;
}
/**
* Output only. Resource that represents completion results.
*/
export interface Schema$CompletionResult {
/**
* The URL for the company logo if `type=COMPANY_NAME`.
*/
imageUrl?: string | null;
/**
* The suggestion for the query.
*/
suggestion?: string | null;
/**
* The completion topic.
*/
type?: string | null;
}
/**
* Input only. Create job request.
*/
export interface Schema$CreateJobRequest {
/**
* Deprecated. Please use processing_options. This flag is ignored if processing_options is set. Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job.
*/
disableStreetAddressResolution?: boolean | null;
/**
* Required. The Job to be created.
*/
job?: Schema$Job;
/**
* Optional. Options for job processing.
*/
processingOptions?: Schema$JobProcessingOptions;
}
/**
* Custom attribute values that are either filterable or non-filterable.
*/
export interface Schema$CustomAttribute {
/**
* Optional. If the `filterable` flag is true, custom field values are searchable. If false, values are not searchable. Default is false.
*/
filterable?: boolean | null;
/**
* Optional but at least one of string_values or long_value must be specified. This field is used to perform number range search. (`EQ`, `GT`, `GE`, `LE`, `LT`) over filterable `long_value`. For `long_value`, a value between Long.MIN and Long.MAX is allowed.
*/
longValue?: string | null;
/**
* Optional but at least one of string_values or long_value must be specified. This field is used to perform a string match (`CASE_SENSITIVE_MATCH` or `CASE_INSENSITIVE_MATCH`) search. For filterable `string_values`, a maximum total number of 200 values is allowed, with each `string_value` has a byte size of no more than 255B. For unfilterable `string_values`, the maximum total byte size of unfilterable `string_values` is 50KB. Empty strings are not allowed.
*/
stringValues?: Schema$StringValues;
}
/**
* Custom attributes histogram request. An error will be thrown if neither string_value_histogram or long_value_histogram_bucketing_option has been defined.
*/
export interface Schema$CustomAttributeHistogramRequest {
/**
* Required. Specifies the custom field key to perform a histogram on. If specified without `long_value_histogram_bucketing_option`, histogram on string values of the given `key` is triggered, otherwise histogram is performed on long values.
*/
key?: string | null;
/**
* Optional. Specifies buckets used to perform a range histogram on Job's filterable long custom field values, or min/max value requirements.
*/
longValueHistogramBucketingOption?: Schema$NumericBucketingOption;
/**
* Optional. If set to true, the response will include the histogram value for each key as a string.
*/
stringValueHistogram?: boolean | null;
}
/**
* Output only. Custom attribute histogram result.
*/
export interface Schema$CustomAttributeHistogramResult {
/**
* Stores the key of custom attribute the histogram is performed on.
*/
key?: string | null;
/**
* Stores bucketed histogram counting result or min/max values for custom attribute long values associated with `key`.
*/
longValueHistogramResult?: Schema$NumericBucketingResult;
/**
* Stores a map from the values of string custom field associated with `key` to the number of jobs with that value in this histogram result.
*/
stringValueHistogramResult?: {
[key: string]: number;
} | null;
}
/**
* Resource that represents the custom data not captured by the standard fields.
*/
export interface Schema$CustomField {
/**
* Optional. The values of the custom data.
*/
values?: string[] | null;
}
/**
* Input only. Custom field filter of the search.
*/
export interface Schema$CustomFieldFilter {
/**
* Required. The query strings for the filter.
*/
queries?: string[] | null;
/**
* Optional. The type of filter. Defaults to FilterType.OR.
*/
type?: string | null;
}
/**
* Represents a whole or partial calendar date, e.g. a birthday. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. This can represent: * A full date, with non-zero year, month and day values * A month and day value, with a zero year, e.g. an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, e.g. a credit card expiration date Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`.
*/
export interface Schema$Date {
/**
* Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a year by itself or a year and month where the day is not significant.
*/
day?: number | null;
/**
* Month of year. Must be from 1 to 12, or 0 if specifying a year without a month and day.
*/
month?: number | null;
/**
* Year of date. Must be from 1 to 9999, or 0 if specifying a date without a year.
*/
year?: number | null;
}
/**
* Deprecated. Use BatchDeleteJobsRequest instead. Input only. Delete job by filter request. The job typically becomes unsearchable within 10 seconds, but it may take up to 5 minutes.
*/
export interface Schema$DeleteJobsByFilterRequest {
/**
* Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster.
*/
disableFastProcess?: boolean | null;
/**
* Required. Restrictions on the scope of the delete request.
*/
filter?: Schema$Filter;
}
/**
* Input only. Device information collected from the job seeker, candidate, or other entity conducting the job search. Providing this information improves the quality of the search results across devices.
*/
export interface Schema$DeviceInfo {
/**
* Optional. Type of the device.
*/
deviceType?: string | null;
/**
* Optional. A device-specific ID. The ID must be a unique identifier that distinguishes the device from other devices.
*/
id?: string | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
*/
export interface Schema$Empty {
}
/**
* Deprecated. Always use CompensationFilter. Input only. Filter on job compensation type and amount.
*/
export interface Schema$ExtendedCompensationFilter {
/**
* Optional. Compensation range.
*/
compensationRange?: Schema$ExtendedCompensationInfoCompensationRange;
/**
* Required. Specify desired `base compensation entry's` ExtendedCompensationInfo.CompensationUnit.
*/
compensationUnits?: string[] | null;
/**
* Optional. Specify currency in 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) format. If unspecified, jobs are returned regardless of currency.
*/
currency?: string | null;
/**
* Optional. Whether to include jobs whose compensation range is unspecified.
*/
includeJobWithUnspecifiedCompensationRange?: boolean | null;
/**
* Required. Type of filter.
*/
type?: string | null;
}
/**
* Deprecated. Use CompensationInfo. Describes job compensation.
*/
export interface Schema$ExtendedCompensationInfo {
/**
* Output only. Annualized base compensation range.
*/
annualizedBaseCompensationRange?: Schema$ExtendedCompensationInfoCompensationRange;
/**
* Output only. Indicates annualized base compensation range cannot be derived, due to the job's base compensation entry cannot be annualized. See CompensationEntry for explanation on annualization and base compensation entry.
*/
annualizedBaseCompensationUnspecified?: boolean | null;
/**
* Output only. Annualized total compensation range.
*/
annualizedTotalCompensationRange?: Schema$ExtendedCompensationInfoCompensationRange;
/**
* Output only. Indicates annualized total compensation range cannot be derived, due to the job's all CompensationEntry cannot be annualized. See CompensationEntry for explanation on annualization and base compensation entry.
*/
annualizedTotalCompensationUnspecified?: boolean | null;
/**
* Optional. A 3-letter [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code.
*/
currency?: string | null;
/**
* Optional. Job compensation information. At most one entry can be of type ExtendedCompensationInfo.CompensationType.BASE, which is referred as ** base compensation entry ** for the job.
*/
entries?: Schema$ExtendedCompensationInfoCompensationEntry[];
}
/**
* Deprecated. See CompensationInfo. A compensation entry that represents one component of compensation, such as base pay, bonus, or other compensation type. Annualization: One compensation entry can be annualized if - it contains valid amount or range. - and its expected_units_per_year is set or can be derived. Its annualized range is determined as (amount or range) times expected_units_per_year.
*/
export interface Schema$ExtendedCompensationInfoCompensationEntry {
/**
* Optional. Monetary amount.
*/
amount?: Schema$ExtendedCompensationInfoDecimal;
/**
* Optional. Compensation description.
*/
description?: string | null;
/**
* Optional. Expected number of units paid each year. If not specified, when Job.employment_types is FULLTIME, a default value is inferred based on unit. Default values: - HOURLY: 2080 - DAILY: 260 - WEEKLY: 52 - MONTHLY: 12 - ANNUAL: 1
*/
expectedUnitsPerYear?: Schema$ExtendedCompensationInfoDecimal;
/**
* Optional. Compensation range.
*/
range?: Schema$ExtendedCompensationInfoCompensationRange;
/**
* Required. Compensation type.
*/
type?: string | null;
/**
* Optional. Frequency of the specified amount. Default is CompensationUnit.COMPENSATION_UNIT_UNSPECIFIED.
*/
unit?: string | null;
/**
* Optional. Indicates compensation amount and range are unset.
*/
unspecified?: boolean | null;
}
/**
* Deprecated. See CompensationInfo. Compensation range.
*/
export interface Schema$ExtendedCompensationInfoCompensationRange {
/**
* Required. Maximum value.
*/
max?: Schema$ExtendedCompensationInfoDecimal;
/**
* Required. Minimum value.
*/
min?: Schema$ExtendedCompensationInfoDecimal;
}
/**
* Deprecated. See CompensationInfo. Decimal number.
*/
export interface Schema$ExtendedCompensationInfoDecimal {
/**
* Micro (10^-6) units. The value must be between -999,999 and +999,999 inclusive. If `units` is positive, `micros` must be positive or zero. If `units` is zero, `micros` can be positive, zero, or negative. If `units` is negative, `micros` must be negative or zero. For example -1.75 is represented as `units`=-1 and `micros`=-750,000.
*/
micros?: number | null;
/**
* Whole units.
*/
units?: string | null;
}
/**
* Deprecated. Use BatchDeleteJobsRequest instead. Input only. Filter for jobs to be deleted.
*/
export interface Schema$Filter {
/**
* Required. The requisition ID (or posting ID) assigned by the client to identify a job. This is intended for client identification and tracking of listings. name takes precedence over this field The maximum number of allowed characters is 225.
*/
requisitionId?: string | null;
}
/**
* Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Input only. A request for the `GetHistogram` method.
*/
export interface Schema$GetHistogramRequest {
/**
* Optional. Controls whether to broaden the search to avoid too few results for a given query in instances where a search has sparse results. Results from a broadened query is a superset of the results from the original query. Defaults to false.
*/
allowBroadening?: boolean | null;
/**
* Deprecated. Use query instead. Optional. Restrictions on the scope of the histogram.
*/
filters?: Schema$JobFilters;
/**
* Optional. Query used to search against jobs, such as keyword, location filters, etc.
*/
query?: Schema$JobQuery;
/**
* Meta information, such as `user_id`, collected from the job searcher or other entity conducting a job search, is used to improve the service's search quality. Users determine identifier values, which must be unique and consist.
*/
requestMetadata?: Schema$RequestMetadata;
/**
* Required. A list of facets that specify the histogram data to be calculated against and returned. Histogram response times can be slow, and counts can be approximations. This call may be temporarily or permanently removed prior to the production release of Cloud Talent Solution.
*/
searchTypes?: string[] | null;
}
/**
* Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Output only. The response of the GetHistogram method.
*/
export interface Schema$GetHistogramResponse {
/**
* Additional information for the API invocation, such as the request tracking id.
*/
metadata?: Schema$ResponseMetadata;
/**
* The Histogram results.
*/
results?: Schema$HistogramResult[];
}
/**
* Input only. Histogram facets to be specified in SearchJobsRequest.
*/
export interface Schema$HistogramFacets {
/**
* Optional. Specifies compensation field-based histogram requests. Duplicate values of CompensationHistogramRequest.type are not allowed.
*/
compensationHistogramFacets?: Schema$CompensationHistogramRequest[];
/**
* Optional. Specifies the custom attributes histogram requests. Duplicate values of CustomAttributeHistogramRequest.key are not allowed.
*/
customAttributeHistogramFacets?: Schema$CustomAttributeHistogramRequest[];
/**
* Optional. Specifies the simple type of histogram facets, for example, `COMPANY_SIZE`, `EMPLOYMENT_TYPE` etc. This field is equivalent to GetHistogramRequest.
*/
simpleHistogramFacets?: string[] | null;
}
/**
* Output only. Result of a histogram call. The response contains the histogram map for the search type specified by HistogramResult.field. The response is a map of each filter value to the corresponding count of jobs for that filter.
*/
export interface Schema$HistogramResult {
/**
* The Histogram search filters.
*/
searchType?: string | null;
/**
* A map from the values of field to the number of jobs with that value in this search result. Key: search type (filter names, such as the companyName). Values: the count of jobs that match the filter for this search.
*/
values?: {
[key: string]: number;
} | null;
}
/**
* Output only. Histogram results that matches HistogramFacets specified in SearchJobsRequest.
*/
export interface Schema$HistogramResults {
/**
* Specifies compensation field-based histogram results that matches HistogramFacets.compensation_histogram_requests.
*/
compensationHistogramResults?: Schema$CompensationHistogramResult[];
/**
* Specifies histogram results for custom attributes that matches HistogramFacets.custom_attribute_histogram_facets.
*/
customAttributeHistogramResults?: Schema$CustomAttributeHistogramResult[];
/**
* Specifies histogram results that matches HistogramFacets.simple_histogram_facets.
*/
simpleHistogramResults?: Schema$HistogramResult[];
}
/**
* A Job resource represents a job posting (also referred to as a "job listing" or "job requisition"). A job belongs to a Company, which is the hiring entity responsible for the job.
*/
export interface Schema$Job {
/**
* Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this field to specify email address(es) to which resumes or applications can be sent. The maximum number of allowed characters is 255.
*/
applicationEmailList?: string[] | null;
/**
* Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this field to provide instructions, such as "Mail your application to ...", that a candidate can follow to apply for the job. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 3,000.
*/
applicationInstruction?: string | null;
/**
* Optional but at least one of application_urls, application_email_list or application_instruction must be specified. Use this URL field to direct an applicant to a website, for example to link to an online application form. The maximum number of allowed characters is 2,000.
*/
applicationUrls?: string[] | null;
/**
* Optional. The benefits included with the job.
*/
benefits?: string[] | null;
/**
* Output only. The name of the company listing the job.
*/
companyDisplayName?: string | null;
/**
* Optional but one of company_name or distributor_company_id must be provided. The resource name of the company listing the job, such as /companies/foo. This field takes precedence over the distributor-assigned company identifier, distributor_company_id.
*/
companyName?: string | null;
/**
* Deprecated. Use company_display_name instead. Output only. The name of the company listing the job.
*/
companyTitle?: string | null;
/**
* Optional. Job compensation information.
*/
compensationInfo?: Schema$CompensationInfo;
/**
* Output only. The timestamp when this job was created.
*/
createTime?: string | null;
/**
* Optional. A map of fields to hold both filterable and non-filterable custom job attributes that are not covered by the provided structured fields. This field is a more general combination of the deprecated id-based filterable_custom_fields and string-based non_filterable_custom_fields. The keys of the map are strings up to 64 bytes and must match the pattern: a-zA-Z*. At most 100 filterable and at most 100 unfilterable keys are supported. For filterable `string_values`, across all keys at most 200 values are allowed, with each string no more than 255 characters. For unfilterable `string_values`, the maximum total size of `string_values` across all keys is 50KB.
*/
customAttributes?: {
[key: string]: Schema$CustomAttribute;
} | null;
/**
* Optional. The department or functional area within the company with the open position. The maximum number of allowed characters is 255.
*/
department?: string | null;
/**
* Required. The description of the job, which typically includes a multi-paragraph description of the company and related information. Separate fields are provided on the job object for responsibilities, qualifications, and other job characteristics. Use of these separate job fields is recommended. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 100,000.
*/
description?: string | null;
/**
* Optional but one of company_name or distributor_company_id must be provided. A unique company identifier used by job distributors to identify an employer's company entity. company_name takes precedence over this field, and is the recommended field to use to identify companies. The maximum number of allowed characters is 255.
*/
distributorCompanyId?: string | null;
/**
* Optional. The desired education level for the job, such as "Bachelors", "Masters", "Doctorate".
*/
educationLevels?: string[] | null;
/**
* Optional. The employment type(s) of a job, for example, full time or part time.
*/
employmentTypes?: string[] | null;
/**
* Optional. The end date of the job in UTC time zone. Typically this field is used for contracting engagements. Dates prior to 1970/1/1 and invalid date formats are ignored.
*/
endDate?: Schema$Date;
/**
* Optional but strongly recommended for the best service experience. The expiration timestamp of the job. After this timestamp, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob API. An expired job can be updated and opened again by using a future expiration timestamp. Updating an expired job fails if there is another existing open job with same requisition_id, company_name and language_code. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are cleaned first. Expired jobs are no longer accessible after they are cleaned out. The format of this field is RFC 3339 date strings. Example: 2000-01-01T00:00:00.999999999Z See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt). A valid date range is between 1970-01-01T00:00:00.0Z and 2100-12-31T23:59:59.999Z. Invalid dates are ignored and treated as expire time not provided. If this value is not provided at the time of job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value is not provided but expiry_date is, expiry_date is used. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_job_fields. If the field masks include expiry_time, or the masks are empty meaning that every field is updated, the job posting expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated.
*/
expireTime?: string | null;
/**
* Deprecated. Use expire_time instead. Optional but strongly recommended to be provided for the best service experience. The expiration date of the job in UTC time. After 12 am on this date, the job is marked as expired, and it no longer appears in search results. The expired job can't be deleted or listed by the DeleteJob and ListJobs APIs, but it can be retrieved with the GetJob API or updated with the UpdateJob API. An expired job can be updated and opened again by using a future expiration date. It can also remain expired. Updating an expired job to be open fails if there is another existing open job with same requisition_id, company_name and language_code. The expired jobs are retained in our system for 90 days. However, the overall expired job count cannot exceed 3 times the maximum of open jobs count over the past week, otherwise jobs with earlier expire time are removed first. Expired jobs are no longer accessible after they are cleaned out. A valid date range is between 1970/1/1 and 2100/12/31. Invalid dates are ignored and treated as expiry date not provided. If this value is not provided on job creation or is invalid, the job posting expires after 30 days from the job's creation time. For example, if the job was created on 2017/01/01 13:00AM UTC with an unspecified expiration date, the job expires after 2017/01/31 13:00AM UTC. If this value is not provided on job update, it depends on the field masks set by UpdateJobRequest.update_job_fields. If the field masks include expiry_date, or the masks are empty meaning that every field is updated, the job expires after 30 days from the job's last update time. Otherwise the expiration date isn't updated.
*/
expiryDate?: Schema$Date;
/**
* Deprecated. Always use compensation_info. Optional. Job compensation information. This field replaces compensation_info. Only CompensationInfo.entries or extended_compensation_info can be set, otherwise an exception is thrown.
*/
extendedCompensationInfo?: Schema$ExtendedCompensationInfo;
/**
* Deprecated. Use custom_attributes instead. Optional. A map of fields to hold filterable custom job attributes not captured by the standard fields such as job_title, company_name, or level. These custom fields store arbitrary string values, and can be used for purposes not covered by the structured fields. For the best search experience, use of the structured rather than custom fields is recommended. Data stored in these custom fields fields are indexed and searched against by keyword searches (see SearchJobsRequest.custom_field_filters][]). The map key must be a number between 1-20. If an invalid key is provided on job create or update, an error is returned.
*/
filterableCustomFields?: {
[key: string]: Schema$CustomField;
} | null;
/**
* Optional. A description of bonus, commission, and other compensation incentives associated with the job not including salary or pay. The maximum number of allowed characters is 10,000.
*/
incentives?: string | null;
/**
* Output only. Structured locations of the job, resolved from locations.
*/
jobLocations?: Schema$JobLocation[];
/**
* Required. The title of the job, such as "Software Engineer" The maximum number of allowed characters is 500.
*/
jobTitle?: string | null;
/**
* Optional. The language of the posting. This field is distinct from any requirements for fluency that are associated with the job. Language codes must be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47){: class="external" target="_blank" }. If this field is unspecified and Job.description is present, detected language code based on Job.description is assigned, otherwise defaults to 'en_US'.
*/
languageCode?: string | null;
/**
* Optional. The experience level associated with the job, such as "Entry Level".
*/
level?: string | null;
/**
* Optional but strongly recommended for the best service experience. Location(s) where the emploeyer is looking to hire for this job posting. Specifying the full street address(es) of the hiring location enables better API results, especially job searches by commute time. At most 50 locations are allowed for best search performance. If a job has more locations, it is suggested to split it into multiple jobs with unique requisition_ids (e.g. 'ReqA' becomes 'ReqA-1', 'ReqA-2', etc.) as multiple jobs with the same requisition_id, company_name and language_code are not allowed. If the original requisition_id must be preserved, a custom field should be used for storage. It is also suggested to group the locations that close to each other in the same job for better search experience. The maximum number of allowed characters is 500.
*/
locations?: string[] | null;
/**
* Required during job update. Resource name assigned to a job by the API, for example, "/jobs/foo". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.
*/
name?: string | null;
/**
* Optional. A promotion value of the job, as determined by the client. The value determines the sort order of the jobs returned when searching for jobs using the featured jobs search call, with higher promotional values being returned first and ties being resolved by relevance sort. Only the jobs with a promotionValue >0 are returned in a FEATURED_JOB_SEARCH. Default value is 0, and negative values are treated as 0.
*/
promotionValue?: number | null;
/**
* Optional. The date this job was most recently published in UTC format. The default value is the time the request arrives at the server.
*/
publishDate?: Schema$Date;
/**
* Optional. A description of the qualifications required to perform the job. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000.
*/
qualifications?: string | null;
/**
* Output only. The URL of a web page that displays job details.
*/
referenceUrl?: string | null;
/**
* Optional. The job Region (for example, state, country) throughout which the job is available. If this field is set, a LocationFilter in a search query within the job region finds this job if an exact location match is not specified. If this field is set, setting job locations to the same location level as this field is strongly recommended.
*/
region?: string | null;
/**
* Required. The requisition ID, also referred to as the posting ID, assigned by the client to identify a job. This field is intended to be used by clients for client identification and tracking of listings. A job is not allowed to be created if there is another job with the same requisition_id, company_name and language_code. The maximum number of allowed characters is 255.
*/
requisitionId?: string | null;
/**
* Optional. A description of job responsibilities. The use of this field is recommended as an alternative to using the more general description field. This field accepts and sanitizes HTML input, and also accepts bold, italic, ordered list, and unordered list markup tags. The maximum number of allowed characters is 10,000.
*/
responsibilities?: string | null;
/**
* Optional. The start date of the job in UTC time zone. Typically this field is used for contracting engagements. Dates prior to 1970/1/1 and invalid date formats are ignored.
*/
startDate?: Schema$Date;
/**
* Deprecated. Use custom_attributes instead. Optional. A map of fields to hold non-filterable custom job attributes, similar to filterable_custom_fields. These fields are distinct in that the data in these fields are not indexed. Therefore, the client cannot search against them, nor can the client use them to list jobs. The key of the map can be any valid string.
*/
unindexedCustomFields?: {
[key: string]: Schema$CustomField;
} | null;
/**
* Output only. The timestamp when this job was last updated.
*/
updateTime?: string | null;
/**
* Optional. The visibility of the job. Defaults to JobVisibility.PRIVATE if not specified. Currently only JobVisibility.PRIVATE is supported.
*/
visibility?: string | null;
}
/**
* Input only. Deprecated. Use JobQuery instead. The filters required to perform a search query or histogram.
*/
export interface Schema$JobFilters {
/**
* Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against.
*/
categories?: string[] | null;
/**
* Optional. Allows filtering jobs by commute time with different travel methods (e.g. driving or public transit). Note: this only works with COMMUTE MODE. When specified, [JobFilters.location_filters] will be ignored. Currently we do not support sorting by commute time.
*/
commuteFilter?: Schema$CommutePreference;
/**
* Optional. The company names filter specifies the company entities to search against. If a value is not specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the specified companies. At most 20 company filters are allowed.
*/
companyNames?: string[] | null;
/**
* Optional. This filter specifies the exact company titles of jobs to search against. If a value is not specified, jobs within the search results can be associated with any company. If multiple values are specified, jobs within the search results may be associated with any of the specified companies. At most 20 company title filters are allowed.
*/
companyTitles?: string[] | null;
/**
* Optional. This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs that meet this criteria are searched. If a filter is not defined, all open jobs are searched.
*/
compensationFilter?: Schema$CompensationFilter;
/**
* Optional. This filter specifies a structured syntax to match against the Job.custom_attributes that are marked as `filterable`. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: =, !=, <, <=, >, >= where the left of the operator is a custom field key and the right of the operator is a number or string (surrounded by quotes) value. Supported functions are LOWER(<field_name>) to perform case insensitive match and EMPTY(<field_name>) to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (For example, "((A AND B AND C) OR NOT D) AND E"), and there can be a maximum of 100 comparisons/functions in the expression. The expression must be < 3000 bytes in length. Sample Query: (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100
*/
customAttributeFilter?: string | null;
/**
* Deprecated. Use custom_attribute_filter instead. Optional. This filter specifies searching against custom field values. See Job.filterable_custom_fields for information. The key value specifies a number between 1-20 (the service supports 20 custom fields) corresponding to the desired custom field map value. If an invalid key is provided or specified together with custom_attribute_filter, an error is thrown.
*/
customFieldFilters?: {
[key: string]: Schema$CustomFieldFilter;
} | null;
/**
* Optional. This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer". Defaults to false: a spell check is performed.
*/
disableSpellCheck?: boolean | null;
/**
* Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results include any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types.
*/
employmentTypes?: string[] | null;
/**
* Deprecated. Always use compensation_filter. Optional. This search filter is applied only to Job.extended_compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs that meet these criteria are searched. If a filter is not defined, all open jobs are searched.
*/
extendedCompensationFilter?: Schema$ExtendedCompensationFilter;
/**
* Optional. This filter specifies the locale of jobs to search against, for example, "en-US". If a value is not specified, the search results may contain jobs in any locale. Language codes should be in BCP-47 format, for example, "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed.
*/
languageCodes?: string[] | null;
/**
* Optional. The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information. If a location value is not specified, jobs are retrieved from all locations. If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed.
*/
locationFilters?: Schema$LocationFilter[];
/**
* Optional. Jobs published within a range specified by this filter are searched against, for example, DateRange.PAST_MONTH. If a value is not specified, all open jobs are searched against regardless of the date they were published.
*/
publishDateRange?: string | null;
/**
* Optional. The query filter contains the keywords that match against the job title, description, and location fields. The maximum query size is 255 bytes/characters.
*/
query?: string | null;
/**
* Deprecated. Do not use this field. This flag controls whether the job search should be restricted to jobs owned by the current user. Defaults to false where all jobs accessible to the user are searched against.
*/
tenantJobOnly?: boolean | null;
}
/**
* Output only. A resource that represents a location with full geographic information.
*/
export interface Schema$JobLocation {
/**
* An object representing a latitude/longitude pair.
*/
latLng?: Schema$LatLng;
/**
* The type of a location, which corresponds to the address lines field of PostalAddress. For example, "Downtown, Atlanta, GA, USA" has a type of LocationType#NEIGHBORHOOD, and "Kansas City, KS, USA" has a type of LocationType#LOCALITY.
*/
locationType?: string | null;
/**
* Postal address of the location that includes human readable information, such as postal delivery and payments addresses. Given a postal address, a postal service can deliver items to a premises, P.O. Box, or other delivery location.
*/
postalAddress?: Schema$PostalAddress;
/**
* Radius in meters of the job location. This value is derived from the location bounding box in which a circle with the specified radius centered from LatLng coves the area associated with the job location. For example, currently, "Mountain View, CA, USA" has a radius of 7885.79 meters.
*/
radiusMeters?: number | null;
}
/**
* Input only. Options for job processing.
*/
export interface Schema$JobProcessingOptions {
/**
* Optional. If set to `true`, the service does not attempt to resolve a more precise address for the job.
*/
disableStreetAddressResolution?: boolean | null;
/**
* Optional. Option for job HTML content sanitization. Applied fields are: * description * applicationInstruction * incentives * qualifications * responsibilities HTML tags in these fields may be stripped if sanitiazation is not disabled. Defaults to HtmlSanitization.SIMPLE_FORMATTING_ONLY.
*/
htmlSanitization?: string | null;
}
/**
* Input only. The query required to perform a search query or histogram.
*/
export interface Schema$JobQuery {
/**
* Optional. The category filter specifies the categories of jobs to search against. See Category for more information. If a value is not specified, jobs from any category are searched against. If multiple values are specified, jobs from any of the specified categories are searched against.
*/
categories?: string[] | null;
/**
* Optional. Allows filtering jobs by commute time with different travel methods (for example, driving or public transit). Note: This only works with COMMUTE MODE. When specified, [JobQuery.location_filters] is ignored. Currently we don't support sorting by commute time.
*/
commuteFilter?: Schema$CommutePreference;
/**
* Optional. This filter specifies the exact company display name of the jobs to search against. If a value isn't specified, jobs within the search results are associated with any company. If multiple values are specified, jobs within the search results may be associated with any of the specified companies. At most 20 company display name filters are allowed.
*/
companyDisplayNames?: string[] | null;
/**
* Optional. This filter specifies the company entities to search against. If a value isn't specified, jobs are searched for against all companies. If multiple values are specified, jobs are searched against the companies specified. At most 20 company filters are allowed.
*/
companyNames?: string[] | null;
/**
* Optional. This search filter is applied only to Job.compensation_info. For example, if the filter is specified as "Hourly job with per-hour compensation > $15", only jobs meeting these criteria are searched. If a filter isn't defined, all open jobs are searched.
*/
compensationFilter?: Schema$CompensationFilter;
/**
* Optional. This filter specifies a structured syntax to match against the Job.custom_attributes marked as `filterable`. The syntax for this expression is a subset of Google SQL syntax. Supported operators are: =, !=, <, <=, >, >= where the left of the operator is a custom field key and the right of the operator is a number or string (surrounded by quotes) value. Supported functions are LOWER(<field_name>) to perform case insensitive match and EMPTY(<field_name>) to filter on the existence of a key. Boolean expressions (AND/OR/NOT) are supported up to 3 levels of nesting (for example, "((A AND B AND C) OR NOT D) AND E"), a maximum of 50 comparisons/functions are allowed in the expression. The expression must be < 2000 characters in length. Sample Query: (key1 = "TEST" OR LOWER(key1)="test" OR NOT EMPTY(key1)) AND key2 > 100
*/
customAttributeFilter?: string | null;
/**
* Optional. This flag controls the spell-check feature. If false, the service attempts to correct a misspelled query, for example, "enginee" is corrected to "engineer". Defaults to false: a spell check is performed.
*/
disableSpellCheck?: boolean | null;
/**
* Optional. The employment type filter specifies the employment type of jobs to search against, such as EmploymentType.FULL_TIME. If a value is not specified, jobs in the search results include any employment type. If multiple values are specified, jobs in the search results include any of the specified employment types.
*/
employmentTypes?: string[] | null;
/**
* Optional. This filter specifies the locale of jobs to search against, for example, "en-US". If a value isn't specified, the search results can contain jobs in any locale. Language codes should be in BCP-47 format, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). At most 10 language code filters are allowed.
*/
languageCodes?: string[] | null;
/**
* Optional. The location filter specifies geo-regions containing the jobs to search against. See LocationFilter for more information. If a location value isn't specified, jobs fitting the other search criteria are retrieved regardless of where they're located. If multiple values are specified, jobs are retrieved from any of the specified locations. If different values are specified for the LocationFilter.distance_in_miles parameter, the maximum provided distance is used for all locations. At most 5 location filters are allowed.
*/
locationFilters?: Schema$LocationFilter[];
/**
* Optional. Jobs published within a range specified by this filter are searched against, for example, DateRange.PAST_MONTH. If a value isn't specified, all open jobs are searched against regardless of their published date.
*/
publishDateRange?: string | null;
/**
* Optional. The query string that matches against the job title, description, and location fields. The maximum query size is 255 bytes.
*/
query?: string | null;
}
/**
* An object representing a latitude/longitude pair. This is expressed as a pair of doubles representing degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84 standard</a>. Values must be within normalized ranges.
*/
export interface Schema$LatLng {
/**
* The latitude in degrees. It must be in the range [-90.0, +90.0].
*/
latitude?: number | null;
/**
* The longitude in degrees. It must be in the range [-180.0, +180.0].
*/
longitude?: number | null;
}
/**
* Output only. The List companies response object.
*/
export interface Schema$ListCompaniesResponse {
/**
* Companies for the current client.
*/
companies?: Schema$Company[];
/**
* Additional information for the API invocation, such as the request tracking id.
*/
metadata?: Schema$ResponseMetadata;
/**
* A token to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Deprecated. Use ListJobsResponse instead. Output only. The List jobs response object.
*/
export interface Schema$ListCompanyJobsResponse {
/**
* The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request.
*/
jobs?: Schema$Job[];
/**
* Additional information for the API invocation, such as the request tracking id.
*/
metadata?: Schema$ResponseMetadata;
/**
* A token to retrieve the next page of results.
*/
nextPageToken?: string | null;
/**
* The total number of open jobs. The result will be empty if ListCompanyJobsRequest.include_jobs_count is not enabled or if no open jobs are available.
*/
totalSize?: string | null;
}
/**
* Output only. List jobs response.
*/
export interface Schema$ListJobsResponse {
/**
* The Jobs for a given company. The maximum number of items returned is based on the limit field provided in the request.
*/
jobs?: Schema$Job[];
/**
* Additional information for the API invocation, such as the request tracking id.
*/
metadata?: Schema$ResponseMetadata;
/**
* A token to retrieve the next page of results.
*/
nextPageToken?: string | null;
}
/**
* Input only. Geographic region of the search.
*/
export interface Schema$LocationFilter {
/**
* Optional. The distance_in_miles is applied when the location being searched for is identified as a city or smaller. When the location being searched for is a state or larger, this field is ignored.
*/
distanceInMiles?: number | null;
/**
* Optional. Allows the client to return jobs without a set location, specifically, telecommuting jobs (telecomuting is considered by the service as a special location. Job.allow_telecommute indicates if a job permits telecommuting. If this field is true, telecommuting jobs are searched, and name and lat_lng are ignored. This filter can be used by itself to search exclusively for telecommuting jobs, or it can be combined with another location filter to search for a combination of job locations, such as "Mountain View" or "telecommuting" jobs. However, when used in combination with other location filters, telecommuting jobs can be treated as less relevant than other jobs in the search response.
*/
isTelecommute?: boolean | null;
/**
* Optional. The latitude and longitude of the geographic center from which to search. This field is ignored if `location_name` is provided.
*/
latLng?: Schema$LatLng;
/**
* Optional. The address name, such as "Mountain View" or "Bay Area".
*/
name?: string | null;
/**
* Optional. CLDR region code of the country/region of the address. This will be used to address ambiguity of the user-input location, e.g. "Liverpool" against "Liverpool, NY, US" or "Liverpool, UK". Set this field if all the jobs to search against are from a same region, or jobs are world-wide but the job seeker is from a specific region. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
*/
regionCode?: string | null;
}
/**
* Output only. Job entry with metadata inside SearchJobsResponse.
*/
export interface Schema$MatchingJob {
/**
* Commute information which is generated based on specified CommutePreference.
*/
commuteInfo?: Schema$CommuteInfo;
/**
* Job resource that matches the specified SearchJobsRequest.
*/
job?: Schema$Job;
/**
* A summary of the job with core information that's displayed on the search results listing page.
*/
jobSummary?: string | null;
/**
* Contains snippets of text from the Job.job_title field most closely matching a search query's keywords, if available. The matching query keywords are enclosed in HTML bold tags.
*/
jobTitleSnippet?: string | null;
/**
* Contains snippets of text from the Job.description and similar fields that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags.
*/
searchTextSnippet?: string | null;
}
/**
* Message representing input to a Mendel server for debug forcing. See go/mendel-debug-forcing for more details. Next ID: 2
*/
export interface Schema$MendelDebugInput {
/**
* When a request spans multiple servers, a MendelDebugInput may travel with the request and take effect in all the servers. This field is a map of namespaces to NamespacedMendelDebugInput protos. In a single server, up to two NamespacedMendelDebugInput protos are applied: 1. NamespacedMendelDebugInput with the global namespace (key == ""). 2. NamespacedMendelDebugInput with the server's namespace. When both NamespacedMendelDebugInput protos are present, they are merged. See go/mendel-debug-forcing for more details.
*/
namespacedDebugInput?: {
[key: string]: Schema$NamespacedDebugInput;
} | null;
}
/**
* Represents an amount of money with its currency type.
*/
export interface Schema$Money {
/**
* The 3-letter currency code defined in ISO 4217.
*/
currencyCode?: string | null;
/**
* Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
*/
nanos?: number | null;
/**
* The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
*/
units?: string | null;
}
/**
* Next ID: 15
*/
export interface Schema$NamespacedDebugInput {
/**
* Set of experiment names to be absolutely forced. These experiments will be forced without evaluating the conditions.
*/
absolutelyForcedExpNames?: string[] | null;
/**
* Set of experiment ids to be absolutely forced. These ids will be forced without evaluating the conditions.
*/
absolutelyForcedExps?: number[] | null;
/**
* Set of experiment tags to be absolutely forced. The experiments with these tags will be forced without evaluating the conditions.
*/
absolutelyForcedExpTags?: string[] | null;
/**
* Set of experiment names to be conditionally forced. These experiments will be forced only if their conditions and their parent domain's conditions are true.
*/
conditionallyForcedExpNames?: string[] | null;
/**
* Set of experiment ids to be conditionally forced. These ids will be forced only if their conditions and their parent domain's conditions are true.
*/
conditionallyForcedExps?: number[] | null;
/**
* Set of experiment tags to be conditionally forced. The experiments with these tags will be forced only if their conditions and their parent domain's conditions are true.
*/
conditionallyForcedExpTags?: string[] | null;
/**
* If true, disable automatic enrollment selection (at all diversion points). Automatic enrollment selection means experiment selection process based on the experiment's automatic enrollment condition. This does not disable selection of forced experiments.
*/
disableAutomaticEnrollmentSelection?: boolean | null;
/**
* Set of experiment names to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If a name corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together.
*/
disableExpNames?: string[] | null;
/**
* Set of experiment ids to be disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together. If an ID corresponds to a domain, the domain itself and all descendant experiments and domains are disabled together.
*/
disableExps?: number[] | null;
/**
* Set of experiment tags to be disabled. All experiments that are tagged with one or more of these tags are disabled. If an experiment is disabled, it is never selected nor forced. If an aggregate experiment is disabled, its partitions are disabled together. If an experiment with an enrollment is disabled, the enrollment is disabled together.
*/
disableExpTags?: string[] | null;
/**
* If true, disable manual enrollment selection (at all diversion points). Manual enrollment selection means experiment selection process based on the request's manual enrollment states (a.k.a. opt-in experiments). This does not disable selection of forced experiments.
*/
disableManualEnrollmentSelection?: boolean | null;
/**
* If true, disable organic experiment selection (at all diversion points). Organic selection means experiment selection process based on traffic allocation and diversion condition evaluation. This does not disable selection of forced experiments. This is useful in cases when it is not known whether experiment selection behavior is responsible for a error or breakage. Disabling organic selection may help to isolate the cause of a given problem.
*/
disableOrganicSelection?: boolean | null;
/**
* Flags to force in a particular experiment state. Map from flag name to flag value.
*/
forcedFlags?: {
[key: string]: string;
} | null;
/**
* Rollouts to force in a particular experiment state. Map from rollout name to rollout value.
*/
forcedRollouts?: {
[key: string]: boolean;
} | null;
}
/**
* Input only. Use this field to specify bucketing option for the histogram search response.
*/
export interface Schema$NumericBucketingOption {
/**
* Required. Two adjacent values form a histogram bucket. Values should be in ascending order. For example, if [5, 10, 15] are provided, four buckets are created: (-inf, 5), 5, 10), [10, 15), [15, inf). At most 20 [buckets_bound is supported.
*/
bucketBounds?: number[] | null;
/**
* Optional. If set to true, the histogram result includes minimum/maximum value of the numeric field.
*/
requiresMinMax?: boolean | null;
}
/**
* Output only. Custom numeric bucketing result.
*/
export interface Schema$NumericBucketingResult {
/**
* Count within each bucket. Its size is the length of NumericBucketingOption.bucket_bounds plus 1.
*/
counts?: Schema$BucketizedCount[];
/**
* Stores the maximum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true.
*/
maxValue?: number | null;
/**
* Stores the minimum value of the numeric field. Will be populated only if [NumericBucketingOption.requires_min_max] is set to true.
*/
minValue?: number | null;
}
/**
* Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an i18n-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478
*/
export interface Schema$PostalAddress {
/**
* Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
*/
addressLines?: string[] | null;
/**
* Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
*/
administrativeArea?: string | null;
/**
* Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
*/
languageCode?: string | null;
/**
* Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
*/
locality?: string | null;
/**
* Optional. The name of the organization at the address.
*/
organization?: string | null;
/**
* Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
*/
postalCode?: string | null;
/**
* Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
*/
recipients?: string[] | null;
/**
* Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
*/
regionCode?: string | null;
/**
* The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
*/
revision?: number | null;
/**
* Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
*/
sortingCode?: string | null;
/**
* Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
*/
sublocality?: string | null;
}
/**
* Input only. Meta information related to the job searcher or entity conducting the job search. This information is used to improve the performance of the service.
*/
export interface Schema$RequestMetadata {
/**
* Optional. The type of device used by the job seeker at the time of the call to the service.
*/
deviceInfo?: Schema$DeviceInfo;
/**
* Required. The client-defined scope or source of the service call, which typically is the domain on which the service has been implemented and is currently being run. For example, if the service is being run by client <em>Foo, Inc.</em>, on job board www.foo.com and career site www.bar.com, then this field is set to "foo.com" for use on the job board, and "bar.com" for use on the career site. If this field is not available for some reason, send "UNKNOWN". Note that any improvements to the service model for a particular tenant site rely on this field being set correctly to some domain.
*/
domain?: string | null;
/**
* Required. A unique session identification string. A session is defined as the duration of an end user's interaction with the service over a period. Obfuscate this field for privacy concerns before providing it to the API. If this field is not available for some reason, please send "UNKNOWN". Note that any improvements to the service model for a particular tenant site, rely on this field being set correctly to some unique session_id.
*/
sessionId?: string | null;
/**
* Required. A unique user identification string, as determined by the client. The client is responsible for ensuring client-level uniqueness of this value in order to have the strongest positive impact on search quality. Obfuscate this field for privacy concerns before providing it to the service. If this field is not available for some reason, please send "UNKNOWN". Note that any improvements to the service model for a particular tenant site, rely on this field being set correctly to some unique user_id.
*/
userId?: string | null;
}
/**
* Output only. Additional information returned to client, such as debugging information.
*/
export interface Schema$ResponseMetadata {
/**
* Identifiers for the versions of the search algorithm used during this API invocation if multiple algorithms are used. The default value is empty. For search response only.
*/
experimentIdList?: number[] | null;
/**
* For search response only. Indicates the mode of a performed search.
*/
mode?: string | null;
/**
* A unique id associated with this call. This id is logged for tracking purposes.
*/
requestId?: string | null;
}
/**
* Input only. The Request body of the `SearchJobs` call.
*/
export interface Schema$SearchJobsRequest {
/**
* Optional. Controls whether to disable relevance thresholding. Relevance thresholding removes jobs that have low relevance in search results, for example, removing "Assistant to the CEO" positions from the search results of a search for "CEO". Disabling relevance thresholding improves the accuracy of subsequent search requests. Defaults to false.
*/
disableRelevanceThresholding?: boolean | null;
/**
* Optional. Controls whether to broaden the search when it produces sparse results. Broadened queries append results to the end of the matching results list. Defaults to false.
*/
enableBroadening?: boolean | null;
/**
* Optional. Controls if the search job request requires the return of a precise count of the first 300 results. Setting this to `true` ensures consistency in the number of results per page. Best practice is to set this value to true if a client allows users to jump directly to a non-sequential search results page. Enabling this flag may adversely impact performance. Defaults to false.
*/
enablePreciseResultSize?: boolean | null;
/**
* Deprecated. Use query instead. Optional. Restrictions on the scope of the search request, such as filtering by location.
*/
filters?: Schema$JobFilters;
/**
* Optional. Restrictions on what fields to perform histogram on, such as `COMPANY_SIZE` etc.
*/
histogramFacets?: Schema$HistogramFacets;
/**
* Optional. The number of job attributes returned for jobs in the search response. Defaults to JobView.SMALL if no value is specified.
*/
jobView?: string | null;
/**
* Required. Mode of a search.
*/
mode?: string | null;
/**
* Optional. An integer that specifies the current offset (that is, starting result location, amongst the jobs deemed by the API as relevant) in search results. This field is only considered if page_token is unset. For example, 0 means to return results starting from the first matching job, and 10 means to return from the 11th job. This can be used for pagination, (for example, pageSize = 10 and offset = 10 means to return from the second page).
*/
offset?: number | null;
/**
* Deprecated. Use sort_by instead. Optional. The criteria determining how search results are sorted. Defaults to SortBy.RELEVANCE_DESC if no value is specified.
*/
orderBy?: string | null;
/**
* Optional. A limit on the number of jobs returned in the search results. Increasing this value above the default value of 10 can increase search response time. The value can be between 1 and 100.
*/
pageSize?: number | null;
/**
* Optional. The token specifying the current offset within search results. See SearchJobsResponse.next_page_token for an explanation of how to obtain the next set of query results.
*/
pageToken?: string | null;
/**
* Optional. Query used to search against jobs, such as keyword, location filters, etc.
*/
query?: Schema$JobQuery;
/**
* Required. The meta information collected about the job searcher, used to improve the search quality of the service. The identifiers, (such as `user_id`) are provided by users, and must be unique and consistent.
*/
requestMetadata?: Schema$RequestMetadata;
/**
* Optional. The criteria determining how search results are sorted. Defaults to SortBy.RELEVANCE_DESC if no value is specified.
*/
sortBy?: string | null;
}
/**
* Output only. Response for SearchJob method.
*/
export interface Schema$SearchJobsResponse {
/**
* The commute filter the service applied to the specified query. This information is only available when query has a valid CommutePreference.
*/
appliedCommuteFilter?: Schema$CommutePreference;
/**
* The location filters that the service applied to the specified query. If any filters are lat-lng based, the JobLocation.location_type is JobLocation.LocationType#LOCATION_TYPE_UNSPECIFIED.
*/
appliedJobLocationFilters?: Schema$JobLocation[];
/**
* An estimation of the number of jobs that match the specified query. This number is not guaranteed to be accurate. For accurate results, seenenable_precise_result_size.
*/
estimatedTotalSize?: string | null;
/**
* The histogram results that match specified SearchJobsRequest.HistogramFacets.
*/
histogramResults?: Schema$HistogramResults;
/**
* Corresponds to SearchJobsRequest.job_view.
*/
jobView?: string | null;
/**
* The Job entities that match the specified SearchJobsRequest.
*/
matchingJobs?: Schema$MatchingJob[];
/**
* Additional information for the API invocation, such as the request tracking id.
*/
metadata?: Schema$ResponseMetadata;
/**
* The token that specifies the starting position of the next page of results. This field is empty if there are no more results.
*/
nextPageToken?: string | null;
/**
* If query broadening is enabled, we may append additional results from the broadened query. This number indicates how many of the jobs returned in the jobs field are from the broadened query. These results are always at the end of the jobs list. In particular, a value of 0 means all the jobs in the jobs list are from the original (without broadening) query. If this field is non-zero, subsequent requests with offset after this result set should contain all broadened results.
*/
numJobsFromBroadenedQuery?: number | null;
/**
* The spell checking result, and correction.
*/
spellResult?: Schema$SpellingCorrection;
/**
* The precise result count, which is available only if the client set enable_precise_result_size to `true` or if the response is the last page of results. Otherwise, the value will be `-1`.
*/
totalSize?: string | null;
}
/**
* Output only. Spell check result.
*/
export interface Schema$SpellingCorrection {
/**
* Indicates if the query was corrected by the spell checker.
*/
corrected?: boolean | null;
/**
* Correction output consisting of the corrected keyword string.
*/
correctedText?: string | null;
}
/**
* Represents array of string values.
*/
export interface Schema$StringValues {
/**
* Required. String values.
*/
values?: string[] | null;
}
/**
* Input only. Update job request.
*/
export interface Schema$UpdateJobRequest {
/**
* Deprecated. Please use processing_options. This flag is ignored if processing_options is set. Optional. If set to `true`, the service does not attempt resolve a more precise address for the job.
*/
disableStreetAddressResolution?: boolean | null;
/**
* Required. The Job to be updated.
*/
job?: Schema$Job;
/**
* Optional. Options for job processing. UpdateJobRequest.disable_street_address_resolution is ignored if this flag is set.
*/
processingOptions?: Schema$JobProcessingOptions;
/**
* Optional but strongly recommended to be provided for the best service experience. If update_job_fields is provided, only the specified fields in job are updated. Otherwise all the fields are updated. A field mask to restrict the fields that are updated. Valid values are: * jobTitle * employmentTypes * description * applicationUrls * applicationEmailList * applicationInstruction * responsibilities * qualifications * educationLevels * level * department * startDate * endDate * compensationInfo * incentives * languageCode * benefits * expireTime * customAttributes * visibility * publishDate * promotionValue * locations * region * expiryDate (deprecated) * filterableCustomFields (deprecated) * unindexedCustomFields (deprecated)
*/
updateJobFields?: string | null;
}
export class Resource$Companies {
context: APIRequestContext;
jobs: Resource$Companies$Jobs;
constructor(context: APIRequestContext);
/**
* jobs.companies.create
* @desc Creates a new company entity.
* @alias jobs.companies.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().Company} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Companies$Create, options?: MethodOptions): GaxiosPromise<Schema$Company>;
create(params: Params$Resource$Companies$Create, options: MethodOptions | BodyResponseCallback<Schema$Company>, callback: BodyResponseCallback<Schema$Company>): void;
create(params: Params$Resource$Companies$Create, callback: BodyResponseCallback<Schema$Company>): void;
create(callback: BodyResponseCallback<Schema$Company>): void;
/**
* jobs.companies.delete
* @desc Deletes the specified company.
* @alias jobs.companies.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The resource name of the company to be deleted, such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Companies$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Companies$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Companies$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* jobs.companies.get
* @desc Retrieves the specified company.
* @alias jobs.companies.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. Resource name of the company to retrieve, such as "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Companies$Get, options?: MethodOptions): GaxiosPromise<Schema$Company>;
get(params: Params$Resource$Companies$Get, options: MethodOptions | BodyResponseCallback<Schema$Company>, callback: BodyResponseCallback<Schema$Company>): void;
get(params: Params$Resource$Companies$Get, callback: BodyResponseCallback<Schema$Company>): void;
get(callback: BodyResponseCallback<Schema$Company>): void;
/**
* jobs.companies.list
* @desc Lists all companies associated with a Cloud Talent Solution account.
* @alias jobs.companies.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.mustHaveOpenJobs Optional. Set to true if the companies request must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned.
* @param {integer=} params.pageSize Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.
* @param {string=} params.pageToken Optional. The starting indicator from which to return results.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Companies$List, options?: MethodOptions): GaxiosPromise<Schema$ListCompaniesResponse>;
list(params: Params$Resource$Companies$List, options: MethodOptions | BodyResponseCallback<Schema$ListCompaniesResponse>, callback: BodyResponseCallback<Schema$ListCompaniesResponse>): void;
list(params: Params$Resource$Companies$List, callback: BodyResponseCallback<Schema$ListCompaniesResponse>): void;
list(callback: BodyResponseCallback<Schema$ListCompaniesResponse>): void;
/**
* jobs.companies.patch
* @desc Updates the specified company. Company names can't be updated. To update a company name, delete the company and all jobs associated with it, and only then re-create them.
* @alias jobs.companies.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".
* @param {string=} params.updateCompanyFields Optional but strongly recommended to be provided for the best service experience. If update_company_fields is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to update. Valid values are: * displayName * website * imageUrl * companySize * distributorBillingCompanyId * companyInfoSources * careerPageLink * hiringAgency * hqLocation * eeoText * keywordSearchableCustomAttributes * title (deprecated) * keywordSearchableCustomFields (deprecated)
* @param {().Company} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Companies$Patch, options?: MethodOptions): GaxiosPromise<Schema$Company>;
patch(params: Params$Resource$Companies$Patch, options: MethodOptions | BodyResponseCallback<Schema$Company>, callback: BodyResponseCallback<Schema$Company>): void;
patch(params: Params$Resource$Companies$Patch, callback: BodyResponseCallback<Schema$Company>): void;
patch(callback: BodyResponseCallback<Schema$Company>): void;
}
export interface Params$Resource$Companies$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$Company;
}
export interface Params$Resource$Companies$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The resource name of the company to be deleted, such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".
*/
name?: string;
}
export interface Params$Resource$Companies$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. Resource name of the company to retrieve, such as "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".
*/
name?: string;
}
export interface Params$Resource$Companies$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. Set to true if the companies request must have open jobs. Defaults to false. If true, at most page_size of companies are fetched, among which only those with open jobs are returned.
*/
mustHaveOpenJobs?: boolean;
/**
* Optional. The maximum number of companies to be returned, at most 100. Default is 100 if a non-positive number is provided.
*/
pageSize?: number;
/**
* Optional. The starting indicator from which to return results.
*/
pageToken?: string;
}
export interface Params$Resource$Companies$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required during company update. The resource name for a company. This is generated by the service when a company is created, for example, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".
*/
name?: string;
/**
* Optional but strongly recommended to be provided for the best service experience. If update_company_fields is provided, only the specified fields in company are updated. Otherwise all the fields are updated. A field mask to specify the company fields to update. Valid values are: * displayName * website * imageUrl * companySize * distributorBillingCompanyId * companyInfoSources * careerPageLink * hiringAgency * hqLocation * eeoText * keywordSearchableCustomAttributes * title (deprecated) * keywordSearchableCustomFields (deprecated)
*/
updateCompanyFields?: string;
/**
* Request body metadata
*/
requestBody?: Schema$Company;
}
export class Resource$Companies$Jobs {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* jobs.companies.jobs.list
* @desc Deprecated. Use ListJobs instead. Lists all jobs associated with a company.
* @alias jobs.companies.jobs.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.companyName Required. The resource name of the company that owns the jobs to be listed, such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".
* @param {boolean=} params.idsOnly Optional. If set to `true`, only job ID, job requisition ID and language code will be returned. A typical use is to synchronize job repositories. Defaults to false.
* @param {boolean=} params.includeJobsCount Deprecated. Please DO NOT use this field except for small companies. Suggest counting jobs page by page instead. Optional. Set to true if the total number of open jobs is to be returned. Defaults to false.
* @param {string=} params.jobRequisitionId Optional. The requisition ID, also known as posting ID, assigned by the company to the job. The maximum number of allowable characters is 225.
* @param {integer=} params.pageSize Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified.
* @param {string=} params.pageToken Optional. The starting point of a query result.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Companies$Jobs$List, options?: MethodOptions): GaxiosPromise<Schema$ListCompanyJobsResponse>;
list(params: Params$Resource$Companies$Jobs$List, options: MethodOptions | BodyResponseCallback<Schema$ListCompanyJobsResponse>, callback: BodyResponseCallback<Schema$ListCompanyJobsResponse>): void;
list(params: Params$Resource$Companies$Jobs$List, callback: BodyResponseCallback<Schema$ListCompanyJobsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListCompanyJobsResponse>): void;
}
export interface Params$Resource$Companies$Jobs$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The resource name of the company that owns the jobs to be listed, such as, "companies/0000aaaa-1111-bbbb-2222-cccc3333dddd".
*/
companyName?: string;
/**
* Optional. If set to `true`, only job ID, job requisition ID and language code will be returned. A typical use is to synchronize job repositories. Defaults to false.
*/
idsOnly?: boolean;
/**
* Deprecated. Please DO NOT use this field except for small companies. Suggest counting jobs page by page instead. Optional. Set to true if the total number of open jobs is to be returned. Defaults to false.
*/
includeJobsCount?: boolean;
/**
* Optional. The requisition ID, also known as posting ID, assigned by the company to the job. The maximum number of allowable characters is 225.
*/
jobRequisitionId?: string;
/**
* Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified.
*/
pageSize?: number;
/**
* Optional. The starting point of a query result.
*/
pageToken?: string;
}
export class Resource$Jobs {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* jobs.jobs.batchDelete
* @desc Deletes a list of Job postings by filter.
* @alias jobs.jobs.batchDelete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().BatchDeleteJobsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
batchDelete(params?: Params$Resource$Jobs$Batchdelete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
batchDelete(params: Params$Resource$Jobs$Batchdelete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
batchDelete(params: Params$Resource$Jobs$Batchdelete, callback: BodyResponseCallback<Schema$Empty>): void;
batchDelete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* jobs.jobs.create
* @desc Creates a new job. Typically, the job becomes searchable within 10 seconds, but it may take up to 5 minutes.
* @alias jobs.jobs.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().CreateJobRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Jobs$Create, options?: MethodOptions): GaxiosPromise<Schema$Job>;
create(params: Params$Resource$Jobs$Create, options: MethodOptions | BodyResponseCallback<Schema$Job>, callback: BodyResponseCallback<Schema$Job>): void;
create(params: Params$Resource$Jobs$Create, callback: BodyResponseCallback<Schema$Job>): void;
create(callback: BodyResponseCallback<Schema$Job>): void;
/**
* jobs.jobs.delete
* @desc Deletes the specified job. Typically, the job becomes unsearchable within 10 seconds, but it may take up to 5 minutes.
* @alias jobs.jobs.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {boolean=} params.disableFastProcess Deprecated. This field is not working anymore. Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster.
* @param {string} params.name Required. The resource name of the job to be deleted, such as "jobs/11111111".
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Jobs$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Jobs$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Jobs$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* jobs.jobs.deleteByFilter
* @desc Deprecated. Use BatchDeleteJobs instead. Deletes the specified job by filter. You can specify whether to synchronously wait for validation, indexing, and general processing to be completed before the response is returned.
* @alias jobs.jobs.deleteByFilter
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().DeleteJobsByFilterRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
deleteByFilter(params?: Params$Resource$Jobs$Deletebyfilter, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
deleteByFilter(params: Params$Resource$Jobs$Deletebyfilter, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
deleteByFilter(params: Params$Resource$Jobs$Deletebyfilter, callback: BodyResponseCallback<Schema$Empty>): void;
deleteByFilter(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* jobs.jobs.get
* @desc Retrieves the specified job, whose status is OPEN or recently EXPIRED within the last 90 days.
* @alias jobs.jobs.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required. The resource name of the job to retrieve, such as "jobs/11111111".
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Jobs$Get, options?: MethodOptions): GaxiosPromise<Schema$Job>;
get(params: Params$Resource$Jobs$Get, options: MethodOptions | BodyResponseCallback<Schema$Job>, callback: BodyResponseCallback<Schema$Job>): void;
get(params: Params$Resource$Jobs$Get, callback: BodyResponseCallback<Schema$Job>): void;
get(callback: BodyResponseCallback<Schema$Job>): void;
/**
* jobs.jobs.histogram
* @desc Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram. Retrieves a histogram for the given GetHistogramRequest. This call provides a structured count of jobs that match against the search query, grouped by specified facets. This call constrains the visibility of jobs present in the database, and only counts jobs the caller has permission to search against. For example, use this call to generate the number of jobs in the U.S. by state.
* @alias jobs.jobs.histogram
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().GetHistogramRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
histogram(params?: Params$Resource$Jobs$Histogram, options?: MethodOptions): GaxiosPromise<Schema$GetHistogramResponse>;
histogram(params: Params$Resource$Jobs$Histogram, options: MethodOptions | BodyResponseCallback<Schema$GetHistogramResponse>, callback: BodyResponseCallback<Schema$GetHistogramResponse>): void;
histogram(params: Params$Resource$Jobs$Histogram, callback: BodyResponseCallback<Schema$GetHistogramResponse>): void;
histogram(callback: BodyResponseCallback<Schema$GetHistogramResponse>): void;
/**
* jobs.jobs.list
* @desc Lists jobs by filter.
* @alias jobs.jobs.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "companies/123" * companyName = "companies/123" AND requisitionId = "req-1"
* @param {boolean=} params.idsOnly Optional. If set to `true`, only Job.name, Job.requisition_id and Job.language_code will be returned. A typical use case is to synchronize job repositories. Defaults to false.
* @param {integer=} params.pageSize Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified.
* @param {string=} params.pageToken Optional. The starting point of a query result.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Jobs$List, options?: MethodOptions): GaxiosPromise<Schema$ListJobsResponse>;
list(params: Params$Resource$Jobs$List, options: MethodOptions | BodyResponseCallback<Schema$ListJobsResponse>, callback: BodyResponseCallback<Schema$ListJobsResponse>): void;
list(params: Params$Resource$Jobs$List, callback: BodyResponseCallback<Schema$ListJobsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListJobsResponse>): void;
/**
* jobs.jobs.patch
* @desc Updates specified job. Typically, updated contents become visible in search results within 10 seconds, but it may take up to 5 minutes.
* @alias jobs.jobs.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name Required during job update. Resource name assigned to a job by the API, for example, "/jobs/foo". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.
* @param {().UpdateJobRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Jobs$Patch, options?: MethodOptions): GaxiosPromise<Schema$Job>;
patch(params: Params$Resource$Jobs$Patch, options: MethodOptions | BodyResponseCallback<Schema$Job>, callback: BodyResponseCallback<Schema$Job>): void;
patch(params: Params$Resource$Jobs$Patch, callback: BodyResponseCallback<Schema$Job>): void;
patch(callback: BodyResponseCallback<Schema$Job>): void;
/**
* jobs.jobs.search
* @desc Searches for jobs using the provided SearchJobsRequest. This call constrains the visibility of jobs present in the database, and only returns jobs that the caller has permission to search against.
* @alias jobs.jobs.search
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().SearchJobsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
search(params?: Params$Resource$Jobs$Search, options?: MethodOptions): GaxiosPromise<Schema$SearchJobsResponse>;
search(params: Params$Resource$Jobs$Search, options: MethodOptions | BodyResponseCallback<Schema$SearchJobsResponse>, callback: BodyResponseCallback<Schema$SearchJobsResponse>): void;
search(params: Params$Resource$Jobs$Search, callback: BodyResponseCallback<Schema$SearchJobsResponse>): void;
search(callback: BodyResponseCallback<Schema$SearchJobsResponse>): void;
/**
* jobs.jobs.searchForAlert
* @desc Searches for jobs using the provided SearchJobsRequest. This API call is intended for the use case of targeting passive job seekers (for example, job seekers who have signed up to receive email alerts about potential job opportunities), and has different algorithmic adjustments that are targeted to passive job seekers. This call constrains the visibility of jobs present in the database, and only returns jobs the caller has permission to search against.
* @alias jobs.jobs.searchForAlert
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().SearchJobsRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
searchForAlert(params?: Params$Resource$Jobs$Searchforalert, options?: MethodOptions): GaxiosPromise<Schema$SearchJobsResponse>;
searchForAlert(params: Params$Resource$Jobs$Searchforalert, options: MethodOptions | BodyResponseCallback<Schema$SearchJobsResponse>, callback: BodyResponseCallback<Schema$SearchJobsResponse>): void;
searchForAlert(params: Params$Resource$Jobs$Searchforalert, callback: BodyResponseCallback<Schema$SearchJobsResponse>): void;
searchForAlert(callback: BodyResponseCallback<Schema$SearchJobsResponse>): void;
}
export interface Params$Resource$Jobs$Batchdelete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$BatchDeleteJobsRequest;
}
export interface Params$Resource$Jobs$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$CreateJobRequest;
}
export interface Params$Resource$Jobs$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Deprecated. This field is not working anymore. Optional. If set to true, this call waits for all processing steps to complete before the job is cleaned up. Otherwise, the call returns while some steps are still taking place asynchronously, hence faster.
*/
disableFastProcess?: boolean;
/**
* Required. The resource name of the job to be deleted, such as "jobs/11111111".
*/
name?: string;
}
export interface Params$Resource$Jobs$Deletebyfilter extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$DeleteJobsByFilterRequest;
}
export interface Params$Resource$Jobs$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The resource name of the job to retrieve, such as "jobs/11111111".
*/
name?: string;
}
export interface Params$Resource$Jobs$Histogram extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$GetHistogramRequest;
}
export interface Params$Resource$Jobs$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required. The filter string specifies the jobs to be enumerated. Supported operator: =, AND The fields eligible for filtering are: * `companyName` (Required) * `requisitionId` (Optional) Sample Query: * companyName = "companies/123" * companyName = "companies/123" AND requisitionId = "req-1"
*/
filter?: string;
/**
* Optional. If set to `true`, only Job.name, Job.requisition_id and Job.language_code will be returned. A typical use case is to synchronize job repositories. Defaults to false.
*/
idsOnly?: boolean;
/**
* Optional. The maximum number of jobs to be returned per page of results. If ids_only is set to true, the maximum allowed page size is 1000. Otherwise, the maximum allowed page size is 100. Default is 100 if empty or a number < 1 is specified.
*/
pageSize?: number;
/**
* Optional. The starting point of a query result.
*/
pageToken?: string;
}
export interface Params$Resource$Jobs$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Required during job update. Resource name assigned to a job by the API, for example, "/jobs/foo". Use of this field in job queries and API calls is preferred over the use of requisition_id since this value is unique.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UpdateJobRequest;
}
export interface Params$Resource$Jobs$Search extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$SearchJobsRequest;
}
export interface Params$Resource$Jobs$Searchforalert extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$SearchJobsRequest;
}
export class Resource$V2 {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* jobs.complete
* @desc Completes the specified prefix with job keyword suggestions. Intended for use by a job search auto-complete search box.
* @alias jobs.complete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.companyName Optional. If provided, restricts completion to the specified company.
* @param {string=} params.languageCode Required. The language of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned.
* @param {integer=} params.pageSize Required. Completion result count. The maximum allowed page size is 10.
* @param {string=} params.query Required. The query used to generate suggestions.
* @param {string=} params.scope Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC.
* @param {string=} params.type Optional. The completion topic. The default is CompletionType.COMBINED.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
complete(params?: Params$Resource$V2$Complete, options?: MethodOptions): GaxiosPromise<Schema$CompleteQueryResponse>;
complete(params: Params$Resource$V2$Complete, options: MethodOptions | BodyResponseCallback<Schema$CompleteQueryResponse>, callback: BodyResponseCallback<Schema$CompleteQueryResponse>): void;
complete(params: Params$Resource$V2$Complete, callback: BodyResponseCallback<Schema$CompleteQueryResponse>): void;
complete(callback: BodyResponseCallback<Schema$CompleteQueryResponse>): void;
}
export interface Params$Resource$V2$Complete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Optional. If provided, restricts completion to the specified company.
*/
companyName?: string;
/**
* Required. The language of the query. This is the BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Tags for Identifying Languages](https://tools.ietf.org/html/bcp47). For CompletionType.JOB_TITLE type, only open jobs with same language_code are returned. For CompletionType.COMPANY_NAME type, only companies having open jobs with same language_code are returned. For CompletionType.COMBINED type, only open jobs with same language_code or companies having open jobs with same language_code are returned.
*/
languageCode?: string;
/**
* Required. Completion result count. The maximum allowed page size is 10.
*/
pageSize?: number;
/**
* Required. The query used to generate suggestions.
*/
query?: string;
/**
* Optional. The scope of the completion. The defaults is CompletionScope.PUBLIC.
*/
scope?: string;
/**
* Optional. The completion topic. The default is CompletionType.COMBINED.
*/
type?: string;
}
export {};
}