Type stubs for the Google Ads API Client Library for Python
This package provides type stubs for the Google Ads API Client Library for Python. It's currently compatible with v31.4.0 of this library (v25.1 of the API). It allows you to type check usage of the library with e.g. mypy and will also improve autocomplete in many editors.
This is in no way affiliated with Google.
Most stubs were created automatically by stubgen, the rest are handwritten or generated by self-made scripts.
If you find incorrect annotations, please create an issue. Contributions for fixes are also welcome.
Installation
$ pip install google-ads-stubs
The stubs should be automatically picked up by your editor or typechecker, but note that if you're using Mypy you need to use the --namespace-packages option as google and google.ads are namespace packages.
Caveats
The stubs assume the client is constructed with use_proto_plus=True. If you use use_proto_plus=False, they are unlikely to be of much use to you.
Type inference does not work for the get_type
method of GoogleAdsClient.The workaround is to explicitly state the type. You can also instantiate the object directly to get inference.
# Replace this:
campaign_operation = client.get_type('CampaignOperation')
# With this:
from google.ads.googleads.v25.services import CampaignOperation
campaign_operation: CampaignOperation = client.get_type('CampaignOperation')
# Or this:
from google.ads.googleads.v25.services import CampaignOperation
campaign_operation = CampaignOperation()
While it is technically possible to type this method using a combination of overloading and literal types, this is not included in these stubs. The reason is that it requires about 10,000 overloads, which makes most typecheckers fairly slow.
Certain parts of the stubs assume you are using the latest included API version. This includes GoogleAdsClient.enums and calls to GoogleAdsClient.get_type and GoogleAdsClient.get_service without specifying the version argument. If you use an older version, you should import enums directly and specify version in these calls even if you specified it when constructing the client.
Certain types are too lenient compared to what's allowed at runtime. The first argument to protobuf message constructors accepts any mapping. On the other hand certain types are more strict than what's allowed at runtime. You can't substitute a protobuf message for an equivalent dict or an enum with it's equivalent name or value.
# Replace this:
AdGroupAd({
"status": "ENABLED",
"ad": {"type": 2},
})
# With this:
from google.ads.googleads.v25.resources import Ad
from google.ads.googleads.v25.enums import AdGroupAdStatusEnum, AdTypeEnum
AdGroupAd(
status=AdGroupAdStatusEnum.AdGroupAdStatus.ENABLED,
ad=Ad(type=AdTypeEnum.AdType.TEXT_AD),
)
Development
You can run gen.sh to generate new stubs, but note that there are a few manual steps before and after mentioned in the script.
Feel free to use this to open a PR when new versions come out.
Contributions to automate the remaining manual steps are also welcome.
1 maintainer
Release files for google-ads-stubs 27.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| google_ads_stubs-27.1.0.tar.gz | 1.8 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| google_ads_stubs-27.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size:9.5 MB
Release files / google_ads_stubs-27.1.0.tar.gz
| Download URL | google_ads_stubs-27.1.0.tar.gz |
|---|---|
| Size | 1.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f5276abd835c95a91028b6f04c2dcf003c8d0d4dca5ffb86aed7862d401a1af9
|
|
BLAKE2b-256 checksum How to use checksums |
ef8ccb68ca6d011309b68cad8d92cc492d5869341b495a63f6b589dac9f5d1ec
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / google_ads_stubs-27.1.0-py3-none-any.whl
| Download URL | google_ads_stubs-27.1.0-py3-none-any.whl |
|---|---|
| Size | 7.7 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c2d8db2d0937d728aa2f89ff97c0971afbf24ff0810358e7c8cc2c7a84888467
|
|
BLAKE2b-256 checksum How to use checksums |
c724778470265f9dfaa4137c79cf1a1785050568545b906c6696a3b9e46bb30d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
