google-api-client 0.11.1 → 0.11.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (252) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +4 -0
  3. data/api_names.yaml +42335 -1
  4. data/generated/google/apis/acceleratedmobilepageurl_v1.rb +3 -3
  5. data/generated/google/apis/acceleratedmobilepageurl_v1/classes.rb +28 -28
  6. data/generated/google/apis/acceleratedmobilepageurl_v1/representations.rb +12 -12
  7. data/generated/google/apis/acceleratedmobilepageurl_v1/service.rb +2 -2
  8. data/generated/google/apis/adexchangebuyer2_v2beta1.rb +1 -1
  9. data/generated/google/apis/adexchangebuyer2_v2beta1/classes.rb +757 -757
  10. data/generated/google/apis/adexchangebuyer2_v2beta1/representations.rb +162 -162
  11. data/generated/google/apis/adexchangebuyer2_v2beta1/service.rb +48 -48
  12. data/generated/google/apis/admin_directory_v1.rb +1 -1
  13. data/generated/google/apis/admin_directory_v1/classes.rb +75 -7
  14. data/generated/google/apis/admin_directory_v1/representations.rb +20 -0
  15. data/generated/google/apis/admin_directory_v1/service.rb +61 -61
  16. data/generated/google/apis/adsense_v1_4.rb +1 -1
  17. data/generated/google/apis/adsensehost_v4_1.rb +1 -1
  18. data/generated/google/apis/analyticsreporting_v4.rb +1 -1
  19. data/generated/google/apis/analyticsreporting_v4/classes.rb +403 -403
  20. data/generated/google/apis/analyticsreporting_v4/representations.rb +108 -108
  21. data/generated/google/apis/androidenterprise_v1.rb +1 -1
  22. data/generated/google/apis/androidenterprise_v1/classes.rb +36 -11
  23. data/generated/google/apis/androidenterprise_v1/representations.rb +2 -0
  24. data/generated/google/apis/androidpublisher_v2.rb +1 -1
  25. data/generated/google/apis/appengine_v1.rb +6 -5
  26. data/generated/google/apis/appengine_v1/classes.rb +1429 -1421
  27. data/generated/google/apis/appengine_v1/representations.rb +331 -331
  28. data/generated/google/apis/appengine_v1/service.rb +173 -168
  29. data/generated/google/apis/appstate_v1.rb +1 -1
  30. data/generated/google/apis/bigquery_v2.rb +1 -1
  31. data/generated/google/apis/calendar_v3.rb +1 -1
  32. data/generated/google/apis/classroom_v1.rb +1 -1
  33. data/generated/google/apis/cloudbilling_v1.rb +1 -1
  34. data/generated/google/apis/cloudbuild_v1.rb +1 -1
  35. data/generated/google/apis/cloudbuild_v1/classes.rb +624 -618
  36. data/generated/google/apis/cloudbuild_v1/representations.rb +126 -125
  37. data/generated/google/apis/cloudbuild_v1/service.rb +87 -87
  38. data/generated/google/apis/clouddebugger_v2.rb +4 -4
  39. data/generated/google/apis/clouddebugger_v2/classes.rb +267 -267
  40. data/generated/google/apis/clouddebugger_v2/representations.rb +83 -83
  41. data/generated/google/apis/clouddebugger_v2/service.rb +137 -137
  42. data/generated/google/apis/clouderrorreporting_v1beta1.rb +1 -1
  43. data/generated/google/apis/clouderrorreporting_v1beta1/classes.rb +131 -131
  44. data/generated/google/apis/clouderrorreporting_v1beta1/representations.rb +28 -28
  45. data/generated/google/apis/clouderrorreporting_v1beta1/service.rb +17 -17
  46. data/generated/google/apis/cloudfunctions_v1.rb +1 -4
  47. data/generated/google/apis/cloudfunctions_v1/classes.rb +7 -47
  48. data/generated/google/apis/cloudfunctions_v1/representations.rb +1 -17
  49. data/generated/google/apis/cloudfunctions_v1/service.rb +0 -30
  50. data/generated/google/apis/cloudkms_v1.rb +1 -1
  51. data/generated/google/apis/cloudkms_v1/classes.rb +625 -625
  52. data/generated/google/apis/cloudkms_v1/representations.rb +132 -132
  53. data/generated/google/apis/cloudkms_v1/service.rb +272 -272
  54. data/generated/google/apis/cloudmonitoring_v2beta2.rb +1 -1
  55. data/generated/google/apis/cloudresourcemanager_v1.rb +4 -4
  56. data/generated/google/apis/cloudresourcemanager_v1/classes.rb +242 -242
  57. data/generated/google/apis/cloudresourcemanager_v1/representations.rb +43 -43
  58. data/generated/google/apis/cloudresourcemanager_v1/service.rb +505 -505
  59. data/generated/google/apis/cloudresourcemanager_v1beta1.rb +4 -4
  60. data/generated/google/apis/cloudresourcemanager_v1beta1/classes.rb +172 -172
  61. data/generated/google/apis/cloudresourcemanager_v1beta1/representations.rb +39 -39
  62. data/generated/google/apis/cloudresourcemanager_v1beta1/service.rb +310 -310
  63. data/generated/google/apis/cloudtrace_v1.rb +1 -1
  64. data/generated/google/apis/cloudtrace_v1/classes.rb +96 -69
  65. data/generated/google/apis/cloudtrace_v1/representations.rb +16 -16
  66. data/generated/google/apis/cloudtrace_v1/service.rb +42 -15
  67. data/generated/google/apis/compute_beta.rb +1 -1
  68. data/generated/google/apis/compute_beta/classes.rb +194 -25
  69. data/generated/google/apis/compute_beta/representations.rb +42 -0
  70. data/generated/google/apis/compute_beta/service.rb +196 -100
  71. data/generated/google/apis/compute_v1.rb +1 -1
  72. data/generated/google/apis/compute_v1/classes.rb +69 -18
  73. data/generated/google/apis/compute_v1/representations.rb +16 -0
  74. data/generated/google/apis/compute_v1/service.rb +84 -26
  75. data/generated/google/apis/container_v1.rb +3 -3
  76. data/generated/google/apis/container_v1/classes.rb +794 -586
  77. data/generated/google/apis/container_v1/representations.rb +202 -118
  78. data/generated/google/apis/container_v1/service.rb +396 -167
  79. data/generated/google/apis/content_v2.rb +1 -1
  80. data/generated/google/apis/content_v2/service.rb +4 -4
  81. data/generated/google/apis/dataproc_v1.rb +1 -1
  82. data/generated/google/apis/dataproc_v1/classes.rb +487 -484
  83. data/generated/google/apis/dataproc_v1/representations.rb +83 -83
  84. data/generated/google/apis/dataproc_v1/service.rb +299 -297
  85. data/generated/google/apis/datastore_v1.rb +1 -1
  86. data/generated/google/apis/datastore_v1/classes.rb +703 -703
  87. data/generated/google/apis/datastore_v1/representations.rb +148 -148
  88. data/generated/google/apis/datastore_v1/service.rb +62 -62
  89. data/generated/google/apis/deploymentmanager_v2.rb +1 -1
  90. data/generated/google/apis/deploymentmanager_v2/classes.rb +7 -5
  91. data/generated/google/apis/dfareporting_v2_6.rb +1 -1
  92. data/generated/google/apis/dfareporting_v2_6/classes.rb +66 -53
  93. data/generated/google/apis/dfareporting_v2_6/service.rb +30 -30
  94. data/generated/google/apis/dfareporting_v2_7.rb +1 -1
  95. data/generated/google/apis/dfareporting_v2_7/classes.rb +69 -55
  96. data/generated/google/apis/dfareporting_v2_7/service.rb +38 -37
  97. data/generated/google/apis/dfareporting_v2_8.rb +40 -0
  98. data/generated/google/apis/dfareporting_v2_8/classes.rb +12046 -0
  99. data/generated/google/apis/dfareporting_v2_8/representations.rb +4310 -0
  100. data/generated/google/apis/dfareporting_v2_8/service.rb +9135 -0
  101. data/generated/google/apis/dns_v1.rb +1 -1
  102. data/generated/google/apis/dns_v2beta1.rb +1 -1
  103. data/generated/google/apis/doubleclicksearch_v2.rb +1 -1
  104. data/generated/google/apis/drive_v2.rb +1 -1
  105. data/generated/google/apis/drive_v2/classes.rb +15 -0
  106. data/generated/google/apis/drive_v2/representations.rb +2 -0
  107. data/generated/google/apis/drive_v2/service.rb +2 -1
  108. data/generated/google/apis/drive_v3.rb +1 -1
  109. data/generated/google/apis/drive_v3/classes.rb +16 -0
  110. data/generated/google/apis/drive_v3/representations.rb +2 -0
  111. data/generated/google/apis/drive_v3/service.rb +2 -1
  112. data/generated/google/apis/firebasedynamiclinks_v1.rb +2 -3
  113. data/generated/google/apis/firebasedynamiclinks_v1/classes.rb +159 -159
  114. data/generated/google/apis/firebasedynamiclinks_v1/representations.rb +55 -55
  115. data/generated/google/apis/firebasedynamiclinks_v1/service.rb +5 -6
  116. data/generated/google/apis/firebaserules_v1.rb +1 -1
  117. data/generated/google/apis/firebaserules_v1/classes.rb +73 -73
  118. data/generated/google/apis/firebaserules_v1/representations.rb +25 -25
  119. data/generated/google/apis/firebaserules_v1/service.rb +118 -118
  120. data/generated/google/apis/fusiontables_v2.rb +1 -1
  121. data/generated/google/apis/games_configuration_v1configuration.rb +1 -1
  122. data/generated/google/apis/games_management_v1management.rb +1 -1
  123. data/generated/google/apis/games_v1.rb +1 -1
  124. data/generated/google/apis/genomics_v1.rb +1 -1
  125. data/generated/google/apis/genomics_v1/classes.rb +920 -920
  126. data/generated/google/apis/genomics_v1/representations.rb +202 -202
  127. data/generated/google/apis/genomics_v1/service.rb +1092 -1092
  128. data/generated/google/apis/gmail_v1.rb +1 -1
  129. data/generated/google/apis/iam_v1.rb +1 -1
  130. data/generated/google/apis/iam_v1/classes.rb +455 -435
  131. data/generated/google/apis/iam_v1/representations.rb +96 -93
  132. data/generated/google/apis/iam_v1/service.rb +157 -157
  133. data/generated/google/apis/identitytoolkit_v3.rb +1 -1
  134. data/generated/google/apis/identitytoolkit_v3/classes.rb +12 -0
  135. data/generated/google/apis/identitytoolkit_v3/representations.rb +2 -0
  136. data/generated/google/apis/kgsearch_v1/classes.rb +6 -6
  137. data/generated/google/apis/kgsearch_v1/representations.rb +1 -1
  138. data/generated/google/apis/kgsearch_v1/service.rb +9 -9
  139. data/generated/google/apis/language_v1.rb +1 -1
  140. data/generated/google/apis/language_v1/classes.rb +455 -455
  141. data/generated/google/apis/language_v1/representations.rb +102 -102
  142. data/generated/google/apis/language_v1/service.rb +42 -42
  143. data/generated/google/apis/language_v1beta1.rb +1 -1
  144. data/generated/google/apis/language_v1beta1/classes.rb +216 -215
  145. data/generated/google/apis/language_v1beta1/representations.rb +75 -75
  146. data/generated/google/apis/language_v1beta1/service.rb +45 -45
  147. data/generated/google/apis/logging_v2.rb +1 -1
  148. data/generated/google/apis/logging_v2/classes.rb +908 -895
  149. data/generated/google/apis/logging_v2/representations.rb +121 -120
  150. data/generated/google/apis/logging_v2/service.rb +489 -489
  151. data/generated/google/apis/logging_v2beta1.rb +4 -4
  152. data/generated/google/apis/logging_v2beta1/classes.rb +928 -915
  153. data/generated/google/apis/logging_v2beta1/representations.rb +121 -120
  154. data/generated/google/apis/logging_v2beta1/service.rb +249 -249
  155. data/generated/google/apis/manufacturers_v1.rb +1 -1
  156. data/generated/google/apis/manufacturers_v1/classes.rb +294 -294
  157. data/generated/google/apis/manufacturers_v1/representations.rb +84 -84
  158. data/generated/google/apis/manufacturers_v1/service.rb +8 -8
  159. data/generated/google/apis/mirror_v1.rb +1 -1
  160. data/generated/google/apis/ml_v1.rb +1 -1
  161. data/generated/google/apis/ml_v1/classes.rb +1186 -1183
  162. data/generated/google/apis/ml_v1/representations.rb +177 -177
  163. data/generated/google/apis/ml_v1/service.rb +244 -244
  164. data/generated/google/apis/monitoring_v3.rb +1 -1
  165. data/generated/google/apis/monitoring_v3/classes.rb +866 -866
  166. data/generated/google/apis/monitoring_v3/representations.rb +163 -163
  167. data/generated/google/apis/monitoring_v3/service.rb +355 -316
  168. data/generated/google/apis/oauth2_v2.rb +1 -1
  169. data/generated/google/apis/partners_v2.rb +1 -1
  170. data/generated/google/apis/partners_v2/classes.rb +1499 -1499
  171. data/generated/google/apis/partners_v2/representations.rb +368 -368
  172. data/generated/google/apis/partners_v2/service.rb +512 -512
  173. data/generated/google/apis/people_v1.rb +10 -10
  174. data/generated/google/apis/people_v1/classes.rb +544 -423
  175. data/generated/google/apis/people_v1/representations.rb +127 -109
  176. data/generated/google/apis/people_v1/service.rb +8 -8
  177. data/generated/google/apis/plus_domains_v1.rb +1 -1
  178. data/generated/google/apis/plus_v1.rb +1 -1
  179. data/generated/google/apis/proximitybeacon_v1beta1.rb +1 -1
  180. data/generated/google/apis/proximitybeacon_v1beta1/classes.rb +200 -200
  181. data/generated/google/apis/proximitybeacon_v1beta1/representations.rb +41 -41
  182. data/generated/google/apis/proximitybeacon_v1beta1/service.rb +80 -80
  183. data/generated/google/apis/pubsub_v1.rb +1 -1
  184. data/generated/google/apis/pubsub_v1/classes.rb +377 -377
  185. data/generated/google/apis/pubsub_v1/representations.rb +82 -82
  186. data/generated/google/apis/pubsub_v1/service.rb +93 -93
  187. data/generated/google/apis/runtimeconfig_v1.rb +6 -4
  188. data/generated/google/apis/runtimeconfig_v1/classes.rb +22 -22
  189. data/generated/google/apis/runtimeconfig_v1/representations.rb +2 -2
  190. data/generated/google/apis/runtimeconfig_v1/service.rb +57 -55
  191. data/generated/google/apis/script_v1.rb +14 -14
  192. data/generated/google/apis/script_v1/classes.rb +113 -58
  193. data/generated/google/apis/script_v1/representations.rb +43 -14
  194. data/generated/google/apis/script_v1/service.rb +6 -6
  195. data/generated/google/apis/searchconsole_v1.rb +1 -1
  196. data/generated/google/apis/searchconsole_v1/classes.rb +67 -67
  197. data/generated/google/apis/searchconsole_v1/representations.rb +29 -29
  198. data/generated/google/apis/searchconsole_v1/service.rb +6 -6
  199. data/generated/google/apis/servicecontrol_v1.rb +4 -4
  200. data/generated/google/apis/servicecontrol_v1/classes.rb +1125 -1125
  201. data/generated/google/apis/servicecontrol_v1/representations.rb +213 -213
  202. data/generated/google/apis/servicecontrol_v1/service.rb +92 -92
  203. data/generated/google/apis/servicemanagement_v1.rb +1 -1
  204. data/generated/google/apis/servicemanagement_v1/classes.rb +3364 -3622
  205. data/generated/google/apis/servicemanagement_v1/representations.rb +546 -530
  206. data/generated/google/apis/servicemanagement_v1/service.rb +262 -152
  207. data/generated/google/apis/serviceuser_v1.rb +4 -4
  208. data/generated/google/apis/serviceuser_v1/classes.rb +2616 -2874
  209. data/generated/google/apis/serviceuser_v1/representations.rb +294 -278
  210. data/generated/google/apis/serviceuser_v1/service.rb +19 -19
  211. data/generated/google/apis/sheets_v4.rb +4 -1
  212. data/generated/google/apis/sheets_v4/classes.rb +4315 -4313
  213. data/generated/google/apis/sheets_v4/representations.rb +858 -858
  214. data/generated/google/apis/sheets_v4/service.rb +115 -115
  215. data/generated/google/apis/slides_v1.rb +1 -1
  216. data/generated/google/apis/slides_v1/classes.rb +2890 -2890
  217. data/generated/google/apis/slides_v1/representations.rb +638 -638
  218. data/generated/google/apis/slides_v1/service.rb +36 -36
  219. data/generated/google/apis/sourcerepo_v1.rb +1 -1
  220. data/generated/google/apis/sourcerepo_v1/classes.rb +283 -283
  221. data/generated/google/apis/sourcerepo_v1/representations.rb +67 -67
  222. data/generated/google/apis/sourcerepo_v1/service.rb +88 -88
  223. data/generated/google/apis/spanner_v1.rb +1 -1
  224. data/generated/google/apis/spanner_v1/classes.rb +2258 -2233
  225. data/generated/google/apis/spanner_v1/representations.rb +325 -325
  226. data/generated/google/apis/spanner_v1/service.rb +466 -466
  227. data/generated/google/apis/speech_v1beta1.rb +2 -2
  228. data/generated/google/apis/speech_v1beta1/classes.rb +97 -97
  229. data/generated/google/apis/speech_v1beta1/representations.rb +29 -29
  230. data/generated/google/apis/speech_v1beta1/service.rb +49 -49
  231. data/generated/google/apis/storage_v1.rb +1 -1
  232. data/generated/google/apis/storagetransfer_v1.rb +1 -1
  233. data/generated/google/apis/storagetransfer_v1/classes.rb +786 -786
  234. data/generated/google/apis/storagetransfer_v1/representations.rb +133 -133
  235. data/generated/google/apis/storagetransfer_v1/service.rb +30 -30
  236. data/generated/google/apis/surveys_v2.rb +1 -1
  237. data/generated/google/apis/surveys_v2/classes.rb +0 -12
  238. data/generated/google/apis/surveys_v2/representations.rb +0 -4
  239. data/generated/google/apis/toolresults_v1beta3.rb +1 -1
  240. data/generated/google/apis/vision_v1.rb +1 -1
  241. data/generated/google/apis/vision_v1/classes.rb +1301 -1302
  242. data/generated/google/apis/vision_v1/representations.rb +183 -183
  243. data/generated/google/apis/youtube_analytics_v1.rb +1 -1
  244. data/generated/google/apis/youtube_partner_v1.rb +1 -1
  245. data/generated/google/apis/youtube_partner_v1/classes.rb +10 -0
  246. data/generated/google/apis/youtube_partner_v1/representations.rb +1 -0
  247. data/generated/google/apis/youtubereporting_v1.rb +1 -1
  248. data/generated/google/apis/youtubereporting_v1/classes.rb +64 -64
  249. data/generated/google/apis/youtubereporting_v1/representations.rb +12 -12
  250. data/generated/google/apis/youtubereporting_v1/service.rb +94 -94
  251. data/lib/google/apis/version.rb +1 -1
  252. metadata +7 -3
@@ -48,16 +48,11 @@ module Google
48
48
  @batch_path = 'batch'
49
49
  end
50
50
 
51
- # Gets a user.
52
- # @param [String] user_id
53
- # Identifier of the user. Can be set to <code>me</code> to mean the currently
54
- # authenticated user.
51
+ # Lists the Offers available for the current user
55
52
  # @param [String] request_metadata_user_overrides_user_id
56
53
  # Logged-in user ID to impersonate instead of the user's ID.
57
54
  # @param [String] request_metadata_partners_session_id
58
55
  # Google Partners session ID.
59
- # @param [String] user_view
60
- # Specifies what parts of the user information to return.
61
56
  # @param [String] request_metadata_traffic_source_traffic_source_id
62
57
  # Identifier to indicate where the traffic comes from.
63
58
  # An identifier has multiple letters created by a team which redirected the
@@ -72,48 +67,48 @@ module Google
72
67
  # Second level identifier to indicate where the traffic comes from.
73
68
  # An identifier has multiple letters created by a team which redirected the
74
69
  # traffic to us.
75
- # @param [String] fields
76
- # Selector specifying which fields to include in a partial response.
77
70
  # @param [String] quota_user
78
71
  # Available to use for quota purposes for server-side applications. Can be any
79
72
  # arbitrary string assigned to a user, but should not exceed 40 characters.
73
+ # @param [String] fields
74
+ # Selector specifying which fields to include in a partial response.
80
75
  # @param [Google::Apis::RequestOptions] options
81
76
  # Request-specific options
82
77
  #
83
78
  # @yield [result, err] Result & error if block supplied
84
- # @yieldparam result [Google::Apis::PartnersV2::User] parsed result object
79
+ # @yieldparam result [Google::Apis::PartnersV2::ListOffersResponse] parsed result object
85
80
  # @yieldparam err [StandardError] error object if request failed
86
81
  #
87
- # @return [Google::Apis::PartnersV2::User]
82
+ # @return [Google::Apis::PartnersV2::ListOffersResponse]
88
83
  #
89
84
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
90
85
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
91
86
  # @raise [Google::Apis::AuthorizationError] Authorization is required
92
- def get_user(user_id, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, user_view: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, fields: nil, quota_user: nil, options: nil, &block)
93
- command = make_simple_command(:get, 'v2/users/{userId}', options)
94
- command.response_representation = Google::Apis::PartnersV2::User::Representation
95
- command.response_class = Google::Apis::PartnersV2::User
96
- command.params['userId'] = user_id unless user_id.nil?
87
+ def list_offers(request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, quota_user: nil, fields: nil, options: nil, &block)
88
+ command = make_simple_command(:get, 'v2/offers', options)
89
+ command.response_representation = Google::Apis::PartnersV2::ListOffersResponse::Representation
90
+ command.response_class = Google::Apis::PartnersV2::ListOffersResponse
97
91
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
98
92
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
99
- command.query['userView'] = user_view unless user_view.nil?
100
93
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
101
94
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
102
95
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
103
96
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
104
97
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
105
- command.query['fields'] = fields unless fields.nil?
106
98
  command.query['quotaUser'] = quota_user unless quota_user.nil?
99
+ command.query['fields'] = fields unless fields.nil?
107
100
  execute_or_queue_command(command, &block)
108
101
  end
109
102
 
110
- # Updates a user's profile. A user can only update their own profile and
111
- # should only be called within the context of a logged in user.
112
- # @param [Google::Apis::PartnersV2::UserProfile] user_profile_object
103
+ # Lists the Historical Offers for the current user (or user's entire company)
113
104
  # @param [String] request_metadata_user_overrides_user_id
114
105
  # Logged-in user ID to impersonate instead of the user's ID.
115
106
  # @param [String] request_metadata_partners_session_id
116
107
  # Google Partners session ID.
108
+ # @param [String] page_token
109
+ # Token to retrieve a specific page.
110
+ # @param [Fixnum] page_size
111
+ # Maximum number of rows to return per page.
117
112
  # @param [String] request_metadata_traffic_source_traffic_source_id
118
113
  # Identifier to indicate where the traffic comes from.
119
114
  # An identifier has multiple letters created by a team which redirected the
@@ -124,50 +119,81 @@ module Google
124
119
  # IP address to use instead of the user's geo-located IP address.
125
120
  # @param [Array<String>, String] request_metadata_experiment_ids
126
121
  # Experiment IDs the current request belongs to.
122
+ # @param [Boolean] entire_company
123
+ # if true, show history for the entire company. Requires user to be admin.
127
124
  # @param [String] request_metadata_traffic_source_traffic_sub_id
128
125
  # Second level identifier to indicate where the traffic comes from.
129
126
  # An identifier has multiple letters created by a team which redirected the
130
127
  # traffic to us.
131
- # @param [String] fields
132
- # Selector specifying which fields to include in a partial response.
128
+ # @param [String] order_by
129
+ # Comma-separated list of fields to order by, e.g.: "foo,bar,baz".
130
+ # Use "foo desc" to sort descending.
131
+ # List of valid field names is: name, offer_code, expiration_time, status,
132
+ # last_modified_time, sender_name, creation_time, country_code,
133
+ # offer_type.
133
134
  # @param [String] quota_user
134
135
  # Available to use for quota purposes for server-side applications. Can be any
135
136
  # arbitrary string assigned to a user, but should not exceed 40 characters.
137
+ # @param [String] fields
138
+ # Selector specifying which fields to include in a partial response.
136
139
  # @param [Google::Apis::RequestOptions] options
137
140
  # Request-specific options
138
141
  #
139
142
  # @yield [result, err] Result & error if block supplied
140
- # @yieldparam result [Google::Apis::PartnersV2::UserProfile] parsed result object
143
+ # @yieldparam result [Google::Apis::PartnersV2::ListOffersHistoryResponse] parsed result object
141
144
  # @yieldparam err [StandardError] error object if request failed
142
145
  #
143
- # @return [Google::Apis::PartnersV2::UserProfile]
146
+ # @return [Google::Apis::PartnersV2::ListOffersHistoryResponse]
144
147
  #
145
148
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
146
149
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
147
150
  # @raise [Google::Apis::AuthorizationError] Authorization is required
148
- def update_user_profile(user_profile_object = nil, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, fields: nil, quota_user: nil, options: nil, &block)
149
- command = make_simple_command(:patch, 'v2/users/profile', options)
150
- command.request_representation = Google::Apis::PartnersV2::UserProfile::Representation
151
- command.request_object = user_profile_object
152
- command.response_representation = Google::Apis::PartnersV2::UserProfile::Representation
153
- command.response_class = Google::Apis::PartnersV2::UserProfile
151
+ def list_offer_histories(request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, page_token: nil, page_size: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, entire_company: nil, request_metadata_traffic_source_traffic_sub_id: nil, order_by: nil, quota_user: nil, fields: nil, options: nil, &block)
152
+ command = make_simple_command(:get, 'v2/offers/history', options)
153
+ command.response_representation = Google::Apis::PartnersV2::ListOffersHistoryResponse::Representation
154
+ command.response_class = Google::Apis::PartnersV2::ListOffersHistoryResponse
154
155
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
155
156
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
157
+ command.query['pageToken'] = page_token unless page_token.nil?
158
+ command.query['pageSize'] = page_size unless page_size.nil?
156
159
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
157
160
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
158
161
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
159
162
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
163
+ command.query['entireCompany'] = entire_company unless entire_company.nil?
160
164
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
161
- command.query['fields'] = fields unless fields.nil?
165
+ command.query['orderBy'] = order_by unless order_by.nil?
162
166
  command.query['quotaUser'] = quota_user unless quota_user.nil?
167
+ command.query['fields'] = fields unless fields.nil?
163
168
  execute_or_queue_command(command, &block)
164
169
  end
165
170
 
166
- # Creates a user's company relation. Affiliates the user to a company.
167
- # @param [String] user_id
168
- # The ID of the user. Can be set to <code>me</code> to mean
169
- # the currently authenticated user.
170
- # @param [Google::Apis::PartnersV2::CompanyRelation] company_relation_object
171
+ # Lists analytics data for a user's associated company.
172
+ # Should only be called within the context of an authorized logged in user.
173
+ # @param [String] request_metadata_user_overrides_user_id
174
+ # Logged-in user ID to impersonate instead of the user's ID.
175
+ # @param [String] request_metadata_partners_session_id
176
+ # Google Partners session ID.
177
+ # @param [String] page_token
178
+ # A token identifying a page of results that the server returns.
179
+ # Typically, this is the value of `ListAnalyticsResponse.next_page_token`
180
+ # returned from the previous call to
181
+ # ListAnalytics.
182
+ # Will be a date string in `YYYY-MM-DD` format representing the end date
183
+ # of the date range of results to return.
184
+ # If unspecified or set to "", default value is the current date.
185
+ # @param [Fixnum] page_size
186
+ # Requested page size. Server may return fewer analytics than requested.
187
+ # If unspecified or set to 0, default value is 30.
188
+ # Specifies the number of days in the date range when querying analytics.
189
+ # The `page_token` represents the end date of the date range
190
+ # and the start date is calculated using the `page_size` as the number
191
+ # of days BEFORE the end date.
192
+ # Must be a non-negative integer.
193
+ # @param [String] request_metadata_traffic_source_traffic_source_id
194
+ # Identifier to indicate where the traffic comes from.
195
+ # An identifier has multiple letters created by a team which redirected the
196
+ # traffic to us.
171
197
  # @param [String] request_metadata_locale
172
198
  # Locale to use for the current request.
173
199
  # @param [String] request_metadata_user_overrides_ip_address
@@ -178,6 +204,46 @@ module Google
178
204
  # Second level identifier to indicate where the traffic comes from.
179
205
  # An identifier has multiple letters created by a team which redirected the
180
206
  # traffic to us.
207
+ # @param [String] quota_user
208
+ # Available to use for quota purposes for server-side applications. Can be any
209
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
210
+ # @param [String] fields
211
+ # Selector specifying which fields to include in a partial response.
212
+ # @param [Google::Apis::RequestOptions] options
213
+ # Request-specific options
214
+ #
215
+ # @yield [result, err] Result & error if block supplied
216
+ # @yieldparam result [Google::Apis::PartnersV2::ListAnalyticsResponse] parsed result object
217
+ # @yieldparam err [StandardError] error object if request failed
218
+ #
219
+ # @return [Google::Apis::PartnersV2::ListAnalyticsResponse]
220
+ #
221
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
222
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
223
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
224
+ def list_analytics(request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, page_token: nil, page_size: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, quota_user: nil, fields: nil, options: nil, &block)
225
+ command = make_simple_command(:get, 'v2/analytics', options)
226
+ command.response_representation = Google::Apis::PartnersV2::ListAnalyticsResponse::Representation
227
+ command.response_class = Google::Apis::PartnersV2::ListAnalyticsResponse
228
+ command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
229
+ command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
230
+ command.query['pageToken'] = page_token unless page_token.nil?
231
+ command.query['pageSize'] = page_size unless page_size.nil?
232
+ command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
233
+ command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
234
+ command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
235
+ command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
236
+ command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
237
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
238
+ command.query['fields'] = fields unless fields.nil?
239
+ execute_or_queue_command(command, &block)
240
+ end
241
+
242
+ # Lists states for current user.
243
+ # @param [String] request_metadata_traffic_source_traffic_sub_id
244
+ # Second level identifier to indicate where the traffic comes from.
245
+ # An identifier has multiple letters created by a team which redirected the
246
+ # traffic to us.
181
247
  # @param [String] request_metadata_user_overrides_user_id
182
248
  # Logged-in user ID to impersonate instead of the user's ID.
183
249
  # @param [String] request_metadata_partners_session_id
@@ -186,50 +252,51 @@ module Google
186
252
  # Identifier to indicate where the traffic comes from.
187
253
  # An identifier has multiple letters created by a team which redirected the
188
254
  # traffic to us.
189
- # @param [String] fields
190
- # Selector specifying which fields to include in a partial response.
255
+ # @param [String] request_metadata_locale
256
+ # Locale to use for the current request.
257
+ # @param [String] request_metadata_user_overrides_ip_address
258
+ # IP address to use instead of the user's geo-located IP address.
259
+ # @param [Array<String>, String] request_metadata_experiment_ids
260
+ # Experiment IDs the current request belongs to.
191
261
  # @param [String] quota_user
192
262
  # Available to use for quota purposes for server-side applications. Can be any
193
263
  # arbitrary string assigned to a user, but should not exceed 40 characters.
264
+ # @param [String] fields
265
+ # Selector specifying which fields to include in a partial response.
194
266
  # @param [Google::Apis::RequestOptions] options
195
267
  # Request-specific options
196
268
  #
197
269
  # @yield [result, err] Result & error if block supplied
198
- # @yieldparam result [Google::Apis::PartnersV2::CompanyRelation] parsed result object
270
+ # @yieldparam result [Google::Apis::PartnersV2::ListUserStatesResponse] parsed result object
199
271
  # @yieldparam err [StandardError] error object if request failed
200
272
  #
201
- # @return [Google::Apis::PartnersV2::CompanyRelation]
273
+ # @return [Google::Apis::PartnersV2::ListUserStatesResponse]
202
274
  #
203
275
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
204
276
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
205
277
  # @raise [Google::Apis::AuthorizationError] Authorization is required
206
- def create_user_company_relation(user_id, company_relation_object = nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, fields: nil, quota_user: nil, options: nil, &block)
207
- command = make_simple_command(:put, 'v2/users/{userId}/companyRelation', options)
208
- command.request_representation = Google::Apis::PartnersV2::CompanyRelation::Representation
209
- command.request_object = company_relation_object
210
- command.response_representation = Google::Apis::PartnersV2::CompanyRelation::Representation
211
- command.response_class = Google::Apis::PartnersV2::CompanyRelation
212
- command.params['userId'] = user_id unless user_id.nil?
213
- command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
214
- command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
215
- command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
278
+ def list_user_states(request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, quota_user: nil, fields: nil, options: nil, &block)
279
+ command = make_simple_command(:get, 'v2/userStates', options)
280
+ command.response_representation = Google::Apis::PartnersV2::ListUserStatesResponse::Representation
281
+ command.response_class = Google::Apis::PartnersV2::ListUserStatesResponse
216
282
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
217
283
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
218
284
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
219
285
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
220
- command.query['fields'] = fields unless fields.nil?
286
+ command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
287
+ command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
288
+ command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
221
289
  command.query['quotaUser'] = quota_user unless quota_user.nil?
290
+ command.query['fields'] = fields unless fields.nil?
222
291
  execute_or_queue_command(command, &block)
223
292
  end
224
293
 
225
- # Deletes a user's company relation. Unaffiliaites the user from a company.
226
- # @param [String] user_id
227
- # The ID of the user. Can be set to <code>me</code> to mean
228
- # the currently authenticated user.
229
- # @param [String] request_metadata_partners_session_id
230
- # Google Partners session ID.
294
+ # Gets Partners Status of the logged in user's agency.
295
+ # Should only be called if the logged in user is the admin of the agency.
231
296
  # @param [String] request_metadata_user_overrides_user_id
232
297
  # Logged-in user ID to impersonate instead of the user's ID.
298
+ # @param [String] request_metadata_partners_session_id
299
+ # Google Partners session ID.
233
300
  # @param [String] request_metadata_traffic_source_traffic_source_id
234
301
  # Identifier to indicate where the traffic comes from.
235
302
  # An identifier has multiple letters created by a team which redirected the
@@ -244,146 +311,241 @@ module Google
244
311
  # Second level identifier to indicate where the traffic comes from.
245
312
  # An identifier has multiple letters created by a team which redirected the
246
313
  # traffic to us.
247
- # @param [String] fields
248
- # Selector specifying which fields to include in a partial response.
249
314
  # @param [String] quota_user
250
315
  # Available to use for quota purposes for server-side applications. Can be any
251
316
  # arbitrary string assigned to a user, but should not exceed 40 characters.
317
+ # @param [String] fields
318
+ # Selector specifying which fields to include in a partial response.
252
319
  # @param [Google::Apis::RequestOptions] options
253
320
  # Request-specific options
254
321
  #
255
322
  # @yield [result, err] Result & error if block supplied
256
- # @yieldparam result [Google::Apis::PartnersV2::Empty] parsed result object
323
+ # @yieldparam result [Google::Apis::PartnersV2::GetPartnersStatusResponse] parsed result object
257
324
  # @yieldparam err [StandardError] error object if request failed
258
325
  #
259
- # @return [Google::Apis::PartnersV2::Empty]
326
+ # @return [Google::Apis::PartnersV2::GetPartnersStatusResponse]
260
327
  #
261
328
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
262
329
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
263
330
  # @raise [Google::Apis::AuthorizationError] Authorization is required
264
- def delete_user_company_relation(user_id, request_metadata_partners_session_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, fields: nil, quota_user: nil, options: nil, &block)
265
- command = make_simple_command(:delete, 'v2/users/{userId}/companyRelation', options)
266
- command.response_representation = Google::Apis::PartnersV2::Empty::Representation
267
- command.response_class = Google::Apis::PartnersV2::Empty
268
- command.params['userId'] = user_id unless user_id.nil?
269
- command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
331
+ def get_partnersstatus(request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, quota_user: nil, fields: nil, options: nil, &block)
332
+ command = make_simple_command(:get, 'v2/partnersstatus', options)
333
+ command.response_representation = Google::Apis::PartnersV2::GetPartnersStatusResponse::Representation
334
+ command.response_class = Google::Apis::PartnersV2::GetPartnersStatusResponse
270
335
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
336
+ command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
271
337
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
272
338
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
273
339
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
274
340
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
275
341
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
276
- command.query['fields'] = fields unless fields.nil?
277
342
  command.query['quotaUser'] = quota_user unless quota_user.nil?
343
+ command.query['fields'] = fields unless fields.nil?
278
344
  execute_or_queue_command(command, &block)
279
345
  end
280
346
 
281
- # Gets a company.
282
- # @param [String] company_id
283
- # The ID of the company to retrieve.
347
+ # Updates the specified lead.
348
+ # @param [Google::Apis::PartnersV2::Lead] lead_object
349
+ # @param [String] request_metadata_traffic_source_traffic_sub_id
350
+ # Second level identifier to indicate where the traffic comes from.
351
+ # An identifier has multiple letters created by a team which redirected the
352
+ # traffic to us.
284
353
  # @param [String] request_metadata_partners_session_id
285
354
  # Google Partners session ID.
286
355
  # @param [String] request_metadata_user_overrides_user_id
287
356
  # Logged-in user ID to impersonate instead of the user's ID.
288
- # @param [String] view
289
- # The view of `Company` resource to be returned. This must not be
290
- # `COMPANY_VIEW_UNSPECIFIED`.
291
- # @param [String] address
292
- # The address to use for sorting the company's addresses by proximity.
293
- # If not given, the geo-located address of the request is used.
294
- # Used when order_by is set.
295
- # @param [String] request_metadata_locale
296
- # Locale to use for the current request.
297
357
  # @param [String] request_metadata_traffic_source_traffic_source_id
298
358
  # Identifier to indicate where the traffic comes from.
299
359
  # An identifier has multiple letters created by a team which redirected the
300
360
  # traffic to us.
361
+ # @param [String] request_metadata_locale
362
+ # Locale to use for the current request.
301
363
  # @param [String] request_metadata_user_overrides_ip_address
302
364
  # IP address to use instead of the user's geo-located IP address.
365
+ # @param [String] update_mask
366
+ # Standard field mask for the set of fields to be updated.
367
+ # Required with at least 1 value in FieldMask's paths.
368
+ # Only `state` and `adwords_customer_id` are currently supported.
303
369
  # @param [Array<String>, String] request_metadata_experiment_ids
304
370
  # Experiment IDs the current request belongs to.
305
- # @param [String] currency_code
306
- # If the company's budget is in a different currency code than this one, then
307
- # the converted budget is converted to this currency code.
308
- # @param [String] request_metadata_traffic_source_traffic_sub_id
309
- # Second level identifier to indicate where the traffic comes from.
310
- # An identifier has multiple letters created by a team which redirected the
311
- # traffic to us.
312
- # @param [String] order_by
313
- # How to order addresses within the returned company. Currently, only
314
- # `address` and `address desc` is supported which will sorted by closest to
315
- # farthest in distance from given address and farthest to closest distance
316
- # from given address respectively.
317
- # @param [String] fields
318
- # Selector specifying which fields to include in a partial response.
319
371
  # @param [String] quota_user
320
372
  # Available to use for quota purposes for server-side applications. Can be any
321
373
  # arbitrary string assigned to a user, but should not exceed 40 characters.
374
+ # @param [String] fields
375
+ # Selector specifying which fields to include in a partial response.
322
376
  # @param [Google::Apis::RequestOptions] options
323
377
  # Request-specific options
324
378
  #
325
379
  # @yield [result, err] Result & error if block supplied
326
- # @yieldparam result [Google::Apis::PartnersV2::GetCompanyResponse] parsed result object
380
+ # @yieldparam result [Google::Apis::PartnersV2::Lead] parsed result object
327
381
  # @yieldparam err [StandardError] error object if request failed
328
382
  #
329
- # @return [Google::Apis::PartnersV2::GetCompanyResponse]
383
+ # @return [Google::Apis::PartnersV2::Lead]
330
384
  #
331
385
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
332
386
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
333
387
  # @raise [Google::Apis::AuthorizationError] Authorization is required
334
- def get_company(company_id, request_metadata_partners_session_id: nil, request_metadata_user_overrides_user_id: nil, view: nil, address: nil, request_metadata_locale: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, currency_code: nil, request_metadata_traffic_source_traffic_sub_id: nil, order_by: nil, fields: nil, quota_user: nil, options: nil, &block)
335
- command = make_simple_command(:get, 'v2/companies/{companyId}', options)
336
- command.response_representation = Google::Apis::PartnersV2::GetCompanyResponse::Representation
337
- command.response_class = Google::Apis::PartnersV2::GetCompanyResponse
338
- command.params['companyId'] = company_id unless company_id.nil?
388
+ def update_leads(lead_object = nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_partners_session_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, update_mask: nil, request_metadata_experiment_ids: nil, quota_user: nil, fields: nil, options: nil, &block)
389
+ command = make_simple_command(:patch, 'v2/leads', options)
390
+ command.request_representation = Google::Apis::PartnersV2::Lead::Representation
391
+ command.request_object = lead_object
392
+ command.response_representation = Google::Apis::PartnersV2::Lead::Representation
393
+ command.response_class = Google::Apis::PartnersV2::Lead
394
+ command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
339
395
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
340
396
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
341
- command.query['view'] = view unless view.nil?
342
- command.query['address'] = address unless address.nil?
343
- command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
344
397
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
398
+ command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
345
399
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
400
+ command.query['updateMask'] = update_mask unless update_mask.nil?
346
401
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
347
- command.query['currencyCode'] = currency_code unless currency_code.nil?
348
- command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
349
- command.query['orderBy'] = order_by unless order_by.nil?
350
- command.query['fields'] = fields unless fields.nil?
351
402
  command.query['quotaUser'] = quota_user unless quota_user.nil?
403
+ command.query['fields'] = fields unless fields.nil?
352
404
  execute_or_queue_command(command, &block)
353
405
  end
354
406
 
355
- # Lists companies.
356
- # @param [Array<String>, String] services
357
- # List of services that the returned agencies should provide. If this is
358
- # not empty, any returned agency must have at least one of these services,
359
- # or one of the specializations in the "specializations" field.
360
- # @param [Fixnum] max_monthly_budget_units
361
- # The whole units of the amount.
362
- # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
407
+ # Update company.
408
+ # Should only be called within the context of an authorized logged in user.
409
+ # @param [Google::Apis::PartnersV2::Company] company_object
410
+ # @param [String] request_metadata_partners_session_id
411
+ # Google Partners session ID.
412
+ # @param [String] request_metadata_user_overrides_user_id
413
+ # Logged-in user ID to impersonate instead of the user's ID.
363
414
  # @param [String] request_metadata_traffic_source_traffic_source_id
364
415
  # Identifier to indicate where the traffic comes from.
365
416
  # An identifier has multiple letters created by a team which redirected the
366
417
  # traffic to us.
418
+ # @param [String] request_metadata_locale
419
+ # Locale to use for the current request.
420
+ # @param [String] request_metadata_user_overrides_ip_address
421
+ # IP address to use instead of the user's geo-located IP address.
422
+ # @param [String] update_mask
423
+ # Standard field mask for the set of fields to be updated.
424
+ # Required with at least 1 value in FieldMask's paths.
425
+ # @param [Array<String>, String] request_metadata_experiment_ids
426
+ # Experiment IDs the current request belongs to.
367
427
  # @param [String] request_metadata_traffic_source_traffic_sub_id
368
428
  # Second level identifier to indicate where the traffic comes from.
369
429
  # An identifier has multiple letters created by a team which redirected the
370
430
  # traffic to us.
371
- # @param [Fixnum] min_monthly_budget_nanos
372
- # Number of nano (10^-9) units of the amount.
373
- # The value must be between -999,999,999 and +999,999,999 inclusive.
374
- # If `units` is positive, `nanos` must be positive or zero.
375
- # If `units` is zero, `nanos` can be positive, zero, or negative.
376
- # If `units` is negative, `nanos` must be negative or zero.
377
- # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
431
+ # @param [String] quota_user
432
+ # Available to use for quota purposes for server-side applications. Can be any
433
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
434
+ # @param [String] fields
435
+ # Selector specifying which fields to include in a partial response.
436
+ # @param [Google::Apis::RequestOptions] options
437
+ # Request-specific options
438
+ #
439
+ # @yield [result, err] Result & error if block supplied
440
+ # @yieldparam result [Google::Apis::PartnersV2::Company] parsed result object
441
+ # @yieldparam err [StandardError] error object if request failed
442
+ #
443
+ # @return [Google::Apis::PartnersV2::Company]
444
+ #
445
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
446
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
447
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
448
+ def update_companies(company_object = nil, request_metadata_partners_session_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, update_mask: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, quota_user: nil, fields: nil, options: nil, &block)
449
+ command = make_simple_command(:patch, 'v2/companies', options)
450
+ command.request_representation = Google::Apis::PartnersV2::Company::Representation
451
+ command.request_object = company_object
452
+ command.response_representation = Google::Apis::PartnersV2::Company::Representation
453
+ command.response_class = Google::Apis::PartnersV2::Company
454
+ command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
455
+ command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
456
+ command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
457
+ command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
458
+ command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
459
+ command.query['updateMask'] = update_mask unless update_mask.nil?
460
+ command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
461
+ command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
462
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
463
+ command.query['fields'] = fields unless fields.nil?
464
+ execute_or_queue_command(command, &block)
465
+ end
466
+
467
+ # Gets a company.
468
+ # @param [String] company_id
469
+ # The ID of the company to retrieve.
470
+ # @param [String] request_metadata_user_overrides_user_id
471
+ # Logged-in user ID to impersonate instead of the user's ID.
378
472
  # @param [String] request_metadata_partners_session_id
379
473
  # Google Partners session ID.
474
+ # @param [String] view
475
+ # The view of `Company` resource to be returned. This must not be
476
+ # `COMPANY_VIEW_UNSPECIFIED`.
477
+ # @param [String] address
478
+ # The address to use for sorting the company's addresses by proximity.
479
+ # If not given, the geo-located address of the request is used.
480
+ # Used when order_by is set.
481
+ # @param [String] request_metadata_locale
482
+ # Locale to use for the current request.
483
+ # @param [String] request_metadata_traffic_source_traffic_source_id
484
+ # Identifier to indicate where the traffic comes from.
485
+ # An identifier has multiple letters created by a team which redirected the
486
+ # traffic to us.
487
+ # @param [String] request_metadata_user_overrides_ip_address
488
+ # IP address to use instead of the user's geo-located IP address.
489
+ # @param [Array<String>, String] request_metadata_experiment_ids
490
+ # Experiment IDs the current request belongs to.
491
+ # @param [String] currency_code
492
+ # If the company's budget is in a different currency code than this one, then
493
+ # the converted budget is converted to this currency code.
494
+ # @param [String] order_by
495
+ # How to order addresses within the returned company. Currently, only
496
+ # `address` and `address desc` is supported which will sorted by closest to
497
+ # farthest in distance from given address and farthest to closest distance
498
+ # from given address respectively.
499
+ # @param [String] request_metadata_traffic_source_traffic_sub_id
500
+ # Second level identifier to indicate where the traffic comes from.
501
+ # An identifier has multiple letters created by a team which redirected the
502
+ # traffic to us.
503
+ # @param [String] quota_user
504
+ # Available to use for quota purposes for server-side applications. Can be any
505
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
506
+ # @param [String] fields
507
+ # Selector specifying which fields to include in a partial response.
508
+ # @param [Google::Apis::RequestOptions] options
509
+ # Request-specific options
510
+ #
511
+ # @yield [result, err] Result & error if block supplied
512
+ # @yieldparam result [Google::Apis::PartnersV2::GetCompanyResponse] parsed result object
513
+ # @yieldparam err [StandardError] error object if request failed
514
+ #
515
+ # @return [Google::Apis::PartnersV2::GetCompanyResponse]
516
+ #
517
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
518
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
519
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
520
+ def get_company(company_id, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, view: nil, address: nil, request_metadata_locale: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, currency_code: nil, order_by: nil, request_metadata_traffic_source_traffic_sub_id: nil, quota_user: nil, fields: nil, options: nil, &block)
521
+ command = make_simple_command(:get, 'v2/companies/{companyId}', options)
522
+ command.response_representation = Google::Apis::PartnersV2::GetCompanyResponse::Representation
523
+ command.response_class = Google::Apis::PartnersV2::GetCompanyResponse
524
+ command.params['companyId'] = company_id unless company_id.nil?
525
+ command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
526
+ command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
527
+ command.query['view'] = view unless view.nil?
528
+ command.query['address'] = address unless address.nil?
529
+ command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
530
+ command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
531
+ command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
532
+ command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
533
+ command.query['currencyCode'] = currency_code unless currency_code.nil?
534
+ command.query['orderBy'] = order_by unless order_by.nil?
535
+ command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
536
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
537
+ command.query['fields'] = fields unless fields.nil?
538
+ execute_or_queue_command(command, &block)
539
+ end
540
+
541
+ # Lists companies.
542
+ # @param [String] company_name
543
+ # Company name to search for.
380
544
  # @param [String] page_token
381
545
  # A token identifying a page of results that the server returns.
382
546
  # Typically, this is the value of `ListCompaniesResponse.next_page_token`
383
547
  # returned from the previous call to
384
548
  # ListCompanies.
385
- # @param [String] company_name
386
- # Company name to search for.
387
549
  # @param [Array<String>, String] industries
388
550
  # List of industries the company can help with.
389
551
  # @param [String] website_url
@@ -414,10 +576,10 @@ module Google
414
576
  # specializations, or one of the services in the "services" field.
415
577
  # @param [String] max_monthly_budget_currency_code
416
578
  # The 3-letter currency code defined in ISO 4217.
417
- # @param [String] min_monthly_budget_currency_code
418
- # The 3-letter currency code defined in ISO 4217.
419
579
  # @param [String] request_metadata_user_overrides_user_id
420
580
  # Logged-in user ID to impersonate instead of the user's ID.
581
+ # @param [String] min_monthly_budget_currency_code
582
+ # The 3-letter currency code defined in ISO 4217.
421
583
  # @param [String] view
422
584
  # The view of the `Company` resource to be returned. This must not be
423
585
  # `COMPANY_VIEW_UNSPECIFIED`.
@@ -436,11 +598,35 @@ module Google
436
598
  # If `units` is zero, `nanos` can be positive, zero, or negative.
437
599
  # If `units` is negative, `nanos` must be negative or zero.
438
600
  # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
439
- # @param [String] fields
440
- # Selector specifying which fields to include in a partial response.
601
+ # @param [Array<String>, String] services
602
+ # List of services that the returned agencies should provide. If this is
603
+ # not empty, any returned agency must have at least one of these services,
604
+ # or one of the specializations in the "specializations" field.
605
+ # @param [Fixnum] max_monthly_budget_units
606
+ # The whole units of the amount.
607
+ # For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
608
+ # @param [String] request_metadata_traffic_source_traffic_source_id
609
+ # Identifier to indicate where the traffic comes from.
610
+ # An identifier has multiple letters created by a team which redirected the
611
+ # traffic to us.
612
+ # @param [String] request_metadata_traffic_source_traffic_sub_id
613
+ # Second level identifier to indicate where the traffic comes from.
614
+ # An identifier has multiple letters created by a team which redirected the
615
+ # traffic to us.
616
+ # @param [Fixnum] min_monthly_budget_nanos
617
+ # Number of nano (10^-9) units of the amount.
618
+ # The value must be between -999,999,999 and +999,999,999 inclusive.
619
+ # If `units` is positive, `nanos` must be positive or zero.
620
+ # If `units` is zero, `nanos` can be positive, zero, or negative.
621
+ # If `units` is negative, `nanos` must be negative or zero.
622
+ # For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
623
+ # @param [String] request_metadata_partners_session_id
624
+ # Google Partners session ID.
441
625
  # @param [String] quota_user
442
626
  # Available to use for quota purposes for server-side applications. Can be any
443
627
  # arbitrary string assigned to a user, but should not exceed 40 characters.
628
+ # @param [String] fields
629
+ # Selector specifying which fields to include in a partial response.
444
630
  # @param [Google::Apis::RequestOptions] options
445
631
  # Request-specific options
446
632
  #
@@ -453,18 +639,12 @@ module Google
453
639
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
454
640
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
455
641
  # @raise [Google::Apis::AuthorizationError] Authorization is required
456
- def list_companies(services: nil, max_monthly_budget_units: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, min_monthly_budget_nanos: nil, request_metadata_partners_session_id: nil, page_token: nil, company_name: nil, industries: nil, website_url: nil, gps_motivations: nil, language_codes: nil, page_size: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, order_by: nil, specializations: nil, max_monthly_budget_currency_code: nil, min_monthly_budget_currency_code: nil, request_metadata_user_overrides_user_id: nil, view: nil, request_metadata_locale: nil, address: nil, min_monthly_budget_units: nil, max_monthly_budget_nanos: nil, fields: nil, quota_user: nil, options: nil, &block)
642
+ def list_companies(company_name: nil, page_token: nil, industries: nil, website_url: nil, gps_motivations: nil, language_codes: nil, page_size: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, order_by: nil, specializations: nil, max_monthly_budget_currency_code: nil, request_metadata_user_overrides_user_id: nil, min_monthly_budget_currency_code: nil, view: nil, request_metadata_locale: nil, address: nil, min_monthly_budget_units: nil, max_monthly_budget_nanos: nil, services: nil, max_monthly_budget_units: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_traffic_source_traffic_sub_id: nil, min_monthly_budget_nanos: nil, request_metadata_partners_session_id: nil, quota_user: nil, fields: nil, options: nil, &block)
457
643
  command = make_simple_command(:get, 'v2/companies', options)
458
644
  command.response_representation = Google::Apis::PartnersV2::ListCompaniesResponse::Representation
459
645
  command.response_class = Google::Apis::PartnersV2::ListCompaniesResponse
460
- command.query['services'] = services unless services.nil?
461
- command.query['maxMonthlyBudget.units'] = max_monthly_budget_units unless max_monthly_budget_units.nil?
462
- command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
463
- command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
464
- command.query['minMonthlyBudget.nanos'] = min_monthly_budget_nanos unless min_monthly_budget_nanos.nil?
465
- command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
466
- command.query['pageToken'] = page_token unless page_token.nil?
467
646
  command.query['companyName'] = company_name unless company_name.nil?
647
+ command.query['pageToken'] = page_token unless page_token.nil?
468
648
  command.query['industries'] = industries unless industries.nil?
469
649
  command.query['websiteUrl'] = website_url unless website_url.nil?
470
650
  command.query['gpsMotivations'] = gps_motivations unless gps_motivations.nil?
@@ -475,15 +655,21 @@ module Google
475
655
  command.query['orderBy'] = order_by unless order_by.nil?
476
656
  command.query['specializations'] = specializations unless specializations.nil?
477
657
  command.query['maxMonthlyBudget.currencyCode'] = max_monthly_budget_currency_code unless max_monthly_budget_currency_code.nil?
478
- command.query['minMonthlyBudget.currencyCode'] = min_monthly_budget_currency_code unless min_monthly_budget_currency_code.nil?
479
658
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
659
+ command.query['minMonthlyBudget.currencyCode'] = min_monthly_budget_currency_code unless min_monthly_budget_currency_code.nil?
480
660
  command.query['view'] = view unless view.nil?
481
661
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
482
662
  command.query['address'] = address unless address.nil?
483
663
  command.query['minMonthlyBudget.units'] = min_monthly_budget_units unless min_monthly_budget_units.nil?
484
664
  command.query['maxMonthlyBudget.nanos'] = max_monthly_budget_nanos unless max_monthly_budget_nanos.nil?
485
- command.query['fields'] = fields unless fields.nil?
665
+ command.query['services'] = services unless services.nil?
666
+ command.query['maxMonthlyBudget.units'] = max_monthly_budget_units unless max_monthly_budget_units.nil?
667
+ command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
668
+ command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
669
+ command.query['minMonthlyBudget.nanos'] = min_monthly_budget_nanos unless min_monthly_budget_nanos.nil?
670
+ command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
486
671
  command.query['quotaUser'] = quota_user unless quota_user.nil?
672
+ command.query['fields'] = fields unless fields.nil?
487
673
  execute_or_queue_command(command, &block)
488
674
  end
489
675
 
@@ -491,11 +677,11 @@ module Google
491
677
  # @param [String] company_id
492
678
  # The ID of the company to contact.
493
679
  # @param [Google::Apis::PartnersV2::CreateLeadRequest] create_lead_request_object
494
- # @param [String] fields
495
- # Selector specifying which fields to include in a partial response.
496
680
  # @param [String] quota_user
497
681
  # Available to use for quota purposes for server-side applications. Can be any
498
682
  # arbitrary string assigned to a user, but should not exceed 40 characters.
683
+ # @param [String] fields
684
+ # Selector specifying which fields to include in a partial response.
499
685
  # @param [Google::Apis::RequestOptions] options
500
686
  # Request-specific options
501
687
  #
@@ -508,83 +694,23 @@ module Google
508
694
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
509
695
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
510
696
  # @raise [Google::Apis::AuthorizationError] Authorization is required
511
- def create_lead(company_id, create_lead_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
697
+ def create_lead(company_id, create_lead_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
512
698
  command = make_simple_command(:post, 'v2/companies/{companyId}/leads', options)
513
699
  command.request_representation = Google::Apis::PartnersV2::CreateLeadRequest::Representation
514
700
  command.request_object = create_lead_request_object
515
701
  command.response_representation = Google::Apis::PartnersV2::CreateLeadResponse::Representation
516
702
  command.response_class = Google::Apis::PartnersV2::CreateLeadResponse
517
703
  command.params['companyId'] = company_id unless company_id.nil?
518
- command.query['fields'] = fields unless fields.nil?
519
704
  command.query['quotaUser'] = quota_user unless quota_user.nil?
520
- execute_or_queue_command(command, &block)
521
- end
522
-
523
- # Logs a user event.
524
- # @param [Google::Apis::PartnersV2::LogUserEventRequest] log_user_event_request_object
525
- # @param [String] fields
526
- # Selector specifying which fields to include in a partial response.
527
- # @param [String] quota_user
528
- # Available to use for quota purposes for server-side applications. Can be any
529
- # arbitrary string assigned to a user, but should not exceed 40 characters.
530
- # @param [Google::Apis::RequestOptions] options
531
- # Request-specific options
532
- #
533
- # @yield [result, err] Result & error if block supplied
534
- # @yieldparam result [Google::Apis::PartnersV2::LogUserEventResponse] parsed result object
535
- # @yieldparam err [StandardError] error object if request failed
536
- #
537
- # @return [Google::Apis::PartnersV2::LogUserEventResponse]
538
- #
539
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
540
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
541
- # @raise [Google::Apis::AuthorizationError] Authorization is required
542
- def log_user_event(log_user_event_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
543
- command = make_simple_command(:post, 'v2/userEvents:log', options)
544
- command.request_representation = Google::Apis::PartnersV2::LogUserEventRequest::Representation
545
- command.request_object = log_user_event_request_object
546
- command.response_representation = Google::Apis::PartnersV2::LogUserEventResponse::Representation
547
- command.response_class = Google::Apis::PartnersV2::LogUserEventResponse
548
- command.query['fields'] = fields unless fields.nil?
549
- command.query['quotaUser'] = quota_user unless quota_user.nil?
550
- execute_or_queue_command(command, &block)
551
- end
552
-
553
- # Logs a generic message from the client, such as
554
- # `Failed to render component`, `Profile page is running slow`,
555
- # `More than 500 users have accessed this result.`, etc.
556
- # @param [Google::Apis::PartnersV2::LogMessageRequest] log_message_request_object
557
- # @param [String] fields
558
- # Selector specifying which fields to include in a partial response.
559
- # @param [String] quota_user
560
- # Available to use for quota purposes for server-side applications. Can be any
561
- # arbitrary string assigned to a user, but should not exceed 40 characters.
562
- # @param [Google::Apis::RequestOptions] options
563
- # Request-specific options
564
- #
565
- # @yield [result, err] Result & error if block supplied
566
- # @yieldparam result [Google::Apis::PartnersV2::LogMessageResponse] parsed result object
567
- # @yieldparam err [StandardError] error object if request failed
568
- #
569
- # @return [Google::Apis::PartnersV2::LogMessageResponse]
570
- #
571
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
572
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
573
- # @raise [Google::Apis::AuthorizationError] Authorization is required
574
- def log_client_message_message(log_message_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
575
- command = make_simple_command(:post, 'v2/clientMessages:log', options)
576
- command.request_representation = Google::Apis::PartnersV2::LogMessageRequest::Representation
577
- command.request_object = log_message_request_object
578
- command.response_representation = Google::Apis::PartnersV2::LogMessageResponse::Representation
579
- command.response_class = Google::Apis::PartnersV2::LogMessageResponse
580
705
  command.query['fields'] = fields unless fields.nil?
581
- command.query['quotaUser'] = quota_user unless quota_user.nil?
582
706
  execute_or_queue_command(command, &block)
583
707
  end
584
708
 
585
- # Gets an Exam Token for a Partner's user to take an exam in the Exams System
586
- # @param [String] exam_type
587
- # The exam type we are requesting a token for.
709
+ # Creates a user's company relation. Affiliates the user to a company.
710
+ # @param [String] user_id
711
+ # The ID of the user. Can be set to <code>me</code> to mean
712
+ # the currently authenticated user.
713
+ # @param [Google::Apis::PartnersV2::CompanyRelation] company_relation_object
588
714
  # @param [String] request_metadata_user_overrides_user_id
589
715
  # Logged-in user ID to impersonate instead of the user's ID.
590
716
  # @param [String] request_metadata_partners_session_id
@@ -603,232 +729,46 @@ module Google
603
729
  # Second level identifier to indicate where the traffic comes from.
604
730
  # An identifier has multiple letters created by a team which redirected the
605
731
  # traffic to us.
606
- # @param [String] fields
607
- # Selector specifying which fields to include in a partial response.
608
732
  # @param [String] quota_user
609
733
  # Available to use for quota purposes for server-side applications. Can be any
610
734
  # arbitrary string assigned to a user, but should not exceed 40 characters.
611
- # @param [Google::Apis::RequestOptions] options
612
- # Request-specific options
613
- #
614
- # @yield [result, err] Result & error if block supplied
615
- # @yieldparam result [Google::Apis::PartnersV2::ExamToken] parsed result object
616
- # @yieldparam err [StandardError] error object if request failed
617
- #
618
- # @return [Google::Apis::PartnersV2::ExamToken]
619
- #
620
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
621
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
622
- # @raise [Google::Apis::AuthorizationError] Authorization is required
623
- def get_exam_token(exam_type, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, fields: nil, quota_user: nil, options: nil, &block)
624
- command = make_simple_command(:get, 'v2/exams/{examType}/token', options)
625
- command.response_representation = Google::Apis::PartnersV2::ExamToken::Representation
626
- command.response_class = Google::Apis::PartnersV2::ExamToken
627
- command.params['examType'] = exam_type unless exam_type.nil?
628
- command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
629
- command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
630
- command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
631
- command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
632
- command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
633
- command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
634
- command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
635
- command.query['fields'] = fields unless fields.nil?
636
- command.query['quotaUser'] = quota_user unless quota_user.nil?
637
- execute_or_queue_command(command, &block)
638
- end
639
-
640
- # Lists advertiser leads for a user's associated company.
641
- # Should only be called within the context of an authorized logged in user.
642
- # @param [String] request_metadata_locale
643
- # Locale to use for the current request.
644
- # @param [String] request_metadata_user_overrides_ip_address
645
- # IP address to use instead of the user's geo-located IP address.
646
- # @param [Array<String>, String] request_metadata_experiment_ids
647
- # Experiment IDs the current request belongs to.
648
- # @param [String] request_metadata_traffic_source_traffic_sub_id
649
- # Second level identifier to indicate where the traffic comes from.
650
- # An identifier has multiple letters created by a team which redirected the
651
- # traffic to us.
652
- # @param [String] order_by
653
- # How to order Leads. Currently, only `create_time`
654
- # and `create_time desc` are supported
655
- # @param [String] request_metadata_partners_session_id
656
- # Google Partners session ID.
657
- # @param [String] request_metadata_user_overrides_user_id
658
- # Logged-in user ID to impersonate instead of the user's ID.
659
- # @param [String] page_token
660
- # A token identifying a page of results that the server returns.
661
- # Typically, this is the value of `ListLeadsResponse.next_page_token`
662
- # returned from the previous call to
663
- # ListLeads.
664
- # @param [Fixnum] page_size
665
- # Requested page size. Server may return fewer leads than requested.
666
- # If unspecified, server picks an appropriate default.
667
- # @param [String] request_metadata_traffic_source_traffic_source_id
668
- # Identifier to indicate where the traffic comes from.
669
- # An identifier has multiple letters created by a team which redirected the
670
- # traffic to us.
671
- # @param [String] fields
672
- # Selector specifying which fields to include in a partial response.
673
- # @param [String] quota_user
674
- # Available to use for quota purposes for server-side applications. Can be any
675
- # arbitrary string assigned to a user, but should not exceed 40 characters.
676
- # @param [Google::Apis::RequestOptions] options
677
- # Request-specific options
678
- #
679
- # @yield [result, err] Result & error if block supplied
680
- # @yieldparam result [Google::Apis::PartnersV2::ListLeadsResponse] parsed result object
681
- # @yieldparam err [StandardError] error object if request failed
682
- #
683
- # @return [Google::Apis::PartnersV2::ListLeadsResponse]
684
- #
685
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
686
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
687
- # @raise [Google::Apis::AuthorizationError] Authorization is required
688
- def list_leads(request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, order_by: nil, request_metadata_partners_session_id: nil, request_metadata_user_overrides_user_id: nil, page_token: nil, page_size: nil, request_metadata_traffic_source_traffic_source_id: nil, fields: nil, quota_user: nil, options: nil, &block)
689
- command = make_simple_command(:get, 'v2/leads', options)
690
- command.response_representation = Google::Apis::PartnersV2::ListLeadsResponse::Representation
691
- command.response_class = Google::Apis::PartnersV2::ListLeadsResponse
692
- command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
693
- command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
694
- command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
695
- command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
696
- command.query['orderBy'] = order_by unless order_by.nil?
697
- command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
698
- command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
699
- command.query['pageToken'] = page_token unless page_token.nil?
700
- command.query['pageSize'] = page_size unless page_size.nil?
701
- command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
702
- command.query['fields'] = fields unless fields.nil?
703
- command.query['quotaUser'] = quota_user unless quota_user.nil?
704
- execute_or_queue_command(command, &block)
705
- end
706
-
707
- # Lists the Offers available for the current user
708
- # @param [String] request_metadata_user_overrides_ip_address
709
- # IP address to use instead of the user's geo-located IP address.
710
- # @param [Array<String>, String] request_metadata_experiment_ids
711
- # Experiment IDs the current request belongs to.
712
- # @param [String] request_metadata_traffic_source_traffic_sub_id
713
- # Second level identifier to indicate where the traffic comes from.
714
- # An identifier has multiple letters created by a team which redirected the
715
- # traffic to us.
716
- # @param [String] request_metadata_user_overrides_user_id
717
- # Logged-in user ID to impersonate instead of the user's ID.
718
- # @param [String] request_metadata_partners_session_id
719
- # Google Partners session ID.
720
- # @param [String] request_metadata_traffic_source_traffic_source_id
721
- # Identifier to indicate where the traffic comes from.
722
- # An identifier has multiple letters created by a team which redirected the
723
- # traffic to us.
724
- # @param [String] request_metadata_locale
725
- # Locale to use for the current request.
726
735
  # @param [String] fields
727
736
  # Selector specifying which fields to include in a partial response.
728
- # @param [String] quota_user
729
- # Available to use for quota purposes for server-side applications. Can be any
730
- # arbitrary string assigned to a user, but should not exceed 40 characters.
731
737
  # @param [Google::Apis::RequestOptions] options
732
738
  # Request-specific options
733
739
  #
734
740
  # @yield [result, err] Result & error if block supplied
735
- # @yieldparam result [Google::Apis::PartnersV2::ListOffersResponse] parsed result object
741
+ # @yieldparam result [Google::Apis::PartnersV2::CompanyRelation] parsed result object
736
742
  # @yieldparam err [StandardError] error object if request failed
737
743
  #
738
- # @return [Google::Apis::PartnersV2::ListOffersResponse]
744
+ # @return [Google::Apis::PartnersV2::CompanyRelation]
739
745
  #
740
746
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
741
747
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
742
748
  # @raise [Google::Apis::AuthorizationError] Authorization is required
743
- def list_offers(request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, fields: nil, quota_user: nil, options: nil, &block)
744
- command = make_simple_command(:get, 'v2/offers', options)
745
- command.response_representation = Google::Apis::PartnersV2::ListOffersResponse::Representation
746
- command.response_class = Google::Apis::PartnersV2::ListOffersResponse
747
- command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
748
- command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
749
- command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
749
+ def create_user_company_relation(user_id, company_relation_object = nil, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, quota_user: nil, fields: nil, options: nil, &block)
750
+ command = make_simple_command(:put, 'v2/users/{userId}/companyRelation', options)
751
+ command.request_representation = Google::Apis::PartnersV2::CompanyRelation::Representation
752
+ command.request_object = company_relation_object
753
+ command.response_representation = Google::Apis::PartnersV2::CompanyRelation::Representation
754
+ command.response_class = Google::Apis::PartnersV2::CompanyRelation
755
+ command.params['userId'] = user_id unless user_id.nil?
750
756
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
751
757
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
752
758
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
753
759
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
754
- command.query['fields'] = fields unless fields.nil?
755
- command.query['quotaUser'] = quota_user unless quota_user.nil?
756
- execute_or_queue_command(command, &block)
757
- end
758
-
759
- # Lists the Historical Offers for the current user (or user's entire company)
760
- # @param [String] request_metadata_partners_session_id
761
- # Google Partners session ID.
762
- # @param [String] request_metadata_user_overrides_user_id
763
- # Logged-in user ID to impersonate instead of the user's ID.
764
- # @param [String] page_token
765
- # Token to retrieve a specific page.
766
- # @param [Fixnum] page_size
767
- # Maximum number of rows to return per page.
768
- # @param [String] request_metadata_traffic_source_traffic_source_id
769
- # Identifier to indicate where the traffic comes from.
770
- # An identifier has multiple letters created by a team which redirected the
771
- # traffic to us.
772
- # @param [String] request_metadata_locale
773
- # Locale to use for the current request.
774
- # @param [String] request_metadata_user_overrides_ip_address
775
- # IP address to use instead of the user's geo-located IP address.
776
- # @param [Boolean] entire_company
777
- # if true, show history for the entire company. Requires user to be admin.
778
- # @param [Array<String>, String] request_metadata_experiment_ids
779
- # Experiment IDs the current request belongs to.
780
- # @param [String] order_by
781
- # Comma-separated list of fields to order by, e.g.: "foo,bar,baz".
782
- # Use "foo desc" to sort descending.
783
- # List of valid field names is: name, offer_code, expiration_time, status,
784
- # last_modified_time, sender_name, creation_time, country_code,
785
- # offer_type.
786
- # @param [String] request_metadata_traffic_source_traffic_sub_id
787
- # Second level identifier to indicate where the traffic comes from.
788
- # An identifier has multiple letters created by a team which redirected the
789
- # traffic to us.
790
- # @param [String] fields
791
- # Selector specifying which fields to include in a partial response.
792
- # @param [String] quota_user
793
- # Available to use for quota purposes for server-side applications. Can be any
794
- # arbitrary string assigned to a user, but should not exceed 40 characters.
795
- # @param [Google::Apis::RequestOptions] options
796
- # Request-specific options
797
- #
798
- # @yield [result, err] Result & error if block supplied
799
- # @yieldparam result [Google::Apis::PartnersV2::ListOffersHistoryResponse] parsed result object
800
- # @yieldparam err [StandardError] error object if request failed
801
- #
802
- # @return [Google::Apis::PartnersV2::ListOffersHistoryResponse]
803
- #
804
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
805
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
806
- # @raise [Google::Apis::AuthorizationError] Authorization is required
807
- def list_offer_histories(request_metadata_partners_session_id: nil, request_metadata_user_overrides_user_id: nil, page_token: nil, page_size: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, entire_company: nil, request_metadata_experiment_ids: nil, order_by: nil, request_metadata_traffic_source_traffic_sub_id: nil, fields: nil, quota_user: nil, options: nil, &block)
808
- command = make_simple_command(:get, 'v2/offers/history', options)
809
- command.response_representation = Google::Apis::PartnersV2::ListOffersHistoryResponse::Representation
810
- command.response_class = Google::Apis::PartnersV2::ListOffersHistoryResponse
811
- command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
812
- command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
813
- command.query['pageToken'] = page_token unless page_token.nil?
814
- command.query['pageSize'] = page_size unless page_size.nil?
815
- command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
816
- command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
817
760
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
818
- command.query['entireCompany'] = entire_company unless entire_company.nil?
819
761
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
820
- command.query['orderBy'] = order_by unless order_by.nil?
821
762
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
822
- command.query['fields'] = fields unless fields.nil?
823
763
  command.query['quotaUser'] = quota_user unless quota_user.nil?
764
+ command.query['fields'] = fields unless fields.nil?
824
765
  execute_or_queue_command(command, &block)
825
766
  end
826
767
 
827
- # Lists states for current user.
828
- # @param [String] request_metadata_user_overrides_user_id
829
- # Logged-in user ID to impersonate instead of the user's ID.
830
- # @param [String] request_metadata_partners_session_id
831
- # Google Partners session ID.
768
+ # Deletes a user's company relation. Unaffiliaites the user from a company.
769
+ # @param [String] user_id
770
+ # The ID of the user. Can be set to <code>me</code> to mean
771
+ # the currently authenticated user.
832
772
  # @param [String] request_metadata_traffic_source_traffic_source_id
833
773
  # Identifier to indicate where the traffic comes from.
834
774
  # An identifier has multiple letters created by a team which redirected the
@@ -843,41 +783,48 @@ module Google
843
783
  # Second level identifier to indicate where the traffic comes from.
844
784
  # An identifier has multiple letters created by a team which redirected the
845
785
  # traffic to us.
846
- # @param [String] fields
847
- # Selector specifying which fields to include in a partial response.
786
+ # @param [String] request_metadata_partners_session_id
787
+ # Google Partners session ID.
788
+ # @param [String] request_metadata_user_overrides_user_id
789
+ # Logged-in user ID to impersonate instead of the user's ID.
848
790
  # @param [String] quota_user
849
791
  # Available to use for quota purposes for server-side applications. Can be any
850
792
  # arbitrary string assigned to a user, but should not exceed 40 characters.
793
+ # @param [String] fields
794
+ # Selector specifying which fields to include in a partial response.
851
795
  # @param [Google::Apis::RequestOptions] options
852
796
  # Request-specific options
853
797
  #
854
798
  # @yield [result, err] Result & error if block supplied
855
- # @yieldparam result [Google::Apis::PartnersV2::ListUserStatesResponse] parsed result object
799
+ # @yieldparam result [Google::Apis::PartnersV2::Empty] parsed result object
856
800
  # @yieldparam err [StandardError] error object if request failed
857
801
  #
858
- # @return [Google::Apis::PartnersV2::ListUserStatesResponse]
802
+ # @return [Google::Apis::PartnersV2::Empty]
859
803
  #
860
804
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
861
805
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
862
806
  # @raise [Google::Apis::AuthorizationError] Authorization is required
863
- def list_user_states(request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, fields: nil, quota_user: nil, options: nil, &block)
864
- command = make_simple_command(:get, 'v2/userStates', options)
865
- command.response_representation = Google::Apis::PartnersV2::ListUserStatesResponse::Representation
866
- command.response_class = Google::Apis::PartnersV2::ListUserStatesResponse
867
- command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
868
- command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
807
+ def delete_user_company_relation(user_id, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_partners_session_id: nil, request_metadata_user_overrides_user_id: nil, quota_user: nil, fields: nil, options: nil, &block)
808
+ command = make_simple_command(:delete, 'v2/users/{userId}/companyRelation', options)
809
+ command.response_representation = Google::Apis::PartnersV2::Empty::Representation
810
+ command.response_class = Google::Apis::PartnersV2::Empty
811
+ command.params['userId'] = user_id unless user_id.nil?
869
812
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
870
813
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
871
814
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
872
815
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
873
816
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
874
- command.query['fields'] = fields unless fields.nil?
817
+ command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
818
+ command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
875
819
  command.query['quotaUser'] = quota_user unless quota_user.nil?
820
+ command.query['fields'] = fields unless fields.nil?
876
821
  execute_or_queue_command(command, &block)
877
822
  end
878
823
 
879
- # Lists analytics data for a user's associated company.
880
- # Should only be called within the context of an authorized logged in user.
824
+ # Gets a user.
825
+ # @param [String] user_id
826
+ # Identifier of the user. Can be set to <code>me</code> to mean the currently
827
+ # authenticated user.
881
828
  # @param [String] request_metadata_user_overrides_ip_address
882
829
  # IP address to use instead of the user's geo-located IP address.
883
830
  # @param [Array<String>, String] request_metadata_experiment_ids
@@ -886,73 +833,56 @@ module Google
886
833
  # Second level identifier to indicate where the traffic comes from.
887
834
  # An identifier has multiple letters created by a team which redirected the
888
835
  # traffic to us.
889
- # @param [String] request_metadata_user_overrides_user_id
890
- # Logged-in user ID to impersonate instead of the user's ID.
891
836
  # @param [String] request_metadata_partners_session_id
892
837
  # Google Partners session ID.
893
- # @param [String] page_token
894
- # A token identifying a page of results that the server returns.
895
- # Typically, this is the value of `ListAnalyticsResponse.next_page_token`
896
- # returned from the previous call to
897
- # ListAnalytics.
898
- # Will be a date string in `YYYY-MM-DD` format representing the end date
899
- # of the date range of results to return.
900
- # If unspecified or set to "", default value is the current date.
901
- # @param [Fixnum] page_size
902
- # Requested page size. Server may return fewer analytics than requested.
903
- # If unspecified or set to 0, default value is 30.
904
- # Specifies the number of days in the date range when querying analytics.
905
- # The `page_token` represents the end date of the date range
906
- # and the start date is calculated using the `page_size` as the number
907
- # of days BEFORE the end date.
908
- # Must be a non-negative integer.
838
+ # @param [String] request_metadata_user_overrides_user_id
839
+ # Logged-in user ID to impersonate instead of the user's ID.
840
+ # @param [String] user_view
841
+ # Specifies what parts of the user information to return.
909
842
  # @param [String] request_metadata_traffic_source_traffic_source_id
910
843
  # Identifier to indicate where the traffic comes from.
911
844
  # An identifier has multiple letters created by a team which redirected the
912
845
  # traffic to us.
913
846
  # @param [String] request_metadata_locale
914
847
  # Locale to use for the current request.
915
- # @param [String] fields
916
- # Selector specifying which fields to include in a partial response.
917
848
  # @param [String] quota_user
918
849
  # Available to use for quota purposes for server-side applications. Can be any
919
850
  # arbitrary string assigned to a user, but should not exceed 40 characters.
851
+ # @param [String] fields
852
+ # Selector specifying which fields to include in a partial response.
920
853
  # @param [Google::Apis::RequestOptions] options
921
854
  # Request-specific options
922
855
  #
923
856
  # @yield [result, err] Result & error if block supplied
924
- # @yieldparam result [Google::Apis::PartnersV2::ListAnalyticsResponse] parsed result object
857
+ # @yieldparam result [Google::Apis::PartnersV2::User] parsed result object
925
858
  # @yieldparam err [StandardError] error object if request failed
926
859
  #
927
- # @return [Google::Apis::PartnersV2::ListAnalyticsResponse]
860
+ # @return [Google::Apis::PartnersV2::User]
928
861
  #
929
862
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
930
863
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
931
864
  # @raise [Google::Apis::AuthorizationError] Authorization is required
932
- def list_analytics(request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, page_token: nil, page_size: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, fields: nil, quota_user: nil, options: nil, &block)
933
- command = make_simple_command(:get, 'v2/analytics', options)
934
- command.response_representation = Google::Apis::PartnersV2::ListAnalyticsResponse::Representation
935
- command.response_class = Google::Apis::PartnersV2::ListAnalyticsResponse
865
+ def get_user(user_id, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_partners_session_id: nil, request_metadata_user_overrides_user_id: nil, user_view: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, quota_user: nil, fields: nil, options: nil, &block)
866
+ command = make_simple_command(:get, 'v2/users/{userId}', options)
867
+ command.response_representation = Google::Apis::PartnersV2::User::Representation
868
+ command.response_class = Google::Apis::PartnersV2::User
869
+ command.params['userId'] = user_id unless user_id.nil?
936
870
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
937
871
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
938
872
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
939
- command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
940
873
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
941
- command.query['pageToken'] = page_token unless page_token.nil?
942
- command.query['pageSize'] = page_size unless page_size.nil?
874
+ command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
875
+ command.query['userView'] = user_view unless user_view.nil?
943
876
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
944
877
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
945
- command.query['fields'] = fields unless fields.nil?
946
878
  command.query['quotaUser'] = quota_user unless quota_user.nil?
879
+ command.query['fields'] = fields unless fields.nil?
947
880
  execute_or_queue_command(command, &block)
948
881
  end
949
882
 
950
- # Gets Partners Status of the logged in user's agency.
951
- # Should only be called if the logged in user is the admin of the agency.
952
- # @param [String] request_metadata_user_overrides_ip_address
953
- # IP address to use instead of the user's geo-located IP address.
954
- # @param [Array<String>, String] request_metadata_experiment_ids
955
- # Experiment IDs the current request belongs to.
883
+ # Updates a user's profile. A user can only update their own profile and
884
+ # should only be called within the context of a logged in user.
885
+ # @param [Google::Apis::PartnersV2::UserProfile] user_profile_object
956
886
  # @param [String] request_metadata_traffic_source_traffic_sub_id
957
887
  # Second level identifier to indicate where the traffic comes from.
958
888
  # An identifier has multiple letters created by a team which redirected the
@@ -967,41 +897,116 @@ module Google
967
897
  # traffic to us.
968
898
  # @param [String] request_metadata_locale
969
899
  # Locale to use for the current request.
970
- # @param [String] fields
971
- # Selector specifying which fields to include in a partial response.
900
+ # @param [String] request_metadata_user_overrides_ip_address
901
+ # IP address to use instead of the user's geo-located IP address.
902
+ # @param [Array<String>, String] request_metadata_experiment_ids
903
+ # Experiment IDs the current request belongs to.
972
904
  # @param [String] quota_user
973
905
  # Available to use for quota purposes for server-side applications. Can be any
974
906
  # arbitrary string assigned to a user, but should not exceed 40 characters.
907
+ # @param [String] fields
908
+ # Selector specifying which fields to include in a partial response.
975
909
  # @param [Google::Apis::RequestOptions] options
976
910
  # Request-specific options
977
911
  #
978
912
  # @yield [result, err] Result & error if block supplied
979
- # @yieldparam result [Google::Apis::PartnersV2::GetPartnersStatusResponse] parsed result object
913
+ # @yieldparam result [Google::Apis::PartnersV2::UserProfile] parsed result object
980
914
  # @yieldparam err [StandardError] error object if request failed
981
915
  #
982
- # @return [Google::Apis::PartnersV2::GetPartnersStatusResponse]
916
+ # @return [Google::Apis::PartnersV2::UserProfile]
983
917
  #
984
918
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
985
919
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
986
920
  # @raise [Google::Apis::AuthorizationError] Authorization is required
987
- def get_partnersstatus(request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, fields: nil, quota_user: nil, options: nil, &block)
988
- command = make_simple_command(:get, 'v2/partnersstatus', options)
989
- command.response_representation = Google::Apis::PartnersV2::GetPartnersStatusResponse::Representation
990
- command.response_class = Google::Apis::PartnersV2::GetPartnersStatusResponse
991
- command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
992
- command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
921
+ def update_user_profile(user_profile_object = nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, quota_user: nil, fields: nil, options: nil, &block)
922
+ command = make_simple_command(:patch, 'v2/users/profile', options)
923
+ command.request_representation = Google::Apis::PartnersV2::UserProfile::Representation
924
+ command.request_object = user_profile_object
925
+ command.response_representation = Google::Apis::PartnersV2::UserProfile::Representation
926
+ command.response_class = Google::Apis::PartnersV2::UserProfile
993
927
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
994
928
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
995
929
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
996
930
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
997
931
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
932
+ command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
933
+ command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
934
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
935
+ command.query['fields'] = fields unless fields.nil?
936
+ execute_or_queue_command(command, &block)
937
+ end
938
+
939
+ # Logs a user event.
940
+ # @param [Google::Apis::PartnersV2::LogUserEventRequest] log_user_event_request_object
941
+ # @param [String] quota_user
942
+ # Available to use for quota purposes for server-side applications. Can be any
943
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
944
+ # @param [String] fields
945
+ # Selector specifying which fields to include in a partial response.
946
+ # @param [Google::Apis::RequestOptions] options
947
+ # Request-specific options
948
+ #
949
+ # @yield [result, err] Result & error if block supplied
950
+ # @yieldparam result [Google::Apis::PartnersV2::LogUserEventResponse] parsed result object
951
+ # @yieldparam err [StandardError] error object if request failed
952
+ #
953
+ # @return [Google::Apis::PartnersV2::LogUserEventResponse]
954
+ #
955
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
956
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
957
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
958
+ def log_user_event(log_user_event_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
959
+ command = make_simple_command(:post, 'v2/userEvents:log', options)
960
+ command.request_representation = Google::Apis::PartnersV2::LogUserEventRequest::Representation
961
+ command.request_object = log_user_event_request_object
962
+ command.response_representation = Google::Apis::PartnersV2::LogUserEventResponse::Representation
963
+ command.response_class = Google::Apis::PartnersV2::LogUserEventResponse
964
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
998
965
  command.query['fields'] = fields unless fields.nil?
966
+ execute_or_queue_command(command, &block)
967
+ end
968
+
969
+ # Logs a generic message from the client, such as
970
+ # `Failed to render component`, `Profile page is running slow`,
971
+ # `More than 500 users have accessed this result.`, etc.
972
+ # @param [Google::Apis::PartnersV2::LogMessageRequest] log_message_request_object
973
+ # @param [String] quota_user
974
+ # Available to use for quota purposes for server-side applications. Can be any
975
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
976
+ # @param [String] fields
977
+ # Selector specifying which fields to include in a partial response.
978
+ # @param [Google::Apis::RequestOptions] options
979
+ # Request-specific options
980
+ #
981
+ # @yield [result, err] Result & error if block supplied
982
+ # @yieldparam result [Google::Apis::PartnersV2::LogMessageResponse] parsed result object
983
+ # @yieldparam err [StandardError] error object if request failed
984
+ #
985
+ # @return [Google::Apis::PartnersV2::LogMessageResponse]
986
+ #
987
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
988
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
989
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
990
+ def log_client_message_message(log_message_request_object = nil, quota_user: nil, fields: nil, options: nil, &block)
991
+ command = make_simple_command(:post, 'v2/clientMessages:log', options)
992
+ command.request_representation = Google::Apis::PartnersV2::LogMessageRequest::Representation
993
+ command.request_object = log_message_request_object
994
+ command.response_representation = Google::Apis::PartnersV2::LogMessageResponse::Representation
995
+ command.response_class = Google::Apis::PartnersV2::LogMessageResponse
999
996
  command.query['quotaUser'] = quota_user unless quota_user.nil?
997
+ command.query['fields'] = fields unless fields.nil?
1000
998
  execute_or_queue_command(command, &block)
1001
999
  end
1002
1000
 
1003
- # Updates the specified lead.
1004
- # @param [Google::Apis::PartnersV2::Lead] lead_object
1001
+ # Gets an Exam Token for a Partner's user to take an exam in the Exams System
1002
+ # @param [String] exam_type
1003
+ # The exam type we are requesting a token for.
1004
+ # @param [Array<String>, String] request_metadata_experiment_ids
1005
+ # Experiment IDs the current request belongs to.
1006
+ # @param [String] request_metadata_traffic_source_traffic_sub_id
1007
+ # Second level identifier to indicate where the traffic comes from.
1008
+ # An identifier has multiple letters created by a team which redirected the
1009
+ # traffic to us.
1005
1010
  # @param [String] request_metadata_partners_session_id
1006
1011
  # Google Partners session ID.
1007
1012
  # @param [String] request_metadata_user_overrides_user_id
@@ -1014,59 +1019,54 @@ module Google
1014
1019
  # Locale to use for the current request.
1015
1020
  # @param [String] request_metadata_user_overrides_ip_address
1016
1021
  # IP address to use instead of the user's geo-located IP address.
1017
- # @param [String] update_mask
1018
- # Standard field mask for the set of fields to be updated.
1019
- # Required with at least 1 value in FieldMask's paths.
1020
- # Only `state` and `adwords_customer_id` are currently supported.
1021
- # @param [Array<String>, String] request_metadata_experiment_ids
1022
- # Experiment IDs the current request belongs to.
1023
- # @param [String] request_metadata_traffic_source_traffic_sub_id
1024
- # Second level identifier to indicate where the traffic comes from.
1025
- # An identifier has multiple letters created by a team which redirected the
1026
- # traffic to us.
1027
- # @param [String] fields
1028
- # Selector specifying which fields to include in a partial response.
1029
1022
  # @param [String] quota_user
1030
1023
  # Available to use for quota purposes for server-side applications. Can be any
1031
1024
  # arbitrary string assigned to a user, but should not exceed 40 characters.
1025
+ # @param [String] fields
1026
+ # Selector specifying which fields to include in a partial response.
1032
1027
  # @param [Google::Apis::RequestOptions] options
1033
1028
  # Request-specific options
1034
1029
  #
1035
1030
  # @yield [result, err] Result & error if block supplied
1036
- # @yieldparam result [Google::Apis::PartnersV2::Lead] parsed result object
1031
+ # @yieldparam result [Google::Apis::PartnersV2::ExamToken] parsed result object
1037
1032
  # @yieldparam err [StandardError] error object if request failed
1038
1033
  #
1039
- # @return [Google::Apis::PartnersV2::Lead]
1034
+ # @return [Google::Apis::PartnersV2::ExamToken]
1040
1035
  #
1041
1036
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1042
1037
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1043
1038
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1044
- def update_leads(lead_object = nil, request_metadata_partners_session_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, update_mask: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1045
- command = make_simple_command(:patch, 'v2/leads', options)
1046
- command.request_representation = Google::Apis::PartnersV2::Lead::Representation
1047
- command.request_object = lead_object
1048
- command.response_representation = Google::Apis::PartnersV2::Lead::Representation
1049
- command.response_class = Google::Apis::PartnersV2::Lead
1039
+ def get_exam_token(exam_type, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, request_metadata_partners_session_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, quota_user: nil, fields: nil, options: nil, &block)
1040
+ command = make_simple_command(:get, 'v2/exams/{examType}/token', options)
1041
+ command.response_representation = Google::Apis::PartnersV2::ExamToken::Representation
1042
+ command.response_class = Google::Apis::PartnersV2::ExamToken
1043
+ command.params['examType'] = exam_type unless exam_type.nil?
1044
+ command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
1045
+ command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
1050
1046
  command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
1051
1047
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
1052
1048
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
1053
1049
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
1054
1050
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
1055
- command.query['updateMask'] = update_mask unless update_mask.nil?
1056
- command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
1057
- command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
1058
- command.query['fields'] = fields unless fields.nil?
1059
1051
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1052
+ command.query['fields'] = fields unless fields.nil?
1060
1053
  execute_or_queue_command(command, &block)
1061
1054
  end
1062
1055
 
1063
- # Update company.
1056
+ # Lists advertiser leads for a user's associated company.
1064
1057
  # Should only be called within the context of an authorized logged in user.
1065
- # @param [Google::Apis::PartnersV2::Company] company_object
1066
- # @param [String] request_metadata_partners_session_id
1067
- # Google Partners session ID.
1068
1058
  # @param [String] request_metadata_user_overrides_user_id
1069
1059
  # Logged-in user ID to impersonate instead of the user's ID.
1060
+ # @param [String] request_metadata_partners_session_id
1061
+ # Google Partners session ID.
1062
+ # @param [String] page_token
1063
+ # A token identifying a page of results that the server returns.
1064
+ # Typically, this is the value of `ListLeadsResponse.next_page_token`
1065
+ # returned from the previous call to
1066
+ # ListLeads.
1067
+ # @param [Fixnum] page_size
1068
+ # Requested page size. Server may return fewer leads than requested.
1069
+ # If unspecified, server picks an appropriate default.
1070
1070
  # @param [String] request_metadata_traffic_source_traffic_source_id
1071
1071
  # Identifier to indicate where the traffic comes from.
1072
1072
  # An identifier has multiple letters created by a team which redirected the
@@ -1075,48 +1075,48 @@ module Google
1075
1075
  # Locale to use for the current request.
1076
1076
  # @param [String] request_metadata_user_overrides_ip_address
1077
1077
  # IP address to use instead of the user's geo-located IP address.
1078
- # @param [String] update_mask
1079
- # Standard field mask for the set of fields to be updated.
1080
- # Required with at least 1 value in FieldMask's paths.
1081
1078
  # @param [Array<String>, String] request_metadata_experiment_ids
1082
1079
  # Experiment IDs the current request belongs to.
1083
1080
  # @param [String] request_metadata_traffic_source_traffic_sub_id
1084
1081
  # Second level identifier to indicate where the traffic comes from.
1085
1082
  # An identifier has multiple letters created by a team which redirected the
1086
1083
  # traffic to us.
1087
- # @param [String] fields
1088
- # Selector specifying which fields to include in a partial response.
1084
+ # @param [String] order_by
1085
+ # How to order Leads. Currently, only `create_time`
1086
+ # and `create_time desc` are supported
1089
1087
  # @param [String] quota_user
1090
1088
  # Available to use for quota purposes for server-side applications. Can be any
1091
1089
  # arbitrary string assigned to a user, but should not exceed 40 characters.
1090
+ # @param [String] fields
1091
+ # Selector specifying which fields to include in a partial response.
1092
1092
  # @param [Google::Apis::RequestOptions] options
1093
1093
  # Request-specific options
1094
1094
  #
1095
1095
  # @yield [result, err] Result & error if block supplied
1096
- # @yieldparam result [Google::Apis::PartnersV2::Company] parsed result object
1096
+ # @yieldparam result [Google::Apis::PartnersV2::ListLeadsResponse] parsed result object
1097
1097
  # @yieldparam err [StandardError] error object if request failed
1098
1098
  #
1099
- # @return [Google::Apis::PartnersV2::Company]
1099
+ # @return [Google::Apis::PartnersV2::ListLeadsResponse]
1100
1100
  #
1101
1101
  # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1102
1102
  # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1103
1103
  # @raise [Google::Apis::AuthorizationError] Authorization is required
1104
- def update_companies(company_object = nil, request_metadata_partners_session_id: nil, request_metadata_user_overrides_user_id: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, update_mask: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, fields: nil, quota_user: nil, options: nil, &block)
1105
- command = make_simple_command(:patch, 'v2/companies', options)
1106
- command.request_representation = Google::Apis::PartnersV2::Company::Representation
1107
- command.request_object = company_object
1108
- command.response_representation = Google::Apis::PartnersV2::Company::Representation
1109
- command.response_class = Google::Apis::PartnersV2::Company
1110
- command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
1104
+ def list_leads(request_metadata_user_overrides_user_id: nil, request_metadata_partners_session_id: nil, page_token: nil, page_size: nil, request_metadata_traffic_source_traffic_source_id: nil, request_metadata_locale: nil, request_metadata_user_overrides_ip_address: nil, request_metadata_experiment_ids: nil, request_metadata_traffic_source_traffic_sub_id: nil, order_by: nil, quota_user: nil, fields: nil, options: nil, &block)
1105
+ command = make_simple_command(:get, 'v2/leads', options)
1106
+ command.response_representation = Google::Apis::PartnersV2::ListLeadsResponse::Representation
1107
+ command.response_class = Google::Apis::PartnersV2::ListLeadsResponse
1111
1108
  command.query['requestMetadata.userOverrides.userId'] = request_metadata_user_overrides_user_id unless request_metadata_user_overrides_user_id.nil?
1109
+ command.query['requestMetadata.partnersSessionId'] = request_metadata_partners_session_id unless request_metadata_partners_session_id.nil?
1110
+ command.query['pageToken'] = page_token unless page_token.nil?
1111
+ command.query['pageSize'] = page_size unless page_size.nil?
1112
1112
  command.query['requestMetadata.trafficSource.trafficSourceId'] = request_metadata_traffic_source_traffic_source_id unless request_metadata_traffic_source_traffic_source_id.nil?
1113
1113
  command.query['requestMetadata.locale'] = request_metadata_locale unless request_metadata_locale.nil?
1114
1114
  command.query['requestMetadata.userOverrides.ipAddress'] = request_metadata_user_overrides_ip_address unless request_metadata_user_overrides_ip_address.nil?
1115
- command.query['updateMask'] = update_mask unless update_mask.nil?
1116
1115
  command.query['requestMetadata.experimentIds'] = request_metadata_experiment_ids unless request_metadata_experiment_ids.nil?
1117
1116
  command.query['requestMetadata.trafficSource.trafficSubId'] = request_metadata_traffic_source_traffic_sub_id unless request_metadata_traffic_source_traffic_sub_id.nil?
1118
- command.query['fields'] = fields unless fields.nil?
1117
+ command.query['orderBy'] = order_by unless order_by.nil?
1119
1118
  command.query['quotaUser'] = quota_user unless quota_user.nil?
1119
+ command.query['fields'] = fields unless fields.nil?
1120
1120
  execute_or_queue_command(command, &block)
1121
1121
  end
1122
1122