@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
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
// Copyright 2025 Google LLC
|
|
2
|
+
//
|
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
// you may not use this file except in compliance with the License.
|
|
5
|
+
// You may obtain a copy of the License at
|
|
6
|
+
//
|
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
//
|
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
// See the License for the specific language governing permissions and
|
|
13
|
+
// limitations under the License.
|
|
14
|
+
|
|
15
|
+
syntax = "proto3";
|
|
16
|
+
|
|
17
|
+
package google.ads.admanager.v1;
|
|
18
|
+
|
|
19
|
+
import "google/ads/admanager/v1/content_label_messages.proto";
|
|
20
|
+
import "google/api/annotations.proto";
|
|
21
|
+
import "google/api/client.proto";
|
|
22
|
+
import "google/api/field_behavior.proto";
|
|
23
|
+
import "google/api/resource.proto";
|
|
24
|
+
|
|
25
|
+
option csharp_namespace = "Google.Ads.AdManager.V1";
|
|
26
|
+
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
|
|
27
|
+
option java_multiple_files = true;
|
|
28
|
+
option java_outer_classname = "ContentLabelServiceProto";
|
|
29
|
+
option java_package = "com.google.ads.admanager.v1";
|
|
30
|
+
option php_namespace = "Google\\Ads\\AdManager\\V1";
|
|
31
|
+
option ruby_package = "Google::Ads::AdManager::V1";
|
|
32
|
+
|
|
33
|
+
// Provides methods for handling `ContentLabel` objects.
|
|
34
|
+
service ContentLabelService {
|
|
35
|
+
option (google.api.default_host) = "admanager.googleapis.com";
|
|
36
|
+
option (google.api.oauth_scopes) =
|
|
37
|
+
"https://www.googleapis.com/auth/admanager";
|
|
38
|
+
|
|
39
|
+
// API to retrieve a `ContentLabel` object.
|
|
40
|
+
rpc GetContentLabel(GetContentLabelRequest) returns (ContentLabel) {
|
|
41
|
+
option (google.api.http) = {
|
|
42
|
+
get: "/v1/{name=networks/*/contentLabels/*}"
|
|
43
|
+
};
|
|
44
|
+
option (google.api.method_signature) = "name";
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
// API to retrieve a list of `ContentLabel` objects.
|
|
48
|
+
rpc ListContentLabels(ListContentLabelsRequest)
|
|
49
|
+
returns (ListContentLabelsResponse) {
|
|
50
|
+
option (google.api.http) = {
|
|
51
|
+
get: "/v1/{parent=networks/*}/contentLabels"
|
|
52
|
+
};
|
|
53
|
+
option (google.api.method_signature) = "parent";
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
// Request object for `GetContentLabel` method.
|
|
58
|
+
message GetContentLabelRequest {
|
|
59
|
+
// Required. The resource name of the ContentLabel.
|
|
60
|
+
// Format: `networks/{network_code}/contentLabels/{content_label_id}`
|
|
61
|
+
string name = 1 [
|
|
62
|
+
(google.api.field_behavior) = REQUIRED,
|
|
63
|
+
(google.api.resource_reference) = {
|
|
64
|
+
type: "admanager.googleapis.com/ContentLabel"
|
|
65
|
+
}
|
|
66
|
+
];
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
// Request object for `ListContentLabels` method.
|
|
70
|
+
message ListContentLabelsRequest {
|
|
71
|
+
// Required. The parent, which owns this collection of ContentLabels.
|
|
72
|
+
// Format: `networks/{network_code}`
|
|
73
|
+
string parent = 1 [
|
|
74
|
+
(google.api.field_behavior) = REQUIRED,
|
|
75
|
+
(google.api.resource_reference) = {
|
|
76
|
+
type: "admanager.googleapis.com/Network"
|
|
77
|
+
}
|
|
78
|
+
];
|
|
79
|
+
|
|
80
|
+
// Optional. The maximum number of `ContentLabels` to return. The service may
|
|
81
|
+
// return fewer than this value. If unspecified, at most 50 `ContentLabels`
|
|
82
|
+
// will be returned. The maximum value is 1000; values greater than 1000 will
|
|
83
|
+
// be coerced to 1000.
|
|
84
|
+
int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
|
|
85
|
+
|
|
86
|
+
// Optional. A page token, received from a previous `ListContentLabels` call.
|
|
87
|
+
// Provide this to retrieve the subsequent page.
|
|
88
|
+
//
|
|
89
|
+
// When paginating, all other parameters provided to `ListContentLabels` must
|
|
90
|
+
// match the call that provided the page token.
|
|
91
|
+
string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
|
|
92
|
+
|
|
93
|
+
// Optional. Expression to filter the response.
|
|
94
|
+
// See syntax details at
|
|
95
|
+
// https://developers.google.com/ad-manager/api/beta/filters
|
|
96
|
+
string filter = 4 [(google.api.field_behavior) = OPTIONAL];
|
|
97
|
+
|
|
98
|
+
// Optional. Expression to specify sorting order.
|
|
99
|
+
// See syntax details at
|
|
100
|
+
// https://developers.google.com/ad-manager/api/beta/filters#order
|
|
101
|
+
string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
|
|
102
|
+
|
|
103
|
+
// Optional. Number of individual resources to skip while paginating.
|
|
104
|
+
int32 skip = 6 [(google.api.field_behavior) = OPTIONAL];
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
// Response object for `ListContentLabelsRequest` containing matching
|
|
108
|
+
// `ContentLabel` objects.
|
|
109
|
+
message ListContentLabelsResponse {
|
|
110
|
+
// The `ContentLabel` objects from the specified network.
|
|
111
|
+
repeated ContentLabel content_labels = 1;
|
|
112
|
+
|
|
113
|
+
// A token, which can be sent as `page_token` to retrieve the next page.
|
|
114
|
+
// If this field is omitted, there are no subsequent pages.
|
|
115
|
+
string next_page_token = 2;
|
|
116
|
+
|
|
117
|
+
// Total number of `ContentLabel` objects.
|
|
118
|
+
// If a filter was included in the request, this reflects the total number
|
|
119
|
+
// after the filtering is applied.
|
|
120
|
+
//
|
|
121
|
+
// `total_size` won't be calculated in the response unless it has been
|
|
122
|
+
// included in a response field mask. The response field mask can be provided
|
|
123
|
+
// to the method by using the URL parameter `$fields` or `fields`, or by using
|
|
124
|
+
// the HTTP/gRPC header `X-Goog-FieldMask`.
|
|
125
|
+
//
|
|
126
|
+
// For more information, see
|
|
127
|
+
// https://developers.google.com/ad-manager/api/beta/field-masks
|
|
128
|
+
int32 total_size = 3;
|
|
129
|
+
}
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
// Copyright 2025 Google LLC
|
|
2
|
+
//
|
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
// you may not use this file except in compliance with the License.
|
|
5
|
+
// You may obtain a copy of the License at
|
|
6
|
+
//
|
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
//
|
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
// See the License for the specific language governing permissions and
|
|
13
|
+
// limitations under the License.
|
|
14
|
+
|
|
15
|
+
syntax = "proto3";
|
|
16
|
+
|
|
17
|
+
package google.ads.admanager.v1;
|
|
18
|
+
|
|
19
|
+
import "google/api/field_behavior.proto";
|
|
20
|
+
import "google/api/resource.proto";
|
|
21
|
+
|
|
22
|
+
option csharp_namespace = "Google.Ads.AdManager.V1";
|
|
23
|
+
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
|
|
24
|
+
option java_multiple_files = true;
|
|
25
|
+
option java_outer_classname = "ContentMessagesProto";
|
|
26
|
+
option java_package = "com.google.ads.admanager.v1";
|
|
27
|
+
option php_namespace = "Google\\Ads\\AdManager\\V1";
|
|
28
|
+
option ruby_package = "Google::Ads::AdManager::V1";
|
|
29
|
+
|
|
30
|
+
// A piece of content from a Publisher's CMS.
|
|
31
|
+
message Content {
|
|
32
|
+
option (google.api.resource) = {
|
|
33
|
+
type: "admanager.googleapis.com/Content"
|
|
34
|
+
pattern: "networks/{network_code}/content/{content}"
|
|
35
|
+
plural: "content"
|
|
36
|
+
singular: "content"
|
|
37
|
+
};
|
|
38
|
+
|
|
39
|
+
// Identifier. The resource name of the `Content`.
|
|
40
|
+
// Format: `networks/{network_code}/content/{content_id}`
|
|
41
|
+
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
|
|
42
|
+
|
|
43
|
+
// Output only. The name of the `Content`.
|
|
44
|
+
optional string display_name = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
45
|
+
}
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
// Copyright 2025 Google LLC
|
|
2
|
+
//
|
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
// you may not use this file except in compliance with the License.
|
|
5
|
+
// You may obtain a copy of the License at
|
|
6
|
+
//
|
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
//
|
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
// See the License for the specific language governing permissions and
|
|
13
|
+
// limitations under the License.
|
|
14
|
+
|
|
15
|
+
syntax = "proto3";
|
|
16
|
+
|
|
17
|
+
package google.ads.admanager.v1;
|
|
18
|
+
|
|
19
|
+
import "google/ads/admanager/v1/content_messages.proto";
|
|
20
|
+
import "google/api/annotations.proto";
|
|
21
|
+
import "google/api/client.proto";
|
|
22
|
+
import "google/api/field_behavior.proto";
|
|
23
|
+
import "google/api/resource.proto";
|
|
24
|
+
|
|
25
|
+
option csharp_namespace = "Google.Ads.AdManager.V1";
|
|
26
|
+
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
|
|
27
|
+
option java_multiple_files = true;
|
|
28
|
+
option java_outer_classname = "ContentServiceProto";
|
|
29
|
+
option java_package = "com.google.ads.admanager.v1";
|
|
30
|
+
option php_namespace = "Google\\Ads\\AdManager\\V1";
|
|
31
|
+
option ruby_package = "Google::Ads::AdManager::V1";
|
|
32
|
+
|
|
33
|
+
// Provides methods for handling `Content` objects.
|
|
34
|
+
service ContentService {
|
|
35
|
+
option (google.api.default_host) = "admanager.googleapis.com";
|
|
36
|
+
option (google.api.oauth_scopes) =
|
|
37
|
+
"https://www.googleapis.com/auth/admanager";
|
|
38
|
+
|
|
39
|
+
// API to retrieve a `Content` object.
|
|
40
|
+
rpc GetContent(GetContentRequest) returns (Content) {
|
|
41
|
+
option (google.api.http) = {
|
|
42
|
+
get: "/v1/{name=networks/*/content/*}"
|
|
43
|
+
};
|
|
44
|
+
option (google.api.method_signature) = "name";
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
// API to retrieve a list of `Content` objects.
|
|
48
|
+
rpc ListContent(ListContentRequest) returns (ListContentResponse) {
|
|
49
|
+
option (google.api.http) = {
|
|
50
|
+
get: "/v1/{parent=networks/*}/content"
|
|
51
|
+
};
|
|
52
|
+
option (google.api.method_signature) = "parent";
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
// Request object for `GetContent` method.
|
|
57
|
+
message GetContentRequest {
|
|
58
|
+
// Required. The resource name of the Content.
|
|
59
|
+
// Format: `networks/{network_code}/content/{content_id}`
|
|
60
|
+
string name = 1 [
|
|
61
|
+
(google.api.field_behavior) = REQUIRED,
|
|
62
|
+
(google.api.resource_reference) = {
|
|
63
|
+
type: "admanager.googleapis.com/Content"
|
|
64
|
+
}
|
|
65
|
+
];
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
// Request object for `ListContent` method.
|
|
69
|
+
message ListContentRequest {
|
|
70
|
+
// Required. The parent, which owns this collection of Content.
|
|
71
|
+
// Format: `networks/{network_code}`
|
|
72
|
+
string parent = 1 [
|
|
73
|
+
(google.api.field_behavior) = REQUIRED,
|
|
74
|
+
(google.api.resource_reference) = {
|
|
75
|
+
type: "admanager.googleapis.com/Network"
|
|
76
|
+
}
|
|
77
|
+
];
|
|
78
|
+
|
|
79
|
+
// Optional. The maximum number of `Content` to return. The service may return
|
|
80
|
+
// fewer than this value. If unspecified, at most 50 `Content` will be
|
|
81
|
+
// returned. The maximum value is 1000; values greater than 1000 will be
|
|
82
|
+
// coerced to 1000.
|
|
83
|
+
int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
|
|
84
|
+
|
|
85
|
+
// Optional. A page token, received from a previous `ListContent` call.
|
|
86
|
+
// Provide this to retrieve the subsequent page.
|
|
87
|
+
//
|
|
88
|
+
// When paginating, all other parameters provided to `ListContent` must
|
|
89
|
+
// match the call that provided the page token.
|
|
90
|
+
string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
|
|
91
|
+
|
|
92
|
+
// Optional. Expression to filter the response.
|
|
93
|
+
// See syntax details at
|
|
94
|
+
// https://developers.google.com/ad-manager/api/beta/filters
|
|
95
|
+
string filter = 4 [(google.api.field_behavior) = OPTIONAL];
|
|
96
|
+
|
|
97
|
+
// Optional. Expression to specify sorting order.
|
|
98
|
+
// See syntax details at
|
|
99
|
+
// https://developers.google.com/ad-manager/api/beta/filters#order
|
|
100
|
+
string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
|
|
101
|
+
|
|
102
|
+
// Optional. Number of individual resources to skip while paginating.
|
|
103
|
+
int32 skip = 6 [(google.api.field_behavior) = OPTIONAL];
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
// Response object for `ListContentRequest` containing matching `Content`
|
|
107
|
+
// objects.
|
|
108
|
+
message ListContentResponse {
|
|
109
|
+
// The `Content` objects from the specified network.
|
|
110
|
+
repeated Content content = 1;
|
|
111
|
+
|
|
112
|
+
// A token, which can be sent as `page_token` to retrieve the next page.
|
|
113
|
+
// If this field is omitted, there are no subsequent pages.
|
|
114
|
+
string next_page_token = 2;
|
|
115
|
+
|
|
116
|
+
// Total number of `Content` objects.
|
|
117
|
+
// If a filter was included in the request, this reflects the total number
|
|
118
|
+
// after the filtering is applied.
|
|
119
|
+
//
|
|
120
|
+
// `total_size` won't be calculated in the response unless it has been
|
|
121
|
+
// included in a response field mask. The response field mask can be provided
|
|
122
|
+
// to the method by using the URL parameter `$fields` or `fields`, or by using
|
|
123
|
+
// the HTTP/gRPC header `X-Goog-FieldMask`.
|
|
124
|
+
//
|
|
125
|
+
// For more information, see
|
|
126
|
+
// https://developers.google.com/ad-manager/api/beta/field-masks
|
|
127
|
+
int32 total_size = 3;
|
|
128
|
+
}
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
// Copyright 2025 Google LLC
|
|
2
|
+
//
|
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
// you may not use this file except in compliance with the License.
|
|
5
|
+
// You may obtain a copy of the License at
|
|
6
|
+
//
|
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
//
|
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
// See the License for the specific language governing permissions and
|
|
13
|
+
// limitations under the License.
|
|
14
|
+
|
|
15
|
+
syntax = "proto3";
|
|
16
|
+
|
|
17
|
+
package google.ads.admanager.v1;
|
|
18
|
+
|
|
19
|
+
option csharp_namespace = "Google.Ads.AdManager.V1";
|
|
20
|
+
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
|
|
21
|
+
option java_multiple_files = true;
|
|
22
|
+
option java_outer_classname = "CreativeTemplateEnumsProto";
|
|
23
|
+
option java_package = "com.google.ads.admanager.v1";
|
|
24
|
+
option php_namespace = "Google\\Ads\\AdManager\\V1";
|
|
25
|
+
option ruby_package = "Google::Ads::AdManager::V1";
|
|
26
|
+
|
|
27
|
+
// Wrapper message for
|
|
28
|
+
// [CreativeTemplateType][google.ads.admanager.v1.CreativeTemplateTypeEnum.CreativeTemplateType]
|
|
29
|
+
message CreativeTemplateTypeEnum {
|
|
30
|
+
// Describes type of the creative template.
|
|
31
|
+
enum CreativeTemplateType {
|
|
32
|
+
// Default value. This value is unused.
|
|
33
|
+
CREATIVE_TEMPLATE_TYPE_UNSPECIFIED = 0;
|
|
34
|
+
|
|
35
|
+
// Creative templates that are included in Ad Manager by default.
|
|
36
|
+
STANDARD = 1;
|
|
37
|
+
|
|
38
|
+
// Creative templates created by an administrator or other user in the
|
|
39
|
+
// network.
|
|
40
|
+
CUSTOM = 2;
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
// Wrapper message for
|
|
45
|
+
// [CreativeTemplateStatus][google.ads.admanager.v1.CreativeTemplateStatusEnum.CreativeTemplateStatus]
|
|
46
|
+
message CreativeTemplateStatusEnum {
|
|
47
|
+
// Describes status of the creative template
|
|
48
|
+
enum CreativeTemplateStatus {
|
|
49
|
+
// Default value. This value is unused.
|
|
50
|
+
CREATIVE_TEMPLATE_STATUS_UNSPECIFIED = 0;
|
|
51
|
+
|
|
52
|
+
// The CreativeTemplate is active
|
|
53
|
+
ACTIVE = 1;
|
|
54
|
+
|
|
55
|
+
// The CreativeTemplate is deleted. Creatives created from this
|
|
56
|
+
// CreativeTemplate can no longer serve.
|
|
57
|
+
DELETED = 2;
|
|
58
|
+
|
|
59
|
+
// The CreativeTemplate is inactive. Users cannot create new creatives
|
|
60
|
+
// from this template, but existing ones can be edited and continue to serve
|
|
61
|
+
INACTIVE = 3;
|
|
62
|
+
}
|
|
63
|
+
}
|
|
@@ -0,0 +1,253 @@
|
|
|
1
|
+
// Copyright 2025 Google LLC
|
|
2
|
+
//
|
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
// you may not use this file except in compliance with the License.
|
|
5
|
+
// You may obtain a copy of the License at
|
|
6
|
+
//
|
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
//
|
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
// See the License for the specific language governing permissions and
|
|
13
|
+
// limitations under the License.
|
|
14
|
+
|
|
15
|
+
syntax = "proto3";
|
|
16
|
+
|
|
17
|
+
package google.ads.admanager.v1;
|
|
18
|
+
|
|
19
|
+
import "google/ads/admanager/v1/creative_template_enums.proto";
|
|
20
|
+
import "google/ads/admanager/v1/creative_template_variable_url_type_enum.proto";
|
|
21
|
+
import "google/api/field_behavior.proto";
|
|
22
|
+
import "google/api/resource.proto";
|
|
23
|
+
|
|
24
|
+
option csharp_namespace = "Google.Ads.AdManager.V1";
|
|
25
|
+
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
|
|
26
|
+
option java_multiple_files = true;
|
|
27
|
+
option java_outer_classname = "CreativeTemplateMessagesProto";
|
|
28
|
+
option java_package = "com.google.ads.admanager.v1";
|
|
29
|
+
option php_namespace = "Google\\Ads\\AdManager\\V1";
|
|
30
|
+
option ruby_package = "Google::Ads::AdManager::V1";
|
|
31
|
+
|
|
32
|
+
// A template that can be used to create a [TemplateCreative][].
|
|
33
|
+
message CreativeTemplate {
|
|
34
|
+
option (google.api.resource) = {
|
|
35
|
+
type: "admanager.googleapis.com/CreativeTemplate"
|
|
36
|
+
pattern: "networks/{network_code}/creativeTemplates/{creative_template}"
|
|
37
|
+
plural: "creativeTemplates"
|
|
38
|
+
singular: "creativeTemplate"
|
|
39
|
+
};
|
|
40
|
+
|
|
41
|
+
// Identifier. The resource name of the creative template.
|
|
42
|
+
// Format: `networks/{network_code}/creativeTemplates/{creative_template_id}`
|
|
43
|
+
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
|
|
44
|
+
|
|
45
|
+
// Required. The display name of the creative template. This has a maximum
|
|
46
|
+
// length of 255 characters.
|
|
47
|
+
optional string display_name = 2 [(google.api.field_behavior) = REQUIRED];
|
|
48
|
+
|
|
49
|
+
// Optional. The description of the creative template.
|
|
50
|
+
optional string description = 3 [(google.api.field_behavior) = OPTIONAL];
|
|
51
|
+
|
|
52
|
+
// Required. The code snippet of the creative template, with placeholders for
|
|
53
|
+
// the associated variables.
|
|
54
|
+
optional string snippet = 4 [(google.api.field_behavior) = REQUIRED];
|
|
55
|
+
|
|
56
|
+
// Output only. The status of the creative template. This attribute is
|
|
57
|
+
// assigned by Google.
|
|
58
|
+
optional CreativeTemplateStatusEnum.CreativeTemplateStatus status = 6
|
|
59
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
60
|
+
|
|
61
|
+
// Optional. The type of the creative template. Users can only create or
|
|
62
|
+
// update `CreativeTemplateType.CUSTOM` templates.
|
|
63
|
+
optional CreativeTemplateTypeEnum.CreativeTemplateType type = 7
|
|
64
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
65
|
+
|
|
66
|
+
// Optional. `True` if this creative template produces out-of-page creatives.
|
|
67
|
+
// Creative templates with this setting enabled must include the viewed
|
|
68
|
+
// impression macro.
|
|
69
|
+
optional bool interstitial = 8 [(google.api.field_behavior) = OPTIONAL];
|
|
70
|
+
|
|
71
|
+
// Optional. `True` if this creative template produces native-eligible
|
|
72
|
+
// creatives.
|
|
73
|
+
optional bool native_eligible = 9 [(google.api.field_behavior) = OPTIONAL];
|
|
74
|
+
|
|
75
|
+
// Optional. `True` if this creative template produces native video-eligible
|
|
76
|
+
// creatives.
|
|
77
|
+
optional bool native_video_eligible = 10
|
|
78
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
79
|
+
|
|
80
|
+
// Optional. Whether the Creative produced is compatible for SafeFrame
|
|
81
|
+
// rendering. This attribute defaults to `True`.
|
|
82
|
+
optional bool safe_frame_compatible = 12
|
|
83
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
84
|
+
|
|
85
|
+
// Required. The list of creative template variables.
|
|
86
|
+
repeated CreativeTemplateVariable variables = 14
|
|
87
|
+
[(google.api.field_behavior) = REQUIRED];
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
// Represents a variable defined in a creative template.
|
|
91
|
+
message CreativeTemplateVariable {
|
|
92
|
+
// Represents a file asset variable defined in a creative template.
|
|
93
|
+
//
|
|
94
|
+
// Use [AssetCreativeTemplateVariableValue][] to specify the value for this
|
|
95
|
+
// variable when creating a [TemplateCreative][] from a
|
|
96
|
+
// [CreativeTemplate][google.ads.admanager.v1.CreativeTemplate].
|
|
97
|
+
message AssetCreativeTemplateVariable {
|
|
98
|
+
// Different MIME types that the asset variable supports.
|
|
99
|
+
enum MimeType {
|
|
100
|
+
// Default value. This value is unused.
|
|
101
|
+
MIME_TYPE_UNSPECIFIED = 0;
|
|
102
|
+
|
|
103
|
+
// The `image/jpeg` MIME type.
|
|
104
|
+
JPG = 1;
|
|
105
|
+
|
|
106
|
+
// The `image/png` MIME type.
|
|
107
|
+
PNG = 2;
|
|
108
|
+
|
|
109
|
+
// The `image/gif` MIME type.
|
|
110
|
+
GIF = 3;
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
// Optional. The set of allowed MIME types. If unspecified, all MIME types
|
|
114
|
+
// are allowed.
|
|
115
|
+
repeated MimeType mime_types = 1 [(google.api.field_behavior) = OPTIONAL];
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
// Represents a list variable defined in a creative template. This is similar
|
|
119
|
+
// to
|
|
120
|
+
// [StringCreativeTemplateVariable][google.ads.admanager.v1.CreativeTemplateVariable.StringCreativeTemplateVariable],
|
|
121
|
+
// except that there are possible choices to choose from.
|
|
122
|
+
//
|
|
123
|
+
// Use [StringCreativeTemplateVariableValue][] to specify the value
|
|
124
|
+
// for this variable when creating a [TemplateCreative][] from a
|
|
125
|
+
// [CreativeTemplate][google.ads.admanager.v1.CreativeTemplate].
|
|
126
|
+
message ListStringCreativeTemplateVariable {
|
|
127
|
+
// Stores variable choices selectable by users.
|
|
128
|
+
message VariableChoice {
|
|
129
|
+
// Required. A label is displayed to users when creating a
|
|
130
|
+
// [TemplateCreative][]. This attribute is intended to be more descriptive
|
|
131
|
+
// than value. This attribute has a maximum length of 255 characters.
|
|
132
|
+
optional string label = 1 [(google.api.field_behavior) = REQUIRED];
|
|
133
|
+
|
|
134
|
+
// Required. When creating a [TemplateCreative][], the value in
|
|
135
|
+
// [StringCreativeTemplateVariableValue][] should match this value, if you
|
|
136
|
+
// intend to select this value. This attribute has a maximum length of 255
|
|
137
|
+
// characters.
|
|
138
|
+
optional string value = 2 [(google.api.field_behavior) = REQUIRED];
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
// Optional. Default value to be filled in when creating creatives from the
|
|
142
|
+
// creative template.
|
|
143
|
+
optional string default_value = 1 [(google.api.field_behavior) = OPTIONAL];
|
|
144
|
+
|
|
145
|
+
// Optional. Sample value that is used when previewing the template in the
|
|
146
|
+
// UI.
|
|
147
|
+
optional string sample_value = 2 [(google.api.field_behavior) = OPTIONAL];
|
|
148
|
+
|
|
149
|
+
// Optional. The selectable values that the user can choose from.
|
|
150
|
+
repeated VariableChoice choices = 3
|
|
151
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
152
|
+
|
|
153
|
+
// Optional. `True` if a user can specify an 'other' value. For example, if
|
|
154
|
+
// a variable called backgroundColor is defined as a list with values: red,
|
|
155
|
+
// green, blue, this boolean can be set to allow a user to enter a value not
|
|
156
|
+
// on the list such as purple.
|
|
157
|
+
optional bool allow_other_choice = 4
|
|
158
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
// Represents a long variable defined in a creative template.
|
|
162
|
+
//
|
|
163
|
+
// Use [LongCreativeTemplateVariableValue][] to specify the value
|
|
164
|
+
// for this variable when creating [TemplateCreative][] from a
|
|
165
|
+
// [CreativeTemplate][google.ads.admanager.v1.CreativeTemplate].
|
|
166
|
+
message LongCreativeTemplateVariable {
|
|
167
|
+
// Optional. Default value to be filled in when creating creatives from the
|
|
168
|
+
// creative template.
|
|
169
|
+
optional int64 default_value = 1 [(google.api.field_behavior) = OPTIONAL];
|
|
170
|
+
|
|
171
|
+
// Optional. Sample value that is used when previewing the template in the
|
|
172
|
+
// UI.
|
|
173
|
+
optional int64 sample_value = 2 [(google.api.field_behavior) = OPTIONAL];
|
|
174
|
+
}
|
|
175
|
+
|
|
176
|
+
// Represents a string variable defined in a creative template.
|
|
177
|
+
//
|
|
178
|
+
// Use [StringCreativeTemplateVariableValue][] to specify the value
|
|
179
|
+
// for this variable when creating [TemplateCreative][] from a
|
|
180
|
+
// [CreativeTemplate][google.ads.admanager.v1.CreativeTemplate].
|
|
181
|
+
message StringCreativeTemplateVariable {
|
|
182
|
+
// Optional. Default value to be filled in when creating creatives from the
|
|
183
|
+
// creative template.
|
|
184
|
+
optional string default_value = 1 [(google.api.field_behavior) = OPTIONAL];
|
|
185
|
+
|
|
186
|
+
// Optional. Sample value that is used when previewing the template in the
|
|
187
|
+
// UI.
|
|
188
|
+
optional string sample_value = 2 [(google.api.field_behavior) = OPTIONAL];
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
// Represents a url variable defined in a creative template.
|
|
192
|
+
//
|
|
193
|
+
// Use [UrlCreativeTemplateVariableValue][] to specify the value for this
|
|
194
|
+
// variable when creating a [TemplateCreative][] from a
|
|
195
|
+
// [CreativeTemplate][google.ads.admanager.v1.CreativeTemplate].
|
|
196
|
+
message UrlCreativeTemplateVariable {
|
|
197
|
+
// Optional. Default value to be filled in when creating creatives from the
|
|
198
|
+
// creative template.
|
|
199
|
+
optional string default_value = 1 [(google.api.field_behavior) = OPTIONAL];
|
|
200
|
+
|
|
201
|
+
// Optional. Sample value that is used when previewing the template in the
|
|
202
|
+
// UI.
|
|
203
|
+
optional string sample_value = 2 [(google.api.field_behavior) = OPTIONAL];
|
|
204
|
+
|
|
205
|
+
// Optional. The type of URL that this variable represents. Different types
|
|
206
|
+
// of URLs may be handled differently at rendering time.
|
|
207
|
+
optional CreativeTemplateVariableUrlTypeEnum.CreativeTemplateVariableUrlType
|
|
208
|
+
url_type = 4 [(google.api.field_behavior) = OPTIONAL];
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
// The specific type of variable represented by this
|
|
212
|
+
// [CreativeTemplateVariable][google.ads.admanager.v1.CreativeTemplateVariable].
|
|
213
|
+
// Exactly one must be set.
|
|
214
|
+
oneof SubType {
|
|
215
|
+
// Optional. Represents a file asset variable defined in a creative
|
|
216
|
+
// template.
|
|
217
|
+
AssetCreativeTemplateVariable asset_variable = 5
|
|
218
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
219
|
+
|
|
220
|
+
// Optional. Represents a list variable defined in a creative template.
|
|
221
|
+
ListStringCreativeTemplateVariable list_string_variable = 7
|
|
222
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
223
|
+
|
|
224
|
+
// Optional. Represents a long variable defined in a creative template.
|
|
225
|
+
LongCreativeTemplateVariable long_variable = 8
|
|
226
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
227
|
+
|
|
228
|
+
// Optional. Represents a string variable defined in a creative template.
|
|
229
|
+
StringCreativeTemplateVariable string_variable = 9
|
|
230
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
231
|
+
|
|
232
|
+
// Optional. Represents a url variable defined in a creative template.
|
|
233
|
+
UrlCreativeTemplateVariable url_variable = 10
|
|
234
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
// Required. Label that is displayed to users when creating from the creative
|
|
238
|
+
// template. This has a maximum length of 127 characters.
|
|
239
|
+
optional string label = 1 [(google.api.field_behavior) = REQUIRED];
|
|
240
|
+
|
|
241
|
+
// Output only. Unique name used to identify the variable. This attribute is
|
|
242
|
+
// assigned by Google when a creative template variable is created.
|
|
243
|
+
optional string unique_display_name = 2
|
|
244
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
245
|
+
|
|
246
|
+
// Required. A descriptive help text that is displayed to users along with the
|
|
247
|
+
// label. This attribute has a maximum length of 255 characters.
|
|
248
|
+
optional string description = 3 [(google.api.field_behavior) = REQUIRED];
|
|
249
|
+
|
|
250
|
+
// Optional. `True` if this variable is required to be filled in by users when
|
|
251
|
+
// creating a creative from the creative template.
|
|
252
|
+
optional bool required = 4 [(google.api.field_behavior) = OPTIONAL];
|
|
253
|
+
}
|