@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.
Files changed (111) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/LICENSE +202 -0
  3. package/README.md +236 -0
  4. package/build/protos/google/ads/admanager/v1/ad_unit_enums.proto +81 -0
  5. package/build/protos/google/ads/admanager/v1/ad_unit_messages.proto +230 -0
  6. package/build/protos/google/ads/admanager/v1/ad_unit_service.proto +195 -0
  7. package/build/protos/google/ads/admanager/v1/admanager_error.proto +52 -0
  8. package/build/protos/google/ads/admanager/v1/applied_label.proto +41 -0
  9. package/build/protos/google/ads/admanager/v1/company_credit_status_enum.proto +97 -0
  10. package/build/protos/google/ads/admanager/v1/company_messages.proto +122 -0
  11. package/build/protos/google/ads/admanager/v1/company_service.proto +126 -0
  12. package/build/protos/google/ads/admanager/v1/company_type_enum.proto +51 -0
  13. package/build/protos/google/ads/admanager/v1/contact_messages.proto +49 -0
  14. package/build/protos/google/ads/admanager/v1/custom_field_enums.proto +110 -0
  15. package/build/protos/google/ads/admanager/v1/custom_field_messages.proto +87 -0
  16. package/build/protos/google/ads/admanager/v1/custom_field_service.proto +127 -0
  17. package/build/protos/google/ads/admanager/v1/custom_field_value.proto +62 -0
  18. package/build/protos/google/ads/admanager/v1/custom_targeting_key_enums.proto +76 -0
  19. package/build/protos/google/ads/admanager/v1/custom_targeting_key_messages.proto +69 -0
  20. package/build/protos/google/ads/admanager/v1/custom_targeting_key_service.proto +129 -0
  21. package/build/protos/google/ads/admanager/v1/custom_targeting_value_enums.proto +90 -0
  22. package/build/protos/google/ads/admanager/v1/custom_targeting_value_messages.proto +66 -0
  23. package/build/protos/google/ads/admanager/v1/custom_targeting_value_service.proto +132 -0
  24. package/build/protos/google/ads/admanager/v1/entity_signals_mapping_messages.proto +64 -0
  25. package/build/protos/google/ads/admanager/v1/entity_signals_mapping_service.proto +252 -0
  26. package/build/protos/google/ads/admanager/v1/environment_type_enum.proto +41 -0
  27. package/build/protos/google/ads/admanager/v1/frequency_cap.proto +39 -0
  28. package/build/protos/google/ads/admanager/v1/label_messages.proto +42 -0
  29. package/build/protos/google/ads/admanager/v1/network_messages.proto +79 -0
  30. package/build/protos/google/ads/admanager/v1/network_service.proto +72 -0
  31. package/build/protos/google/ads/admanager/v1/order_enums.proto +59 -0
  32. package/build/protos/google/ads/admanager/v1/order_messages.proto +209 -0
  33. package/build/protos/google/ads/admanager/v1/order_service.proto +129 -0
  34. package/build/protos/google/ads/admanager/v1/placement_enums.proto +44 -0
  35. package/build/protos/google/ads/admanager/v1/placement_messages.proto +77 -0
  36. package/build/protos/google/ads/admanager/v1/placement_service.proto +126 -0
  37. package/build/protos/google/ads/admanager/v1/report_service.proto +3526 -0
  38. package/build/protos/google/ads/admanager/v1/role_enums.proto +41 -0
  39. package/build/protos/google/ads/admanager/v1/role_messages.proto +59 -0
  40. package/build/protos/google/ads/admanager/v1/role_service.proto +122 -0
  41. package/build/protos/google/ads/admanager/v1/size.proto +47 -0
  42. package/build/protos/google/ads/admanager/v1/size_type_enum.proto +62 -0
  43. package/build/protos/google/ads/admanager/v1/taxonomy_category_messages.proto +70 -0
  44. package/build/protos/google/ads/admanager/v1/taxonomy_category_service.proto +128 -0
  45. package/build/protos/google/ads/admanager/v1/taxonomy_type_enum.proto +51 -0
  46. package/build/protos/google/ads/admanager/v1/team_messages.proto +46 -0
  47. package/build/protos/google/ads/admanager/v1/time_unit_enum.proto +59 -0
  48. package/build/protos/google/ads/admanager/v1/user_messages.proto +78 -0
  49. package/build/protos/google/ads/admanager/v1/user_service.proto +57 -0
  50. package/build/protos/protos.d.ts +23491 -0
  51. package/build/protos/protos.js +69798 -0
  52. package/build/protos/protos.json +7273 -0
  53. package/build/src/index.d.ts +47 -0
  54. package/build/src/index.js +67 -0
  55. package/build/src/index.js.map +1 -0
  56. package/build/src/v1/ad_unit_service_client.d.ts +794 -0
  57. package/build/src/v1/ad_unit_service_client.js +1136 -0
  58. package/build/src/v1/ad_unit_service_client.js.map +1 -0
  59. package/build/src/v1/ad_unit_service_client_config.json +38 -0
  60. package/build/src/v1/company_service_client.d.ts +663 -0
  61. package/build/src/v1/company_service_client.js +999 -0
  62. package/build/src/v1/company_service_client.js.map +1 -0
  63. package/build/src/v1/company_service_client_config.json +34 -0
  64. package/build/src/v1/custom_field_service_client.d.ts +663 -0
  65. package/build/src/v1/custom_field_service_client.js +1002 -0
  66. package/build/src/v1/custom_field_service_client.js.map +1 -0
  67. package/build/src/v1/custom_field_service_client_config.json +34 -0
  68. package/build/src/v1/custom_targeting_key_service_client.d.ts +664 -0
  69. package/build/src/v1/custom_targeting_key_service_client.js +1004 -0
  70. package/build/src/v1/custom_targeting_key_service_client.js.map +1 -0
  71. package/build/src/v1/custom_targeting_key_service_client_config.json +34 -0
  72. package/build/src/v1/custom_targeting_value_service_client.d.ts +673 -0
  73. package/build/src/v1/custom_targeting_value_service_client.js +1010 -0
  74. package/build/src/v1/custom_targeting_value_service_client.js.map +1 -0
  75. package/build/src/v1/custom_targeting_value_service_client_config.json +34 -0
  76. package/build/src/v1/entity_signals_mapping_service_client.d.ts +782 -0
  77. package/build/src/v1/entity_signals_mapping_service_client.js +1096 -0
  78. package/build/src/v1/entity_signals_mapping_service_client.js.map +1 -0
  79. package/build/src/v1/entity_signals_mapping_service_client_config.json +50 -0
  80. package/build/src/v1/index.d.ts +13 -0
  81. package/build/src/v1/index.js +47 -0
  82. package/build/src/v1/index.js.map +1 -0
  83. package/build/src/v1/network_service_client.d.ts +552 -0
  84. package/build/src/v1/network_service_client.js +877 -0
  85. package/build/src/v1/network_service_client.js.map +1 -0
  86. package/build/src/v1/network_service_client_config.json +34 -0
  87. package/build/src/v1/order_service_client.d.ts +668 -0
  88. package/build/src/v1/order_service_client.js +999 -0
  89. package/build/src/v1/order_service_client.js.map +1 -0
  90. package/build/src/v1/order_service_client_config.json +48 -0
  91. package/build/src/v1/placement_service_client.d.ts +663 -0
  92. package/build/src/v1/placement_service_client.js +999 -0
  93. package/build/src/v1/placement_service_client.js.map +1 -0
  94. package/build/src/v1/placement_service_client_config.json +34 -0
  95. package/build/src/v1/report_service_client.d.ts +975 -0
  96. package/build/src/v1/report_service_client.js +1352 -0
  97. package/build/src/v1/report_service_client.js.map +1 -0
  98. package/build/src/v1/report_service_client_config.json +50 -0
  99. package/build/src/v1/role_service_client.d.ts +660 -0
  100. package/build/src/v1/role_service_client.js +997 -0
  101. package/build/src/v1/role_service_client.js.map +1 -0
  102. package/build/src/v1/role_service_client_config.json +34 -0
  103. package/build/src/v1/taxonomy_category_service_client.d.ts +663 -0
  104. package/build/src/v1/taxonomy_category_service_client.js +1003 -0
  105. package/build/src/v1/taxonomy_category_service_client.js.map +1 -0
  106. package/build/src/v1/taxonomy_category_service_client_config.json +34 -0
  107. package/build/src/v1/user_service_client.d.ts +534 -0
  108. package/build/src/v1/user_service_client.js +861 -0
  109. package/build/src/v1/user_service_client.js.map +1 -0
  110. package/build/src/v1/user_service_client_config.json +30 -0
  111. package/package.json +70 -0
@@ -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 = "RoleEnumsProto";
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
+ // [RoleStatus][google.ads.admanager.v1.RoleStatusEnum.RoleStatus]
29
+ message RoleStatusEnum {
30
+ // The status of the role.
31
+ enum RoleStatus {
32
+ // No value specified.
33
+ ROLE_STATUS_UNSPECIFIED = 0;
34
+
35
+ // Role is active.
36
+ ACTIVE = 1;
37
+
38
+ // Role is inactive.
39
+ INACTIVE = 2;
40
+ }
41
+ }
@@ -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
+ import "google/ads/admanager/v1/role_enums.proto";
20
+ import "google/api/field_behavior.proto";
21
+ import "google/api/resource.proto";
22
+
23
+ option csharp_namespace = "Google.Ads.AdManager.V1";
24
+ option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
25
+ option java_multiple_files = true;
26
+ option java_outer_classname = "RoleMessagesProto";
27
+ option java_package = "com.google.ads.admanager.v1";
28
+ option php_namespace = "Google\\Ads\\AdManager\\V1";
29
+ option ruby_package = "Google::Ads::AdManager::V1";
30
+
31
+ // The `Role` resource.
32
+ message Role {
33
+ option (google.api.resource) = {
34
+ type: "admanager.googleapis.com/Role"
35
+ pattern: "networks/{network_code}/roles/{role}"
36
+ plural: "roles"
37
+ singular: "role"
38
+ };
39
+
40
+ // Identifier. The resource name of the `Role`.
41
+ // Format: `networks/{network_code}/roles/{role_id}`
42
+ string name = 1 [(google.api.field_behavior) = IDENTIFIER];
43
+
44
+ // Output only. `Role` ID.
45
+ int64 role_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
46
+
47
+ // Required. The display name of the `Role`.
48
+ string display_name = 3 [(google.api.field_behavior) = REQUIRED];
49
+
50
+ // Optional. The description of the `Role`.
51
+ string description = 4 [(google.api.field_behavior) = OPTIONAL];
52
+
53
+ // Output only. Whether the `Role` is a built-in or custom user role.
54
+ bool built_in = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
55
+
56
+ // Output only. The status of the `Role`.
57
+ RoleStatusEnum.RoleStatus status = 6
58
+ [(google.api.field_behavior) = OUTPUT_ONLY];
59
+ }
@@ -0,0 +1,122 @@
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/role_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 = "RoleServiceProto";
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 `Role` objects.
34
+ service RoleService {
35
+ option (google.api.default_host) = "admanager.googleapis.com";
36
+
37
+ // API to retrieve a `Role` object.
38
+ rpc GetRole(GetRoleRequest) returns (Role) {
39
+ option (google.api.http) = {
40
+ get: "/v1/{name=networks/*/roles/*}"
41
+ };
42
+ option (google.api.method_signature) = "name";
43
+ }
44
+
45
+ // API to retrieve a list of `Role` objects.
46
+ rpc ListRoles(ListRolesRequest) returns (ListRolesResponse) {
47
+ option (google.api.http) = {
48
+ get: "/v1/{parent=networks/*}/roles"
49
+ };
50
+ option (google.api.method_signature) = "parent";
51
+ }
52
+ }
53
+
54
+ // Request object for `GetRole` method.
55
+ message GetRoleRequest {
56
+ // Required. The resource name of the Role.
57
+ // Format: `networks/{network_code}/roles/{role_id}`
58
+ string name = 1 [
59
+ (google.api.field_behavior) = REQUIRED,
60
+ (google.api.resource_reference) = { type: "admanager.googleapis.com/Role" }
61
+ ];
62
+ }
63
+
64
+ // Request object for `ListRoles` method.
65
+ message ListRolesRequest {
66
+ // Required. The parent, which owns this collection of Roles.
67
+ // Format: `networks/{network_code}`
68
+ string parent = 1 [
69
+ (google.api.field_behavior) = REQUIRED,
70
+ (google.api.resource_reference) = {
71
+ type: "admanager.googleapis.com/Network"
72
+ }
73
+ ];
74
+
75
+ // Optional. The maximum number of `Roles` to return. The service may return
76
+ // fewer than this value. If unspecified, at most 50 `Roles` will be returned.
77
+ // The maximum value is 1000; values above 1000 will be coerced to 1000.
78
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
79
+
80
+ // Optional. A page token, received from a previous `ListRoles` call.
81
+ // Provide this to retrieve the subsequent page.
82
+ //
83
+ // When paginating, all other parameters provided to `ListRoles` must match
84
+ // the call that provided the page token.
85
+ string page_token = 3 [(google.api.field_behavior) = OPTIONAL];
86
+
87
+ // Optional. Expression to filter the response.
88
+ // See syntax details at
89
+ // https://developers.google.com/ad-manager/api/beta/filters
90
+ string filter = 4 [(google.api.field_behavior) = OPTIONAL];
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
+ string order_by = 5 [(google.api.field_behavior) = OPTIONAL];
96
+
97
+ // Optional. Number of individual resources to skip while paginating.
98
+ int32 skip = 6 [(google.api.field_behavior) = OPTIONAL];
99
+ }
100
+
101
+ // Response object for `ListRolesRequest` containing matching `Role` objects.
102
+ message ListRolesResponse {
103
+ // The `Role` objects from the specified network.
104
+ repeated Role roles = 1;
105
+
106
+ // A token, which can be sent as `page_token` to retrieve the next page.
107
+ // If this field is omitted, there are no subsequent pages.
108
+ string next_page_token = 2;
109
+
110
+ // Total number of `Role` objects.
111
+ // If a filter was included in the request, this reflects the total number
112
+ // after the filtering is applied.
113
+ //
114
+ // `total_size` will not be calculated in the response unless it has been
115
+ // included in a response field mask. The response field mask can be provided
116
+ // to the method by using the URL parameter `$fields` or `fields`, or by using
117
+ // the HTTP/gRPC header `X-Goog-FieldMask`.
118
+ //
119
+ // For more information, see
120
+ // https://developers.google.com/ad-manager/api/beta/field-masks
121
+ int32 total_size = 3;
122
+ }
@@ -0,0 +1,47 @@
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/size_type_enum.proto";
20
+ import "google/api/field_behavior.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 = "SizeProto";
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
+ // Represents the dimensions of an AdUnit, LineItem, or Creative.
31
+ message Size {
32
+ // Required. The width of the [Creative](google.ads.admanager.v1.Creative),
33
+ // [AdUnit](google.ads.admanager.v1.AdUnit), or
34
+ // [LineItem](google.ads.admanager.v1.LineItem).
35
+ int32 width = 1 [(google.api.field_behavior) = REQUIRED];
36
+
37
+ // Required. The height of the [Creative](google.ads.admanager.v1.Creative),
38
+ // [AdUnit](google.ads.admanager.v1.AdUnit), or
39
+ // [LineItem](google.ads.admanager.v1.LineItem).
40
+ int32 height = 2 [(google.api.field_behavior) = REQUIRED];
41
+
42
+ // Required. The SizeType of the
43
+ // [Creative](google.ads.admanager.v1.Creative),
44
+ // [AdUnit](google.ads.admanager.v1.AdUnit), or
45
+ // [LineItem](google.ads.admanager.v1.LineItem).
46
+ SizeTypeEnum.SizeType size_type = 3 [(google.api.field_behavior) = REQUIRED];
47
+ }
@@ -0,0 +1,62 @@
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 = "SizeTypeEnumProto";
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
+ // [SizeType][google.ads.admanager.v1.SizeTypeEnum.SizeType].
29
+ message SizeTypeEnum {
30
+ // The different Size types for an ad.
31
+ enum SizeType {
32
+ // Default value. This value is unused.
33
+ SIZE_TYPE_UNSPECIFIED = 0;
34
+
35
+ // Dimension based size, an actual height and width in pixels.
36
+ PIXEL = 1;
37
+
38
+ // Size is expressed as a ratio. For example, 4:1 could be
39
+ // met by a 100 x 25 sized image.
40
+ ASPECT_RATIO = 2;
41
+
42
+ // Out-of-page (Interstitial) size that is not related to the slot it is
43
+ // served. This must be used with 1x1 size.
44
+ INTERSTITIAL = 3;
45
+
46
+ // Size is ignored. This must be used with 1x1
47
+ // size.
48
+ IGNORED = 4;
49
+
50
+ // Native size, which is a function of the how the client renders the
51
+ // creative. This must be used with 1x1 size.
52
+ NATIVE = 5;
53
+
54
+ // Fluid size. Automatically sizes the ad by filling the width of the
55
+ // enclosing column and adjusting the height as appropriate. This must be
56
+ // used with 1x1 size.
57
+ FLUID = 6;
58
+
59
+ // Audio size. Used with audio ads. This must be used with 1x1 size.
60
+ AUDIO = 7;
61
+ }
62
+ }
@@ -0,0 +1,70 @@
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/taxonomy_type_enum.proto";
20
+ import "google/api/field_behavior.proto";
21
+ import "google/api/resource.proto";
22
+
23
+ option csharp_namespace = "Google.Ads.AdManager.V1";
24
+ option go_package = "google.golang.org/genproto/googleapis/ads/admanager/v1;admanager";
25
+ option java_multiple_files = true;
26
+ option java_outer_classname = "TaxonomyCategoryMessagesProto";
27
+ option java_package = "com.google.ads.admanager.v1";
28
+ option php_namespace = "Google\\Ads\\AdManager\\V1";
29
+ option ruby_package = "Google::Ads::AdManager::V1";
30
+
31
+ // The `TaxonomyCategory` resource.
32
+ message TaxonomyCategory {
33
+ option (google.api.resource) = {
34
+ type: "admanager.googleapis.com/TaxonomyCategory"
35
+ pattern: "networks/{network_code}/taxonomyCategories/{taxonomy_category}"
36
+ plural: "taxonomyCategories"
37
+ singular: "taxonomyCategory"
38
+ };
39
+
40
+ // Identifier. The resource name of the `TaxonomyCategory`.
41
+ // Format: `networks/{network_code}/taxonomyCategories/{taxonomy_category_id}`
42
+ string name = 1 [(google.api.field_behavior) = IDENTIFIER];
43
+
44
+ // Output only. `TaxonomyCategory` ID.
45
+ int64 taxonomy_category_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
46
+
47
+ // Output only. Display name of the `TaxonomyCategory`.
48
+ string display_name = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
49
+
50
+ // Output only. Whether this `TaxonomyCategory` only serves to group its
51
+ // children.
52
+ bool grouping_only = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
53
+
54
+ // Output only. The ID of the parent category this `TaxonomyCategory` descends
55
+ // from.
56
+ int64 parent_taxonomy_category_id = 6
57
+ [(google.api.field_behavior) = OUTPUT_ONLY];
58
+
59
+ // Output only. The taxonomy that this `TaxonomyCategory` belongs to.
60
+ TaxonomyTypeEnum.TaxonomyType taxonomy_type = 9
61
+ [(google.api.field_behavior) = OUTPUT_ONLY];
62
+
63
+ // Output only. The list of names of the ancestors of this `TaxonomyCategory`.
64
+ repeated string ancestor_names = 7
65
+ [(google.api.field_behavior) = OUTPUT_ONLY];
66
+
67
+ // Output only. The list of IDs of the ancestors of this `TaxonomyCategory`.
68
+ repeated int64 ancestor_taxonomy_category_ids = 8
69
+ [(google.api.field_behavior) = OUTPUT_ONLY];
70
+ }
@@ -0,0 +1,128 @@
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/taxonomy_category_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 = "TaxonomyCategoryServiceProto";
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 `TaxonomyCategory` objects.
34
+ service TaxonomyCategoryService {
35
+ option (google.api.default_host) = "admanager.googleapis.com";
36
+
37
+ // API to retrieve a `TaxonomyCategory` object.
38
+ rpc GetTaxonomyCategory(GetTaxonomyCategoryRequest)
39
+ returns (TaxonomyCategory) {
40
+ option (google.api.http) = {
41
+ get: "/v1/{name=networks/*/taxonomyCategories/*}"
42
+ };
43
+ option (google.api.method_signature) = "name";
44
+ }
45
+
46
+ // API to retrieve a list of `TaxonomyCategory` objects.
47
+ rpc ListTaxonomyCategories(ListTaxonomyCategoriesRequest)
48
+ returns (ListTaxonomyCategoriesResponse) {
49
+ option (google.api.http) = {
50
+ get: "/v1/{parent=networks/*}/taxonomyCategories"
51
+ };
52
+ option (google.api.method_signature) = "parent";
53
+ }
54
+ }
55
+
56
+ // Request object for `GetTaxonomyCategory` method.
57
+ message GetTaxonomyCategoryRequest {
58
+ // Required. The resource name of the TaxonomyCategory.
59
+ // Format: `networks/{network_code}/taxonomyCategories/{taxonomy_category_id}`
60
+ string name = 1 [
61
+ (google.api.field_behavior) = REQUIRED,
62
+ (google.api.resource_reference) = {
63
+ type: "admanager.googleapis.com/TaxonomyCategory"
64
+ }
65
+ ];
66
+ }
67
+
68
+ // Request object for `ListTaxonomyCategories` method.
69
+ message ListTaxonomyCategoriesRequest {
70
+ // Required. The parent, which owns this collection of TaxonomyCategories.
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 `TaxonomyCategories` to return. The service
80
+ // may return fewer than this value. If unspecified, at most 50
81
+ // `TaxonomyCategories` will be returned. The maximum value is 1000; values
82
+ // above 1000 will be coerced to 1000.
83
+ int32 page_size = 2 [(google.api.field_behavior) = OPTIONAL];
84
+
85
+ // Optional. A page token, received from a previous `ListTaxonomyCategories`
86
+ // call. Provide this to retrieve the subsequent page.
87
+ //
88
+ // When paginating, all other parameters provided to `ListTaxonomyCategories`
89
+ // must 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 `ListTaxonomyCategoriesRequest` containing matching
107
+ // `TaxonomyCategory` objects.
108
+ message ListTaxonomyCategoriesResponse {
109
+ // The `TaxonomyCategory` objects.
110
+ repeated TaxonomyCategory taxonomy_categories = 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 `TaxonomyCategory` 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` will not 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
+ }
@@ -0,0 +1,51 @@
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 = "TaxonomyTypeEnumProto";
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 for
28
+ // [TaxonomyType][google.ads.admanager.v1.TaxonomyTypeEnum.TaxonomyType]
29
+ message TaxonomyTypeEnum {
30
+ // The taxonomy type of the IAB defined taxonomies.
31
+ // Used for Publisher provided signals.
32
+ enum TaxonomyType {
33
+ // Unspecified/not present
34
+ TAXONOMY_TYPE_UNSPECIFIED = 0;
35
+
36
+ // The IAB Audience Taxonomy v1.1.
37
+ TAXONOMY_IAB_AUDIENCE_1_1 = 3;
38
+
39
+ // The IAB Content Taxonomy v2.1.
40
+ TAXONOMY_IAB_CONTENT_2_1 = 4;
41
+
42
+ // The IAB Content Taxonomy v2.2.
43
+ TAXONOMY_IAB_CONTENT_2_2 = 6;
44
+
45
+ // The IAB Content Taxonomy v3.0.
46
+ TAXONOMY_IAB_CONTENT_3_0 = 5;
47
+
48
+ // The PPS structured video signals taxonomy.
49
+ TAXONOMY_GOOGLE_STRUCTURED_VIDEO_1_0 = 7;
50
+ }
51
+ }
@@ -0,0 +1,46 @@
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 = "TeamMessagesProto";
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 Team defines a grouping of users and what entities they have access to.
31
+ message Team {
32
+ option (google.api.resource) = {
33
+ type: "admanager.googleapis.com/Team"
34
+ pattern: "networks/{network_code}/teams/{team}"
35
+ plural: "teams"
36
+ singular: "team"
37
+ };
38
+
39
+ // Identifier. The resource name of the `Team`.
40
+ // Format: `networks/{network_code}/teams/{team_id}`
41
+ string name = 1 [(google.api.field_behavior) = IDENTIFIER];
42
+
43
+ // Output only. The unique ID of the Team. This value is assigned by Google.
44
+ // Teams that are created by Google will have negative IDs.
45
+ int64 team_id = 2 [(google.api.field_behavior) = OUTPUT_ONLY];
46
+ }