-
Notifications
You must be signed in to change notification settings - Fork 1
/
README
95 lines (77 loc) · 3.23 KB
/
README
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
# (Unofficial) Google Local Guides API
This npm package will give you functionality to get your
contribution metadata from your google local guides profile.
The metadata you'll be able to grab using this module is located by going here:
https://www.google.com/maps/contrib/
and then clicking on your `points` to pop up the modal full of attributes...
Go to the this project's github link to see the full readme with pictures.
_Note: there is no authentication when using this package because it'll scrape your public profile page,
which is accessible to everyone._
## Quickstart
Installation
```shell script
npm install google-local-guides-api
```
Usage
```javascript
const ContributionMetadata = require('google-local-guides-api');
let contributionMetadata = new ContributionMetadata();
// This initializes your link into the response body -- has to be in async/await func
async function () {
await contributionMetadata.init(link);
// You can call get specific attributes like points
let points = contributionMetadata.getPoints();
// ...Or use getMetadata() to get all available attributes from you profile
let metadata = contributionMetadata.getMetadata();
}
```
What `link` are you talking about?
The `link` that you need is your publically available local guides link found here:
https://www.google.com/maps/contrib/
When redirected to that link, the rest of the URL will populate with your google local guide ID and other information.
You can just get the entire link and pass it in as the value as `link`.
If you want to have a clean link, this is the structure that you can use:
```
https://www.google.com/maps/contrib/0123456789
```
The last path will be your numerical ID.
## Endpoints
```javascript
const ContributionMetadata = require('google-local-guides-api');
let contributionMetadata = new ContributionMetadata();
// This initializes your link into the response body -- has to be in async/await func
async function () {
await contributionMetadata.init(link);
// You can call get specific attributes like points
// These all return string type of a number associated with
// how many/how much for each attribute
let points = contributionMetadata.getPoints();
let level = contributionMetadata.getLevel();
let reviews = contributionMetadata.getReviews();
let ratings = contributionMetadata.getRatings();
let questions = contributionMetadata.getQuestions();
let placesAdded = contributionMetadata.getPlacesAdded();
let edits = contributionMetadata.getEdits();
let facts = contributionMetadata.getFacts();
let videos = contributionMetadata.getVideos();
let qa = contributionMetadata.getQA();
let roadsAdded = contributionMetadata.getRoadsAdded();
let listsPublished = contributionMetadata.getPublishedLists();
// ...Or use getMetadata() to get all available attributes from you profile
let metadata = contributionMetadata.getMetadata();
// {
// points: string,
// level: string,
// reviews: string,
// ratings: string,
// questions: string,
// placesAdded: string,
// edits: string,
// facts: string,
// videos: string,
// qa: string,
// roadsAdded: string,
// listsPublished: string
// }
}
```