Skip to content

Commit fd1116f

Browse files
docs: add query syntax rules for garf-bid-manager
1 parent 3caab94 commit fd1116f

File tree

4 files changed

+22
-0
lines changed

4 files changed

+22
-0
lines changed

docs/fetchers/bid-manager.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
## garf for Bid Manager API
22

3+
[![PyPI](https://img.shields.io/pypi/v/garf-bid-manager?logo=pypi&logoColor=white&style=flat-square)](https://pypi.org/project/garf-bid-manager)
4+
[![Downloads PyPI](https://img.shields.io/pypi/dw/garf-bid-manager?logo=pypi)](https://pypi.org/project/garf-bid-manager/)
5+
36
Interacts with [Bid Manager API](https://developers.google.com/bid-manager).
47

58
## Install
@@ -74,3 +77,13 @@ csv_writer.write(fetched_report, 'query')
7477
| name | values| comments |
7578
|----- | ----- | -------- |
7679
| `credentials_file` | File with Oauth or service account credentials | You can expose `credentials_file` as `GARF_BID_MANAGER_CREDENTIALS_FILE` ENV variable|
80+
81+
## Query syntax
82+
83+
`garf-bid-manager` uses simplified syntax for writing queries.
84+
85+
|area | Bid Manager | garf|
86+
| --- |----- | ----- |
87+
| filters and metrics case | upper (FILTER_ADVERTISER)| any (filter_advertiser) |
88+
| prefix| mandatory (FILTER_ADVERTISER)| optional for filters (advertiser) |
89+
| resource case | upper (STANDARD)| any (standard) |

docs/fetchers/merchant-center-api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# garf for Merchant Center API
22

3+
[![PyPI](https://img.shields.io/pypi/v/garf-merchant-api?logo=pypi&logoColor=white&style=flat-square)](https://pypi.org/project/garf-merchant-api)
4+
[![Downloads PyPI](https://img.shields.io/pypi/dw/garf-merchant-api?logo=pypi)](https://pypi.org/project/garf-merchant-api/)
5+
36
## Install
47

58
Install `garf-merchant-api` library

docs/fetchers/youtube-data-api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# garf for YouTube Data API
22

3+
[![PyPI](https://img.shields.io/pypi/v/garf-youtube-data-api?logo=pypi&logoColor=white&style=flat-square)](https://pypi.org/project/garf-youtube-data-api)
4+
[![Downloads PyPI](https://img.shields.io/pypi/dw/garf-youtube-data-api?logo=pypi)](https://pypi.org/project/garf-youtube-data-api/)
5+
36
Interacts with [YouTube Data API](https://developers.google.com/youtube/v3/docs).
47

58
## Install

docs/fetchers/youtube-reporting-api.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# garf for YouTube Data API
22

3+
[![PyPI](https://img.shields.io/pypi/v/garf-youtube-reporting-api?logo=pypi&logoColor=white&style=flat-square)](https://pypi.org/project/garf-youtube-reporting-api)
4+
[![Downloads PyPI](https://img.shields.io/pypi/dw/garf-youtube-reporting-api?logo=pypi)](https://pypi.org/project/garf-youtube-reporting-api/)
5+
36
## Install
47

58
Install `garf-youtube-reporting-api` library

0 commit comments

Comments
 (0)