google-ads-datamanager 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (51) hide show
  1. google_ads_datamanager-0.1.0/LICENSE +202 -0
  2. google_ads_datamanager-0.1.0/MANIFEST.in +20 -0
  3. google_ads_datamanager-0.1.0/PKG-INFO +243 -0
  4. google_ads_datamanager-0.1.0/README.rst +198 -0
  5. google_ads_datamanager-0.1.0/google/ads/datamanager/__init__.py +137 -0
  6. google_ads_datamanager-0.1.0/google/ads/datamanager/gapic_version.py +16 -0
  7. google_ads_datamanager-0.1.0/google/ads/datamanager/py.typed +2 -0
  8. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/__init__.py +106 -0
  9. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/gapic_metadata.json +88 -0
  10. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/gapic_version.py +16 -0
  11. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/py.typed +2 -0
  12. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/services/__init__.py +15 -0
  13. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/services/ingestion_service/__init__.py +22 -0
  14. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/services/ingestion_service/async_client.py +665 -0
  15. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/services/ingestion_service/client.py +1067 -0
  16. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/services/ingestion_service/transports/__init__.py +36 -0
  17. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/services/ingestion_service/transports/base.py +220 -0
  18. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/services/ingestion_service/transports/grpc.py +455 -0
  19. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/services/ingestion_service/transports/grpc_asyncio.py +494 -0
  20. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/services/ingestion_service/transports/rest.py +1097 -0
  21. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/services/ingestion_service/transports/rest_base.py +311 -0
  22. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/types/__init__.py +95 -0
  23. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/types/audience.py +135 -0
  24. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/types/cart_data.py +105 -0
  25. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/types/consent.py +74 -0
  26. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/types/destination.py +177 -0
  27. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/types/device_info.py +65 -0
  28. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/types/encryption_info.py +106 -0
  29. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/types/error.py +174 -0
  30. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/types/event.py +285 -0
  31. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/types/experimental_field.py +50 -0
  32. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/types/ingestion_service.py +354 -0
  33. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/types/match_rate.py +79 -0
  34. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/types/processing_errors.py +261 -0
  35. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/types/request_status_per_destination.py +409 -0
  36. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/types/terms_of_service.py +70 -0
  37. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/types/user_data.py +140 -0
  38. google_ads_datamanager-0.1.0/google/ads/datamanager_v1/types/user_properties.py +100 -0
  39. google_ads_datamanager-0.1.0/google_ads_datamanager.egg-info/PKG-INFO +243 -0
  40. google_ads_datamanager-0.1.0/google_ads_datamanager.egg-info/SOURCES.txt +49 -0
  41. google_ads_datamanager-0.1.0/google_ads_datamanager.egg-info/dependency_links.txt +1 -0
  42. google_ads_datamanager-0.1.0/google_ads_datamanager.egg-info/not-zip-safe +1 -0
  43. google_ads_datamanager-0.1.0/google_ads_datamanager.egg-info/requires.txt +11 -0
  44. google_ads_datamanager-0.1.0/google_ads_datamanager.egg-info/top_level.txt +1 -0
  45. google_ads_datamanager-0.1.0/setup.cfg +4 -0
  46. google_ads_datamanager-0.1.0/setup.py +100 -0
  47. google_ads_datamanager-0.1.0/tests/__init__.py +15 -0
  48. google_ads_datamanager-0.1.0/tests/unit/__init__.py +15 -0
  49. google_ads_datamanager-0.1.0/tests/unit/gapic/__init__.py +15 -0
  50. google_ads_datamanager-0.1.0/tests/unit/gapic/datamanager_v1/__init__.py +15 -0
  51. google_ads_datamanager-0.1.0/tests/unit/gapic/datamanager_v1/test_ingestion_service.py +4014 -0
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,20 @@
1
+ # -*- coding: utf-8 -*-
2
+ # Copyright 2025 Google LLC
3
+ #
4
+ # Licensed under the Apache License, Version 2.0 (the "License");
5
+ # you may not use this file except in compliance with the License.
6
+ # You may obtain a copy of the License at
7
+ #
8
+ # http://www.apache.org/licenses/LICENSE-2.0
9
+ #
10
+ # Unless required by applicable law or agreed to in writing, software
11
+ # distributed under the License is distributed on an "AS IS" BASIS,
12
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ # See the License for the specific language governing permissions and
14
+ # limitations under the License.
15
+ #
16
+ include README.rst LICENSE
17
+ recursive-include google *.py *.pyi *.json *.proto py.typed
18
+ recursive-include tests *
19
+ global-exclude *.py[co]
20
+ global-exclude __pycache__
@@ -0,0 +1,243 @@
1
+ Metadata-Version: 2.4
2
+ Name: google-ads-datamanager
3
+ Version: 0.1.0
4
+ Summary: Google Ads Datamanager API client library
5
+ Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-ads-datamanager
6
+ Author: Google LLC
7
+ Author-email: googleapis-packages@google.com
8
+ License: Apache 2.0
9
+ Platform: Posix; MacOS X; Windows
10
+ Classifier: Development Status :: 4 - Beta
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: License :: OSI Approved :: Apache Software License
13
+ Classifier: Programming Language :: Python
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Programming Language :: Python :: 3.7
16
+ Classifier: Programming Language :: Python :: 3.8
17
+ Classifier: Programming Language :: Python :: 3.9
18
+ Classifier: Programming Language :: Python :: 3.10
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Programming Language :: Python :: 3.13
22
+ Classifier: Programming Language :: Python :: 3.14
23
+ Classifier: Operating System :: OS Independent
24
+ Classifier: Topic :: Internet
25
+ Requires-Python: >=3.7
26
+ License-File: LICENSE
27
+ Requires-Dist: google-api-core[grpc]!=2.0.*,!=2.1.*,!=2.10.*,!=2.2.*,!=2.3.*,!=2.4.*,!=2.5.*,!=2.6.*,!=2.7.*,!=2.8.*,!=2.9.*,<3.0.0,>=1.34.1
28
+ Requires-Dist: google-auth!=2.24.0,!=2.25.0,<3.0.0,>=2.14.1
29
+ Requires-Dist: grpcio<2.0.0,>=1.33.2
30
+ Requires-Dist: grpcio<2.0.0,>=1.75.1; python_version >= "3.14"
31
+ Requires-Dist: proto-plus<2.0.0,>=1.22.3
32
+ Requires-Dist: proto-plus<2.0.0,>=1.25.0; python_version >= "3.13"
33
+ Requires-Dist: protobuf!=4.21.0,!=4.21.1,!=4.21.2,!=4.21.3,!=4.21.4,!=4.21.5,<7.0.0,>=3.20.2
34
+ Dynamic: author
35
+ Dynamic: author-email
36
+ Dynamic: classifier
37
+ Dynamic: description
38
+ Dynamic: home-page
39
+ Dynamic: license
40
+ Dynamic: license-file
41
+ Dynamic: platform
42
+ Dynamic: requires-dist
43
+ Dynamic: requires-python
44
+ Dynamic: summary
45
+
46
+ Python Client for Data Manager API
47
+ ==================================
48
+
49
+ |preview| |pypi| |versions|
50
+
51
+ `Data Manager API`_: A unified ingestion API for data partners, agencies and advertisers to
52
+ connect first-party data across Google advertising products.
53
+
54
+ - `Client Library Documentation`_
55
+ - `Product Documentation`_
56
+
57
+ .. |preview| image:: https://img.shields.io/badge/support-preview-orange.svg
58
+ :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels
59
+ .. |pypi| image:: https://img.shields.io/pypi/v/google-ads-datamanager.svg
60
+ :target: https://pypi.org/project/google-ads-datamanager/
61
+ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-ads-datamanager.svg
62
+ :target: https://pypi.org/project/google-ads-datamanager/
63
+ .. _Data Manager API: https://developers.google.com/data-manager
64
+ .. _Client Library Documentation: https://cloud.google.com/python/docs/reference/google-ads-datamanager/latest
65
+ .. _Product Documentation: https://developers.google.com/data-manager
66
+
67
+ Quick Start
68
+ -----------
69
+
70
+ In order to use this library, you first need to go through the following steps:
71
+
72
+ 1. `Select or create a Cloud Platform project.`_
73
+ 2. `Enable billing for your project.`_
74
+ 3. `Enable the Data Manager API.`_
75
+ 4. `Set up Authentication.`_
76
+
77
+ .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
78
+ .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
79
+ .. _Enable the Data Manager API.: https://developers.google.com/data-manager
80
+ .. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
81
+
82
+ Installation
83
+ ~~~~~~~~~~~~
84
+
85
+ Install this library in a virtual environment using `venv`_. `venv`_ is a tool that
86
+ creates isolated Python environments. These isolated environments can have separate
87
+ versions of Python packages, which allows you to isolate one project's dependencies
88
+ from the dependencies of other projects.
89
+
90
+ With `venv`_, it's possible to install this library without needing system
91
+ install permissions, and without clashing with the installed system
92
+ dependencies.
93
+
94
+ .. _`venv`: https://docs.python.org/3/library/venv.html
95
+
96
+
97
+ Code samples and snippets
98
+ ~~~~~~~~~~~~~~~~~~~~~~~~~
99
+
100
+ Code samples and snippets live in the `samples/`_ folder.
101
+
102
+ .. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-ads-datamanager/samples
103
+
104
+
105
+ Supported Python Versions
106
+ ^^^^^^^^^^^^^^^^^^^^^^^^^
107
+ Our client libraries are compatible with all current `active`_ and `maintenance`_ versions of
108
+ Python.
109
+
110
+ Python >= 3.7, including 3.14
111
+
112
+ .. _active: https://devguide.python.org/devcycle/#in-development-main-branch
113
+ .. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches
114
+
115
+ Unsupported Python Versions
116
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
117
+ Python <= 3.6
118
+
119
+ If you are using an `end-of-life`_
120
+ version of Python, we recommend that you update as soon as possible to an actively supported version.
121
+
122
+ .. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches
123
+
124
+ Mac/Linux
125
+ ^^^^^^^^^
126
+
127
+ .. code-block:: console
128
+
129
+ python3 -m venv <your-env>
130
+ source <your-env>/bin/activate
131
+ pip install google-ads-datamanager
132
+
133
+
134
+ Windows
135
+ ^^^^^^^
136
+
137
+ .. code-block:: console
138
+
139
+ py -m venv <your-env>
140
+ .\<your-env>\Scripts\activate
141
+ pip install google-ads-datamanager
142
+
143
+ Next Steps
144
+ ~~~~~~~~~~
145
+
146
+ - Read the `Client Library Documentation`_ for Data Manager API
147
+ to see other available methods on the client.
148
+ - Read the `Data Manager API Product documentation`_ to learn
149
+ more about the product and see How-to Guides.
150
+ - View this `README`_ to see the full list of Cloud
151
+ APIs that we cover.
152
+
153
+ .. _Data Manager API Product documentation: https://developers.google.com/data-manager
154
+ .. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
155
+
156
+ Logging
157
+ -------
158
+
159
+ This library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes.
160
+ Note the following:
161
+
162
+ #. Logs may contain sensitive information. Take care to **restrict access to the logs** if they are saved, whether it be on local storage or on Google Cloud Logging.
163
+ #. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking. **Do not depend on immutability of the logging events**.
164
+ #. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below.
165
+
166
+ Simple, environment-based configuration
167
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
168
+
169
+ To enable logging for this library without any changes in your code, set the :code:`GOOGLE_SDK_PYTHON_LOGGING_SCOPE` environment variable to a valid Google
170
+ logging scope. This configures handling of logging events (at level :code:`logging.DEBUG` or higher) from this library in a default manner, emitting the logged
171
+ messages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers, formatters, etc. used for any logging
172
+ event.
173
+
174
+ A logging scope is a period-separated namespace that begins with :code:`google`, identifying the Python module or package to log.
175
+
176
+ - Valid logging scopes: :code:`google`, :code:`google.cloud.asset.v1`, :code:`google.api`, :code:`google.auth`, etc.
177
+ - Invalid logging scopes: :code:`foo`, :code:`123`, etc.
178
+
179
+ **NOTE**: If the logging scope is invalid, the library does not set up any logging handlers.
180
+
181
+ Environment-Based Examples
182
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^
183
+
184
+ - Enabling the default handler for all Google-based loggers
185
+
186
+ .. code-block:: console
187
+
188
+ export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google
189
+
190
+ - Enabling the default handler for a specific Google module (for a client library called :code:`library_v1`):
191
+
192
+ .. code-block:: console
193
+
194
+ export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1
195
+
196
+
197
+ Advanced, code-based configuration
198
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
199
+
200
+ You can also configure a valid logging scope using Python's standard `logging` mechanism.
201
+
202
+ Code-Based Examples
203
+ ^^^^^^^^^^^^^^^^^^^
204
+
205
+ - Configuring a handler for all Google-based loggers
206
+
207
+ .. code-block:: python
208
+
209
+ import logging
210
+
211
+ from google.cloud import library_v1
212
+
213
+ base_logger = logging.getLogger("google")
214
+ base_logger.addHandler(logging.StreamHandler())
215
+ base_logger.setLevel(logging.DEBUG)
216
+
217
+ - Configuring a handler for a specific Google module (for a client library called :code:`library_v1`):
218
+
219
+ .. code-block:: python
220
+
221
+ import logging
222
+
223
+ from google.cloud import library_v1
224
+
225
+ base_logger = logging.getLogger("google.cloud.library_v1")
226
+ base_logger.addHandler(logging.StreamHandler())
227
+ base_logger.setLevel(logging.DEBUG)
228
+
229
+ Logging details
230
+ ~~~~~~~~~~~~~~~
231
+
232
+ #. Regardless of which of the mechanisms above you use to configure logging for this library, by default logging events are not propagated up to the root
233
+ logger from the `google`-level logger. If you need the events to be propagated to the root logger, you must explicitly set
234
+ :code:`logging.getLogger("google").propagate = True` in your code.
235
+ #. You can mix the different logging configurations above for different Google modules. For example, you may want use a code-based logging configuration for
236
+ one library, but decide you need to also set up environment-based logging configuration for another library.
237
+
238
+ #. If you attempt to use both code-based and environment-based configuration for the same module, the environment-based configuration will be ineffectual
239
+ if the code -based configuration gets applied first.
240
+
241
+ #. The Google-specific logging configurations (default handlers for environment-based configuration; not propagating logging events to the root logger) get
242
+ executed the first time *any* client library is instantiated in your application, and only if the affected loggers have not been previously configured.
243
+ (This is the reason for 2.i. above.)
@@ -0,0 +1,198 @@
1
+ Python Client for Data Manager API
2
+ ==================================
3
+
4
+ |preview| |pypi| |versions|
5
+
6
+ `Data Manager API`_: A unified ingestion API for data partners, agencies and advertisers to
7
+ connect first-party data across Google advertising products.
8
+
9
+ - `Client Library Documentation`_
10
+ - `Product Documentation`_
11
+
12
+ .. |preview| image:: https://img.shields.io/badge/support-preview-orange.svg
13
+ :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels
14
+ .. |pypi| image:: https://img.shields.io/pypi/v/google-ads-datamanager.svg
15
+ :target: https://pypi.org/project/google-ads-datamanager/
16
+ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-ads-datamanager.svg
17
+ :target: https://pypi.org/project/google-ads-datamanager/
18
+ .. _Data Manager API: https://developers.google.com/data-manager
19
+ .. _Client Library Documentation: https://cloud.google.com/python/docs/reference/google-ads-datamanager/latest
20
+ .. _Product Documentation: https://developers.google.com/data-manager
21
+
22
+ Quick Start
23
+ -----------
24
+
25
+ In order to use this library, you first need to go through the following steps:
26
+
27
+ 1. `Select or create a Cloud Platform project.`_
28
+ 2. `Enable billing for your project.`_
29
+ 3. `Enable the Data Manager API.`_
30
+ 4. `Set up Authentication.`_
31
+
32
+ .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
33
+ .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
34
+ .. _Enable the Data Manager API.: https://developers.google.com/data-manager
35
+ .. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
36
+
37
+ Installation
38
+ ~~~~~~~~~~~~
39
+
40
+ Install this library in a virtual environment using `venv`_. `venv`_ is a tool that
41
+ creates isolated Python environments. These isolated environments can have separate
42
+ versions of Python packages, which allows you to isolate one project's dependencies
43
+ from the dependencies of other projects.
44
+
45
+ With `venv`_, it's possible to install this library without needing system
46
+ install permissions, and without clashing with the installed system
47
+ dependencies.
48
+
49
+ .. _`venv`: https://docs.python.org/3/library/venv.html
50
+
51
+
52
+ Code samples and snippets
53
+ ~~~~~~~~~~~~~~~~~~~~~~~~~
54
+
55
+ Code samples and snippets live in the `samples/`_ folder.
56
+
57
+ .. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-ads-datamanager/samples
58
+
59
+
60
+ Supported Python Versions
61
+ ^^^^^^^^^^^^^^^^^^^^^^^^^
62
+ Our client libraries are compatible with all current `active`_ and `maintenance`_ versions of
63
+ Python.
64
+
65
+ Python >= 3.7, including 3.14
66
+
67
+ .. _active: https://devguide.python.org/devcycle/#in-development-main-branch
68
+ .. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches
69
+
70
+ Unsupported Python Versions
71
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
72
+ Python <= 3.6
73
+
74
+ If you are using an `end-of-life`_
75
+ version of Python, we recommend that you update as soon as possible to an actively supported version.
76
+
77
+ .. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches
78
+
79
+ Mac/Linux
80
+ ^^^^^^^^^
81
+
82
+ .. code-block:: console
83
+
84
+ python3 -m venv <your-env>
85
+ source <your-env>/bin/activate
86
+ pip install google-ads-datamanager
87
+
88
+
89
+ Windows
90
+ ^^^^^^^
91
+
92
+ .. code-block:: console
93
+
94
+ py -m venv <your-env>
95
+ .\<your-env>\Scripts\activate
96
+ pip install google-ads-datamanager
97
+
98
+ Next Steps
99
+ ~~~~~~~~~~
100
+
101
+ - Read the `Client Library Documentation`_ for Data Manager API
102
+ to see other available methods on the client.
103
+ - Read the `Data Manager API Product documentation`_ to learn
104
+ more about the product and see How-to Guides.
105
+ - View this `README`_ to see the full list of Cloud
106
+ APIs that we cover.
107
+
108
+ .. _Data Manager API Product documentation: https://developers.google.com/data-manager
109
+ .. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst
110
+
111
+ Logging
112
+ -------
113
+
114
+ This library uses the standard Python :code:`logging` functionality to log some RPC events that could be of interest for debugging and monitoring purposes.
115
+ Note the following:
116
+
117
+ #. Logs may contain sensitive information. Take care to **restrict access to the logs** if they are saved, whether it be on local storage or on Google Cloud Logging.
118
+ #. Google may refine the occurrence, level, and content of various log messages in this library without flagging such changes as breaking. **Do not depend on immutability of the logging events**.
119
+ #. By default, the logging events from this library are not handled. You must **explicitly configure log handling** using one of the mechanisms below.
120
+
121
+ Simple, environment-based configuration
122
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
123
+
124
+ To enable logging for this library without any changes in your code, set the :code:`GOOGLE_SDK_PYTHON_LOGGING_SCOPE` environment variable to a valid Google
125
+ logging scope. This configures handling of logging events (at level :code:`logging.DEBUG` or higher) from this library in a default manner, emitting the logged
126
+ messages in a structured format. It does not currently allow customizing the logging levels captured nor the handlers, formatters, etc. used for any logging
127
+ event.
128
+
129
+ A logging scope is a period-separated namespace that begins with :code:`google`, identifying the Python module or package to log.
130
+
131
+ - Valid logging scopes: :code:`google`, :code:`google.cloud.asset.v1`, :code:`google.api`, :code:`google.auth`, etc.
132
+ - Invalid logging scopes: :code:`foo`, :code:`123`, etc.
133
+
134
+ **NOTE**: If the logging scope is invalid, the library does not set up any logging handlers.
135
+
136
+ Environment-Based Examples
137
+ ^^^^^^^^^^^^^^^^^^^^^^^^^^
138
+
139
+ - Enabling the default handler for all Google-based loggers
140
+
141
+ .. code-block:: console
142
+
143
+ export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google
144
+
145
+ - Enabling the default handler for a specific Google module (for a client library called :code:`library_v1`):
146
+
147
+ .. code-block:: console
148
+
149
+ export GOOGLE_SDK_PYTHON_LOGGING_SCOPE=google.cloud.library_v1
150
+
151
+
152
+ Advanced, code-based configuration
153
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
154
+
155
+ You can also configure a valid logging scope using Python's standard `logging` mechanism.
156
+
157
+ Code-Based Examples
158
+ ^^^^^^^^^^^^^^^^^^^
159
+
160
+ - Configuring a handler for all Google-based loggers
161
+
162
+ .. code-block:: python
163
+
164
+ import logging
165
+
166
+ from google.cloud import library_v1
167
+
168
+ base_logger = logging.getLogger("google")
169
+ base_logger.addHandler(logging.StreamHandler())
170
+ base_logger.setLevel(logging.DEBUG)
171
+
172
+ - Configuring a handler for a specific Google module (for a client library called :code:`library_v1`):
173
+
174
+ .. code-block:: python
175
+
176
+ import logging
177
+
178
+ from google.cloud import library_v1
179
+
180
+ base_logger = logging.getLogger("google.cloud.library_v1")
181
+ base_logger.addHandler(logging.StreamHandler())
182
+ base_logger.setLevel(logging.DEBUG)
183
+
184
+ Logging details
185
+ ~~~~~~~~~~~~~~~
186
+
187
+ #. Regardless of which of the mechanisms above you use to configure logging for this library, by default logging events are not propagated up to the root
188
+ logger from the `google`-level logger. If you need the events to be propagated to the root logger, you must explicitly set
189
+ :code:`logging.getLogger("google").propagate = True` in your code.
190
+ #. You can mix the different logging configurations above for different Google modules. For example, you may want use a code-based logging configuration for
191
+ one library, but decide you need to also set up environment-based logging configuration for another library.
192
+
193
+ #. If you attempt to use both code-based and environment-based configuration for the same module, the environment-based configuration will be ineffectual
194
+ if the code -based configuration gets applied first.
195
+
196
+ #. The Google-specific logging configurations (default handlers for environment-based configuration; not propagating logging events to the root logger) get
197
+ executed the first time *any* client library is instantiated in your application, and only if the affected loggers have not been previously configured.
198
+ (This is the reason for 2.i. above.)