@google-ads/admanager 0.4.1 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (276) hide show
  1. package/README.md +68 -0
  2. package/build/protos/google/ads/admanager/v1/ad_break_service.proto +1 -1
  3. package/build/protos/google/ads/admanager/v1/ad_review_center_ad_enums.proto +44 -0
  4. package/build/protos/google/ads/admanager/v1/ad_review_center_ad_messages.proto +62 -0
  5. package/build/protos/google/ads/admanager/v1/ad_review_center_ad_service.proto +237 -0
  6. package/build/protos/google/ads/admanager/v1/ad_unit_messages.proto +7 -7
  7. package/build/protos/google/ads/admanager/v1/ad_unit_service.proto +6 -6
  8. package/build/protos/google/ads/admanager/v1/application_messages.proto +47 -0
  9. package/build/protos/google/ads/admanager/v1/application_service.proto +129 -0
  10. package/build/protos/google/ads/admanager/v1/audience_segment_messages.proto +49 -0
  11. package/build/protos/google/ads/admanager/v1/audience_segment_service.proto +129 -0
  12. package/build/protos/google/ads/admanager/v1/bandwidth_group_service.proto +3 -3
  13. package/build/protos/google/ads/admanager/v1/browser_language_messages.proto +45 -0
  14. package/build/protos/google/ads/admanager/v1/browser_language_service.proto +129 -0
  15. package/build/protos/google/ads/admanager/v1/browser_messages.proto +51 -0
  16. package/build/protos/google/ads/admanager/v1/browser_service.proto +128 -0
  17. package/build/protos/google/ads/admanager/v1/cms_metadata_key_enums.proto +41 -0
  18. package/build/protos/google/ads/admanager/v1/cms_metadata_key_messages.proto +50 -0
  19. package/build/protos/google/ads/admanager/v1/cms_metadata_key_service.proto +129 -0
  20. package/build/protos/google/ads/admanager/v1/cms_metadata_value_enums.proto +44 -0
  21. package/build/protos/google/ads/admanager/v1/cms_metadata_value_messages.proto +61 -0
  22. package/build/protos/google/ads/admanager/v1/cms_metadata_value_service.proto +130 -0
  23. package/build/protos/google/ads/admanager/v1/company_messages.proto +14 -12
  24. package/build/protos/google/ads/admanager/v1/company_service.proto +3 -3
  25. package/build/protos/google/ads/admanager/v1/contact_enums.proto +57 -0
  26. package/build/protos/google/ads/admanager/v1/contact_messages.proto +45 -2
  27. package/build/protos/google/ads/admanager/v1/contact_service.proto +244 -0
  28. package/build/protos/google/ads/admanager/v1/content_bundle_messages.proto +53 -0
  29. package/build/protos/google/ads/admanager/v1/content_bundle_service.proto +129 -0
  30. package/build/protos/google/ads/admanager/v1/content_label_messages.proto +45 -0
  31. package/build/protos/google/ads/admanager/v1/content_label_service.proto +129 -0
  32. package/build/protos/google/ads/admanager/v1/content_messages.proto +45 -0
  33. package/build/protos/google/ads/admanager/v1/content_service.proto +128 -0
  34. package/build/protos/google/ads/admanager/v1/creative_template_enums.proto +63 -0
  35. package/build/protos/google/ads/admanager/v1/creative_template_messages.proto +253 -0
  36. package/build/protos/google/ads/admanager/v1/creative_template_service.proto +130 -0
  37. package/build/protos/google/ads/admanager/v1/creative_template_variable_url_type_enum.proto +47 -0
  38. package/build/protos/google/ads/admanager/v1/custom_field_messages.proto +5 -2
  39. package/build/protos/google/ads/admanager/v1/custom_field_service.proto +185 -3
  40. package/build/protos/google/ads/admanager/v1/custom_targeting_key_messages.proto +7 -6
  41. package/build/protos/google/ads/admanager/v1/custom_targeting_key_service.proto +1 -1
  42. package/build/protos/google/ads/admanager/v1/custom_targeting_value_messages.proto +9 -9
  43. package/build/protos/google/ads/admanager/v1/custom_targeting_value_service.proto +1 -1
  44. package/build/protos/google/ads/admanager/v1/device_capability_messages.proto +45 -0
  45. package/build/protos/google/ads/admanager/v1/device_capability_service.proto +130 -0
  46. package/build/protos/google/ads/admanager/v1/device_category_service.proto +2 -2
  47. package/build/protos/google/ads/admanager/v1/device_manufacturer_messages.proto +46 -0
  48. package/build/protos/google/ads/admanager/v1/device_manufacturer_service.proto +131 -0
  49. package/build/protos/google/ads/admanager/v1/entity_signals_mapping_service.proto +1 -1
  50. package/build/protos/google/ads/admanager/v1/exchange_syndication_product_enum.proto +47 -0
  51. package/build/protos/google/ads/admanager/v1/geo_target_service.proto +3 -3
  52. package/build/protos/google/ads/admanager/v1/mobile_carrier_messages.proto +48 -0
  53. package/build/protos/google/ads/admanager/v1/mobile_carrier_service.proto +129 -0
  54. package/build/protos/google/ads/admanager/v1/mobile_device_messages.proto +54 -0
  55. package/build/protos/google/ads/admanager/v1/mobile_device_service.proto +129 -0
  56. package/build/protos/google/ads/admanager/v1/mobile_device_submodel_messages.proto +55 -0
  57. package/build/protos/google/ads/admanager/v1/mobile_device_submodel_service.proto +133 -0
  58. package/build/protos/google/ads/admanager/v1/operating_system_service.proto +2 -2
  59. package/build/protos/google/ads/admanager/v1/operating_system_version_service.proto +2 -2
  60. package/build/protos/google/ads/admanager/v1/order_messages.proto +7 -8
  61. package/build/protos/google/ads/admanager/v1/order_service.proto +3 -3
  62. package/build/protos/google/ads/admanager/v1/placement_service.proto +220 -3
  63. package/build/protos/google/ads/admanager/v1/private_auction_deal_service.proto +2 -2
  64. package/build/protos/google/ads/admanager/v1/private_auction_service.proto +2 -2
  65. package/build/protos/google/ads/admanager/v1/programmatic_buyer_service.proto +1 -1
  66. package/build/protos/google/ads/admanager/v1/report_definition.proto +12478 -0
  67. package/build/protos/google/ads/admanager/v1/report_messages.proto +118 -3410
  68. package/build/protos/google/ads/admanager/v1/report_service.proto +10 -8
  69. package/build/protos/google/ads/admanager/v1/report_value.proto +73 -0
  70. package/build/protos/google/ads/admanager/v1/role_service.proto +3 -2
  71. package/build/protos/google/ads/admanager/v1/site_enums.proto +72 -0
  72. package/build/protos/google/ads/admanager/v1/site_messages.proto +77 -0
  73. package/build/protos/google/ads/admanager/v1/site_service.proto +295 -0
  74. package/build/protos/google/ads/admanager/v1/targeting.proto +311 -0
  75. package/build/protos/google/ads/admanager/v1/taxonomy_category_service.proto +1 -1
  76. package/build/protos/google/ads/admanager/v1/taxonomy_type_enum.proto +3 -0
  77. package/build/protos/google/ads/admanager/v1/team_enums.proto +62 -0
  78. package/build/protos/google/ads/admanager/v1/team_messages.proto +30 -0
  79. package/build/protos/google/ads/admanager/v1/team_service.proto +303 -0
  80. package/build/protos/google/ads/admanager/v1/web_property.proto +54 -0
  81. package/build/protos/protos.d.ts +30764 -11410
  82. package/build/protos/protos.js +93644 -43318
  83. package/build/protos/protos.json +9909 -3734
  84. package/build/src/index.d.ts +58 -1
  85. package/build/src/index.js +40 -2
  86. package/build/src/index.js.map +1 -1
  87. package/build/src/v1/ad_break_service_client.d.ts +441 -0
  88. package/build/src/v1/ad_break_service_client.js +624 -0
  89. package/build/src/v1/ad_break_service_client.js.map +1 -1
  90. package/build/src/v1/ad_break_service_proto_list.json +49 -1
  91. package/build/src/v1/ad_review_center_ad_service_client.d.ts +1607 -0
  92. package/build/src/v1/ad_review_center_ad_service_client.js +2291 -0
  93. package/build/src/v1/ad_review_center_ad_service_client.js.map +1 -0
  94. package/build/src/v1/ad_review_center_ad_service_client_config.json +38 -0
  95. package/build/src/v1/ad_review_center_ad_service_proto_list.json +122 -0
  96. package/build/src/v1/ad_unit_service_client.d.ts +453 -12
  97. package/build/src/v1/ad_unit_service_client.js +632 -8
  98. package/build/src/v1/ad_unit_service_client.js.map +1 -1
  99. package/build/src/v1/ad_unit_service_proto_list.json +49 -1
  100. package/build/src/v1/application_service_client.d.ts +1345 -0
  101. package/build/src/v1/application_service_client.js +1993 -0
  102. package/build/src/v1/application_service_client.js.map +1 -0
  103. package/build/src/v1/application_service_client_config.json +34 -0
  104. package/build/src/v1/application_service_proto_list.json +122 -0
  105. package/build/src/v1/audience_segment_service_client.d.ts +1345 -0
  106. package/build/src/v1/audience_segment_service_client.js +1993 -0
  107. package/build/src/v1/audience_segment_service_client.js.map +1 -0
  108. package/build/src/v1/audience_segment_service_client_config.json +34 -0
  109. package/build/src/v1/audience_segment_service_proto_list.json +122 -0
  110. package/build/src/v1/bandwidth_group_service_client.d.ts +447 -6
  111. package/build/src/v1/bandwidth_group_service_client.js +628 -4
  112. package/build/src/v1/bandwidth_group_service_client.js.map +1 -1
  113. package/build/src/v1/bandwidth_group_service_proto_list.json +49 -1
  114. package/build/src/v1/browser_language_service_client.d.ts +1345 -0
  115. package/build/src/v1/browser_language_service_client.js +1993 -0
  116. package/build/src/v1/browser_language_service_client.js.map +1 -0
  117. package/build/src/v1/browser_language_service_client_config.json +34 -0
  118. package/build/src/v1/browser_language_service_proto_list.json +122 -0
  119. package/build/src/v1/browser_service_client.d.ts +1345 -0
  120. package/build/src/v1/browser_service_client.js +1993 -0
  121. package/build/src/v1/browser_service_client.js.map +1 -0
  122. package/build/src/v1/browser_service_client_config.json +34 -0
  123. package/build/src/v1/browser_service_proto_list.json +122 -0
  124. package/build/src/v1/cms_metadata_key_service_client.d.ts +1345 -0
  125. package/build/src/v1/cms_metadata_key_service_client.js +1993 -0
  126. package/build/src/v1/cms_metadata_key_service_client.js.map +1 -0
  127. package/build/src/v1/cms_metadata_key_service_client_config.json +34 -0
  128. package/build/src/v1/cms_metadata_key_service_proto_list.json +122 -0
  129. package/build/src/v1/cms_metadata_value_service_client.d.ts +1345 -0
  130. package/build/src/v1/cms_metadata_value_service_client.js +1993 -0
  131. package/build/src/v1/cms_metadata_value_service_client.js.map +1 -0
  132. package/build/src/v1/cms_metadata_value_service_client_config.json +34 -0
  133. package/build/src/v1/cms_metadata_value_service_proto_list.json +122 -0
  134. package/build/src/v1/company_service_client.d.ts +447 -6
  135. package/build/src/v1/company_service_client.js +628 -4
  136. package/build/src/v1/company_service_client.js.map +1 -1
  137. package/build/src/v1/company_service_proto_list.json +49 -1
  138. package/build/src/v1/contact_service_client.d.ts +1456 -0
  139. package/build/src/v1/contact_service_client.js +2137 -0
  140. package/build/src/v1/contact_service_client.js.map +1 -0
  141. package/build/src/v1/contact_service_client_config.json +50 -0
  142. package/build/src/v1/contact_service_proto_list.json +122 -0
  143. package/build/src/v1/content_bundle_service_client.d.ts +1345 -0
  144. package/build/src/v1/content_bundle_service_client.js +1993 -0
  145. package/build/src/v1/content_bundle_service_client.js.map +1 -0
  146. package/build/src/v1/content_bundle_service_client_config.json +34 -0
  147. package/build/src/v1/content_bundle_service_proto_list.json +122 -0
  148. package/build/src/v1/content_label_service_client.d.ts +1345 -0
  149. package/build/src/v1/content_label_service_client.js +1993 -0
  150. package/build/src/v1/content_label_service_client.js.map +1 -0
  151. package/build/src/v1/content_label_service_client_config.json +34 -0
  152. package/build/src/v1/content_label_service_proto_list.json +122 -0
  153. package/build/src/v1/content_service_client.d.ts +1345 -0
  154. package/build/src/v1/content_service_client.js +1993 -0
  155. package/build/src/v1/content_service_client.js.map +1 -0
  156. package/build/src/v1/content_service_client_config.json +34 -0
  157. package/build/src/v1/content_service_proto_list.json +122 -0
  158. package/build/src/v1/creative_template_service_client.d.ts +1345 -0
  159. package/build/src/v1/creative_template_service_client.js +1993 -0
  160. package/build/src/v1/creative_template_service_client.js.map +1 -0
  161. package/build/src/v1/creative_template_service_client_config.json +34 -0
  162. package/build/src/v1/creative_template_service_proto_list.json +122 -0
  163. package/build/src/v1/custom_field_service_client.d.ts +610 -6
  164. package/build/src/v1/custom_field_service_client.js +845 -5
  165. package/build/src/v1/custom_field_service_client.js.map +1 -1
  166. package/build/src/v1/custom_field_service_client_config.json +24 -0
  167. package/build/src/v1/custom_field_service_proto_list.json +49 -1
  168. package/build/src/v1/custom_targeting_key_service_client.d.ts +441 -0
  169. package/build/src/v1/custom_targeting_key_service_client.js +624 -0
  170. package/build/src/v1/custom_targeting_key_service_client.js.map +1 -1
  171. package/build/src/v1/custom_targeting_key_service_proto_list.json +49 -1
  172. package/build/src/v1/custom_targeting_value_service_client.d.ts +441 -0
  173. package/build/src/v1/custom_targeting_value_service_client.js +624 -0
  174. package/build/src/v1/custom_targeting_value_service_client.js.map +1 -1
  175. package/build/src/v1/custom_targeting_value_service_proto_list.json +49 -1
  176. package/build/src/v1/device_capability_service_client.d.ts +1345 -0
  177. package/build/src/v1/device_capability_service_client.js +1993 -0
  178. package/build/src/v1/device_capability_service_client.js.map +1 -0
  179. package/build/src/v1/device_capability_service_client_config.json +34 -0
  180. package/build/src/v1/device_capability_service_proto_list.json +122 -0
  181. package/build/src/v1/device_category_service_client.d.ts +444 -3
  182. package/build/src/v1/device_category_service_client.js +626 -2
  183. package/build/src/v1/device_category_service_client.js.map +1 -1
  184. package/build/src/v1/device_category_service_proto_list.json +49 -1
  185. package/build/src/v1/device_manufacturer_service_client.d.ts +1346 -0
  186. package/build/src/v1/device_manufacturer_service_client.js +1993 -0
  187. package/build/src/v1/device_manufacturer_service_client.js.map +1 -0
  188. package/build/src/v1/device_manufacturer_service_client_config.json +34 -0
  189. package/build/src/v1/device_manufacturer_service_proto_list.json +122 -0
  190. package/build/src/v1/entity_signals_mapping_service_client.d.ts +441 -0
  191. package/build/src/v1/entity_signals_mapping_service_client.js +624 -0
  192. package/build/src/v1/entity_signals_mapping_service_client.js.map +1 -1
  193. package/build/src/v1/entity_signals_mapping_service_proto_list.json +49 -1
  194. package/build/src/v1/gapic_metadata.json +1026 -4
  195. package/build/src/v1/geo_target_service_client.d.ts +447 -6
  196. package/build/src/v1/geo_target_service_client.js +628 -4
  197. package/build/src/v1/geo_target_service_client.js.map +1 -1
  198. package/build/src/v1/geo_target_service_proto_list.json +49 -1
  199. package/build/src/v1/index.d.ts +19 -0
  200. package/build/src/v1/index.js +39 -1
  201. package/build/src/v1/index.js.map +1 -1
  202. package/build/src/v1/mobile_carrier_service_client.d.ts +1345 -0
  203. package/build/src/v1/mobile_carrier_service_client.js +1993 -0
  204. package/build/src/v1/mobile_carrier_service_client.js.map +1 -0
  205. package/build/src/v1/mobile_carrier_service_client_config.json +34 -0
  206. package/build/src/v1/mobile_carrier_service_proto_list.json +122 -0
  207. package/build/src/v1/mobile_device_service_client.d.ts +1345 -0
  208. package/build/src/v1/mobile_device_service_client.js +1993 -0
  209. package/build/src/v1/mobile_device_service_client.js.map +1 -0
  210. package/build/src/v1/mobile_device_service_client_config.json +34 -0
  211. package/build/src/v1/mobile_device_service_proto_list.json +122 -0
  212. package/build/src/v1/mobile_device_submodel_service_client.d.ts +1352 -0
  213. package/build/src/v1/mobile_device_submodel_service_client.js +1997 -0
  214. package/build/src/v1/mobile_device_submodel_service_client.js.map +1 -0
  215. package/build/src/v1/mobile_device_submodel_service_client_config.json +34 -0
  216. package/build/src/v1/mobile_device_submodel_service_proto_list.json +122 -0
  217. package/build/src/v1/network_service_client.d.ts +441 -0
  218. package/build/src/v1/network_service_client.js +624 -0
  219. package/build/src/v1/network_service_client.js.map +1 -1
  220. package/build/src/v1/network_service_proto_list.json +49 -1
  221. package/build/src/v1/operating_system_service_client.d.ts +444 -3
  222. package/build/src/v1/operating_system_service_client.js +626 -2
  223. package/build/src/v1/operating_system_service_client.js.map +1 -1
  224. package/build/src/v1/operating_system_service_proto_list.json +49 -1
  225. package/build/src/v1/operating_system_version_service_client.d.ts +444 -3
  226. package/build/src/v1/operating_system_version_service_client.js +626 -2
  227. package/build/src/v1/operating_system_version_service_client.js.map +1 -1
  228. package/build/src/v1/operating_system_version_service_proto_list.json +49 -1
  229. package/build/src/v1/order_service_client.d.ts +447 -6
  230. package/build/src/v1/order_service_client.js +628 -4
  231. package/build/src/v1/order_service_client.js.map +1 -1
  232. package/build/src/v1/order_service_proto_list.json +49 -1
  233. package/build/src/v1/placement_service_client.d.ts +638 -6
  234. package/build/src/v1/placement_service_client.js +937 -61
  235. package/build/src/v1/placement_service_client.js.map +1 -1
  236. package/build/src/v1/placement_service_client_config.json +28 -0
  237. package/build/src/v1/placement_service_proto_list.json +49 -1
  238. package/build/src/v1/private_auction_deal_service_client.d.ts +444 -3
  239. package/build/src/v1/private_auction_deal_service_client.js +626 -2
  240. package/build/src/v1/private_auction_deal_service_client.js.map +1 -1
  241. package/build/src/v1/private_auction_deal_service_proto_list.json +49 -1
  242. package/build/src/v1/private_auction_service_client.d.ts +444 -3
  243. package/build/src/v1/private_auction_service_client.js +626 -2
  244. package/build/src/v1/private_auction_service_client.js.map +1 -1
  245. package/build/src/v1/private_auction_service_proto_list.json +49 -1
  246. package/build/src/v1/programmatic_buyer_service_client.d.ts +441 -0
  247. package/build/src/v1/programmatic_buyer_service_client.js +624 -0
  248. package/build/src/v1/programmatic_buyer_service_client.js.map +1 -1
  249. package/build/src/v1/programmatic_buyer_service_proto_list.json +49 -1
  250. package/build/src/v1/report_service_client.d.ts +461 -17
  251. package/build/src/v1/report_service_client.js +634 -8
  252. package/build/src/v1/report_service_client.js.map +1 -1
  253. package/build/src/v1/report_service_proto_list.json +49 -1
  254. package/build/src/v1/role_service_client.d.ts +447 -3
  255. package/build/src/v1/role_service_client.js +628 -2
  256. package/build/src/v1/role_service_client.js.map +1 -1
  257. package/build/src/v1/role_service_proto_list.json +49 -1
  258. package/build/src/v1/site_service_client.d.ts +1506 -0
  259. package/build/src/v1/site_service_client.js +2209 -0
  260. package/build/src/v1/site_service_client.js.map +1 -0
  261. package/build/src/v1/site_service_client_config.json +58 -0
  262. package/build/src/v1/site_service_proto_list.json +122 -0
  263. package/build/src/v1/taxonomy_category_service_client.d.ts +441 -0
  264. package/build/src/v1/taxonomy_category_service_client.js +624 -0
  265. package/build/src/v1/taxonomy_category_service_client.js.map +1 -1
  266. package/build/src/v1/taxonomy_category_service_proto_list.json +49 -1
  267. package/build/src/v1/team_service_client.d.ts +1508 -0
  268. package/build/src/v1/team_service_client.js +2209 -0
  269. package/build/src/v1/team_service_client.js.map +1 -0
  270. package/build/src/v1/team_service_client_config.json +58 -0
  271. package/build/src/v1/team_service_proto_list.json +122 -0
  272. package/build/src/v1/user_service_client.d.ts +441 -0
  273. package/build/src/v1/user_service_client.js +624 -0
  274. package/build/src/v1/user_service_client.js.map +1 -1
  275. package/build/src/v1/user_service_proto_list.json +49 -1
  276. package/package.json +1 -1
@@ -0,0 +1,1993 @@
1
+ "use strict";
2
+ // Copyright 2025 Google LLC
3
+ //
4
+ // Licensed under the Apache License, Version 2.0 (the "License");
5
+ // you may not use this file except in compliance with the License.
6
+ // You may obtain a copy of the License at
7
+ //
8
+ // https://www.apache.org/licenses/LICENSE-2.0
9
+ //
10
+ // Unless required by applicable law or agreed to in writing, software
11
+ // distributed under the License is distributed on an "AS IS" BASIS,
12
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ // See the License for the specific language governing permissions and
14
+ // limitations under the License.
15
+ //
16
+ // ** This file is automatically generated by gapic-generator-typescript. **
17
+ // ** https://github.com/googleapis/gapic-generator-typescript **
18
+ // ** All changes to this file may be overwritten. **
19
+ Object.defineProperty(exports, "__esModule", { value: true });
20
+ exports.CmsMetadataValueServiceClient = void 0;
21
+ const jsonProtos = require("../../protos/protos.json");
22
+ const google_gax_1 = require("google-gax");
23
+ /**
24
+ * Client JSON configuration object, loaded from
25
+ * `src/v1/cms_metadata_value_service_client_config.json`.
26
+ * This file defines retry strategy and timeouts for all API methods in this library.
27
+ */
28
+ const gapicConfig = require("./cms_metadata_value_service_client_config.json");
29
+ const version = require('../../../package.json').version;
30
+ /**
31
+ * Provides methods for handling `CmsMetadataValue` objects.
32
+ * @class
33
+ * @memberof v1
34
+ */
35
+ class CmsMetadataValueServiceClient {
36
+ _terminated = false;
37
+ _opts;
38
+ _providedCustomServicePath;
39
+ _gaxModule;
40
+ _gaxGrpc;
41
+ _protos;
42
+ _defaults;
43
+ _universeDomain;
44
+ _servicePath;
45
+ _log = google_gax_1.loggingUtils.log('admanager');
46
+ auth;
47
+ descriptors = {
48
+ page: {},
49
+ stream: {},
50
+ longrunning: {},
51
+ batching: {},
52
+ };
53
+ warn;
54
+ innerApiCalls;
55
+ pathTemplates;
56
+ cmsMetadataValueServiceStub;
57
+ /**
58
+ * Construct an instance of CmsMetadataValueServiceClient.
59
+ *
60
+ * @param {object} [options] - The configuration object.
61
+ * The options accepted by the constructor are described in detail
62
+ * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
63
+ * The common options are:
64
+ * @param {object} [options.credentials] - Credentials object.
65
+ * @param {string} [options.credentials.client_email]
66
+ * @param {string} [options.credentials.private_key]
67
+ * @param {string} [options.email] - Account email address. Required when
68
+ * using a .pem or .p12 keyFilename.
69
+ * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
70
+ * .p12 key downloaded from the Google Developers Console. If you provide
71
+ * a path to a JSON file, the projectId option below is not necessary.
72
+ * NOTE: .pem and .p12 require you to specify options.email as well.
73
+ * @param {number} [options.port] - The port on which to connect to
74
+ * the remote host.
75
+ * @param {string} [options.projectId] - The project ID from the Google
76
+ * Developer's Console, e.g. 'grape-spaceship-123'. We will also check
77
+ * the environment variable GCLOUD_PROJECT for your project ID. If your
78
+ * app is running in an environment which supports
79
+ * {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
80
+ * your project ID will be detected automatically.
81
+ * @param {string} [options.apiEndpoint] - The domain name of the
82
+ * API remote host.
83
+ * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
84
+ * Follows the structure of {@link gapicConfig}.
85
+ * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
86
+ * For more information, please check the
87
+ * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
88
+ * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
89
+ * need to avoid loading the default gRPC version and want to use the fallback
90
+ * HTTP implementation. Load only fallback version and pass it to the constructor:
91
+ * ```
92
+ * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
93
+ * const client = new CmsMetadataValueServiceClient({fallback: true}, gax);
94
+ * ```
95
+ */
96
+ constructor(opts, gaxInstance) {
97
+ // Ensure that options include all the required fields.
98
+ const staticMembers = this.constructor;
99
+ if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
100
+ throw new Error('Please set either universe_domain or universeDomain, but not both.');
101
+ }
102
+ const universeDomainEnvVar = (typeof process === 'object' && typeof process.env === 'object') ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN'] : undefined;
103
+ this._universeDomain = opts?.universeDomain ?? opts?.universe_domain ?? universeDomainEnvVar ?? 'googleapis.com';
104
+ this._servicePath = 'admanager.' + this._universeDomain;
105
+ const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
106
+ this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
107
+ const port = opts?.port || staticMembers.port;
108
+ const clientConfig = opts?.clientConfig ?? {};
109
+ // Implicitly enable HTTP transport for the APIs that use REST as transport (e.g. Google Cloud Compute).
110
+ if (!opts) {
111
+ opts = { fallback: true };
112
+ }
113
+ else {
114
+ opts.fallback = opts.fallback ?? true;
115
+ }
116
+ const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
117
+ opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
118
+ // Request numeric enum values if REST transport is used.
119
+ opts.numericEnums = true;
120
+ // If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
121
+ if (servicePath !== this._servicePath && !('scopes' in opts)) {
122
+ opts['scopes'] = staticMembers.scopes;
123
+ }
124
+ // Load google-gax module synchronously if needed
125
+ if (!gaxInstance) {
126
+ gaxInstance = require('google-gax');
127
+ }
128
+ // Choose either gRPC or proto-over-HTTP implementation of google-gax.
129
+ this._gaxModule = opts.fallback ? gaxInstance.fallback : gaxInstance;
130
+ // Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
131
+ this._gaxGrpc = new this._gaxModule.GrpcClient(opts);
132
+ // Save options to use in initialize() method.
133
+ this._opts = opts;
134
+ // Save the auth object to the client, for use by other methods.
135
+ this.auth = this._gaxGrpc.auth;
136
+ // Set useJWTAccessWithScope on the auth object.
137
+ this.auth.useJWTAccessWithScope = true;
138
+ // Set defaultServicePath on the auth object.
139
+ this.auth.defaultServicePath = this._servicePath;
140
+ // Set the default scopes in auth client if needed.
141
+ if (servicePath === this._servicePath) {
142
+ this.auth.defaultScopes = staticMembers.scopes;
143
+ }
144
+ // Determine the client header string.
145
+ const clientHeader = [
146
+ `gax/${this._gaxModule.version}`,
147
+ `gapic/${version}`,
148
+ ];
149
+ if (typeof process === 'object' && 'versions' in process) {
150
+ clientHeader.push(`gl-node/${process.versions.node}`);
151
+ }
152
+ else {
153
+ clientHeader.push(`gl-web/${this._gaxModule.version}`);
154
+ }
155
+ if (!opts.fallback) {
156
+ clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
157
+ }
158
+ else {
159
+ clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
160
+ }
161
+ if (opts.libName && opts.libVersion) {
162
+ clientHeader.push(`${opts.libName}/${opts.libVersion}`);
163
+ }
164
+ // Load the applicable protos.
165
+ this._protos = this._gaxGrpc.loadProtoJSON(jsonProtos);
166
+ // This API contains "path templates"; forward-slash-separated
167
+ // identifiers to uniquely identify resources within the API.
168
+ // Create useful helper objects for these.
169
+ this.pathTemplates = {
170
+ adBreakPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}'),
171
+ adReviewCenterAdPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/webProperties/{web_property_code}/adReviewCenterAds/{ad_review_center_ad}'),
172
+ adUnitPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/adUnits/{ad_unit}'),
173
+ applicationPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/applications/{application}'),
174
+ audienceSegmentPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/audienceSegments/{audience_segment}'),
175
+ bandwidthGroupPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/bandwidthGroups/{bandwidth_group}'),
176
+ browserPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/browsers/{browser}'),
177
+ browserLanguagePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/browserLanguages/{browser_language}'),
178
+ cmsMetadataKeyPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/cmsMetadataKeys/{cms_metadata_key}'),
179
+ cmsMetadataValuePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/cmsMetadataValues/{cms_metadata_value}'),
180
+ companyPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/companies/{company}'),
181
+ contactPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/contacts/{contact}'),
182
+ contentPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/content/{content}'),
183
+ contentBundlePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/contentBundles/{content_bundle}'),
184
+ contentLabelPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/contentLabels/{content_label}'),
185
+ creativeTemplatePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/creativeTemplates/{creative_template}'),
186
+ customFieldPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/customFields/{custom_field}'),
187
+ customTargetingKeyPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/customTargetingKeys/{custom_targeting_key}'),
188
+ customTargetingValuePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/customTargetingValues/{custom_targeting_value}'),
189
+ deviceCapabilityPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/deviceCapabilities/{device_capability}'),
190
+ deviceCategoryPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/deviceCategories/{device_category}'),
191
+ deviceManufacturerPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/deviceManufacturers/{device_manufacturer}'),
192
+ entitySignalsMappingPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}'),
193
+ geoTargetPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/geoTargets/{geo_target}'),
194
+ labelPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/labels/{label}'),
195
+ liveStreamEventPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/liveStreamEvents/{live_stream_event}'),
196
+ mobileCarrierPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/mobileCarriers/{mobile_carrier}'),
197
+ mobileDevicePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/mobileDevices/{mobile_device}'),
198
+ mobileDeviceSubmodelPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/mobileDeviceSubmodels/{mobile_device_submodel}'),
199
+ networkPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}'),
200
+ operatingSystemPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/operatingSystems/{operating_system}'),
201
+ operatingSystemVersionPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/operatingSystemVersions/{operating_system_version}'),
202
+ orderPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/orders/{order}'),
203
+ placementPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/placements/{placement}'),
204
+ privateAuctionPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/privateAuctions/{private_auction}'),
205
+ privateAuctionDealPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/privateAuctionDeals/{private_auction_deal}'),
206
+ programmaticBuyerPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/programmaticBuyers/{programmatic_buyer}'),
207
+ reportPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/reports/{report}'),
208
+ rolePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/roles/{role}'),
209
+ sitePathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/sites/{site}'),
210
+ taxonomyCategoryPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/taxonomyCategories/{taxonomy_category}'),
211
+ teamPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/teams/{team}'),
212
+ userPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/users/{user}'),
213
+ webPropertyPathTemplate: new this._gaxModule.PathTemplate('networks/{network_code}/webProperties/{web_property}'),
214
+ };
215
+ // Some of the methods on this service return "paged" results,
216
+ // (e.g. 50 results at a time, with tokens to get subsequent
217
+ // pages). Denote the keys used for pagination and results.
218
+ this.descriptors.page = {
219
+ listCmsMetadataValues: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'cmsMetadataValues')
220
+ };
221
+ // Put together the default options sent with requests.
222
+ this._defaults = this._gaxGrpc.constructSettings('google.ads.admanager.v1.CmsMetadataValueService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
223
+ // Set up a dictionary of "inner API calls"; the core implementation
224
+ // of calling the API is handled in `google-gax`, with this code
225
+ // merely providing the destination and request information.
226
+ this.innerApiCalls = {};
227
+ // Add a warn function to the client constructor so it can be easily tested.
228
+ this.warn = this._gaxModule.warn;
229
+ }
230
+ /**
231
+ * Initialize the client.
232
+ * Performs asynchronous operations (such as authentication) and prepares the client.
233
+ * This function will be called automatically when any class method is called for the
234
+ * first time, but if you need to initialize it before calling an actual method,
235
+ * feel free to call initialize() directly.
236
+ *
237
+ * You can await on this method if you want to make sure the client is initialized.
238
+ *
239
+ * @returns {Promise} A promise that resolves to an authenticated service stub.
240
+ */
241
+ initialize() {
242
+ // If the client stub promise is already initialized, return immediately.
243
+ if (this.cmsMetadataValueServiceStub) {
244
+ return this.cmsMetadataValueServiceStub;
245
+ }
246
+ // Put together the "service stub" for
247
+ // google.ads.admanager.v1.CmsMetadataValueService.
248
+ this.cmsMetadataValueServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
249
+ this._protos.lookupService('google.ads.admanager.v1.CmsMetadataValueService') :
250
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
251
+ this._protos.google.ads.admanager.v1.CmsMetadataValueService, this._opts, this._providedCustomServicePath);
252
+ // Iterate over each of the methods that the service provides
253
+ // and create an API call method for each.
254
+ const cmsMetadataValueServiceStubMethods = ['getCmsMetadataValue', 'listCmsMetadataValues'];
255
+ for (const methodName of cmsMetadataValueServiceStubMethods) {
256
+ const callPromise = this.cmsMetadataValueServiceStub.then(stub => (...args) => {
257
+ if (this._terminated) {
258
+ return Promise.reject('The client has already been closed.');
259
+ }
260
+ const func = stub[methodName];
261
+ return func.apply(stub, args);
262
+ }, (err) => () => {
263
+ throw err;
264
+ });
265
+ const descriptor = this.descriptors.page[methodName] ||
266
+ undefined;
267
+ const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
268
+ this.innerApiCalls[methodName] = apiCall;
269
+ }
270
+ return this.cmsMetadataValueServiceStub;
271
+ }
272
+ /**
273
+ * The DNS address for this API service.
274
+ * @deprecated Use the apiEndpoint method of the client instance.
275
+ * @returns {string} The DNS address for this service.
276
+ */
277
+ static get servicePath() {
278
+ if (typeof process === 'object' && typeof process.emitWarning === 'function') {
279
+ process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
280
+ }
281
+ return 'admanager.googleapis.com';
282
+ }
283
+ /**
284
+ * The DNS address for this API service - same as servicePath.
285
+ * @deprecated Use the apiEndpoint method of the client instance.
286
+ * @returns {string} The DNS address for this service.
287
+ */
288
+ static get apiEndpoint() {
289
+ if (typeof process === 'object' && typeof process.emitWarning === 'function') {
290
+ process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
291
+ }
292
+ return 'admanager.googleapis.com';
293
+ }
294
+ /**
295
+ * The DNS address for this API service.
296
+ * @returns {string} The DNS address for this service.
297
+ */
298
+ get apiEndpoint() {
299
+ return this._servicePath;
300
+ }
301
+ get universeDomain() {
302
+ return this._universeDomain;
303
+ }
304
+ /**
305
+ * The port for this API service.
306
+ * @returns {number} The default port for this service.
307
+ */
308
+ static get port() {
309
+ return 443;
310
+ }
311
+ /**
312
+ * The scopes needed to make gRPC calls for every method defined
313
+ * in this service.
314
+ * @returns {string[]} List of default scopes.
315
+ */
316
+ static get scopes() {
317
+ return [
318
+ 'https://www.googleapis.com/auth/admanager'
319
+ ];
320
+ }
321
+ /**
322
+ * Return the project ID used by this class.
323
+ * @returns {Promise} A promise that resolves to string containing the project ID.
324
+ */
325
+ getProjectId(callback) {
326
+ if (callback) {
327
+ this.auth.getProjectId(callback);
328
+ return;
329
+ }
330
+ return this.auth.getProjectId();
331
+ }
332
+ getCmsMetadataValue(request, optionsOrCallback, callback) {
333
+ request = request || {};
334
+ let options;
335
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
336
+ callback = optionsOrCallback;
337
+ options = {};
338
+ }
339
+ else {
340
+ options = optionsOrCallback;
341
+ }
342
+ options = options || {};
343
+ options.otherArgs = options.otherArgs || {};
344
+ options.otherArgs.headers = options.otherArgs.headers || {};
345
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
346
+ 'name': request.name ?? '',
347
+ });
348
+ this.initialize().catch(err => { throw err; });
349
+ this._log.info('getCmsMetadataValue request %j', request);
350
+ const wrappedCallback = callback
351
+ ? (error, response, options, rawResponse) => {
352
+ this._log.info('getCmsMetadataValue response %j', response);
353
+ callback(error, response, options, rawResponse); // We verified callback above.
354
+ }
355
+ : undefined;
356
+ return this.innerApiCalls.getCmsMetadataValue(request, options, wrappedCallback)
357
+ ?.then(([response, options, rawResponse]) => {
358
+ this._log.info('getCmsMetadataValue response %j', response);
359
+ return [response, options, rawResponse];
360
+ }).catch((error) => {
361
+ if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
362
+ const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
363
+ error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
364
+ }
365
+ throw error;
366
+ });
367
+ }
368
+ listCmsMetadataValues(request, optionsOrCallback, callback) {
369
+ request = request || {};
370
+ let options;
371
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
372
+ callback = optionsOrCallback;
373
+ options = {};
374
+ }
375
+ else {
376
+ options = optionsOrCallback;
377
+ }
378
+ options = options || {};
379
+ options.otherArgs = options.otherArgs || {};
380
+ options.otherArgs.headers = options.otherArgs.headers || {};
381
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
382
+ 'parent': request.parent ?? '',
383
+ });
384
+ this.initialize().catch(err => { throw err; });
385
+ const wrappedCallback = callback
386
+ ? (error, values, nextPageRequest, rawResponse) => {
387
+ this._log.info('listCmsMetadataValues values %j', values);
388
+ callback(error, values, nextPageRequest, rawResponse); // We verified callback above.
389
+ }
390
+ : undefined;
391
+ this._log.info('listCmsMetadataValues request %j', request);
392
+ return this.innerApiCalls
393
+ .listCmsMetadataValues(request, options, wrappedCallback)
394
+ ?.then(([response, input, output]) => {
395
+ this._log.info('listCmsMetadataValues values %j', response);
396
+ return [response, input, output];
397
+ });
398
+ }
399
+ /**
400
+ * Equivalent to `listCmsMetadataValues`, but returns a NodeJS Stream object.
401
+ * @param {Object} request
402
+ * The request object that will be sent.
403
+ * @param {string} request.parent
404
+ * Required. The parent, which owns this collection of CmsMetadataValues.
405
+ * Format: `networks/{network_code}`
406
+ * @param {number} [request.pageSize]
407
+ * Optional. The maximum number of `CmsMetadataValues` to return. The service
408
+ * may return fewer than this value. If unspecified, at most 50
409
+ * `CmsMetadataValues` will be returned. The maximum value is 1000; values
410
+ * greater than 1000 will be coerced to 1000.
411
+ * @param {string} [request.pageToken]
412
+ * Optional. A page token, received from a previous `ListCmsMetadataValues`
413
+ * call. Provide this to retrieve the subsequent page.
414
+ *
415
+ * When paginating, all other parameters provided to `ListCmsMetadataValues`
416
+ * must match the call that provided the page token.
417
+ * @param {string} [request.filter]
418
+ * Optional. Expression to filter the response.
419
+ * See syntax details at
420
+ * https://developers.google.com/ad-manager/api/beta/filters
421
+ * @param {string} [request.orderBy]
422
+ * Optional. Expression to specify sorting order.
423
+ * See syntax details at
424
+ * https://developers.google.com/ad-manager/api/beta/filters#order
425
+ * @param {number} [request.skip]
426
+ * Optional. Number of individual resources to skip while paginating.
427
+ * @param {object} [options]
428
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
429
+ * @returns {Stream}
430
+ * An object stream which emits an object representing {@link protos.google.ads.admanager.v1.CmsMetadataValue|CmsMetadataValue} on 'data' event.
431
+ * The client library will perform auto-pagination by default: it will call the API as many
432
+ * times as needed. Note that it can affect your quota.
433
+ * We recommend using `listCmsMetadataValuesAsync()`
434
+ * method described below for async iteration which you can stop as needed.
435
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
436
+ * for more details and examples.
437
+ */
438
+ listCmsMetadataValuesStream(request, options) {
439
+ request = request || {};
440
+ options = options || {};
441
+ options.otherArgs = options.otherArgs || {};
442
+ options.otherArgs.headers = options.otherArgs.headers || {};
443
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
444
+ 'parent': request.parent ?? '',
445
+ });
446
+ const defaultCallSettings = this._defaults['listCmsMetadataValues'];
447
+ const callSettings = defaultCallSettings.merge(options);
448
+ this.initialize().catch(err => { throw err; });
449
+ this._log.info('listCmsMetadataValues stream %j', request);
450
+ return this.descriptors.page.listCmsMetadataValues.createStream(this.innerApiCalls.listCmsMetadataValues, request, callSettings);
451
+ }
452
+ /**
453
+ * Equivalent to `listCmsMetadataValues`, but returns an iterable object.
454
+ *
455
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
456
+ * @param {Object} request
457
+ * The request object that will be sent.
458
+ * @param {string} request.parent
459
+ * Required. The parent, which owns this collection of CmsMetadataValues.
460
+ * Format: `networks/{network_code}`
461
+ * @param {number} [request.pageSize]
462
+ * Optional. The maximum number of `CmsMetadataValues` to return. The service
463
+ * may return fewer than this value. If unspecified, at most 50
464
+ * `CmsMetadataValues` will be returned. The maximum value is 1000; values
465
+ * greater than 1000 will be coerced to 1000.
466
+ * @param {string} [request.pageToken]
467
+ * Optional. A page token, received from a previous `ListCmsMetadataValues`
468
+ * call. Provide this to retrieve the subsequent page.
469
+ *
470
+ * When paginating, all other parameters provided to `ListCmsMetadataValues`
471
+ * must match the call that provided the page token.
472
+ * @param {string} [request.filter]
473
+ * Optional. Expression to filter the response.
474
+ * See syntax details at
475
+ * https://developers.google.com/ad-manager/api/beta/filters
476
+ * @param {string} [request.orderBy]
477
+ * Optional. Expression to specify sorting order.
478
+ * See syntax details at
479
+ * https://developers.google.com/ad-manager/api/beta/filters#order
480
+ * @param {number} [request.skip]
481
+ * Optional. Number of individual resources to skip while paginating.
482
+ * @param {object} [options]
483
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
484
+ * @returns {Object}
485
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
486
+ * When you iterate the returned iterable, each element will be an object representing
487
+ * {@link protos.google.ads.admanager.v1.CmsMetadataValue|CmsMetadataValue}. The API will be called under the hood as needed, once per the page,
488
+ * so you can stop the iteration when you don't need more results.
489
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
490
+ * for more details and examples.
491
+ * @example <caption>include:samples/generated/v1/cms_metadata_value_service.list_cms_metadata_values.js</caption>
492
+ * region_tag:admanager_v1_generated_CmsMetadataValueService_ListCmsMetadataValues_async
493
+ */
494
+ listCmsMetadataValuesAsync(request, options) {
495
+ request = request || {};
496
+ options = options || {};
497
+ options.otherArgs = options.otherArgs || {};
498
+ options.otherArgs.headers = options.otherArgs.headers || {};
499
+ options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
500
+ 'parent': request.parent ?? '',
501
+ });
502
+ const defaultCallSettings = this._defaults['listCmsMetadataValues'];
503
+ const callSettings = defaultCallSettings.merge(options);
504
+ this.initialize().catch(err => { throw err; });
505
+ this._log.info('listCmsMetadataValues iterate %j', request);
506
+ return this.descriptors.page.listCmsMetadataValues.asyncIterate(this.innerApiCalls['listCmsMetadataValues'], request, callSettings);
507
+ }
508
+ // --------------------
509
+ // -- Path templates --
510
+ // --------------------
511
+ /**
512
+ * Return a fully-qualified adBreak resource name string.
513
+ *
514
+ * @param {string} network_code
515
+ * @param {string} asset_key
516
+ * @param {string} ad_break
517
+ * @returns {string} Resource name string.
518
+ */
519
+ adBreakPath(networkCode, assetKey, adBreak) {
520
+ return this.pathTemplates.adBreakPathTemplate.render({
521
+ network_code: networkCode,
522
+ asset_key: assetKey,
523
+ ad_break: adBreak,
524
+ });
525
+ }
526
+ /**
527
+ * Parse the network_code from AdBreak resource.
528
+ *
529
+ * @param {string} adBreakName
530
+ * A fully-qualified path representing AdBreak resource.
531
+ * @returns {string} A string representing the network_code.
532
+ */
533
+ matchNetworkCodeFromAdBreakName(adBreakName) {
534
+ return this.pathTemplates.adBreakPathTemplate.match(adBreakName).network_code;
535
+ }
536
+ /**
537
+ * Parse the asset_key from AdBreak resource.
538
+ *
539
+ * @param {string} adBreakName
540
+ * A fully-qualified path representing AdBreak resource.
541
+ * @returns {string} A string representing the asset_key.
542
+ */
543
+ matchAssetKeyFromAdBreakName(adBreakName) {
544
+ return this.pathTemplates.adBreakPathTemplate.match(adBreakName).asset_key;
545
+ }
546
+ /**
547
+ * Parse the ad_break from AdBreak resource.
548
+ *
549
+ * @param {string} adBreakName
550
+ * A fully-qualified path representing AdBreak resource.
551
+ * @returns {string} A string representing the ad_break.
552
+ */
553
+ matchAdBreakFromAdBreakName(adBreakName) {
554
+ return this.pathTemplates.adBreakPathTemplate.match(adBreakName).ad_break;
555
+ }
556
+ /**
557
+ * Return a fully-qualified adReviewCenterAd resource name string.
558
+ *
559
+ * @param {string} network_code
560
+ * @param {string} web_property_code
561
+ * @param {string} ad_review_center_ad
562
+ * @returns {string} Resource name string.
563
+ */
564
+ adReviewCenterAdPath(networkCode, webPropertyCode, adReviewCenterAd) {
565
+ return this.pathTemplates.adReviewCenterAdPathTemplate.render({
566
+ network_code: networkCode,
567
+ web_property_code: webPropertyCode,
568
+ ad_review_center_ad: adReviewCenterAd,
569
+ });
570
+ }
571
+ /**
572
+ * Parse the network_code from AdReviewCenterAd resource.
573
+ *
574
+ * @param {string} adReviewCenterAdName
575
+ * A fully-qualified path representing AdReviewCenterAd resource.
576
+ * @returns {string} A string representing the network_code.
577
+ */
578
+ matchNetworkCodeFromAdReviewCenterAdName(adReviewCenterAdName) {
579
+ return this.pathTemplates.adReviewCenterAdPathTemplate.match(adReviewCenterAdName).network_code;
580
+ }
581
+ /**
582
+ * Parse the web_property_code from AdReviewCenterAd resource.
583
+ *
584
+ * @param {string} adReviewCenterAdName
585
+ * A fully-qualified path representing AdReviewCenterAd resource.
586
+ * @returns {string} A string representing the web_property_code.
587
+ */
588
+ matchWebPropertyCodeFromAdReviewCenterAdName(adReviewCenterAdName) {
589
+ return this.pathTemplates.adReviewCenterAdPathTemplate.match(adReviewCenterAdName).web_property_code;
590
+ }
591
+ /**
592
+ * Parse the ad_review_center_ad from AdReviewCenterAd resource.
593
+ *
594
+ * @param {string} adReviewCenterAdName
595
+ * A fully-qualified path representing AdReviewCenterAd resource.
596
+ * @returns {string} A string representing the ad_review_center_ad.
597
+ */
598
+ matchAdReviewCenterAdFromAdReviewCenterAdName(adReviewCenterAdName) {
599
+ return this.pathTemplates.adReviewCenterAdPathTemplate.match(adReviewCenterAdName).ad_review_center_ad;
600
+ }
601
+ /**
602
+ * Return a fully-qualified adUnit resource name string.
603
+ *
604
+ * @param {string} network_code
605
+ * @param {string} ad_unit
606
+ * @returns {string} Resource name string.
607
+ */
608
+ adUnitPath(networkCode, adUnit) {
609
+ return this.pathTemplates.adUnitPathTemplate.render({
610
+ network_code: networkCode,
611
+ ad_unit: adUnit,
612
+ });
613
+ }
614
+ /**
615
+ * Parse the network_code from AdUnit resource.
616
+ *
617
+ * @param {string} adUnitName
618
+ * A fully-qualified path representing AdUnit resource.
619
+ * @returns {string} A string representing the network_code.
620
+ */
621
+ matchNetworkCodeFromAdUnitName(adUnitName) {
622
+ return this.pathTemplates.adUnitPathTemplate.match(adUnitName).network_code;
623
+ }
624
+ /**
625
+ * Parse the ad_unit from AdUnit resource.
626
+ *
627
+ * @param {string} adUnitName
628
+ * A fully-qualified path representing AdUnit resource.
629
+ * @returns {string} A string representing the ad_unit.
630
+ */
631
+ matchAdUnitFromAdUnitName(adUnitName) {
632
+ return this.pathTemplates.adUnitPathTemplate.match(adUnitName).ad_unit;
633
+ }
634
+ /**
635
+ * Return a fully-qualified application resource name string.
636
+ *
637
+ * @param {string} network_code
638
+ * @param {string} application
639
+ * @returns {string} Resource name string.
640
+ */
641
+ applicationPath(networkCode, application) {
642
+ return this.pathTemplates.applicationPathTemplate.render({
643
+ network_code: networkCode,
644
+ application: application,
645
+ });
646
+ }
647
+ /**
648
+ * Parse the network_code from Application resource.
649
+ *
650
+ * @param {string} applicationName
651
+ * A fully-qualified path representing Application resource.
652
+ * @returns {string} A string representing the network_code.
653
+ */
654
+ matchNetworkCodeFromApplicationName(applicationName) {
655
+ return this.pathTemplates.applicationPathTemplate.match(applicationName).network_code;
656
+ }
657
+ /**
658
+ * Parse the application from Application resource.
659
+ *
660
+ * @param {string} applicationName
661
+ * A fully-qualified path representing Application resource.
662
+ * @returns {string} A string representing the application.
663
+ */
664
+ matchApplicationFromApplicationName(applicationName) {
665
+ return this.pathTemplates.applicationPathTemplate.match(applicationName).application;
666
+ }
667
+ /**
668
+ * Return a fully-qualified audienceSegment resource name string.
669
+ *
670
+ * @param {string} network_code
671
+ * @param {string} audience_segment
672
+ * @returns {string} Resource name string.
673
+ */
674
+ audienceSegmentPath(networkCode, audienceSegment) {
675
+ return this.pathTemplates.audienceSegmentPathTemplate.render({
676
+ network_code: networkCode,
677
+ audience_segment: audienceSegment,
678
+ });
679
+ }
680
+ /**
681
+ * Parse the network_code from AudienceSegment resource.
682
+ *
683
+ * @param {string} audienceSegmentName
684
+ * A fully-qualified path representing AudienceSegment resource.
685
+ * @returns {string} A string representing the network_code.
686
+ */
687
+ matchNetworkCodeFromAudienceSegmentName(audienceSegmentName) {
688
+ return this.pathTemplates.audienceSegmentPathTemplate.match(audienceSegmentName).network_code;
689
+ }
690
+ /**
691
+ * Parse the audience_segment from AudienceSegment resource.
692
+ *
693
+ * @param {string} audienceSegmentName
694
+ * A fully-qualified path representing AudienceSegment resource.
695
+ * @returns {string} A string representing the audience_segment.
696
+ */
697
+ matchAudienceSegmentFromAudienceSegmentName(audienceSegmentName) {
698
+ return this.pathTemplates.audienceSegmentPathTemplate.match(audienceSegmentName).audience_segment;
699
+ }
700
+ /**
701
+ * Return a fully-qualified bandwidthGroup resource name string.
702
+ *
703
+ * @param {string} network_code
704
+ * @param {string} bandwidth_group
705
+ * @returns {string} Resource name string.
706
+ */
707
+ bandwidthGroupPath(networkCode, bandwidthGroup) {
708
+ return this.pathTemplates.bandwidthGroupPathTemplate.render({
709
+ network_code: networkCode,
710
+ bandwidth_group: bandwidthGroup,
711
+ });
712
+ }
713
+ /**
714
+ * Parse the network_code from BandwidthGroup resource.
715
+ *
716
+ * @param {string} bandwidthGroupName
717
+ * A fully-qualified path representing BandwidthGroup resource.
718
+ * @returns {string} A string representing the network_code.
719
+ */
720
+ matchNetworkCodeFromBandwidthGroupName(bandwidthGroupName) {
721
+ return this.pathTemplates.bandwidthGroupPathTemplate.match(bandwidthGroupName).network_code;
722
+ }
723
+ /**
724
+ * Parse the bandwidth_group from BandwidthGroup resource.
725
+ *
726
+ * @param {string} bandwidthGroupName
727
+ * A fully-qualified path representing BandwidthGroup resource.
728
+ * @returns {string} A string representing the bandwidth_group.
729
+ */
730
+ matchBandwidthGroupFromBandwidthGroupName(bandwidthGroupName) {
731
+ return this.pathTemplates.bandwidthGroupPathTemplate.match(bandwidthGroupName).bandwidth_group;
732
+ }
733
+ /**
734
+ * Return a fully-qualified browser resource name string.
735
+ *
736
+ * @param {string} network_code
737
+ * @param {string} browser
738
+ * @returns {string} Resource name string.
739
+ */
740
+ browserPath(networkCode, browser) {
741
+ return this.pathTemplates.browserPathTemplate.render({
742
+ network_code: networkCode,
743
+ browser: browser,
744
+ });
745
+ }
746
+ /**
747
+ * Parse the network_code from Browser resource.
748
+ *
749
+ * @param {string} browserName
750
+ * A fully-qualified path representing Browser resource.
751
+ * @returns {string} A string representing the network_code.
752
+ */
753
+ matchNetworkCodeFromBrowserName(browserName) {
754
+ return this.pathTemplates.browserPathTemplate.match(browserName).network_code;
755
+ }
756
+ /**
757
+ * Parse the browser from Browser resource.
758
+ *
759
+ * @param {string} browserName
760
+ * A fully-qualified path representing Browser resource.
761
+ * @returns {string} A string representing the browser.
762
+ */
763
+ matchBrowserFromBrowserName(browserName) {
764
+ return this.pathTemplates.browserPathTemplate.match(browserName).browser;
765
+ }
766
+ /**
767
+ * Return a fully-qualified browserLanguage resource name string.
768
+ *
769
+ * @param {string} network_code
770
+ * @param {string} browser_language
771
+ * @returns {string} Resource name string.
772
+ */
773
+ browserLanguagePath(networkCode, browserLanguage) {
774
+ return this.pathTemplates.browserLanguagePathTemplate.render({
775
+ network_code: networkCode,
776
+ browser_language: browserLanguage,
777
+ });
778
+ }
779
+ /**
780
+ * Parse the network_code from BrowserLanguage resource.
781
+ *
782
+ * @param {string} browserLanguageName
783
+ * A fully-qualified path representing BrowserLanguage resource.
784
+ * @returns {string} A string representing the network_code.
785
+ */
786
+ matchNetworkCodeFromBrowserLanguageName(browserLanguageName) {
787
+ return this.pathTemplates.browserLanguagePathTemplate.match(browserLanguageName).network_code;
788
+ }
789
+ /**
790
+ * Parse the browser_language from BrowserLanguage resource.
791
+ *
792
+ * @param {string} browserLanguageName
793
+ * A fully-qualified path representing BrowserLanguage resource.
794
+ * @returns {string} A string representing the browser_language.
795
+ */
796
+ matchBrowserLanguageFromBrowserLanguageName(browserLanguageName) {
797
+ return this.pathTemplates.browserLanguagePathTemplate.match(browserLanguageName).browser_language;
798
+ }
799
+ /**
800
+ * Return a fully-qualified cmsMetadataKey resource name string.
801
+ *
802
+ * @param {string} network_code
803
+ * @param {string} cms_metadata_key
804
+ * @returns {string} Resource name string.
805
+ */
806
+ cmsMetadataKeyPath(networkCode, cmsMetadataKey) {
807
+ return this.pathTemplates.cmsMetadataKeyPathTemplate.render({
808
+ network_code: networkCode,
809
+ cms_metadata_key: cmsMetadataKey,
810
+ });
811
+ }
812
+ /**
813
+ * Parse the network_code from CmsMetadataKey resource.
814
+ *
815
+ * @param {string} cmsMetadataKeyName
816
+ * A fully-qualified path representing CmsMetadataKey resource.
817
+ * @returns {string} A string representing the network_code.
818
+ */
819
+ matchNetworkCodeFromCmsMetadataKeyName(cmsMetadataKeyName) {
820
+ return this.pathTemplates.cmsMetadataKeyPathTemplate.match(cmsMetadataKeyName).network_code;
821
+ }
822
+ /**
823
+ * Parse the cms_metadata_key from CmsMetadataKey resource.
824
+ *
825
+ * @param {string} cmsMetadataKeyName
826
+ * A fully-qualified path representing CmsMetadataKey resource.
827
+ * @returns {string} A string representing the cms_metadata_key.
828
+ */
829
+ matchCmsMetadataKeyFromCmsMetadataKeyName(cmsMetadataKeyName) {
830
+ return this.pathTemplates.cmsMetadataKeyPathTemplate.match(cmsMetadataKeyName).cms_metadata_key;
831
+ }
832
+ /**
833
+ * Return a fully-qualified cmsMetadataValue resource name string.
834
+ *
835
+ * @param {string} network_code
836
+ * @param {string} cms_metadata_value
837
+ * @returns {string} Resource name string.
838
+ */
839
+ cmsMetadataValuePath(networkCode, cmsMetadataValue) {
840
+ return this.pathTemplates.cmsMetadataValuePathTemplate.render({
841
+ network_code: networkCode,
842
+ cms_metadata_value: cmsMetadataValue,
843
+ });
844
+ }
845
+ /**
846
+ * Parse the network_code from CmsMetadataValue resource.
847
+ *
848
+ * @param {string} cmsMetadataValueName
849
+ * A fully-qualified path representing CmsMetadataValue resource.
850
+ * @returns {string} A string representing the network_code.
851
+ */
852
+ matchNetworkCodeFromCmsMetadataValueName(cmsMetadataValueName) {
853
+ return this.pathTemplates.cmsMetadataValuePathTemplate.match(cmsMetadataValueName).network_code;
854
+ }
855
+ /**
856
+ * Parse the cms_metadata_value from CmsMetadataValue resource.
857
+ *
858
+ * @param {string} cmsMetadataValueName
859
+ * A fully-qualified path representing CmsMetadataValue resource.
860
+ * @returns {string} A string representing the cms_metadata_value.
861
+ */
862
+ matchCmsMetadataValueFromCmsMetadataValueName(cmsMetadataValueName) {
863
+ return this.pathTemplates.cmsMetadataValuePathTemplate.match(cmsMetadataValueName).cms_metadata_value;
864
+ }
865
+ /**
866
+ * Return a fully-qualified company resource name string.
867
+ *
868
+ * @param {string} network_code
869
+ * @param {string} company
870
+ * @returns {string} Resource name string.
871
+ */
872
+ companyPath(networkCode, company) {
873
+ return this.pathTemplates.companyPathTemplate.render({
874
+ network_code: networkCode,
875
+ company: company,
876
+ });
877
+ }
878
+ /**
879
+ * Parse the network_code from Company resource.
880
+ *
881
+ * @param {string} companyName
882
+ * A fully-qualified path representing Company resource.
883
+ * @returns {string} A string representing the network_code.
884
+ */
885
+ matchNetworkCodeFromCompanyName(companyName) {
886
+ return this.pathTemplates.companyPathTemplate.match(companyName).network_code;
887
+ }
888
+ /**
889
+ * Parse the company from Company resource.
890
+ *
891
+ * @param {string} companyName
892
+ * A fully-qualified path representing Company resource.
893
+ * @returns {string} A string representing the company.
894
+ */
895
+ matchCompanyFromCompanyName(companyName) {
896
+ return this.pathTemplates.companyPathTemplate.match(companyName).company;
897
+ }
898
+ /**
899
+ * Return a fully-qualified contact resource name string.
900
+ *
901
+ * @param {string} network_code
902
+ * @param {string} contact
903
+ * @returns {string} Resource name string.
904
+ */
905
+ contactPath(networkCode, contact) {
906
+ return this.pathTemplates.contactPathTemplate.render({
907
+ network_code: networkCode,
908
+ contact: contact,
909
+ });
910
+ }
911
+ /**
912
+ * Parse the network_code from Contact resource.
913
+ *
914
+ * @param {string} contactName
915
+ * A fully-qualified path representing Contact resource.
916
+ * @returns {string} A string representing the network_code.
917
+ */
918
+ matchNetworkCodeFromContactName(contactName) {
919
+ return this.pathTemplates.contactPathTemplate.match(contactName).network_code;
920
+ }
921
+ /**
922
+ * Parse the contact from Contact resource.
923
+ *
924
+ * @param {string} contactName
925
+ * A fully-qualified path representing Contact resource.
926
+ * @returns {string} A string representing the contact.
927
+ */
928
+ matchContactFromContactName(contactName) {
929
+ return this.pathTemplates.contactPathTemplate.match(contactName).contact;
930
+ }
931
+ /**
932
+ * Return a fully-qualified content resource name string.
933
+ *
934
+ * @param {string} network_code
935
+ * @param {string} content
936
+ * @returns {string} Resource name string.
937
+ */
938
+ contentPath(networkCode, content) {
939
+ return this.pathTemplates.contentPathTemplate.render({
940
+ network_code: networkCode,
941
+ content: content,
942
+ });
943
+ }
944
+ /**
945
+ * Parse the network_code from Content resource.
946
+ *
947
+ * @param {string} contentName
948
+ * A fully-qualified path representing Content resource.
949
+ * @returns {string} A string representing the network_code.
950
+ */
951
+ matchNetworkCodeFromContentName(contentName) {
952
+ return this.pathTemplates.contentPathTemplate.match(contentName).network_code;
953
+ }
954
+ /**
955
+ * Parse the content from Content resource.
956
+ *
957
+ * @param {string} contentName
958
+ * A fully-qualified path representing Content resource.
959
+ * @returns {string} A string representing the content.
960
+ */
961
+ matchContentFromContentName(contentName) {
962
+ return this.pathTemplates.contentPathTemplate.match(contentName).content;
963
+ }
964
+ /**
965
+ * Return a fully-qualified contentBundle resource name string.
966
+ *
967
+ * @param {string} network_code
968
+ * @param {string} content_bundle
969
+ * @returns {string} Resource name string.
970
+ */
971
+ contentBundlePath(networkCode, contentBundle) {
972
+ return this.pathTemplates.contentBundlePathTemplate.render({
973
+ network_code: networkCode,
974
+ content_bundle: contentBundle,
975
+ });
976
+ }
977
+ /**
978
+ * Parse the network_code from ContentBundle resource.
979
+ *
980
+ * @param {string} contentBundleName
981
+ * A fully-qualified path representing ContentBundle resource.
982
+ * @returns {string} A string representing the network_code.
983
+ */
984
+ matchNetworkCodeFromContentBundleName(contentBundleName) {
985
+ return this.pathTemplates.contentBundlePathTemplate.match(contentBundleName).network_code;
986
+ }
987
+ /**
988
+ * Parse the content_bundle from ContentBundle resource.
989
+ *
990
+ * @param {string} contentBundleName
991
+ * A fully-qualified path representing ContentBundle resource.
992
+ * @returns {string} A string representing the content_bundle.
993
+ */
994
+ matchContentBundleFromContentBundleName(contentBundleName) {
995
+ return this.pathTemplates.contentBundlePathTemplate.match(contentBundleName).content_bundle;
996
+ }
997
+ /**
998
+ * Return a fully-qualified contentLabel resource name string.
999
+ *
1000
+ * @param {string} network_code
1001
+ * @param {string} content_label
1002
+ * @returns {string} Resource name string.
1003
+ */
1004
+ contentLabelPath(networkCode, contentLabel) {
1005
+ return this.pathTemplates.contentLabelPathTemplate.render({
1006
+ network_code: networkCode,
1007
+ content_label: contentLabel,
1008
+ });
1009
+ }
1010
+ /**
1011
+ * Parse the network_code from ContentLabel resource.
1012
+ *
1013
+ * @param {string} contentLabelName
1014
+ * A fully-qualified path representing ContentLabel resource.
1015
+ * @returns {string} A string representing the network_code.
1016
+ */
1017
+ matchNetworkCodeFromContentLabelName(contentLabelName) {
1018
+ return this.pathTemplates.contentLabelPathTemplate.match(contentLabelName).network_code;
1019
+ }
1020
+ /**
1021
+ * Parse the content_label from ContentLabel resource.
1022
+ *
1023
+ * @param {string} contentLabelName
1024
+ * A fully-qualified path representing ContentLabel resource.
1025
+ * @returns {string} A string representing the content_label.
1026
+ */
1027
+ matchContentLabelFromContentLabelName(contentLabelName) {
1028
+ return this.pathTemplates.contentLabelPathTemplate.match(contentLabelName).content_label;
1029
+ }
1030
+ /**
1031
+ * Return a fully-qualified creativeTemplate resource name string.
1032
+ *
1033
+ * @param {string} network_code
1034
+ * @param {string} creative_template
1035
+ * @returns {string} Resource name string.
1036
+ */
1037
+ creativeTemplatePath(networkCode, creativeTemplate) {
1038
+ return this.pathTemplates.creativeTemplatePathTemplate.render({
1039
+ network_code: networkCode,
1040
+ creative_template: creativeTemplate,
1041
+ });
1042
+ }
1043
+ /**
1044
+ * Parse the network_code from CreativeTemplate resource.
1045
+ *
1046
+ * @param {string} creativeTemplateName
1047
+ * A fully-qualified path representing CreativeTemplate resource.
1048
+ * @returns {string} A string representing the network_code.
1049
+ */
1050
+ matchNetworkCodeFromCreativeTemplateName(creativeTemplateName) {
1051
+ return this.pathTemplates.creativeTemplatePathTemplate.match(creativeTemplateName).network_code;
1052
+ }
1053
+ /**
1054
+ * Parse the creative_template from CreativeTemplate resource.
1055
+ *
1056
+ * @param {string} creativeTemplateName
1057
+ * A fully-qualified path representing CreativeTemplate resource.
1058
+ * @returns {string} A string representing the creative_template.
1059
+ */
1060
+ matchCreativeTemplateFromCreativeTemplateName(creativeTemplateName) {
1061
+ return this.pathTemplates.creativeTemplatePathTemplate.match(creativeTemplateName).creative_template;
1062
+ }
1063
+ /**
1064
+ * Return a fully-qualified customField resource name string.
1065
+ *
1066
+ * @param {string} network_code
1067
+ * @param {string} custom_field
1068
+ * @returns {string} Resource name string.
1069
+ */
1070
+ customFieldPath(networkCode, customField) {
1071
+ return this.pathTemplates.customFieldPathTemplate.render({
1072
+ network_code: networkCode,
1073
+ custom_field: customField,
1074
+ });
1075
+ }
1076
+ /**
1077
+ * Parse the network_code from CustomField resource.
1078
+ *
1079
+ * @param {string} customFieldName
1080
+ * A fully-qualified path representing CustomField resource.
1081
+ * @returns {string} A string representing the network_code.
1082
+ */
1083
+ matchNetworkCodeFromCustomFieldName(customFieldName) {
1084
+ return this.pathTemplates.customFieldPathTemplate.match(customFieldName).network_code;
1085
+ }
1086
+ /**
1087
+ * Parse the custom_field from CustomField resource.
1088
+ *
1089
+ * @param {string} customFieldName
1090
+ * A fully-qualified path representing CustomField resource.
1091
+ * @returns {string} A string representing the custom_field.
1092
+ */
1093
+ matchCustomFieldFromCustomFieldName(customFieldName) {
1094
+ return this.pathTemplates.customFieldPathTemplate.match(customFieldName).custom_field;
1095
+ }
1096
+ /**
1097
+ * Return a fully-qualified customTargetingKey resource name string.
1098
+ *
1099
+ * @param {string} network_code
1100
+ * @param {string} custom_targeting_key
1101
+ * @returns {string} Resource name string.
1102
+ */
1103
+ customTargetingKeyPath(networkCode, customTargetingKey) {
1104
+ return this.pathTemplates.customTargetingKeyPathTemplate.render({
1105
+ network_code: networkCode,
1106
+ custom_targeting_key: customTargetingKey,
1107
+ });
1108
+ }
1109
+ /**
1110
+ * Parse the network_code from CustomTargetingKey resource.
1111
+ *
1112
+ * @param {string} customTargetingKeyName
1113
+ * A fully-qualified path representing CustomTargetingKey resource.
1114
+ * @returns {string} A string representing the network_code.
1115
+ */
1116
+ matchNetworkCodeFromCustomTargetingKeyName(customTargetingKeyName) {
1117
+ return this.pathTemplates.customTargetingKeyPathTemplate.match(customTargetingKeyName).network_code;
1118
+ }
1119
+ /**
1120
+ * Parse the custom_targeting_key from CustomTargetingKey resource.
1121
+ *
1122
+ * @param {string} customTargetingKeyName
1123
+ * A fully-qualified path representing CustomTargetingKey resource.
1124
+ * @returns {string} A string representing the custom_targeting_key.
1125
+ */
1126
+ matchCustomTargetingKeyFromCustomTargetingKeyName(customTargetingKeyName) {
1127
+ return this.pathTemplates.customTargetingKeyPathTemplate.match(customTargetingKeyName).custom_targeting_key;
1128
+ }
1129
+ /**
1130
+ * Return a fully-qualified customTargetingValue resource name string.
1131
+ *
1132
+ * @param {string} network_code
1133
+ * @param {string} custom_targeting_value
1134
+ * @returns {string} Resource name string.
1135
+ */
1136
+ customTargetingValuePath(networkCode, customTargetingValue) {
1137
+ return this.pathTemplates.customTargetingValuePathTemplate.render({
1138
+ network_code: networkCode,
1139
+ custom_targeting_value: customTargetingValue,
1140
+ });
1141
+ }
1142
+ /**
1143
+ * Parse the network_code from CustomTargetingValue resource.
1144
+ *
1145
+ * @param {string} customTargetingValueName
1146
+ * A fully-qualified path representing CustomTargetingValue resource.
1147
+ * @returns {string} A string representing the network_code.
1148
+ */
1149
+ matchNetworkCodeFromCustomTargetingValueName(customTargetingValueName) {
1150
+ return this.pathTemplates.customTargetingValuePathTemplate.match(customTargetingValueName).network_code;
1151
+ }
1152
+ /**
1153
+ * Parse the custom_targeting_value from CustomTargetingValue resource.
1154
+ *
1155
+ * @param {string} customTargetingValueName
1156
+ * A fully-qualified path representing CustomTargetingValue resource.
1157
+ * @returns {string} A string representing the custom_targeting_value.
1158
+ */
1159
+ matchCustomTargetingValueFromCustomTargetingValueName(customTargetingValueName) {
1160
+ return this.pathTemplates.customTargetingValuePathTemplate.match(customTargetingValueName).custom_targeting_value;
1161
+ }
1162
+ /**
1163
+ * Return a fully-qualified deviceCapability resource name string.
1164
+ *
1165
+ * @param {string} network_code
1166
+ * @param {string} device_capability
1167
+ * @returns {string} Resource name string.
1168
+ */
1169
+ deviceCapabilityPath(networkCode, deviceCapability) {
1170
+ return this.pathTemplates.deviceCapabilityPathTemplate.render({
1171
+ network_code: networkCode,
1172
+ device_capability: deviceCapability,
1173
+ });
1174
+ }
1175
+ /**
1176
+ * Parse the network_code from DeviceCapability resource.
1177
+ *
1178
+ * @param {string} deviceCapabilityName
1179
+ * A fully-qualified path representing DeviceCapability resource.
1180
+ * @returns {string} A string representing the network_code.
1181
+ */
1182
+ matchNetworkCodeFromDeviceCapabilityName(deviceCapabilityName) {
1183
+ return this.pathTemplates.deviceCapabilityPathTemplate.match(deviceCapabilityName).network_code;
1184
+ }
1185
+ /**
1186
+ * Parse the device_capability from DeviceCapability resource.
1187
+ *
1188
+ * @param {string} deviceCapabilityName
1189
+ * A fully-qualified path representing DeviceCapability resource.
1190
+ * @returns {string} A string representing the device_capability.
1191
+ */
1192
+ matchDeviceCapabilityFromDeviceCapabilityName(deviceCapabilityName) {
1193
+ return this.pathTemplates.deviceCapabilityPathTemplate.match(deviceCapabilityName).device_capability;
1194
+ }
1195
+ /**
1196
+ * Return a fully-qualified deviceCategory resource name string.
1197
+ *
1198
+ * @param {string} network_code
1199
+ * @param {string} device_category
1200
+ * @returns {string} Resource name string.
1201
+ */
1202
+ deviceCategoryPath(networkCode, deviceCategory) {
1203
+ return this.pathTemplates.deviceCategoryPathTemplate.render({
1204
+ network_code: networkCode,
1205
+ device_category: deviceCategory,
1206
+ });
1207
+ }
1208
+ /**
1209
+ * Parse the network_code from DeviceCategory resource.
1210
+ *
1211
+ * @param {string} deviceCategoryName
1212
+ * A fully-qualified path representing DeviceCategory resource.
1213
+ * @returns {string} A string representing the network_code.
1214
+ */
1215
+ matchNetworkCodeFromDeviceCategoryName(deviceCategoryName) {
1216
+ return this.pathTemplates.deviceCategoryPathTemplate.match(deviceCategoryName).network_code;
1217
+ }
1218
+ /**
1219
+ * Parse the device_category from DeviceCategory resource.
1220
+ *
1221
+ * @param {string} deviceCategoryName
1222
+ * A fully-qualified path representing DeviceCategory resource.
1223
+ * @returns {string} A string representing the device_category.
1224
+ */
1225
+ matchDeviceCategoryFromDeviceCategoryName(deviceCategoryName) {
1226
+ return this.pathTemplates.deviceCategoryPathTemplate.match(deviceCategoryName).device_category;
1227
+ }
1228
+ /**
1229
+ * Return a fully-qualified deviceManufacturer resource name string.
1230
+ *
1231
+ * @param {string} network_code
1232
+ * @param {string} device_manufacturer
1233
+ * @returns {string} Resource name string.
1234
+ */
1235
+ deviceManufacturerPath(networkCode, deviceManufacturer) {
1236
+ return this.pathTemplates.deviceManufacturerPathTemplate.render({
1237
+ network_code: networkCode,
1238
+ device_manufacturer: deviceManufacturer,
1239
+ });
1240
+ }
1241
+ /**
1242
+ * Parse the network_code from DeviceManufacturer resource.
1243
+ *
1244
+ * @param {string} deviceManufacturerName
1245
+ * A fully-qualified path representing DeviceManufacturer resource.
1246
+ * @returns {string} A string representing the network_code.
1247
+ */
1248
+ matchNetworkCodeFromDeviceManufacturerName(deviceManufacturerName) {
1249
+ return this.pathTemplates.deviceManufacturerPathTemplate.match(deviceManufacturerName).network_code;
1250
+ }
1251
+ /**
1252
+ * Parse the device_manufacturer from DeviceManufacturer resource.
1253
+ *
1254
+ * @param {string} deviceManufacturerName
1255
+ * A fully-qualified path representing DeviceManufacturer resource.
1256
+ * @returns {string} A string representing the device_manufacturer.
1257
+ */
1258
+ matchDeviceManufacturerFromDeviceManufacturerName(deviceManufacturerName) {
1259
+ return this.pathTemplates.deviceManufacturerPathTemplate.match(deviceManufacturerName).device_manufacturer;
1260
+ }
1261
+ /**
1262
+ * Return a fully-qualified entitySignalsMapping resource name string.
1263
+ *
1264
+ * @param {string} network_code
1265
+ * @param {string} entity_signals_mapping
1266
+ * @returns {string} Resource name string.
1267
+ */
1268
+ entitySignalsMappingPath(networkCode, entitySignalsMapping) {
1269
+ return this.pathTemplates.entitySignalsMappingPathTemplate.render({
1270
+ network_code: networkCode,
1271
+ entity_signals_mapping: entitySignalsMapping,
1272
+ });
1273
+ }
1274
+ /**
1275
+ * Parse the network_code from EntitySignalsMapping resource.
1276
+ *
1277
+ * @param {string} entitySignalsMappingName
1278
+ * A fully-qualified path representing EntitySignalsMapping resource.
1279
+ * @returns {string} A string representing the network_code.
1280
+ */
1281
+ matchNetworkCodeFromEntitySignalsMappingName(entitySignalsMappingName) {
1282
+ return this.pathTemplates.entitySignalsMappingPathTemplate.match(entitySignalsMappingName).network_code;
1283
+ }
1284
+ /**
1285
+ * Parse the entity_signals_mapping from EntitySignalsMapping resource.
1286
+ *
1287
+ * @param {string} entitySignalsMappingName
1288
+ * A fully-qualified path representing EntitySignalsMapping resource.
1289
+ * @returns {string} A string representing the entity_signals_mapping.
1290
+ */
1291
+ matchEntitySignalsMappingFromEntitySignalsMappingName(entitySignalsMappingName) {
1292
+ return this.pathTemplates.entitySignalsMappingPathTemplate.match(entitySignalsMappingName).entity_signals_mapping;
1293
+ }
1294
+ /**
1295
+ * Return a fully-qualified geoTarget resource name string.
1296
+ *
1297
+ * @param {string} network_code
1298
+ * @param {string} geo_target
1299
+ * @returns {string} Resource name string.
1300
+ */
1301
+ geoTargetPath(networkCode, geoTarget) {
1302
+ return this.pathTemplates.geoTargetPathTemplate.render({
1303
+ network_code: networkCode,
1304
+ geo_target: geoTarget,
1305
+ });
1306
+ }
1307
+ /**
1308
+ * Parse the network_code from GeoTarget resource.
1309
+ *
1310
+ * @param {string} geoTargetName
1311
+ * A fully-qualified path representing GeoTarget resource.
1312
+ * @returns {string} A string representing the network_code.
1313
+ */
1314
+ matchNetworkCodeFromGeoTargetName(geoTargetName) {
1315
+ return this.pathTemplates.geoTargetPathTemplate.match(geoTargetName).network_code;
1316
+ }
1317
+ /**
1318
+ * Parse the geo_target from GeoTarget resource.
1319
+ *
1320
+ * @param {string} geoTargetName
1321
+ * A fully-qualified path representing GeoTarget resource.
1322
+ * @returns {string} A string representing the geo_target.
1323
+ */
1324
+ matchGeoTargetFromGeoTargetName(geoTargetName) {
1325
+ return this.pathTemplates.geoTargetPathTemplate.match(geoTargetName).geo_target;
1326
+ }
1327
+ /**
1328
+ * Return a fully-qualified label resource name string.
1329
+ *
1330
+ * @param {string} network_code
1331
+ * @param {string} label
1332
+ * @returns {string} Resource name string.
1333
+ */
1334
+ labelPath(networkCode, label) {
1335
+ return this.pathTemplates.labelPathTemplate.render({
1336
+ network_code: networkCode,
1337
+ label: label,
1338
+ });
1339
+ }
1340
+ /**
1341
+ * Parse the network_code from Label resource.
1342
+ *
1343
+ * @param {string} labelName
1344
+ * A fully-qualified path representing Label resource.
1345
+ * @returns {string} A string representing the network_code.
1346
+ */
1347
+ matchNetworkCodeFromLabelName(labelName) {
1348
+ return this.pathTemplates.labelPathTemplate.match(labelName).network_code;
1349
+ }
1350
+ /**
1351
+ * Parse the label from Label resource.
1352
+ *
1353
+ * @param {string} labelName
1354
+ * A fully-qualified path representing Label resource.
1355
+ * @returns {string} A string representing the label.
1356
+ */
1357
+ matchLabelFromLabelName(labelName) {
1358
+ return this.pathTemplates.labelPathTemplate.match(labelName).label;
1359
+ }
1360
+ /**
1361
+ * Return a fully-qualified liveStreamEvent resource name string.
1362
+ *
1363
+ * @param {string} network_code
1364
+ * @param {string} live_stream_event
1365
+ * @returns {string} Resource name string.
1366
+ */
1367
+ liveStreamEventPath(networkCode, liveStreamEvent) {
1368
+ return this.pathTemplates.liveStreamEventPathTemplate.render({
1369
+ network_code: networkCode,
1370
+ live_stream_event: liveStreamEvent,
1371
+ });
1372
+ }
1373
+ /**
1374
+ * Parse the network_code from LiveStreamEvent resource.
1375
+ *
1376
+ * @param {string} liveStreamEventName
1377
+ * A fully-qualified path representing LiveStreamEvent resource.
1378
+ * @returns {string} A string representing the network_code.
1379
+ */
1380
+ matchNetworkCodeFromLiveStreamEventName(liveStreamEventName) {
1381
+ return this.pathTemplates.liveStreamEventPathTemplate.match(liveStreamEventName).network_code;
1382
+ }
1383
+ /**
1384
+ * Parse the live_stream_event from LiveStreamEvent resource.
1385
+ *
1386
+ * @param {string} liveStreamEventName
1387
+ * A fully-qualified path representing LiveStreamEvent resource.
1388
+ * @returns {string} A string representing the live_stream_event.
1389
+ */
1390
+ matchLiveStreamEventFromLiveStreamEventName(liveStreamEventName) {
1391
+ return this.pathTemplates.liveStreamEventPathTemplate.match(liveStreamEventName).live_stream_event;
1392
+ }
1393
+ /**
1394
+ * Return a fully-qualified mobileCarrier resource name string.
1395
+ *
1396
+ * @param {string} network_code
1397
+ * @param {string} mobile_carrier
1398
+ * @returns {string} Resource name string.
1399
+ */
1400
+ mobileCarrierPath(networkCode, mobileCarrier) {
1401
+ return this.pathTemplates.mobileCarrierPathTemplate.render({
1402
+ network_code: networkCode,
1403
+ mobile_carrier: mobileCarrier,
1404
+ });
1405
+ }
1406
+ /**
1407
+ * Parse the network_code from MobileCarrier resource.
1408
+ *
1409
+ * @param {string} mobileCarrierName
1410
+ * A fully-qualified path representing MobileCarrier resource.
1411
+ * @returns {string} A string representing the network_code.
1412
+ */
1413
+ matchNetworkCodeFromMobileCarrierName(mobileCarrierName) {
1414
+ return this.pathTemplates.mobileCarrierPathTemplate.match(mobileCarrierName).network_code;
1415
+ }
1416
+ /**
1417
+ * Parse the mobile_carrier from MobileCarrier resource.
1418
+ *
1419
+ * @param {string} mobileCarrierName
1420
+ * A fully-qualified path representing MobileCarrier resource.
1421
+ * @returns {string} A string representing the mobile_carrier.
1422
+ */
1423
+ matchMobileCarrierFromMobileCarrierName(mobileCarrierName) {
1424
+ return this.pathTemplates.mobileCarrierPathTemplate.match(mobileCarrierName).mobile_carrier;
1425
+ }
1426
+ /**
1427
+ * Return a fully-qualified mobileDevice resource name string.
1428
+ *
1429
+ * @param {string} network_code
1430
+ * @param {string} mobile_device
1431
+ * @returns {string} Resource name string.
1432
+ */
1433
+ mobileDevicePath(networkCode, mobileDevice) {
1434
+ return this.pathTemplates.mobileDevicePathTemplate.render({
1435
+ network_code: networkCode,
1436
+ mobile_device: mobileDevice,
1437
+ });
1438
+ }
1439
+ /**
1440
+ * Parse the network_code from MobileDevice resource.
1441
+ *
1442
+ * @param {string} mobileDeviceName
1443
+ * A fully-qualified path representing MobileDevice resource.
1444
+ * @returns {string} A string representing the network_code.
1445
+ */
1446
+ matchNetworkCodeFromMobileDeviceName(mobileDeviceName) {
1447
+ return this.pathTemplates.mobileDevicePathTemplate.match(mobileDeviceName).network_code;
1448
+ }
1449
+ /**
1450
+ * Parse the mobile_device from MobileDevice resource.
1451
+ *
1452
+ * @param {string} mobileDeviceName
1453
+ * A fully-qualified path representing MobileDevice resource.
1454
+ * @returns {string} A string representing the mobile_device.
1455
+ */
1456
+ matchMobileDeviceFromMobileDeviceName(mobileDeviceName) {
1457
+ return this.pathTemplates.mobileDevicePathTemplate.match(mobileDeviceName).mobile_device;
1458
+ }
1459
+ /**
1460
+ * Return a fully-qualified mobileDeviceSubmodel resource name string.
1461
+ *
1462
+ * @param {string} network_code
1463
+ * @param {string} mobile_device_submodel
1464
+ * @returns {string} Resource name string.
1465
+ */
1466
+ mobileDeviceSubmodelPath(networkCode, mobileDeviceSubmodel) {
1467
+ return this.pathTemplates.mobileDeviceSubmodelPathTemplate.render({
1468
+ network_code: networkCode,
1469
+ mobile_device_submodel: mobileDeviceSubmodel,
1470
+ });
1471
+ }
1472
+ /**
1473
+ * Parse the network_code from MobileDeviceSubmodel resource.
1474
+ *
1475
+ * @param {string} mobileDeviceSubmodelName
1476
+ * A fully-qualified path representing MobileDeviceSubmodel resource.
1477
+ * @returns {string} A string representing the network_code.
1478
+ */
1479
+ matchNetworkCodeFromMobileDeviceSubmodelName(mobileDeviceSubmodelName) {
1480
+ return this.pathTemplates.mobileDeviceSubmodelPathTemplate.match(mobileDeviceSubmodelName).network_code;
1481
+ }
1482
+ /**
1483
+ * Parse the mobile_device_submodel from MobileDeviceSubmodel resource.
1484
+ *
1485
+ * @param {string} mobileDeviceSubmodelName
1486
+ * A fully-qualified path representing MobileDeviceSubmodel resource.
1487
+ * @returns {string} A string representing the mobile_device_submodel.
1488
+ */
1489
+ matchMobileDeviceSubmodelFromMobileDeviceSubmodelName(mobileDeviceSubmodelName) {
1490
+ return this.pathTemplates.mobileDeviceSubmodelPathTemplate.match(mobileDeviceSubmodelName).mobile_device_submodel;
1491
+ }
1492
+ /**
1493
+ * Return a fully-qualified network resource name string.
1494
+ *
1495
+ * @param {string} network_code
1496
+ * @returns {string} Resource name string.
1497
+ */
1498
+ networkPath(networkCode) {
1499
+ return this.pathTemplates.networkPathTemplate.render({
1500
+ network_code: networkCode,
1501
+ });
1502
+ }
1503
+ /**
1504
+ * Parse the network_code from Network resource.
1505
+ *
1506
+ * @param {string} networkName
1507
+ * A fully-qualified path representing Network resource.
1508
+ * @returns {string} A string representing the network_code.
1509
+ */
1510
+ matchNetworkCodeFromNetworkName(networkName) {
1511
+ return this.pathTemplates.networkPathTemplate.match(networkName).network_code;
1512
+ }
1513
+ /**
1514
+ * Return a fully-qualified operatingSystem resource name string.
1515
+ *
1516
+ * @param {string} network_code
1517
+ * @param {string} operating_system
1518
+ * @returns {string} Resource name string.
1519
+ */
1520
+ operatingSystemPath(networkCode, operatingSystem) {
1521
+ return this.pathTemplates.operatingSystemPathTemplate.render({
1522
+ network_code: networkCode,
1523
+ operating_system: operatingSystem,
1524
+ });
1525
+ }
1526
+ /**
1527
+ * Parse the network_code from OperatingSystem resource.
1528
+ *
1529
+ * @param {string} operatingSystemName
1530
+ * A fully-qualified path representing OperatingSystem resource.
1531
+ * @returns {string} A string representing the network_code.
1532
+ */
1533
+ matchNetworkCodeFromOperatingSystemName(operatingSystemName) {
1534
+ return this.pathTemplates.operatingSystemPathTemplate.match(operatingSystemName).network_code;
1535
+ }
1536
+ /**
1537
+ * Parse the operating_system from OperatingSystem resource.
1538
+ *
1539
+ * @param {string} operatingSystemName
1540
+ * A fully-qualified path representing OperatingSystem resource.
1541
+ * @returns {string} A string representing the operating_system.
1542
+ */
1543
+ matchOperatingSystemFromOperatingSystemName(operatingSystemName) {
1544
+ return this.pathTemplates.operatingSystemPathTemplate.match(operatingSystemName).operating_system;
1545
+ }
1546
+ /**
1547
+ * Return a fully-qualified operatingSystemVersion resource name string.
1548
+ *
1549
+ * @param {string} network_code
1550
+ * @param {string} operating_system_version
1551
+ * @returns {string} Resource name string.
1552
+ */
1553
+ operatingSystemVersionPath(networkCode, operatingSystemVersion) {
1554
+ return this.pathTemplates.operatingSystemVersionPathTemplate.render({
1555
+ network_code: networkCode,
1556
+ operating_system_version: operatingSystemVersion,
1557
+ });
1558
+ }
1559
+ /**
1560
+ * Parse the network_code from OperatingSystemVersion resource.
1561
+ *
1562
+ * @param {string} operatingSystemVersionName
1563
+ * A fully-qualified path representing OperatingSystemVersion resource.
1564
+ * @returns {string} A string representing the network_code.
1565
+ */
1566
+ matchNetworkCodeFromOperatingSystemVersionName(operatingSystemVersionName) {
1567
+ return this.pathTemplates.operatingSystemVersionPathTemplate.match(operatingSystemVersionName).network_code;
1568
+ }
1569
+ /**
1570
+ * Parse the operating_system_version from OperatingSystemVersion resource.
1571
+ *
1572
+ * @param {string} operatingSystemVersionName
1573
+ * A fully-qualified path representing OperatingSystemVersion resource.
1574
+ * @returns {string} A string representing the operating_system_version.
1575
+ */
1576
+ matchOperatingSystemVersionFromOperatingSystemVersionName(operatingSystemVersionName) {
1577
+ return this.pathTemplates.operatingSystemVersionPathTemplate.match(operatingSystemVersionName).operating_system_version;
1578
+ }
1579
+ /**
1580
+ * Return a fully-qualified order resource name string.
1581
+ *
1582
+ * @param {string} network_code
1583
+ * @param {string} order
1584
+ * @returns {string} Resource name string.
1585
+ */
1586
+ orderPath(networkCode, order) {
1587
+ return this.pathTemplates.orderPathTemplate.render({
1588
+ network_code: networkCode,
1589
+ order: order,
1590
+ });
1591
+ }
1592
+ /**
1593
+ * Parse the network_code from Order resource.
1594
+ *
1595
+ * @param {string} orderName
1596
+ * A fully-qualified path representing Order resource.
1597
+ * @returns {string} A string representing the network_code.
1598
+ */
1599
+ matchNetworkCodeFromOrderName(orderName) {
1600
+ return this.pathTemplates.orderPathTemplate.match(orderName).network_code;
1601
+ }
1602
+ /**
1603
+ * Parse the order from Order resource.
1604
+ *
1605
+ * @param {string} orderName
1606
+ * A fully-qualified path representing Order resource.
1607
+ * @returns {string} A string representing the order.
1608
+ */
1609
+ matchOrderFromOrderName(orderName) {
1610
+ return this.pathTemplates.orderPathTemplate.match(orderName).order;
1611
+ }
1612
+ /**
1613
+ * Return a fully-qualified placement resource name string.
1614
+ *
1615
+ * @param {string} network_code
1616
+ * @param {string} placement
1617
+ * @returns {string} Resource name string.
1618
+ */
1619
+ placementPath(networkCode, placement) {
1620
+ return this.pathTemplates.placementPathTemplate.render({
1621
+ network_code: networkCode,
1622
+ placement: placement,
1623
+ });
1624
+ }
1625
+ /**
1626
+ * Parse the network_code from Placement resource.
1627
+ *
1628
+ * @param {string} placementName
1629
+ * A fully-qualified path representing Placement resource.
1630
+ * @returns {string} A string representing the network_code.
1631
+ */
1632
+ matchNetworkCodeFromPlacementName(placementName) {
1633
+ return this.pathTemplates.placementPathTemplate.match(placementName).network_code;
1634
+ }
1635
+ /**
1636
+ * Parse the placement from Placement resource.
1637
+ *
1638
+ * @param {string} placementName
1639
+ * A fully-qualified path representing Placement resource.
1640
+ * @returns {string} A string representing the placement.
1641
+ */
1642
+ matchPlacementFromPlacementName(placementName) {
1643
+ return this.pathTemplates.placementPathTemplate.match(placementName).placement;
1644
+ }
1645
+ /**
1646
+ * Return a fully-qualified privateAuction resource name string.
1647
+ *
1648
+ * @param {string} network_code
1649
+ * @param {string} private_auction
1650
+ * @returns {string} Resource name string.
1651
+ */
1652
+ privateAuctionPath(networkCode, privateAuction) {
1653
+ return this.pathTemplates.privateAuctionPathTemplate.render({
1654
+ network_code: networkCode,
1655
+ private_auction: privateAuction,
1656
+ });
1657
+ }
1658
+ /**
1659
+ * Parse the network_code from PrivateAuction resource.
1660
+ *
1661
+ * @param {string} privateAuctionName
1662
+ * A fully-qualified path representing PrivateAuction resource.
1663
+ * @returns {string} A string representing the network_code.
1664
+ */
1665
+ matchNetworkCodeFromPrivateAuctionName(privateAuctionName) {
1666
+ return this.pathTemplates.privateAuctionPathTemplate.match(privateAuctionName).network_code;
1667
+ }
1668
+ /**
1669
+ * Parse the private_auction from PrivateAuction resource.
1670
+ *
1671
+ * @param {string} privateAuctionName
1672
+ * A fully-qualified path representing PrivateAuction resource.
1673
+ * @returns {string} A string representing the private_auction.
1674
+ */
1675
+ matchPrivateAuctionFromPrivateAuctionName(privateAuctionName) {
1676
+ return this.pathTemplates.privateAuctionPathTemplate.match(privateAuctionName).private_auction;
1677
+ }
1678
+ /**
1679
+ * Return a fully-qualified privateAuctionDeal resource name string.
1680
+ *
1681
+ * @param {string} network_code
1682
+ * @param {string} private_auction_deal
1683
+ * @returns {string} Resource name string.
1684
+ */
1685
+ privateAuctionDealPath(networkCode, privateAuctionDeal) {
1686
+ return this.pathTemplates.privateAuctionDealPathTemplate.render({
1687
+ network_code: networkCode,
1688
+ private_auction_deal: privateAuctionDeal,
1689
+ });
1690
+ }
1691
+ /**
1692
+ * Parse the network_code from PrivateAuctionDeal resource.
1693
+ *
1694
+ * @param {string} privateAuctionDealName
1695
+ * A fully-qualified path representing PrivateAuctionDeal resource.
1696
+ * @returns {string} A string representing the network_code.
1697
+ */
1698
+ matchNetworkCodeFromPrivateAuctionDealName(privateAuctionDealName) {
1699
+ return this.pathTemplates.privateAuctionDealPathTemplate.match(privateAuctionDealName).network_code;
1700
+ }
1701
+ /**
1702
+ * Parse the private_auction_deal from PrivateAuctionDeal resource.
1703
+ *
1704
+ * @param {string} privateAuctionDealName
1705
+ * A fully-qualified path representing PrivateAuctionDeal resource.
1706
+ * @returns {string} A string representing the private_auction_deal.
1707
+ */
1708
+ matchPrivateAuctionDealFromPrivateAuctionDealName(privateAuctionDealName) {
1709
+ return this.pathTemplates.privateAuctionDealPathTemplate.match(privateAuctionDealName).private_auction_deal;
1710
+ }
1711
+ /**
1712
+ * Return a fully-qualified programmaticBuyer resource name string.
1713
+ *
1714
+ * @param {string} network_code
1715
+ * @param {string} programmatic_buyer
1716
+ * @returns {string} Resource name string.
1717
+ */
1718
+ programmaticBuyerPath(networkCode, programmaticBuyer) {
1719
+ return this.pathTemplates.programmaticBuyerPathTemplate.render({
1720
+ network_code: networkCode,
1721
+ programmatic_buyer: programmaticBuyer,
1722
+ });
1723
+ }
1724
+ /**
1725
+ * Parse the network_code from ProgrammaticBuyer resource.
1726
+ *
1727
+ * @param {string} programmaticBuyerName
1728
+ * A fully-qualified path representing ProgrammaticBuyer resource.
1729
+ * @returns {string} A string representing the network_code.
1730
+ */
1731
+ matchNetworkCodeFromProgrammaticBuyerName(programmaticBuyerName) {
1732
+ return this.pathTemplates.programmaticBuyerPathTemplate.match(programmaticBuyerName).network_code;
1733
+ }
1734
+ /**
1735
+ * Parse the programmatic_buyer from ProgrammaticBuyer resource.
1736
+ *
1737
+ * @param {string} programmaticBuyerName
1738
+ * A fully-qualified path representing ProgrammaticBuyer resource.
1739
+ * @returns {string} A string representing the programmatic_buyer.
1740
+ */
1741
+ matchProgrammaticBuyerFromProgrammaticBuyerName(programmaticBuyerName) {
1742
+ return this.pathTemplates.programmaticBuyerPathTemplate.match(programmaticBuyerName).programmatic_buyer;
1743
+ }
1744
+ /**
1745
+ * Return a fully-qualified report resource name string.
1746
+ *
1747
+ * @param {string} network_code
1748
+ * @param {string} report
1749
+ * @returns {string} Resource name string.
1750
+ */
1751
+ reportPath(networkCode, report) {
1752
+ return this.pathTemplates.reportPathTemplate.render({
1753
+ network_code: networkCode,
1754
+ report: report,
1755
+ });
1756
+ }
1757
+ /**
1758
+ * Parse the network_code from Report resource.
1759
+ *
1760
+ * @param {string} reportName
1761
+ * A fully-qualified path representing Report resource.
1762
+ * @returns {string} A string representing the network_code.
1763
+ */
1764
+ matchNetworkCodeFromReportName(reportName) {
1765
+ return this.pathTemplates.reportPathTemplate.match(reportName).network_code;
1766
+ }
1767
+ /**
1768
+ * Parse the report from Report resource.
1769
+ *
1770
+ * @param {string} reportName
1771
+ * A fully-qualified path representing Report resource.
1772
+ * @returns {string} A string representing the report.
1773
+ */
1774
+ matchReportFromReportName(reportName) {
1775
+ return this.pathTemplates.reportPathTemplate.match(reportName).report;
1776
+ }
1777
+ /**
1778
+ * Return a fully-qualified role resource name string.
1779
+ *
1780
+ * @param {string} network_code
1781
+ * @param {string} role
1782
+ * @returns {string} Resource name string.
1783
+ */
1784
+ rolePath(networkCode, role) {
1785
+ return this.pathTemplates.rolePathTemplate.render({
1786
+ network_code: networkCode,
1787
+ role: role,
1788
+ });
1789
+ }
1790
+ /**
1791
+ * Parse the network_code from Role resource.
1792
+ *
1793
+ * @param {string} roleName
1794
+ * A fully-qualified path representing Role resource.
1795
+ * @returns {string} A string representing the network_code.
1796
+ */
1797
+ matchNetworkCodeFromRoleName(roleName) {
1798
+ return this.pathTemplates.rolePathTemplate.match(roleName).network_code;
1799
+ }
1800
+ /**
1801
+ * Parse the role from Role resource.
1802
+ *
1803
+ * @param {string} roleName
1804
+ * A fully-qualified path representing Role resource.
1805
+ * @returns {string} A string representing the role.
1806
+ */
1807
+ matchRoleFromRoleName(roleName) {
1808
+ return this.pathTemplates.rolePathTemplate.match(roleName).role;
1809
+ }
1810
+ /**
1811
+ * Return a fully-qualified site resource name string.
1812
+ *
1813
+ * @param {string} network_code
1814
+ * @param {string} site
1815
+ * @returns {string} Resource name string.
1816
+ */
1817
+ sitePath(networkCode, site) {
1818
+ return this.pathTemplates.sitePathTemplate.render({
1819
+ network_code: networkCode,
1820
+ site: site,
1821
+ });
1822
+ }
1823
+ /**
1824
+ * Parse the network_code from Site resource.
1825
+ *
1826
+ * @param {string} siteName
1827
+ * A fully-qualified path representing Site resource.
1828
+ * @returns {string} A string representing the network_code.
1829
+ */
1830
+ matchNetworkCodeFromSiteName(siteName) {
1831
+ return this.pathTemplates.sitePathTemplate.match(siteName).network_code;
1832
+ }
1833
+ /**
1834
+ * Parse the site from Site resource.
1835
+ *
1836
+ * @param {string} siteName
1837
+ * A fully-qualified path representing Site resource.
1838
+ * @returns {string} A string representing the site.
1839
+ */
1840
+ matchSiteFromSiteName(siteName) {
1841
+ return this.pathTemplates.sitePathTemplate.match(siteName).site;
1842
+ }
1843
+ /**
1844
+ * Return a fully-qualified taxonomyCategory resource name string.
1845
+ *
1846
+ * @param {string} network_code
1847
+ * @param {string} taxonomy_category
1848
+ * @returns {string} Resource name string.
1849
+ */
1850
+ taxonomyCategoryPath(networkCode, taxonomyCategory) {
1851
+ return this.pathTemplates.taxonomyCategoryPathTemplate.render({
1852
+ network_code: networkCode,
1853
+ taxonomy_category: taxonomyCategory,
1854
+ });
1855
+ }
1856
+ /**
1857
+ * Parse the network_code from TaxonomyCategory resource.
1858
+ *
1859
+ * @param {string} taxonomyCategoryName
1860
+ * A fully-qualified path representing TaxonomyCategory resource.
1861
+ * @returns {string} A string representing the network_code.
1862
+ */
1863
+ matchNetworkCodeFromTaxonomyCategoryName(taxonomyCategoryName) {
1864
+ return this.pathTemplates.taxonomyCategoryPathTemplate.match(taxonomyCategoryName).network_code;
1865
+ }
1866
+ /**
1867
+ * Parse the taxonomy_category from TaxonomyCategory resource.
1868
+ *
1869
+ * @param {string} taxonomyCategoryName
1870
+ * A fully-qualified path representing TaxonomyCategory resource.
1871
+ * @returns {string} A string representing the taxonomy_category.
1872
+ */
1873
+ matchTaxonomyCategoryFromTaxonomyCategoryName(taxonomyCategoryName) {
1874
+ return this.pathTemplates.taxonomyCategoryPathTemplate.match(taxonomyCategoryName).taxonomy_category;
1875
+ }
1876
+ /**
1877
+ * Return a fully-qualified team resource name string.
1878
+ *
1879
+ * @param {string} network_code
1880
+ * @param {string} team
1881
+ * @returns {string} Resource name string.
1882
+ */
1883
+ teamPath(networkCode, team) {
1884
+ return this.pathTemplates.teamPathTemplate.render({
1885
+ network_code: networkCode,
1886
+ team: team,
1887
+ });
1888
+ }
1889
+ /**
1890
+ * Parse the network_code from Team resource.
1891
+ *
1892
+ * @param {string} teamName
1893
+ * A fully-qualified path representing Team resource.
1894
+ * @returns {string} A string representing the network_code.
1895
+ */
1896
+ matchNetworkCodeFromTeamName(teamName) {
1897
+ return this.pathTemplates.teamPathTemplate.match(teamName).network_code;
1898
+ }
1899
+ /**
1900
+ * Parse the team from Team resource.
1901
+ *
1902
+ * @param {string} teamName
1903
+ * A fully-qualified path representing Team resource.
1904
+ * @returns {string} A string representing the team.
1905
+ */
1906
+ matchTeamFromTeamName(teamName) {
1907
+ return this.pathTemplates.teamPathTemplate.match(teamName).team;
1908
+ }
1909
+ /**
1910
+ * Return a fully-qualified user resource name string.
1911
+ *
1912
+ * @param {string} network_code
1913
+ * @param {string} user
1914
+ * @returns {string} Resource name string.
1915
+ */
1916
+ userPath(networkCode, user) {
1917
+ return this.pathTemplates.userPathTemplate.render({
1918
+ network_code: networkCode,
1919
+ user: user,
1920
+ });
1921
+ }
1922
+ /**
1923
+ * Parse the network_code from User resource.
1924
+ *
1925
+ * @param {string} userName
1926
+ * A fully-qualified path representing User resource.
1927
+ * @returns {string} A string representing the network_code.
1928
+ */
1929
+ matchNetworkCodeFromUserName(userName) {
1930
+ return this.pathTemplates.userPathTemplate.match(userName).network_code;
1931
+ }
1932
+ /**
1933
+ * Parse the user from User resource.
1934
+ *
1935
+ * @param {string} userName
1936
+ * A fully-qualified path representing User resource.
1937
+ * @returns {string} A string representing the user.
1938
+ */
1939
+ matchUserFromUserName(userName) {
1940
+ return this.pathTemplates.userPathTemplate.match(userName).user;
1941
+ }
1942
+ /**
1943
+ * Return a fully-qualified webProperty resource name string.
1944
+ *
1945
+ * @param {string} network_code
1946
+ * @param {string} web_property
1947
+ * @returns {string} Resource name string.
1948
+ */
1949
+ webPropertyPath(networkCode, webProperty) {
1950
+ return this.pathTemplates.webPropertyPathTemplate.render({
1951
+ network_code: networkCode,
1952
+ web_property: webProperty,
1953
+ });
1954
+ }
1955
+ /**
1956
+ * Parse the network_code from WebProperty resource.
1957
+ *
1958
+ * @param {string} webPropertyName
1959
+ * A fully-qualified path representing WebProperty resource.
1960
+ * @returns {string} A string representing the network_code.
1961
+ */
1962
+ matchNetworkCodeFromWebPropertyName(webPropertyName) {
1963
+ return this.pathTemplates.webPropertyPathTemplate.match(webPropertyName).network_code;
1964
+ }
1965
+ /**
1966
+ * Parse the web_property from WebProperty resource.
1967
+ *
1968
+ * @param {string} webPropertyName
1969
+ * A fully-qualified path representing WebProperty resource.
1970
+ * @returns {string} A string representing the web_property.
1971
+ */
1972
+ matchWebPropertyFromWebPropertyName(webPropertyName) {
1973
+ return this.pathTemplates.webPropertyPathTemplate.match(webPropertyName).web_property;
1974
+ }
1975
+ /**
1976
+ * Terminate the gRPC channel and close the client.
1977
+ *
1978
+ * The client will no longer be usable and all future behavior is undefined.
1979
+ * @returns {Promise} A promise that resolves when the client is closed.
1980
+ */
1981
+ close() {
1982
+ if (this.cmsMetadataValueServiceStub && !this._terminated) {
1983
+ return this.cmsMetadataValueServiceStub.then(stub => {
1984
+ this._log.info('ending gRPC channel');
1985
+ this._terminated = true;
1986
+ stub.close();
1987
+ });
1988
+ }
1989
+ return Promise.resolve();
1990
+ }
1991
+ }
1992
+ exports.CmsMetadataValueServiceClient = CmsMetadataValueServiceClient;
1993
+ //# sourceMappingURL=cms_metadata_value_service_client.js.map