Skip to content

fix(connectors docs): updated connectors to follow standard template #39328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Aug 14, 2024
Merged

fix(connectors docs): updated connectors to follow standard template #39328

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
4832af3
updated connectors to follow standard template
darynaishchenko Jun 6, 2024
2941499
Merge branch 'master' into daryna/update-connectors-docs-to-follow-te…
darynaishchenko Jun 11, 2024
7c65c56
added valid link to google-sheets.md
darynaishchenko Jun 11, 2024
cb36bba
fix For Airbyte Cloud/Open Source sections
darynaishchenko Jun 25, 2024
c19788c
Merge branch 'master' into daryna/update-connectors-docs-to-follow-te…
darynaishchenko Jun 25, 2024
3a0ca91
Merge branch 'master' into daryna/update-connectors-docs-to-follow-te…
darynaishchenko Aug 12, 2024
c97da7d
updated docs for new connectors with sl=300
darynaishchenko Aug 12, 2024
34e67e3
Merge branch 'master' into daryna/update-connectors-docs-to-follow-te…
darynaishchenko Aug 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 30 additions & 9 deletions docs/integrations/sources/amazon-ads.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Amazon Ads

This page contains the setup guide and reference information for the Amazon Ads source connector.
<HideInUI>

This page contains the setup guide and reference information for the [Amazon Ads](https://advertising.amazon.com) source connector.

</HideInUI>

## Prerequisites

Expand Down Expand Up @@ -29,13 +33,30 @@ To use the [Amazon Ads API](https://advertising.amazon.com/API/docs/en-us), you

<!-- env:cloud -->

**For Airbyte Cloud:**
#### 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 source setup page, select **Amazon Ads** from the Source type dropdown and enter a name for this connector.
4. Click **Authenticate your Amazon Ads account**.
5. Log in and Authorize to the Amazon account.
2. Click Sources and then click + New source.
3. On the Set up the source page, select Amazon Ads from the Source type dropdown.
4. Enter a name for the Amazon Ads connector.
5. Click **Authenticate your Amazon Ads account**.
6. Log in and Authorize to the Amazon account.
7. Select **Region** to pull data from **North America (NA)**, **Europe (EU)**, **Far East (FE)**. See [docs](https://advertising.amazon.com/API/docs/en-us/info/api-overview#api-endpoints) for more details.
8. **Start Date (Optional)** is used for generating reports starting from the specified start date. This should be in YYYY-MM-DD format and not more than 60 days in the past. If a date is not specified, today's date is used. The date is treated in the timezone of the processed profile.
9. **Profile IDs (Optional)** you want to fetch data for. The Amazon Ads source connector supports only profiles with seller and vendor type, profiles with agency type will be ignored. See [docs](https://advertising.amazon.com/API/docs/en-us/concepts/authorization/profiles) for more details.
10. **Marketplace IDs (Optional)** you want to fetch data for. _Note: If Profile IDs are also selected, profiles will be selected if they match the Profile ID **OR** the Marketplace ID._
11. Click **Set up source**.
<!-- /env:cloud -->

<!-- env:oss -->

#### For Airbyte Open Source:

1. Navigate to the Airbyte Open Source dashboard.
2. Set the name for your source.
3. **Client ID** of your Amazon Ads developer application. See [onboarding process](https://advertising.amazon.com/API/docs/en-us/setting-up/overview) for more details.
4. **Client Secret** of your Amazon Ads developer application. See [onboarding process](https://advertising.amazon.com/API/docs/en-us/setting-up/overview) for more details.
5. **Refresh Token**. See [onboarding process](https://advertising.amazon.com/API/docs/en-us/setting-up/overview) for more details.
6. Select **Region** to pull data from **North America (NA)**, **Europe (EU)**, **Far East (FE)**. See [docs](https://advertising.amazon.com/API/docs/en-us/info/api-overview#api-endpoints) for more details.
7. **Start Date (Optional)** is used for generating reports starting from the specified start date. This should be in YYYY-MM-DD format and not more than 60 days in the past. If a date is not specified, today's date is used. The date is treated in the timezone of the processed profile.
8. **Profile IDs (Optional)** you want to fetch data for. The Amazon Ads source connector supports only profiles with seller and vendor type, profiles with agency type will be ignored. See [docs](https://advertising.amazon.com/API/docs/en-us/concepts/authorization/profiles) for more details.
Expand Down Expand Up @@ -63,7 +84,7 @@ If you have only agency profile, please use accounts associated with the profile

## Supported sync modes

The Amazon Ads source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts/#connection-sync-mode):
The Amazon Ads source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts/#connection-sync-modes):

- Full Refresh
- Incremental
Expand Down Expand Up @@ -114,7 +135,7 @@ Report data synchronization only covers the last 60 days - [details](https://adv

Information about expected report generation waiting time can be found [here](https://advertising.amazon.com/API/docs/en-us/get-started/developer-notes).

### Data type mapping
### Data type map

| Integration Type | Airbyte Type |
| :----------------------- | :----------- |
Expand Down Expand Up @@ -150,7 +171,7 @@ Information about expected report generation waiting time can be found [here](ht
| 3.2.0 | 2023-09-18 | [30517](https://github.com/airbytehq/airbyte/pull/30517) | Add suggested streams; fix unexpected column issue |
| 3.1.2 | 2023-08-16 | [29233](https://github.com/airbytehq/airbyte/pull/29233) | Add filter for Marketplace IDs |
| 3.1.1 | 2023-08-28 | [29900](https://github.com/airbytehq/airbyte/pull/29900) | Add 404 handling for no associated with bid ad groups |
| 3.1.0 | 2023-08-08 | [00000](https://github.com/airbytehq/airbyte/pull/00000) | Add `T00030` tactic support for `sponsored_display_report_stream` |
| 3.1.0 | 2023-08-08 | [29212](https://github.com/airbytehq/airbyte/pull/29212) | Add `T00030` tactic support for `sponsored_display_report_stream` |
| 3.0.0 | 2023-07-24 | [27868](https://github.com/airbytehq/airbyte/pull/27868) | Fix attribution report stream schemas |
| 2.3.1 | 2023-07-11 | [28155](https://github.com/airbytehq/airbyte/pull/28155) | Bugfix: validation error when record values are missing |
| 2.3.0 | 2023-07-06 | [28002](https://github.com/airbytehq/airbyte/pull/28002) | Add sponsored_product_ad_group_suggested_keywords, sponsored_product_ad_group_bid_recommendations streams |
Expand Down
58 changes: 34 additions & 24 deletions docs/integrations/sources/facebook-marketing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,40 @@
# Facebook Marketing

This page guides you through the process of setting up the Facebook Marketing source connector.
<HideInUI>

This page contains the setup guide and reference information for the [Facebook Marketing](https://developers.facebook.com) source connector.

</HideInUI>

## Prerequisites

- A [Facebook Ad Account ID](https://www.facebook.com/business/help/1492627900875762)

## Setup guide

### Set up Facebook Marketing

<!-- env:cloud -->

#### For Airbyte Cloud
#### For Airbyte Cloud:

1. [Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account.
2. Click Sources and then click + New source.
3. On the Set up the source page, select Facebook Marketing from the Source type dropdown.
4. Enter a name for the Facebook Marketing connector.

If you are not the owner/admin of the Ad account, you must be granted [permissions to access the Ad account](https://www.facebook.com/business/help/155909647811305?id=829106167281625) by an admin.

<!-- /env:cloud -->

<!-- env:oss -->

#### For Airbyte Open Source
#### For Airbyte Open Source:

1. Navigate to the Airbyte Open Source dashboard.
2. Click Sources and then click + New source.
3. On the Set up the source page, select Facebook Marketing from the Source type dropdown.
4. Enter a name for the Facebook Marketing connector.

A [Facebook app](https://developers.facebook.com/apps/) with the Marketing API enabled and the following permissions:

Expand All @@ -27,7 +45,16 @@ A [Facebook app](https://developers.facebook.com/apps/) with the Marketing API e

<!-- /env:oss -->

## Setup guide
5. To authenticate the connection:

<!-- env:cloud -->

**For Airbyte Cloud**: Click **Authenticate your account** to authorize your Facebook account. Make sure you are logged into the right account, as Airbyte will authenticate the account you are currently logged in to.
<!-- /env:cloud -->
<!-- env:oss -->

**For Airbyte Open Source**: In the **Access Token** field, enter the access token you generated with your Facebook app.
<!-- /env:oss -->

<!-- env:oss -->

Expand All @@ -53,23 +80,6 @@ You can use the [Access Token Tool](https://developers.facebook.com/tools/access

<!-- /env:oss -->

### Set up Facebook Marketing as a source in Airbyte

1. [Log in to your Airbyte Cloud](https://cloud.airbyte.io/workspaces) account, or navigate to your Airbyte Open Source dashboard.
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ New source**.
3. Find and select **Facebook Marketing** from the list of available sources.
4. For **Source name**, enter a name for your Facebook Marketing connector.
5. To authenticate the connection:

<!-- env:cloud -->

**For Airbyte Cloud**: Click **Authenticate your account** to authorize your Facebook account. Make sure you are logged into the right account, as Airbyte will authenticate the account you are currently logged in to.
<!-- /env:cloud -->
<!-- env:oss -->

**For Airbyte Open Source**: In the **Access Token** field, enter the access token you generated with your Facebook app.
<!-- /env:oss -->

#### Facebook Marketing Source Settings

1. For **Account ID(s)**, enter one or multiple comma-separated [Facebook Ad Account ID Numbers](https://www.facebook.com/business/help/1492627900875762) to use when pulling data from the Facebook Marketing API. To find this ID, open your Meta Ads Manager. The Ad Account ID number is in the **Account** dropdown menu or in your browser's address bar. Refer to the [Facebook docs](https://www.facebook.com/business/help/1492627900875762) for more information.
Expand Down Expand Up @@ -121,14 +131,14 @@ You can use the [Access Token Tool](https://developers.facebook.com/tools/access

## Supported sync modes

The Facebook Marketing source connector supports the following sync modes:
The Facebook Marketing source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts/#connection-sync-modes):

- [Full Refresh - Overwrite](https://docs.airbyte.com/understanding-airbyte/connections/full-refresh-overwrite/)
- [Full Refresh - Append](https://docs.airbyte.com/understanding-airbyte/connections/full-refresh-append)
- [Incremental Sync - Append](https://docs.airbyte.com/understanding-airbyte/connections/incremental-append) (except for the AdCreatives and AdAccount tables)
- [Incremental Sync - Append + Deduped](https://docs.airbyte.com/understanding-airbyte/connections/incremental-append-deduped) (except for the AdCreatives and AdAccount tables)

## Supported streams
## Supported Streams

- [Activities](https://developers.facebook.com/docs/marketing-api/reference/ad-activity)
- [AdAccount](https://developers.facebook.com/docs/marketing-api/business-asset-management/guides/ad-accounts)
Expand Down Expand Up @@ -189,7 +199,7 @@ Please be aware that some fields, such as `conversions` and `conversion_values`,

The Facebook Marketing connector uses the `lookback_window` parameter to repeatedly read data from the last `<lookback_window>` days during an Incremental sync. This means some data will be synced twice (or possibly more often) despite the cursor value being up to date, in order to capture updated ads conversion data from Facebook. You can change this date window by adjusting the `lookback_window` parameter when setting up the source, up to a maximum of 28 days. Smaller values will result in fewer duplicates, while larger values provide more accurate results. For a deeper understanding of the purpose and role of the attribution window, refer to this [Meta article](https://www.facebook.com/business/help/458681590974355?id=768381033531365).

## Data type mapping
## Data type map

| Integration Type | Airbyte Type |
|:----------------:|:------------:|
Expand Down
35 changes: 19 additions & 16 deletions docs/integrations/sources/google-ads.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Google Ads

This page contains the setup guide and reference information for the Google Ads source connector.
<HideInUI>

This page contains the setup guide and reference information for the [Google Ads](https://developers.google.com) source connector.

</HideInUI>

## Prerequisites

Expand All @@ -13,9 +17,11 @@ This page contains the setup guide and reference information for the Google Ads

## Setup guide

### Set up Google Ads

<!-- env:oss -->

### Step 1: (For Airbyte Open Source) Apply for a developer token
#### Step 1: (For Airbyte Open Source) Apply for a developer token

To set up the Google Ads source connector with Airbyte Open Source, you will need to obtain a developer token. This token allows you to access your data from the Google Ads API. Please note that Google is selective about which software and use cases are issued this token. The Airbyte team has worked with the Google Ads team to allowlist Airbyte and ensure you can get a developer token (see [issue 1981](https://github.com/airbytehq/airbyte/issues/1981) for more information on this topic).

Expand All @@ -33,7 +39,7 @@ To set up the Google Ads source connector with Airbyte Open Source, you will nee
You will _not_ be able to access your data via the Google Ads API until this token is approved. You cannot use a test developer token; it has to be at least a basic developer token. The approval process typically takes around 24 hours.
:::

### Step 2: (For Airbyte Open Source) Obtain your OAuth credentials
#### Step 2: (For Airbyte Open Source) Obtain your OAuth credentials

If you are using Airbyte Open Source, you will need to obtain the following OAuth credentials to authenticate your Google Ads account:

Expand All @@ -52,16 +58,15 @@ Each Google Ads API developer token is assigned an access level and "permissible
### Step 3: Set up the Google Ads connector in Airbyte

<!-- /env:oss -->

<!-- env:cloud -->

#### For Airbyte Cloud:

To set up Google Ads as a source in Airbyte Cloud:

1. [Log in to 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. Find and select **Google Ads** from the list of available sources.
4. Enter a **Source name** of your choosing.
1. [Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account.
2. Click Sources and then click + New source.
3. On the Set up the source page, select Google Ads from the Source type dropdown.
4. Enter a name for the Google Ads connector.
5. Click **Sign in with Google** to authenticate your Google Ads account. In the pop-up, select the appropriate Google account and click **Continue** to proceed.
6. (Optional) Enter a comma-separated list of the **Customer ID(s)** for your account. These IDs are 10-digit numbers that uniquely identify your account. To find your Customer ID, please follow [Google's instructions](https://support.google.com/google-ads/answer/1704344). Leaving this field blank will replicate data from all connected accounts.
7. (Optional) Enter customer statuses to filter customers. Leaving this field blank will replicate data from all accounts. Check [Google Ads documentation](https://developers.google.com/google-ads/api/reference/rpc/v15/CustomerStatusEnum.CustomerStatus) for more info.
Expand All @@ -81,9 +86,7 @@ To set up Google Ads as a source in Airbyte Cloud:

#### For Airbyte Open Source:

To set up Google Ads as a source in Airbyte Open Source:

1. Log in to your Airbyte Open Source account.
1. Navigate to the Airbyte Open Source dashboard.
2. In the left navigation bar, click **Sources**. In the top-right corner, click **+ New source**.
3. Find and select **Google Ads** from the list of available sources.
4. Enter a **Source name** of your choosing.
Expand All @@ -100,16 +103,16 @@ To set up Google Ads as a source in Airbyte Open Source:

<!-- /env:oss -->

## Supported Sync Modes
## Supported sync modes

The Google Ads source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
The Google Ads source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts/#connection-sync-modes):

- [Full Refresh - Overwrite](https://docs.airbyte.com/understanding-airbyte/connections/full-refresh-overwrite/)
- [Full Refresh - Append](https://docs.airbyte.com/understanding-airbyte/connections/full-refresh-append)
- [Incremental Sync - Append](https://docs.airbyte.com/understanding-airbyte/connections/incremental-append)
- [Incremental Sync - Append + Deduped](https://docs.airbyte.com/understanding-airbyte/connections/incremental-append-deduped)

#### Incremental Events Streams
**Incremental Events Streams:**

List of stream:

Expand Down Expand Up @@ -188,7 +191,7 @@ Note that `ad_group`, `ad_group_ad`, and `campaign` contain a `labels` field, wh

### Report Tables

- [account_performance_report](https://developers.google.com/google-ads/api/docs/migration/mapping#account_performance)
- [account_performance_report](https://developers.google.com/google-ads/api/fields/v15/overview)

Provides in-depth metrics related to ads interactions, including viewability, click-through rates, and conversions. Segments data by various factors, offering a granular look into how ads perform across different contexts.

Expand Down
Loading
Loading