Skip to content

Latest commit

 

History

History
59 lines (44 loc) · 3.01 KB

README.md

File metadata and controls

59 lines (44 loc) · 3.01 KB
Raw

Type stubs for the Google Ads API Client Library for Python

PyPI version

This package provides type stubs for the Google Ads API Client Library for Python. It's currently compatible with v25.0.0 of this library (v17.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.v17 import CampaignOperation
campaign_operation: CampaignOperation = client.get_type('CampaignOperation')
# Or this:
from google.ads.googleads.v17 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.v17 import AdGroupAdStatusEnum, AdStrengtEnum, AdTypeEnum, Ad
AdGroupAd(
    status=AdGroupAdStatusEnum.AdGroupAdStatus.ENABLED, 
    ad=Ad(type=AdTypeEnum.AdType.TEXT_AD),
)