@google-ads/admanager 0.5.0 → 0.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +15 -0
- package/build/protos/google/ads/admanager/v1/ad_review_center_ad_service.proto +4 -3
- package/build/protos/google/ads/admanager/v1/ad_unit_service.proto +216 -0
- package/build/protos/google/ads/admanager/v1/cms_metadata_value_service.proto +2 -2
- package/build/protos/google/ads/admanager/v1/custom_targeting_key_service.proto +190 -0
- package/build/protos/google/ads/admanager/v1/goal.proto +57 -0
- package/build/protos/google/ads/admanager/v1/goal_enums.proto +129 -0
- package/build/protos/google/ads/admanager/v1/line_item_enums.proto +86 -0
- package/build/protos/google/ads/admanager/v1/line_item_messages.proto +93 -0
- package/build/protos/google/ads/admanager/v1/line_item_service.proto +128 -0
- package/build/protos/google/ads/admanager/v1/network_messages.proto +8 -8
- package/build/protos/google/ads/admanager/v1/network_service.proto +32 -1
- package/build/protos/google/ads/admanager/v1/order_messages.proto +4 -2
- package/build/protos/google/ads/admanager/v1/report_definition.proto +927 -58
- package/build/protos/google/ads/admanager/v1/report_messages.proto +7 -2
- package/build/protos/protos.d.ts +9435 -5893
- package/build/protos/protos.js +29871 -20651
- package/build/protos/protos.json +1191 -105
- package/build/src/index.d.ts +4 -1
- package/build/src/index.js +5 -3
- package/build/src/index.js.map +1 -1
- package/build/src/v1/ad_break_service_client.d.ts +24 -0
- package/build/src/v1/ad_break_service_client.js +35 -1
- package/build/src/v1/ad_break_service_client.js.map +1 -1
- package/build/src/v1/ad_break_service_proto_list.json +5 -0
- package/build/src/v1/ad_review_center_ad_service_client.d.ts +36 -9
- package/build/src/v1/ad_review_center_ad_service_client.js +43 -7
- package/build/src/v1/ad_review_center_ad_service_client.js.map +1 -1
- package/build/src/v1/ad_review_center_ad_service_proto_list.json +5 -0
- package/build/src/v1/ad_unit_service_client.d.ts +214 -0
- package/build/src/v1/ad_unit_service_client.js +288 -2
- package/build/src/v1/ad_unit_service_client.js.map +1 -1
- package/build/src/v1/ad_unit_service_client_config.json +28 -0
- package/build/src/v1/ad_unit_service_proto_list.json +5 -0
- package/build/src/v1/application_service_client.d.ts +24 -0
- package/build/src/v1/application_service_client.js +35 -1
- package/build/src/v1/application_service_client.js.map +1 -1
- package/build/src/v1/application_service_proto_list.json +5 -0
- package/build/src/v1/audience_segment_service_client.d.ts +24 -0
- package/build/src/v1/audience_segment_service_client.js +35 -1
- package/build/src/v1/audience_segment_service_client.js.map +1 -1
- package/build/src/v1/audience_segment_service_proto_list.json +5 -0
- package/build/src/v1/bandwidth_group_service_client.d.ts +24 -0
- package/build/src/v1/bandwidth_group_service_client.js +35 -1
- package/build/src/v1/bandwidth_group_service_client.js.map +1 -1
- package/build/src/v1/bandwidth_group_service_proto_list.json +5 -0
- package/build/src/v1/browser_language_service_client.d.ts +24 -0
- package/build/src/v1/browser_language_service_client.js +35 -1
- package/build/src/v1/browser_language_service_client.js.map +1 -1
- package/build/src/v1/browser_language_service_proto_list.json +5 -0
- package/build/src/v1/browser_service_client.d.ts +24 -0
- package/build/src/v1/browser_service_client.js +35 -1
- package/build/src/v1/browser_service_client.js.map +1 -1
- package/build/src/v1/browser_service_proto_list.json +5 -0
- package/build/src/v1/cms_metadata_key_service_client.d.ts +24 -0
- package/build/src/v1/cms_metadata_key_service_client.js +35 -1
- package/build/src/v1/cms_metadata_key_service_client.js.map +1 -1
- package/build/src/v1/cms_metadata_key_service_proto_list.json +5 -0
- package/build/src/v1/cms_metadata_value_service_client.d.ts +26 -2
- package/build/src/v1/cms_metadata_value_service_client.js +35 -1
- package/build/src/v1/cms_metadata_value_service_client.js.map +1 -1
- package/build/src/v1/cms_metadata_value_service_proto_list.json +5 -0
- package/build/src/v1/company_service_client.d.ts +24 -0
- package/build/src/v1/company_service_client.js +35 -1
- package/build/src/v1/company_service_client.js.map +1 -1
- package/build/src/v1/company_service_proto_list.json +5 -0
- package/build/src/v1/contact_service_client.d.ts +24 -0
- package/build/src/v1/contact_service_client.js +35 -1
- package/build/src/v1/contact_service_client.js.map +1 -1
- package/build/src/v1/contact_service_proto_list.json +5 -0
- package/build/src/v1/content_bundle_service_client.d.ts +24 -0
- package/build/src/v1/content_bundle_service_client.js +35 -1
- package/build/src/v1/content_bundle_service_client.js.map +1 -1
- package/build/src/v1/content_bundle_service_proto_list.json +5 -0
- package/build/src/v1/content_label_service_client.d.ts +24 -0
- package/build/src/v1/content_label_service_client.js +35 -1
- package/build/src/v1/content_label_service_client.js.map +1 -1
- package/build/src/v1/content_label_service_proto_list.json +5 -0
- package/build/src/v1/content_service_client.d.ts +24 -0
- package/build/src/v1/content_service_client.js +35 -1
- package/build/src/v1/content_service_client.js.map +1 -1
- package/build/src/v1/content_service_proto_list.json +5 -0
- package/build/src/v1/creative_template_service_client.d.ts +24 -0
- package/build/src/v1/creative_template_service_client.js +35 -1
- package/build/src/v1/creative_template_service_client.js.map +1 -1
- package/build/src/v1/creative_template_service_proto_list.json +5 -0
- package/build/src/v1/custom_field_service_client.d.ts +24 -0
- package/build/src/v1/custom_field_service_client.js +35 -1
- package/build/src/v1/custom_field_service_client.js.map +1 -1
- package/build/src/v1/custom_field_service_proto_list.json +5 -0
- package/build/src/v1/custom_targeting_key_service_client.d.ts +190 -0
- package/build/src/v1/custom_targeting_key_service_client.js +252 -2
- package/build/src/v1/custom_targeting_key_service_client.js.map +1 -1
- package/build/src/v1/custom_targeting_key_service_client_config.json +24 -0
- package/build/src/v1/custom_targeting_key_service_proto_list.json +5 -0
- package/build/src/v1/custom_targeting_value_service_client.d.ts +24 -0
- package/build/src/v1/custom_targeting_value_service_client.js +35 -1
- package/build/src/v1/custom_targeting_value_service_client.js.map +1 -1
- package/build/src/v1/custom_targeting_value_service_proto_list.json +5 -0
- package/build/src/v1/device_capability_service_client.d.ts +24 -0
- package/build/src/v1/device_capability_service_client.js +35 -1
- package/build/src/v1/device_capability_service_client.js.map +1 -1
- package/build/src/v1/device_capability_service_proto_list.json +5 -0
- package/build/src/v1/device_category_service_client.d.ts +24 -0
- package/build/src/v1/device_category_service_client.js +35 -1
- package/build/src/v1/device_category_service_client.js.map +1 -1
- package/build/src/v1/device_category_service_proto_list.json +5 -0
- package/build/src/v1/device_manufacturer_service_client.d.ts +24 -0
- package/build/src/v1/device_manufacturer_service_client.js +35 -1
- package/build/src/v1/device_manufacturer_service_client.js.map +1 -1
- package/build/src/v1/device_manufacturer_service_proto_list.json +5 -0
- package/build/src/v1/entity_signals_mapping_service_client.d.ts +24 -0
- package/build/src/v1/entity_signals_mapping_service_client.js +35 -1
- package/build/src/v1/entity_signals_mapping_service_client.js.map +1 -1
- package/build/src/v1/entity_signals_mapping_service_proto_list.json +5 -0
- package/build/src/v1/gapic_metadata.json +174 -2
- package/build/src/v1/geo_target_service_client.d.ts +24 -0
- package/build/src/v1/geo_target_service_client.js +35 -1
- package/build/src/v1/geo_target_service_client.js.map +1 -1
- package/build/src/v1/geo_target_service_proto_list.json +5 -0
- package/build/src/v1/index.d.ts +1 -0
- package/build/src/v1/index.js +4 -2
- package/build/src/v1/index.js.map +1 -1
- package/build/src/v1/line_item_service_client.d.ts +1369 -0
- package/build/src/v1/line_item_service_client.js +2027 -0
- package/build/src/v1/line_item_service_client.js.map +1 -0
- package/build/src/v1/line_item_service_client_config.json +34 -0
- package/build/src/v1/line_item_service_proto_list.json +127 -0
- package/build/src/v1/mobile_carrier_service_client.d.ts +24 -0
- package/build/src/v1/mobile_carrier_service_client.js +35 -1
- package/build/src/v1/mobile_carrier_service_client.js.map +1 -1
- package/build/src/v1/mobile_carrier_service_proto_list.json +5 -0
- package/build/src/v1/mobile_device_service_client.d.ts +24 -0
- package/build/src/v1/mobile_device_service_client.js +35 -1
- package/build/src/v1/mobile_device_service_client.js.map +1 -1
- package/build/src/v1/mobile_device_service_proto_list.json +5 -0
- package/build/src/v1/mobile_device_submodel_service_client.d.ts +24 -0
- package/build/src/v1/mobile_device_submodel_service_client.js +35 -1
- package/build/src/v1/mobile_device_submodel_service_client.js.map +1 -1
- package/build/src/v1/mobile_device_submodel_service_proto_list.json +5 -0
- package/build/src/v1/network_service_client.d.ts +114 -12
- package/build/src/v1/network_service_client.js +133 -16
- package/build/src/v1/network_service_client.js.map +1 -1
- package/build/src/v1/network_service_proto_list.json +5 -0
- package/build/src/v1/operating_system_service_client.d.ts +24 -0
- package/build/src/v1/operating_system_service_client.js +35 -1
- package/build/src/v1/operating_system_service_client.js.map +1 -1
- package/build/src/v1/operating_system_service_proto_list.json +5 -0
- package/build/src/v1/operating_system_version_service_client.d.ts +24 -0
- package/build/src/v1/operating_system_version_service_client.js +35 -1
- package/build/src/v1/operating_system_version_service_client.js.map +1 -1
- package/build/src/v1/operating_system_version_service_proto_list.json +5 -0
- package/build/src/v1/order_service_client.d.ts +24 -0
- package/build/src/v1/order_service_client.js +35 -1
- package/build/src/v1/order_service_client.js.map +1 -1
- package/build/src/v1/order_service_proto_list.json +5 -0
- package/build/src/v1/placement_service_client.d.ts +24 -0
- package/build/src/v1/placement_service_client.js +35 -1
- package/build/src/v1/placement_service_client.js.map +1 -1
- package/build/src/v1/placement_service_proto_list.json +5 -0
- package/build/src/v1/private_auction_deal_service_client.d.ts +24 -0
- package/build/src/v1/private_auction_deal_service_client.js +35 -1
- package/build/src/v1/private_auction_deal_service_client.js.map +1 -1
- package/build/src/v1/private_auction_deal_service_proto_list.json +5 -0
- package/build/src/v1/private_auction_service_client.d.ts +24 -0
- package/build/src/v1/private_auction_service_client.js +35 -1
- package/build/src/v1/private_auction_service_client.js.map +1 -1
- package/build/src/v1/private_auction_service_proto_list.json +5 -0
- package/build/src/v1/programmatic_buyer_service_client.d.ts +24 -0
- package/build/src/v1/programmatic_buyer_service_client.js +35 -1
- package/build/src/v1/programmatic_buyer_service_client.js.map +1 -1
- package/build/src/v1/programmatic_buyer_service_proto_list.json +5 -0
- package/build/src/v1/report_service_client.d.ts +24 -0
- package/build/src/v1/report_service_client.js +35 -1
- package/build/src/v1/report_service_client.js.map +1 -1
- package/build/src/v1/report_service_proto_list.json +5 -0
- package/build/src/v1/role_service_client.d.ts +24 -0
- package/build/src/v1/role_service_client.js +35 -1
- package/build/src/v1/role_service_client.js.map +1 -1
- package/build/src/v1/role_service_proto_list.json +5 -0
- package/build/src/v1/site_service_client.d.ts +24 -0
- package/build/src/v1/site_service_client.js +35 -1
- package/build/src/v1/site_service_client.js.map +1 -1
- package/build/src/v1/site_service_proto_list.json +5 -0
- package/build/src/v1/taxonomy_category_service_client.d.ts +24 -0
- package/build/src/v1/taxonomy_category_service_client.js +35 -1
- package/build/src/v1/taxonomy_category_service_client.js.map +1 -1
- package/build/src/v1/taxonomy_category_service_proto_list.json +5 -0
- package/build/src/v1/team_service_client.d.ts +24 -0
- package/build/src/v1/team_service_client.js +35 -1
- package/build/src/v1/team_service_client.js.map +1 -1
- package/build/src/v1/team_service_proto_list.json +5 -0
- package/build/src/v1/user_service_client.d.ts +24 -0
- package/build/src/v1/user_service_client.js +35 -1
- package/build/src/v1/user_service_client.js.map +1 -1
- package/build/src/v1/user_service_proto_list.json +5 -0
- package/package.json +10 -2
- package/LICENSE +0 -202
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
// Copyright 2025 Google LLC
|
|
2
|
+
//
|
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
// you may not use this file except in compliance with the License.
|
|
5
|
+
// You may obtain a copy of the License at
|
|
6
|
+
//
|
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
//
|
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
// See the License for the specific language governing permissions and
|
|
13
|
+
// limitations under the License.
|
|
14
|
+
|
|
15
|
+
syntax = "proto3";
|
|
16
|
+
|
|
17
|
+
package google.ads.admanager.v1;
|
|
18
|
+
|
|
19
|
+
option csharp_namespace = "Google.Ads.AdManager.V1";
|
|
20
|
+
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
|
|
21
|
+
option java_multiple_files = true;
|
|
22
|
+
option java_outer_classname = "GoalEnumsProto";
|
|
23
|
+
option java_package = "com.google.ads.admanager.v1";
|
|
24
|
+
option php_namespace = "Google\\Ads\\AdManager\\V1";
|
|
25
|
+
option ruby_package = "Google::Ads::AdManager::V1";
|
|
26
|
+
|
|
27
|
+
// Wrapper message for
|
|
28
|
+
// [GoalType][google.ads.admanager.v1.GoalTypeEnum.GoalType].
|
|
29
|
+
message GoalTypeEnum {
|
|
30
|
+
// Specifies the type of the goal for a LineItem.
|
|
31
|
+
enum GoalType {
|
|
32
|
+
// Default value. This value is unused.
|
|
33
|
+
GOAL_TYPE_UNSPECIFIED = 0;
|
|
34
|
+
|
|
35
|
+
// No goal is specified for the number of ads delivered.
|
|
36
|
+
// The line item [type][google.ads.admanager.v1.LineItem.line_item_type]
|
|
37
|
+
// must be one of:
|
|
38
|
+
//
|
|
39
|
+
// * [LineItemTypeEnum.LineItemType.PRICE_PRIORITY][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.PRICE_PRIORITY]
|
|
40
|
+
// * [LineItemTypeEnum.LineItemType.AD_EXCHANGE][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.AD_EXCHANGE]
|
|
41
|
+
// * [LineItemTypeEnum.LineItemType.CLICK_TRACKING][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.CLICK_TRACKING]
|
|
42
|
+
NONE = 1;
|
|
43
|
+
|
|
44
|
+
// There is a goal on the number of ads delivered for this line item during
|
|
45
|
+
// its entire lifetime.
|
|
46
|
+
// The line item [type][google.ads.admanager.v1.LineItem.line_item_type]
|
|
47
|
+
// must be one of:
|
|
48
|
+
//
|
|
49
|
+
// * [LineItemTypeEnum.LineItemType.STANDARD][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.STANDARD]
|
|
50
|
+
// * [LineItemTypeEnum.LineItemType.BULK][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.BULK]
|
|
51
|
+
// * [LineItemTypeEnum.LineItemType.PRICE_PRIORITY][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.PRICE_PRIORITY]
|
|
52
|
+
// * [LineItemTypeEnum.LineItemType.ADSENSE][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.ADSENSE]
|
|
53
|
+
// * [LineItemTypeEnum.LineItemType.AD_EXCHANGE][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.AD_EXCHANGE]
|
|
54
|
+
// * [LineItemTypeEnum.LineItemType.ADMOB][]
|
|
55
|
+
// * [LineItemTypeEnum.LineItemType.CLICK_TRACKING][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.CLICK_TRACKING]
|
|
56
|
+
LIFETIME = 2;
|
|
57
|
+
|
|
58
|
+
// There is a daily goal on the number of ads delivered for this line item.
|
|
59
|
+
// The line item [type][google.ads.admanager.v1.LineItem.line_item_type]
|
|
60
|
+
// must be one of:
|
|
61
|
+
//
|
|
62
|
+
// * [LineItemTypeEnum.LineItemType.SPONSORSHIP][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.SPONSORSHIP]
|
|
63
|
+
// * [LineItemTypeEnum.LineItemType.NETWORK][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.NETWORK]
|
|
64
|
+
// * [LineItemTypeEnum.LineItemType.PRICE_PRIORITY][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.PRICE_PRIORITY]
|
|
65
|
+
// * [LineItemTypeEnum.LineItemType.HOUSE][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.HOUSE]
|
|
66
|
+
// * [LineItemTypeEnum.LineItemType.ADSENSE][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.ADSENSE]
|
|
67
|
+
// * [LineItemTypeEnum.LineItemType.AD_EXCHANGE][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.AD_EXCHANGE]
|
|
68
|
+
// * [LineItemTypeEnum.LineItemType.ADMOB][]
|
|
69
|
+
// * [LineItemTypeEnum.LineItemType.BUMPER][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.BUMPER]
|
|
70
|
+
DAILY = 3;
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
// Wrapper message for
|
|
75
|
+
// [UnitType][google.ads.admanager.v1.UnitTypeEnum.UnitType].
|
|
76
|
+
message UnitTypeEnum {
|
|
77
|
+
// Indicates the type of unit used for defining a reservation. The
|
|
78
|
+
// [LineItem.cost_type][] can differ from the UnitType - an
|
|
79
|
+
// ad can have an impression goal, but be billed by its click. Usually
|
|
80
|
+
// CostType and UnitType will refer to the same unit.
|
|
81
|
+
enum UnitType {
|
|
82
|
+
// Default value. This value is unused.
|
|
83
|
+
UNIT_TYPE_UNSPECIFIED = 0;
|
|
84
|
+
|
|
85
|
+
// The number of impressions served by creatives associated with the line
|
|
86
|
+
// item.
|
|
87
|
+
IMPRESSIONS = 1;
|
|
88
|
+
|
|
89
|
+
// The number of clicks reported by creatives associated with the line item.
|
|
90
|
+
// The line item [type][google.ads.admanager.v1.LineItem.line_item_type]
|
|
91
|
+
// must be one of:
|
|
92
|
+
//
|
|
93
|
+
// * [LineItemTypeEnum.LineItemType.STANDARD][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.STANDARD]
|
|
94
|
+
// * [LineItemTypeEnum.LineItemType.BULK][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.BULK]
|
|
95
|
+
// * [LineItemTypeEnum.LineItemType.PRICE_PRIORITY][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.PRICE_PRIORITY]
|
|
96
|
+
CLICKS = 2;
|
|
97
|
+
|
|
98
|
+
// The number of click-through Cost-Per-Action (CPA) conversions from
|
|
99
|
+
// creatives associated with the line item. This is only supported as
|
|
100
|
+
// secondary goal and the [LineItem.cost_type][] must be
|
|
101
|
+
// [CostTypeEnum.CostType.CPA][].
|
|
102
|
+
CLICK_THROUGH_CPA_CONVERSIONS = 3;
|
|
103
|
+
|
|
104
|
+
// The number of view-through Cost-Per-Action (CPA) conversions from
|
|
105
|
+
// creatives associated with the line item. This is only supported as
|
|
106
|
+
// secondary goal and the [LineItem.cost_type][] must be
|
|
107
|
+
// [CostTypeEnum.CostType.CPA}.
|
|
108
|
+
VIEW_THROUGH_CPA_CONVERSIONS = 4;
|
|
109
|
+
|
|
110
|
+
// The number of total Cost-Per-Action (CPA) conversions from creatives
|
|
111
|
+
// associated with the line item. This is only supported as secondary goal
|
|
112
|
+
// and the [LineItem.cost_type} must be [CostTypeEnum.CostType.CPA}.
|
|
113
|
+
TOTAL_CPA_CONVERSIONS = 5;
|
|
114
|
+
|
|
115
|
+
// The number of viewable impressions reported by creatives associated with
|
|
116
|
+
// the line item. The
|
|
117
|
+
// [LineItem.line_item_type][google.ads.admanager.v1.LineItem.line_item_type]
|
|
118
|
+
// must be
|
|
119
|
+
// [LineItemTypeEnum.LineItemType.STANDARD][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.STANDARD].
|
|
120
|
+
VIEWABLE_IMPRESSIONS = 6;
|
|
121
|
+
|
|
122
|
+
// The number of in-target impressions reported by third party measurements.
|
|
123
|
+
// The
|
|
124
|
+
// [LineItem.line_item_type][google.ads.admanager.v1.LineItem.line_item_type]
|
|
125
|
+
// must be
|
|
126
|
+
// [LineItemTypeEnum.LineItemType.STANDARD][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.STANDARD].
|
|
127
|
+
IN_TARGET_IMPRESSIONS = 7;
|
|
128
|
+
}
|
|
129
|
+
}
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
// Copyright 2025 Google LLC
|
|
2
|
+
//
|
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
// you may not use this file except in compliance with the License.
|
|
5
|
+
// You may obtain a copy of the License at
|
|
6
|
+
//
|
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
//
|
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
// See the License for the specific language governing permissions and
|
|
13
|
+
// limitations under the License.
|
|
14
|
+
|
|
15
|
+
syntax = "proto3";
|
|
16
|
+
|
|
17
|
+
package google.ads.admanager.v1;
|
|
18
|
+
|
|
19
|
+
option csharp_namespace = "Google.Ads.AdManager.V1";
|
|
20
|
+
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
|
|
21
|
+
option java_multiple_files = true;
|
|
22
|
+
option java_outer_classname = "LineItemEnumsProto";
|
|
23
|
+
option java_package = "com.google.ads.admanager.v1";
|
|
24
|
+
option php_namespace = "Google\\Ads\\AdManager\\V1";
|
|
25
|
+
option ruby_package = "Google::Ads::AdManager::V1";
|
|
26
|
+
|
|
27
|
+
// Wrapper message for
|
|
28
|
+
// [LineItemType][google.ads.admanager.v1.LineItemTypeEnum.LineItemType].
|
|
29
|
+
message LineItemTypeEnum {
|
|
30
|
+
// Indicates the priority of a LineItem, determined by the way in which
|
|
31
|
+
// impressions are reserved to be served for it.
|
|
32
|
+
enum LineItemType {
|
|
33
|
+
// Not specified value.
|
|
34
|
+
LINE_ITEM_TYPE_UNSPECIFIED = 0;
|
|
35
|
+
|
|
36
|
+
// The type of LineItem for which a percentage of all the impressions that
|
|
37
|
+
// are being sold are reserved.
|
|
38
|
+
SPONSORSHIP = 12;
|
|
39
|
+
|
|
40
|
+
// The type of LineItem for which a fixed quantity of impressions or
|
|
41
|
+
// clicks are reserved.
|
|
42
|
+
STANDARD = 13;
|
|
43
|
+
|
|
44
|
+
// The type of LineItem most commonly used to fill a site's unsold
|
|
45
|
+
// inventory if not contractually obligated to deliver a requested number
|
|
46
|
+
// of impressions. Uses daily percentage of unsold impressions or clicks.
|
|
47
|
+
NETWORK = 9;
|
|
48
|
+
|
|
49
|
+
// The type of LineItem for which a fixed quantity of impressions or
|
|
50
|
+
// clicks will be delivered at a priority lower than the STANDARD type.
|
|
51
|
+
BULK = 4;
|
|
52
|
+
|
|
53
|
+
// The type of LineItem most commonly used to fill a site's unsold
|
|
54
|
+
// inventory if not contractually obligated to deliver a requested number
|
|
55
|
+
// of impressions. Uses fixed quantity percentage of unsold impressions or
|
|
56
|
+
// clicks.
|
|
57
|
+
PRICE_PRIORITY = 11;
|
|
58
|
+
|
|
59
|
+
// The type of LineItem typically used for ads that promote products and
|
|
60
|
+
// services chosen by the publisher.
|
|
61
|
+
HOUSE = 7;
|
|
62
|
+
|
|
63
|
+
// The type of LineItem used for ads that track ads being served
|
|
64
|
+
// externally of Ad Manager.
|
|
65
|
+
CLICK_TRACKING = 6;
|
|
66
|
+
|
|
67
|
+
// Targets the LineItem to specific inventory available to AdSense buyers.
|
|
68
|
+
ADSENSE = 2;
|
|
69
|
+
|
|
70
|
+
// Targets the LineItem to specific inventory available to Authorized Buyers
|
|
71
|
+
// and the Open Auction.
|
|
72
|
+
AD_EXCHANGE = 3;
|
|
73
|
+
|
|
74
|
+
// Represents a non-monetizable video LineItem that targets one or more
|
|
75
|
+
// bumper positions, which are short house video messages used by
|
|
76
|
+
// publishers to separate content from ad breaks.
|
|
77
|
+
BUMPER = 5;
|
|
78
|
+
|
|
79
|
+
// The type of LineItem for which there are no impressions reserved, and
|
|
80
|
+
// will serve for a second price bid.
|
|
81
|
+
PREFERRED_DEAL = 10;
|
|
82
|
+
|
|
83
|
+
// The type of LineItem used for configuring audience extension campaigns.
|
|
84
|
+
AUDIENCE_EXTENSION = 14;
|
|
85
|
+
}
|
|
86
|
+
}
|
|
@@ -0,0 +1,93 @@
|
|
|
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/custom_field_value.proto";
|
|
20
|
+
import "google/ads/admanager/v1/goal.proto";
|
|
21
|
+
import "google/ads/admanager/v1/line_item_enums.proto";
|
|
22
|
+
import "google/api/field_behavior.proto";
|
|
23
|
+
import "google/api/resource.proto";
|
|
24
|
+
import "google/protobuf/timestamp.proto";
|
|
25
|
+
import "google/type/money.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 = "LineItemMessagesProto";
|
|
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
|
+
// A LineItem contains information about how specific ad creatives are intended
|
|
36
|
+
// to serve to your website or app along with pricing and other delivery
|
|
37
|
+
// details.
|
|
38
|
+
message LineItem {
|
|
39
|
+
option (google.api.resource) = {
|
|
40
|
+
type: "admanager.googleapis.com/LineItem"
|
|
41
|
+
pattern: "networks/{network_code}/lineItems/{line_item}"
|
|
42
|
+
plural: "lineItems"
|
|
43
|
+
singular: "lineItem"
|
|
44
|
+
};
|
|
45
|
+
|
|
46
|
+
// Identifier. The resource name of the `LineItem`.
|
|
47
|
+
// Format: `networks/{network_code}/lineItems/{line_item_id}`
|
|
48
|
+
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
|
|
49
|
+
|
|
50
|
+
// Output only. The ID of the Order to which the LineItem belongs. This
|
|
51
|
+
// attribute is required. Format: `networks/{network_code}/orders/{order}`
|
|
52
|
+
optional string order = 2 [
|
|
53
|
+
(google.api.field_behavior) = OUTPUT_ONLY,
|
|
54
|
+
(google.api.resource_reference) = { type: "admanager.googleapis.com/Order" }
|
|
55
|
+
];
|
|
56
|
+
|
|
57
|
+
// Required. The name of the line item. This attribute is required and has a
|
|
58
|
+
// maximum length of 255 characters.
|
|
59
|
+
optional string display_name = 3 [(google.api.field_behavior) = REQUIRED];
|
|
60
|
+
|
|
61
|
+
// Required. The date and time on which the LineItem is enabled to begin
|
|
62
|
+
// serving. This attribute is required and must be in the future.
|
|
63
|
+
optional google.protobuf.Timestamp start_time = 6
|
|
64
|
+
[(google.api.field_behavior) = REQUIRED];
|
|
65
|
+
|
|
66
|
+
// Output only. The timestamp when the LineItem will stop serving. This
|
|
67
|
+
// attribute is read-only and includes auto extension days.
|
|
68
|
+
optional google.protobuf.Timestamp end_time = 7
|
|
69
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
70
|
+
|
|
71
|
+
// Required. Indicates the line item type of a LineItem. This attribute is
|
|
72
|
+
// required. The line item type determines the default priority of the line
|
|
73
|
+
// item. More information can be found at
|
|
74
|
+
// https://support.google.com/admanager/answer/177279.
|
|
75
|
+
optional LineItemTypeEnum.LineItemType line_item_type = 17
|
|
76
|
+
[(google.api.field_behavior) = REQUIRED];
|
|
77
|
+
|
|
78
|
+
// Required. The amount of money to spend per impression or click.
|
|
79
|
+
optional google.type.Money rate = 20 [(google.api.field_behavior) = REQUIRED];
|
|
80
|
+
|
|
81
|
+
// Output only. The amount of money allocated to the LineItem. This attribute
|
|
82
|
+
// is readonly and is populated by Google. The currency code is readonly.
|
|
83
|
+
optional google.type.Money budget = 35
|
|
84
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
85
|
+
|
|
86
|
+
// Optional. The values of the custom fields associated with this line item.
|
|
87
|
+
repeated CustomFieldValue custom_field_values = 59
|
|
88
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
89
|
+
|
|
90
|
+
// Optional. The primary goal that this LineItem is associated with, which is
|
|
91
|
+
// used in its pacing and budgeting.
|
|
92
|
+
optional Goal goal = 76 [(google.api.field_behavior) = OPTIONAL];
|
|
93
|
+
}
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
// Copyright 2025 Google LLC
|
|
2
|
+
//
|
|
3
|
+
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
// you may not use this file except in compliance with the License.
|
|
5
|
+
// You may obtain a copy of the License at
|
|
6
|
+
//
|
|
7
|
+
// http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
//
|
|
9
|
+
// Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
// See the License for the specific language governing permissions and
|
|
13
|
+
// limitations under the License.
|
|
14
|
+
|
|
15
|
+
syntax = "proto3";
|
|
16
|
+
|
|
17
|
+
package google.ads.admanager.v1;
|
|
18
|
+
|
|
19
|
+
import "google/ads/admanager/v1/line_item_messages.proto";
|
|
20
|
+
import "google/api/annotations.proto";
|
|
21
|
+
import "google/api/client.proto";
|
|
22
|
+
import "google/api/field_behavior.proto";
|
|
23
|
+
import "google/api/resource.proto";
|
|
24
|
+
|
|
25
|
+
option csharp_namespace = "Google.Ads.AdManager.V1";
|
|
26
|
+
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
|
|
27
|
+
option java_multiple_files = true;
|
|
28
|
+
option java_outer_classname = "LineItemServiceProto";
|
|
29
|
+
option java_package = "com.google.ads.admanager.v1";
|
|
30
|
+
option php_namespace = "Google\\Ads\\AdManager\\V1";
|
|
31
|
+
option ruby_package = "Google::Ads::AdManager::V1";
|
|
32
|
+
|
|
33
|
+
// Provides methods for handling `LineItem` objects.
|
|
34
|
+
service LineItemService {
|
|
35
|
+
option (google.api.default_host) = "admanager.googleapis.com";
|
|
36
|
+
option (google.api.oauth_scopes) =
|
|
37
|
+
"https://www.googleapis.com/auth/admanager";
|
|
38
|
+
|
|
39
|
+
// API to retrieve a `LineItem` object.
|
|
40
|
+
rpc GetLineItem(GetLineItemRequest) returns (LineItem) {
|
|
41
|
+
option (google.api.http) = {
|
|
42
|
+
get: "/v1/{name=networks/*/lineItems/*}"
|
|
43
|
+
};
|
|
44
|
+
option (google.api.method_signature) = "name";
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
// API to retrieve a list of `LineItem` objects.
|
|
48
|
+
rpc ListLineItems(ListLineItemsRequest) returns (ListLineItemsResponse) {
|
|
49
|
+
option (google.api.http) = {
|
|
50
|
+
get: "/v1/{parent=networks/*}/lineItems"
|
|
51
|
+
};
|
|
52
|
+
option (google.api.method_signature) = "parent";
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
// Request object for `GetLineItem` method.
|
|
57
|
+
message GetLineItemRequest {
|
|
58
|
+
// Required. The resource name of the LineItem.
|
|
59
|
+
// Format: `networks/{network_code}/lineItems/{line_item_id}`
|
|
60
|
+
string name = 1 [
|
|
61
|
+
(google.api.field_behavior) = REQUIRED,
|
|
62
|
+
(google.api.resource_reference) = {
|
|
63
|
+
type: "admanager.googleapis.com/LineItem"
|
|
64
|
+
}
|
|
65
|
+
];
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
// Request object for `ListLineItems` method.
|
|
69
|
+
message ListLineItemsRequest {
|
|
70
|
+
// Required. The parent, which owns this collection of LineItems.
|
|
71
|
+
// Format: `networks/{network_code}`
|
|
72
|
+
string parent = 1 [
|
|
73
|
+
(google.api.field_behavior) = REQUIRED,
|
|
74
|
+
(google.api.resource_reference) = {
|
|
75
|
+
type: "admanager.googleapis.com/Network"
|
|
76
|
+
}
|
|
77
|
+
];
|
|
78
|
+
|
|
79
|
+
// Optional. The maximum number of `LineItems` to return. The service may
|
|
80
|
+
// return fewer than this value. If unspecified, at most 50 `LineItems` will
|
|
81
|
+
// be returned. The maximum value is 1000; values greater than 1000 will be
|
|
82
|
+
// coerced to 1000.
|
|
83
|
+
int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
|
|
84
|
+
|
|
85
|
+
// Optional. A page token, received from a previous `ListLineItems` call.
|
|
86
|
+
// Provide this to retrieve the subsequent page.
|
|
87
|
+
//
|
|
88
|
+
// When paginating, all other parameters provided to `ListLineItems` must
|
|
89
|
+
// match the call that provided the page token.
|
|
90
|
+
string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
|
|
91
|
+
|
|
92
|
+
// Optional. Expression to filter the response.
|
|
93
|
+
// See syntax details at
|
|
94
|
+
// https://developers.google.com/ad-manager/api/beta/filters
|
|
95
|
+
string filter = 4 [(google.api.field_behavior) = OPTIONAL];
|
|
96
|
+
|
|
97
|
+
// Optional. Expression to specify sorting order.
|
|
98
|
+
// See syntax details at
|
|
99
|
+
// https://developers.google.com/ad-manager/api/beta/filters#order
|
|
100
|
+
string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
|
|
101
|
+
|
|
102
|
+
// Optional. Number of individual resources to skip while paginating.
|
|
103
|
+
int32 skip = 6 [(google.api.field_behavior) = OPTIONAL];
|
|
104
|
+
}
|
|
105
|
+
|
|
106
|
+
// Response object for `ListLineItemsRequest` containing matching `LineItem`
|
|
107
|
+
// objects.
|
|
108
|
+
message ListLineItemsResponse {
|
|
109
|
+
// The `LineItem` objects from the specified network.
|
|
110
|
+
repeated LineItem line_items = 1;
|
|
111
|
+
|
|
112
|
+
// A token, which can be sent as `page_token` to retrieve the next page.
|
|
113
|
+
// If this field is omitted, there are no subsequent pages.
|
|
114
|
+
string next_page_token = 2;
|
|
115
|
+
|
|
116
|
+
// Total number of `LineItem` objects.
|
|
117
|
+
// If a filter was included in the request, this reflects the total number
|
|
118
|
+
// after the filtering is applied.
|
|
119
|
+
//
|
|
120
|
+
// `total_size` won't be calculated in the response unless it has been
|
|
121
|
+
// included in a response field mask. The response field mask can be provided
|
|
122
|
+
// to the method by using the URL parameter `$fields` or `fields`, or by using
|
|
123
|
+
// the HTTP/gRPC header `X-Goog-FieldMask`.
|
|
124
|
+
//
|
|
125
|
+
// For more information, see
|
|
126
|
+
// https://developers.google.com/ad-manager/api/beta/field-masks
|
|
127
|
+
int32 total_size = 3;
|
|
128
|
+
}
|
|
@@ -41,20 +41,20 @@ message Network {
|
|
|
41
41
|
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
|
|
42
42
|
|
|
43
43
|
// Optional. Display name for Network.
|
|
44
|
-
string display_name = 2 [(google.api.field_behavior) = OPTIONAL];
|
|
44
|
+
optional string display_name = 2 [(google.api.field_behavior) = OPTIONAL];
|
|
45
45
|
|
|
46
46
|
// Output only. Network Code.
|
|
47
|
-
string network_code = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
47
|
+
optional string network_code = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
48
48
|
|
|
49
49
|
// Output only. Property code.
|
|
50
|
-
string property_code = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
50
|
+
optional string property_code = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
51
51
|
|
|
52
52
|
// Output only. Time zone associated with the delivery of orders and
|
|
53
53
|
// reporting.
|
|
54
|
-
string time_zone = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
54
|
+
optional string time_zone = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
55
55
|
|
|
56
56
|
// Output only. Primary currency code, in ISO-4217 format.
|
|
57
|
-
string currency_code = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
57
|
+
optional string currency_code = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
58
58
|
|
|
59
59
|
// Optional. Currency codes that can be used as an alternative to the primary
|
|
60
60
|
// currency code for trafficking Line Items.
|
|
@@ -64,7 +64,7 @@ message Network {
|
|
|
64
64
|
// Output only. Top most [Ad Unit](google.ads.admanager.v1.AdUnit) to which
|
|
65
65
|
// descendant Ad Units can be added.
|
|
66
66
|
// Format: networks/{network_code}/adUnits/{ad_unit}
|
|
67
|
-
string effective_root_ad_unit = 8 [
|
|
67
|
+
optional string effective_root_ad_unit = 8 [
|
|
68
68
|
(google.api.field_behavior) = OUTPUT_ONLY,
|
|
69
69
|
(google.api.resource_reference) = {
|
|
70
70
|
type: "admanager.googleapis.com/AdUnit"
|
|
@@ -72,8 +72,8 @@ message Network {
|
|
|
72
72
|
];
|
|
73
73
|
|
|
74
74
|
// Output only. Whether this is a test network.
|
|
75
|
-
bool test_network = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
75
|
+
optional bool test_network = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
76
76
|
|
|
77
77
|
// Output only. Network ID.
|
|
78
|
-
int64 network_id = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
78
|
+
optional int64 network_id = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
79
79
|
}
|
|
@@ -65,10 +65,41 @@ message GetNetworkRequest {
|
|
|
65
65
|
}
|
|
66
66
|
|
|
67
67
|
// Request object for `ListNetworks` method.
|
|
68
|
-
message ListNetworksRequest {
|
|
68
|
+
message ListNetworksRequest {
|
|
69
|
+
// Optional. The maximum number of `Network`s to return. The service may
|
|
70
|
+
// return fewer than this value. If unspecified, at most 50 `Network`s will be
|
|
71
|
+
// returned. The maximum value is 1000; values greater than 1000 will be
|
|
72
|
+
// coerced to 1000.
|
|
73
|
+
int32 page_size = 3 [(google.api.field_behavior) = OPTIONAL];
|
|
74
|
+
|
|
75
|
+
// Optional. A page token, received from a previous `ListNetworks` call.
|
|
76
|
+
// Provide this to retrieve the subsequent page.
|
|
77
|
+
//
|
|
78
|
+
// When paginating, all other parameters provided to `ListNetworks` must match
|
|
79
|
+
// the call that provided the page token.
|
|
80
|
+
string page_token = 4 [(google.api.field_behavior) = OPTIONAL];
|
|
81
|
+
|
|
82
|
+
// Optional. Number of individual resources to skip while paginating.
|
|
83
|
+
int32 skip = 5 [(google.api.field_behavior) = OPTIONAL];
|
|
84
|
+
}
|
|
69
85
|
|
|
70
86
|
// Response object for `ListNetworks` method.
|
|
71
87
|
message ListNetworksResponse {
|
|
72
88
|
// The `Network`s a user has access to.
|
|
73
89
|
repeated Network networks = 1;
|
|
90
|
+
|
|
91
|
+
// A token, which can be sent as `page_token` to retrieve the next page.
|
|
92
|
+
// If this field is omitted, there are no subsequent pages.
|
|
93
|
+
string next_page_token = 2;
|
|
94
|
+
|
|
95
|
+
// Total number of `Network`s.
|
|
96
|
+
//
|
|
97
|
+
// `total_size` won't be calculated in the response unless it has been
|
|
98
|
+
// included in a response field mask. The response field mask can be provided
|
|
99
|
+
// to the method by using the URL parameter `$fields` or `fields`, or by using
|
|
100
|
+
// the HTTP/gRPC header `X-Goog-FieldMask`.
|
|
101
|
+
//
|
|
102
|
+
// For more information, see
|
|
103
|
+
// https://developers.google.com/ad-manager/api/beta/field-masks
|
|
104
|
+
int32 total_size = 3;
|
|
74
105
|
}
|
|
@@ -61,10 +61,12 @@ message Order {
|
|
|
61
61
|
(google.api.resource_reference) = { type: "admanager.googleapis.com/User" }
|
|
62
62
|
];
|
|
63
63
|
|
|
64
|
-
// Optional. The resource names of Contacts from the
|
|
65
|
-
// Format:
|
|
64
|
+
// Optional. Unordered list. The resource names of Contacts from the
|
|
65
|
+
// advertiser of this Order. Format:
|
|
66
|
+
// "networks/{network_code}/contacts/{contact_id}"
|
|
66
67
|
repeated string advertiser_contacts = 5 [
|
|
67
68
|
(google.api.field_behavior) = OPTIONAL,
|
|
69
|
+
(google.api.field_behavior) = UNORDERED_LIST,
|
|
68
70
|
(google.api.resource_reference) = {
|
|
69
71
|
type: "admanager.googleapis.com/Contact"
|
|
70
72
|
}
|