@google-ads/admanager 0.13.0 → 0.14.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/build/protos/google/ads/admanager/v1/dai_session_enums.proto +449 -0
- package/build/protos/google/ads/admanager/v1/dai_session_messages.proto +595 -0
- package/build/protos/google/ads/admanager/v1/dai_session_service.proto +65 -0
- package/build/protos/google/ads/admanager/v1/private_auction_deal_messages.proto +16 -0
- package/build/protos/google/ads/admanager/v1/private_auction_deal_service.proto +2 -0
- package/build/protos/google/ads/admanager/v1/report_definition.proto +2 -2
- package/build/protos/google/ads/admanager/v1/report_delivery.proto +4 -3
- package/build/protos/google/ads/admanager/v1/report_visibility_enum.proto +2 -1
- package/build/protos/protos.d.ts +4053 -0
- package/build/protos/protos.js +1 -1
- package/build/protos/protos.json +1477 -0
- package/build/src/index.d.ts +4 -1
- package/build/src/index.js +5 -3
- package/build/src/index.js.map +1 -1
- package/build/src/v1/ad_break_service_client.d.ts +24 -0
- package/build/src/v1/ad_break_service_client.js +36 -0
- package/build/src/v1/ad_break_service_client.js.map +1 -1
- package/build/src/v1/ad_break_service_proto_list.json +3 -0
- package/build/src/v1/ad_review_center_ad_service_client.d.ts +24 -0
- package/build/src/v1/ad_review_center_ad_service_client.js +36 -0
- package/build/src/v1/ad_review_center_ad_service_client.js.map +1 -1
- package/build/src/v1/ad_review_center_ad_service_proto_list.json +3 -0
- package/build/src/v1/ad_rule_service_client.d.ts +24 -0
- package/build/src/v1/ad_rule_service_client.js +36 -0
- package/build/src/v1/ad_rule_service_client.js.map +1 -1
- package/build/src/v1/ad_rule_service_proto_list.json +3 -0
- package/build/src/v1/ad_spot_service_client.d.ts +24 -0
- package/build/src/v1/ad_spot_service_client.js +36 -0
- package/build/src/v1/ad_spot_service_client.js.map +1 -1
- package/build/src/v1/ad_spot_service_proto_list.json +3 -0
- package/build/src/v1/ad_unit_service_client.d.ts +24 -0
- package/build/src/v1/ad_unit_service_client.js +36 -0
- package/build/src/v1/ad_unit_service_client.js.map +1 -1
- package/build/src/v1/ad_unit_service_proto_list.json +3 -0
- package/build/src/v1/application_service_client.d.ts +24 -0
- package/build/src/v1/application_service_client.js +36 -0
- package/build/src/v1/application_service_client.js.map +1 -1
- package/build/src/v1/application_service_proto_list.json +3 -0
- package/build/src/v1/audience_segment_service_client.d.ts +24 -0
- package/build/src/v1/audience_segment_service_client.js +36 -0
- package/build/src/v1/audience_segment_service_client.js.map +1 -1
- package/build/src/v1/audience_segment_service_proto_list.json +3 -0
- package/build/src/v1/bandwidth_group_service_client.d.ts +24 -0
- package/build/src/v1/bandwidth_group_service_client.js +36 -0
- package/build/src/v1/bandwidth_group_service_client.js.map +1 -1
- package/build/src/v1/bandwidth_group_service_proto_list.json +3 -0
- package/build/src/v1/break_template_service_client.d.ts +24 -0
- package/build/src/v1/break_template_service_client.js +36 -0
- package/build/src/v1/break_template_service_client.js.map +1 -1
- package/build/src/v1/break_template_service_proto_list.json +3 -0
- package/build/src/v1/browser_language_service_client.d.ts +24 -0
- package/build/src/v1/browser_language_service_client.js +36 -0
- package/build/src/v1/browser_language_service_client.js.map +1 -1
- package/build/src/v1/browser_language_service_proto_list.json +3 -0
- package/build/src/v1/browser_service_client.d.ts +24 -0
- package/build/src/v1/browser_service_client.js +36 -0
- package/build/src/v1/browser_service_client.js.map +1 -1
- package/build/src/v1/browser_service_proto_list.json +3 -0
- package/build/src/v1/cdn_config_service_client.d.ts +24 -0
- package/build/src/v1/cdn_config_service_client.js +36 -0
- package/build/src/v1/cdn_config_service_client.js.map +1 -1
- package/build/src/v1/cdn_config_service_proto_list.json +3 -0
- package/build/src/v1/child_publisher_service_client.d.ts +24 -0
- package/build/src/v1/child_publisher_service_client.js +36 -0
- package/build/src/v1/child_publisher_service_client.js.map +1 -1
- package/build/src/v1/child_publisher_service_proto_list.json +3 -0
- package/build/src/v1/cms_metadata_key_service_client.d.ts +24 -0
- package/build/src/v1/cms_metadata_key_service_client.js +36 -0
- package/build/src/v1/cms_metadata_key_service_client.js.map +1 -1
- package/build/src/v1/cms_metadata_key_service_proto_list.json +3 -0
- package/build/src/v1/cms_metadata_value_service_client.d.ts +24 -0
- package/build/src/v1/cms_metadata_value_service_client.js +36 -0
- package/build/src/v1/cms_metadata_value_service_client.js.map +1 -1
- package/build/src/v1/cms_metadata_value_service_proto_list.json +3 -0
- package/build/src/v1/company_service_client.d.ts +24 -0
- package/build/src/v1/company_service_client.js +36 -0
- package/build/src/v1/company_service_client.js.map +1 -1
- package/build/src/v1/company_service_proto_list.json +3 -0
- package/build/src/v1/contact_service_client.d.ts +24 -0
- package/build/src/v1/contact_service_client.js +36 -0
- package/build/src/v1/contact_service_client.js.map +1 -1
- package/build/src/v1/contact_service_proto_list.json +3 -0
- package/build/src/v1/content_bundle_service_client.d.ts +24 -0
- package/build/src/v1/content_bundle_service_client.js +36 -0
- package/build/src/v1/content_bundle_service_client.js.map +1 -1
- package/build/src/v1/content_bundle_service_proto_list.json +3 -0
- package/build/src/v1/content_label_service_client.d.ts +24 -0
- package/build/src/v1/content_label_service_client.js +36 -0
- package/build/src/v1/content_label_service_client.js.map +1 -1
- package/build/src/v1/content_label_service_proto_list.json +3 -0
- package/build/src/v1/content_service_client.d.ts +24 -0
- package/build/src/v1/content_service_client.js +36 -0
- package/build/src/v1/content_service_client.js.map +1 -1
- package/build/src/v1/content_service_proto_list.json +3 -0
- package/build/src/v1/creative_set_service_client.d.ts +24 -0
- package/build/src/v1/creative_set_service_client.js +36 -0
- package/build/src/v1/creative_set_service_client.js.map +1 -1
- package/build/src/v1/creative_set_service_proto_list.json +3 -0
- package/build/src/v1/creative_template_service_client.d.ts +24 -0
- package/build/src/v1/creative_template_service_client.js +36 -0
- package/build/src/v1/creative_template_service_client.js.map +1 -1
- package/build/src/v1/creative_template_service_proto_list.json +3 -0
- package/build/src/v1/creative_wrapper_service_client.d.ts +24 -0
- package/build/src/v1/creative_wrapper_service_client.js +36 -0
- package/build/src/v1/creative_wrapper_service_client.js.map +1 -1
- package/build/src/v1/creative_wrapper_service_proto_list.json +3 -0
- package/build/src/v1/custom_field_service_client.d.ts +24 -0
- package/build/src/v1/custom_field_service_client.js +36 -0
- package/build/src/v1/custom_field_service_client.js.map +1 -1
- package/build/src/v1/custom_field_service_proto_list.json +3 -0
- package/build/src/v1/custom_targeting_key_service_client.d.ts +24 -0
- package/build/src/v1/custom_targeting_key_service_client.js +36 -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 +3 -0
- package/build/src/v1/custom_targeting_value_service_client.d.ts +24 -0
- package/build/src/v1/custom_targeting_value_service_client.js +36 -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 +3 -0
- package/build/src/v1/dai_authentication_key_service_client.d.ts +24 -0
- package/build/src/v1/dai_authentication_key_service_client.js +36 -0
- package/build/src/v1/dai_authentication_key_service_client.js.map +1 -1
- package/build/src/v1/dai_authentication_key_service_proto_list.json +3 -0
- package/build/src/v1/dai_encoding_profile_service_client.d.ts +24 -0
- package/build/src/v1/dai_encoding_profile_service_client.js +36 -0
- package/build/src/v1/dai_encoding_profile_service_client.js.map +1 -1
- package/build/src/v1/dai_encoding_profile_service_proto_list.json +3 -0
- package/build/src/v1/dai_session_service_client.d.ts +1762 -0
- package/build/src/v1/dai_session_service_client.js +2674 -0
- package/build/src/v1/dai_session_service_client.js.map +1 -0
- package/build/src/v1/dai_session_service_client_config.json +30 -0
- package/build/src/v1/dai_session_service_proto_list.json +233 -0
- package/build/src/v1/device_capability_service_client.d.ts +24 -0
- package/build/src/v1/device_capability_service_client.js +36 -0
- package/build/src/v1/device_capability_service_client.js.map +1 -1
- package/build/src/v1/device_capability_service_proto_list.json +3 -0
- package/build/src/v1/device_category_service_client.d.ts +24 -0
- package/build/src/v1/device_category_service_client.js +36 -0
- package/build/src/v1/device_category_service_client.js.map +1 -1
- package/build/src/v1/device_category_service_proto_list.json +3 -0
- package/build/src/v1/device_manufacturer_service_client.d.ts +24 -0
- package/build/src/v1/device_manufacturer_service_client.js +36 -0
- package/build/src/v1/device_manufacturer_service_client.js.map +1 -1
- package/build/src/v1/device_manufacturer_service_proto_list.json +3 -0
- package/build/src/v1/entity_signals_mapping_service_client.d.ts +24 -0
- package/build/src/v1/entity_signals_mapping_service_client.js +36 -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 +3 -0
- package/build/src/v1/gapic_metadata.json +24 -0
- package/build/src/v1/geo_target_service_client.d.ts +24 -0
- package/build/src/v1/geo_target_service_client.js +36 -0
- package/build/src/v1/geo_target_service_client.js.map +1 -1
- package/build/src/v1/geo_target_service_proto_list.json +3 -0
- package/build/src/v1/index.d.ts +1 -0
- package/build/src/v1/index.js +4 -2
- package/build/src/v1/index.js.map +1 -1
- package/build/src/v1/label_service_client.d.ts +24 -0
- package/build/src/v1/label_service_client.js +36 -0
- package/build/src/v1/label_service_client.js.map +1 -1
- package/build/src/v1/label_service_proto_list.json +3 -0
- package/build/src/v1/line_item_service_client.d.ts +24 -0
- package/build/src/v1/line_item_service_client.js +36 -0
- package/build/src/v1/line_item_service_client.js.map +1 -1
- package/build/src/v1/line_item_service_proto_list.json +3 -0
- package/build/src/v1/linked_device_service_client.d.ts +24 -0
- package/build/src/v1/linked_device_service_client.js +36 -0
- package/build/src/v1/linked_device_service_client.js.map +1 -1
- package/build/src/v1/linked_device_service_proto_list.json +3 -0
- package/build/src/v1/live_stream_service_client.d.ts +24 -0
- package/build/src/v1/live_stream_service_client.js +36 -0
- package/build/src/v1/live_stream_service_client.js.map +1 -1
- package/build/src/v1/live_stream_service_proto_list.json +3 -0
- package/build/src/v1/mcm_earnings_service_client.d.ts +24 -0
- package/build/src/v1/mcm_earnings_service_client.js +36 -0
- package/build/src/v1/mcm_earnings_service_client.js.map +1 -1
- package/build/src/v1/mcm_earnings_service_proto_list.json +3 -0
- package/build/src/v1/mobile_carrier_service_client.d.ts +24 -0
- package/build/src/v1/mobile_carrier_service_client.js +36 -0
- package/build/src/v1/mobile_carrier_service_client.js.map +1 -1
- package/build/src/v1/mobile_carrier_service_proto_list.json +3 -0
- package/build/src/v1/mobile_device_service_client.d.ts +24 -0
- package/build/src/v1/mobile_device_service_client.js +36 -0
- package/build/src/v1/mobile_device_service_client.js.map +1 -1
- package/build/src/v1/mobile_device_service_proto_list.json +3 -0
- package/build/src/v1/mobile_device_submodel_service_client.d.ts +24 -0
- package/build/src/v1/mobile_device_submodel_service_client.js +36 -0
- package/build/src/v1/mobile_device_submodel_service_client.js.map +1 -1
- package/build/src/v1/mobile_device_submodel_service_proto_list.json +3 -0
- package/build/src/v1/native_style_service_client.d.ts +24 -0
- package/build/src/v1/native_style_service_client.js +36 -0
- package/build/src/v1/native_style_service_client.js.map +1 -1
- package/build/src/v1/native_style_service_proto_list.json +3 -0
- package/build/src/v1/network_service_client.d.ts +24 -0
- package/build/src/v1/network_service_client.js +36 -0
- package/build/src/v1/network_service_client.js.map +1 -1
- package/build/src/v1/network_service_proto_list.json +3 -0
- package/build/src/v1/operating_system_service_client.d.ts +24 -0
- package/build/src/v1/operating_system_service_client.js +36 -0
- package/build/src/v1/operating_system_service_client.js.map +1 -1
- package/build/src/v1/operating_system_service_proto_list.json +3 -0
- package/build/src/v1/operating_system_version_service_client.d.ts +24 -0
- package/build/src/v1/operating_system_version_service_client.js +36 -0
- package/build/src/v1/operating_system_version_service_client.js.map +1 -1
- package/build/src/v1/operating_system_version_service_proto_list.json +3 -0
- package/build/src/v1/order_service_client.d.ts +24 -0
- package/build/src/v1/order_service_client.js +36 -0
- package/build/src/v1/order_service_client.js.map +1 -1
- package/build/src/v1/order_service_proto_list.json +3 -0
- package/build/src/v1/partner_service_client.d.ts +24 -0
- package/build/src/v1/partner_service_client.js +36 -0
- package/build/src/v1/partner_service_client.js.map +1 -1
- package/build/src/v1/partner_service_proto_list.json +3 -0
- package/build/src/v1/placement_service_client.d.ts +24 -0
- package/build/src/v1/placement_service_client.js +36 -0
- package/build/src/v1/placement_service_client.js.map +1 -1
- package/build/src/v1/placement_service_proto_list.json +3 -0
- package/build/src/v1/private_auction_deal_service_client.d.ts +30 -0
- package/build/src/v1/private_auction_deal_service_client.js +40 -0
- package/build/src/v1/private_auction_deal_service_client.js.map +1 -1
- package/build/src/v1/private_auction_deal_service_proto_list.json +3 -0
- package/build/src/v1/private_auction_service_client.d.ts +24 -0
- package/build/src/v1/private_auction_service_client.js +36 -0
- package/build/src/v1/private_auction_service_client.js.map +1 -1
- package/build/src/v1/private_auction_service_proto_list.json +3 -0
- package/build/src/v1/programmatic_buyer_service_client.d.ts +24 -0
- package/build/src/v1/programmatic_buyer_service_client.js +36 -0
- package/build/src/v1/programmatic_buyer_service_client.js.map +1 -1
- package/build/src/v1/programmatic_buyer_service_proto_list.json +3 -0
- package/build/src/v1/report_service_client.d.ts +24 -0
- package/build/src/v1/report_service_client.js +36 -0
- package/build/src/v1/report_service_client.js.map +1 -1
- package/build/src/v1/report_service_proto_list.json +3 -0
- package/build/src/v1/rich_media_ads_company_service_client.d.ts +24 -0
- package/build/src/v1/rich_media_ads_company_service_client.js +36 -0
- package/build/src/v1/rich_media_ads_company_service_client.js.map +1 -1
- package/build/src/v1/rich_media_ads_company_service_proto_list.json +3 -0
- package/build/src/v1/role_service_client.d.ts +24 -0
- package/build/src/v1/role_service_client.js +36 -0
- package/build/src/v1/role_service_client.js.map +1 -1
- package/build/src/v1/role_service_proto_list.json +3 -0
- package/build/src/v1/site_service_client.d.ts +24 -0
- package/build/src/v1/site_service_client.js +36 -0
- package/build/src/v1/site_service_client.js.map +1 -1
- package/build/src/v1/site_service_proto_list.json +3 -0
- package/build/src/v1/slate_service_client.d.ts +24 -0
- package/build/src/v1/slate_service_client.js +36 -0
- package/build/src/v1/slate_service_client.js.map +1 -1
- package/build/src/v1/slate_service_proto_list.json +3 -0
- package/build/src/v1/suggested_ad_unit_service_client.d.ts +24 -0
- package/build/src/v1/suggested_ad_unit_service_client.js +36 -0
- package/build/src/v1/suggested_ad_unit_service_client.js.map +1 -1
- package/build/src/v1/suggested_ad_unit_service_proto_list.json +3 -0
- package/build/src/v1/targeting_preset_service_client.d.ts +24 -0
- package/build/src/v1/targeting_preset_service_client.js +36 -0
- package/build/src/v1/targeting_preset_service_client.js.map +1 -1
- package/build/src/v1/targeting_preset_service_proto_list.json +3 -0
- package/build/src/v1/taxonomy_category_service_client.d.ts +24 -0
- package/build/src/v1/taxonomy_category_service_client.js +36 -0
- package/build/src/v1/taxonomy_category_service_client.js.map +1 -1
- package/build/src/v1/taxonomy_category_service_proto_list.json +3 -0
- package/build/src/v1/team_service_client.d.ts +24 -0
- package/build/src/v1/team_service_client.js +36 -0
- package/build/src/v1/team_service_client.js.map +1 -1
- package/build/src/v1/team_service_proto_list.json +3 -0
- package/build/src/v1/third_party_company_service_client.d.ts +24 -0
- package/build/src/v1/third_party_company_service_client.js +36 -0
- package/build/src/v1/third_party_company_service_client.js.map +1 -1
- package/build/src/v1/third_party_company_service_proto_list.json +3 -0
- package/build/src/v1/user_service_client.d.ts +24 -0
- package/build/src/v1/user_service_client.js +36 -0
- package/build/src/v1/user_service_client.js.map +1 -1
- package/build/src/v1/user_service_proto_list.json +3 -0
- package/build/src/v1/viewability_provider_service_client.d.ts +24 -0
- package/build/src/v1/viewability_provider_service_client.js +36 -0
- package/build/src/v1/viewability_provider_service_client.js.map +1 -1
- package/build/src/v1/viewability_provider_service_proto_list.json +3 -0
- package/package.json +6 -1
|
@@ -0,0 +1,595 @@
|
|
|
1
|
+
// Copyright 2026 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/dai_session_enums.proto";
|
|
20
|
+
import "google/api/field_behavior.proto";
|
|
21
|
+
import "google/api/resource.proto";
|
|
22
|
+
import "google/protobuf/duration.proto";
|
|
23
|
+
import "google/protobuf/timestamp.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 = "DaiSessionMessagesProto";
|
|
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
|
+
// Representation of an individual Dynamic Ad Insertion (DAI) session watching a
|
|
34
|
+
// [LiveStream][google.ads.admanager.v1.LiveStream] resource or VOD
|
|
35
|
+
// [Content][google.ads.admanager.v1.Content] resource. Use the
|
|
36
|
+
// Stream Activity Monitor (SAM) on the Google Ad Manager UI to look up this
|
|
37
|
+
// session. For details, see [Locate a DAI session ID or debug
|
|
38
|
+
// key](https://support.google.com/admanager/answer/7257678).
|
|
39
|
+
message DaiSession {
|
|
40
|
+
option (google.api.resource) = {
|
|
41
|
+
type: "admanager.googleapis.com/DaiSession"
|
|
42
|
+
pattern: "networks/{network_code}/daiSessions/{dai_session}"
|
|
43
|
+
plural: "daiSessions"
|
|
44
|
+
singular: "daiSession"
|
|
45
|
+
};
|
|
46
|
+
|
|
47
|
+
// Context data to create the DAI session.
|
|
48
|
+
message CreationContext {
|
|
49
|
+
// The VOD [Content][google.ads.admanager.v1.Content] resource
|
|
50
|
+
// in the stream request that creates the DAI session.
|
|
51
|
+
message VodInfo {
|
|
52
|
+
// Output only. The [name][google.ads.admanager.v1.Content.name] field of
|
|
53
|
+
// the VOD [Content][google.ads.admanager.v1.Content]
|
|
54
|
+
// resource.
|
|
55
|
+
optional string content = 3 [
|
|
56
|
+
(google.api.field_behavior) = OUTPUT_ONLY,
|
|
57
|
+
(google.api.resource_reference) = {
|
|
58
|
+
type: "admanager.googleapis.com/Content"
|
|
59
|
+
}
|
|
60
|
+
];
|
|
61
|
+
|
|
62
|
+
// Output only. The identifier of the content source from which Google Ad
|
|
63
|
+
// Manager ingested the [Content][google.ads.admanager.v1.Content]
|
|
64
|
+
// resource associated with this session. For more information, see
|
|
65
|
+
// [Create a content source for video on
|
|
66
|
+
// demand](https://support.google.com/admanager/answer/7064112).
|
|
67
|
+
optional int64 cms_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
68
|
+
|
|
69
|
+
// Output only. The video ID of the
|
|
70
|
+
// [Content][google.ads.admanager.v1.Content] resource
|
|
71
|
+
// that this session is associated with. This value is the same as the
|
|
72
|
+
// [CmsContent.cms_content_id][google.ads.admanager.v1.CmsContent.cms_content_id]
|
|
73
|
+
// field. For details, see [Content ingestion and best
|
|
74
|
+
// practices](https://support.google.com/admanager/answer/6057894).
|
|
75
|
+
optional string vid = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
76
|
+
|
|
77
|
+
// Output only. The cue points detected in the ingested VOD content
|
|
78
|
+
// manifest. Stored in milliseconds starting from the beginning of the
|
|
79
|
+
// content.
|
|
80
|
+
repeated int64 cue_points = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
81
|
+
|
|
82
|
+
// Output only. The VOD
|
|
83
|
+
// [Content.duration][google.ads.admanager.v1.Content.duration]
|
|
84
|
+
// field. Represents the duration of the content without ads.
|
|
85
|
+
google.protobuf.Duration content_duration = 5
|
|
86
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
// The [LiveStream][google.ads.admanager.v1.LiveStream] resource
|
|
90
|
+
// in the stream request that creates the DAI session.
|
|
91
|
+
message LinearInfo {
|
|
92
|
+
// Output only. The [name][google.ads.admanager.v1.LiveStream.name] field
|
|
93
|
+
// of the [LiveStream][google.ads.admanager.v1.LiveStream]
|
|
94
|
+
// resource.
|
|
95
|
+
optional string live_stream = 5 [
|
|
96
|
+
(google.api.field_behavior) = OUTPUT_ONLY,
|
|
97
|
+
(google.api.resource_reference) = {
|
|
98
|
+
type: "admanager.googleapis.com/LiveStream"
|
|
99
|
+
}
|
|
100
|
+
];
|
|
101
|
+
|
|
102
|
+
// Output only. The
|
|
103
|
+
// [LiveStream.asset_key][google.ads.admanager.v1.LiveStream.asset_key]
|
|
104
|
+
// field. Google Ad Manager only generates this field for livestreams with
|
|
105
|
+
// the
|
|
106
|
+
// [dynamic_ad_insertion_type][google.ads.admanager.v1.LiveStream.dynamic_ad_insertion_type]
|
|
107
|
+
// field set to
|
|
108
|
+
// [DynamicAdInsertionType.LINEAR][google.ads.admanager.v1.DynamicAdInsertionTypeEnum.DynamicAdInsertionType.LINEAR]
|
|
109
|
+
// value.
|
|
110
|
+
optional string asset_key = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
111
|
+
|
|
112
|
+
// Output only. The
|
|
113
|
+
// [LiveStream.custom_asset_key][google.ads.admanager.v1.LiveStream.custom_asset_key]
|
|
114
|
+
// field. This field is only populated for livestreams with the
|
|
115
|
+
// [dynamic_ad_insertion_type][google.ads.admanager.v1.LiveStream.dynamic_ad_insertion_type]
|
|
116
|
+
// field set to
|
|
117
|
+
// [DynamicAdInsertionType.POD_SERVING_MANIFEST][google.ads.admanager.v1.DynamicAdInsertionTypeEnum.DynamicAdInsertionType.POD_SERVING_MANIFEST]
|
|
118
|
+
// value or
|
|
119
|
+
// [DynamicAdInsertionType.POD_SERVING_REDIRECT][google.ads.admanager.v1.DynamicAdInsertionTypeEnum.DynamicAdInsertionType.POD_SERVING_REDIRECT]
|
|
120
|
+
// value.
|
|
121
|
+
optional string custom_asset_key = 2
|
|
122
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
123
|
+
|
|
124
|
+
// Output only. Whether the
|
|
125
|
+
// [LiveStream.prefetch_enabled][google.ads.admanager.v1.LiveStream.prefetch_enabled]
|
|
126
|
+
// field is set to true.
|
|
127
|
+
optional bool prefetch_enabled = 3
|
|
128
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
129
|
+
|
|
130
|
+
// Output only. Whether ad pod trimming is enabled for the DAI session.
|
|
131
|
+
optional bool pod_trimming_enabled = 4
|
|
132
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
133
|
+
|
|
134
|
+
// Optional. The maximum duration allowed to be trimmed from an ad pod
|
|
135
|
+
// before whole ads are dropped. This field is only populated when pod
|
|
136
|
+
// trimming is enabled.
|
|
137
|
+
optional google.protobuf.Duration pod_trim_tolerance = 8
|
|
138
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
139
|
+
|
|
140
|
+
// The
|
|
141
|
+
// [LiveStream.start_time][google.ads.admanager.v1.LiveStream.start_time]
|
|
142
|
+
// field.
|
|
143
|
+
google.protobuf.Timestamp event_start_time = 6;
|
|
144
|
+
|
|
145
|
+
// Output only. The
|
|
146
|
+
// [LiveStream.end_time][google.ads.admanager.v1.LiveStream.end_time]
|
|
147
|
+
// field.
|
|
148
|
+
google.protobuf.Timestamp event_end_time = 7
|
|
149
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
// Information about the
|
|
153
|
+
// [LiveStream][google.ads.admanager.v1.LiveStream] resource or
|
|
154
|
+
// VOD [Content][google.ads.admanager.v1.Content] resource
|
|
155
|
+
// creating the DAI session.
|
|
156
|
+
oneof content_info {
|
|
157
|
+
// Output only. The [LiveStream][google.ads.admanager.v1.LiveStream]
|
|
158
|
+
// resource in the stream request that creates the DAI session.
|
|
159
|
+
LinearInfo linear_info = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
160
|
+
|
|
161
|
+
// Output only. The [Content][google.ads.admanager.v1.Content] resource in
|
|
162
|
+
// the stream request that creates the DAI session.
|
|
163
|
+
VodInfo vod_info = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
// Output only. The string the `dai-sam-id` parameter sets in the DAI stream
|
|
167
|
+
// request. For details, see [Locate a DAI session ID or debug
|
|
168
|
+
// key](https://support.google.com/admanager/answer/7257678).
|
|
169
|
+
optional string debug_key = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
170
|
+
|
|
171
|
+
// Output only. The
|
|
172
|
+
// [LiveStream.display_name][google.ads.admanager.v1.LiveStream.display_name]
|
|
173
|
+
// field or
|
|
174
|
+
// [Content.display_name][google.ads.admanager.v1.Content.display_name]
|
|
175
|
+
// field associated with the DAI session.
|
|
176
|
+
optional string content_title = 10
|
|
177
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
178
|
+
|
|
179
|
+
// Output only. The string the `session_title` parameter sets in the DAI
|
|
180
|
+
// stream request. For details, see
|
|
181
|
+
// [CreateStreamOptions](/ad-manager/dynamic-ad-insertion/api/pod-serving/reference/vod#createstreamoptions).
|
|
182
|
+
optional string session_title = 9
|
|
183
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
184
|
+
|
|
185
|
+
// Output only. The HTTP request creating the DAI session. For details, see
|
|
186
|
+
// [Linear
|
|
187
|
+
// API](/ad-manager/dynamic-ad-insertion/api/full-service/reference/live#method_stream),
|
|
188
|
+
// [VOD
|
|
189
|
+
// API](/ad-manager/dynamic-ad-insertion/api/full-service/reference/vod#method_stream),
|
|
190
|
+
// [pod serving live
|
|
191
|
+
// API](/ad-manager/dynamic-ad-insertion/api/pod-serving/reference/live#method_stream)
|
|
192
|
+
// and [pod serving VOD
|
|
193
|
+
// API](/ad-manager/dynamic-ad-insertion/api/pod-serving/reference/vod#method_create_stream).
|
|
194
|
+
HttpRequest stream_create_request = 1
|
|
195
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
196
|
+
|
|
197
|
+
// Output only. Whether the stream request is for [Full-service
|
|
198
|
+
// DAI](/ad-manager/dynamic-ad-insertion/full-service)
|
|
199
|
+
// or [Pod
|
|
200
|
+
// serving](/ad-manager/dynamic-ad-insertion/pod-serving).
|
|
201
|
+
optional StitchingTypeEnum.StitchingType stitching_type = 4
|
|
202
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
203
|
+
|
|
204
|
+
// Output only. Whether ad tracking URLs are pinged on the client side or
|
|
205
|
+
// server side. If IMA SDK is used to make the stream requests, IMA SDK
|
|
206
|
+
// pings the ad tracking URLs on the client side. For server-side beaconing,
|
|
207
|
+
// see [Integrate with DAI using server-side beaconing
|
|
208
|
+
// (SSB)](https://support.google.com/admanager/answer/7299051).
|
|
209
|
+
optional ReportingTypeEnum.ReportingType reporting_type = 5
|
|
210
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
211
|
+
|
|
212
|
+
// Output only. Whether the parameter `dai-istl` on the stream request is
|
|
213
|
+
// set to true. This parameter is only accepted for
|
|
214
|
+
// [LiveStream][google.ads.admanager.v1.LiveStream] resources
|
|
215
|
+
// with the
|
|
216
|
+
// [dynamic_ad_insertion_type][google.ads.admanager.v1.LiveStream.dynamic_ad_insertion_type]
|
|
217
|
+
// field set to
|
|
218
|
+
// [DynamicAdInsertionType.LINEAR][google.ads.admanager.v1.DynamicAdInsertionTypeEnum.DynamicAdInsertionType.LINEAR]
|
|
219
|
+
// value.
|
|
220
|
+
optional bool interstitial_enabled = 6
|
|
221
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
// The ad requests, ad response, and nested ads in the DAI session.
|
|
225
|
+
message AdSelection {
|
|
226
|
+
// Top-level ad request.
|
|
227
|
+
message AdRequest {
|
|
228
|
+
// Output only. Ad request ID.
|
|
229
|
+
optional int64 ad_request_key = 1
|
|
230
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
231
|
+
|
|
232
|
+
// Output only. The HTTP request of the ad request.
|
|
233
|
+
HttpRequest http_request = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
234
|
+
|
|
235
|
+
// Output only. Ad requests made to follow redirects or unwrap a previous
|
|
236
|
+
// VMAP or VAST wrapper ad response.
|
|
237
|
+
repeated AdRequest child_requests = 3
|
|
238
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
239
|
+
|
|
240
|
+
// Output only. The ad request URL.
|
|
241
|
+
optional string ad_tag = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
242
|
+
|
|
243
|
+
// Output only. The effective ad request URL header value on the ad
|
|
244
|
+
// response. This value is only populated for VMAP ad requests when video
|
|
245
|
+
// playlist internal redirects are enabled. For details, see [Internal
|
|
246
|
+
// redirect to Google Campaign Manager
|
|
247
|
+
// 360](https://support.google.com/admanager/answer/9580500?hl=en&sjid=487826991051851731-NA).
|
|
248
|
+
optional string effective_ad_request_url = 5
|
|
249
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
250
|
+
}
|
|
251
|
+
|
|
252
|
+
// Output only. Response type of the parent ad request.
|
|
253
|
+
optional AdResponseTypeEnum.AdResponseType type = 1
|
|
254
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
255
|
+
|
|
256
|
+
// Output only. Top-level ad request.
|
|
257
|
+
AdRequest ad_request = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
// Information about a single decisioned ad pod in this session. This message
|
|
261
|
+
// pertains to the smallest unit of ads to insert in a session, and
|
|
262
|
+
// might be a pod fragment.
|
|
263
|
+
message AdPod {
|
|
264
|
+
// Output only. Type of ad break this ad pod was decisioned for.
|
|
265
|
+
optional BreakTypeEnum.BreakType requested_break_type = 1
|
|
266
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
267
|
+
|
|
268
|
+
// Output only. Ad request ID that links to the ad request that resulted in
|
|
269
|
+
// this ad pod.
|
|
270
|
+
optional int64 ad_request_key = 2
|
|
271
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
272
|
+
|
|
273
|
+
// Output only. The creatives in this ad pod. Keyed by a unique ID used to
|
|
274
|
+
// reference this creative from a different submessage.
|
|
275
|
+
map<int64, Creative> creatives = 3
|
|
276
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
277
|
+
|
|
278
|
+
// Output only. Indicates the prefetch stage for this ad pod. If prefetch is
|
|
279
|
+
// not enabled this stage is set to the
|
|
280
|
+
// [PrefetchStageType.DISABLED][google.ads.admanager.v1.PrefetchStageTypeEnum.PrefetchStageType.DISABLED]
|
|
281
|
+
// value.
|
|
282
|
+
optional PrefetchStageTypeEnum.PrefetchStageType prefetch_stage = 4
|
|
283
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
284
|
+
|
|
285
|
+
// Output only. Publisher-provided or DAI-generated break ID for the [Ad
|
|
286
|
+
// break API](/ad-manager/dynamic-ad-insertion/api/ad-break) or [pod serving
|
|
287
|
+
// API](/ad-manager/dynamic-ad-insertion/pod-serving).
|
|
288
|
+
optional string ad_break_id = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
289
|
+
|
|
290
|
+
// Output only. Descriptive label for this ad pod, used to distinguish ad
|
|
291
|
+
// pods from one another in this session. e.g. "midroll-1", "2".
|
|
292
|
+
optional string label = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
// Information about an ad break in this session. Includes statuses such as ad
|
|
296
|
+
// and slate durations.
|
|
297
|
+
message AdBreak {
|
|
298
|
+
// Represents Video on Demand related break information.
|
|
299
|
+
message VodBreak {
|
|
300
|
+
// Output only. The time difference between the start of this break and
|
|
301
|
+
// the start of the session. Includes the time for any preceding ad
|
|
302
|
+
// breaks.
|
|
303
|
+
google.protobuf.Duration time_offset = 1
|
|
304
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
305
|
+
}
|
|
306
|
+
|
|
307
|
+
// Represents linear session related break information.
|
|
308
|
+
message LinearBreak {
|
|
309
|
+
// Output only. The timestamp of when the break started.
|
|
310
|
+
google.protobuf.Timestamp break_start_time = 3
|
|
311
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
312
|
+
|
|
313
|
+
// Output only. The duration of the placement opportunity associated with
|
|
314
|
+
// the break.
|
|
315
|
+
google.protobuf.Duration expected_break_duration = 4
|
|
316
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
317
|
+
|
|
318
|
+
// Output only. The duration of slate that was inserted for this break.
|
|
319
|
+
google.protobuf.Duration slate_duration = 5
|
|
320
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
321
|
+
|
|
322
|
+
// Output only. The duration of underlying content that was inserted for
|
|
323
|
+
// this break.
|
|
324
|
+
google.protobuf.Duration underlying_duration = 6
|
|
325
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
326
|
+
}
|
|
327
|
+
|
|
328
|
+
// Information about a tracking ping issued for a break.
|
|
329
|
+
message TrackingPing {
|
|
330
|
+
// Output only. A unique ID for this tracking event, which is the ID3 tag
|
|
331
|
+
// in client-side reporting.
|
|
332
|
+
optional string original_tracking_event_id = 4
|
|
333
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
334
|
+
|
|
335
|
+
// Output only. The HTTP request made to the ad server for this tracking
|
|
336
|
+
// ping.
|
|
337
|
+
HttpRequest request = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
338
|
+
}
|
|
339
|
+
|
|
340
|
+
// Information about this ad break relevant to the session type.
|
|
341
|
+
oneof stream_type_info {
|
|
342
|
+
// Output only. Information on the break for a linear session.
|
|
343
|
+
LinearBreak linear = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
344
|
+
|
|
345
|
+
// Output only. Information on the break for a VOD session.
|
|
346
|
+
VodBreak vod = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
347
|
+
}
|
|
348
|
+
|
|
349
|
+
// Output only. Ad pod ID that links to one or more decisioned ad pods for
|
|
350
|
+
// this break. Most types of sessions will have a single pod key, but in the
|
|
351
|
+
// case of prefetched pods there will be two pod keys.
|
|
352
|
+
repeated int64 pod_keys = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
353
|
+
|
|
354
|
+
// Output only. Publisher-provided or DAI-generated break ID for the [Ad
|
|
355
|
+
// break API](/ad-manager/dynamic-ad-insertion/api/ad-break) or [pod serving
|
|
356
|
+
// API](/ad-manager/dynamic-ad-insertion/pod-serving).
|
|
357
|
+
optional string ad_break_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
358
|
+
|
|
359
|
+
// Output only. Type of break this represents.
|
|
360
|
+
optional BreakTypeEnum.BreakType break_type = 3
|
|
361
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
362
|
+
|
|
363
|
+
// Output only. The index of this ad break in the session.
|
|
364
|
+
optional int64 break_sequence = 4
|
|
365
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
366
|
+
|
|
367
|
+
// Output only. The duration of ads that were inserted for this break.
|
|
368
|
+
google.protobuf.Duration served_ads_duration = 5
|
|
369
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
370
|
+
|
|
371
|
+
// Output only. The total duration of the break as it was served by DAI. In
|
|
372
|
+
// VOD, this value is the duration of ads inserted in between content. In
|
|
373
|
+
// linear, this value is the duration between cue out and cue in.
|
|
374
|
+
google.protobuf.Duration executed_break_duration = 6
|
|
375
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
376
|
+
|
|
377
|
+
// Output only. Tracking pings that were issued for this break. Keyed by a
|
|
378
|
+
// unique ID to reference this tracking ping from a different submessage.
|
|
379
|
+
map<int64, TrackingPing> tracking_pings = 9
|
|
380
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
381
|
+
}
|
|
382
|
+
|
|
383
|
+
// An HTTP request made by DAI.
|
|
384
|
+
message HttpRequest {
|
|
385
|
+
// Output only. The time when the request was made.
|
|
386
|
+
google.protobuf.Timestamp request_time = 1
|
|
387
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
388
|
+
|
|
389
|
+
// Output only. How long the request took to complete.
|
|
390
|
+
google.protobuf.Duration latency = 2
|
|
391
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
392
|
+
|
|
393
|
+
// Output only. The URL sent in the request.
|
|
394
|
+
optional string url = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
395
|
+
|
|
396
|
+
// Output only. The user agent sent with the request.
|
|
397
|
+
optional string user_agent = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
398
|
+
|
|
399
|
+
// Output only. The HTTP response code.
|
|
400
|
+
optional int32 response_code = 5
|
|
401
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
402
|
+
|
|
403
|
+
// Output only. The full response body.
|
|
404
|
+
optional string response_body = 6
|
|
405
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
406
|
+
}
|
|
407
|
+
|
|
408
|
+
// Information about a single creative.
|
|
409
|
+
message Creative {
|
|
410
|
+
// Details about a single VAST info.
|
|
411
|
+
message VastInfo {
|
|
412
|
+
// Output only. Value of VAST/Ad/InLine/AdSystem.
|
|
413
|
+
optional string ad_system = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
414
|
+
|
|
415
|
+
// Output only. Version attribute from VAST/Ad/InLine/AdSystem.
|
|
416
|
+
optional string ad_system_version = 2
|
|
417
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
418
|
+
|
|
419
|
+
// Output only. Value of VAST/Ad/InLine/AdTitle.
|
|
420
|
+
optional string ad_title = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
421
|
+
|
|
422
|
+
// Output only. Value of VAST/Ad/InLine/Description.
|
|
423
|
+
optional string description = 4
|
|
424
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
425
|
+
|
|
426
|
+
// Output only. The `id` attribute from VAST/Ad/InLine/Creatives/Creative.
|
|
427
|
+
optional string creative_id = 5
|
|
428
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
429
|
+
}
|
|
430
|
+
|
|
431
|
+
// Output only. The type of ID that is used to identify this creative.
|
|
432
|
+
optional CreativeIdTypeEnum.CreativeIdType id_type = 1
|
|
433
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
434
|
+
|
|
435
|
+
// Output only. The value for the given ID type.
|
|
436
|
+
optional string id_value = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
437
|
+
|
|
438
|
+
// Output only. The ad system that provided this creative.
|
|
439
|
+
optional string ad_system = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
440
|
+
|
|
441
|
+
// Output only. Duration of the creative.
|
|
442
|
+
google.protobuf.Duration duration = 4
|
|
443
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
444
|
+
|
|
445
|
+
// Output only. The index at which this creative appeared in the ad pod.
|
|
446
|
+
optional int32 pod_sequence = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
447
|
+
|
|
448
|
+
// Output only. The VAST infos that resulted in this creative.
|
|
449
|
+
repeated VastInfo vast_infos = 6
|
|
450
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
451
|
+
|
|
452
|
+
// Output only. Whether this creative was from ad buffet.
|
|
453
|
+
optional bool ad_buffet = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
454
|
+
}
|
|
455
|
+
|
|
456
|
+
// Information about errors or notable discoveries that occurred during a
|
|
457
|
+
// session.
|
|
458
|
+
message Finding {
|
|
459
|
+
// A finding that occurred while decisioning an ad pod.
|
|
460
|
+
message PodFinding {
|
|
461
|
+
// Output only. The finding's type.
|
|
462
|
+
optional PodFindingTypeEnum.PodFindingType type = 1
|
|
463
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
464
|
+
|
|
465
|
+
// Output only. ID that links to the relevant ad pod.
|
|
466
|
+
optional int64 pod_key = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
467
|
+
}
|
|
468
|
+
|
|
469
|
+
// A finding that occurred regarding the slate creative, which can be found
|
|
470
|
+
// at the
|
|
471
|
+
// [DaiSession.slate][google.ads.admanager.v1.DaiSession.slate]
|
|
472
|
+
// field.
|
|
473
|
+
message SlateFinding {
|
|
474
|
+
// Output only. The finding's type.
|
|
475
|
+
optional SlateFindingTypeEnum.SlateFindingType type = 1
|
|
476
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
477
|
+
}
|
|
478
|
+
|
|
479
|
+
// A finding that occurred while serving ads for a session.
|
|
480
|
+
message AdBreakFinding {
|
|
481
|
+
// Output only. The finding's type.
|
|
482
|
+
optional AdBreakFindingTypeEnum.AdBreakFindingType type = 1
|
|
483
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
484
|
+
|
|
485
|
+
// Output only. The ID that links to the relevant ad break.
|
|
486
|
+
optional int64 break_key = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
487
|
+
}
|
|
488
|
+
|
|
489
|
+
// A finding that occurred while pinging tracking URLs for a session.
|
|
490
|
+
message TrackingPingFinding {
|
|
491
|
+
// Output only. The finding's type.
|
|
492
|
+
optional TrackingPingFindingTypeEnum.TrackingPingFindingType type = 1
|
|
493
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
494
|
+
|
|
495
|
+
// Output only. The ID that links to the relevant tracking ping.
|
|
496
|
+
optional int64 tracking_ping_key = 2
|
|
497
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
498
|
+
}
|
|
499
|
+
|
|
500
|
+
// A finding that occurred while looking up creative information.
|
|
501
|
+
message CreativeFinding {
|
|
502
|
+
// Output only. The finding's type.
|
|
503
|
+
optional CreativeFindingTypeEnum.CreativeFindingType type = 1
|
|
504
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
505
|
+
|
|
506
|
+
// Output only. The ID that links to the relevant creative.
|
|
507
|
+
optional int64 creative_key = 2
|
|
508
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
509
|
+
}
|
|
510
|
+
|
|
511
|
+
// A finding that occurred while making an ad request.
|
|
512
|
+
message AdRequestFinding {
|
|
513
|
+
// Output only. The finding's type.
|
|
514
|
+
optional AdRequestFindingTypeEnum.AdRequestFindingType type = 1
|
|
515
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
516
|
+
|
|
517
|
+
// Output only. The ID that links to the relevant ad selection.
|
|
518
|
+
optional int64 ad_selection_key = 2
|
|
519
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
520
|
+
|
|
521
|
+
// Output only. The ID that links to the relevant ad request.
|
|
522
|
+
optional int64 ad_request_key = 3
|
|
523
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
524
|
+
}
|
|
525
|
+
|
|
526
|
+
// Which session entity this finding is relevant to.
|
|
527
|
+
oneof type {
|
|
528
|
+
// Output only. A finding related to building an ad pod.
|
|
529
|
+
PodFinding pod_finding = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
530
|
+
|
|
531
|
+
// Output only. A finding related to the slate creative.
|
|
532
|
+
SlateFinding slate_finding = 5
|
|
533
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
534
|
+
|
|
535
|
+
// Output only. A finding related to an ad break.
|
|
536
|
+
AdBreakFinding ad_break_finding = 6
|
|
537
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
538
|
+
|
|
539
|
+
// Output only. A finding related to a tracking ping.
|
|
540
|
+
TrackingPingFinding tracking_finding = 7
|
|
541
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
542
|
+
|
|
543
|
+
// Output only. A finding related to a creative.
|
|
544
|
+
CreativeFinding creative_finding = 8
|
|
545
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
546
|
+
|
|
547
|
+
// Output only. A finding related to an ad request within ad selection.
|
|
548
|
+
AdRequestFinding ad_request_finding = 9
|
|
549
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
550
|
+
}
|
|
551
|
+
|
|
552
|
+
// Output only. The severity of the finding to the session.
|
|
553
|
+
optional SessionFindingSeverityEnum.SessionFindingSeverity severity = 1
|
|
554
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
555
|
+
|
|
556
|
+
// Output only. A description of the finding.
|
|
557
|
+
optional string description = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
558
|
+
}
|
|
559
|
+
|
|
560
|
+
// Identifier. The resource name of the `DaiSession`.
|
|
561
|
+
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
|
|
562
|
+
|
|
563
|
+
// Output only. Context data to create the DAI session.
|
|
564
|
+
CreationContext creation_context = 3
|
|
565
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
566
|
+
|
|
567
|
+
// Output only. Slate creative to use in the DAI session for unfilled ad
|
|
568
|
+
// durations.
|
|
569
|
+
Creative slate = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
570
|
+
|
|
571
|
+
// Output only. The ad requests, ad responses and nested ads in the DAI
|
|
572
|
+
// session.
|
|
573
|
+
map<int64, AdSelection> ad_selections = 5
|
|
574
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
575
|
+
|
|
576
|
+
// Output only. All decisioned ad pods for this session, disregarding serving
|
|
577
|
+
// status. Keyed by a unique ID to reference an ad pod from a different
|
|
578
|
+
// submessage.
|
|
579
|
+
map<int64, AdPod> ad_pods = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
580
|
+
|
|
581
|
+
// Output only. All DAI ad breaks for this session. Contains information such
|
|
582
|
+
// as ad duration, slate duration, and various ad statuses. Keyed by a unique
|
|
583
|
+
// ID to reference an ad break from a different submessage.
|
|
584
|
+
map<int64, AdBreak> ad_breaks = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
585
|
+
|
|
586
|
+
// Output only. Information about errors or notable discoveries that occurred
|
|
587
|
+
// during a session.
|
|
588
|
+
repeated Finding findings = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
589
|
+
|
|
590
|
+
// Output only. The duration of the DAI session, calculated as the difference
|
|
591
|
+
// between the timestamp of DAI's latest recorded event and the timestamp of
|
|
592
|
+
// the session create request.
|
|
593
|
+
google.protobuf.Duration session_duration = 9
|
|
594
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
595
|
+
}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
// Copyright 2026 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/dai_session_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 = "DaiSessionServiceProto";
|
|
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 `DaiSession` objects.
|
|
34
|
+
service DaiSessionService {
|
|
35
|
+
option (google.api.default_host) = "admanager.googleapis.com";
|
|
36
|
+
option (google.api.oauth_scopes) =
|
|
37
|
+
"https://www.googleapis.com/auth/admanager,"
|
|
38
|
+
"https://www.googleapis.com/auth/admanager.readonly";
|
|
39
|
+
|
|
40
|
+
// Retrieves a `DaiSession` object.
|
|
41
|
+
rpc GetDaiSession(GetDaiSessionRequest) returns (DaiSession) {
|
|
42
|
+
option (google.api.http) = {
|
|
43
|
+
get: "/v1/{name=networks/*/daiSessions/*}"
|
|
44
|
+
};
|
|
45
|
+
option (google.api.method_signature) = "name";
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
|
|
49
|
+
// Request object for `GetDaiSession` method.
|
|
50
|
+
message GetDaiSessionRequest {
|
|
51
|
+
// Required. The resource name of the DaiSession. The dai_session can be
|
|
52
|
+
// either the session ID or debug key, that DAI returns on stream create. For
|
|
53
|
+
// details, see [Locate a DAI session ID or debug
|
|
54
|
+
// key](https://support.google.com/admanager/answer/7257678).
|
|
55
|
+
//
|
|
56
|
+
// Format: `networks/{network_code}/daiSessions/{dai_session}`
|
|
57
|
+
// Format: `networks/{network_code}/daiSessions/{session_id}`
|
|
58
|
+
// Format: `networks/{network_code}/daiSessions/{debug_key}`
|
|
59
|
+
string name = 1 [
|
|
60
|
+
(google.api.field_behavior) = REQUIRED,
|
|
61
|
+
(google.api.resource_reference) = {
|
|
62
|
+
type: "admanager.googleapis.com/DaiSession"
|
|
63
|
+
}
|
|
64
|
+
];
|
|
65
|
+
}
|