google-ads-googleads 2.1.1 → 2.2.0

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 (60) hide show
  1. checksums.yaml +4 -4
  2. data/ChangeLog +2 -0
  3. data/lib/google/ads/google_ads/factories/v1/enums.rb +72 -0
  4. data/lib/google/ads/google_ads/factories/v1/operations.rb +125 -0
  5. data/lib/google/ads/google_ads/factories/v1/resources.rb +190 -86
  6. data/lib/google/ads/google_ads/factories/v1/services.rb +72 -0
  7. data/lib/google/ads/google_ads/google_ads_client.rb +12 -5
  8. data/lib/google/ads/google_ads/lookup_util.rb +1 -1
  9. data/lib/google/ads/google_ads/utils/v1/path_lookup_util.rb +14 -0
  10. data/lib/google/ads/google_ads/utils/v1/proto_lookup_util.rb +13 -0
  11. data/lib/google/ads/google_ads/v1/common/ad_type_infos_pb.rb +4 -0
  12. data/lib/google/ads/google_ads/v1/common/segments_pb.rb +4 -0
  13. data/lib/google/ads/google_ads/v1/common/simulation_pb.rb +16 -0
  14. data/lib/google/ads/google_ads/v1/enums/ad_group_type_pb.rb +1 -0
  15. data/lib/google/ads/google_ads/v1/enums/ad_type_pb.rb +1 -0
  16. data/lib/google/ads/google_ads/v1/enums/advertising_channel_sub_type_pb.rb +1 -0
  17. data/lib/google/ads/google_ads/v1/enums/bidding_strategy_type_pb.rb +1 -0
  18. data/lib/google/ads/google_ads/v1/enums/campaign_criterion_status_pb.rb +22 -0
  19. data/lib/google/ads/google_ads/v1/enums/campaign_draft_status_pb.rb +24 -0
  20. data/lib/google/ads/google_ads/v1/enums/campaign_experiment_status_pb.rb +28 -0
  21. data/lib/google/ads/google_ads/v1/enums/campaign_experiment_traffic_split_type_pb.rb +21 -0
  22. data/lib/google/ads/google_ads/v1/enums/click_type_pb.rb +1 -0
  23. data/lib/google/ads/google_ads/v1/enums/device_pb.rb +1 -0
  24. data/lib/google/ads/google_ads/v1/enums/google_ads_field_data_type_pb.rb +1 -0
  25. data/lib/google/ads/google_ads/v1/enums/hotel_rate_type_pb.rb +23 -0
  26. data/lib/google/ads/google_ads/v1/errors/bidding_error_pb.rb +1 -0
  27. data/lib/google/ads/google_ads/v1/errors/campaign_draft_error_pb.rb +29 -0
  28. data/lib/google/ads/google_ads/v1/errors/campaign_error_pb.rb +2 -0
  29. data/lib/google/ads/google_ads/v1/errors/campaign_experiment_error_pb.rb +29 -0
  30. data/lib/google/ads/google_ads/v1/errors/errors_pb.rb +8 -0
  31. data/lib/google/ads/google_ads/v1/errors/feed_error_pb.rb +1 -0
  32. data/lib/google/ads/google_ads/v1/errors/manager_link_error_pb.rb +33 -0
  33. data/lib/google/ads/google_ads/v1/errors/not_whitelisted_error_pb.rb +20 -0
  34. data/lib/google/ads/google_ads/v1/errors/url_field_error_pb.rb +1 -0
  35. data/lib/google/ads/google_ads/v1/resources/ad_group_pb.rb +1 -0
  36. data/lib/google/ads/google_ads/v1/resources/ad_group_simulation_pb.rb +1 -0
  37. data/lib/google/ads/google_ads/v1/resources/ad_pb.rb +1 -0
  38. data/lib/google/ads/google_ads/v1/resources/campaign_criterion_pb.rb +2 -0
  39. data/lib/google/ads/google_ads/v1/resources/campaign_draft_pb.rb +24 -0
  40. data/lib/google/ads/google_ads/v1/resources/campaign_experiment_pb.rb +29 -0
  41. data/lib/google/ads/google_ads/v1/resources/campaign_pb.rb +21 -20
  42. data/lib/google/ads/google_ads/v1/resources/extension_feed_item_pb.rb +5 -0
  43. data/lib/google/ads/google_ads/v1/resources/recommendation_pb.rb +21 -21
  44. data/lib/google/ads/google_ads/v1/services/asset_service_client.rb +3 -1
  45. data/lib/google/ads/google_ads/v1/services/asset_service_services_pb.rb +3 -1
  46. data/lib/google/ads/google_ads/v1/services/campaign_draft_service_client.rb +439 -0
  47. data/lib/google/ads/google_ads/v1/services/campaign_draft_service_client_config.json +46 -0
  48. data/lib/google/ads/google_ads/v1/services/campaign_draft_service_pb.rb +60 -0
  49. data/lib/google/ads/google_ads/v1/services/campaign_draft_service_services_pb.rb +59 -0
  50. data/lib/google/ads/google_ads/v1/services/campaign_experiment_service_client.rb +616 -0
  51. data/lib/google/ads/google_ads/v1/services/campaign_experiment_service_client_config.json +61 -0
  52. data/lib/google/ads/google_ads/v1/services/campaign_experiment_service_pb.rb +83 -0
  53. data/lib/google/ads/google_ads/v1/services/campaign_experiment_service_services_pb.rb +82 -0
  54. data/lib/google/ads/google_ads/v1/services/conversion_adjustment_upload_service_client.rb +6 -1
  55. data/lib/google/ads/google_ads/v1/services/conversion_adjustment_upload_service_pb.rb +1 -0
  56. data/lib/google/ads/google_ads/v1/services/conversion_upload_service_client.rb +12 -2
  57. data/lib/google/ads/google_ads/v1/services/conversion_upload_service_pb.rb +2 -0
  58. data/lib/google/ads/google_ads/v1/services/google_ads_service_pb.rb +10 -0
  59. data/lib/google/ads/google_ads/version.rb +1 -1
  60. metadata +21 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 164db641c982021a9c51f5b3bf9e18a65f8e7b973338bd392b003d00f5235cc7
4
- data.tar.gz: f84eeceb7819e6751d8b897eb92423bf9145df1118971033a7794d687690f199
3
+ metadata.gz: 4f66a636784daa5beeae7a3782c2b31b704e3ce520536c34f9840cb8096caf39
4
+ data.tar.gz: bf5149b98724cd03c6e336341743dfccb5e8853045e6c356bb540155d193b4ad
5
5
  SHA512:
6
- metadata.gz: 9896edaac0beb4a622c4d1c7df3df42ad58767770772b8365afa275f045667d5ae0f5c808f3248077560386e966bad0ee9bd58281b1e5af41079d2cc2ccae5e0
7
- data.tar.gz: e26923a7bc61d68228b1de9ab79d679c50c8e4ed97d9b80bda4eb3eeebe41eb0620f2ca833a63eb96a77961e0fac6e14ac6569512a37b5192921511a2b2ce839
6
+ metadata.gz: db80064d0a7ddd095e5fe9960547848285276fe01cc4d7d9c69eb2ae2c961a63cff3ea465cd84f0e4930493ec232550641cc82ceeb220fcaf2971a3920eaafcd
7
+ data.tar.gz: 77245ff7fb4efbaed9b6d34e5fcbe991a571d607a9e83d94a1f4bb73bc2c3552da1a088a3cc7838cad1c84a8bd63f13fc8e67031735f62a6755732f84e7e5897
data/ChangeLog CHANGED
@@ -1,3 +1,5 @@
1
+ 2.2.0:
2
+ - Adding support for Google Ads API v1_3.
1
3
  2.1.1:
2
4
  - Fix "factories" implementation for Google's build system.
3
5
 
@@ -396,6 +396,14 @@ module Google
396
396
  Google::Ads::GoogleAds::V1::Enums::TrackingCodeTypeEnum::TrackingCodeType.descriptor
397
397
  end
398
398
 
399
+ # Returns the descriptor for the CampaignDraftStatus enum
400
+ #
401
+ # @return [Google::Protobuf::EnumDescriptor] for the CampaignDraftStatus enum
402
+ def self.campaign_draft_status
403
+ require "google/ads/google_ads/v1/enums/campaign_draft_status_pb.rb"
404
+ Google::Ads::GoogleAds::V1::Enums::CampaignDraftStatusEnum::CampaignDraftStatus.descriptor
405
+ end
406
+
399
407
  # Returns the descriptor for the PolicyTopicEntryType enum
400
408
  #
401
409
  # @return [Google::Protobuf::EnumDescriptor] for the PolicyTopicEntryType enum
@@ -644,6 +652,22 @@ module Google
644
652
  Google::Ads::GoogleAds::V1::Enums::ManagerLinkStatusEnum::ManagerLinkStatus.descriptor
645
653
  end
646
654
 
655
+ # Returns the descriptor for the CampaignExperimentStatus enum
656
+ #
657
+ # @return [Google::Protobuf::EnumDescriptor] for the CampaignExperimentStatus enum
658
+ def self.campaign_experiment_status
659
+ require "google/ads/google_ads/v1/enums/campaign_experiment_status_pb.rb"
660
+ Google::Ads::GoogleAds::V1::Enums::CampaignExperimentStatusEnum::CampaignExperimentStatus.descriptor
661
+ end
662
+
663
+ # Returns the descriptor for the CampaignExperimentTrafficSplitType enum
664
+ #
665
+ # @return [Google::Protobuf::EnumDescriptor] for the CampaignExperimentTrafficSplitType enum
666
+ def self.campaign_experiment_traffic_split_type
667
+ require "google/ads/google_ads/v1/enums/campaign_experiment_traffic_split_type_pb.rb"
668
+ Google::Ads::GoogleAds::V1::Enums::CampaignExperimentTrafficSplitTypeEnum::CampaignExperimentTrafficSplitType.descriptor
669
+ end
670
+
647
671
  # Returns the descriptor for the ChangeStatusOperation enum
648
672
  #
649
673
  # @return [Google::Protobuf::EnumDescriptor] for the ChangeStatusOperation enum
@@ -868,6 +892,14 @@ module Google
868
892
  Google::Ads::GoogleAds::V1::Enums::UserListTypeEnum::UserListType.descriptor
869
893
  end
870
894
 
895
+ # Returns the descriptor for the CampaignCriterionStatus enum
896
+ #
897
+ # @return [Google::Protobuf::EnumDescriptor] for the CampaignCriterionStatus enum
898
+ def self.campaign_criterion_status
899
+ require "google/ads/google_ads/v1/enums/campaign_criterion_status_pb.rb"
900
+ Google::Ads::GoogleAds::V1::Enums::CampaignCriterionStatusEnum::CampaignCriterionStatus.descriptor
901
+ end
902
+
871
903
  # Returns the descriptor for the CriterionType enum
872
904
  #
873
905
  # @return [Google::Protobuf::EnumDescriptor] for the CriterionType enum
@@ -1548,6 +1580,14 @@ module Google
1548
1580
  Google::Ads::GoogleAds::V1::Enums::ExternalConversionSourceEnum::ExternalConversionSource.descriptor
1549
1581
  end
1550
1582
 
1583
+ # Returns the descriptor for the HotelRateType enum
1584
+ #
1585
+ # @return [Google::Protobuf::EnumDescriptor] for the HotelRateType enum
1586
+ def self.hotel_rate_type
1587
+ require "google/ads/google_ads/v1/enums/hotel_rate_type_pb.rb"
1588
+ Google::Ads::GoogleAds::V1::Enums::HotelRateTypeEnum::HotelRateType.descriptor
1589
+ end
1590
+
1551
1591
  # Returns the descriptor for the MonthOfYear enum
1552
1592
  #
1553
1593
  # @return [Google::Protobuf::EnumDescriptor] for the MonthOfYear enum
@@ -1884,6 +1924,14 @@ module Google
1884
1924
  Google::Ads::GoogleAds::V1::Errors::CampaignCriterionErrorEnum::CampaignCriterionError.descriptor
1885
1925
  end
1886
1926
 
1927
+ # Returns the descriptor for the CampaignDraftError enum
1928
+ #
1929
+ # @return [Google::Protobuf::EnumDescriptor] for the CampaignDraftError enum
1930
+ def self.campaign_draft_error
1931
+ require "google/ads/google_ads/v1/errors/campaign_draft_error_pb.rb"
1932
+ Google::Ads::GoogleAds::V1::Errors::CampaignDraftErrorEnum::CampaignDraftError.descriptor
1933
+ end
1934
+
1887
1935
  # Returns the descriptor for the CampaignError enum
1888
1936
  #
1889
1937
  # @return [Google::Protobuf::EnumDescriptor] for the CampaignError enum
@@ -1892,6 +1940,14 @@ module Google
1892
1940
  Google::Ads::GoogleAds::V1::Errors::CampaignErrorEnum::CampaignError.descriptor
1893
1941
  end
1894
1942
 
1943
+ # Returns the descriptor for the CampaignExperimentError enum
1944
+ #
1945
+ # @return [Google::Protobuf::EnumDescriptor] for the CampaignExperimentError enum
1946
+ def self.campaign_experiment_error
1947
+ require "google/ads/google_ads/v1/errors/campaign_experiment_error_pb.rb"
1948
+ Google::Ads::GoogleAds::V1::Errors::CampaignExperimentErrorEnum::CampaignExperimentError.descriptor
1949
+ end
1950
+
1895
1951
  # Returns the descriptor for the CampaignSharedSetError enum
1896
1952
  #
1897
1953
  # @return [Google::Protobuf::EnumDescriptor] for the CampaignSharedSetError enum
@@ -2180,6 +2236,14 @@ module Google
2180
2236
  Google::Ads::GoogleAds::V1::Errors::ListOperationErrorEnum::ListOperationError.descriptor
2181
2237
  end
2182
2238
 
2239
+ # Returns the descriptor for the ManagerLinkError enum
2240
+ #
2241
+ # @return [Google::Protobuf::EnumDescriptor] for the ManagerLinkError enum
2242
+ def self.manager_link_error
2243
+ require "google/ads/google_ads/v1/errors/manager_link_error_pb.rb"
2244
+ Google::Ads::GoogleAds::V1::Errors::ManagerLinkErrorEnum::ManagerLinkError.descriptor
2245
+ end
2246
+
2183
2247
  # Returns the descriptor for the MediaBundleError enum
2184
2248
  #
2185
2249
  # @return [Google::Protobuf::EnumDescriptor] for the MediaBundleError enum
@@ -2220,6 +2284,14 @@ module Google
2220
2284
  Google::Ads::GoogleAds::V1::Errors::NotEmptyErrorEnum::NotEmptyError.descriptor
2221
2285
  end
2222
2286
 
2287
+ # Returns the descriptor for the NotWhitelistedError enum
2288
+ #
2289
+ # @return [Google::Protobuf::EnumDescriptor] for the NotWhitelistedError enum
2290
+ def self.not_whitelisted_error
2291
+ require "google/ads/google_ads/v1/errors/not_whitelisted_error_pb.rb"
2292
+ Google::Ads::GoogleAds::V1::Errors::NotWhitelistedErrorEnum::NotWhitelistedError.descriptor
2293
+ end
2294
+
2223
2295
  # Returns the descriptor for the NullError enum
2224
2296
  #
2225
2297
  # @return [Google::Protobuf::EnumDescriptor] for the NullError enum
@@ -156,6 +156,22 @@ module Google
156
156
  Google::Ads::GoogleAds::V1::Services::CampaignCriterionOperation.new
157
157
  end
158
158
 
159
+ # Create a new CampaignDraftOperation
160
+ #
161
+ # @return [Google::Ads::GoogleAds::V1::Services::CampaignDraftOperation] the operation
162
+ def self.campaign_draft
163
+ require "google/ads/google_ads/v1/services/campaign_draft_service_pb.rb"
164
+ Google::Ads::GoogleAds::V1::Services::CampaignDraftOperation.new
165
+ end
166
+
167
+ # Create a new CampaignExperimentOperation
168
+ #
169
+ # @return [Google::Ads::GoogleAds::V1::Services::CampaignExperimentOperation] the operation
170
+ def self.campaign_experiment
171
+ require "google/ads/google_ads/v1/services/campaign_experiment_service_pb.rb"
172
+ Google::Ads::GoogleAds::V1::Services::CampaignExperimentOperation.new
173
+ end
174
+
159
175
  # Create a new CampaignExtensionSettingOperation
160
176
  #
161
177
  # @return [Google::Ads::GoogleAds::V1::Services::CampaignExtensionSettingOperation] the operation
@@ -795,6 +811,56 @@ module Google
795
811
  op
796
812
  end
797
813
 
814
+ # A convenience method for creating an CampaignDraftOperation instance with
815
+ # its "create" field prepopulated with an CampaignDraft instance.
816
+ #
817
+ # @overload campaign_draft
818
+ # creates an operation instance, yielding a newly fabricated CampaignDraft
819
+ # which can be used for setting attributes on the newly created resource
820
+ # @overload campaign_draft(res)
821
+ # creates an operation instance, with the resource to be created
822
+ # set to the passed value (res)
823
+ # @param res [Google::Ads::GoogleAds::V1::Resources::CampaignDraft]
824
+ # a resource instance to be used for creation in this operation.
825
+ #
826
+ # @return [Google::Ads::GoogleAds::V1::Services::CampaignDraftOperation] instance that will create the resource
827
+ def self.campaign_draft(res = nil, &blk)
828
+ require "google/ads/google_ads/v1/services/campaign_draft_service_pb.rb"
829
+ op = Google::Ads::GoogleAds::V1::Services::CampaignDraftOperation.new
830
+ if !res.nil?
831
+ op["create"] = res
832
+ elsif !blk.nil?
833
+ op["create"] = Factories::V1::Resources.campaign_draft(&blk)
834
+ end
835
+
836
+ op
837
+ end
838
+
839
+ # A convenience method for creating an CampaignExperimentOperation instance with
840
+ # its "create" field prepopulated with an CampaignExperiment instance.
841
+ #
842
+ # @overload campaign_experiment
843
+ # creates an operation instance, yielding a newly fabricated CampaignExperiment
844
+ # which can be used for setting attributes on the newly created resource
845
+ # @overload campaign_experiment(res)
846
+ # creates an operation instance, with the resource to be created
847
+ # set to the passed value (res)
848
+ # @param res [Google::Ads::GoogleAds::V1::Resources::CampaignExperiment]
849
+ # a resource instance to be used for creation in this operation.
850
+ #
851
+ # @return [Google::Ads::GoogleAds::V1::Services::CampaignExperimentOperation] instance that will create the resource
852
+ def self.campaign_experiment(res = nil, &blk)
853
+ require "google/ads/google_ads/v1/services/campaign_experiment_service_pb.rb"
854
+ op = Google::Ads::GoogleAds::V1::Services::CampaignExperimentOperation.new
855
+ if !res.nil?
856
+ op["create"] = res
857
+ elsif !blk.nil?
858
+ op["create"] = Factories::V1::Resources.campaign_experiment(&blk)
859
+ end
860
+
861
+ op
862
+ end
863
+
798
864
  # A convenience method for creating an CampaignExtensionSettingOperation instance with
799
865
  # its "create" field prepopulated with an CampaignExtensionSetting instance.
800
866
  #
@@ -1999,6 +2065,45 @@ module Google
1999
2065
  op
2000
2066
  end
2001
2067
 
2068
+ # A convenience method for creating an CampaignDraftOperation instance with
2069
+ # its "update" field prepopulated with an CampaignDraft instance, and
2070
+ # its "update_mask" field populated as needed to send the updates to the API.
2071
+ #
2072
+ # @overload #campaign_draft(path, &blk)
2073
+ # @param path [String] a resource path for the resource to update
2074
+ # @yield [Google::Ads::GoogleAds::V1::Resources::CampaignDraft] a new instance of the resource for this update operation, on
2075
+ # which fields can be set to update
2076
+ #
2077
+ # @overload #campaign_draft(resource, &blk)
2078
+ # @param resource [Google::Ads::GoogleAds::V1::Resources::CampaignDraft] a resource instance to update
2079
+ # @yield the passed block is called and updates against `resource` are recordered in the update mask
2080
+ # @return [Google::Ads::GoogleAds::V1::Services::CampaignDraftOperation] the operation instance to update the resource
2081
+ def self.campaign_draft(resource_or_path, &blk)
2082
+ require "google/ads/google_ads/v1/services/campaign_draft_service_pb.rb"
2083
+ res = case resource_or_path
2084
+ when Google::Ads::GoogleAds::V1::Resources::CampaignDraft
2085
+ resource_or_path
2086
+ # got a resource path
2087
+ when String
2088
+ obj = Google::Ads::GoogleAds::V1::Resources::CampaignDraft.new
2089
+ obj.resource_name = resource_or_path
2090
+ obj
2091
+ else
2092
+ unless Google::Ads::GoogleAds::V1::Resources::CampaignDraft === res
2093
+ raise ArgumentError.new(
2094
+ "Called #{__method__} with instance of wrong type:"\
2095
+ " #{res.class} want #{operation.update_class}"\
2096
+ " or String representing resource name"
2097
+ )
2098
+ end
2099
+ end
2100
+
2101
+ op = Google::Ads::GoogleAds::V1::Services::CampaignDraftOperation.new
2102
+ op["update_mask"] = Google::Ads::GoogleAds::FieldMaskUtil.with(res, &blk)
2103
+ op["update"] = res
2104
+ op
2105
+ end
2106
+
2002
2107
  # A convenience method for creating an CampaignExtensionSettingOperation instance with
2003
2108
  # its "update" field prepopulated with an CampaignExtensionSetting instance, and
2004
2109
  # its "update_mask" field populated as needed to send the updates to the API.
@@ -3244,6 +3349,26 @@ module Google
3244
3349
  op
3245
3350
  end
3246
3351
 
3352
+ # A convenience method for creationg an CampaignDraftOperation instance with
3353
+ # its "remove" field preopulated with a resource path corresponding to the resource to be removed.
3354
+ #
3355
+ # @param path [String] the resource name of the resource to delete.
3356
+ def self.campaign_draft(path)
3357
+ op = Google::Ads::GoogleAds::V1::Services::CampaignDraftOperation.new
3358
+ op["remove"] = path
3359
+ op
3360
+ end
3361
+
3362
+ # A convenience method for creationg an CampaignExperimentOperation instance with
3363
+ # its "remove" field preopulated with a resource path corresponding to the resource to be removed.
3364
+ #
3365
+ # @param path [String] the resource name of the resource to delete.
3366
+ def self.campaign_experiment(path)
3367
+ op = Google::Ads::GoogleAds::V1::Services::CampaignExperimentOperation.new
3368
+ op["remove"] = path
3369
+ op
3370
+ end
3371
+
3247
3372
  # A convenience method for creationg an CampaignExtensionSettingOperation instance with
3248
3373
  # its "remove" field preopulated with a resource path corresponding to the resource to be removed.
3249
3374
  #