Skip to main content

Type stubs for google-ads

Project description

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 v.9.0.0 of this library. 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.

The stubs for protobuf messages were created by mypy-protobuf. The rest were created either by hand or by self-made scripts, with the output of MyPy's stubgen as a starting point.

If you find incorrect annotations, please create an issue. Contributions for fixes are also welcome.

Installation

$ pip install google-ads-stubs

Caveats

There are some caveats. The primary one is that type inference does not work for the get_type and get_service methods of Client. The workaround is to explicitly state the type. For get_type you can also instantiate the object directly.

# Replace this:
campaign_operation = client.get_type('CampaignOperation')
# With this:
from google.ads.google_ads.v3.types import CampaignOperation
campaign_operation: CampaignOperation = client.get_type('CampaignOperation')
# Or this:
from google.ads.google_ads.v3.types import CampaignOperation
campaign_operation = CampaignOperation()

# Replace this:
google_ads_service = client.get_service('GoogleAdsService')
# With this:
from google.ads.google_ads.v3.services import GoogleAdsServiceClient
google_ads_service: GoogleAdsServiceClient = client.get_service('GoogleAdsService')

While it is technically possible to type these methods 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, while simple to generate, slows type checking to a crawl.

This package does not provide complete type annotations, although it should cover what's used by most developers. The bare output from stubgen is used by the ransport classes. These may be typed in the future if there is a need for it.

Some service methods allow you to pass in either a protobuf message or a dictionary for certain arguments. There is no check that the dictionary conforms to the message structure, as this would require a TypedDict subclass for each message.

Note that if you're using Mypy you need to use the --namespace-packages option as google and google.ads are namespace packages.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

google-ads-stubs-7.0.0.tar.gz (1.1 MB view hashes)

Uploaded Source

Built Distribution

google_ads_stubs-7.0.0-py3-none-any.whl (3.4 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page