@google-ads/admanager 0.3.0 → 0.4.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +86 -150
- 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
|
@@ -1,24 +1,24 @@
|
|
|
1
1
|
[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
|
|
2
|
-
[//]: # "
|
|
2
|
+
[//]: # "The comments you see below are used to generate those parts of the template in later states."
|
|
3
3
|
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
|
|
4
4
|
|
|
5
|
-
# [Google Ad Manager API:
|
|
6
|
-
|
|
7
|
-
[](https://cloud.google.com/terms/launch-stages)
|
|
8
|
-
[](https://www.npmjs.org/package/@google-ads/admanager)
|
|
9
|
-
|
|
5
|
+
# [Google Ad Manager API: Nodejs Client][homepage]
|
|
10
6
|
|
|
7
|
+
This library is considered to be in **preview**. This means it is still a
|
|
8
|
+
work-in-progress and under active development. Any release is subject to
|
|
9
|
+
backwards-incompatible changes at any time.
|
|
11
10
|
|
|
11
|
+
[](https://www.npmjs.org/package/@google-ads/admanager)
|
|
12
12
|
|
|
13
13
|
Google Ad Manager API client for Node.js
|
|
14
14
|
|
|
15
|
+
[//]: # "partials.introduction"
|
|
15
16
|
|
|
16
17
|
A comprehensive list of changes in each version may be found in
|
|
17
|
-
[the CHANGELOG]
|
|
18
|
+
[the CHANGELOG][homepage_changelog].
|
|
18
19
|
|
|
19
|
-
* [Google Ad Manager API
|
|
20
|
-
* [Google Ad Manager API Documentation]
|
|
21
|
-
* [github.com/googleapis/google-cloud-node/packages/google-ads-admanager](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-ads-admanager)
|
|
20
|
+
* [Google Ad Manager API Nodejs Client API Reference](https://cloud.google.com/nodejs/docs/reference/admanager/latest)
|
|
21
|
+
* [Google Ad Manager API Documentation](https://developers.google.com/ad-manager/api/beta)
|
|
22
22
|
|
|
23
23
|
Read more about the client libraries for Cloud APIs, including the older
|
|
24
24
|
Google APIs Client Libraries, in [Client Libraries Explained][explained].
|
|
@@ -27,149 +27,97 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
|
|
|
27
27
|
|
|
28
28
|
**Table of contents:**
|
|
29
29
|
|
|
30
|
-
|
|
31
30
|
* [Quickstart](#quickstart)
|
|
32
31
|
* [Before you begin](#before-you-begin)
|
|
33
32
|
* [Installing the client library](#installing-the-client-library)
|
|
34
|
-
|
|
35
|
-
* [Samples](#samples)
|
|
33
|
+
|
|
36
34
|
* [Versioning](#versioning)
|
|
37
35
|
* [Contributing](#contributing)
|
|
38
36
|
* [License](#license)
|
|
39
37
|
|
|
40
38
|
## Quickstart
|
|
41
|
-
|
|
42
39
|
### Before you begin
|
|
43
40
|
|
|
44
41
|
1. [Select or create a Cloud Platform project][projects].
|
|
45
42
|
1. [Enable billing for your project][billing].
|
|
46
43
|
1. [Enable the Google Ad Manager API API][enable_api].
|
|
47
|
-
1. [Set up authentication
|
|
44
|
+
1. [Set up authentication][auth] so you can access the
|
|
48
45
|
API from your local workstation.
|
|
49
|
-
|
|
50
46
|
### Installing the client library
|
|
51
47
|
|
|
52
48
|
```bash
|
|
53
49
|
npm install @google-ads/admanager
|
|
54
50
|
```
|
|
55
51
|
|
|
56
|
-
|
|
57
|
-
### Using the client library
|
|
58
|
-
|
|
59
|
-
```javascript
|
|
60
|
-
/**
|
|
61
|
-
* This snippet has been automatically generated and should be regarded as a code template only.
|
|
62
|
-
* It will require modifications to work.
|
|
63
|
-
* It may require correct/in-range values for request initialization.
|
|
64
|
-
* TODO(developer): Uncomment these variables before running the sample.
|
|
65
|
-
*/
|
|
66
|
-
/**
|
|
67
|
-
* Required. The parent, which owns this collection of AdUnitSizes.
|
|
68
|
-
* Format: `networks/{network_code}`
|
|
69
|
-
*/
|
|
70
|
-
// const parent = 'abc123'
|
|
71
|
-
/**
|
|
72
|
-
* Optional. The maximum number of AdUnitSizes to return. The service may
|
|
73
|
-
* return fewer than this value. If unspecified, at most 50 ad unit sizes will
|
|
74
|
-
* be returned. The maximum value is 1000; values above 1000 will be coerced
|
|
75
|
-
* to 1000.
|
|
76
|
-
*/
|
|
77
|
-
// const pageSize = 1234
|
|
78
|
-
/**
|
|
79
|
-
* Optional. A page token, received from a previous `ListAdUnitSizes` call.
|
|
80
|
-
* Provide this to retrieve the subsequent page.
|
|
81
|
-
* When paginating, all other parameters provided to `ListAdUnitSizes` must
|
|
82
|
-
* match the call that provided the page token.
|
|
83
|
-
*/
|
|
84
|
-
// const pageToken = 'abc123'
|
|
85
|
-
/**
|
|
86
|
-
* Optional. Expression to filter the response.
|
|
87
|
-
* See syntax details at
|
|
88
|
-
* https://developers.google.com/ad-manager/api/beta/filters
|
|
89
|
-
*/
|
|
90
|
-
// const filter = 'abc123'
|
|
91
|
-
/**
|
|
92
|
-
* Optional. Expression to specify sorting order.
|
|
93
|
-
* See syntax details at
|
|
94
|
-
* https://developers.google.com/ad-manager/api/beta/filters#order
|
|
95
|
-
*/
|
|
96
|
-
// const orderBy = 'abc123'
|
|
97
|
-
/**
|
|
98
|
-
* Optional. Number of individual resources to skip while paginating.
|
|
99
|
-
*/
|
|
100
|
-
// const skip = 1234
|
|
101
|
-
|
|
102
|
-
// Imports the Admanager library
|
|
103
|
-
const {AdUnitServiceClient} = require('@google-ads/admanager').v1;
|
|
104
|
-
|
|
105
|
-
// Instantiates a client
|
|
106
|
-
const admanagerClient = new AdUnitServiceClient();
|
|
107
|
-
|
|
108
|
-
async function callListAdUnitSizes() {
|
|
109
|
-
// Construct request
|
|
110
|
-
const request = {
|
|
111
|
-
parent,
|
|
112
|
-
};
|
|
113
|
-
|
|
114
|
-
// Run request
|
|
115
|
-
const iterable = admanagerClient.listAdUnitSizesAsync(request);
|
|
116
|
-
for await (const response of iterable) {
|
|
117
|
-
console.log(response);
|
|
118
|
-
}
|
|
119
|
-
}
|
|
120
|
-
|
|
121
|
-
callListAdUnitSizes();
|
|
122
|
-
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
|
|
52
|
+
[//]: # "partials.body"
|
|
126
53
|
|
|
127
54
|
## Samples
|
|
128
55
|
|
|
129
|
-
Samples are in the [`samples/`]
|
|
130
|
-
|
|
131
|
-
| Sample | Source Code |
|
|
132
|
-
| --------------------------- | --------------------------------- |
|
|
133
|
-
|
|
|
134
|
-
|
|
|
135
|
-
|
|
|
136
|
-
|
|
|
137
|
-
|
|
|
138
|
-
|
|
|
139
|
-
|
|
|
140
|
-
|
|
|
141
|
-
|
|
|
142
|
-
|
|
|
143
|
-
|
|
|
144
|
-
|
|
|
145
|
-
|
|
|
146
|
-
|
|
|
147
|
-
|
|
|
148
|
-
|
|
|
149
|
-
|
|
|
150
|
-
|
|
|
151
|
-
|
|
|
152
|
-
|
|
|
153
|
-
|
|
|
154
|
-
|
|
|
155
|
-
|
|
|
156
|
-
|
|
|
157
|
-
|
|
|
158
|
-
|
|
|
159
|
-
|
|
|
160
|
-
|
|
|
161
|
-
|
|
|
162
|
-
|
|
|
163
|
-
|
|
|
164
|
-
|
|
|
165
|
-
|
|
|
166
|
-
|
|
|
167
|
-
|
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
56
|
+
Samples are in the [`samples/`][homepage_samples] directory. Each sample's `README.md` has instructions for running its sample.
|
|
57
|
+
|
|
58
|
+
| Sample | Source Code |
|
|
59
|
+
| --------------------------- | --------------------------------- |
|
|
60
|
+
| 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) |
|
|
61
|
+
| 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) |
|
|
62
|
+
| 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) |
|
|
63
|
+
| 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) |
|
|
64
|
+
| 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) |
|
|
65
|
+
| 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) |
|
|
66
|
+
| 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) |
|
|
67
|
+
| 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) |
|
|
68
|
+
| 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) |
|
|
69
|
+
| 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) |
|
|
70
|
+
| 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) |
|
|
71
|
+
| 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) |
|
|
72
|
+
| 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) |
|
|
73
|
+
| list custom fields | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/custom_field_service.list_custom_fields.js) |
|
|
74
|
+
| get custom targeting key | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/custom_targeting_key_service.get_custom_targeting_key.js) |
|
|
75
|
+
| 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) |
|
|
76
|
+
| 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) |
|
|
77
|
+
| 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) |
|
|
78
|
+
| 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) |
|
|
79
|
+
| 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) |
|
|
80
|
+
| 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) |
|
|
81
|
+
| 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) |
|
|
82
|
+
| 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) |
|
|
83
|
+
| 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) |
|
|
84
|
+
| 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) |
|
|
85
|
+
| 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) |
|
|
86
|
+
| 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) |
|
|
87
|
+
| 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) |
|
|
88
|
+
| 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) |
|
|
89
|
+
| 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) |
|
|
90
|
+
| 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) |
|
|
91
|
+
| 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) |
|
|
92
|
+
| 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) |
|
|
93
|
+
| 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) |
|
|
94
|
+
| 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) |
|
|
95
|
+
| 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) |
|
|
96
|
+
| 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) |
|
|
97
|
+
| 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) |
|
|
98
|
+
| 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) |
|
|
99
|
+
| 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) |
|
|
100
|
+
| 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) |
|
|
101
|
+
| 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) |
|
|
102
|
+
| 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) |
|
|
103
|
+
| 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) |
|
|
104
|
+
| 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) |
|
|
105
|
+
| 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) |
|
|
106
|
+
| 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) |
|
|
107
|
+
| 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) |
|
|
108
|
+
| 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) |
|
|
109
|
+
| 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) |
|
|
110
|
+
| 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) |
|
|
111
|
+
| list reports | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/report_service.list_reports.js) |
|
|
112
|
+
| run report | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/report_service.run_report.js) |
|
|
113
|
+
| update report | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/report_service.update_report.js) |
|
|
114
|
+
| get role | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/role_service.get_role.js) |
|
|
115
|
+
| list roles | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/role_service.list_roles.js) |
|
|
116
|
+
| ads | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/snippet_metadata_google.ads.admanager.v1.json) |
|
|
117
|
+
| get taxonomy category | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/taxonomy_category_service.get_taxonomy_category.js) |
|
|
118
|
+
| list taxonomy categories | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/taxonomy_category_service.list_taxonomy_categories.js) |
|
|
119
|
+
| get user | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples/generated/v1/user_service.get_user.js) |
|
|
120
|
+
|
|
173
121
|
|
|
174
122
|
## Supported Node.js Versions
|
|
175
123
|
|
|
@@ -196,41 +144,29 @@ for versions compatible with Node.js 8.
|
|
|
196
144
|
|
|
197
145
|
This library follows [Semantic Versioning](http://semver.org/).
|
|
198
146
|
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
This library is considered to be in **preview**. This means it is still a
|
|
206
|
-
work-in-progress and under active development. Any release is subject to
|
|
207
|
-
backwards-incompatible changes at any time.
|
|
208
|
-
|
|
209
|
-
|
|
210
147
|
More Information: [Google Cloud Platform Launch Stages][launch_stages]
|
|
211
148
|
|
|
212
149
|
[launch_stages]: https://cloud.google.com/terms/launch-stages
|
|
213
150
|
|
|
214
151
|
## Contributing
|
|
215
152
|
|
|
216
|
-
Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md).
|
|
153
|
+
Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/CONTRIBUTING.md).
|
|
217
154
|
|
|
218
|
-
Please note that this `README.md
|
|
155
|
+
Please note that this `README.md`
|
|
219
156
|
and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
|
|
220
|
-
are generated from a central template.
|
|
221
|
-
to its templates in
|
|
222
|
-
[directory](https://github.com/googleapis/synthtool).
|
|
157
|
+
are generated from a central template.
|
|
223
158
|
|
|
224
159
|
## License
|
|
225
160
|
|
|
226
161
|
Apache Version 2.0
|
|
227
162
|
|
|
228
|
-
See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
|
|
163
|
+
See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/LICENSE)
|
|
229
164
|
|
|
230
|
-
[client-docs]: https://cloud.google.com/nodejs/docs/reference/admanager/latest
|
|
231
|
-
[product-docs]: https://developers.google.com/ad-manager/api/beta
|
|
232
165
|
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
|
|
233
166
|
[projects]: https://console.cloud.google.com/project
|
|
234
167
|
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
|
|
235
168
|
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=admanager.googleapis.com
|
|
236
|
-
[auth]: https://cloud.google.com/docs/authentication/
|
|
169
|
+
[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
|
|
170
|
+
[homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/samples
|
|
171
|
+
[homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager/CHANGELOG.md
|
|
172
|
+
[homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-ads-admanager
|
|
@@ -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
|
+
}
|