Skip to content

Commit 38ff618

Browse files
committed
chore: initial commit with README
0 parents  commit 38ff618

1 file changed

Lines changed: 82 additions & 0 deletions

File tree

README.rst

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
Data Manager API utilities and samples for Python
2+
=================================================
3+
4+
Utilities and code samples for working with the Data Manager API and Python.
5+
6+
Requirements
7+
------------
8+
* Python 3.10+
9+
10+
Installation
11+
------------
12+
13+
.. code-block::
14+
15+
pip install .
16+
17+
Documentation
18+
-------------
19+
Please refer to our `Developer Site`_ for documentation on how to install,
20+
configure, and use this client library.
21+
22+
Run samples
23+
-----------
24+
25+
Samples are provided in the `samples/` directory, and the `samples/sampledata`
26+
directory contains samples of input files you can use with the samples.
27+
28+
To run a sample, invoke the script using the command line. You can pass
29+
arguments to the script in one of two ways:
30+
31+
1. Explicitly, on the command line
32+
-----------------------------------
33+
34+
.. code-block:: bash
35+
36+
python3 -m samples.events.ingest_events \
37+
--operating_account_type='GOOGLE_ADS' \
38+
--operating_account_id='<operating_account_id>' \
39+
--conversion_action_id='<conversion_action_id>' \
40+
--json_file='</path/to/your/file>'
41+
42+
2. Using an arguments file
43+
--------------------------
44+
45+
You can also save arguments in a file, with one argument per line.
46+
47+
.. code-block:: text
48+
49+
--operating_account_type
50+
GOOGLE_ADS
51+
--operating_account_id
52+
<operating_account_id>
53+
--conversion_action_id
54+
<conversion_action_id>
55+
--json_file
56+
</path/to/your/file>
57+
58+
Then, run the sample by passing the file path, prefixed with the ``@``
59+
character.
60+
61+
.. code-block:: bash
62+
63+
python3 -m samples.events.ingest_events @/path/to/your/args.txt
64+
65+
66+
Issue tracker
67+
-------------
68+
69+
https://github.com/googleads/data-manager-python/issues
70+
71+
Contributing
72+
------------
73+
74+
Contributions welcome! See the [Contributing Guide](CONTRIBUTING.md).
75+
76+
Authors
77+
-------
78+
79+
* `Josh Radcliff`_
80+
81+
.. _Developer Site: https://developers.google.com/data-manager/api/get-started/set-up-access#python
82+
.. _Josh Radcliff: https://github.com/jradcliff

0 commit comments

Comments
 (0)