@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.
- package/README.md +68 -0
- package/build/protos/google/ads/admanager/v1/ad_break_service.proto +1 -1
- package/build/protos/google/ads/admanager/v1/ad_review_center_ad_enums.proto +44 -0
- package/build/protos/google/ads/admanager/v1/ad_review_center_ad_messages.proto +62 -0
- package/build/protos/google/ads/admanager/v1/ad_review_center_ad_service.proto +237 -0
- package/build/protos/google/ads/admanager/v1/ad_unit_messages.proto +7 -7
- package/build/protos/google/ads/admanager/v1/ad_unit_service.proto +6 -6
- package/build/protos/google/ads/admanager/v1/application_messages.proto +47 -0
- package/build/protos/google/ads/admanager/v1/application_service.proto +129 -0
- package/build/protos/google/ads/admanager/v1/audience_segment_messages.proto +49 -0
- package/build/protos/google/ads/admanager/v1/audience_segment_service.proto +129 -0
- package/build/protos/google/ads/admanager/v1/bandwidth_group_service.proto +3 -3
- package/build/protos/google/ads/admanager/v1/browser_language_messages.proto +45 -0
- package/build/protos/google/ads/admanager/v1/browser_language_service.proto +129 -0
- package/build/protos/google/ads/admanager/v1/browser_messages.proto +51 -0
- package/build/protos/google/ads/admanager/v1/browser_service.proto +128 -0
- package/build/protos/google/ads/admanager/v1/cms_metadata_key_enums.proto +41 -0
- package/build/protos/google/ads/admanager/v1/cms_metadata_key_messages.proto +50 -0
- package/build/protos/google/ads/admanager/v1/cms_metadata_key_service.proto +129 -0
- package/build/protos/google/ads/admanager/v1/cms_metadata_value_enums.proto +44 -0
- package/build/protos/google/ads/admanager/v1/cms_metadata_value_messages.proto +61 -0
- package/build/protos/google/ads/admanager/v1/cms_metadata_value_service.proto +130 -0
- package/build/protos/google/ads/admanager/v1/company_messages.proto +14 -12
- package/build/protos/google/ads/admanager/v1/company_service.proto +3 -3
- package/build/protos/google/ads/admanager/v1/contact_enums.proto +57 -0
- package/build/protos/google/ads/admanager/v1/contact_messages.proto +45 -2
- package/build/protos/google/ads/admanager/v1/contact_service.proto +244 -0
- package/build/protos/google/ads/admanager/v1/content_bundle_messages.proto +53 -0
- package/build/protos/google/ads/admanager/v1/content_bundle_service.proto +129 -0
- package/build/protos/google/ads/admanager/v1/content_label_messages.proto +45 -0
- package/build/protos/google/ads/admanager/v1/content_label_service.proto +129 -0
- package/build/protos/google/ads/admanager/v1/content_messages.proto +45 -0
- package/build/protos/google/ads/admanager/v1/content_service.proto +128 -0
- package/build/protos/google/ads/admanager/v1/creative_template_enums.proto +63 -0
- package/build/protos/google/ads/admanager/v1/creative_template_messages.proto +253 -0
- package/build/protos/google/ads/admanager/v1/creative_template_service.proto +130 -0
- package/build/protos/google/ads/admanager/v1/creative_template_variable_url_type_enum.proto +47 -0
- package/build/protos/google/ads/admanager/v1/custom_field_messages.proto +5 -2
- package/build/protos/google/ads/admanager/v1/custom_field_service.proto +185 -3
- package/build/protos/google/ads/admanager/v1/custom_targeting_key_messages.proto +7 -6
- package/build/protos/google/ads/admanager/v1/custom_targeting_key_service.proto +1 -1
- package/build/protos/google/ads/admanager/v1/custom_targeting_value_messages.proto +9 -9
- package/build/protos/google/ads/admanager/v1/custom_targeting_value_service.proto +1 -1
- package/build/protos/google/ads/admanager/v1/device_capability_messages.proto +45 -0
- package/build/protos/google/ads/admanager/v1/device_capability_service.proto +130 -0
- package/build/protos/google/ads/admanager/v1/device_category_service.proto +2 -2
- package/build/protos/google/ads/admanager/v1/device_manufacturer_messages.proto +46 -0
- package/build/protos/google/ads/admanager/v1/device_manufacturer_service.proto +131 -0
- package/build/protos/google/ads/admanager/v1/entity_signals_mapping_service.proto +1 -1
- package/build/protos/google/ads/admanager/v1/exchange_syndication_product_enum.proto +47 -0
- package/build/protos/google/ads/admanager/v1/geo_target_service.proto +3 -3
- package/build/protos/google/ads/admanager/v1/mobile_carrier_messages.proto +48 -0
- package/build/protos/google/ads/admanager/v1/mobile_carrier_service.proto +129 -0
- package/build/protos/google/ads/admanager/v1/mobile_device_messages.proto +54 -0
- package/build/protos/google/ads/admanager/v1/mobile_device_service.proto +129 -0
- package/build/protos/google/ads/admanager/v1/mobile_device_submodel_messages.proto +55 -0
- package/build/protos/google/ads/admanager/v1/mobile_device_submodel_service.proto +133 -0
- package/build/protos/google/ads/admanager/v1/operating_system_service.proto +2 -2
- package/build/protos/google/ads/admanager/v1/operating_system_version_service.proto +2 -2
- package/build/protos/google/ads/admanager/v1/order_messages.proto +7 -8
- package/build/protos/google/ads/admanager/v1/order_service.proto +3 -3
- package/build/protos/google/ads/admanager/v1/placement_service.proto +220 -3
- package/build/protos/google/ads/admanager/v1/private_auction_deal_service.proto +2 -2
- package/build/protos/google/ads/admanager/v1/private_auction_service.proto +2 -2
- package/build/protos/google/ads/admanager/v1/programmatic_buyer_service.proto +1 -1
- package/build/protos/google/ads/admanager/v1/report_definition.proto +12478 -0
- package/build/protos/google/ads/admanager/v1/report_messages.proto +118 -3410
- package/build/protos/google/ads/admanager/v1/report_service.proto +10 -8
- package/build/protos/google/ads/admanager/v1/report_value.proto +73 -0
- package/build/protos/google/ads/admanager/v1/role_service.proto +3 -2
- package/build/protos/google/ads/admanager/v1/site_enums.proto +72 -0
- package/build/protos/google/ads/admanager/v1/site_messages.proto +77 -0
- package/build/protos/google/ads/admanager/v1/site_service.proto +295 -0
- package/build/protos/google/ads/admanager/v1/targeting.proto +311 -0
- package/build/protos/google/ads/admanager/v1/taxonomy_category_service.proto +1 -1
- package/build/protos/google/ads/admanager/v1/taxonomy_type_enum.proto +3 -0
- package/build/protos/google/ads/admanager/v1/team_enums.proto +62 -0
- package/build/protos/google/ads/admanager/v1/team_messages.proto +30 -0
- package/build/protos/google/ads/admanager/v1/team_service.proto +303 -0
- package/build/protos/google/ads/admanager/v1/web_property.proto +54 -0
- package/build/protos/protos.d.ts +30764 -11410
- package/build/protos/protos.js +93644 -43318
- package/build/protos/protos.json +9909 -3734
- package/build/src/index.d.ts +58 -1
- package/build/src/index.js +40 -2
- package/build/src/index.js.map +1 -1
- package/build/src/v1/ad_break_service_client.d.ts +441 -0
- package/build/src/v1/ad_break_service_client.js +624 -0
- package/build/src/v1/ad_break_service_client.js.map +1 -1
- package/build/src/v1/ad_break_service_proto_list.json +49 -1
- package/build/src/v1/ad_review_center_ad_service_client.d.ts +1607 -0
- package/build/src/v1/ad_review_center_ad_service_client.js +2291 -0
- package/build/src/v1/ad_review_center_ad_service_client.js.map +1 -0
- package/build/src/v1/ad_review_center_ad_service_client_config.json +38 -0
- package/build/src/v1/ad_review_center_ad_service_proto_list.json +122 -0
- package/build/src/v1/ad_unit_service_client.d.ts +453 -12
- package/build/src/v1/ad_unit_service_client.js +632 -8
- package/build/src/v1/ad_unit_service_client.js.map +1 -1
- package/build/src/v1/ad_unit_service_proto_list.json +49 -1
- package/build/src/v1/application_service_client.d.ts +1345 -0
- package/build/src/v1/application_service_client.js +1993 -0
- package/build/src/v1/application_service_client.js.map +1 -0
- package/build/src/v1/application_service_client_config.json +34 -0
- package/build/src/v1/application_service_proto_list.json +122 -0
- package/build/src/v1/audience_segment_service_client.d.ts +1345 -0
- package/build/src/v1/audience_segment_service_client.js +1993 -0
- package/build/src/v1/audience_segment_service_client.js.map +1 -0
- package/build/src/v1/audience_segment_service_client_config.json +34 -0
- package/build/src/v1/audience_segment_service_proto_list.json +122 -0
- package/build/src/v1/bandwidth_group_service_client.d.ts +447 -6
- package/build/src/v1/bandwidth_group_service_client.js +628 -4
- package/build/src/v1/bandwidth_group_service_client.js.map +1 -1
- package/build/src/v1/bandwidth_group_service_proto_list.json +49 -1
- package/build/src/v1/browser_language_service_client.d.ts +1345 -0
- package/build/src/v1/browser_language_service_client.js +1993 -0
- package/build/src/v1/browser_language_service_client.js.map +1 -0
- package/build/src/v1/browser_language_service_client_config.json +34 -0
- package/build/src/v1/browser_language_service_proto_list.json +122 -0
- package/build/src/v1/browser_service_client.d.ts +1345 -0
- package/build/src/v1/browser_service_client.js +1993 -0
- package/build/src/v1/browser_service_client.js.map +1 -0
- package/build/src/v1/browser_service_client_config.json +34 -0
- package/build/src/v1/browser_service_proto_list.json +122 -0
- package/build/src/v1/cms_metadata_key_service_client.d.ts +1345 -0
- package/build/src/v1/cms_metadata_key_service_client.js +1993 -0
- package/build/src/v1/cms_metadata_key_service_client.js.map +1 -0
- package/build/src/v1/cms_metadata_key_service_client_config.json +34 -0
- package/build/src/v1/cms_metadata_key_service_proto_list.json +122 -0
- package/build/src/v1/cms_metadata_value_service_client.d.ts +1345 -0
- package/build/src/v1/cms_metadata_value_service_client.js +1993 -0
- package/build/src/v1/cms_metadata_value_service_client.js.map +1 -0
- package/build/src/v1/cms_metadata_value_service_client_config.json +34 -0
- package/build/src/v1/cms_metadata_value_service_proto_list.json +122 -0
- package/build/src/v1/company_service_client.d.ts +447 -6
- package/build/src/v1/company_service_client.js +628 -4
- package/build/src/v1/company_service_client.js.map +1 -1
- package/build/src/v1/company_service_proto_list.json +49 -1
- package/build/src/v1/contact_service_client.d.ts +1456 -0
- package/build/src/v1/contact_service_client.js +2137 -0
- package/build/src/v1/contact_service_client.js.map +1 -0
- package/build/src/v1/contact_service_client_config.json +50 -0
- package/build/src/v1/contact_service_proto_list.json +122 -0
- package/build/src/v1/content_bundle_service_client.d.ts +1345 -0
- package/build/src/v1/content_bundle_service_client.js +1993 -0
- package/build/src/v1/content_bundle_service_client.js.map +1 -0
- package/build/src/v1/content_bundle_service_client_config.json +34 -0
- package/build/src/v1/content_bundle_service_proto_list.json +122 -0
- package/build/src/v1/content_label_service_client.d.ts +1345 -0
- package/build/src/v1/content_label_service_client.js +1993 -0
- package/build/src/v1/content_label_service_client.js.map +1 -0
- package/build/src/v1/content_label_service_client_config.json +34 -0
- package/build/src/v1/content_label_service_proto_list.json +122 -0
- package/build/src/v1/content_service_client.d.ts +1345 -0
- package/build/src/v1/content_service_client.js +1993 -0
- package/build/src/v1/content_service_client.js.map +1 -0
- package/build/src/v1/content_service_client_config.json +34 -0
- package/build/src/v1/content_service_proto_list.json +122 -0
- package/build/src/v1/creative_template_service_client.d.ts +1345 -0
- package/build/src/v1/creative_template_service_client.js +1993 -0
- package/build/src/v1/creative_template_service_client.js.map +1 -0
- package/build/src/v1/creative_template_service_client_config.json +34 -0
- package/build/src/v1/creative_template_service_proto_list.json +122 -0
- package/build/src/v1/custom_field_service_client.d.ts +610 -6
- package/build/src/v1/custom_field_service_client.js +845 -5
- package/build/src/v1/custom_field_service_client.js.map +1 -1
- package/build/src/v1/custom_field_service_client_config.json +24 -0
- package/build/src/v1/custom_field_service_proto_list.json +49 -1
- package/build/src/v1/custom_targeting_key_service_client.d.ts +441 -0
- package/build/src/v1/custom_targeting_key_service_client.js +624 -0
- package/build/src/v1/custom_targeting_key_service_client.js.map +1 -1
- package/build/src/v1/custom_targeting_key_service_proto_list.json +49 -1
- package/build/src/v1/custom_targeting_value_service_client.d.ts +441 -0
- package/build/src/v1/custom_targeting_value_service_client.js +624 -0
- package/build/src/v1/custom_targeting_value_service_client.js.map +1 -1
- package/build/src/v1/custom_targeting_value_service_proto_list.json +49 -1
- package/build/src/v1/device_capability_service_client.d.ts +1345 -0
- package/build/src/v1/device_capability_service_client.js +1993 -0
- package/build/src/v1/device_capability_service_client.js.map +1 -0
- package/build/src/v1/device_capability_service_client_config.json +34 -0
- package/build/src/v1/device_capability_service_proto_list.json +122 -0
- package/build/src/v1/device_category_service_client.d.ts +444 -3
- package/build/src/v1/device_category_service_client.js +626 -2
- package/build/src/v1/device_category_service_client.js.map +1 -1
- package/build/src/v1/device_category_service_proto_list.json +49 -1
- package/build/src/v1/device_manufacturer_service_client.d.ts +1346 -0
- package/build/src/v1/device_manufacturer_service_client.js +1993 -0
- package/build/src/v1/device_manufacturer_service_client.js.map +1 -0
- package/build/src/v1/device_manufacturer_service_client_config.json +34 -0
- package/build/src/v1/device_manufacturer_service_proto_list.json +122 -0
- package/build/src/v1/entity_signals_mapping_service_client.d.ts +441 -0
- package/build/src/v1/entity_signals_mapping_service_client.js +624 -0
- package/build/src/v1/entity_signals_mapping_service_client.js.map +1 -1
- package/build/src/v1/entity_signals_mapping_service_proto_list.json +49 -1
- package/build/src/v1/gapic_metadata.json +1026 -4
- package/build/src/v1/geo_target_service_client.d.ts +447 -6
- package/build/src/v1/geo_target_service_client.js +628 -4
- package/build/src/v1/geo_target_service_client.js.map +1 -1
- package/build/src/v1/geo_target_service_proto_list.json +49 -1
- package/build/src/v1/index.d.ts +19 -0
- package/build/src/v1/index.js +39 -1
- package/build/src/v1/index.js.map +1 -1
- package/build/src/v1/mobile_carrier_service_client.d.ts +1345 -0
- package/build/src/v1/mobile_carrier_service_client.js +1993 -0
- package/build/src/v1/mobile_carrier_service_client.js.map +1 -0
- package/build/src/v1/mobile_carrier_service_client_config.json +34 -0
- package/build/src/v1/mobile_carrier_service_proto_list.json +122 -0
- package/build/src/v1/mobile_device_service_client.d.ts +1345 -0
- package/build/src/v1/mobile_device_service_client.js +1993 -0
- package/build/src/v1/mobile_device_service_client.js.map +1 -0
- package/build/src/v1/mobile_device_service_client_config.json +34 -0
- package/build/src/v1/mobile_device_service_proto_list.json +122 -0
- package/build/src/v1/mobile_device_submodel_service_client.d.ts +1352 -0
- package/build/src/v1/mobile_device_submodel_service_client.js +1997 -0
- package/build/src/v1/mobile_device_submodel_service_client.js.map +1 -0
- package/build/src/v1/mobile_device_submodel_service_client_config.json +34 -0
- package/build/src/v1/mobile_device_submodel_service_proto_list.json +122 -0
- package/build/src/v1/network_service_client.d.ts +441 -0
- package/build/src/v1/network_service_client.js +624 -0
- package/build/src/v1/network_service_client.js.map +1 -1
- package/build/src/v1/network_service_proto_list.json +49 -1
- package/build/src/v1/operating_system_service_client.d.ts +444 -3
- package/build/src/v1/operating_system_service_client.js +626 -2
- package/build/src/v1/operating_system_service_client.js.map +1 -1
- package/build/src/v1/operating_system_service_proto_list.json +49 -1
- package/build/src/v1/operating_system_version_service_client.d.ts +444 -3
- package/build/src/v1/operating_system_version_service_client.js +626 -2
- package/build/src/v1/operating_system_version_service_client.js.map +1 -1
- package/build/src/v1/operating_system_version_service_proto_list.json +49 -1
- package/build/src/v1/order_service_client.d.ts +447 -6
- package/build/src/v1/order_service_client.js +628 -4
- package/build/src/v1/order_service_client.js.map +1 -1
- package/build/src/v1/order_service_proto_list.json +49 -1
- package/build/src/v1/placement_service_client.d.ts +638 -6
- package/build/src/v1/placement_service_client.js +937 -61
- package/build/src/v1/placement_service_client.js.map +1 -1
- package/build/src/v1/placement_service_client_config.json +28 -0
- package/build/src/v1/placement_service_proto_list.json +49 -1
- package/build/src/v1/private_auction_deal_service_client.d.ts +444 -3
- package/build/src/v1/private_auction_deal_service_client.js +626 -2
- package/build/src/v1/private_auction_deal_service_client.js.map +1 -1
- package/build/src/v1/private_auction_deal_service_proto_list.json +49 -1
- package/build/src/v1/private_auction_service_client.d.ts +444 -3
- package/build/src/v1/private_auction_service_client.js +626 -2
- package/build/src/v1/private_auction_service_client.js.map +1 -1
- package/build/src/v1/private_auction_service_proto_list.json +49 -1
- package/build/src/v1/programmatic_buyer_service_client.d.ts +441 -0
- package/build/src/v1/programmatic_buyer_service_client.js +624 -0
- package/build/src/v1/programmatic_buyer_service_client.js.map +1 -1
- package/build/src/v1/programmatic_buyer_service_proto_list.json +49 -1
- package/build/src/v1/report_service_client.d.ts +461 -17
- package/build/src/v1/report_service_client.js +634 -8
- package/build/src/v1/report_service_client.js.map +1 -1
- package/build/src/v1/report_service_proto_list.json +49 -1
- package/build/src/v1/role_service_client.d.ts +447 -3
- package/build/src/v1/role_service_client.js +628 -2
- package/build/src/v1/role_service_client.js.map +1 -1
- package/build/src/v1/role_service_proto_list.json +49 -1
- package/build/src/v1/site_service_client.d.ts +1506 -0
- package/build/src/v1/site_service_client.js +2209 -0
- package/build/src/v1/site_service_client.js.map +1 -0
- package/build/src/v1/site_service_client_config.json +58 -0
- package/build/src/v1/site_service_proto_list.json +122 -0
- package/build/src/v1/taxonomy_category_service_client.d.ts +441 -0
- package/build/src/v1/taxonomy_category_service_client.js +624 -0
- package/build/src/v1/taxonomy_category_service_client.js.map +1 -1
- package/build/src/v1/taxonomy_category_service_proto_list.json +49 -1
- package/build/src/v1/team_service_client.d.ts +1508 -0
- package/build/src/v1/team_service_client.js +2209 -0
- package/build/src/v1/team_service_client.js.map +1 -0
- package/build/src/v1/team_service_client_config.json +58 -0
- package/build/src/v1/team_service_proto_list.json +122 -0
- package/build/src/v1/user_service_client.d.ts +441 -0
- package/build/src/v1/user_service_client.js +624 -0
- package/build/src/v1/user_service_client.js.map +1 -1
- package/build/src/v1/user_service_proto_list.json +49 -1
- package/package.json +1 -1
|
@@ -139,6 +139,169 @@ export declare class CustomFieldServiceClient {
|
|
|
139
139
|
]>;
|
|
140
140
|
getCustomField(request: protos.google.ads.admanager.v1.IGetCustomFieldRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.ICustomField, protos.google.ads.admanager.v1.IGetCustomFieldRequest | null | undefined, {} | null | undefined>): void;
|
|
141
141
|
getCustomField(request: protos.google.ads.admanager.v1.IGetCustomFieldRequest, callback: Callback<protos.google.ads.admanager.v1.ICustomField, protos.google.ads.admanager.v1.IGetCustomFieldRequest | null | undefined, {} | null | undefined>): void;
|
|
142
|
+
/**
|
|
143
|
+
* API to create a `CustomField` object.
|
|
144
|
+
*
|
|
145
|
+
* @param {Object} request
|
|
146
|
+
* The request object that will be sent.
|
|
147
|
+
* @param {string} request.parent
|
|
148
|
+
* Required. The parent resource where this `CustomField` will be created.
|
|
149
|
+
* Format: `networks/{network_code}`
|
|
150
|
+
* @param {google.ads.admanager.v1.CustomField} request.customField
|
|
151
|
+
* Required. The `CustomField` to create.
|
|
152
|
+
* @param {object} [options]
|
|
153
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
154
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
155
|
+
* The first element of the array is an object representing {@link protos.google.ads.admanager.v1.CustomField|CustomField}.
|
|
156
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
157
|
+
* for more details and examples.
|
|
158
|
+
* @example <caption>include:samples/generated/v1/custom_field_service.create_custom_field.js</caption>
|
|
159
|
+
* region_tag:admanager_v1_generated_CustomFieldService_CreateCustomField_async
|
|
160
|
+
*/
|
|
161
|
+
createCustomField(request?: protos.google.ads.admanager.v1.ICreateCustomFieldRequest, options?: CallOptions): Promise<[
|
|
162
|
+
protos.google.ads.admanager.v1.ICustomField,
|
|
163
|
+
protos.google.ads.admanager.v1.ICreateCustomFieldRequest | undefined,
|
|
164
|
+
{} | undefined
|
|
165
|
+
]>;
|
|
166
|
+
createCustomField(request: protos.google.ads.admanager.v1.ICreateCustomFieldRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.ICustomField, protos.google.ads.admanager.v1.ICreateCustomFieldRequest | null | undefined, {} | null | undefined>): void;
|
|
167
|
+
createCustomField(request: protos.google.ads.admanager.v1.ICreateCustomFieldRequest, callback: Callback<protos.google.ads.admanager.v1.ICustomField, protos.google.ads.admanager.v1.ICreateCustomFieldRequest | null | undefined, {} | null | undefined>): void;
|
|
168
|
+
/**
|
|
169
|
+
* API to batch create `CustomField` objects.
|
|
170
|
+
*
|
|
171
|
+
* @param {Object} request
|
|
172
|
+
* The request object that will be sent.
|
|
173
|
+
* @param {string} request.parent
|
|
174
|
+
* Required. The parent resource where `CustomFields` will be created.
|
|
175
|
+
* Format: `networks/{network_code}`
|
|
176
|
+
* The parent field in the CreateCustomFieldRequest must match this
|
|
177
|
+
* field.
|
|
178
|
+
* @param {number[]} request.requests
|
|
179
|
+
* Required. The `CustomField` objects to create.
|
|
180
|
+
* A maximum of 100 objects can be created in a batch.
|
|
181
|
+
* @param {object} [options]
|
|
182
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
183
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
184
|
+
* The first element of the array is an object representing {@link protos.google.ads.admanager.v1.BatchCreateCustomFieldsResponse|BatchCreateCustomFieldsResponse}.
|
|
185
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
186
|
+
* for more details and examples.
|
|
187
|
+
* @example <caption>include:samples/generated/v1/custom_field_service.batch_create_custom_fields.js</caption>
|
|
188
|
+
* region_tag:admanager_v1_generated_CustomFieldService_BatchCreateCustomFields_async
|
|
189
|
+
*/
|
|
190
|
+
batchCreateCustomFields(request?: protos.google.ads.admanager.v1.IBatchCreateCustomFieldsRequest, options?: CallOptions): Promise<[
|
|
191
|
+
protos.google.ads.admanager.v1.IBatchCreateCustomFieldsResponse,
|
|
192
|
+
protos.google.ads.admanager.v1.IBatchCreateCustomFieldsRequest | undefined,
|
|
193
|
+
{} | undefined
|
|
194
|
+
]>;
|
|
195
|
+
batchCreateCustomFields(request: protos.google.ads.admanager.v1.IBatchCreateCustomFieldsRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IBatchCreateCustomFieldsResponse, protos.google.ads.admanager.v1.IBatchCreateCustomFieldsRequest | null | undefined, {} | null | undefined>): void;
|
|
196
|
+
batchCreateCustomFields(request: protos.google.ads.admanager.v1.IBatchCreateCustomFieldsRequest, callback: Callback<protos.google.ads.admanager.v1.IBatchCreateCustomFieldsResponse, protos.google.ads.admanager.v1.IBatchCreateCustomFieldsRequest | null | undefined, {} | null | undefined>): void;
|
|
197
|
+
/**
|
|
198
|
+
* API to update a `CustomField` object.
|
|
199
|
+
*
|
|
200
|
+
* @param {Object} request
|
|
201
|
+
* The request object that will be sent.
|
|
202
|
+
* @param {google.ads.admanager.v1.CustomField} request.customField
|
|
203
|
+
* Required. The `CustomField` to update.
|
|
204
|
+
*
|
|
205
|
+
* The `CustomField`'s `name` is used to identify the `CustomField` to update.
|
|
206
|
+
* @param {google.protobuf.FieldMask} request.updateMask
|
|
207
|
+
* Required. The list of fields to update.
|
|
208
|
+
* @param {object} [options]
|
|
209
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
210
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
211
|
+
* The first element of the array is an object representing {@link protos.google.ads.admanager.v1.CustomField|CustomField}.
|
|
212
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
213
|
+
* for more details and examples.
|
|
214
|
+
* @example <caption>include:samples/generated/v1/custom_field_service.update_custom_field.js</caption>
|
|
215
|
+
* region_tag:admanager_v1_generated_CustomFieldService_UpdateCustomField_async
|
|
216
|
+
*/
|
|
217
|
+
updateCustomField(request?: protos.google.ads.admanager.v1.IUpdateCustomFieldRequest, options?: CallOptions): Promise<[
|
|
218
|
+
protos.google.ads.admanager.v1.ICustomField,
|
|
219
|
+
protos.google.ads.admanager.v1.IUpdateCustomFieldRequest | undefined,
|
|
220
|
+
{} | undefined
|
|
221
|
+
]>;
|
|
222
|
+
updateCustomField(request: protos.google.ads.admanager.v1.IUpdateCustomFieldRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.ICustomField, protos.google.ads.admanager.v1.IUpdateCustomFieldRequest | null | undefined, {} | null | undefined>): void;
|
|
223
|
+
updateCustomField(request: protos.google.ads.admanager.v1.IUpdateCustomFieldRequest, callback: Callback<protos.google.ads.admanager.v1.ICustomField, protos.google.ads.admanager.v1.IUpdateCustomFieldRequest | null | undefined, {} | null | undefined>): void;
|
|
224
|
+
/**
|
|
225
|
+
* API to batch update `CustomField` objects.
|
|
226
|
+
*
|
|
227
|
+
* @param {Object} request
|
|
228
|
+
* The request object that will be sent.
|
|
229
|
+
* @param {string} request.parent
|
|
230
|
+
* Required. The parent resource where `CustomFields` will be updated.
|
|
231
|
+
* Format: `networks/{network_code}`
|
|
232
|
+
* The parent field in the UpdateCustomFieldRequest must match this
|
|
233
|
+
* field.
|
|
234
|
+
* @param {number[]} request.requests
|
|
235
|
+
* Required. The `CustomField` objects to update.
|
|
236
|
+
* A maximum of 100 objects can be updated in a batch.
|
|
237
|
+
* @param {object} [options]
|
|
238
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
239
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
240
|
+
* The first element of the array is an object representing {@link protos.google.ads.admanager.v1.BatchUpdateCustomFieldsResponse|BatchUpdateCustomFieldsResponse}.
|
|
241
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
242
|
+
* for more details and examples.
|
|
243
|
+
* @example <caption>include:samples/generated/v1/custom_field_service.batch_update_custom_fields.js</caption>
|
|
244
|
+
* region_tag:admanager_v1_generated_CustomFieldService_BatchUpdateCustomFields_async
|
|
245
|
+
*/
|
|
246
|
+
batchUpdateCustomFields(request?: protos.google.ads.admanager.v1.IBatchUpdateCustomFieldsRequest, options?: CallOptions): Promise<[
|
|
247
|
+
protos.google.ads.admanager.v1.IBatchUpdateCustomFieldsResponse,
|
|
248
|
+
protos.google.ads.admanager.v1.IBatchUpdateCustomFieldsRequest | undefined,
|
|
249
|
+
{} | undefined
|
|
250
|
+
]>;
|
|
251
|
+
batchUpdateCustomFields(request: protos.google.ads.admanager.v1.IBatchUpdateCustomFieldsRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IBatchUpdateCustomFieldsResponse, protos.google.ads.admanager.v1.IBatchUpdateCustomFieldsRequest | null | undefined, {} | null | undefined>): void;
|
|
252
|
+
batchUpdateCustomFields(request: protos.google.ads.admanager.v1.IBatchUpdateCustomFieldsRequest, callback: Callback<protos.google.ads.admanager.v1.IBatchUpdateCustomFieldsResponse, protos.google.ads.admanager.v1.IBatchUpdateCustomFieldsRequest | null | undefined, {} | null | undefined>): void;
|
|
253
|
+
/**
|
|
254
|
+
* Activates a list of `CustomField` objects.
|
|
255
|
+
*
|
|
256
|
+
* @param {Object} request
|
|
257
|
+
* The request object that will be sent.
|
|
258
|
+
* @param {string} request.parent
|
|
259
|
+
* Required. Format: `networks/{network_code}`
|
|
260
|
+
* @param {string[]} request.names
|
|
261
|
+
* Required. The resource names of the `CustomField` objects to activate.
|
|
262
|
+
* Format: `networks/{network_code}/customFields/{custom_field_id}`
|
|
263
|
+
* @param {object} [options]
|
|
264
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
265
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
266
|
+
* The first element of the array is an object representing {@link protos.google.ads.admanager.v1.BatchActivateCustomFieldsResponse|BatchActivateCustomFieldsResponse}.
|
|
267
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
268
|
+
* for more details and examples.
|
|
269
|
+
* @example <caption>include:samples/generated/v1/custom_field_service.batch_activate_custom_fields.js</caption>
|
|
270
|
+
* region_tag:admanager_v1_generated_CustomFieldService_BatchActivateCustomFields_async
|
|
271
|
+
*/
|
|
272
|
+
batchActivateCustomFields(request?: protos.google.ads.admanager.v1.IBatchActivateCustomFieldsRequest, options?: CallOptions): Promise<[
|
|
273
|
+
protos.google.ads.admanager.v1.IBatchActivateCustomFieldsResponse,
|
|
274
|
+
protos.google.ads.admanager.v1.IBatchActivateCustomFieldsRequest | undefined,
|
|
275
|
+
{} | undefined
|
|
276
|
+
]>;
|
|
277
|
+
batchActivateCustomFields(request: protos.google.ads.admanager.v1.IBatchActivateCustomFieldsRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IBatchActivateCustomFieldsResponse, protos.google.ads.admanager.v1.IBatchActivateCustomFieldsRequest | null | undefined, {} | null | undefined>): void;
|
|
278
|
+
batchActivateCustomFields(request: protos.google.ads.admanager.v1.IBatchActivateCustomFieldsRequest, callback: Callback<protos.google.ads.admanager.v1.IBatchActivateCustomFieldsResponse, protos.google.ads.admanager.v1.IBatchActivateCustomFieldsRequest | null | undefined, {} | null | undefined>): void;
|
|
279
|
+
/**
|
|
280
|
+
* Deactivates a list of `CustomField` objects.
|
|
281
|
+
*
|
|
282
|
+
* @param {Object} request
|
|
283
|
+
* The request object that will be sent.
|
|
284
|
+
* @param {string} request.parent
|
|
285
|
+
* Required. Format: `networks/{network_code}`
|
|
286
|
+
* @param {string[]} request.names
|
|
287
|
+
* Required. The resource names of the `CustomField` objects to deactivate.
|
|
288
|
+
* Format: `networks/{network_code}/customFields/{custom_field_id}`
|
|
289
|
+
* @param {object} [options]
|
|
290
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
|
291
|
+
* @returns {Promise} - The promise which resolves to an array.
|
|
292
|
+
* The first element of the array is an object representing {@link protos.google.ads.admanager.v1.BatchDeactivateCustomFieldsResponse|BatchDeactivateCustomFieldsResponse}.
|
|
293
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
|
294
|
+
* for more details and examples.
|
|
295
|
+
* @example <caption>include:samples/generated/v1/custom_field_service.batch_deactivate_custom_fields.js</caption>
|
|
296
|
+
* region_tag:admanager_v1_generated_CustomFieldService_BatchDeactivateCustomFields_async
|
|
297
|
+
*/
|
|
298
|
+
batchDeactivateCustomFields(request?: protos.google.ads.admanager.v1.IBatchDeactivateCustomFieldsRequest, options?: CallOptions): Promise<[
|
|
299
|
+
protos.google.ads.admanager.v1.IBatchDeactivateCustomFieldsResponse,
|
|
300
|
+
protos.google.ads.admanager.v1.IBatchDeactivateCustomFieldsRequest | undefined,
|
|
301
|
+
{} | undefined
|
|
302
|
+
]>;
|
|
303
|
+
batchDeactivateCustomFields(request: protos.google.ads.admanager.v1.IBatchDeactivateCustomFieldsRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IBatchDeactivateCustomFieldsResponse, protos.google.ads.admanager.v1.IBatchDeactivateCustomFieldsRequest | null | undefined, {} | null | undefined>): void;
|
|
304
|
+
batchDeactivateCustomFields(request: protos.google.ads.admanager.v1.IBatchDeactivateCustomFieldsRequest, callback: Callback<protos.google.ads.admanager.v1.IBatchDeactivateCustomFieldsResponse, protos.google.ads.admanager.v1.IBatchDeactivateCustomFieldsRequest | null | undefined, {} | null | undefined>): void;
|
|
142
305
|
/**
|
|
143
306
|
* API to retrieve a list of `CustomField` objects.
|
|
144
307
|
*
|
|
@@ -150,8 +313,8 @@ export declare class CustomFieldServiceClient {
|
|
|
150
313
|
* @param {number} [request.pageSize]
|
|
151
314
|
* Optional. The maximum number of `CustomFields` to return. The service may
|
|
152
315
|
* return fewer than this value. If unspecified, at most 50 `CustomFields`
|
|
153
|
-
* will be returned. The maximum value is 1000; values
|
|
154
|
-
* coerced to 1000.
|
|
316
|
+
* will be returned. The maximum value is 1000; values greater than 1000 will
|
|
317
|
+
* be coerced to 1000.
|
|
155
318
|
* @param {string} [request.pageToken]
|
|
156
319
|
* Optional. A page token, received from a previous `ListCustomFields` call.
|
|
157
320
|
* Provide this to retrieve the subsequent page.
|
|
@@ -197,8 +360,8 @@ export declare class CustomFieldServiceClient {
|
|
|
197
360
|
* @param {number} [request.pageSize]
|
|
198
361
|
* Optional. The maximum number of `CustomFields` to return. The service may
|
|
199
362
|
* return fewer than this value. If unspecified, at most 50 `CustomFields`
|
|
200
|
-
* will be returned. The maximum value is 1000; values
|
|
201
|
-
* coerced to 1000.
|
|
363
|
+
* will be returned. The maximum value is 1000; values greater than 1000 will
|
|
364
|
+
* be coerced to 1000.
|
|
202
365
|
* @param {string} [request.pageToken]
|
|
203
366
|
* Optional. A page token, received from a previous `ListCustomFields` call.
|
|
204
367
|
* Provide this to retrieve the subsequent page.
|
|
@@ -239,8 +402,8 @@ export declare class CustomFieldServiceClient {
|
|
|
239
402
|
* @param {number} [request.pageSize]
|
|
240
403
|
* Optional. The maximum number of `CustomFields` to return. The service may
|
|
241
404
|
* return fewer than this value. If unspecified, at most 50 `CustomFields`
|
|
242
|
-
* will be returned. The maximum value is 1000; values
|
|
243
|
-
* coerced to 1000.
|
|
405
|
+
* will be returned. The maximum value is 1000; values greater than 1000 will
|
|
406
|
+
* be coerced to 1000.
|
|
244
407
|
* @param {string} [request.pageToken]
|
|
245
408
|
* Optional. A page token, received from a previous `ListCustomFields` call.
|
|
246
409
|
* Provide this to retrieve the subsequent page.
|
|
@@ -303,6 +466,39 @@ export declare class CustomFieldServiceClient {
|
|
|
303
466
|
* @returns {string} A string representing the ad_break.
|
|
304
467
|
*/
|
|
305
468
|
matchAdBreakFromAdBreakName(adBreakName: string): string | number;
|
|
469
|
+
/**
|
|
470
|
+
* Return a fully-qualified adReviewCenterAd resource name string.
|
|
471
|
+
*
|
|
472
|
+
* @param {string} network_code
|
|
473
|
+
* @param {string} web_property_code
|
|
474
|
+
* @param {string} ad_review_center_ad
|
|
475
|
+
* @returns {string} Resource name string.
|
|
476
|
+
*/
|
|
477
|
+
adReviewCenterAdPath(networkCode: string, webPropertyCode: string, adReviewCenterAd: string): string;
|
|
478
|
+
/**
|
|
479
|
+
* Parse the network_code from AdReviewCenterAd resource.
|
|
480
|
+
*
|
|
481
|
+
* @param {string} adReviewCenterAdName
|
|
482
|
+
* A fully-qualified path representing AdReviewCenterAd resource.
|
|
483
|
+
* @returns {string} A string representing the network_code.
|
|
484
|
+
*/
|
|
485
|
+
matchNetworkCodeFromAdReviewCenterAdName(adReviewCenterAdName: string): string | number;
|
|
486
|
+
/**
|
|
487
|
+
* Parse the web_property_code from AdReviewCenterAd resource.
|
|
488
|
+
*
|
|
489
|
+
* @param {string} adReviewCenterAdName
|
|
490
|
+
* A fully-qualified path representing AdReviewCenterAd resource.
|
|
491
|
+
* @returns {string} A string representing the web_property_code.
|
|
492
|
+
*/
|
|
493
|
+
matchWebPropertyCodeFromAdReviewCenterAdName(adReviewCenterAdName: string): string | number;
|
|
494
|
+
/**
|
|
495
|
+
* Parse the ad_review_center_ad from AdReviewCenterAd resource.
|
|
496
|
+
*
|
|
497
|
+
* @param {string} adReviewCenterAdName
|
|
498
|
+
* A fully-qualified path representing AdReviewCenterAd resource.
|
|
499
|
+
* @returns {string} A string representing the ad_review_center_ad.
|
|
500
|
+
*/
|
|
501
|
+
matchAdReviewCenterAdFromAdReviewCenterAdName(adReviewCenterAdName: string): string | number;
|
|
306
502
|
/**
|
|
307
503
|
* Return a fully-qualified adUnit resource name string.
|
|
308
504
|
*
|
|
@@ -327,6 +523,54 @@ export declare class CustomFieldServiceClient {
|
|
|
327
523
|
* @returns {string} A string representing the ad_unit.
|
|
328
524
|
*/
|
|
329
525
|
matchAdUnitFromAdUnitName(adUnitName: string): string | number;
|
|
526
|
+
/**
|
|
527
|
+
* Return a fully-qualified application resource name string.
|
|
528
|
+
*
|
|
529
|
+
* @param {string} network_code
|
|
530
|
+
* @param {string} application
|
|
531
|
+
* @returns {string} Resource name string.
|
|
532
|
+
*/
|
|
533
|
+
applicationPath(networkCode: string, application: string): string;
|
|
534
|
+
/**
|
|
535
|
+
* Parse the network_code from Application resource.
|
|
536
|
+
*
|
|
537
|
+
* @param {string} applicationName
|
|
538
|
+
* A fully-qualified path representing Application resource.
|
|
539
|
+
* @returns {string} A string representing the network_code.
|
|
540
|
+
*/
|
|
541
|
+
matchNetworkCodeFromApplicationName(applicationName: string): string | number;
|
|
542
|
+
/**
|
|
543
|
+
* Parse the application from Application resource.
|
|
544
|
+
*
|
|
545
|
+
* @param {string} applicationName
|
|
546
|
+
* A fully-qualified path representing Application resource.
|
|
547
|
+
* @returns {string} A string representing the application.
|
|
548
|
+
*/
|
|
549
|
+
matchApplicationFromApplicationName(applicationName: string): string | number;
|
|
550
|
+
/**
|
|
551
|
+
* Return a fully-qualified audienceSegment resource name string.
|
|
552
|
+
*
|
|
553
|
+
* @param {string} network_code
|
|
554
|
+
* @param {string} audience_segment
|
|
555
|
+
* @returns {string} Resource name string.
|
|
556
|
+
*/
|
|
557
|
+
audienceSegmentPath(networkCode: string, audienceSegment: string): string;
|
|
558
|
+
/**
|
|
559
|
+
* Parse the network_code from AudienceSegment resource.
|
|
560
|
+
*
|
|
561
|
+
* @param {string} audienceSegmentName
|
|
562
|
+
* A fully-qualified path representing AudienceSegment resource.
|
|
563
|
+
* @returns {string} A string representing the network_code.
|
|
564
|
+
*/
|
|
565
|
+
matchNetworkCodeFromAudienceSegmentName(audienceSegmentName: string): string | number;
|
|
566
|
+
/**
|
|
567
|
+
* Parse the audience_segment from AudienceSegment resource.
|
|
568
|
+
*
|
|
569
|
+
* @param {string} audienceSegmentName
|
|
570
|
+
* A fully-qualified path representing AudienceSegment resource.
|
|
571
|
+
* @returns {string} A string representing the audience_segment.
|
|
572
|
+
*/
|
|
573
|
+
matchAudienceSegmentFromAudienceSegmentName(audienceSegmentName: string): string | number;
|
|
330
574
|
/**
|
|
331
575
|
* Return a fully-qualified bandwidthGroup resource name string.
|
|
332
576
|
*
|
|
@@ -351,6 +595,102 @@ export declare class CustomFieldServiceClient {
|
|
|
351
595
|
* @returns {string} A string representing the bandwidth_group.
|
|
352
596
|
*/
|
|
353
597
|
matchBandwidthGroupFromBandwidthGroupName(bandwidthGroupName: string): string | number;
|
|
598
|
+
/**
|
|
599
|
+
* Return a fully-qualified browser resource name string.
|
|
600
|
+
*
|
|
601
|
+
* @param {string} network_code
|
|
602
|
+
* @param {string} browser
|
|
603
|
+
* @returns {string} Resource name string.
|
|
604
|
+
*/
|
|
605
|
+
browserPath(networkCode: string, browser: string): string;
|
|
606
|
+
/**
|
|
607
|
+
* Parse the network_code from Browser resource.
|
|
608
|
+
*
|
|
609
|
+
* @param {string} browserName
|
|
610
|
+
* A fully-qualified path representing Browser resource.
|
|
611
|
+
* @returns {string} A string representing the network_code.
|
|
612
|
+
*/
|
|
613
|
+
matchNetworkCodeFromBrowserName(browserName: string): string | number;
|
|
614
|
+
/**
|
|
615
|
+
* Parse the browser from Browser resource.
|
|
616
|
+
*
|
|
617
|
+
* @param {string} browserName
|
|
618
|
+
* A fully-qualified path representing Browser resource.
|
|
619
|
+
* @returns {string} A string representing the browser.
|
|
620
|
+
*/
|
|
621
|
+
matchBrowserFromBrowserName(browserName: string): string | number;
|
|
622
|
+
/**
|
|
623
|
+
* Return a fully-qualified browserLanguage resource name string.
|
|
624
|
+
*
|
|
625
|
+
* @param {string} network_code
|
|
626
|
+
* @param {string} browser_language
|
|
627
|
+
* @returns {string} Resource name string.
|
|
628
|
+
*/
|
|
629
|
+
browserLanguagePath(networkCode: string, browserLanguage: string): string;
|
|
630
|
+
/**
|
|
631
|
+
* Parse the network_code from BrowserLanguage resource.
|
|
632
|
+
*
|
|
633
|
+
* @param {string} browserLanguageName
|
|
634
|
+
* A fully-qualified path representing BrowserLanguage resource.
|
|
635
|
+
* @returns {string} A string representing the network_code.
|
|
636
|
+
*/
|
|
637
|
+
matchNetworkCodeFromBrowserLanguageName(browserLanguageName: string): string | number;
|
|
638
|
+
/**
|
|
639
|
+
* Parse the browser_language from BrowserLanguage resource.
|
|
640
|
+
*
|
|
641
|
+
* @param {string} browserLanguageName
|
|
642
|
+
* A fully-qualified path representing BrowserLanguage resource.
|
|
643
|
+
* @returns {string} A string representing the browser_language.
|
|
644
|
+
*/
|
|
645
|
+
matchBrowserLanguageFromBrowserLanguageName(browserLanguageName: string): string | number;
|
|
646
|
+
/**
|
|
647
|
+
* Return a fully-qualified cmsMetadataKey resource name string.
|
|
648
|
+
*
|
|
649
|
+
* @param {string} network_code
|
|
650
|
+
* @param {string} cms_metadata_key
|
|
651
|
+
* @returns {string} Resource name string.
|
|
652
|
+
*/
|
|
653
|
+
cmsMetadataKeyPath(networkCode: string, cmsMetadataKey: string): string;
|
|
654
|
+
/**
|
|
655
|
+
* Parse the network_code from CmsMetadataKey resource.
|
|
656
|
+
*
|
|
657
|
+
* @param {string} cmsMetadataKeyName
|
|
658
|
+
* A fully-qualified path representing CmsMetadataKey resource.
|
|
659
|
+
* @returns {string} A string representing the network_code.
|
|
660
|
+
*/
|
|
661
|
+
matchNetworkCodeFromCmsMetadataKeyName(cmsMetadataKeyName: string): string | number;
|
|
662
|
+
/**
|
|
663
|
+
* Parse the cms_metadata_key from CmsMetadataKey resource.
|
|
664
|
+
*
|
|
665
|
+
* @param {string} cmsMetadataKeyName
|
|
666
|
+
* A fully-qualified path representing CmsMetadataKey resource.
|
|
667
|
+
* @returns {string} A string representing the cms_metadata_key.
|
|
668
|
+
*/
|
|
669
|
+
matchCmsMetadataKeyFromCmsMetadataKeyName(cmsMetadataKeyName: string): string | number;
|
|
670
|
+
/**
|
|
671
|
+
* Return a fully-qualified cmsMetadataValue resource name string.
|
|
672
|
+
*
|
|
673
|
+
* @param {string} network_code
|
|
674
|
+
* @param {string} cms_metadata_value
|
|
675
|
+
* @returns {string} Resource name string.
|
|
676
|
+
*/
|
|
677
|
+
cmsMetadataValuePath(networkCode: string, cmsMetadataValue: string): string;
|
|
678
|
+
/**
|
|
679
|
+
* Parse the network_code from CmsMetadataValue resource.
|
|
680
|
+
*
|
|
681
|
+
* @param {string} cmsMetadataValueName
|
|
682
|
+
* A fully-qualified path representing CmsMetadataValue resource.
|
|
683
|
+
* @returns {string} A string representing the network_code.
|
|
684
|
+
*/
|
|
685
|
+
matchNetworkCodeFromCmsMetadataValueName(cmsMetadataValueName: string): string | number;
|
|
686
|
+
/**
|
|
687
|
+
* Parse the cms_metadata_value from CmsMetadataValue resource.
|
|
688
|
+
*
|
|
689
|
+
* @param {string} cmsMetadataValueName
|
|
690
|
+
* A fully-qualified path representing CmsMetadataValue resource.
|
|
691
|
+
* @returns {string} A string representing the cms_metadata_value.
|
|
692
|
+
*/
|
|
693
|
+
matchCmsMetadataValueFromCmsMetadataValueName(cmsMetadataValueName: string): string | number;
|
|
354
694
|
/**
|
|
355
695
|
* Return a fully-qualified company resource name string.
|
|
356
696
|
*
|
|
@@ -399,6 +739,102 @@ export declare class CustomFieldServiceClient {
|
|
|
399
739
|
* @returns {string} A string representing the contact.
|
|
400
740
|
*/
|
|
401
741
|
matchContactFromContactName(contactName: string): string | number;
|
|
742
|
+
/**
|
|
743
|
+
* Return a fully-qualified content resource name string.
|
|
744
|
+
*
|
|
745
|
+
* @param {string} network_code
|
|
746
|
+
* @param {string} content
|
|
747
|
+
* @returns {string} Resource name string.
|
|
748
|
+
*/
|
|
749
|
+
contentPath(networkCode: string, content: string): string;
|
|
750
|
+
/**
|
|
751
|
+
* Parse the network_code from Content resource.
|
|
752
|
+
*
|
|
753
|
+
* @param {string} contentName
|
|
754
|
+
* A fully-qualified path representing Content resource.
|
|
755
|
+
* @returns {string} A string representing the network_code.
|
|
756
|
+
*/
|
|
757
|
+
matchNetworkCodeFromContentName(contentName: string): string | number;
|
|
758
|
+
/**
|
|
759
|
+
* Parse the content from Content resource.
|
|
760
|
+
*
|
|
761
|
+
* @param {string} contentName
|
|
762
|
+
* A fully-qualified path representing Content resource.
|
|
763
|
+
* @returns {string} A string representing the content.
|
|
764
|
+
*/
|
|
765
|
+
matchContentFromContentName(contentName: string): string | number;
|
|
766
|
+
/**
|
|
767
|
+
* Return a fully-qualified contentBundle resource name string.
|
|
768
|
+
*
|
|
769
|
+
* @param {string} network_code
|
|
770
|
+
* @param {string} content_bundle
|
|
771
|
+
* @returns {string} Resource name string.
|
|
772
|
+
*/
|
|
773
|
+
contentBundlePath(networkCode: string, contentBundle: string): string;
|
|
774
|
+
/**
|
|
775
|
+
* Parse the network_code from ContentBundle resource.
|
|
776
|
+
*
|
|
777
|
+
* @param {string} contentBundleName
|
|
778
|
+
* A fully-qualified path representing ContentBundle resource.
|
|
779
|
+
* @returns {string} A string representing the network_code.
|
|
780
|
+
*/
|
|
781
|
+
matchNetworkCodeFromContentBundleName(contentBundleName: string): string | number;
|
|
782
|
+
/**
|
|
783
|
+
* Parse the content_bundle from ContentBundle resource.
|
|
784
|
+
*
|
|
785
|
+
* @param {string} contentBundleName
|
|
786
|
+
* A fully-qualified path representing ContentBundle resource.
|
|
787
|
+
* @returns {string} A string representing the content_bundle.
|
|
788
|
+
*/
|
|
789
|
+
matchContentBundleFromContentBundleName(contentBundleName: string): string | number;
|
|
790
|
+
/**
|
|
791
|
+
* Return a fully-qualified contentLabel resource name string.
|
|
792
|
+
*
|
|
793
|
+
* @param {string} network_code
|
|
794
|
+
* @param {string} content_label
|
|
795
|
+
* @returns {string} Resource name string.
|
|
796
|
+
*/
|
|
797
|
+
contentLabelPath(networkCode: string, contentLabel: string): string;
|
|
798
|
+
/**
|
|
799
|
+
* Parse the network_code from ContentLabel resource.
|
|
800
|
+
*
|
|
801
|
+
* @param {string} contentLabelName
|
|
802
|
+
* A fully-qualified path representing ContentLabel resource.
|
|
803
|
+
* @returns {string} A string representing the network_code.
|
|
804
|
+
*/
|
|
805
|
+
matchNetworkCodeFromContentLabelName(contentLabelName: string): string | number;
|
|
806
|
+
/**
|
|
807
|
+
* Parse the content_label from ContentLabel resource.
|
|
808
|
+
*
|
|
809
|
+
* @param {string} contentLabelName
|
|
810
|
+
* A fully-qualified path representing ContentLabel resource.
|
|
811
|
+
* @returns {string} A string representing the content_label.
|
|
812
|
+
*/
|
|
813
|
+
matchContentLabelFromContentLabelName(contentLabelName: string): string | number;
|
|
814
|
+
/**
|
|
815
|
+
* Return a fully-qualified creativeTemplate resource name string.
|
|
816
|
+
*
|
|
817
|
+
* @param {string} network_code
|
|
818
|
+
* @param {string} creative_template
|
|
819
|
+
* @returns {string} Resource name string.
|
|
820
|
+
*/
|
|
821
|
+
creativeTemplatePath(networkCode: string, creativeTemplate: string): string;
|
|
822
|
+
/**
|
|
823
|
+
* Parse the network_code from CreativeTemplate resource.
|
|
824
|
+
*
|
|
825
|
+
* @param {string} creativeTemplateName
|
|
826
|
+
* A fully-qualified path representing CreativeTemplate resource.
|
|
827
|
+
* @returns {string} A string representing the network_code.
|
|
828
|
+
*/
|
|
829
|
+
matchNetworkCodeFromCreativeTemplateName(creativeTemplateName: string): string | number;
|
|
830
|
+
/**
|
|
831
|
+
* Parse the creative_template from CreativeTemplate resource.
|
|
832
|
+
*
|
|
833
|
+
* @param {string} creativeTemplateName
|
|
834
|
+
* A fully-qualified path representing CreativeTemplate resource.
|
|
835
|
+
* @returns {string} A string representing the creative_template.
|
|
836
|
+
*/
|
|
837
|
+
matchCreativeTemplateFromCreativeTemplateName(creativeTemplateName: string): string | number;
|
|
402
838
|
/**
|
|
403
839
|
* Return a fully-qualified customField resource name string.
|
|
404
840
|
*
|
|
@@ -471,6 +907,30 @@ export declare class CustomFieldServiceClient {
|
|
|
471
907
|
* @returns {string} A string representing the custom_targeting_value.
|
|
472
908
|
*/
|
|
473
909
|
matchCustomTargetingValueFromCustomTargetingValueName(customTargetingValueName: string): string | number;
|
|
910
|
+
/**
|
|
911
|
+
* Return a fully-qualified deviceCapability resource name string.
|
|
912
|
+
*
|
|
913
|
+
* @param {string} network_code
|
|
914
|
+
* @param {string} device_capability
|
|
915
|
+
* @returns {string} Resource name string.
|
|
916
|
+
*/
|
|
917
|
+
deviceCapabilityPath(networkCode: string, deviceCapability: string): string;
|
|
918
|
+
/**
|
|
919
|
+
* Parse the network_code from DeviceCapability resource.
|
|
920
|
+
*
|
|
921
|
+
* @param {string} deviceCapabilityName
|
|
922
|
+
* A fully-qualified path representing DeviceCapability resource.
|
|
923
|
+
* @returns {string} A string representing the network_code.
|
|
924
|
+
*/
|
|
925
|
+
matchNetworkCodeFromDeviceCapabilityName(deviceCapabilityName: string): string | number;
|
|
926
|
+
/**
|
|
927
|
+
* Parse the device_capability from DeviceCapability resource.
|
|
928
|
+
*
|
|
929
|
+
* @param {string} deviceCapabilityName
|
|
930
|
+
* A fully-qualified path representing DeviceCapability resource.
|
|
931
|
+
* @returns {string} A string representing the device_capability.
|
|
932
|
+
*/
|
|
933
|
+
matchDeviceCapabilityFromDeviceCapabilityName(deviceCapabilityName: string): string | number;
|
|
474
934
|
/**
|
|
475
935
|
* Return a fully-qualified deviceCategory resource name string.
|
|
476
936
|
*
|
|
@@ -495,6 +955,30 @@ export declare class CustomFieldServiceClient {
|
|
|
495
955
|
* @returns {string} A string representing the device_category.
|
|
496
956
|
*/
|
|
497
957
|
matchDeviceCategoryFromDeviceCategoryName(deviceCategoryName: string): string | number;
|
|
958
|
+
/**
|
|
959
|
+
* Return a fully-qualified deviceManufacturer resource name string.
|
|
960
|
+
*
|
|
961
|
+
* @param {string} network_code
|
|
962
|
+
* @param {string} device_manufacturer
|
|
963
|
+
* @returns {string} Resource name string.
|
|
964
|
+
*/
|
|
965
|
+
deviceManufacturerPath(networkCode: string, deviceManufacturer: string): string;
|
|
966
|
+
/**
|
|
967
|
+
* Parse the network_code from DeviceManufacturer resource.
|
|
968
|
+
*
|
|
969
|
+
* @param {string} deviceManufacturerName
|
|
970
|
+
* A fully-qualified path representing DeviceManufacturer resource.
|
|
971
|
+
* @returns {string} A string representing the network_code.
|
|
972
|
+
*/
|
|
973
|
+
matchNetworkCodeFromDeviceManufacturerName(deviceManufacturerName: string): string | number;
|
|
974
|
+
/**
|
|
975
|
+
* Parse the device_manufacturer from DeviceManufacturer resource.
|
|
976
|
+
*
|
|
977
|
+
* @param {string} deviceManufacturerName
|
|
978
|
+
* A fully-qualified path representing DeviceManufacturer resource.
|
|
979
|
+
* @returns {string} A string representing the device_manufacturer.
|
|
980
|
+
*/
|
|
981
|
+
matchDeviceManufacturerFromDeviceManufacturerName(deviceManufacturerName: string): string | number;
|
|
498
982
|
/**
|
|
499
983
|
* Return a fully-qualified entitySignalsMapping resource name string.
|
|
500
984
|
*
|
|
@@ -591,6 +1075,78 @@ export declare class CustomFieldServiceClient {
|
|
|
591
1075
|
* @returns {string} A string representing the live_stream_event.
|
|
592
1076
|
*/
|
|
593
1077
|
matchLiveStreamEventFromLiveStreamEventName(liveStreamEventName: string): string | number;
|
|
1078
|
+
/**
|
|
1079
|
+
* Return a fully-qualified mobileCarrier resource name string.
|
|
1080
|
+
*
|
|
1081
|
+
* @param {string} network_code
|
|
1082
|
+
* @param {string} mobile_carrier
|
|
1083
|
+
* @returns {string} Resource name string.
|
|
1084
|
+
*/
|
|
1085
|
+
mobileCarrierPath(networkCode: string, mobileCarrier: string): string;
|
|
1086
|
+
/**
|
|
1087
|
+
* Parse the network_code from MobileCarrier resource.
|
|
1088
|
+
*
|
|
1089
|
+
* @param {string} mobileCarrierName
|
|
1090
|
+
* A fully-qualified path representing MobileCarrier resource.
|
|
1091
|
+
* @returns {string} A string representing the network_code.
|
|
1092
|
+
*/
|
|
1093
|
+
matchNetworkCodeFromMobileCarrierName(mobileCarrierName: string): string | number;
|
|
1094
|
+
/**
|
|
1095
|
+
* Parse the mobile_carrier from MobileCarrier resource.
|
|
1096
|
+
*
|
|
1097
|
+
* @param {string} mobileCarrierName
|
|
1098
|
+
* A fully-qualified path representing MobileCarrier resource.
|
|
1099
|
+
* @returns {string} A string representing the mobile_carrier.
|
|
1100
|
+
*/
|
|
1101
|
+
matchMobileCarrierFromMobileCarrierName(mobileCarrierName: string): string | number;
|
|
1102
|
+
/**
|
|
1103
|
+
* Return a fully-qualified mobileDevice resource name string.
|
|
1104
|
+
*
|
|
1105
|
+
* @param {string} network_code
|
|
1106
|
+
* @param {string} mobile_device
|
|
1107
|
+
* @returns {string} Resource name string.
|
|
1108
|
+
*/
|
|
1109
|
+
mobileDevicePath(networkCode: string, mobileDevice: string): string;
|
|
1110
|
+
/**
|
|
1111
|
+
* Parse the network_code from MobileDevice resource.
|
|
1112
|
+
*
|
|
1113
|
+
* @param {string} mobileDeviceName
|
|
1114
|
+
* A fully-qualified path representing MobileDevice resource.
|
|
1115
|
+
* @returns {string} A string representing the network_code.
|
|
1116
|
+
*/
|
|
1117
|
+
matchNetworkCodeFromMobileDeviceName(mobileDeviceName: string): string | number;
|
|
1118
|
+
/**
|
|
1119
|
+
* Parse the mobile_device from MobileDevice resource.
|
|
1120
|
+
*
|
|
1121
|
+
* @param {string} mobileDeviceName
|
|
1122
|
+
* A fully-qualified path representing MobileDevice resource.
|
|
1123
|
+
* @returns {string} A string representing the mobile_device.
|
|
1124
|
+
*/
|
|
1125
|
+
matchMobileDeviceFromMobileDeviceName(mobileDeviceName: string): string | number;
|
|
1126
|
+
/**
|
|
1127
|
+
* Return a fully-qualified mobileDeviceSubmodel resource name string.
|
|
1128
|
+
*
|
|
1129
|
+
* @param {string} network_code
|
|
1130
|
+
* @param {string} mobile_device_submodel
|
|
1131
|
+
* @returns {string} Resource name string.
|
|
1132
|
+
*/
|
|
1133
|
+
mobileDeviceSubmodelPath(networkCode: string, mobileDeviceSubmodel: string): string;
|
|
1134
|
+
/**
|
|
1135
|
+
* Parse the network_code from MobileDeviceSubmodel resource.
|
|
1136
|
+
*
|
|
1137
|
+
* @param {string} mobileDeviceSubmodelName
|
|
1138
|
+
* A fully-qualified path representing MobileDeviceSubmodel resource.
|
|
1139
|
+
* @returns {string} A string representing the network_code.
|
|
1140
|
+
*/
|
|
1141
|
+
matchNetworkCodeFromMobileDeviceSubmodelName(mobileDeviceSubmodelName: string): string | number;
|
|
1142
|
+
/**
|
|
1143
|
+
* Parse the mobile_device_submodel from MobileDeviceSubmodel resource.
|
|
1144
|
+
*
|
|
1145
|
+
* @param {string} mobileDeviceSubmodelName
|
|
1146
|
+
* A fully-qualified path representing MobileDeviceSubmodel resource.
|
|
1147
|
+
* @returns {string} A string representing the mobile_device_submodel.
|
|
1148
|
+
*/
|
|
1149
|
+
matchMobileDeviceSubmodelFromMobileDeviceSubmodelName(mobileDeviceSubmodelName: string): string | number;
|
|
594
1150
|
/**
|
|
595
1151
|
* Return a fully-qualified network resource name string.
|
|
596
1152
|
*
|
|
@@ -822,6 +1378,30 @@ export declare class CustomFieldServiceClient {
|
|
|
822
1378
|
* @returns {string} A string representing the role.
|
|
823
1379
|
*/
|
|
824
1380
|
matchRoleFromRoleName(roleName: string): string | number;
|
|
1381
|
+
/**
|
|
1382
|
+
* Return a fully-qualified site resource name string.
|
|
1383
|
+
*
|
|
1384
|
+
* @param {string} network_code
|
|
1385
|
+
* @param {string} site
|
|
1386
|
+
* @returns {string} Resource name string.
|
|
1387
|
+
*/
|
|
1388
|
+
sitePath(networkCode: string, site: string): string;
|
|
1389
|
+
/**
|
|
1390
|
+
* Parse the network_code from Site resource.
|
|
1391
|
+
*
|
|
1392
|
+
* @param {string} siteName
|
|
1393
|
+
* A fully-qualified path representing Site resource.
|
|
1394
|
+
* @returns {string} A string representing the network_code.
|
|
1395
|
+
*/
|
|
1396
|
+
matchNetworkCodeFromSiteName(siteName: string): string | number;
|
|
1397
|
+
/**
|
|
1398
|
+
* Parse the site from Site resource.
|
|
1399
|
+
*
|
|
1400
|
+
* @param {string} siteName
|
|
1401
|
+
* A fully-qualified path representing Site resource.
|
|
1402
|
+
* @returns {string} A string representing the site.
|
|
1403
|
+
*/
|
|
1404
|
+
matchSiteFromSiteName(siteName: string): string | number;
|
|
825
1405
|
/**
|
|
826
1406
|
* Return a fully-qualified taxonomyCategory resource name string.
|
|
827
1407
|
*
|
|
@@ -894,6 +1474,30 @@ export declare class CustomFieldServiceClient {
|
|
|
894
1474
|
* @returns {string} A string representing the user.
|
|
895
1475
|
*/
|
|
896
1476
|
matchUserFromUserName(userName: string): string | number;
|
|
1477
|
+
/**
|
|
1478
|
+
* Return a fully-qualified webProperty resource name string.
|
|
1479
|
+
*
|
|
1480
|
+
* @param {string} network_code
|
|
1481
|
+
* @param {string} web_property
|
|
1482
|
+
* @returns {string} Resource name string.
|
|
1483
|
+
*/
|
|
1484
|
+
webPropertyPath(networkCode: string, webProperty: string): string;
|
|
1485
|
+
/**
|
|
1486
|
+
* Parse the network_code from WebProperty resource.
|
|
1487
|
+
*
|
|
1488
|
+
* @param {string} webPropertyName
|
|
1489
|
+
* A fully-qualified path representing WebProperty resource.
|
|
1490
|
+
* @returns {string} A string representing the network_code.
|
|
1491
|
+
*/
|
|
1492
|
+
matchNetworkCodeFromWebPropertyName(webPropertyName: string): string | number;
|
|
1493
|
+
/**
|
|
1494
|
+
* Parse the web_property from WebProperty resource.
|
|
1495
|
+
*
|
|
1496
|
+
* @param {string} webPropertyName
|
|
1497
|
+
* A fully-qualified path representing WebProperty resource.
|
|
1498
|
+
* @returns {string} A string representing the web_property.
|
|
1499
|
+
*/
|
|
1500
|
+
matchWebPropertyFromWebPropertyName(webPropertyName: string): string | number;
|
|
897
1501
|
/**
|
|
898
1502
|
* Terminate the gRPC channel and close the client.
|
|
899
1503
|
*
|