@google-ads/admanager 0.4.1 → 0.5.1
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 +83 -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 +238 -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 +222 -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 +191 -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/goal.proto +57 -0
- package/build/protos/google/ads/admanager/v1/goal_enums.proto +129 -0
- package/build/protos/google/ads/admanager/v1/line_item_enums.proto +86 -0
- package/build/protos/google/ads/admanager/v1/line_item_messages.proto +93 -0
- package/build/protos/google/ads/admanager/v1/line_item_service.proto +128 -0
- 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/network_messages.proto +8 -8
- package/build/protos/google/ads/admanager/v1/network_service.proto +32 -1
- 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 +11 -10
- 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 +13347 -0
- package/build/protos/google/ads/admanager/v1/report_messages.proto +124 -3411
- 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 +34075 -11179
- package/build/protos/protos.js +102857 -43311
- package/build/protos/protos.json +11142 -3881
- package/build/src/index.d.ts +61 -1
- package/build/src/index.js +43 -3
- package/build/src/index.js.map +1 -1
- package/build/src/v1/ad_break_service_client.d.ts +465 -0
- package/build/src/v1/ad_break_service_client.js +659 -1
- package/build/src/v1/ad_break_service_client.js.map +1 -1
- package/build/src/v1/ad_break_service_proto_list.json +54 -1
- package/build/src/v1/ad_review_center_ad_service_client.d.ts +1634 -0
- package/build/src/v1/ad_review_center_ad_service_client.js +2327 -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 +127 -0
- package/build/src/v1/ad_unit_service_client.d.ts +667 -12
- package/build/src/v1/ad_unit_service_client.js +966 -56
- package/build/src/v1/ad_unit_service_client.js.map +1 -1
- package/build/src/v1/ad_unit_service_client_config.json +28 -0
- package/build/src/v1/ad_unit_service_proto_list.json +54 -1
- package/build/src/v1/application_service_client.d.ts +1369 -0
- package/build/src/v1/application_service_client.js +2027 -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 +127 -0
- package/build/src/v1/audience_segment_service_client.d.ts +1369 -0
- package/build/src/v1/audience_segment_service_client.js +2027 -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 +127 -0
- package/build/src/v1/bandwidth_group_service_client.d.ts +471 -6
- package/build/src/v1/bandwidth_group_service_client.js +663 -5
- package/build/src/v1/bandwidth_group_service_client.js.map +1 -1
- package/build/src/v1/bandwidth_group_service_proto_list.json +54 -1
- package/build/src/v1/browser_language_service_client.d.ts +1369 -0
- package/build/src/v1/browser_language_service_client.js +2027 -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 +127 -0
- package/build/src/v1/browser_service_client.d.ts +1369 -0
- package/build/src/v1/browser_service_client.js +2027 -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 +127 -0
- package/build/src/v1/cms_metadata_key_service_client.d.ts +1369 -0
- package/build/src/v1/cms_metadata_key_service_client.js +2027 -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 +127 -0
- package/build/src/v1/cms_metadata_value_service_client.d.ts +1369 -0
- package/build/src/v1/cms_metadata_value_service_client.js +2027 -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 +127 -0
- package/build/src/v1/company_service_client.d.ts +471 -6
- package/build/src/v1/company_service_client.js +663 -5
- package/build/src/v1/company_service_client.js.map +1 -1
- package/build/src/v1/company_service_proto_list.json +54 -1
- package/build/src/v1/contact_service_client.d.ts +1480 -0
- package/build/src/v1/contact_service_client.js +2171 -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 +127 -0
- package/build/src/v1/content_bundle_service_client.d.ts +1369 -0
- package/build/src/v1/content_bundle_service_client.js +2027 -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 +127 -0
- package/build/src/v1/content_label_service_client.d.ts +1369 -0
- package/build/src/v1/content_label_service_client.js +2027 -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 +127 -0
- package/build/src/v1/content_service_client.d.ts +1369 -0
- package/build/src/v1/content_service_client.js +2027 -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 +127 -0
- package/build/src/v1/creative_template_service_client.d.ts +1369 -0
- package/build/src/v1/creative_template_service_client.js +2027 -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 +127 -0
- package/build/src/v1/custom_field_service_client.d.ts +634 -6
- package/build/src/v1/custom_field_service_client.js +880 -6
- 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 +54 -1
- package/build/src/v1/custom_targeting_key_service_client.d.ts +631 -0
- package/build/src/v1/custom_targeting_key_service_client.js +876 -2
- package/build/src/v1/custom_targeting_key_service_client.js.map +1 -1
- package/build/src/v1/custom_targeting_key_service_client_config.json +24 -0
- package/build/src/v1/custom_targeting_key_service_proto_list.json +54 -1
- package/build/src/v1/custom_targeting_value_service_client.d.ts +465 -0
- package/build/src/v1/custom_targeting_value_service_client.js +659 -1
- package/build/src/v1/custom_targeting_value_service_client.js.map +1 -1
- package/build/src/v1/custom_targeting_value_service_proto_list.json +54 -1
- package/build/src/v1/device_capability_service_client.d.ts +1369 -0
- package/build/src/v1/device_capability_service_client.js +2027 -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 +127 -0
- package/build/src/v1/device_category_service_client.d.ts +468 -3
- package/build/src/v1/device_category_service_client.js +661 -3
- package/build/src/v1/device_category_service_client.js.map +1 -1
- package/build/src/v1/device_category_service_proto_list.json +54 -1
- package/build/src/v1/device_manufacturer_service_client.d.ts +1370 -0
- package/build/src/v1/device_manufacturer_service_client.js +2027 -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 +127 -0
- package/build/src/v1/entity_signals_mapping_service_client.d.ts +465 -0
- package/build/src/v1/entity_signals_mapping_service_client.js +659 -1
- package/build/src/v1/entity_signals_mapping_service_client.js.map +1 -1
- package/build/src/v1/entity_signals_mapping_service_proto_list.json +54 -1
- package/build/src/v1/gapic_metadata.json +1200 -6
- package/build/src/v1/geo_target_service_client.d.ts +471 -6
- package/build/src/v1/geo_target_service_client.js +663 -5
- package/build/src/v1/geo_target_service_client.js.map +1 -1
- package/build/src/v1/geo_target_service_proto_list.json +54 -1
- package/build/src/v1/index.d.ts +20 -0
- package/build/src/v1/index.js +42 -2
- package/build/src/v1/index.js.map +1 -1
- package/build/src/v1/line_item_service_client.d.ts +1369 -0
- package/build/src/v1/line_item_service_client.js +2027 -0
- package/build/src/v1/line_item_service_client.js.map +1 -0
- package/build/src/v1/line_item_service_client_config.json +34 -0
- package/build/src/v1/line_item_service_proto_list.json +127 -0
- package/build/src/v1/mobile_carrier_service_client.d.ts +1369 -0
- package/build/src/v1/mobile_carrier_service_client.js +2027 -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 +127 -0
- package/build/src/v1/mobile_device_service_client.d.ts +1369 -0
- package/build/src/v1/mobile_device_service_client.js +2027 -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 +127 -0
- package/build/src/v1/mobile_device_submodel_service_client.d.ts +1376 -0
- package/build/src/v1/mobile_device_submodel_service_client.js +2031 -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 +127 -0
- package/build/src/v1/network_service_client.d.ts +555 -12
- package/build/src/v1/network_service_client.js +757 -16
- package/build/src/v1/network_service_client.js.map +1 -1
- package/build/src/v1/network_service_proto_list.json +54 -1
- package/build/src/v1/operating_system_service_client.d.ts +468 -3
- package/build/src/v1/operating_system_service_client.js +661 -3
- package/build/src/v1/operating_system_service_client.js.map +1 -1
- package/build/src/v1/operating_system_service_proto_list.json +54 -1
- package/build/src/v1/operating_system_version_service_client.d.ts +468 -3
- package/build/src/v1/operating_system_version_service_client.js +661 -3
- package/build/src/v1/operating_system_version_service_client.js.map +1 -1
- package/build/src/v1/operating_system_version_service_proto_list.json +54 -1
- package/build/src/v1/order_service_client.d.ts +471 -6
- package/build/src/v1/order_service_client.js +663 -5
- package/build/src/v1/order_service_client.js.map +1 -1
- package/build/src/v1/order_service_proto_list.json +54 -1
- package/build/src/v1/placement_service_client.d.ts +662 -6
- package/build/src/v1/placement_service_client.js +962 -52
- 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 +54 -1
- package/build/src/v1/private_auction_deal_service_client.d.ts +468 -3
- package/build/src/v1/private_auction_deal_service_client.js +661 -3
- package/build/src/v1/private_auction_deal_service_client.js.map +1 -1
- package/build/src/v1/private_auction_deal_service_proto_list.json +54 -1
- package/build/src/v1/private_auction_service_client.d.ts +468 -3
- package/build/src/v1/private_auction_service_client.js +661 -3
- package/build/src/v1/private_auction_service_client.js.map +1 -1
- package/build/src/v1/private_auction_service_proto_list.json +54 -1
- package/build/src/v1/programmatic_buyer_service_client.d.ts +465 -0
- package/build/src/v1/programmatic_buyer_service_client.js +659 -1
- package/build/src/v1/programmatic_buyer_service_client.js.map +1 -1
- package/build/src/v1/programmatic_buyer_service_proto_list.json +54 -1
- package/build/src/v1/report_service_client.d.ts +485 -17
- package/build/src/v1/report_service_client.js +669 -9
- package/build/src/v1/report_service_client.js.map +1 -1
- package/build/src/v1/report_service_proto_list.json +54 -1
- package/build/src/v1/role_service_client.d.ts +471 -3
- package/build/src/v1/role_service_client.js +663 -3
- package/build/src/v1/role_service_client.js.map +1 -1
- package/build/src/v1/role_service_proto_list.json +54 -1
- package/build/src/v1/site_service_client.d.ts +1530 -0
- package/build/src/v1/site_service_client.js +2243 -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 +127 -0
- package/build/src/v1/taxonomy_category_service_client.d.ts +465 -0
- package/build/src/v1/taxonomy_category_service_client.js +659 -1
- package/build/src/v1/taxonomy_category_service_client.js.map +1 -1
- package/build/src/v1/taxonomy_category_service_proto_list.json +54 -1
- package/build/src/v1/team_service_client.d.ts +1532 -0
- package/build/src/v1/team_service_client.js +2243 -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 +127 -0
- package/build/src/v1/user_service_client.d.ts +465 -0
- package/build/src/v1/user_service_client.js +659 -1
- package/build/src/v1/user_service_client.js.map +1 -1
- package/build/src/v1/user_service_proto_list.json +54 -1
- package/package.json +10 -2
- package/LICENSE +0 -202
|
@@ -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
|
+
}
|
|
@@ -0,0 +1,130 @@
|
|
|
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_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 = "CreativeTemplateServiceProto";
|
|
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 `CreativeTemplate` objects.
|
|
34
|
+
service CreativeTemplateService {
|
|
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 `CreativeTemplate` object.
|
|
40
|
+
rpc GetCreativeTemplate(GetCreativeTemplateRequest)
|
|
41
|
+
returns (CreativeTemplate) {
|
|
42
|
+
option (google.api.http) = {
|
|
43
|
+
get: "/v1/{name=networks/*/creativeTemplates/*}"
|
|
44
|
+
};
|
|
45
|
+
option (google.api.method_signature) = "name";
|
|
46
|
+
}
|
|
47
|
+
|
|
48
|
+
// API to retrieve a list of `CreativeTemplate` objects.
|
|
49
|
+
rpc ListCreativeTemplates(ListCreativeTemplatesRequest)
|
|
50
|
+
returns (ListCreativeTemplatesResponse) {
|
|
51
|
+
option (google.api.http) = {
|
|
52
|
+
get: "/v1/{parent=networks/*}/creativeTemplates"
|
|
53
|
+
};
|
|
54
|
+
option (google.api.method_signature) = "parent";
|
|
55
|
+
}
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
// Request object for `GetCreativeTemplate` method.
|
|
59
|
+
message GetCreativeTemplateRequest {
|
|
60
|
+
// Required. The resource name of the CreativeTemplate.
|
|
61
|
+
// Format: `networks/{network_code}/creativeTemplates/{creative_template_id}`
|
|
62
|
+
string name = 1 [
|
|
63
|
+
(google.api.field_behavior) = REQUIRED,
|
|
64
|
+
(google.api.resource_reference) = {
|
|
65
|
+
type: "admanager.googleapis.com/CreativeTemplate"
|
|
66
|
+
}
|
|
67
|
+
];
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
// Request object for `ListCreativeTemplates` method.
|
|
71
|
+
message ListCreativeTemplatesRequest {
|
|
72
|
+
// Required. The parent, which owns this collection of CreativeTemplates.
|
|
73
|
+
// Format: `networks/{network_code}`
|
|
74
|
+
string parent = 1 [
|
|
75
|
+
(google.api.field_behavior) = REQUIRED,
|
|
76
|
+
(google.api.resource_reference) = {
|
|
77
|
+
type: "admanager.googleapis.com/Network"
|
|
78
|
+
}
|
|
79
|
+
];
|
|
80
|
+
|
|
81
|
+
// Optional. The maximum number of `CreativeTemplates` to return. The service
|
|
82
|
+
// may return fewer than this value. If unspecified, at most 50
|
|
83
|
+
// `CreativeTemplates` will be returned. The maximum value is 1000; values
|
|
84
|
+
// greater than 1000 will be coerced to 1000.
|
|
85
|
+
int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
|
|
86
|
+
|
|
87
|
+
// Optional. A page token, received from a previous `ListCreativeTemplates`
|
|
88
|
+
// call. Provide this to retrieve the subsequent page.
|
|
89
|
+
//
|
|
90
|
+
// When paginating, all other parameters provided to `ListCreativeTemplates`
|
|
91
|
+
// must match the call that provided the page token.
|
|
92
|
+
string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
|
|
93
|
+
|
|
94
|
+
// Optional. Expression to filter the response.
|
|
95
|
+
// See syntax details at
|
|
96
|
+
// https://developers.google.com/ad-manager/api/beta/filters
|
|
97
|
+
string filter = 4 [(google.api.field_behavior) = OPTIONAL];
|
|
98
|
+
|
|
99
|
+
// Optional. Expression to specify sorting order.
|
|
100
|
+
// See syntax details at
|
|
101
|
+
// https://developers.google.com/ad-manager/api/beta/filters#order
|
|
102
|
+
string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
|
|
103
|
+
|
|
104
|
+
// Optional. Number of individual resources to skip while paginating.
|
|
105
|
+
int32 skip = 6 [(google.api.field_behavior) = OPTIONAL];
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
// Response object for `ListCreativeTemplatesRequest` containing matching
|
|
109
|
+
// `CreativeTemplate` objects.
|
|
110
|
+
message ListCreativeTemplatesResponse {
|
|
111
|
+
// The `CreativeTemplate` objects from the specified network.
|
|
112
|
+
repeated CreativeTemplate creative_templates = 1;
|
|
113
|
+
|
|
114
|
+
// A token, which can be sent as `page_token` to retrieve the next page.
|
|
115
|
+
// If this field is omitted, there are no subsequent pages.
|
|
116
|
+
string next_page_token = 2;
|
|
117
|
+
|
|
118
|
+
// Total number of `CreativeTemplate` objects.
|
|
119
|
+
// If a filter was included in the request, this reflects the total number
|
|
120
|
+
// after the filtering is applied.
|
|
121
|
+
//
|
|
122
|
+
// `total_size` won't be calculated in the response unless it has been
|
|
123
|
+
// included in a response field mask. The response field mask can be provided
|
|
124
|
+
// to the method by using the URL parameter `$fields` or `fields`, or by using
|
|
125
|
+
// the HTTP/gRPC header `X-Goog-FieldMask`.
|
|
126
|
+
//
|
|
127
|
+
// For more information, see
|
|
128
|
+
// https://developers.google.com/ad-manager/api/beta/field-masks
|
|
129
|
+
int32 total_size = 3;
|
|
130
|
+
}
|
|
@@ -0,0 +1,47 @@
|
|
|
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 = "CreativeTemplateVariableUrlTypeEnumProto";
|
|
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
|
+
// [CreativeTemplateVariableUrlType][google.ads.admanager.v1.CreativeTemplateVariableUrlTypeEnum.CreativeTemplateVariableUrlType]
|
|
29
|
+
message CreativeTemplateVariableUrlTypeEnum {
|
|
30
|
+
// Types of URLs that a UrlCreativeTemplateVariable can represent.
|
|
31
|
+
enum CreativeTemplateVariableUrlType {
|
|
32
|
+
// Default value. This value is unused.
|
|
33
|
+
CREATIVE_TEMPLATE_VARIABLE_URL_TYPE_UNSPECIFIED = 0;
|
|
34
|
+
|
|
35
|
+
// Click tracking URL.
|
|
36
|
+
CLICK_TRACKER = 1;
|
|
37
|
+
|
|
38
|
+
// Deep-link URL.
|
|
39
|
+
DEEPLINK = 2;
|
|
40
|
+
|
|
41
|
+
// Impression tracking URL.
|
|
42
|
+
IMPRESSION_TRACKER = 3;
|
|
43
|
+
|
|
44
|
+
// Standard HTTP URL.
|
|
45
|
+
STANDARD_HTTP = 4;
|
|
46
|
+
}
|
|
47
|
+
}
|
|
@@ -78,8 +78,11 @@ message CustomField {
|
|
|
78
78
|
|
|
79
79
|
// An option for a drop-down `CustomField`.
|
|
80
80
|
message CustomFieldOption {
|
|
81
|
-
//
|
|
82
|
-
int64 custom_field_option_id = 1 [
|
|
81
|
+
// Optional. Non-empty default. `CustomFieldOption` ID.
|
|
82
|
+
int64 custom_field_option_id = 1 [
|
|
83
|
+
(google.api.field_behavior) = OPTIONAL,
|
|
84
|
+
(google.api.field_behavior) = NON_EMPTY_DEFAULT
|
|
85
|
+
];
|
|
83
86
|
|
|
84
87
|
// Required. The display name of the `CustomFieldOption`.
|
|
85
88
|
//
|
|
@@ -21,6 +21,7 @@ import "google/api/annotations.proto";
|
|
|
21
21
|
import "google/api/client.proto";
|
|
22
22
|
import "google/api/field_behavior.proto";
|
|
23
23
|
import "google/api/resource.proto";
|
|
24
|
+
import "google/protobuf/field_mask.proto";
|
|
24
25
|
|
|
25
26
|
option csharp_namespace = "Google.Ads.AdManager.V1";
|
|
26
27
|
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
|
|
@@ -52,6 +53,64 @@ service CustomFieldService {
|
|
|
52
53
|
};
|
|
53
54
|
option (google.api.method_signature) = "parent";
|
|
54
55
|
}
|
|
56
|
+
|
|
57
|
+
// API to create a `CustomField` object.
|
|
58
|
+
rpc CreateCustomField(CreateCustomFieldRequest) returns (CustomField) {
|
|
59
|
+
option (google.api.http) = {
|
|
60
|
+
post: "/v1/{parent=networks/*}/customFields"
|
|
61
|
+
body: "custom_field"
|
|
62
|
+
};
|
|
63
|
+
option (google.api.method_signature) = "parent,custom_field";
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
// API to batch create `CustomField` objects.
|
|
67
|
+
rpc BatchCreateCustomFields(BatchCreateCustomFieldsRequest)
|
|
68
|
+
returns (BatchCreateCustomFieldsResponse) {
|
|
69
|
+
option (google.api.http) = {
|
|
70
|
+
post: "/v1/{parent=networks/*}/customFields:batchCreate"
|
|
71
|
+
body: "*"
|
|
72
|
+
};
|
|
73
|
+
option (google.api.method_signature) = "parent,requests";
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
// API to update a `CustomField` object.
|
|
77
|
+
rpc UpdateCustomField(UpdateCustomFieldRequest) returns (CustomField) {
|
|
78
|
+
option (google.api.http) = {
|
|
79
|
+
patch: "/v1/{custom_field.name=networks/*/customFields/*}"
|
|
80
|
+
body: "custom_field"
|
|
81
|
+
};
|
|
82
|
+
option (google.api.method_signature) = "custom_field,update_mask";
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
// API to batch update `CustomField` objects.
|
|
86
|
+
rpc BatchUpdateCustomFields(BatchUpdateCustomFieldsRequest)
|
|
87
|
+
returns (BatchUpdateCustomFieldsResponse) {
|
|
88
|
+
option (google.api.http) = {
|
|
89
|
+
post: "/v1/{parent=networks/*}/customFields:batchUpdate"
|
|
90
|
+
body: "*"
|
|
91
|
+
};
|
|
92
|
+
option (google.api.method_signature) = "parent,requests";
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
// Activates a list of `CustomField` objects.
|
|
96
|
+
rpc BatchActivateCustomFields(BatchActivateCustomFieldsRequest)
|
|
97
|
+
returns (BatchActivateCustomFieldsResponse) {
|
|
98
|
+
option (google.api.http) = {
|
|
99
|
+
post: "/v1/{parent=networks/*}/customFields:batchActivate"
|
|
100
|
+
body: "*"
|
|
101
|
+
};
|
|
102
|
+
option (google.api.method_signature) = "parent,names";
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
// Deactivates a list of `CustomField` objects.
|
|
106
|
+
rpc BatchDeactivateCustomFields(BatchDeactivateCustomFieldsRequest)
|
|
107
|
+
returns (BatchDeactivateCustomFieldsResponse) {
|
|
108
|
+
option (google.api.http) = {
|
|
109
|
+
post: "/v1/{parent=networks/*}/customFields:batchDeactivate"
|
|
110
|
+
body: "*"
|
|
111
|
+
};
|
|
112
|
+
option (google.api.method_signature) = "parent,names";
|
|
113
|
+
}
|
|
55
114
|
}
|
|
56
115
|
|
|
57
116
|
// Request object for `GetCustomField` method.
|
|
@@ -79,8 +138,8 @@ message ListCustomFieldsRequest {
|
|
|
79
138
|
|
|
80
139
|
// Optional. The maximum number of `CustomFields` to return. The service may
|
|
81
140
|
// return fewer than this value. If unspecified, at most 50 `CustomFields`
|
|
82
|
-
// will be returned. The maximum value is 1000; values
|
|
83
|
-
// coerced to 1000.
|
|
141
|
+
// will be returned. The maximum value is 1000; values greater than 1000 will
|
|
142
|
+
// be coerced to 1000.
|
|
84
143
|
int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
|
|
85
144
|
|
|
86
145
|
// Optional. A page token, received from a previous `ListCustomFields` call.
|
|
@@ -118,7 +177,7 @@ message ListCustomFieldsResponse {
|
|
|
118
177
|
// If a filter was included in the request, this reflects the total number
|
|
119
178
|
// after the filtering is applied.
|
|
120
179
|
//
|
|
121
|
-
// `total_size`
|
|
180
|
+
// `total_size` won't be calculated in the response unless it has been
|
|
122
181
|
// included in a response field mask. The response field mask can be provided
|
|
123
182
|
// to the method by using the URL parameter `$fields` or `fields`, or by using
|
|
124
183
|
// the HTTP/gRPC header `X-Goog-FieldMask`.
|
|
@@ -127,3 +186,126 @@ message ListCustomFieldsResponse {
|
|
|
127
186
|
// https://developers.google.com/ad-manager/api/beta/field-masks
|
|
128
187
|
int32 total_size = 3;
|
|
129
188
|
}
|
|
189
|
+
|
|
190
|
+
// Request object for `CreateCustomField` method.
|
|
191
|
+
message CreateCustomFieldRequest {
|
|
192
|
+
// Required. The parent resource where this `CustomField` will be created.
|
|
193
|
+
// Format: `networks/{network_code}`
|
|
194
|
+
string parent = 1 [
|
|
195
|
+
(google.api.field_behavior) = REQUIRED,
|
|
196
|
+
(google.api.resource_reference) = {
|
|
197
|
+
type: "admanager.googleapis.com/Network"
|
|
198
|
+
}
|
|
199
|
+
];
|
|
200
|
+
|
|
201
|
+
// Required. The `CustomField` to create.
|
|
202
|
+
CustomField custom_field = 2 [(google.api.field_behavior) = REQUIRED];
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
// Request object for `BatchCreateCustomFields` method.
|
|
206
|
+
message BatchCreateCustomFieldsRequest {
|
|
207
|
+
// Required. The parent resource where `CustomFields` will be created.
|
|
208
|
+
// Format: `networks/{network_code}`
|
|
209
|
+
// The parent field in the CreateCustomFieldRequest must match this
|
|
210
|
+
// field.
|
|
211
|
+
string parent = 1 [
|
|
212
|
+
(google.api.field_behavior) = REQUIRED,
|
|
213
|
+
(google.api.resource_reference) = {
|
|
214
|
+
type: "admanager.googleapis.com/Network"
|
|
215
|
+
}
|
|
216
|
+
];
|
|
217
|
+
|
|
218
|
+
// Required. The `CustomField` objects to create.
|
|
219
|
+
// A maximum of 100 objects can be created in a batch.
|
|
220
|
+
repeated CreateCustomFieldRequest requests = 2
|
|
221
|
+
[(google.api.field_behavior) = REQUIRED];
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
// Response object for `BatchCreateCustomFields` method.
|
|
225
|
+
message BatchCreateCustomFieldsResponse {
|
|
226
|
+
// The `CustomField` objects created.
|
|
227
|
+
repeated CustomField custom_fields = 1;
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
// Request object for `UpdateCustomField` method.
|
|
231
|
+
message UpdateCustomFieldRequest {
|
|
232
|
+
// Required. The `CustomField` to update.
|
|
233
|
+
//
|
|
234
|
+
// The `CustomField`'s `name` is used to identify the `CustomField` to update.
|
|
235
|
+
CustomField custom_field = 1 [(google.api.field_behavior) = REQUIRED];
|
|
236
|
+
|
|
237
|
+
// Required. The list of fields to update.
|
|
238
|
+
google.protobuf.FieldMask update_mask = 2
|
|
239
|
+
[(google.api.field_behavior) = REQUIRED];
|
|
240
|
+
}
|
|
241
|
+
|
|
242
|
+
// Request object for `BatchUpdateCustomFields` method.
|
|
243
|
+
message BatchUpdateCustomFieldsRequest {
|
|
244
|
+
// Required. The parent resource where `CustomFields` will be updated.
|
|
245
|
+
// Format: `networks/{network_code}`
|
|
246
|
+
// The parent field in the UpdateCustomFieldRequest must match this
|
|
247
|
+
// field.
|
|
248
|
+
string parent = 1 [
|
|
249
|
+
(google.api.field_behavior) = REQUIRED,
|
|
250
|
+
(google.api.resource_reference) = {
|
|
251
|
+
type: "admanager.googleapis.com/Network"
|
|
252
|
+
}
|
|
253
|
+
];
|
|
254
|
+
|
|
255
|
+
// Required. The `CustomField` objects to update.
|
|
256
|
+
// A maximum of 100 objects can be updated in a batch.
|
|
257
|
+
repeated UpdateCustomFieldRequest requests = 2
|
|
258
|
+
[(google.api.field_behavior) = REQUIRED];
|
|
259
|
+
}
|
|
260
|
+
|
|
261
|
+
// Response object for `BatchUpdateCustomFields` method.
|
|
262
|
+
message BatchUpdateCustomFieldsResponse {
|
|
263
|
+
// The `CustomField` objects updated.
|
|
264
|
+
repeated CustomField custom_fields = 1;
|
|
265
|
+
}
|
|
266
|
+
|
|
267
|
+
// Request message for `BatchActivateCustomFields` method.
|
|
268
|
+
message BatchActivateCustomFieldsRequest {
|
|
269
|
+
// Required. Format: `networks/{network_code}`
|
|
270
|
+
string parent = 1 [
|
|
271
|
+
(google.api.field_behavior) = REQUIRED,
|
|
272
|
+
(google.api.resource_reference) = {
|
|
273
|
+
type: "admanager.googleapis.com/Network"
|
|
274
|
+
}
|
|
275
|
+
];
|
|
276
|
+
|
|
277
|
+
// Required. The resource names of the `CustomField` objects to activate.
|
|
278
|
+
// Format: `networks/{network_code}/customFields/{custom_field_id}`
|
|
279
|
+
repeated string names = 3 [
|
|
280
|
+
(google.api.field_behavior) = REQUIRED,
|
|
281
|
+
(google.api.resource_reference) = {
|
|
282
|
+
type: "admanager.googleapis.com/CustomField"
|
|
283
|
+
}
|
|
284
|
+
];
|
|
285
|
+
}
|
|
286
|
+
|
|
287
|
+
// Response object for `BatchActivateCustomFields` method.
|
|
288
|
+
message BatchActivateCustomFieldsResponse {}
|
|
289
|
+
|
|
290
|
+
// Request message for `BatchDeactivateCustomFields` method.
|
|
291
|
+
message BatchDeactivateCustomFieldsRequest {
|
|
292
|
+
// Required. Format: `networks/{network_code}`
|
|
293
|
+
string parent = 1 [
|
|
294
|
+
(google.api.field_behavior) = REQUIRED,
|
|
295
|
+
(google.api.resource_reference) = {
|
|
296
|
+
type: "admanager.googleapis.com/Network"
|
|
297
|
+
}
|
|
298
|
+
];
|
|
299
|
+
|
|
300
|
+
// Required. The resource names of the `CustomField` objects to deactivate.
|
|
301
|
+
// Format: `networks/{network_code}/customFields/{custom_field_id}`
|
|
302
|
+
repeated string names = 3 [
|
|
303
|
+
(google.api.field_behavior) = REQUIRED,
|
|
304
|
+
(google.api.resource_reference) = {
|
|
305
|
+
type: "admanager.googleapis.com/CustomField"
|
|
306
|
+
}
|
|
307
|
+
];
|
|
308
|
+
}
|
|
309
|
+
|
|
310
|
+
// Response object for `BatchDeactivateCustomFields` method.
|
|
311
|
+
message BatchDeactivateCustomFieldsResponse {}
|