@google-ads/admanager 0.1.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/CHANGELOG.md +10 -0
- package/LICENSE +202 -0
- package/README.md +236 -0
- package/build/protos/google/ads/admanager/v1/ad_unit_enums.proto +81 -0
- package/build/protos/google/ads/admanager/v1/ad_unit_messages.proto +230 -0
- package/build/protos/google/ads/admanager/v1/ad_unit_service.proto +195 -0
- package/build/protos/google/ads/admanager/v1/admanager_error.proto +52 -0
- package/build/protos/google/ads/admanager/v1/applied_label.proto +41 -0
- package/build/protos/google/ads/admanager/v1/company_credit_status_enum.proto +97 -0
- package/build/protos/google/ads/admanager/v1/company_messages.proto +122 -0
- package/build/protos/google/ads/admanager/v1/company_service.proto +126 -0
- package/build/protos/google/ads/admanager/v1/company_type_enum.proto +51 -0
- package/build/protos/google/ads/admanager/v1/contact_messages.proto +49 -0
- package/build/protos/google/ads/admanager/v1/custom_field_enums.proto +110 -0
- package/build/protos/google/ads/admanager/v1/custom_field_messages.proto +87 -0
- package/build/protos/google/ads/admanager/v1/custom_field_service.proto +127 -0
- package/build/protos/google/ads/admanager/v1/custom_field_value.proto +62 -0
- package/build/protos/google/ads/admanager/v1/custom_targeting_key_enums.proto +76 -0
- package/build/protos/google/ads/admanager/v1/custom_targeting_key_messages.proto +69 -0
- package/build/protos/google/ads/admanager/v1/custom_targeting_key_service.proto +129 -0
- package/build/protos/google/ads/admanager/v1/custom_targeting_value_enums.proto +90 -0
- package/build/protos/google/ads/admanager/v1/custom_targeting_value_messages.proto +66 -0
- package/build/protos/google/ads/admanager/v1/custom_targeting_value_service.proto +132 -0
- package/build/protos/google/ads/admanager/v1/entity_signals_mapping_messages.proto +64 -0
- package/build/protos/google/ads/admanager/v1/entity_signals_mapping_service.proto +252 -0
- package/build/protos/google/ads/admanager/v1/environment_type_enum.proto +41 -0
- package/build/protos/google/ads/admanager/v1/frequency_cap.proto +39 -0
- package/build/protos/google/ads/admanager/v1/label_messages.proto +42 -0
- package/build/protos/google/ads/admanager/v1/network_messages.proto +79 -0
- package/build/protos/google/ads/admanager/v1/network_service.proto +72 -0
- package/build/protos/google/ads/admanager/v1/order_enums.proto +59 -0
- package/build/protos/google/ads/admanager/v1/order_messages.proto +209 -0
- package/build/protos/google/ads/admanager/v1/order_service.proto +129 -0
- package/build/protos/google/ads/admanager/v1/placement_enums.proto +44 -0
- package/build/protos/google/ads/admanager/v1/placement_messages.proto +77 -0
- package/build/protos/google/ads/admanager/v1/placement_service.proto +126 -0
- package/build/protos/google/ads/admanager/v1/report_service.proto +3526 -0
- package/build/protos/google/ads/admanager/v1/role_enums.proto +41 -0
- package/build/protos/google/ads/admanager/v1/role_messages.proto +59 -0
- package/build/protos/google/ads/admanager/v1/role_service.proto +122 -0
- package/build/protos/google/ads/admanager/v1/size.proto +47 -0
- package/build/protos/google/ads/admanager/v1/size_type_enum.proto +62 -0
- package/build/protos/google/ads/admanager/v1/taxonomy_category_messages.proto +70 -0
- package/build/protos/google/ads/admanager/v1/taxonomy_category_service.proto +128 -0
- package/build/protos/google/ads/admanager/v1/taxonomy_type_enum.proto +51 -0
- package/build/protos/google/ads/admanager/v1/team_messages.proto +46 -0
- package/build/protos/google/ads/admanager/v1/time_unit_enum.proto +59 -0
- package/build/protos/google/ads/admanager/v1/user_messages.proto +78 -0
- package/build/protos/google/ads/admanager/v1/user_service.proto +57 -0
- package/build/protos/protos.d.ts +23491 -0
- package/build/protos/protos.js +69798 -0
- package/build/protos/protos.json +7273 -0
- package/build/src/index.d.ts +47 -0
- package/build/src/index.js +67 -0
- package/build/src/index.js.map +1 -0
- package/build/src/v1/ad_unit_service_client.d.ts +794 -0
- package/build/src/v1/ad_unit_service_client.js +1136 -0
- package/build/src/v1/ad_unit_service_client.js.map +1 -0
- package/build/src/v1/ad_unit_service_client_config.json +38 -0
- package/build/src/v1/company_service_client.d.ts +663 -0
- package/build/src/v1/company_service_client.js +999 -0
- package/build/src/v1/company_service_client.js.map +1 -0
- package/build/src/v1/company_service_client_config.json +34 -0
- package/build/src/v1/custom_field_service_client.d.ts +663 -0
- package/build/src/v1/custom_field_service_client.js +1002 -0
- package/build/src/v1/custom_field_service_client.js.map +1 -0
- package/build/src/v1/custom_field_service_client_config.json +34 -0
- package/build/src/v1/custom_targeting_key_service_client.d.ts +664 -0
- package/build/src/v1/custom_targeting_key_service_client.js +1004 -0
- package/build/src/v1/custom_targeting_key_service_client.js.map +1 -0
- package/build/src/v1/custom_targeting_key_service_client_config.json +34 -0
- package/build/src/v1/custom_targeting_value_service_client.d.ts +673 -0
- package/build/src/v1/custom_targeting_value_service_client.js +1010 -0
- package/build/src/v1/custom_targeting_value_service_client.js.map +1 -0
- package/build/src/v1/custom_targeting_value_service_client_config.json +34 -0
- package/build/src/v1/entity_signals_mapping_service_client.d.ts +782 -0
- package/build/src/v1/entity_signals_mapping_service_client.js +1096 -0
- package/build/src/v1/entity_signals_mapping_service_client.js.map +1 -0
- package/build/src/v1/entity_signals_mapping_service_client_config.json +50 -0
- package/build/src/v1/index.d.ts +13 -0
- package/build/src/v1/index.js +47 -0
- package/build/src/v1/index.js.map +1 -0
- package/build/src/v1/network_service_client.d.ts +552 -0
- package/build/src/v1/network_service_client.js +877 -0
- package/build/src/v1/network_service_client.js.map +1 -0
- package/build/src/v1/network_service_client_config.json +34 -0
- package/build/src/v1/order_service_client.d.ts +668 -0
- package/build/src/v1/order_service_client.js +999 -0
- package/build/src/v1/order_service_client.js.map +1 -0
- package/build/src/v1/order_service_client_config.json +48 -0
- package/build/src/v1/placement_service_client.d.ts +663 -0
- package/build/src/v1/placement_service_client.js +999 -0
- package/build/src/v1/placement_service_client.js.map +1 -0
- package/build/src/v1/placement_service_client_config.json +34 -0
- package/build/src/v1/report_service_client.d.ts +975 -0
- package/build/src/v1/report_service_client.js +1352 -0
- package/build/src/v1/report_service_client.js.map +1 -0
- package/build/src/v1/report_service_client_config.json +50 -0
- package/build/src/v1/role_service_client.d.ts +660 -0
- package/build/src/v1/role_service_client.js +997 -0
- package/build/src/v1/role_service_client.js.map +1 -0
- package/build/src/v1/role_service_client_config.json +34 -0
- package/build/src/v1/taxonomy_category_service_client.d.ts +663 -0
- package/build/src/v1/taxonomy_category_service_client.js +1003 -0
- package/build/src/v1/taxonomy_category_service_client.js.map +1 -0
- package/build/src/v1/taxonomy_category_service_client_config.json +34 -0
- package/build/src/v1/user_service_client.d.ts +534 -0
- package/build/src/v1/user_service_client.js +861 -0
- package/build/src/v1/user_service_client.js.map +1 -0
- package/build/src/v1/user_service_client_config.json +30 -0
- package/package.json +70 -0
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
// Copyright 2024 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/api/field_behavior.proto";
|
|
20
|
+
import "google/api/resource.proto";
|
|
21
|
+
|
|
22
|
+
option csharp_namespace = "Google.Ads.AdManager.V1";
|
|
23
|
+
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
|
|
24
|
+
option java_multiple_files = true;
|
|
25
|
+
option java_outer_classname = "EntitySignalsMappingMessagesProto";
|
|
26
|
+
option java_package = "com.google.ads.admanager.v1";
|
|
27
|
+
option php_namespace = "Google\\Ads\\AdManager\\V1";
|
|
28
|
+
option ruby_package = "Google::Ads::AdManager::V1";
|
|
29
|
+
|
|
30
|
+
// The `EntitySignalsMapping` resource.
|
|
31
|
+
message EntitySignalsMapping {
|
|
32
|
+
option (google.api.resource) = {
|
|
33
|
+
type: "admanager.googleapis.com/EntitySignalsMapping"
|
|
34
|
+
pattern: "networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}"
|
|
35
|
+
plural: "entitySignalsMappings"
|
|
36
|
+
singular: "entitySignalsMapping"
|
|
37
|
+
};
|
|
38
|
+
|
|
39
|
+
// The entity that the mapping belongs to.
|
|
40
|
+
oneof entity {
|
|
41
|
+
// ID of an AudienceSegment that this mapping belongs to.
|
|
42
|
+
int64 audience_segment_id = 3;
|
|
43
|
+
|
|
44
|
+
// ID of a ContentBundle that this mapping belongs to.
|
|
45
|
+
int64 content_bundle_id = 4;
|
|
46
|
+
|
|
47
|
+
// ID of a CustomValue that this mapping belongs to.
|
|
48
|
+
int64 custom_targeting_value_id = 5;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
// Identifier. The resource name of the `EntitySignalsMapping`.
|
|
52
|
+
// Format:
|
|
53
|
+
// `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}`
|
|
54
|
+
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
|
|
55
|
+
|
|
56
|
+
// Output only. `EntitySignalsMapping` ID.
|
|
57
|
+
int64 entity_signals_mapping_id = 2
|
|
58
|
+
[(google.api.field_behavior) = OUTPUT_ONLY];
|
|
59
|
+
|
|
60
|
+
// Required. The IDs of the categories that are associated with the
|
|
61
|
+
// referencing entity.
|
|
62
|
+
repeated int64 taxonomy_category_ids = 6
|
|
63
|
+
[(google.api.field_behavior) = REQUIRED];
|
|
64
|
+
}
|
|
@@ -0,0 +1,252 @@
|
|
|
1
|
+
// Copyright 2024 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/entity_signals_mapping_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/field_mask.proto";
|
|
25
|
+
|
|
26
|
+
option csharp_namespace = "Google.Ads.AdManager.V1";
|
|
27
|
+
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
|
|
28
|
+
option java_multiple_files = true;
|
|
29
|
+
option java_outer_classname = "EntitySignalsMappingServiceProto";
|
|
30
|
+
option java_package = "com.google.ads.admanager.v1";
|
|
31
|
+
option php_namespace = "Google\\Ads\\AdManager\\V1";
|
|
32
|
+
option ruby_package = "Google::Ads::AdManager::V1";
|
|
33
|
+
|
|
34
|
+
// Provides methods for handling `EntitySignalsMapping` objects.
|
|
35
|
+
service EntitySignalsMappingService {
|
|
36
|
+
option (google.api.default_host) = "admanager.googleapis.com";
|
|
37
|
+
|
|
38
|
+
// API to retrieve a `EntitySignalsMapping` object.
|
|
39
|
+
rpc GetEntitySignalsMapping(GetEntitySignalsMappingRequest)
|
|
40
|
+
returns (EntitySignalsMapping) {
|
|
41
|
+
option (google.api.http) = {
|
|
42
|
+
get: "/v1/{name=networks/*/entitySignalsMappings/*}"
|
|
43
|
+
};
|
|
44
|
+
option (google.api.method_signature) = "name";
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
// API to retrieve a list of `EntitySignalsMapping` objects.
|
|
48
|
+
rpc ListEntitySignalsMappings(ListEntitySignalsMappingsRequest)
|
|
49
|
+
returns (ListEntitySignalsMappingsResponse) {
|
|
50
|
+
option (google.api.http) = {
|
|
51
|
+
get: "/v1/{parent=networks/*}/entitySignalsMappings"
|
|
52
|
+
};
|
|
53
|
+
option (google.api.method_signature) = "parent";
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
// API to create an `EntitySignalsMapping` object.
|
|
57
|
+
rpc CreateEntitySignalsMapping(CreateEntitySignalsMappingRequest)
|
|
58
|
+
returns (EntitySignalsMapping) {
|
|
59
|
+
option (google.api.http) = {
|
|
60
|
+
post: "/v1/{parent=networks/*}/entitySignalsMappings"
|
|
61
|
+
body: "entity_signals_mapping"
|
|
62
|
+
};
|
|
63
|
+
option (google.api.method_signature) = "parent,entity_signals_mapping";
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
// API to update an `EntitySignalsMapping` object.
|
|
67
|
+
rpc UpdateEntitySignalsMapping(UpdateEntitySignalsMappingRequest)
|
|
68
|
+
returns (EntitySignalsMapping) {
|
|
69
|
+
option (google.api.http) = {
|
|
70
|
+
patch: "/v1/{entity_signals_mapping.name=networks/*/entitySignalsMappings/*}"
|
|
71
|
+
body: "entity_signals_mapping"
|
|
72
|
+
};
|
|
73
|
+
option (google.api.method_signature) = "entity_signals_mapping,update_mask";
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
// API to batch create `EntitySignalsMapping` objects.
|
|
77
|
+
rpc BatchCreateEntitySignalsMappings(BatchCreateEntitySignalsMappingsRequest)
|
|
78
|
+
returns (BatchCreateEntitySignalsMappingsResponse) {
|
|
79
|
+
option (google.api.http) = {
|
|
80
|
+
post: "/v1/{parent=networks/*}/entitySignalsMappings:batchCreate"
|
|
81
|
+
body: "*"
|
|
82
|
+
};
|
|
83
|
+
option (google.api.method_signature) = "parent,requests";
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
// API to batch update `EntitySignalsMapping` objects.
|
|
87
|
+
rpc BatchUpdateEntitySignalsMappings(BatchUpdateEntitySignalsMappingsRequest)
|
|
88
|
+
returns (BatchUpdateEntitySignalsMappingsResponse) {
|
|
89
|
+
option (google.api.http) = {
|
|
90
|
+
post: "/v1/{parent=networks/*}/entitySignalsMappings:batchUpdate"
|
|
91
|
+
body: "*"
|
|
92
|
+
};
|
|
93
|
+
option (google.api.method_signature) = "parent,requests";
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
// Request object for `GetEntitySignalsMapping` method.
|
|
98
|
+
message GetEntitySignalsMappingRequest {
|
|
99
|
+
// Required. The resource name of the EntitySignalsMapping.
|
|
100
|
+
// Format:
|
|
101
|
+
// `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping_id}`
|
|
102
|
+
string name = 1 [
|
|
103
|
+
(google.api.field_behavior) = REQUIRED,
|
|
104
|
+
(google.api.resource_reference) = {
|
|
105
|
+
type: "admanager.googleapis.com/EntitySignalsMapping"
|
|
106
|
+
}
|
|
107
|
+
];
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
// Request object for `ListEntitySignalsMappings` method.
|
|
111
|
+
message ListEntitySignalsMappingsRequest {
|
|
112
|
+
// Required. The parent, which owns this collection of EntitySignalsMappings.
|
|
113
|
+
// Format: `networks/{network_code}`
|
|
114
|
+
string parent = 1 [
|
|
115
|
+
(google.api.field_behavior) = REQUIRED,
|
|
116
|
+
(google.api.resource_reference) = {
|
|
117
|
+
type: "admanager.googleapis.com/Network"
|
|
118
|
+
}
|
|
119
|
+
];
|
|
120
|
+
|
|
121
|
+
// Optional. The maximum number of `EntitySignalsMappings` to return. The
|
|
122
|
+
// service may return fewer than this value. If unspecified, at most 50
|
|
123
|
+
// `EntitySignalsMappings` will be returned. The maximum value is 1000; values
|
|
124
|
+
// above 1000 will be coerced to 1000.
|
|
125
|
+
int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
|
|
126
|
+
|
|
127
|
+
// Optional. A page token, received from a previous
|
|
128
|
+
// `ListEntitySignalsMappings` call. Provide this to retrieve the subsequent
|
|
129
|
+
// page.
|
|
130
|
+
//
|
|
131
|
+
// When paginating, all other parameters provided to
|
|
132
|
+
// `ListEntitySignalsMappings` must match the call that provided the page
|
|
133
|
+
// token.
|
|
134
|
+
string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
|
|
135
|
+
|
|
136
|
+
// Optional. Expression to filter the response.
|
|
137
|
+
// See syntax details at
|
|
138
|
+
// https://developers.google.com/ad-manager/api/beta/filters
|
|
139
|
+
string filter = 4 [(google.api.field_behavior) = OPTIONAL];
|
|
140
|
+
|
|
141
|
+
// Optional. Expression to specify sorting order.
|
|
142
|
+
// See syntax details at
|
|
143
|
+
// https://developers.google.com/ad-manager/api/beta/filters#order
|
|
144
|
+
string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
|
|
145
|
+
|
|
146
|
+
// Optional. Number of individual resources to skip while paginating.
|
|
147
|
+
int32 skip = 6 [(google.api.field_behavior) = OPTIONAL];
|
|
148
|
+
}
|
|
149
|
+
|
|
150
|
+
// Request object for 'CreateEntitySignalsMapping' method.
|
|
151
|
+
message CreateEntitySignalsMappingRequest {
|
|
152
|
+
// Required. The parent resource where this EntitySignalsMapping will be
|
|
153
|
+
// created. Format: `networks/{network_code}`
|
|
154
|
+
string parent = 1 [
|
|
155
|
+
(google.api.field_behavior) = REQUIRED,
|
|
156
|
+
(google.api.resource_reference) = {
|
|
157
|
+
child_type: "admanager.googleapis.com/EntitySignalsMapping"
|
|
158
|
+
}
|
|
159
|
+
];
|
|
160
|
+
|
|
161
|
+
// Required. The EntitySignalsMapping object to create.
|
|
162
|
+
EntitySignalsMapping entity_signals_mapping = 2
|
|
163
|
+
[(google.api.field_behavior) = REQUIRED];
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
// Request object for 'UpdateEntitySignalsMapping' method.
|
|
167
|
+
message UpdateEntitySignalsMappingRequest {
|
|
168
|
+
// Required. The `EntitySignalsMapping` to update.
|
|
169
|
+
//
|
|
170
|
+
// The EntitySignalsMapping's name is used to identify the
|
|
171
|
+
// EntitySignalsMapping to update.
|
|
172
|
+
// Format:
|
|
173
|
+
// `networks/{network_code}/entitySignalsMappings/{entity_signals_mapping}`
|
|
174
|
+
EntitySignalsMapping entity_signals_mapping = 1
|
|
175
|
+
[(google.api.field_behavior) = REQUIRED];
|
|
176
|
+
|
|
177
|
+
// Required. The list of fields to update.
|
|
178
|
+
google.protobuf.FieldMask update_mask = 2
|
|
179
|
+
[(google.api.field_behavior) = REQUIRED];
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
// Response object for `ListEntitySignalsMappingsRequest` containing matching
|
|
183
|
+
// `EntitySignalsMapping` resources.
|
|
184
|
+
message ListEntitySignalsMappingsResponse {
|
|
185
|
+
// The `EntitySignalsMapping` from the specified network.
|
|
186
|
+
repeated EntitySignalsMapping entity_signals_mappings = 1;
|
|
187
|
+
|
|
188
|
+
// A token, which can be sent as `page_token` to retrieve the next page.
|
|
189
|
+
// If this field is omitted, there are no subsequent pages.
|
|
190
|
+
string next_page_token = 2;
|
|
191
|
+
|
|
192
|
+
// Total number of `EntitySignalsMappings`.
|
|
193
|
+
// If a filter was included in the request, this reflects the total number
|
|
194
|
+
// after the filtering is applied.
|
|
195
|
+
//
|
|
196
|
+
// `total_size` will not be calculated in the response unless it has been
|
|
197
|
+
// included in a response field mask. The response field mask can be provided
|
|
198
|
+
// to the method by using the URL parameter `$fields` or `fields`, or by using
|
|
199
|
+
// the HTTP/gRPC header `X-Goog-FieldMask`.
|
|
200
|
+
//
|
|
201
|
+
// For more information, see
|
|
202
|
+
// https://developers.google.com/ad-manager/api/beta/field-masks
|
|
203
|
+
int32 total_size = 3;
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
// Request object for `BatchCreateEntitySignalsMappings` method.
|
|
207
|
+
message BatchCreateEntitySignalsMappingsRequest {
|
|
208
|
+
// Required. The parent resource where `EntitySignalsMappings` will be
|
|
209
|
+
// created. Format: `networks/{network_code}` The parent field in the
|
|
210
|
+
// CreateEntitySignalsMappingRequest must match this field.
|
|
211
|
+
string parent = 1 [
|
|
212
|
+
(google.api.field_behavior) = REQUIRED,
|
|
213
|
+
(google.api.resource_reference) = {
|
|
214
|
+
child_type: "admanager.googleapis.com/EntitySignalsMapping"
|
|
215
|
+
}
|
|
216
|
+
];
|
|
217
|
+
|
|
218
|
+
// Required. The `EntitySignalsMapping` objects to create.
|
|
219
|
+
// A maximum of 100 objects can be created in a batch.
|
|
220
|
+
repeated CreateEntitySignalsMappingRequest requests = 2
|
|
221
|
+
[(google.api.field_behavior) = REQUIRED];
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
// Response object for `BatchCreateEntitySignalsMappings` method.
|
|
225
|
+
message BatchCreateEntitySignalsMappingsResponse {
|
|
226
|
+
// The `EntitySignalsMapping` objects created.
|
|
227
|
+
repeated EntitySignalsMapping entity_signals_mappings = 1;
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
// Request object for `BatchUpdateEntitySignalsMappings` method.
|
|
231
|
+
message BatchUpdateEntitySignalsMappingsRequest {
|
|
232
|
+
// Required. The parent resource where `EntitySignalsMappings` will be
|
|
233
|
+
// updated. Format: `networks/{network_code}` The parent field in the
|
|
234
|
+
// UpdateEntitySignalsMappingRequest must match this field.
|
|
235
|
+
string parent = 1 [
|
|
236
|
+
(google.api.field_behavior) = REQUIRED,
|
|
237
|
+
(google.api.resource_reference) = {
|
|
238
|
+
child_type: "admanager.googleapis.com/EntitySignalsMapping"
|
|
239
|
+
}
|
|
240
|
+
];
|
|
241
|
+
|
|
242
|
+
// Required. The `EntitySignalsMapping` objects to update.
|
|
243
|
+
// A maximum of 100 objects can be updated in a batch.
|
|
244
|
+
repeated UpdateEntitySignalsMappingRequest requests = 2
|
|
245
|
+
[(google.api.field_behavior) = REQUIRED];
|
|
246
|
+
}
|
|
247
|
+
|
|
248
|
+
// Response object for `BatchUpdateEntitySignalsMappings` method.
|
|
249
|
+
message BatchUpdateEntitySignalsMappingsResponse {
|
|
250
|
+
// The `EntitySignalsMapping` objects updated.
|
|
251
|
+
repeated EntitySignalsMapping entity_signals_mappings = 1;
|
|
252
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
// Copyright 2024 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 = "EnvironmentTypeEnumProto";
|
|
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
|
+
// [EnvironmentType][google.ads.admanager.v1.EnvironmentTypeEnum.EnvironmentType].
|
|
29
|
+
message EnvironmentTypeEnum {
|
|
30
|
+
// The different environments in which an ad can be shown.
|
|
31
|
+
enum EnvironmentType {
|
|
32
|
+
// No value specified
|
|
33
|
+
ENVIRONMENT_TYPE_UNSPECIFIED = 0;
|
|
34
|
+
|
|
35
|
+
// A regular web browser.
|
|
36
|
+
BROWSER = 1;
|
|
37
|
+
|
|
38
|
+
// Video players.
|
|
39
|
+
VIDEO_PLAYER = 2;
|
|
40
|
+
}
|
|
41
|
+
}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
// Copyright 2024 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/time_unit_enum.proto";
|
|
20
|
+
|
|
21
|
+
option csharp_namespace = "Google.Ads.AdManager.V1";
|
|
22
|
+
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
|
|
23
|
+
option java_multiple_files = true;
|
|
24
|
+
option java_outer_classname = "FrequencyCapProto";
|
|
25
|
+
option java_package = "com.google.ads.admanager.v1";
|
|
26
|
+
option php_namespace = "Google\\Ads\\AdManager\\V1";
|
|
27
|
+
option ruby_package = "Google::Ads::AdManager::V1";
|
|
28
|
+
|
|
29
|
+
// Represents a Frequency Cap that can be applied to an entity.
|
|
30
|
+
message FrequencyCap {
|
|
31
|
+
// The maximum number of impressions for this frequency cap.
|
|
32
|
+
optional int64 max_impressions = 1;
|
|
33
|
+
|
|
34
|
+
// The number of time units over which the frequency cap is effective.
|
|
35
|
+
optional int64 time_amount = 2;
|
|
36
|
+
|
|
37
|
+
// The units of time of this frequency cap.
|
|
38
|
+
optional TimeUnitEnum.TimeUnit time_unit = 3;
|
|
39
|
+
}
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
// Copyright 2024 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/api/field_behavior.proto";
|
|
20
|
+
import "google/api/resource.proto";
|
|
21
|
+
|
|
22
|
+
option csharp_namespace = "Google.Ads.AdManager.V1";
|
|
23
|
+
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
|
|
24
|
+
option java_multiple_files = true;
|
|
25
|
+
option java_outer_classname = "LabelMessagesProto";
|
|
26
|
+
option java_package = "com.google.ads.admanager.v1";
|
|
27
|
+
option php_namespace = "Google\\Ads\\AdManager\\V1";
|
|
28
|
+
option ruby_package = "Google::Ads::AdManager::V1";
|
|
29
|
+
|
|
30
|
+
// A Label is additional information that can be added to an entity.
|
|
31
|
+
message Label {
|
|
32
|
+
option (google.api.resource) = {
|
|
33
|
+
type: "admanager.googleapis.com/Label"
|
|
34
|
+
pattern: "networks/{network_code}/labels/{label}"
|
|
35
|
+
plural: "labels"
|
|
36
|
+
singular: "label"
|
|
37
|
+
};
|
|
38
|
+
|
|
39
|
+
// Identifier. The resource name of the `Label`.
|
|
40
|
+
// Format: `networks/{network_code}/labels/{label_id}`
|
|
41
|
+
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
|
|
42
|
+
}
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
// Copyright 2024 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/api/field_behavior.proto";
|
|
20
|
+
import "google/api/resource.proto";
|
|
21
|
+
|
|
22
|
+
option csharp_namespace = "Google.Ads.AdManager.V1";
|
|
23
|
+
option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
|
|
24
|
+
option java_multiple_files = true;
|
|
25
|
+
option java_outer_classname = "NetworkMessagesProto";
|
|
26
|
+
option java_package = "com.google.ads.admanager.v1";
|
|
27
|
+
option php_namespace = "Google\\Ads\\AdManager\\V1";
|
|
28
|
+
option ruby_package = "Google::Ads::AdManager::V1";
|
|
29
|
+
|
|
30
|
+
// The Network resource.
|
|
31
|
+
message Network {
|
|
32
|
+
option (google.api.resource) = {
|
|
33
|
+
type: "admanager.googleapis.com/Network"
|
|
34
|
+
pattern: "networks/{network_code}"
|
|
35
|
+
plural: "networks"
|
|
36
|
+
singular: "network"
|
|
37
|
+
};
|
|
38
|
+
|
|
39
|
+
// Identifier. The resource name of the Network.
|
|
40
|
+
// Format: networks/{network_code}
|
|
41
|
+
string name = 1 [(google.api.field_behavior) = IDENTIFIER];
|
|
42
|
+
|
|
43
|
+
// Optional. Display name for Network.
|
|
44
|
+
string display_name = 2 [(google.api.field_behavior) = OPTIONAL];
|
|
45
|
+
|
|
46
|
+
// Output only. Network Code.
|
|
47
|
+
string network_code = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
48
|
+
|
|
49
|
+
// Output only. Property code.
|
|
50
|
+
string property_code = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
51
|
+
|
|
52
|
+
// Output only. Time zone associated with the delivery of orders and
|
|
53
|
+
// reporting.
|
|
54
|
+
string time_zone = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
55
|
+
|
|
56
|
+
// Output only. Primary currency code, in ISO-4217 format.
|
|
57
|
+
string currency_code = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
58
|
+
|
|
59
|
+
// Optional. Currency codes that can be used as an alternative to the primary
|
|
60
|
+
// currency code for trafficking Line Items.
|
|
61
|
+
repeated string secondary_currency_codes = 7
|
|
62
|
+
[(google.api.field_behavior) = OPTIONAL];
|
|
63
|
+
|
|
64
|
+
// Output only. Top most [Ad Unit](google.ads.admanager.v1.AdUnit) to which
|
|
65
|
+
// descendant Ad Units can be added.
|
|
66
|
+
// Format: networks/{network_code}/adUnit/{ad_unit_id}
|
|
67
|
+
string effective_root_ad_unit = 8 [
|
|
68
|
+
(google.api.field_behavior) = OUTPUT_ONLY,
|
|
69
|
+
(google.api.resource_reference) = {
|
|
70
|
+
type: "admanager.googleapis.com/AdUnit"
|
|
71
|
+
}
|
|
72
|
+
];
|
|
73
|
+
|
|
74
|
+
// Output only. Whether this is a test network.
|
|
75
|
+
bool test_network = 10 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
76
|
+
|
|
77
|
+
// Output only. Network ID.
|
|
78
|
+
int64 network_id = 11 [(google.api.field_behavior) = OUTPUT_ONLY];
|
|
79
|
+
}
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
// Copyright 2024 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/network_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 = "NetworkServiceProto";
|
|
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 Network objects.
|
|
34
|
+
service NetworkService {
|
|
35
|
+
option (google.api.default_host) = "admanager.googleapis.com";
|
|
36
|
+
|
|
37
|
+
// API to retrieve a Network object.
|
|
38
|
+
rpc GetNetwork(GetNetworkRequest) returns (Network) {
|
|
39
|
+
option (google.api.http) = {
|
|
40
|
+
get: "/v1/{name=networks/*}"
|
|
41
|
+
};
|
|
42
|
+
option (google.api.method_signature) = "name";
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
// API to retrieve all the networks the current user has access to.
|
|
46
|
+
rpc ListNetworks(ListNetworksRequest) returns (ListNetworksResponse) {
|
|
47
|
+
option (google.api.http) = {
|
|
48
|
+
get: "/v1/networks"
|
|
49
|
+
};
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
// Request to get Network
|
|
54
|
+
message GetNetworkRequest {
|
|
55
|
+
// Required. Resource name of Network.
|
|
56
|
+
// Format: networks/{network_code}
|
|
57
|
+
string name = 1 [
|
|
58
|
+
(google.api.field_behavior) = REQUIRED,
|
|
59
|
+
(google.api.resource_reference) = {
|
|
60
|
+
type: "admanager.googleapis.com/Network"
|
|
61
|
+
}
|
|
62
|
+
];
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
// Request object for `ListNetworks` method.
|
|
66
|
+
message ListNetworksRequest {}
|
|
67
|
+
|
|
68
|
+
// Response object for `ListNetworks` method.
|
|
69
|
+
message ListNetworksResponse {
|
|
70
|
+
// The `Network`s a user has access to.
|
|
71
|
+
repeated Network networks = 1;
|
|
72
|
+
}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
// Copyright 2024 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 = "OrderEnumsProto";
|
|
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
|
+
// [OrderStatus][google.ads.admanager.v1.OrderStatusEnum.OrderStatus].
|
|
29
|
+
message OrderStatusEnum {
|
|
30
|
+
// The status of an Order.
|
|
31
|
+
enum OrderStatus {
|
|
32
|
+
// Default value. This value is unused.
|
|
33
|
+
ORDER_STATUS_UNSPECIFIED = 0;
|
|
34
|
+
|
|
35
|
+
// Indicates that the Order has just been created but no approval has been
|
|
36
|
+
// requested yet.
|
|
37
|
+
DRAFT = 2;
|
|
38
|
+
|
|
39
|
+
// Indicates that a request for approval for the Order has been made.
|
|
40
|
+
PENDING_APPROVAL = 3;
|
|
41
|
+
|
|
42
|
+
// Indicates that the Order has been approved and is ready to serve.
|
|
43
|
+
APPROVED = 4;
|
|
44
|
+
|
|
45
|
+
// Indicates that the Order has been disapproved and is not eligible to
|
|
46
|
+
// serve.
|
|
47
|
+
DISAPPROVED = 5;
|
|
48
|
+
|
|
49
|
+
// This is a legacy state. Paused status should be checked on LineItems
|
|
50
|
+
// within the order.
|
|
51
|
+
PAUSED = 6;
|
|
52
|
+
|
|
53
|
+
// Indicates that the Order has been canceled and cannot serve.
|
|
54
|
+
CANCELED = 7;
|
|
55
|
+
|
|
56
|
+
// Indicates that the Order has been deleted.
|
|
57
|
+
DELETED = 8;
|
|
58
|
+
}
|
|
59
|
+
}
|