76df2f240a
* updated_links_in_docs * updated more links * typo * removed backticks * deleted links in deploying on cloud and local deployment
69 lines
2.7 KiB
Markdown
69 lines
2.7 KiB
Markdown
# Google-webfonts
|
|
|
|
This page contains the setup guide and reference information for the [Google-webfonts](https://developers.google.com/fonts/docs/developer_api) source connector.
|
|
|
|
## Prerequisites
|
|
|
|
Api key is mandate for this connector to work, It could be generated by a gmail account for free at https://console.cloud.google.com/apis/dashboard.
|
|
Just pass the generated API key and optional parameters for establishing the connection. Example:123
|
|
|
|
## Setup guide
|
|
|
|
### Step 1: Set up Google-webfonts connection
|
|
|
|
- Generate an API key (Example: 12345)
|
|
- Params (If specific info is needed)
|
|
- Available params
|
|
- sort: SORT_UNDEFINED, ALPHA, DATE, STYLE, TRENDING, POPULARITY
|
|
- alt: json, media or proto
|
|
- prettyPrint: boolean
|
|
|
|
## Step 2: Set up the Google-webfonts connector in Airbyte
|
|
|
|
### For Airbyte Cloud:
|
|
|
|
1. [Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account.
|
|
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**.
|
|
3. On the Set up the source page, enter the name for the Google-webfonts connector and select **Google-webfonts** from the Source type dropdown.
|
|
4. Enter your `api_key`.
|
|
5. Enter the params configuration if needed. Supported params are: sort, alt, prettyPrint (Optional)
|
|
6. Click **Set up source**.
|
|
|
|
### For Airbyte OSS:
|
|
|
|
1. Navigate to the Airbyte Open Source dashboard.
|
|
2. Set the name for your source.
|
|
3. Enter your `api_key`.
|
|
5. Enter the params configuration if needed. Supported params are: sort, alt, prettyPrint (Optional)
|
|
6. Click **Set up source**.
|
|
|
|
## Supported sync modes
|
|
|
|
The Google-webfonts source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
|
|
|
|
| Feature | Supported? |
|
|
| :---------------------------- | :--------- |
|
|
| Full Refresh Sync | Yes |
|
|
| Incremental Sync | No |
|
|
| Replicate Incremental Deletes | No |
|
|
| SSL connection | Yes |
|
|
| Namespaces | No |
|
|
|
|
## Supported Streams
|
|
|
|
- Webfonts (Single stream API)
|
|
|
|
## API method example
|
|
|
|
`GET https://webfonts.googleapis.com/v1/webfonts?key=<1234567>&sort=SORT_UNDEFINED&prettyPrint=true&alt=json`
|
|
|
|
## Performance considerations
|
|
|
|
Google Webfont's [API reference](https://developers.google.com/fonts/docs/developer_api) has v1 at present and v2 is at development. The connector as default uses v1.
|
|
|
|
## Changelog
|
|
|
|
| Version | Date | Pull Request | Subject |
|
|
| :------ | :--------- | :----------------------------------------------------- | :------------- |
|
|
| 0.1.0 | 2022-10-26 | [Init](https://github.com/airbytehq/airbyte/pull/18496)| Initial commit |
|