Skip to content

Latest commit

 

History

History
135 lines (115 loc) · 5.99 KB

README.md

File metadata and controls

135 lines (115 loc) · 5.99 KB
Raw

tap-youtube-analytics

Python Version: 3.7.4

This is a Singer tap that produces JSON-formatted data following the Singer spec.

This tap:

Authentication

The Youtube Analytics Authentication Google Doc provides instructions show how to configure an API app, generate an API key (client_id, client_secret), authenticate and generate a refresh_token, and prepare your tap config.json with the necessary parameters.

Quick Start

  1. Install

    Clone this repository, and then install using setup.py. We recommend using a virtualenv:

    > virtualenv -p python3 venv
> source venv/bin/activate
> python setup.py install
OR
> cd .../tap-youtube-analytics
> pip install .

  2. Dependent libraries The following dependent libraries were installed.

    > pip install target-json
> pip install target-stitch
> pip install singer-tools
> pip install singer-python

  3. Create your tap's config.json file. Include the client_id, client_secret, refresh_token, channel_ids (unique channel IDs in a comma delimited list), start_date (UTC format), and user_agent (tap name with the api user email address).

    {
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "refresh_token": "YOUR_REFRESH_TOKEN",
    "channel_ids": "CHANNEL_ID_1, CHANNEL_ID_2, CHANNEL_ID_3ß",
    "start_date": "2019-01-01T00:00:00Z",
    "user_agent": "tap-youtube-analytics <[email protected]>"
}

    Optionally, also create a state.json file. currently_syncing is an optional attribute used for identifying the last object to be synced in case the job is interrupted mid-stream. The next run would begin where the last job left off. Only the performance_reports uses a bookmark. The date-time bookmark is stored in a nested structure based on the endpoint, site, and sub_type.

    {
  "currently_syncing": "sitemaps",
  "bookmarks": {
    "playlist_items": "2020-04-08T00:00:00.000000Z",
    "videos": "2020-04-08T00:00:00.000000Z",
    "channel_basic": "2020-04-08T00:00:00.000000Z",
    "channel_province": "2020-04-08T00:00:00.000000Z",
    "channel_traffic_source": "2020-04-08T00:00:00.000000Z"
  }
}

  4. Run the Tap in Discovery Mode This creates a catalog.json for selecting objects/fields to integrate:

    tap-youtube-analytics --config config.json --discover > catalog.json

    See the Singer docs on discovery mode here.

  5. Run the Tap in Sync Mode (with catalog) and write out to state file

    For Sync mode:

    > tap-youtube-analytics --config tap_config.json --catalog catalog.json > state.json
> tail -1 state.json > state.json.tmp && mv state.json.tmp state.json

    To load to json files to verify outputs:

    > tap-youtube-analytics --config tap_config.json --catalog catalog.json | target-json > state.json
> tail -1 state.json > state.json.tmp && mv state.json.tmp state.json

    To pseudo-load to Stitch Import API with dry run:

    > tap-youtube-analytics --config tap_config.json --catalog catalog.json | target-stitch --config target_config.json --dry-run > state.json
> tail -1 state.json > state.json.tmp && mv state.json.tmp state.json

  6. Test the Tap

    While developing the Google Search Console tap, the following utilities were run in accordance with Singer.io best practices: Pylint to improve code quality:

    > pylint tap_youtube_analytics -d missing-docstring -d logging-format-interpolation -d too-many-locals -d too-many-arguments

    Pylint test resulted in the following score:

    Your code has been rated at 9.87/10

    To check the tap and verify working:

    > tap-youtube-analytics --config tap_config.json --catalog catalog.json | singer-check-tap > state.json
> tail -1 state.json > state.json.tmp && mv state.json.tmp state.json

    Check tap resulted in the following:

      TBD

Copyright © 2019 Stitch