garf-merchant-api 0.0.1

Garf implementation for Google Merchant API

garf for Merchant API

garf-merchant-api simplifies fetching data from Merchant API using SQL-like queries.

Prerequisites

• Merchant API enabled.

Installation

pip install garf-merchant-api

Usage

Run as a library

from garf_merchant_api import report_fetcher
from garf_io import writer


# Specify query
query = """
  SELECT
    date,
    clicks
    FROM product_performance_view
    WHERE date BETWEEN '2023-12-01' AND '2023-12-03'
  ORDER BY clicks DESC
""

# Fetch report
fetched_report = (
  report_fetcher.MerchantApiReportFetcher()
  .fetch(query, query="<YOUR_SEARCH_QUERY_HERE">, account=ACCOUNT_ID)
)

# Write report to console
console_writer = writer.create_writer('console')
console_writer.write(fetched_report, 'output')

Run via CLI

Install garf-executors package to run queries via CLI (pip install garf-executors).

garf <PATH_TO_QUERIES> --source merchant-api \
  --output <OUTPUT_TYPE> \
  --source.<SOURCE_PARAMETER=VALUE>

where:

• <PATH_TO_QUERIES> - local or remove files containing queries
• <OUTPUT_TYPE> - output supported by garf-io library.
• <SOURCE_PARAMETER=VALUE - key-value pairs to refine fetching, check available source parameters.

Available source parameters

name	values	comments
account	Account(s) to get data to	Multiple accounts are supported, should be comma-separated