-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Expand file tree
/
Copy path__init__.py
More file actions
983 lines (972 loc) · 34.5 KB
/
__init__.py
File metadata and controls
983 lines (972 loc) · 34.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
# -*- coding: utf-8 -*-
# Copyright 2025 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
import sys
import google.api_core as api_core
from google.ads.admanager_v1 import gapic_version as package_version
__version__ = package_version.__version__
if sys.version_info >= (3, 8): # pragma: NO COVER
from importlib import metadata
else: # pragma: NO COVER
# TODO(https://github.com/googleapis/python-api-core/issues/835): Remove
# this code path once we drop support for Python 3.7
import importlib_metadata as metadata
from .services.ad_break_service import AdBreakServiceClient
from .services.ad_review_center_ad_service import AdReviewCenterAdServiceClient
from .services.ad_unit_service import AdUnitServiceClient
from .services.application_service import ApplicationServiceClient
from .services.audience_segment_service import AudienceSegmentServiceClient
from .services.bandwidth_group_service import BandwidthGroupServiceClient
from .services.browser_language_service import BrowserLanguageServiceClient
from .services.browser_service import BrowserServiceClient
from .services.cms_metadata_key_service import CmsMetadataKeyServiceClient
from .services.cms_metadata_value_service import CmsMetadataValueServiceClient
from .services.company_service import CompanyServiceClient
from .services.contact_service import ContactServiceClient
from .services.content_bundle_service import ContentBundleServiceClient
from .services.content_label_service import ContentLabelServiceClient
from .services.content_service import ContentServiceClient
from .services.creative_template_service import CreativeTemplateServiceClient
from .services.custom_field_service import CustomFieldServiceClient
from .services.custom_targeting_key_service import CustomTargetingKeyServiceClient
from .services.custom_targeting_value_service import CustomTargetingValueServiceClient
from .services.device_capability_service import DeviceCapabilityServiceClient
from .services.device_category_service import DeviceCategoryServiceClient
from .services.device_manufacturer_service import DeviceManufacturerServiceClient
from .services.entity_signals_mapping_service import EntitySignalsMappingServiceClient
from .services.geo_target_service import GeoTargetServiceClient
from .services.line_item_service import LineItemServiceClient
from .services.mobile_carrier_service import MobileCarrierServiceClient
from .services.mobile_device_service import MobileDeviceServiceClient
from .services.mobile_device_submodel_service import MobileDeviceSubmodelServiceClient
from .services.network_service import NetworkServiceClient
from .services.operating_system_service import OperatingSystemServiceClient
from .services.operating_system_version_service import (
OperatingSystemVersionServiceClient,
)
from .services.order_service import OrderServiceClient
from .services.placement_service import PlacementServiceClient
from .services.private_auction_deal_service import PrivateAuctionDealServiceClient
from .services.private_auction_service import PrivateAuctionServiceClient
from .services.programmatic_buyer_service import ProgrammaticBuyerServiceClient
from .services.report_service import ReportServiceClient
from .services.role_service import RoleServiceClient
from .services.site_service import SiteServiceClient
from .services.taxonomy_category_service import TaxonomyCategoryServiceClient
from .services.team_service import TeamServiceClient
from .services.user_service import UserServiceClient
from .types.ad_break_messages import AdBreak
from .types.ad_break_service import (
CreateAdBreakRequest,
DeleteAdBreakRequest,
GetAdBreakRequest,
ListAdBreaksRequest,
ListAdBreaksResponse,
UpdateAdBreakRequest,
)
from .types.ad_review_center_ad_enums import AdReviewCenterAdStatusEnum
from .types.ad_review_center_ad_messages import AdReviewCenterAd
from .types.ad_review_center_ad_service import (
BatchAdReviewCenterAdsOperationMetadata,
BatchAllowAdReviewCenterAdsRequest,
BatchAllowAdReviewCenterAdsResponse,
BatchBlockAdReviewCenterAdsRequest,
BatchBlockAdReviewCenterAdsResponse,
SearchAdReviewCenterAdsRequest,
SearchAdReviewCenterAdsResponse,
)
from .types.ad_unit_enums import AdUnitStatusEnum, SmartSizeModeEnum, TargetWindowEnum
from .types.ad_unit_messages import AdUnit, AdUnitParent, AdUnitSize, LabelFrequencyCap
from .types.ad_unit_service import (
BatchActivateAdUnitsRequest,
BatchActivateAdUnitsResponse,
BatchArchiveAdUnitsRequest,
BatchArchiveAdUnitsResponse,
BatchCreateAdUnitsRequest,
BatchCreateAdUnitsResponse,
BatchDeactivateAdUnitsRequest,
BatchDeactivateAdUnitsResponse,
BatchUpdateAdUnitsRequest,
BatchUpdateAdUnitsResponse,
CreateAdUnitRequest,
GetAdUnitRequest,
ListAdUnitSizesRequest,
ListAdUnitSizesResponse,
ListAdUnitsRequest,
ListAdUnitsResponse,
UpdateAdUnitRequest,
)
from .types.admanager_error import AdManagerError
from .types.application_messages import Application
from .types.application_service import (
GetApplicationRequest,
ListApplicationsRequest,
ListApplicationsResponse,
)
from .types.applied_label import AppliedLabel
from .types.audience_segment_messages import AudienceSegment
from .types.audience_segment_service import (
GetAudienceSegmentRequest,
ListAudienceSegmentsRequest,
ListAudienceSegmentsResponse,
)
from .types.bandwidth_group_messages import BandwidthGroup
from .types.bandwidth_group_service import (
GetBandwidthGroupRequest,
ListBandwidthGroupsRequest,
ListBandwidthGroupsResponse,
)
from .types.browser_language_messages import BrowserLanguage
from .types.browser_language_service import (
GetBrowserLanguageRequest,
ListBrowserLanguagesRequest,
ListBrowserLanguagesResponse,
)
from .types.browser_messages import Browser
from .types.browser_service import (
GetBrowserRequest,
ListBrowsersRequest,
ListBrowsersResponse,
)
from .types.cms_metadata_key_enums import CmsMetadataKeyStatusEnum
from .types.cms_metadata_key_messages import CmsMetadataKey
from .types.cms_metadata_key_service import (
GetCmsMetadataKeyRequest,
ListCmsMetadataKeysRequest,
ListCmsMetadataKeysResponse,
)
from .types.cms_metadata_value_enums import CmsMetadataValueStatusEnum
from .types.cms_metadata_value_messages import CmsMetadataValue
from .types.cms_metadata_value_service import (
GetCmsMetadataValueRequest,
ListCmsMetadataValuesRequest,
ListCmsMetadataValuesResponse,
)
from .types.company_enums import CompanyCreditStatusEnum, CompanyTypeEnum
from .types.company_messages import Company
from .types.company_service import (
GetCompanyRequest,
ListCompaniesRequest,
ListCompaniesResponse,
)
from .types.contact_enums import ContactStatusEnum
from .types.contact_messages import Contact
from .types.contact_service import (
BatchCreateContactsRequest,
BatchCreateContactsResponse,
BatchUpdateContactsRequest,
BatchUpdateContactsResponse,
CreateContactRequest,
GetContactRequest,
ListContactsRequest,
ListContactsResponse,
UpdateContactRequest,
)
from .types.content_bundle_messages import ContentBundle
from .types.content_bundle_service import (
GetContentBundleRequest,
ListContentBundlesRequest,
ListContentBundlesResponse,
)
from .types.content_label_messages import ContentLabel
from .types.content_label_service import (
GetContentLabelRequest,
ListContentLabelsRequest,
ListContentLabelsResponse,
)
from .types.content_messages import Content
from .types.content_service import (
GetContentRequest,
ListContentRequest,
ListContentResponse,
)
from .types.creative_template_enums import (
CreativeTemplateStatusEnum,
CreativeTemplateTypeEnum,
)
from .types.creative_template_messages import CreativeTemplate, CreativeTemplateVariable
from .types.creative_template_service import (
GetCreativeTemplateRequest,
ListCreativeTemplatesRequest,
ListCreativeTemplatesResponse,
)
from .types.creative_template_variable_url_type_enum import (
CreativeTemplateVariableUrlTypeEnum,
)
from .types.custom_field_enums import (
CustomFieldDataTypeEnum,
CustomFieldEntityTypeEnum,
CustomFieldStatusEnum,
CustomFieldVisibilityEnum,
)
from .types.custom_field_messages import CustomField, CustomFieldOption
from .types.custom_field_service import (
BatchActivateCustomFieldsRequest,
BatchActivateCustomFieldsResponse,
BatchCreateCustomFieldsRequest,
BatchCreateCustomFieldsResponse,
BatchDeactivateCustomFieldsRequest,
BatchDeactivateCustomFieldsResponse,
BatchUpdateCustomFieldsRequest,
BatchUpdateCustomFieldsResponse,
CreateCustomFieldRequest,
GetCustomFieldRequest,
ListCustomFieldsRequest,
ListCustomFieldsResponse,
UpdateCustomFieldRequest,
)
from .types.custom_field_value import CustomFieldValue
from .types.custom_targeting_key_enums import (
CustomTargetingKeyReportableTypeEnum,
CustomTargetingKeyStatusEnum,
CustomTargetingKeyTypeEnum,
)
from .types.custom_targeting_key_messages import CustomTargetingKey
from .types.custom_targeting_key_service import (
BatchActivateCustomTargetingKeysRequest,
BatchActivateCustomTargetingKeysResponse,
BatchCreateCustomTargetingKeysRequest,
BatchCreateCustomTargetingKeysResponse,
BatchDeactivateCustomTargetingKeysRequest,
BatchDeactivateCustomTargetingKeysResponse,
BatchUpdateCustomTargetingKeysRequest,
BatchUpdateCustomTargetingKeysResponse,
CreateCustomTargetingKeyRequest,
GetCustomTargetingKeyRequest,
ListCustomTargetingKeysRequest,
ListCustomTargetingKeysResponse,
UpdateCustomTargetingKeyRequest,
)
from .types.custom_targeting_value_enums import (
CustomTargetingValueMatchTypeEnum,
CustomTargetingValueStatusEnum,
)
from .types.custom_targeting_value_messages import CustomTargetingValue
from .types.custom_targeting_value_service import (
GetCustomTargetingValueRequest,
ListCustomTargetingValuesRequest,
ListCustomTargetingValuesResponse,
)
from .types.deal_buyer_permission_type_enum import DealBuyerPermissionTypeEnum
from .types.device_capability_messages import DeviceCapability
from .types.device_capability_service import (
GetDeviceCapabilityRequest,
ListDeviceCapabilitiesRequest,
ListDeviceCapabilitiesResponse,
)
from .types.device_category_messages import DeviceCategory
from .types.device_category_service import (
GetDeviceCategoryRequest,
ListDeviceCategoriesRequest,
ListDeviceCategoriesResponse,
)
from .types.device_manufacturer_messages import DeviceManufacturer
from .types.device_manufacturer_service import (
GetDeviceManufacturerRequest,
ListDeviceManufacturersRequest,
ListDeviceManufacturersResponse,
)
from .types.early_ad_break_notification_enums import AdBreakStateEnum
from .types.entity_signals_mapping_messages import EntitySignalsMapping
from .types.entity_signals_mapping_service import (
BatchCreateEntitySignalsMappingsRequest,
BatchCreateEntitySignalsMappingsResponse,
BatchUpdateEntitySignalsMappingsRequest,
BatchUpdateEntitySignalsMappingsResponse,
CreateEntitySignalsMappingRequest,
GetEntitySignalsMappingRequest,
ListEntitySignalsMappingsRequest,
ListEntitySignalsMappingsResponse,
UpdateEntitySignalsMappingRequest,
)
from .types.environment_type_enum import EnvironmentTypeEnum
from .types.exchange_syndication_product_enum import ExchangeSyndicationProductEnum
from .types.frequency_cap import FrequencyCap
from .types.geo_target_messages import GeoTarget
from .types.geo_target_service import (
GetGeoTargetRequest,
ListGeoTargetsRequest,
ListGeoTargetsResponse,
)
from .types.goal import Goal
from .types.goal_enums import GoalTypeEnum, UnitTypeEnum
from .types.label_messages import Label
from .types.line_item_enums import LineItemTypeEnum
from .types.line_item_messages import LineItem
from .types.line_item_service import (
GetLineItemRequest,
ListLineItemsRequest,
ListLineItemsResponse,
)
from .types.live_stream_event_messages import LiveStreamEvent
from .types.mobile_carrier_messages import MobileCarrier
from .types.mobile_carrier_service import (
GetMobileCarrierRequest,
ListMobileCarriersRequest,
ListMobileCarriersResponse,
)
from .types.mobile_device_messages import MobileDevice
from .types.mobile_device_service import (
GetMobileDeviceRequest,
ListMobileDevicesRequest,
ListMobileDevicesResponse,
)
from .types.mobile_device_submodel_messages import MobileDeviceSubmodel
from .types.mobile_device_submodel_service import (
GetMobileDeviceSubmodelRequest,
ListMobileDeviceSubmodelsRequest,
ListMobileDeviceSubmodelsResponse,
)
from .types.network_messages import Network
from .types.network_service import (
GetNetworkRequest,
ListNetworksRequest,
ListNetworksResponse,
)
from .types.operating_system_messages import OperatingSystem
from .types.operating_system_service import (
GetOperatingSystemRequest,
ListOperatingSystemsRequest,
ListOperatingSystemsResponse,
)
from .types.operating_system_version_messages import OperatingSystemVersion
from .types.operating_system_version_service import (
GetOperatingSystemVersionRequest,
ListOperatingSystemVersionsRequest,
ListOperatingSystemVersionsResponse,
)
from .types.order_enums import OrderStatusEnum
from .types.order_messages import Order
from .types.order_service import GetOrderRequest, ListOrdersRequest, ListOrdersResponse
from .types.placement_enums import PlacementStatusEnum
from .types.placement_messages import Placement
from .types.placement_service import (
BatchActivatePlacementsRequest,
BatchActivatePlacementsResponse,
BatchArchivePlacementsRequest,
BatchArchivePlacementsResponse,
BatchCreatePlacementsRequest,
BatchCreatePlacementsResponse,
BatchDeactivatePlacementsRequest,
BatchDeactivatePlacementsResponse,
BatchUpdatePlacementsRequest,
BatchUpdatePlacementsResponse,
CreatePlacementRequest,
GetPlacementRequest,
ListPlacementsRequest,
ListPlacementsResponse,
UpdatePlacementRequest,
)
from .types.private_auction_deal_messages import PrivateAuctionDeal
from .types.private_auction_deal_service import (
CreatePrivateAuctionDealRequest,
GetPrivateAuctionDealRequest,
ListPrivateAuctionDealsRequest,
ListPrivateAuctionDealsResponse,
UpdatePrivateAuctionDealRequest,
)
from .types.private_auction_messages import PrivateAuction
from .types.private_auction_service import (
CreatePrivateAuctionRequest,
GetPrivateAuctionRequest,
ListPrivateAuctionsRequest,
ListPrivateAuctionsResponse,
UpdatePrivateAuctionRequest,
)
from .types.private_marketplace_enums import PrivateMarketplaceDealStatusEnum
from .types.programmatic_buyer_messages import ProgrammaticBuyer
from .types.programmatic_buyer_service import (
GetProgrammaticBuyerRequest,
ListProgrammaticBuyersRequest,
ListProgrammaticBuyersResponse,
)
from .types.report_definition import ReportDefinition
from .types.report_messages import Report, ReportDataTable, ScheduleOptions
from .types.report_service import (
CreateReportRequest,
FetchReportResultRowsRequest,
FetchReportResultRowsResponse,
GetReportRequest,
ListReportsRequest,
ListReportsResponse,
RunReportMetadata,
RunReportRequest,
RunReportResponse,
UpdateReportRequest,
)
from .types.report_value import ReportValue
from .types.request_platform_enum import RequestPlatformEnum
from .types.role_enums import RoleStatusEnum
from .types.role_messages import Role
from .types.role_service import GetRoleRequest, ListRolesRequest, ListRolesResponse
from .types.site_enums import SiteApprovalStatusEnum, SiteDisapprovalReasonEnum
from .types.site_messages import DisapprovalReason, Site
from .types.site_service import (
BatchCreateSitesRequest,
BatchCreateSitesResponse,
BatchDeactivateSitesRequest,
BatchDeactivateSitesResponse,
BatchSubmitSitesForApprovalRequest,
BatchSubmitSitesForApprovalResponse,
BatchUpdateSitesRequest,
BatchUpdateSitesResponse,
CreateSiteRequest,
GetSiteRequest,
ListSitesRequest,
ListSitesResponse,
UpdateSiteRequest,
)
from .types.size import Size
from .types.size_type_enum import SizeTypeEnum
from .types.targeted_video_bumper_type_enum import TargetedVideoBumperTypeEnum
from .types.targeting import (
AdUnitTargeting,
AudienceSegmentTargeting,
BandwidthTargeting,
BrowserLanguageTargeting,
BrowserTargeting,
CmsMetadataTargeting,
ContentTargeting,
CustomTargeting,
CustomTargetingClause,
CustomTargetingLiteral,
DataSegmentTargeting,
DeviceCapabilityTargeting,
DeviceCategoryTargeting,
DeviceManufacturerTargeting,
FirstPartyMobileApplicationTargeting,
GeoTargeting,
InventoryTargeting,
MobileApplicationTargeting,
MobileCarrierTargeting,
OperatingSystemTargeting,
RequestPlatformTargeting,
Targeting,
TechnologyTargeting,
UserDomainTargeting,
VideoPosition,
VideoPositionTargeting,
)
from .types.taxonomy_category_messages import TaxonomyCategory
from .types.taxonomy_category_service import (
GetTaxonomyCategoryRequest,
ListTaxonomyCategoriesRequest,
ListTaxonomyCategoriesResponse,
)
from .types.taxonomy_type_enum import TaxonomyTypeEnum
from .types.team_enums import TeamAccessTypeEnum, TeamStatusEnum
from .types.team_messages import Team
from .types.team_service import (
BatchActivateTeamsRequest,
BatchActivateTeamsResponse,
BatchCreateTeamsRequest,
BatchCreateTeamsResponse,
BatchDeactivateTeamsRequest,
BatchDeactivateTeamsResponse,
BatchUpdateTeamsRequest,
BatchUpdateTeamsResponse,
CreateTeamRequest,
GetTeamRequest,
ListTeamsRequest,
ListTeamsResponse,
UpdateTeamRequest,
)
from .types.time_unit_enum import TimeUnitEnum
from .types.user_messages import User
from .types.user_service import GetUserRequest
from .types.video_position_enum import VideoPositionEnum
from .types.web_property import WebProperty
if hasattr(api_core, "check_python_version") and hasattr(
api_core, "check_dependency_versions"
): # pragma: NO COVER
api_core.check_python_version("google.ads.admanager_v1") # type: ignore
api_core.check_dependency_versions("google.ads.admanager_v1") # type: ignore
else: # pragma: NO COVER
# An older version of api_core is installed which does not define the
# functions above. We do equivalent checks manually.
try:
import sys
import warnings
_py_version_str = sys.version.split()[0]
_package_label = "google.ads.admanager_v1"
if sys.version_info < (3, 9):
warnings.warn(
"You are using a non-supported Python version "
+ f"({_py_version_str}). Google will not post any further "
+ f"updates to {_package_label} supporting this Python version. "
+ "Please upgrade to the latest Python version, or at "
+ f"least to Python 3.9, and then update {_package_label}.",
FutureWarning,
)
if sys.version_info[:2] == (3, 9):
warnings.warn(
f"You are using a Python version ({_py_version_str}) "
+ f"which Google will stop supporting in {_package_label} in "
+ "January 2026. Please "
+ "upgrade to the latest Python version, or at "
+ "least to Python 3.10, before then, and "
+ f"then update {_package_label}.",
FutureWarning,
)
def parse_version_to_tuple(version_string: str):
"""Safely converts a semantic version string to a comparable tuple of integers.
Example: "4.25.8" -> (4, 25, 8)
Ignores non-numeric parts and handles common version formats.
Args:
version_string: Version string in the format "x.y.z" or "x.y.z<suffix>"
Returns:
Tuple of integers for the parsed version string.
"""
parts = []
for part in version_string.split("."):
try:
parts.append(int(part))
except ValueError:
# If it's a non-numeric part (e.g., '1.0.0b1' -> 'b1'), stop here.
# This is a simplification compared to 'packaging.parse_version', but sufficient
# for comparing strictly numeric semantic versions.
break
return tuple(parts)
def _get_version(dependency_name):
try:
version_string: str = metadata.version(dependency_name)
parsed_version = parse_version_to_tuple(version_string)
return (parsed_version, version_string)
except Exception:
# Catch exceptions from metadata.version() (e.g., PackageNotFoundError)
# or errors during parse_version_to_tuple
return (None, "--")
_dependency_package = "google.protobuf"
_next_supported_version = "4.25.8"
_next_supported_version_tuple = (4, 25, 8)
_recommendation = " (we recommend 6.x)"
(_version_used, _version_used_string) = _get_version(_dependency_package)
if _version_used and _version_used < _next_supported_version_tuple:
warnings.warn(
f"Package {_package_label} depends on "
+ f"{_dependency_package}, currently installed at version "
+ f"{_version_used_string}. Future updates to "
+ f"{_package_label} will require {_dependency_package} at "
+ f"version {_next_supported_version} or higher{_recommendation}."
+ " Please ensure "
+ "that either (a) your Python environment doesn't pin the "
+ f"version of {_dependency_package}, so that updates to "
+ f"{_package_label} can require the higher version, or "
+ "(b) you manually update your Python environment to use at "
+ f"least version {_next_supported_version} of "
+ f"{_dependency_package}.",
FutureWarning,
)
except Exception:
warnings.warn(
"Could not determine the version of Python "
+ "currently being used. To continue receiving "
+ "updates for {_package_label}, ensure you are "
+ "using a supported version of Python; see "
+ "https://devguide.python.org/versions/"
)
__all__ = (
"AdBreak",
"AdBreakServiceClient",
"AdBreakStateEnum",
"AdManagerError",
"AdReviewCenterAd",
"AdReviewCenterAdServiceClient",
"AdReviewCenterAdStatusEnum",
"AdUnit",
"AdUnitParent",
"AdUnitServiceClient",
"AdUnitSize",
"AdUnitStatusEnum",
"AdUnitTargeting",
"Application",
"ApplicationServiceClient",
"AppliedLabel",
"AudienceSegment",
"AudienceSegmentServiceClient",
"AudienceSegmentTargeting",
"BandwidthGroup",
"BandwidthGroupServiceClient",
"BandwidthTargeting",
"BatchActivateAdUnitsRequest",
"BatchActivateAdUnitsResponse",
"BatchActivateCustomFieldsRequest",
"BatchActivateCustomFieldsResponse",
"BatchActivateCustomTargetingKeysRequest",
"BatchActivateCustomTargetingKeysResponse",
"BatchActivatePlacementsRequest",
"BatchActivatePlacementsResponse",
"BatchActivateTeamsRequest",
"BatchActivateTeamsResponse",
"BatchAdReviewCenterAdsOperationMetadata",
"BatchAllowAdReviewCenterAdsRequest",
"BatchAllowAdReviewCenterAdsResponse",
"BatchArchiveAdUnitsRequest",
"BatchArchiveAdUnitsResponse",
"BatchArchivePlacementsRequest",
"BatchArchivePlacementsResponse",
"BatchBlockAdReviewCenterAdsRequest",
"BatchBlockAdReviewCenterAdsResponse",
"BatchCreateAdUnitsRequest",
"BatchCreateAdUnitsResponse",
"BatchCreateContactsRequest",
"BatchCreateContactsResponse",
"BatchCreateCustomFieldsRequest",
"BatchCreateCustomFieldsResponse",
"BatchCreateCustomTargetingKeysRequest",
"BatchCreateCustomTargetingKeysResponse",
"BatchCreateEntitySignalsMappingsRequest",
"BatchCreateEntitySignalsMappingsResponse",
"BatchCreatePlacementsRequest",
"BatchCreatePlacementsResponse",
"BatchCreateSitesRequest",
"BatchCreateSitesResponse",
"BatchCreateTeamsRequest",
"BatchCreateTeamsResponse",
"BatchDeactivateAdUnitsRequest",
"BatchDeactivateAdUnitsResponse",
"BatchDeactivateCustomFieldsRequest",
"BatchDeactivateCustomFieldsResponse",
"BatchDeactivateCustomTargetingKeysRequest",
"BatchDeactivateCustomTargetingKeysResponse",
"BatchDeactivatePlacementsRequest",
"BatchDeactivatePlacementsResponse",
"BatchDeactivateSitesRequest",
"BatchDeactivateSitesResponse",
"BatchDeactivateTeamsRequest",
"BatchDeactivateTeamsResponse",
"BatchSubmitSitesForApprovalRequest",
"BatchSubmitSitesForApprovalResponse",
"BatchUpdateAdUnitsRequest",
"BatchUpdateAdUnitsResponse",
"BatchUpdateContactsRequest",
"BatchUpdateContactsResponse",
"BatchUpdateCustomFieldsRequest",
"BatchUpdateCustomFieldsResponse",
"BatchUpdateCustomTargetingKeysRequest",
"BatchUpdateCustomTargetingKeysResponse",
"BatchUpdateEntitySignalsMappingsRequest",
"BatchUpdateEntitySignalsMappingsResponse",
"BatchUpdatePlacementsRequest",
"BatchUpdatePlacementsResponse",
"BatchUpdateSitesRequest",
"BatchUpdateSitesResponse",
"BatchUpdateTeamsRequest",
"BatchUpdateTeamsResponse",
"Browser",
"BrowserLanguage",
"BrowserLanguageServiceClient",
"BrowserLanguageTargeting",
"BrowserServiceClient",
"BrowserTargeting",
"CmsMetadataKey",
"CmsMetadataKeyServiceClient",
"CmsMetadataKeyStatusEnum",
"CmsMetadataTargeting",
"CmsMetadataValue",
"CmsMetadataValueServiceClient",
"CmsMetadataValueStatusEnum",
"Company",
"CompanyCreditStatusEnum",
"CompanyServiceClient",
"CompanyTypeEnum",
"Contact",
"ContactServiceClient",
"ContactStatusEnum",
"Content",
"ContentBundle",
"ContentBundleServiceClient",
"ContentLabel",
"ContentLabelServiceClient",
"ContentServiceClient",
"ContentTargeting",
"CreateAdBreakRequest",
"CreateAdUnitRequest",
"CreateContactRequest",
"CreateCustomFieldRequest",
"CreateCustomTargetingKeyRequest",
"CreateEntitySignalsMappingRequest",
"CreatePlacementRequest",
"CreatePrivateAuctionDealRequest",
"CreatePrivateAuctionRequest",
"CreateReportRequest",
"CreateSiteRequest",
"CreateTeamRequest",
"CreativeTemplate",
"CreativeTemplateServiceClient",
"CreativeTemplateStatusEnum",
"CreativeTemplateTypeEnum",
"CreativeTemplateVariable",
"CreativeTemplateVariableUrlTypeEnum",
"CustomField",
"CustomFieldDataTypeEnum",
"CustomFieldEntityTypeEnum",
"CustomFieldOption",
"CustomFieldServiceClient",
"CustomFieldStatusEnum",
"CustomFieldValue",
"CustomFieldVisibilityEnum",
"CustomTargeting",
"CustomTargetingClause",
"CustomTargetingKey",
"CustomTargetingKeyReportableTypeEnum",
"CustomTargetingKeyServiceClient",
"CustomTargetingKeyStatusEnum",
"CustomTargetingKeyTypeEnum",
"CustomTargetingLiteral",
"CustomTargetingValue",
"CustomTargetingValueMatchTypeEnum",
"CustomTargetingValueServiceClient",
"CustomTargetingValueStatusEnum",
"DataSegmentTargeting",
"DealBuyerPermissionTypeEnum",
"DeleteAdBreakRequest",
"DeviceCapability",
"DeviceCapabilityServiceClient",
"DeviceCapabilityTargeting",
"DeviceCategory",
"DeviceCategoryServiceClient",
"DeviceCategoryTargeting",
"DeviceManufacturer",
"DeviceManufacturerServiceClient",
"DeviceManufacturerTargeting",
"DisapprovalReason",
"EntitySignalsMapping",
"EntitySignalsMappingServiceClient",
"EnvironmentTypeEnum",
"ExchangeSyndicationProductEnum",
"FetchReportResultRowsRequest",
"FetchReportResultRowsResponse",
"FirstPartyMobileApplicationTargeting",
"FrequencyCap",
"GeoTarget",
"GeoTargetServiceClient",
"GeoTargeting",
"GetAdBreakRequest",
"GetAdUnitRequest",
"GetApplicationRequest",
"GetAudienceSegmentRequest",
"GetBandwidthGroupRequest",
"GetBrowserLanguageRequest",
"GetBrowserRequest",
"GetCmsMetadataKeyRequest",
"GetCmsMetadataValueRequest",
"GetCompanyRequest",
"GetContactRequest",
"GetContentBundleRequest",
"GetContentLabelRequest",
"GetContentRequest",
"GetCreativeTemplateRequest",
"GetCustomFieldRequest",
"GetCustomTargetingKeyRequest",
"GetCustomTargetingValueRequest",
"GetDeviceCapabilityRequest",
"GetDeviceCategoryRequest",
"GetDeviceManufacturerRequest",
"GetEntitySignalsMappingRequest",
"GetGeoTargetRequest",
"GetLineItemRequest",
"GetMobileCarrierRequest",
"GetMobileDeviceRequest",
"GetMobileDeviceSubmodelRequest",
"GetNetworkRequest",
"GetOperatingSystemRequest",
"GetOperatingSystemVersionRequest",
"GetOrderRequest",
"GetPlacementRequest",
"GetPrivateAuctionDealRequest",
"GetPrivateAuctionRequest",
"GetProgrammaticBuyerRequest",
"GetReportRequest",
"GetRoleRequest",
"GetSiteRequest",
"GetTaxonomyCategoryRequest",
"GetTeamRequest",
"GetUserRequest",
"Goal",
"GoalTypeEnum",
"InventoryTargeting",
"Label",
"LabelFrequencyCap",
"LineItem",
"LineItemServiceClient",
"LineItemTypeEnum",
"ListAdBreaksRequest",
"ListAdBreaksResponse",
"ListAdUnitSizesRequest",
"ListAdUnitSizesResponse",
"ListAdUnitsRequest",
"ListAdUnitsResponse",
"ListApplicationsRequest",
"ListApplicationsResponse",
"ListAudienceSegmentsRequest",
"ListAudienceSegmentsResponse",
"ListBandwidthGroupsRequest",
"ListBandwidthGroupsResponse",
"ListBrowserLanguagesRequest",
"ListBrowserLanguagesResponse",
"ListBrowsersRequest",
"ListBrowsersResponse",
"ListCmsMetadataKeysRequest",
"ListCmsMetadataKeysResponse",
"ListCmsMetadataValuesRequest",
"ListCmsMetadataValuesResponse",
"ListCompaniesRequest",
"ListCompaniesResponse",
"ListContactsRequest",
"ListContactsResponse",
"ListContentBundlesRequest",
"ListContentBundlesResponse",
"ListContentLabelsRequest",
"ListContentLabelsResponse",
"ListContentRequest",
"ListContentResponse",
"ListCreativeTemplatesRequest",
"ListCreativeTemplatesResponse",
"ListCustomFieldsRequest",
"ListCustomFieldsResponse",
"ListCustomTargetingKeysRequest",
"ListCustomTargetingKeysResponse",
"ListCustomTargetingValuesRequest",
"ListCustomTargetingValuesResponse",
"ListDeviceCapabilitiesRequest",
"ListDeviceCapabilitiesResponse",
"ListDeviceCategoriesRequest",
"ListDeviceCategoriesResponse",
"ListDeviceManufacturersRequest",
"ListDeviceManufacturersResponse",
"ListEntitySignalsMappingsRequest",
"ListEntitySignalsMappingsResponse",
"ListGeoTargetsRequest",
"ListGeoTargetsResponse",
"ListLineItemsRequest",
"ListLineItemsResponse",
"ListMobileCarriersRequest",
"ListMobileCarriersResponse",
"ListMobileDeviceSubmodelsRequest",
"ListMobileDeviceSubmodelsResponse",
"ListMobileDevicesRequest",
"ListMobileDevicesResponse",
"ListNetworksRequest",
"ListNetworksResponse",
"ListOperatingSystemVersionsRequest",
"ListOperatingSystemVersionsResponse",
"ListOperatingSystemsRequest",
"ListOperatingSystemsResponse",
"ListOrdersRequest",
"ListOrdersResponse",
"ListPlacementsRequest",
"ListPlacementsResponse",
"ListPrivateAuctionDealsRequest",
"ListPrivateAuctionDealsResponse",
"ListPrivateAuctionsRequest",
"ListPrivateAuctionsResponse",
"ListProgrammaticBuyersRequest",
"ListProgrammaticBuyersResponse",
"ListReportsRequest",
"ListReportsResponse",
"ListRolesRequest",
"ListRolesResponse",
"ListSitesRequest",
"ListSitesResponse",
"ListTaxonomyCategoriesRequest",
"ListTaxonomyCategoriesResponse",
"ListTeamsRequest",
"ListTeamsResponse",
"LiveStreamEvent",
"MobileApplicationTargeting",
"MobileCarrier",
"MobileCarrierServiceClient",
"MobileCarrierTargeting",
"MobileDevice",
"MobileDeviceServiceClient",
"MobileDeviceSubmodel",
"MobileDeviceSubmodelServiceClient",
"Network",
"NetworkServiceClient",
"OperatingSystem",
"OperatingSystemServiceClient",
"OperatingSystemTargeting",
"OperatingSystemVersion",
"OperatingSystemVersionServiceClient",
"Order",
"OrderServiceClient",
"OrderStatusEnum",
"Placement",
"PlacementServiceClient",
"PlacementStatusEnum",
"PrivateAuction",
"PrivateAuctionDeal",
"PrivateAuctionDealServiceClient",
"PrivateAuctionServiceClient",
"PrivateMarketplaceDealStatusEnum",
"ProgrammaticBuyer",
"ProgrammaticBuyerServiceClient",
"Report",
"ReportDataTable",
"ReportDefinition",
"ReportServiceClient",
"ReportValue",
"RequestPlatformEnum",
"RequestPlatformTargeting",
"Role",
"RoleServiceClient",
"RoleStatusEnum",
"RunReportMetadata",
"RunReportRequest",
"RunReportResponse",
"ScheduleOptions",
"SearchAdReviewCenterAdsRequest",
"SearchAdReviewCenterAdsResponse",
"Site",
"SiteApprovalStatusEnum",
"SiteDisapprovalReasonEnum",
"SiteServiceClient",
"Size",
"SizeTypeEnum",
"SmartSizeModeEnum",
"TargetWindowEnum",
"TargetedVideoBumperTypeEnum",
"Targeting",
"TaxonomyCategory",
"TaxonomyCategoryServiceClient",
"TaxonomyTypeEnum",
"Team",
"TeamAccessTypeEnum",
"TeamServiceClient",
"TeamStatusEnum",
"TechnologyTargeting",
"TimeUnitEnum",
"UnitTypeEnum",
"UpdateAdBreakRequest",
"UpdateAdUnitRequest",
"UpdateContactRequest",
"UpdateCustomFieldRequest",
"UpdateCustomTargetingKeyRequest",
"UpdateEntitySignalsMappingRequest",
"UpdatePlacementRequest",
"UpdatePrivateAuctionDealRequest",
"UpdatePrivateAuctionRequest",
"UpdateReportRequest",
"UpdateSiteRequest",
"UpdateTeamRequest",
"User",
"UserDomainTargeting",
"UserServiceClient",
"VideoPosition",
"VideoPositionEnum",
"VideoPositionTargeting",
"WebProperty",
)