@google-ads/admanager 0.3.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -2
- package/build/protos/google/ads/admanager/v1/ad_break_messages.proto +134 -0
- package/build/protos/google/ads/admanager/v1/ad_break_service.proto +269 -0
- package/build/protos/google/ads/admanager/v1/ad_unit_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/ad_unit_messages.proto +32 -26
- package/build/protos/google/ads/admanager/v1/ad_unit_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/admanager_error.proto +1 -1
- package/build/protos/google/ads/admanager/v1/applied_label.proto +1 -1
- package/build/protos/google/ads/admanager/v1/bandwidth_group_messages.proto +46 -0
- package/build/protos/google/ads/admanager/v1/bandwidth_group_service.proto +129 -0
- package/build/protos/google/ads/admanager/v1/company_enums.proto +123 -0
- package/build/protos/google/ads/admanager/v1/company_messages.proto +6 -7
- package/build/protos/google/ads/admanager/v1/company_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/contact_messages.proto +4 -4
- package/build/protos/google/ads/admanager/v1/custom_field_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/custom_field_messages.proto +12 -11
- package/build/protos/google/ads/admanager/v1/custom_field_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/custom_field_value.proto +1 -2
- package/build/protos/google/ads/admanager/v1/custom_targeting_key_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/custom_targeting_key_messages.proto +1 -1
- package/build/protos/google/ads/admanager/v1/custom_targeting_key_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/custom_targeting_value_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/custom_targeting_value_messages.proto +14 -3
- package/build/protos/google/ads/admanager/v1/custom_targeting_value_service.proto +14 -6
- package/build/protos/google/ads/admanager/v1/deal_buyer_permission_type_enum.proto +41 -0
- package/build/protos/google/ads/admanager/v1/device_category_messages.proto +45 -0
- package/build/protos/google/ads/admanager/v1/device_category_service.proto +129 -0
- package/build/protos/google/ads/admanager/v1/early_ad_break_notification_enums.proto +47 -0
- package/build/protos/google/ads/admanager/v1/entity_signals_mapping_messages.proto +4 -4
- package/build/protos/google/ads/admanager/v1/entity_signals_mapping_service.proto +6 -4
- package/build/protos/google/ads/admanager/v1/environment_type_enum.proto +1 -1
- package/build/protos/google/ads/admanager/v1/frequency_cap.proto +1 -1
- package/build/protos/google/ads/admanager/v1/geo_target_messages.proto +70 -0
- package/build/protos/google/ads/admanager/v1/geo_target_service.proto +128 -0
- package/build/protos/google/ads/admanager/v1/label_messages.proto +1 -1
- package/build/protos/google/ads/admanager/v1/live_stream_event_messages.proto +47 -0
- package/build/protos/google/ads/admanager/v1/network_messages.proto +2 -2
- package/build/protos/google/ads/admanager/v1/network_service.proto +4 -2
- package/build/protos/google/ads/admanager/v1/operating_system_messages.proto +45 -0
- package/build/protos/google/ads/admanager/v1/operating_system_service.proto +129 -0
- package/build/protos/google/ads/admanager/v1/operating_system_version_messages.proto +52 -0
- package/build/protos/google/ads/admanager/v1/operating_system_version_service.proto +133 -0
- package/build/protos/google/ads/admanager/v1/order_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/order_messages.proto +24 -20
- package/build/protos/google/ads/admanager/v1/order_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/placement_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/placement_messages.proto +14 -14
- package/build/protos/google/ads/admanager/v1/placement_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/private_auction_deal_messages.proto +119 -0
- package/build/protos/google/ads/admanager/v1/private_auction_deal_service.proto +184 -0
- package/build/protos/google/ads/admanager/v1/private_auction_messages.proto +74 -0
- package/build/protos/google/ads/admanager/v1/private_auction_service.proto +180 -0
- package/build/protos/google/ads/admanager/v1/private_marketplace_enums.proto +50 -0
- package/build/protos/google/ads/admanager/v1/programmatic_buyer_messages.proto +72 -0
- package/build/protos/google/ads/admanager/v1/programmatic_buyer_service.proto +131 -0
- package/build/protos/google/ads/admanager/v1/report_messages.proto +3536 -0
- package/build/protos/google/ads/admanager/v1/report_service.proto +5 -3247
- package/build/protos/google/ads/admanager/v1/request_platform_enum.proto +49 -0
- package/build/protos/google/ads/admanager/v1/role_enums.proto +1 -1
- package/build/protos/google/ads/admanager/v1/role_messages.proto +6 -6
- package/build/protos/google/ads/admanager/v1/role_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/size.proto +7 -11
- package/build/protos/google/ads/admanager/v1/size_type_enum.proto +1 -1
- package/build/protos/google/ads/admanager/v1/targeted_video_bumper_type_enum.proto +44 -0
- package/build/protos/google/ads/admanager/v1/targeting.proto +328 -0
- package/build/protos/google/ads/admanager/v1/taxonomy_category_messages.proto +7 -6
- package/build/protos/google/ads/admanager/v1/taxonomy_category_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/taxonomy_type_enum.proto +1 -1
- package/build/protos/google/ads/admanager/v1/team_messages.proto +1 -5
- package/build/protos/google/ads/admanager/v1/time_unit_enum.proto +1 -1
- package/build/protos/google/ads/admanager/v1/user_messages.proto +10 -9
- package/build/protos/google/ads/admanager/v1/user_service.proto +3 -1
- package/build/protos/google/ads/admanager/v1/video_position_enum.proto +47 -0
- package/build/protos/protos.d.ts +15832 -7575
- package/build/protos/protos.js +57744 -36372
- package/build/protos/protos.json +5795 -2511
- package/build/src/index.d.ts +28 -1
- package/build/src/index.js +20 -17
- package/build/src/index.js.map +1 -1
- package/build/src/v1/ad_break_service_client.d.ts +1040 -0
- package/build/src/v1/ad_break_service_client.js +1483 -0
- package/build/src/v1/ad_break_service_client.js.map +1 -0
- package/build/src/v1/ad_break_service_client_config.json +46 -0
- package/build/src/v1/ad_break_service_proto_list.json +74 -0
- package/build/src/v1/ad_unit_service_client.d.ts +331 -91
- package/build/src/v1/ad_unit_service_client.js +414 -106
- package/build/src/v1/ad_unit_service_client.js.map +1 -1
- package/build/src/v1/ad_unit_service_proto_list.json +29 -3
- package/build/src/v1/bandwidth_group_service_client.d.ts +904 -0
- package/build/src/v1/bandwidth_group_service_client.js +1369 -0
- package/build/src/v1/bandwidth_group_service_client.js.map +1 -0
- package/build/src/v1/bandwidth_group_service_client_config.json +34 -0
- package/build/src/v1/bandwidth_group_service_proto_list.json +74 -0
- package/build/src/v1/company_service_client.d.ts +291 -51
- package/build/src/v1/company_service_client.js +402 -81
- package/build/src/v1/company_service_client.js.map +1 -1
- package/build/src/v1/company_service_proto_list.json +29 -3
- package/build/src/v1/custom_field_service_client.d.ts +291 -51
- package/build/src/v1/custom_field_service_client.js +403 -85
- package/build/src/v1/custom_field_service_client.js.map +1 -1
- package/build/src/v1/custom_field_service_proto_list.json +29 -3
- package/build/src/v1/custom_targeting_key_service_client.d.ts +291 -51
- package/build/src/v1/custom_targeting_key_service_client.js +404 -88
- package/build/src/v1/custom_targeting_key_service_client.js.map +1 -1
- package/build/src/v1/custom_targeting_key_service_proto_list.json +29 -3
- package/build/src/v1/custom_targeting_value_service_client.d.ts +298 -58
- package/build/src/v1/custom_targeting_value_service_client.js +406 -90
- package/build/src/v1/custom_targeting_value_service_client.js.map +1 -1
- package/build/src/v1/custom_targeting_value_service_proto_list.json +29 -3
- package/build/src/v1/device_category_service_client.d.ts +904 -0
- package/build/src/v1/device_category_service_client.js +1369 -0
- package/build/src/v1/device_category_service_client.js.map +1 -0
- package/build/src/v1/device_category_service_client_config.json +34 -0
- package/build/src/v1/device_category_service_proto_list.json +74 -0
- package/build/src/v1/entity_signals_mapping_service_client.d.ts +298 -58
- package/build/src/v1/entity_signals_mapping_service_client.js +444 -124
- package/build/src/v1/entity_signals_mapping_service_client.js.map +1 -1
- package/build/src/v1/entity_signals_mapping_service_proto_list.json +29 -3
- package/build/src/v1/gapic_metadata.json +412 -0
- package/build/src/v1/geo_target_service_client.d.ts +904 -0
- package/build/src/v1/geo_target_service_client.js +1369 -0
- package/build/src/v1/geo_target_service_client.js.map +1 -0
- package/build/src/v1/geo_target_service_client_config.json +34 -0
- package/build/src/v1/geo_target_service_proto_list.json +74 -0
- package/build/src/v1/index.d.ts +9 -0
- package/build/src/v1/index.js +19 -1
- package/build/src/v1/index.js.map +1 -1
- package/build/src/v1/network_service_client.d.ts +252 -12
- package/build/src/v1/network_service_client.js +397 -65
- package/build/src/v1/network_service_client.js.map +1 -1
- package/build/src/v1/network_service_proto_list.json +29 -3
- package/build/src/v1/operating_system_service_client.d.ts +904 -0
- package/build/src/v1/operating_system_service_client.js +1369 -0
- package/build/src/v1/operating_system_service_client.js.map +1 -0
- package/build/src/v1/operating_system_service_client_config.json +34 -0
- package/build/src/v1/operating_system_service_proto_list.json +74 -0
- package/build/src/v1/operating_system_version_service_client.d.ts +911 -0
- package/build/src/v1/operating_system_version_service_client.js +1373 -0
- package/build/src/v1/operating_system_version_service_client.js.map +1 -0
- package/build/src/v1/operating_system_version_service_client_config.json +34 -0
- package/build/src/v1/operating_system_version_service_proto_list.json +74 -0
- package/build/src/v1/order_service_client.d.ts +296 -56
- package/build/src/v1/order_service_client.js +402 -81
- package/build/src/v1/order_service_client.js.map +1 -1
- package/build/src/v1/order_service_proto_list.json +29 -3
- package/build/src/v1/placement_service_client.d.ts +291 -51
- package/build/src/v1/placement_service_client.js +402 -81
- package/build/src/v1/placement_service_client.js.map +1 -1
- package/build/src/v1/placement_service_proto_list.json +29 -3
- package/build/src/v1/private_auction_deal_service_client.d.ts +965 -0
- package/build/src/v1/private_auction_deal_service_client.js +1445 -0
- package/build/src/v1/private_auction_deal_service_client.js.map +1 -0
- package/build/src/v1/private_auction_deal_service_client_config.json +42 -0
- package/build/src/v1/private_auction_deal_service_proto_list.json +74 -0
- package/build/src/v1/private_auction_service_client.d.ts +962 -0
- package/build/src/v1/private_auction_service_client.js +1443 -0
- package/build/src/v1/private_auction_service_client.js.map +1 -0
- package/build/src/v1/private_auction_service_client_config.json +42 -0
- package/build/src/v1/private_auction_service_proto_list.json +74 -0
- package/build/src/v1/programmatic_buyer_service_client.d.ts +905 -0
- package/build/src/v1/programmatic_buyer_service_client.js +1369 -0
- package/build/src/v1/programmatic_buyer_service_client.js.map +1 -0
- package/build/src/v1/programmatic_buyer_service_client_config.json +34 -0
- package/build/src/v1/programmatic_buyer_service_proto_list.json +74 -0
- package/build/src/v1/report_service_client.d.ts +350 -110
- package/build/src/v1/report_service_client.js +471 -177
- package/build/src/v1/report_service_client.js.map +1 -1
- package/build/src/v1/report_service_proto_list.json +29 -3
- package/build/src/v1/role_service_client.d.ts +290 -50
- package/build/src/v1/role_service_client.js +402 -81
- package/build/src/v1/role_service_client.js.map +1 -1
- package/build/src/v1/role_service_proto_list.json +29 -3
- package/build/src/v1/taxonomy_category_service_client.d.ts +291 -51
- package/build/src/v1/taxonomy_category_service_client.js +404 -87
- package/build/src/v1/taxonomy_category_service_client.js.map +1 -1
- package/build/src/v1/taxonomy_category_service_proto_list.json +29 -3
- package/build/src/v1/user_service_client.d.ts +251 -11
- package/build/src/v1/user_service_client.js +388 -59
- package/build/src/v1/user_service_client.js.map +1 -1
- package/build/src/v1/user_service_proto_list.json +29 -3
- package/package.json +4 -4
- package/CHANGELOG.md +0 -40
package/README.md
CHANGED
|
@@ -44,7 +44,7 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
|
|
|
44
44
|
1. [Select or create a Cloud Platform project][projects].
|
|
45
45
|
1. [Enable billing for your project][billing].
|
|
46
46
|
1. [Enable the Google Ad Manager API API][enable_api].
|
|
47
|
-
1. [Set up authentication
|
|
47
|
+
1. [Set up authentication][auth] so you can access the
|
|
48
48
|
API from your local workstation.
|
|
49
49
|
|
|
50
50
|
### Installing the client library
|
|
@@ -130,9 +130,16 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
|
|
|
130
130
|
|
|
131
131
|
| Sample | Source Code | Try it |
|
|
132
132
|
| --------------------------- | --------------------------------- | ------ |
|
|
133
|
+
| Ad_break_service.create_ad_break | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/ad_break_service.create_ad_break.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/ad_break_service.create_ad_break.js,packages/google-ads-admanager/samples/README.md) |
|
|
134
|
+
| Ad_break_service.delete_ad_break | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/ad_break_service.delete_ad_break.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/ad_break_service.delete_ad_break.js,packages/google-ads-admanager/samples/README.md) |
|
|
135
|
+
| Ad_break_service.get_ad_break | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/ad_break_service.get_ad_break.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/ad_break_service.get_ad_break.js,packages/google-ads-admanager/samples/README.md) |
|
|
136
|
+
| Ad_break_service.list_ad_breaks | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/ad_break_service.list_ad_breaks.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/ad_break_service.list_ad_breaks.js,packages/google-ads-admanager/samples/README.md) |
|
|
137
|
+
| Ad_break_service.update_ad_break | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/ad_break_service.update_ad_break.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/ad_break_service.update_ad_break.js,packages/google-ads-admanager/samples/README.md) |
|
|
133
138
|
| Ad_unit_service.get_ad_unit | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/ad_unit_service.get_ad_unit.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/ad_unit_service.get_ad_unit.js,packages/google-ads-admanager/samples/README.md) |
|
|
134
139
|
| Ad_unit_service.list_ad_unit_sizes | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/ad_unit_service.list_ad_unit_sizes.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/ad_unit_service.list_ad_unit_sizes.js,packages/google-ads-admanager/samples/README.md) |
|
|
135
140
|
| Ad_unit_service.list_ad_units | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/ad_unit_service.list_ad_units.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/ad_unit_service.list_ad_units.js,packages/google-ads-admanager/samples/README.md) |
|
|
141
|
+
| Bandwidth_group_service.get_bandwidth_group | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/bandwidth_group_service.get_bandwidth_group.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/bandwidth_group_service.get_bandwidth_group.js,packages/google-ads-admanager/samples/README.md) |
|
|
142
|
+
| Bandwidth_group_service.list_bandwidth_groups | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/bandwidth_group_service.list_bandwidth_groups.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/bandwidth_group_service.list_bandwidth_groups.js,packages/google-ads-admanager/samples/README.md) |
|
|
136
143
|
| Company_service.get_company | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/company_service.get_company.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/company_service.get_company.js,packages/google-ads-admanager/samples/README.md) |
|
|
137
144
|
| Company_service.list_companies | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/company_service.list_companies.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/company_service.list_companies.js,packages/google-ads-admanager/samples/README.md) |
|
|
138
145
|
| Custom_field_service.get_custom_field | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/custom_field_service.get_custom_field.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/custom_field_service.get_custom_field.js,packages/google-ads-admanager/samples/README.md) |
|
|
@@ -141,18 +148,36 @@ Samples are in the [`samples/`](https://github.com/googleapis/google-cloud-node/
|
|
|
141
148
|
| Custom_targeting_key_service.list_custom_targeting_keys | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/custom_targeting_key_service.list_custom_targeting_keys.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/custom_targeting_key_service.list_custom_targeting_keys.js,packages/google-ads-admanager/samples/README.md) |
|
|
142
149
|
| Custom_targeting_value_service.get_custom_targeting_value | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/custom_targeting_value_service.get_custom_targeting_value.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/custom_targeting_value_service.get_custom_targeting_value.js,packages/google-ads-admanager/samples/README.md) |
|
|
143
150
|
| Custom_targeting_value_service.list_custom_targeting_values | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/custom_targeting_value_service.list_custom_targeting_values.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/custom_targeting_value_service.list_custom_targeting_values.js,packages/google-ads-admanager/samples/README.md) |
|
|
151
|
+
| Device_category_service.get_device_category | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/device_category_service.get_device_category.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/device_category_service.get_device_category.js,packages/google-ads-admanager/samples/README.md) |
|
|
152
|
+
| Device_category_service.list_device_categories | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/device_category_service.list_device_categories.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/device_category_service.list_device_categories.js,packages/google-ads-admanager/samples/README.md) |
|
|
144
153
|
| Entity_signals_mapping_service.batch_create_entity_signals_mappings | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/entity_signals_mapping_service.batch_create_entity_signals_mappings.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/entity_signals_mapping_service.batch_create_entity_signals_mappings.js,packages/google-ads-admanager/samples/README.md) |
|
|
145
154
|
| Entity_signals_mapping_service.batch_update_entity_signals_mappings | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/entity_signals_mapping_service.batch_update_entity_signals_mappings.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/entity_signals_mapping_service.batch_update_entity_signals_mappings.js,packages/google-ads-admanager/samples/README.md) |
|
|
146
155
|
| Entity_signals_mapping_service.create_entity_signals_mapping | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/entity_signals_mapping_service.create_entity_signals_mapping.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/entity_signals_mapping_service.create_entity_signals_mapping.js,packages/google-ads-admanager/samples/README.md) |
|
|
147
156
|
| Entity_signals_mapping_service.get_entity_signals_mapping | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/entity_signals_mapping_service.get_entity_signals_mapping.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/entity_signals_mapping_service.get_entity_signals_mapping.js,packages/google-ads-admanager/samples/README.md) |
|
|
148
157
|
| Entity_signals_mapping_service.list_entity_signals_mappings | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/entity_signals_mapping_service.list_entity_signals_mappings.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/entity_signals_mapping_service.list_entity_signals_mappings.js,packages/google-ads-admanager/samples/README.md) |
|
|
149
158
|
| Entity_signals_mapping_service.update_entity_signals_mapping | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/entity_signals_mapping_service.update_entity_signals_mapping.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/entity_signals_mapping_service.update_entity_signals_mapping.js,packages/google-ads-admanager/samples/README.md) |
|
|
159
|
+
| Geo_target_service.get_geo_target | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/geo_target_service.get_geo_target.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/geo_target_service.get_geo_target.js,packages/google-ads-admanager/samples/README.md) |
|
|
160
|
+
| Geo_target_service.list_geo_targets | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/geo_target_service.list_geo_targets.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/geo_target_service.list_geo_targets.js,packages/google-ads-admanager/samples/README.md) |
|
|
150
161
|
| Network_service.get_network | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/network_service.get_network.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/network_service.get_network.js,packages/google-ads-admanager/samples/README.md) |
|
|
151
162
|
| Network_service.list_networks | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/network_service.list_networks.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/network_service.list_networks.js,packages/google-ads-admanager/samples/README.md) |
|
|
163
|
+
| Operating_system_service.get_operating_system | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/operating_system_service.get_operating_system.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/operating_system_service.get_operating_system.js,packages/google-ads-admanager/samples/README.md) |
|
|
164
|
+
| Operating_system_service.list_operating_systems | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/operating_system_service.list_operating_systems.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/operating_system_service.list_operating_systems.js,packages/google-ads-admanager/samples/README.md) |
|
|
165
|
+
| Operating_system_version_service.get_operating_system_version | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/operating_system_version_service.get_operating_system_version.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/operating_system_version_service.get_operating_system_version.js,packages/google-ads-admanager/samples/README.md) |
|
|
166
|
+
| Operating_system_version_service.list_operating_system_versions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/operating_system_version_service.list_operating_system_versions.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/operating_system_version_service.list_operating_system_versions.js,packages/google-ads-admanager/samples/README.md) |
|
|
152
167
|
| Order_service.get_order | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/order_service.get_order.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/order_service.get_order.js,packages/google-ads-admanager/samples/README.md) |
|
|
153
168
|
| Order_service.list_orders | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/order_service.list_orders.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/order_service.list_orders.js,packages/google-ads-admanager/samples/README.md) |
|
|
154
169
|
| Placement_service.get_placement | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/placement_service.get_placement.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/placement_service.get_placement.js,packages/google-ads-admanager/samples/README.md) |
|
|
155
170
|
| Placement_service.list_placements | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/placement_service.list_placements.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/placement_service.list_placements.js,packages/google-ads-admanager/samples/README.md) |
|
|
171
|
+
| Private_auction_deal_service.create_private_auction_deal | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/private_auction_deal_service.create_private_auction_deal.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/private_auction_deal_service.create_private_auction_deal.js,packages/google-ads-admanager/samples/README.md) |
|
|
172
|
+
| Private_auction_deal_service.get_private_auction_deal | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/private_auction_deal_service.get_private_auction_deal.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/private_auction_deal_service.get_private_auction_deal.js,packages/google-ads-admanager/samples/README.md) |
|
|
173
|
+
| Private_auction_deal_service.list_private_auction_deals | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/private_auction_deal_service.list_private_auction_deals.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/private_auction_deal_service.list_private_auction_deals.js,packages/google-ads-admanager/samples/README.md) |
|
|
174
|
+
| Private_auction_deal_service.update_private_auction_deal | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/private_auction_deal_service.update_private_auction_deal.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/private_auction_deal_service.update_private_auction_deal.js,packages/google-ads-admanager/samples/README.md) |
|
|
175
|
+
| Private_auction_service.create_private_auction | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/private_auction_service.create_private_auction.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/private_auction_service.create_private_auction.js,packages/google-ads-admanager/samples/README.md) |
|
|
176
|
+
| Private_auction_service.get_private_auction | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/private_auction_service.get_private_auction.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/private_auction_service.get_private_auction.js,packages/google-ads-admanager/samples/README.md) |
|
|
177
|
+
| Private_auction_service.list_private_auctions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/private_auction_service.list_private_auctions.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/private_auction_service.list_private_auctions.js,packages/google-ads-admanager/samples/README.md) |
|
|
178
|
+
| Private_auction_service.update_private_auction | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/private_auction_service.update_private_auction.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/private_auction_service.update_private_auction.js,packages/google-ads-admanager/samples/README.md) |
|
|
179
|
+
| Programmatic_buyer_service.get_programmatic_buyer | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/programmatic_buyer_service.get_programmatic_buyer.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/programmatic_buyer_service.get_programmatic_buyer.js,packages/google-ads-admanager/samples/README.md) |
|
|
180
|
+
| Programmatic_buyer_service.list_programmatic_buyers | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/programmatic_buyer_service.list_programmatic_buyers.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/programmatic_buyer_service.list_programmatic_buyers.js,packages/google-ads-admanager/samples/README.md) |
|
|
156
181
|
| Report_service.create_report | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/report_service.create_report.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/report_service.create_report.js,packages/google-ads-admanager/samples/README.md) |
|
|
157
182
|
| Report_service.fetch_report_result_rows | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/report_service.fetch_report_result_rows.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/report_service.fetch_report_result_rows.js,packages/google-ads-admanager/samples/README.md) |
|
|
158
183
|
| Report_service.get_report | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/report_service.get_report.js) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/google-cloud-node&page=editor&open_in_editor=packages/google-ads-admanager/samples/generated/v1/report_service.get_report.js,packages/google-ads-admanager/samples/README.md) |
|
|
@@ -233,4 +258,4 @@ See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
|
|
|
233
258
|
[projects]: https://console.cloud.google.com/project
|
|
234
259
|
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
|
|
235
260
|
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=admanager.googleapis.com
|
|
236
|
-
[auth]: https://cloud.google.com/docs/authentication/
|
|
261
|
+
[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
|
|
@@ -0,0 +1,134 @@
|
|
|
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/early_ad_break_notification_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 = "AdBreakMessagesProto";
|
|
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
|
+
// The `AdBreak` resource.
|
|
34
|
+
message AdBreak {
|
|
35
|
+
option (google.api.resource) = {
|
|
36
|
+
type: "admanager.googleapis.com/AdBreak"
|
|
37
|
+
pattern: "networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}"
|
|
38
|
+
plural: "adBreaks"
|
|
39
|
+
singular: "adBreak"
|
|
40
|
+
};
|
|
41
|
+
|
|
42
|
+
// Identifier. The resource name of the `AdBreak`.
|
|
43
|
+
// This field uses the `LiveStreamEvent` resource's asset key in the
|
|
44
|
+
// URI, even if the ad break was created, updated, or queried using the custom
|
|
45
|
+
// asset key.
|
|
46
|
+
//
|
|
47
|
+
// Format:
|
|
48
|
+
// `networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break_id}`
|
|
49
|
+
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
|
|
50
|
+
|
|
51
|
+
// Optional. Immutable. `AdBreak` ID.
|
|
52
|
+
// Must consist only of lowercase letters, digits, and hyphens. Ad break IDs
|
|
53
|
+
// have a maximum length of 63 characters.
|
|
54
|
+
// If not set, an ad break ID is generated as a UUID string.
|
|
55
|
+
optional string ad_break_id = 2 [
|
|
56
|
+
(google.api.field_behavior) = OPTIONAL,
|
|
57
|
+
(google.api.field_behavior) = IMMUTABLE
|
|
58
|
+
];
|
|
59
|
+
|
|
60
|
+
// Optional. Immutable. The asset key of the `LiveStreamEvent` that the ad
|
|
61
|
+
// break belongs to. Either an asset key or a custom asset key must be
|
|
62
|
+
// provided for creation.
|
|
63
|
+
optional string asset_key = 3 [
|
|
64
|
+
(google.api.field_behavior) = OPTIONAL,
|
|
65
|
+
(google.api.field_behavior) = IMMUTABLE
|
|
66
|
+
];
|
|
67
|
+
|
|
68
|
+
// Optional. Immutable. The custom asset key of the `LiveStreamEvent` that the
|
|
69
|
+
// ad break belongs to. Either an asset key or a custom asset key must be
|
|
70
|
+
// provided for creation.
|
|
71
|
+
optional string custom_asset_key = 4 [
|
|
72
|
+
(google.api.field_behavior) = OPTIONAL,
|
|
73
|
+
(google.api.field_behavior) = IMMUTABLE
|
|
74
|
+
];
|
|
75
|
+
|
|
76
|
+
// Optional. The expected start time of the ad break.
|
|
77
|
+
// When set, the scheduled ad break will be decisioned shortly before the
|
|
78
|
+
// expected start time.
|
|
79
|
+
// If this field is not set, ad decisioning begins immediately.
|
|
80
|
+
// An ad break can be created up to six hours before the expected start time.
|
|
81
|
+
optional google.protobuf.Timestamp expected_start_time = 5
|
|
82
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
83
|
+
|
|
84
|
+
// Required. The duration of the `AdBreak`.
|
|
85
|
+
// An expected duration in seconds with up to nine fractional digits, ending
|
|
86
|
+
// with `s`, for example, `3.5s`. This value will be updated to match the
|
|
87
|
+
// actual duration from the manifest or pod request after the ad break's state
|
|
88
|
+
// is
|
|
89
|
+
// [`COMPLETE`][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.COMPLETE].
|
|
90
|
+
optional google.protobuf.Duration duration = 6
|
|
91
|
+
[(google.api.field_behavior) = REQUIRED];
|
|
92
|
+
|
|
93
|
+
// Output only. The state of the `AdBreak`.
|
|
94
|
+
optional AdBreakStateEnum.AdBreakState break_state = 7
|
|
95
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
96
|
+
|
|
97
|
+
// Output only. The sequence id of the `AdBreak`.
|
|
98
|
+
// The unique sequence number of the created ad break. This value is only set
|
|
99
|
+
// after the `AdBreak` starts decisioning indicated by the ad break state's
|
|
100
|
+
// being
|
|
101
|
+
// [`DECISIONED`][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.DECISIONED]
|
|
102
|
+
// .
|
|
103
|
+
optional int64 break_sequence = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
104
|
+
|
|
105
|
+
// Optional. The pod template name of the `AdBreak`.
|
|
106
|
+
// This field is the required unique name across all pod templates in the
|
|
107
|
+
// network, not the display name.
|
|
108
|
+
optional string pod_template_name = 9
|
|
109
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
110
|
+
|
|
111
|
+
// Optional. The key-value pairs to be included on the ad requests for this
|
|
112
|
+
// `AdBreak`. Key-value pairs to include on ad requests for this break for
|
|
113
|
+
// custom criteria targeting in Google Ad Manager, separated by `=` and joined
|
|
114
|
+
// by
|
|
115
|
+
// `&`.
|
|
116
|
+
//
|
|
117
|
+
// Format:"key1=value&key2=value"
|
|
118
|
+
optional string custom_params = 10 [(google.api.field_behavior) = OPTIONAL];
|
|
119
|
+
|
|
120
|
+
// Optional. The Base64-encoded SCTE-35 command associated with the `AdBreak`.
|
|
121
|
+
// This field can include the `splice_insert()` or `time_signal()` command.
|
|
122
|
+
//
|
|
123
|
+
// **Examples**
|
|
124
|
+
//
|
|
125
|
+
// * `time_signal()`
|
|
126
|
+
// ```
|
|
127
|
+
// /DA0AAAAAAAA///wBQb+cr0AUAAeAhxDVUVJSAAAjn/PAAGlmbAICAAAAAAsoKGKNAIAmsnRfg==
|
|
128
|
+
// ```
|
|
129
|
+
// * `splice_insert()`
|
|
130
|
+
// ```
|
|
131
|
+
// /DAvAAAAAAAA///wFAVIAACPf+/+c2nALv4AUsz1AAAAAAAKAAhDVUVJAAABNWLbowo=
|
|
132
|
+
// ```
|
|
133
|
+
optional string scte_35_cue_out = 11 [(google.api.field_behavior) = OPTIONAL];
|
|
134
|
+
}
|
|
@@ -0,0 +1,269 @@
|
|
|
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/ad_break_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
|
+
import "google/protobuf/empty.proto";
|
|
25
|
+
import "google/protobuf/field_mask.proto";
|
|
26
|
+
|
|
27
|
+
option csharp_namespace = "Google.Ads.AdManager.V1";
|
|
28
|
+
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
|
|
29
|
+
option java_multiple_files = true;
|
|
30
|
+
option java_outer_classname = "AdBreakServiceProto";
|
|
31
|
+
option java_package = "com.google.ads.admanager.v1";
|
|
32
|
+
option php_namespace = "Google\\Ads\\AdManager\\V1";
|
|
33
|
+
option ruby_package = "Google::Ads::AdManager::V1";
|
|
34
|
+
|
|
35
|
+
// Provides methods for handling `AdBreak` objects.
|
|
36
|
+
service AdBreakService {
|
|
37
|
+
option (google.api.default_host) = "admanager.googleapis.com";
|
|
38
|
+
option (google.api.oauth_scopes) =
|
|
39
|
+
"https://www.googleapis.com/auth/admanager";
|
|
40
|
+
|
|
41
|
+
// API to retrieve an `AdBreak` object.
|
|
42
|
+
//
|
|
43
|
+
// Query an ad break by its resource name or custom asset key. Check the
|
|
44
|
+
// resource's `breakState` field to determine its state.
|
|
45
|
+
rpc GetAdBreak(GetAdBreakRequest) returns (AdBreak) {
|
|
46
|
+
option (google.api.http) = {
|
|
47
|
+
get: "/v1/{name=networks/*/liveStreamEventsByAssetKey/*/adBreaks/*}"
|
|
48
|
+
additional_bindings {
|
|
49
|
+
get: "/v1/{name=networks/*/liveStreamEventsByCustomAssetKey/*/adBreaks/*}"
|
|
50
|
+
}
|
|
51
|
+
additional_bindings {
|
|
52
|
+
get: "/v1/{name=networks/*/liveStreamEvents/*/adBreaks/*}"
|
|
53
|
+
}
|
|
54
|
+
};
|
|
55
|
+
option (google.api.method_signature) = "name";
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
// API to retrieve a list of `AdBreak` objects.
|
|
59
|
+
//
|
|
60
|
+
// By default, when no `orderBy` query parameter is specified, ad breaks are
|
|
61
|
+
// ordered reverse chronologically. However, ad breaks with a 'breakState' of
|
|
62
|
+
// 'SCHEDULED' or 'DECISIONED' are prioritized and appear first.
|
|
63
|
+
rpc ListAdBreaks(ListAdBreaksRequest) returns (ListAdBreaksResponse) {
|
|
64
|
+
option (google.api.http) = {
|
|
65
|
+
get: "/v1/{parent=networks/*/liveStreamEventsByAssetKey/*}/adBreaks"
|
|
66
|
+
additional_bindings {
|
|
67
|
+
get: "/v1/{parent=networks/*/liveStreamEventsByCustomAssetKey/*}/adBreaks"
|
|
68
|
+
}
|
|
69
|
+
additional_bindings {
|
|
70
|
+
get: "/v1/{parent=networks/*/liveStreamEvents/*}/adBreaks"
|
|
71
|
+
}
|
|
72
|
+
};
|
|
73
|
+
option (google.api.method_signature) = "parent";
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
// API to create an `AdBreak` object.
|
|
77
|
+
//
|
|
78
|
+
// Informs DAI of an upcoming ad break for a live stream event, with an
|
|
79
|
+
// optional expected start time. DAI will begin decisioning ads for the break
|
|
80
|
+
// shortly before the expected start time, if provided. Each live stream
|
|
81
|
+
// event can only have one incomplete ad break at any given time. The next ad
|
|
82
|
+
// break can be scheduled after the previous ad break has started serving,
|
|
83
|
+
// indicated by its state being
|
|
84
|
+
// [`COMPLETE`][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.COMPLETE],
|
|
85
|
+
// or it has been deleted.
|
|
86
|
+
//
|
|
87
|
+
// This method cannot be used if the `LiveStreamEvent` has
|
|
88
|
+
// [prefetching ad breaks
|
|
89
|
+
// enabled](https://developers.google.com/ad-manager/api/reference/latest/LiveStreamEventService.LiveStreamEvent#prefetchenabled)
|
|
90
|
+
// or the event is not active. If a `LiveStreamEvent` is deactivated after
|
|
91
|
+
// creating an ad break and before the ad break is complete, the ad break
|
|
92
|
+
// is discarded.
|
|
93
|
+
//
|
|
94
|
+
// An ad break's state is complete when the following occurs:
|
|
95
|
+
// - Full service DAI: after a matching ad break shows in the
|
|
96
|
+
// `LiveStreamEvent` manifest only when the ad break has started decisioning.
|
|
97
|
+
// - Pod Serving: after the ad break is requested using the ad break ID or
|
|
98
|
+
// break sequence.
|
|
99
|
+
rpc CreateAdBreak(CreateAdBreakRequest) returns (AdBreak) {
|
|
100
|
+
option (google.api.http) = {
|
|
101
|
+
post: "/v1/{parent=networks/*/liveStreamEventsByAssetKey/*}/adBreaks"
|
|
102
|
+
body: "ad_break"
|
|
103
|
+
additional_bindings {
|
|
104
|
+
post: "/v1/{parent=networks/*/liveStreamEventsByCustomAssetKey/*}/adBreaks"
|
|
105
|
+
body: "ad_break"
|
|
106
|
+
}
|
|
107
|
+
additional_bindings {
|
|
108
|
+
post: "/v1/{parent=networks/*/liveStreamEvents/*}/adBreaks"
|
|
109
|
+
body: "ad_break"
|
|
110
|
+
}
|
|
111
|
+
};
|
|
112
|
+
option (google.api.method_signature) = "parent,ad_break";
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
// API to update an `AdBreak` object.
|
|
116
|
+
//
|
|
117
|
+
// Modify an ad break when its state is
|
|
118
|
+
// [`SCHEDULED`][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.SCHEDULED].
|
|
119
|
+
rpc UpdateAdBreak(UpdateAdBreakRequest) returns (AdBreak) {
|
|
120
|
+
option (google.api.http) = {
|
|
121
|
+
patch: "/v1/{ad_break.name=networks/*/liveStreamEventsByAssetKey/*/adBreaks/*}"
|
|
122
|
+
body: "ad_break"
|
|
123
|
+
};
|
|
124
|
+
option (google.api.method_signature) = "ad_break,update_mask";
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
// API to delete an `AdBreak` object.
|
|
128
|
+
//
|
|
129
|
+
// Deletes and cancels an incomplete ad break, mitigating the need to wait
|
|
130
|
+
// for the current break to serve before recreating an ad break. You can
|
|
131
|
+
// delete an ad break that has not started serving or seen in manifests,
|
|
132
|
+
// indicated by its state being
|
|
133
|
+
// [`SCHEDULED`][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.SCHEDULED]
|
|
134
|
+
// or
|
|
135
|
+
// [`DECISIONED`][google.ads.admanager.v1.AdBreakStateEnum.AdBreakState.DECISIONED].
|
|
136
|
+
rpc DeleteAdBreak(DeleteAdBreakRequest) returns (google.protobuf.Empty) {
|
|
137
|
+
option (google.api.http) = {
|
|
138
|
+
delete: "/v1/{name=networks/*/liveStreamEventsByAssetKey/*/adBreaks/*}"
|
|
139
|
+
};
|
|
140
|
+
option (google.api.method_signature) = "name";
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
|
|
144
|
+
// Request object for `GetAdBreak` method.
|
|
145
|
+
message GetAdBreakRequest {
|
|
146
|
+
// Required. The resource name of the AdBreak using the asset key or custom
|
|
147
|
+
// asset key.
|
|
148
|
+
//
|
|
149
|
+
// Format:
|
|
150
|
+
// `networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break_id}`
|
|
151
|
+
// `networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}/adBreaks/{ad_break_id}`
|
|
152
|
+
string name = 1 [
|
|
153
|
+
(google.api.field_behavior) = REQUIRED,
|
|
154
|
+
(google.api.resource_reference) = {
|
|
155
|
+
type: "admanager.googleapis.com/AdBreak"
|
|
156
|
+
}
|
|
157
|
+
];
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
// Request object for `ListAdBreaks` method.
|
|
161
|
+
message ListAdBreaksRequest {
|
|
162
|
+
// Required. The parent, which owns this collection of AdBreaks.
|
|
163
|
+
//
|
|
164
|
+
// Formats:
|
|
165
|
+
// `networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}`
|
|
166
|
+
// `networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}`
|
|
167
|
+
string parent = 1 [
|
|
168
|
+
(google.api.field_behavior) = REQUIRED,
|
|
169
|
+
(google.api.resource_reference) = {
|
|
170
|
+
type: "admanager.googleapis.com/LiveStreamEvent"
|
|
171
|
+
}
|
|
172
|
+
];
|
|
173
|
+
|
|
174
|
+
// Optional. The maximum number of `AdBreaks` to return. The service might
|
|
175
|
+
// return fewer than this value. If unspecified, at most 10 ad breaks are
|
|
176
|
+
// returned. The maximum value is `100`. Values above `100` are coerced to
|
|
177
|
+
// `100`.
|
|
178
|
+
int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
|
|
179
|
+
|
|
180
|
+
// Optional. A page token, received from a previous `ListAdBreaks` call.
|
|
181
|
+
// Provide this to retrieve the subsequent page.
|
|
182
|
+
//
|
|
183
|
+
// When paginating, all other parameters provided to `ListAdBreaks` must match
|
|
184
|
+
// the call that provided the page token.
|
|
185
|
+
string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
|
|
186
|
+
|
|
187
|
+
// Optional. Expression to filter the response.
|
|
188
|
+
// See syntax details at
|
|
189
|
+
// https://developers.google.com/ad-manager/api/beta/filters
|
|
190
|
+
string filter = 4 [(google.api.field_behavior) = OPTIONAL];
|
|
191
|
+
|
|
192
|
+
// Optional. Expression to specify sorting order.
|
|
193
|
+
// See syntax details at
|
|
194
|
+
// https://developers.google.com/ad-manager/api/beta/filters#order
|
|
195
|
+
string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
|
|
196
|
+
|
|
197
|
+
// Optional. Number of individual resources to skip while paginating.
|
|
198
|
+
int32 skip = 6 [(google.api.field_behavior) = OPTIONAL];
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
// Response object for `ListAdBreaksRequest` containing matching `AdBreak`
|
|
202
|
+
// objects.
|
|
203
|
+
message ListAdBreaksResponse {
|
|
204
|
+
// The `AdBreak` objects from the specified network.
|
|
205
|
+
repeated AdBreak ad_breaks = 1;
|
|
206
|
+
|
|
207
|
+
// A token, which can be sent as `page_token` to retrieve the next page.
|
|
208
|
+
// If this field is omitted, there are no subsequent pages. This field expires
|
|
209
|
+
// after five minutes.
|
|
210
|
+
string next_page_token = 2;
|
|
211
|
+
|
|
212
|
+
// Total number of `AdBreak` objects.
|
|
213
|
+
// If a filter was included in the request, this reflects the total number
|
|
214
|
+
// after the filtering is applied.
|
|
215
|
+
//
|
|
216
|
+
// `total_size` will not be calculated in the response unless it has been
|
|
217
|
+
// included in a response field mask. The response field mask can be provided
|
|
218
|
+
// to the method by using the URL parameter `$fields` or `fields`, or by using
|
|
219
|
+
// the HTTP/gRPC header `X-Goog-FieldMask`.
|
|
220
|
+
//
|
|
221
|
+
// For more information, see
|
|
222
|
+
// https://developers.google.com/ad-manager/api/beta/field-masks
|
|
223
|
+
int32 total_size = 3;
|
|
224
|
+
}
|
|
225
|
+
|
|
226
|
+
// Request object for `CreateAdBreak` method.
|
|
227
|
+
message CreateAdBreakRequest {
|
|
228
|
+
// Required. The parent resource where this `AdBreak` will be created
|
|
229
|
+
// identified by an asset key or custom asset key.
|
|
230
|
+
//
|
|
231
|
+
// Formats:
|
|
232
|
+
// `networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}`
|
|
233
|
+
// `networks/{network_code}/liveStreamEventsByCustomAssetKey/{custom_asset_key}`
|
|
234
|
+
string parent = 1 [
|
|
235
|
+
(google.api.field_behavior) = REQUIRED,
|
|
236
|
+
(google.api.resource_reference) = {
|
|
237
|
+
type: "admanager.googleapis.com/LiveStreamEvent"
|
|
238
|
+
}
|
|
239
|
+
];
|
|
240
|
+
|
|
241
|
+
// Required. The `AdBreak` to create.
|
|
242
|
+
AdBreak ad_break = 2 [(google.api.field_behavior) = REQUIRED];
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
// Request object for `UpdateAdBreak` method.
|
|
246
|
+
message UpdateAdBreakRequest {
|
|
247
|
+
// Required. The `AdBreak` to update.
|
|
248
|
+
//
|
|
249
|
+
// The `AdBreak`'s `name` is used to identify the `AdBreak` to update.
|
|
250
|
+
AdBreak ad_break = 1 [(google.api.field_behavior) = REQUIRED];
|
|
251
|
+
|
|
252
|
+
// Required. The list of fields to update.
|
|
253
|
+
google.protobuf.FieldMask update_mask = 2
|
|
254
|
+
[(google.api.field_behavior) = REQUIRED];
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
// Request object for `DeleteAdBreak` method.
|
|
258
|
+
message DeleteAdBreakRequest {
|
|
259
|
+
// Required. The name of the ad break to delete.
|
|
260
|
+
//
|
|
261
|
+
// Format:
|
|
262
|
+
// `networks/{network_code}/liveStreamEventsByAssetKey/{asset_key}/adBreaks/{ad_break}`
|
|
263
|
+
string name = 1 [
|
|
264
|
+
(google.api.field_behavior) = REQUIRED,
|
|
265
|
+
(google.api.resource_reference) = {
|
|
266
|
+
type: "admanager.googleapis.com/AdBreak"
|
|
267
|
+
}
|
|
268
|
+
];
|
|
269
|
+
}
|