Skip to content

Commit

Permalink
TDL-18524 updated readme and added sample config (AutoIDM#51)
Browse files Browse the repository at this point in the history
* updated readme and added sample config

* updated endpoints

* add new streams

* resolved PR comments

* fixed a typo

* added the
  • Loading branch information
namrata270998 authored Jun 30, 2022
1 parent e4aab11 commit 7362c58
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 1 deletion.
58 changes: 57 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,64 @@ spec](https://github.com/singer-io/getting-started/blob/master/SPEC.md).

This tap:

- Pulls raw data from the [Google Ads API](https://developers.google.com/google-ads/api/docs/start).
- Pulls data from the [Google Ads API](https://developers.google.com/google-ads/api/docs/start).
- Extracts the following resources from Google Ads
- [Accessible Bidding Strategies](https://developers.google.com/google-ads/api/reference/rpc/v10/AccessibleBiddingStrategy)
- [Accounts](https://developers.google.com/google-ads/api/reference/rpc/v10/Customer)
- [Ad Groups](https://developers.google.com/google-ads/api/reference/rpc/v10/AdGroup)
- [Ads](https://developers.google.com/google-ads/api/reference/rpc/v10/Ad)
- [Bidding Strategies](https://developers.google.com/google-ads/api/reference/rpc/v10/BiddingStrategy)
- [Call Details](https://developers.google.com/google-ads/api/reference/rpc/v10/CallView)
- [Campaigns](https://developers.google.com/google-ads/api/reference/rpc/v10/Campaign)
- [Campaign Budgets](https://developers.google.com/google-ads/api/reference/rpc/v10/CampaignBudget)
- [Campaign Labels](https://developers.google.com/google-ads/api/reference/rpc/v10/CampaignLabel)
- [Labels](https://developers.google.com/google-ads/api/reference/rpc/v10/Label)
- [Reporting](https://developers.google.com/google-ads/api/docs/reporting/overview)
- [Account Performance Report](https://developers.google.com/google-ads/api/fields/v10/customer)
- [Ad Group Performance Report](https://developers.google.com/google-ads/api/fields/v10/ad_group)
- [Ad Group Audience Performance Report](https://developers.google.com/google-ads/api/fields/v10/ad_group_audience_view)
- [Ad Performance Report](https://developers.google.com/google-ads/api/fields/v10/ad_group_ad)
- [Age Range Performance Report](https://developers.google.com/google-ads/api/fields/v10/age_range_view)
- [Campaign Performance Report](https://developers.google.com/google-ads/api/fields/v10/campaign)
- [Campaign Audience Performance Report](https://developers.google.com/google-ads/api/fields/v10/campaign_audience_view)
- [Call Metrics Call Details Report](https://developers.google.com/google-ads/api/fields/v10/call_view)
- [Click Performance Report](https://developers.google.com/google-ads/api/fields/v10/click_view)
- [Display Keyword Performance Report](https://developers.google.com/google-ads/api/fields/v10/display_keyword_view)
- [Display Topics Performance Report](https://developers.google.com/google-ads/api/fields/v10/topic_view)
- [Expanded Landing Page Report](https://developers.google.com/google-ads/api/fields/v10/expanded_landing_page_view)
- [Gender Performance Report](https://developers.google.com/google-ads/api/fields/v10/gender_view)
- [Geo Performance Report](https://developers.google.com/google-ads/api/fields/v10/geographic_view)
- [Keywordless Query Report](https://developers.google.com/google-ads/api/fields/v10/dynamic_search_ads_search_term_view)
- [Keywords Performance Report](https://developers.google.com/google-ads/api/fields/v10/keyword_view)
- [Landing Page Report](https://developers.google.com/google-ads/api/fields/v10/landing_page_view)
- [Placeholder Feed Item Report](https://developers.google.com/google-ads/api/fields/v10/feed_item)
- [Placeholder Report](https://developers.google.com/google-ads/api/fields/v10/feed_placeholder_view)
- [Placement Performance Report](https://developers.google.com/google-ads/api/fields/v10/managed_placement_view)
- [Search Query Performance Report](https://developers.google.com/google-ads/api/fields/v10/search_term_view)
- [Shopping Performance Report](https://developers.google.com/google-ads/api/fields/v10/shopping_performance_view)
- [User Location Performance Report](https://developers.google.com/google-ads/api/fields/v10/user_location_view)
- [UserLocation Performance Report](https://developers.google.com/google-ads/api/fields/v10/user_location_view)
- [Video Performance Report](https://developers.google.com/google-ads/api/fields/v10/video)

## Bookmarking Strategy

The Google Ads API supports the `start_date` and `end_date` parameters that limits the records which filters the analytics records in the given time period.

## Configuration

This tap requires a `config.json` which specifies details regarding [OAuth 2.0](https://developers.google.com/google-ads/api/docs/oauth/overview) authentication and a cutoff date for syncing historical data. See [config.sample.json](config.sample.json) for an example.

To run the discover mode of `tap-google-ads` with the configuration file, use this command:

```bash
$ tap-google-ads -c my-config.json -d
```

To run the sync mode of `tap-google-ads` with the catalog file, use the command:

```bash
$ tap-google-ads -c my-config.json --catalog catalog.json
```
---

Copyright © 2021 Stitch
8 changes: 8 additions & 0 deletions config.sample.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"start_date": "2020-10-01T00:00:00Z",
"login_customer_ids": [{"customerId": "1234567890", "loginCustomerId": "0987654321"}],
"oauth_client_id":"client_id",
"oauth_client_secret":"client_secret",
"refresh_token":"refresh_token",
"developer_token":"developer_token"
}

0 comments on commit 7362c58

Please sign in to comment.